gst/rtsp-server/rtsp-auth.h

   1 /* GStreamer
   2  * Copyright (C) 2010 Wim Taymans <wim.taymans at gmail.com>
   3  *
   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.
   8  *
   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.
  13  *
  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.
  18  */
  19
  20 #include <gst/gst.h>
  21
  22 #ifndef __GST_RTSP_AUTH_H__
  23 #define __GST_RTSP_AUTH_H__
  24
  25 typedef struct _GstRTSPAuth GstRTSPAuth;
  26 typedef struct _GstRTSPAuthClass GstRTSPAuthClass;
  27 typedef struct _GstRTSPAuthPrivate GstRTSPAuthPrivate;
  28
  29 #include "rtsp-client.h"
  30 #include "rtsp-token.h"
  31
  32 G_BEGIN_DECLS
  33
  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))
  42
  43 /**
  44  * GstRTSPAuth:
  45  *
  46  * The authentication structure.
  47  */
  48 struct _GstRTSPAuth {
  49   GObject       parent;
  50
  51   /*< private >*/
  52   GstRTSPAuthPrivate *priv;
  53   gpointer _gst_reserved[GST_PADDING];
  54 };
  55
  56 /**
  57  * GstRTSPAuthClass:
  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
  61  *         in the context.
  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
  65  *         error.
  66  *
  67  * The authentication class.
  68  */
  69 struct _GstRTSPAuthClass {
  70   GObjectClass  parent_class;
  71
  72   gboolean           (*authenticate) (GstRTSPAuth *auth, GstRTSPContext *ctx);
  73   gboolean           (*check)        (GstRTSPAuth *auth, GstRTSPContext *ctx,
  74                                       const gchar *check);
  75   /*< private >*/
  76   gpointer            _gst_reserved[GST_PADDING];
  77 };
  78
  79 GType               gst_rtsp_auth_get_type          (void);
  80
  81 GstRTSPAuth *       gst_rtsp_auth_new               (void);
  82
  83 void                gst_rtsp_auth_set_tls_certificate (GstRTSPAuth *auth, GTlsCertificate *cert);
  84 GTlsCertificate *   gst_rtsp_auth_get_tls_certificate (GstRTSPAuth *auth);
  85
  86 void                gst_rtsp_auth_set_default_token (GstRTSPAuth *auth, GstRTSPToken *token);
  87 GstRTSPToken *      gst_rtsp_auth_get_default_token (GstRTSPAuth *auth);
  88
  89 void                gst_rtsp_auth_add_basic         (GstRTSPAuth *auth, const gchar * basic,
  90                                                      GstRTSPToken *token);
  91 void                gst_rtsp_auth_remove_basic      (GstRTSPAuth *auth, const gchar * basic);
  92
  93 gboolean            gst_rtsp_auth_check             (const gchar *check);
  94
  95
  96 /* helpers */
  97 gchar *             gst_rtsp_auth_make_basic        (const gchar * user, const gchar * pass);
  98
  99 /* checks */
 100 /**
 101  * GST_RTSP_AUTH_CHECK_CONNECT:
 102  *
 103  * Check a new connection
 104  */
 105 #define GST_RTSP_AUTH_CHECK_CONNECT                  "auth.check.connect"
 106 /**
 107  * GST_RTSP_AUTH_CHECK_URL:
 108  *
 109  * Check the URL and methods
 110  */
 111 #define GST_RTSP_AUTH_CHECK_URL                      "auth.check.url"
 112 /**
 113  * GST_RTSP_AUTH_CHECK_MEDIA_FACTORY_ACCESS:
 114  *
 115  * Check if access is allowed to a factory.
 116  * When access is not allowed an 404 Not Found is sent in the response.
 117  */
 118 #define GST_RTSP_AUTH_CHECK_MEDIA_FACTORY_ACCESS     "auth.check.media.factory.access"
 119 /**
 120  * GST_RTSP_AUTH_CHECK_MEDIA_FACTORY_CONSTRUCT:
 121  *
 122  * Check if media can be constructed from a media factory
 123  * A response should be sent on error.
 124  */
 125 #define GST_RTSP_AUTH_CHECK_MEDIA_FACTORY_CONSTRUCT  "auth.check.media.factory.construct"
 126 /**
 127  * GST_RTSP_AUTH_CHECK_TRANSPORT_CLIENT_SETTINGS:
 128  *
 129  * Check if the client can specify TTL, destination and
 130  * port pair in multicast. No response is sent when the check returns
 131  * %FALSE.
 132  */
 133 #define GST_RTSP_AUTH_CHECK_TRANSPORT_CLIENT_SETTINGS  "auth.check.transport.client-settings"
 134
 135
 136 /* tokens */
 137 /**
 138  * GST_RTSP_TOKEN_MEDIA_FACTORY_ROLE:
 139  *
 140  * G_TYPE_STRING, the role to use when dealing with media factories
 141  *
 142  * The default #GstRTSPAuth object uses this string in the token to find the
 143  * role of the media factory. It will then retrieve the #GstRTSPPermissions of
 144  * the media factory and retrieve the role with the same name.
 145  */
 146 #define GST_RTSP_TOKEN_MEDIA_FACTORY_ROLE      "media.factory.role"
 147 /**
 148  * GST_RTSP_TOKEN_TRANSPORT_CLIENT_SETTINGS:
 149  *
 150  * G_TYPE_BOOLEAN, %TRUE if the client can specify TTL, destination and
 151  *     port pair in multicast.
 152  */
 153 #define GST_RTSP_TOKEN_TRANSPORT_CLIENT_SETTINGS   "transport.client-settings"
 154
 155 /* permissions */
 156 /**
 157  * GST_RTSP_PERM_MEDIA_FACTORY_ACCESS:
 158  *
 159  * G_TYPE_BOOLEAN, %TRUE if the media can be accessed, %FALSE will
 160  * return a 404 Not Found error when trying to access the media.
 161  */
 162 #define GST_RTSP_PERM_MEDIA_FACTORY_ACCESS      "media.factory.access"
 163 /**
 164  * GST_RTSP_PERM_MEDIA_FACTORY_CONSTRUCT:
 165  *
 166  * G_TYPE_BOOLEAN, %TRUE if the media can be constructed, %FALSE will
 167  * return a 404 Not Found error when trying to access the media.
 168  */
 169 #define GST_RTSP_PERM_MEDIA_FACTORY_CONSTRUCT   "media.factory.construct"
 170
 171 G_END_DECLS
 172
 173 #endif /* __GST_RTSP_AUTH_H__ */