2 * Copyright (C) 2010 Wim Taymans <wim.taymans at gmail.com>
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Library General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Library General Public License for more details.
14 * You should have received a copy of the GNU Library General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
17 * Boston, MA 02110-1301, USA.
22 #ifndef __GST_RTSP_AUTH_H__
23 #define __GST_RTSP_AUTH_H__
25 typedef struct _GstRTSPAuth GstRTSPAuth;
26 typedef struct _GstRTSPAuthClass GstRTSPAuthClass;
27 typedef struct _GstRTSPAuthPrivate GstRTSPAuthPrivate;
29 #include "rtsp-client.h"
30 #include "rtsp-token.h"
34 #define GST_TYPE_RTSP_AUTH (gst_rtsp_auth_get_type ())
35 #define GST_IS_RTSP_AUTH(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_RTSP_AUTH))
36 #define GST_IS_RTSP_AUTH_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_RTSP_AUTH))
37 #define GST_RTSP_AUTH_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_RTSP_AUTH, GstRTSPAuthClass))
38 #define GST_RTSP_AUTH(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_RTSP_AUTH, GstRTSPAuth))
39 #define GST_RTSP_AUTH_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_RTSP_AUTH, GstRTSPAuthClass))
40 #define GST_RTSP_AUTH_CAST(obj) ((GstRTSPAuth*)(obj))
41 #define GST_RTSP_AUTH_CLASS_CAST(klass) ((GstRTSPAuthClass*)(klass))
46 * The authentication structure.
52 GstRTSPAuthPrivate *priv;
53 gpointer _gst_reserved[GST_PADDING];
58 * @authenticate: check the authentication of a client. The default implementation
59 * checks if the authentication in the header matches one of the basic
60 * authentication tokens. This function should set the authgroup field
62 * @check: check if a resource can be accessed. this function should
63 * call authenticate to authenticate the client when needed. The method
64 * should also construct and send an appropriate response message on
67 * The authentication class.
69 struct _GstRTSPAuthClass {
70 GObjectClass parent_class;
72 gboolean (*authenticate) (GstRTSPAuth *auth, GstRTSPContext *ctx);
73 gboolean (*check) (GstRTSPAuth *auth, GstRTSPContext *ctx,
75 gboolean (*accept_certificate) (GstRTSPAuth *auth,
76 GTlsConnection *connection,
77 GTlsCertificate *peer_cert,
78 GTlsCertificateFlags errors);
80 gpointer _gst_reserved[GST_PADDING - 1];
83 GType gst_rtsp_auth_get_type (void);
85 GstRTSPAuth * gst_rtsp_auth_new (void);
87 void gst_rtsp_auth_set_tls_certificate (GstRTSPAuth *auth, GTlsCertificate *cert);
88 GTlsCertificate * gst_rtsp_auth_get_tls_certificate (GstRTSPAuth *auth);
90 void gst_rtsp_auth_set_tls_database (GstRTSPAuth *auth, GTlsDatabase *database);
91 GTlsDatabase * gst_rtsp_auth_get_tls_database (GstRTSPAuth *auth);
93 void gst_rtsp_auth_set_tls_authentication_mode (GstRTSPAuth *auth, GTlsAuthenticationMode mode);
94 GTlsAuthenticationMode gst_rtsp_auth_get_tls_authentication_mode (GstRTSPAuth *auth);
96 void gst_rtsp_auth_set_default_token (GstRTSPAuth *auth, GstRTSPToken *token);
97 GstRTSPToken * gst_rtsp_auth_get_default_token (GstRTSPAuth *auth);
99 void gst_rtsp_auth_add_basic (GstRTSPAuth *auth, const gchar * basic,
100 GstRTSPToken *token);
101 void gst_rtsp_auth_remove_basic (GstRTSPAuth *auth, const gchar * basic);
103 gboolean gst_rtsp_auth_check (const gchar *check);
107 gchar * gst_rtsp_auth_make_basic (const gchar * user, const gchar * pass);
111 * GST_RTSP_AUTH_CHECK_CONNECT:
113 * Check a new connection
115 #define GST_RTSP_AUTH_CHECK_CONNECT "auth.check.connect"
117 * GST_RTSP_AUTH_CHECK_URL:
119 * Check the URL and methods
121 #define GST_RTSP_AUTH_CHECK_URL "auth.check.url"
123 * GST_RTSP_AUTH_CHECK_MEDIA_FACTORY_ACCESS:
125 * Check if access is allowed to a factory.
126 * When access is not allowed an 404 Not Found is sent in the response.
128 #define GST_RTSP_AUTH_CHECK_MEDIA_FACTORY_ACCESS "auth.check.media.factory.access"
130 * GST_RTSP_AUTH_CHECK_MEDIA_FACTORY_CONSTRUCT:
132 * Check if media can be constructed from a media factory
133 * A response should be sent on error.
135 #define GST_RTSP_AUTH_CHECK_MEDIA_FACTORY_CONSTRUCT "auth.check.media.factory.construct"
137 * GST_RTSP_AUTH_CHECK_TRANSPORT_CLIENT_SETTINGS:
139 * Check if the client can specify TTL, destination and
140 * port pair in multicast. No response is sent when the check returns
143 #define GST_RTSP_AUTH_CHECK_TRANSPORT_CLIENT_SETTINGS "auth.check.transport.client-settings"
148 * GST_RTSP_TOKEN_MEDIA_FACTORY_ROLE:
150 * G_TYPE_STRING, the role to use when dealing with media factories
152 * The default #GstRTSPAuth object uses this string in the token to find the
153 * role of the media factory. It will then retrieve the #GstRTSPPermissions of
154 * the media factory and retrieve the role with the same name.
156 #define GST_RTSP_TOKEN_MEDIA_FACTORY_ROLE "media.factory.role"
158 * GST_RTSP_TOKEN_TRANSPORT_CLIENT_SETTINGS:
160 * G_TYPE_BOOLEAN, %TRUE if the client can specify TTL, destination and
161 * port pair in multicast.
163 #define GST_RTSP_TOKEN_TRANSPORT_CLIENT_SETTINGS "transport.client-settings"
167 * GST_RTSP_PERM_MEDIA_FACTORY_ACCESS:
169 * G_TYPE_BOOLEAN, %TRUE if the media can be accessed, %FALSE will
170 * return a 404 Not Found error when trying to access the media.
172 #define GST_RTSP_PERM_MEDIA_FACTORY_ACCESS "media.factory.access"
174 * GST_RTSP_PERM_MEDIA_FACTORY_CONSTRUCT:
176 * G_TYPE_BOOLEAN, %TRUE if the media can be constructed, %FALSE will
177 * return a 404 Not Found error when trying to access the media.
179 #define GST_RTSP_PERM_MEDIA_FACTORY_CONSTRUCT "media.factory.construct"
181 #ifdef G_DEFINE_AUTOPTR_CLEANUP_FUNC
182 G_DEFINE_AUTOPTR_CLEANUP_FUNC(GstRTSPAuth, gst_object_unref)
187 #endif /* __GST_RTSP_AUTH_H__ */