gst_rtsp_auth_new ()

GstRTSPAuth *
gst_rtsp_auth_new (void);

Create a new GstRTSPAuth instance.

gst_rtsp_auth_get_tls_certificate ()

GTlsCertificate *
gst_rtsp_auth_get_tls_certificate (GstRTSPAuth *auth);

Get the GTlsCertificate used for negotiating TLS auth .

gst_rtsp_auth_set_tls_certificate ()

void
gst_rtsp_auth_set_tls_certificate (GstRTSPAuth *auth,
                                   GTlsCertificate *cert);

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

gst_rtsp_auth_get_tls_database ()

GTlsDatabase *
gst_rtsp_auth_get_tls_database (GstRTSPAuth *auth);

Get the GTlsDatabase used for verifying client certificate.

Since: 1.6

gst_rtsp_auth_set_tls_database ()

void
gst_rtsp_auth_set_tls_database (GstRTSPAuth *auth,
                                GTlsDatabase *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 G_TLS_CERTIFICATE_UNKNOWN_CA error.

Since 1.6

gst_rtsp_auth_get_tls_authentication_mode ()

GTlsAuthenticationMode
gst_rtsp_auth_get_tls_authentication_mode
                               (GstRTSPAuth *auth);

Get the GTlsAuthenticationMode.

gst_rtsp_auth_set_tls_authentication_mode ()

void
gst_rtsp_auth_set_tls_authentication_mode
                               (GstRTSPAuth *auth,
                                GTlsAuthenticationMode mode);

The GTlsAuthenticationMode to set on the underlying GTlsServerConnection. When set to another value than G_TLS_AUTHENTICATION_NONE, “accept-certificate” signal will be emitted and must be handled.

Since: 1.6

gst_rtsp_auth_make_basic ()

gchar *
gst_rtsp_auth_make_basic (const gchar *user,
                          const gchar *pass);

Construct a Basic authorisation token from user and pass .

gst_rtsp_auth_add_basic ()

void
gst_rtsp_auth_add_basic (GstRTSPAuth *auth,
                         const gchar *basic,
                         GstRTSPToken *token);

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

gst_rtsp_auth_remove_basic ()

void
gst_rtsp_auth_remove_basic (GstRTSPAuth *auth,
                            const gchar *basic);

Add a basic token for the default authentication algorithm that enables the client with privileges from authgroup .

gst_rtsp_auth_check ()

gboolean
gst_rtsp_auth_check (const gchar *check);

Check if check is allowed in the current context.

gst_rtsp_auth_get_default_token ()

GstRTSPToken *
gst_rtsp_auth_get_default_token (GstRTSPAuth *auth);

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

gst_rtsp_auth_set_default_token ()

void
gst_rtsp_auth_set_default_token (GstRTSPAuth *auth,
                                 GstRTSPToken *token);

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

struct GstRTSPAuth

struct GstRTSPAuth;

The authentication structure.

struct GstRTSPAuthClass

struct GstRTSPAuthClass {
  GObjectClass  parent_class;

  gboolean           (*authenticate) (GstRTSPAuth *auth, GstRTSPContext *ctx);
  gboolean           (*check)        (GstRTSPAuth *auth, GstRTSPContext *ctx,
                                      const gchar *check);
  gboolean           (*accept_certificate) (GstRTSPAuth *auth,
                                            GTlsConnection *connection,
                                            GTlsCertificate *peer_cert,
                                            GTlsCertificateFlags errors);
};

The authentication class.

GST_RTSP_AUTH_CHECK_CONNECT

#define GST_RTSP_AUTH_CHECK_CONNECT                  "auth.check.connect"

Check a new connection

GST_RTSP_AUTH_CHECK_URL

#define GST_RTSP_AUTH_CHECK_URL                      "auth.check.url"

Check the URL and methods

GST_RTSP_AUTH_CHECK_MEDIA_FACTORY_ACCESS

#define GST_RTSP_AUTH_CHECK_MEDIA_FACTORY_ACCESS     "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.

GST_RTSP_AUTH_CHECK_MEDIA_FACTORY_CONSTRUCT

#define GST_RTSP_AUTH_CHECK_MEDIA_FACTORY_CONSTRUCT  "auth.check.media.factory.construct"

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

GST_RTSP_AUTH_CHECK_TRANSPORT_CLIENT_SETTINGS

#define GST_RTSP_AUTH_CHECK_TRANSPORT_CLIENT_SETTINGS  "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.

GST_RTSP_TOKEN_MEDIA_FACTORY_ROLE

#define GST_RTSP_TOKEN_MEDIA_FACTORY_ROLE      "media.factory.role"

G_TYPE_STRING, the role to use when dealing with media factories

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

GST_RTSP_TOKEN_TRANSPORT_CLIENT_SETTINGS

#define GST_RTSP_TOKEN_TRANSPORT_CLIENT_SETTINGS   "transport.client-settings"

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

GST_RTSP_PERM_MEDIA_FACTORY_ACCESS

#define GST_RTSP_PERM_MEDIA_FACTORY_ACCESS      "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.

GST_RTSP_PERM_MEDIA_FACTORY_CONSTRUCT

#define GST_RTSP_PERM_MEDIA_FACTORY_CONSTRUCT   "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.

The “accept-certificate” signal

gboolean
user_function (GstRTSPAuth         *auth,
               GTlsConnection      *connection,
               GTlsCertificate     *peer_cert,
               GTlsCertificateFlags errors,
               gpointer             user_data)

Emitted during the TLS handshake after the client certificate has been received. See also gst_rtsp_auth_set_tls_authentication_mode().

Flags: Run Last

Since: 1.6