rtsp auth

GstRtspServer.RTSPAuth

GObject.Object
    ╰──GstRtspServer.RTSPAuth

GstRtspServer.RTSPAuth.prototype.new

function GstRtspServer.RTSPAuth.prototype.new(): {
    // javascript wrapper for 'gst_rtsp_auth_new'
}

Create a new GstRtspServer.RTSPAuth instance.

GstRtspServer.RTSPAuth.prototype.add_basic

function GstRtspServer.RTSPAuth.prototype.add_basic(basic: String, token: GstRtspServer.RTSPToken): {
    // javascript wrapper for 'gst_rtsp_auth_add_basic'
}

Add a basic token for the default authentication algorithm that enables the client with privileges listed in token.

GstRtspServer.RTSPAuth.prototype.add_digest

function GstRtspServer.RTSPAuth.prototype.add_digest(user: String, pass: String, token: GstRtspServer.RTSPToken): {
    // javascript wrapper for 'gst_rtsp_auth_add_digest'
}

Add a digest user and pass for the default authentication algorithm that enables the client with privileges listed in token.

Since : 1.12

GstRtspServer.RTSPAuth.prototype.get_default_token

function GstRtspServer.RTSPAuth.prototype.get_default_token(): {
    // javascript wrapper for 'gst_rtsp_auth_get_default_token'
}

Get the default token for auth. This token will be used for unauthenticated users.

GstRtspServer.RTSPAuth.prototype.get_realm

function GstRtspServer.RTSPAuth.prototype.get_realm(): {
    // javascript wrapper for 'gst_rtsp_auth_get_realm'
}

Since : 1.16

GstRtspServer.RTSPAuth.prototype.get_supported_methods

function GstRtspServer.RTSPAuth.prototype.get_supported_methods(): {
    // javascript wrapper for 'gst_rtsp_auth_get_supported_methods'
}

Gets the supported authentication methods of auth.

Since : 1.12

GstRtspServer.RTSPAuth.prototype.get_tls_authentication_mode

function GstRtspServer.RTSPAuth.prototype.get_tls_authentication_mode(): {
    // javascript wrapper for 'gst_rtsp_auth_get_tls_authentication_mode'
}

Get the Gio.TlsAuthenticationMode.

GstRtspServer.RTSPAuth.prototype.get_tls_certificate

function GstRtspServer.RTSPAuth.prototype.get_tls_certificate(): {
    // javascript wrapper for 'gst_rtsp_auth_get_tls_certificate'
}

Get the Gio.TlsCertificate used for negotiating TLS auth.

GstRtspServer.RTSPAuth.prototype.get_tls_database

function GstRtspServer.RTSPAuth.prototype.get_tls_database(): {
    // javascript wrapper for 'gst_rtsp_auth_get_tls_database'
}

Get the Gio.TlsDatabase used for verifying client certificate.

Since : 1.6

GstRtspServer.RTSPAuth.prototype.parse_htdigest

function GstRtspServer.RTSPAuth.prototype.parse_htdigest(path: filename, token: GstRtspServer.RTSPToken): {
    // javascript wrapper for 'gst_rtsp_auth_parse_htdigest'
}

Parse the contents of the file at path and enable the privileges listed in token for the users it describes.

The format of the file is expected to match the format described by https://en.wikipedia.org/wiki/Digest_access_authentication#The_.htdigest_file, as output by the htdigest command.

Since : 1.16

GstRtspServer.RTSPAuth.prototype.remove_basic

function GstRtspServer.RTSPAuth.prototype.remove_basic(basic: String): {
    // javascript wrapper for 'gst_rtsp_auth_remove_basic'
}

Removes basic authentication token.

GstRtspServer.RTSPAuth.prototype.remove_digest

function GstRtspServer.RTSPAuth.prototype.remove_digest(user: String): {
    // javascript wrapper for 'gst_rtsp_auth_remove_digest'
}

Removes a digest user.

Since : 1.12

GstRtspServer.RTSPAuth.prototype.set_default_token

function GstRtspServer.RTSPAuth.prototype.set_default_token(token: GstRtspServer.RTSPToken): {
    // javascript wrapper for 'gst_rtsp_auth_set_default_token'
}

Set the default GstRtspServer.RTSPToken to token in auth. The default token will be used for unauthenticated users.

GstRtspServer.RTSPAuth.prototype.set_realm

function GstRtspServer.RTSPAuth.prototype.set_realm(realm: String): {
    // javascript wrapper for 'gst_rtsp_auth_set_realm'
}

Set the realm of auth

Since : 1.16

GstRtspServer.RTSPAuth.prototype.set_supported_methods

function GstRtspServer.RTSPAuth.prototype.set_supported_methods(methods: GstRtsp.RTSPAuthMethod): {
    // javascript wrapper for 'gst_rtsp_auth_set_supported_methods'
}

Sets the supported authentication methods for auth.

Since : 1.12

GstRtspServer.RTSPAuth.prototype.set_tls_authentication_mode

function GstRtspServer.RTSPAuth.prototype.set_tls_authentication_mode(mode: Gio.TlsAuthenticationMode): {
    // javascript wrapper for 'gst_rtsp_auth_set_tls_authentication_mode'
}

The Gio.TlsAuthenticationMode to set on the underlying GTlsServerConnection. When set to another value than Gio.TlsAuthenticationMode.NONE, accept-certificate signal will be emitted and must be handled.

Since : 1.6

GstRtspServer.RTSPAuth.prototype.set_tls_certificate

function GstRtspServer.RTSPAuth.prototype.set_tls_certificate(cert: Gio.TlsCertificate): {
    // javascript wrapper for 'gst_rtsp_auth_set_tls_certificate'
}

Set the TLS certificate for the auth. Client connections will only be accepted when TLS is negotiated.

GstRtspServer.RTSPAuth.prototype.set_tls_database

function GstRtspServer.RTSPAuth.prototype.set_tls_database(database: Gio.TlsDatabase): {
    // javascript wrapper for 'gst_rtsp_auth_set_tls_database'
}

Sets the certificate database that is used to verify peer certificates. If set to null (the default), then peer certificate validation will always set the Gio.TlsCertificateFlags.UNKNOWN_CA error.

Since : 1.6

GstRtspServer.RTSPAuth.prototype.check

function GstRtspServer.RTSPAuth.prototype.check(check: String): {
    // javascript wrapper for 'gst_rtsp_auth_check'
}

Check if check is allowed in the current context.

GstRtspServer.RTSPAuth.prototype.make_basic

function GstRtspServer.RTSPAuth.prototype.make_basic(user: String, pass: String): {
    // javascript wrapper for 'gst_rtsp_auth_make_basic'
}

Construct a Basic authorisation token from user and pass.

accept-certificate

function accept_certificate_callback(self: GstRtspServer.RTSPAuth, connection: Gio.TlsConnection, peer_cert: Gio.TlsCertificate, errors: Gio.TlsCertificateFlags, user_data: Object): {
    // javascript callback for the 'accept-certificate' signal
}

Emitted during the TLS handshake after the client certificate has been received. See also GstRtspServer.RTSPAuth.prototype.set_tls_authentication_mode.

Flags: Run Last

Since : 1.6

vfunc_accept_certificate

function vfunc_accept_certificate(auth: GstRtspServer.RTSPAuth, connection: Gio.TlsConnection, peer_cert: Gio.TlsCertificate, errors: Gio.TlsCertificateFlags): {
    // javascript implementation of the 'accept_certificate' virtual method
}

vfunc_authenticate

function vfunc_authenticate(auth: GstRtspServer.RTSPAuth, ctx: GstRtspServer.RTSPContext): {
    // javascript implementation of the 'authenticate' virtual method
}

check the authentication of a client. The default implementation checks if the authentication in the header matches one of the basic authentication tokens. This function should set the authgroup field in the context.

vfunc_check

function vfunc_check(auth: GstRtspServer.RTSPAuth, ctx: GstRtspServer.RTSPContext, check: String): {
    // javascript implementation of the 'check' virtual method
}

check if a resource can be accessed. this function should call authenticate to authenticate the client when needed. The method should also construct and send an appropriate response message on error.

vfunc_generate_authenticate_header

function vfunc_generate_authenticate_header(auth: GstRtspServer.RTSPAuth, ctx: GstRtspServer.RTSPContext): {
    // javascript implementation of the 'generate_authenticate_header' virtual method
}

GstRtspServer.RTSP_AUTH_CHECK_CONNECT

Check a new connection

GstRtspServer.RTSP_AUTH_CHECK_MEDIA_FACTORY_ACCESS

Check if access is allowed to a factory. When access is not allowed an 404 Not Found is sent in the response.

GstRtspServer.RTSP_AUTH_CHECK_MEDIA_FACTORY_CONSTRUCT

Check if media can be constructed from a media factory A response should be sent on error.

GstRtspServer.RTSP_AUTH_CHECK_TRANSPORT_CLIENT_SETTINGS

Check if the client can specify TTL, destination and port pair in multicast. No response is sent when the check returns false.

GstRtspServer.RTSP_AUTH_CHECK_URL

Check the URL and methods

GstRtspServer.RTSP_PERM_MEDIA_FACTORY_ACCESS

G_TYPE_BOOLEAN, true if the media can be accessed, false will return a 404 Not Found error when trying to access the media.

GstRtspServer.RTSP_PERM_MEDIA_FACTORY_CONSTRUCT

G_TYPE_BOOLEAN, true if the media can be constructed, false will return a 404 Not Found error when trying to access the media.

GstRtspServer.RTSP_TOKEN_MEDIA_FACTORY_ROLE

G_TYPE_STRING, the role to use when dealing with media factories

The default GstRtspServer.RTSPAuth object uses this string in the token to find the role of the media factory. It will then retrieve the GstRtspServer.RTSPPermissions of the media factory and retrieve the role with the same name.

GstRtspServer.RTSP_TOKEN_TRANSPORT_CLIENT_SETTINGS

G_TYPE_BOOLEAN, true if the client can specify TTL, destination and port pair in multicast.