token: add authorization token

Add a simply miniobject that contains the authorizations. The object contains a
GstStructure that hold all authorization fields. When a user is authenticated,
the auth module will create a Token for the user. The token is then used to
check what operations the user is allowed to do and various other configuration
values.

gst/rtsp-server/Makefile.am

@@ -12,6 +12,7 @@ public_headers = \
 		rtsp-session.h \
 		rtsp-session-media.h \
 		rtsp-session-pool.h \
+		rtsp-token.h \
 		rtsp-client.h \
 		rtsp-server.h
 
@@ -29,6 +30,7 @@ c_sources = \
 	rtsp-session.c \
 	rtsp-session-media.c \
 	rtsp-session-pool.c \
+	rtsp-token.c \
 	rtsp-client.c \
 	rtsp-server.c
 

gst/rtsp-server/rtsp-token.c

@@ -0,0 +1,156 @@
+/* GStreamer
+ * Copyright (C) 2010 Wim Taymans <wim.taymans at gmail.com>
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Library General Public
+ * License as published by the Free Software Foundation; either
+ * version 2 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Library General Public License for more details.
+ *
+ * You should have received a copy of the GNU Library General Public
+ * License along with this library; if not, write to the
+ * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
+ * Boston, MA 02110-1301, USA.
+ */
+
+#include <string.h>
+
+#include "rtsp-token.h"
+
+typedef struct _GstRTSPTokenImpl
+{
+  GstRTSPToken token;
+
+  GstStructure *structure;
+} GstRTSPTokenImpl;
+
+#define GST_RTSP_TOKEN_STRUCTURE(t)  (((GstRTSPTokenImpl *)(t))->structure)
+
+//GST_DEBUG_CATEGORY_STATIC (rtsp_token_debug);
+//#define GST_CAT_DEFAULT rtsp_token_debug
+
+GST_DEFINE_MINI_OBJECT_TYPE (GstRTSPToken, gst_rtsp_token);
+
+static void gst_rtsp_token_init (GstRTSPTokenImpl * token,
+    GstStructure * structure);
+
+static void
+_gst_rtsp_token_free (GstRTSPToken * token)
+{
+  GstRTSPTokenImpl *impl = (GstRTSPTokenImpl *) token;
+
+  gst_structure_set_parent_refcount (impl->structure, NULL);
+  gst_structure_free (impl->structure);
+
+  g_slice_free1 (sizeof (GstRTSPTokenImpl), token);
+}
+
+static GstRTSPToken *
+_gst_rtsp_token_copy (GstRTSPTokenImpl * token)
+{
+  GstRTSPTokenImpl *copy;
+  GstStructure *structure;
+
+  structure = gst_structure_copy (token->structure);
+
+  copy = g_slice_new0 (GstRTSPTokenImpl);
+  gst_rtsp_token_init (copy, structure);
+
+  return (GstRTSPToken *) copy;
+}
+
+static void
+gst_rtsp_token_init (GstRTSPTokenImpl * token, GstStructure * structure)
+{
+  gst_mini_object_init (GST_MINI_OBJECT_CAST (token), 0,
+      GST_TYPE_RTSP_TOKEN,
+      (GstMiniObjectCopyFunction) _gst_rtsp_token_copy, NULL,
+      (GstMiniObjectFreeFunction) _gst_rtsp_token_free);
+
+  token->structure = structure;
+  gst_structure_set_parent_refcount (token->structure,
+      &token->token.mini_object.refcount);
+}
+
+/**
+ * gst_rtsp_token_new:
+ *
+ * Create a new empty Authorization token.
+ *
+ * Returns: (transfer full): a new empty authorization token.
+ */
+GstRTSPToken *
+gst_rtsp_token_new (void)
+{
+  GstRTSPTokenImpl *token;
+
+  token = g_slice_new0 (GstRTSPTokenImpl);
+
+  gst_rtsp_token_init (token, gst_structure_new_empty ("GstRTSPToken"));
+
+  return (GstRTSPToken *) token;
+}
+
+
+/**
+ * gst_rtsp_token_get_structure:
+ * @token: The #GstRTSPToken.
+ *
+ * Access the structure of the token.
+ *
+ * Returns: The structure of the token. The structure is still
+ * owned by the token, which means that you should not free it and
+ * that the pointer becomes invalid when you free the token.
+ *
+ * MT safe.
+ */
+const GstStructure *
+gst_rtsp_token_get_structure (GstRTSPToken * token)
+{
+  g_return_val_if_fail (GST_IS_RTSP_TOKEN (token), NULL);
+
+  return GST_RTSP_TOKEN_STRUCTURE (token);
+}
+
+/**
+ * gst_rtsp_token_writable_structure:
+ * @token: The #GstRTSPToken.
+ *
+ * Get a writable version of the structure.
+ *
+ * Returns: The structure of the token. The structure is still
+ * owned by the token, which means that you should not free it and
+ * that the pointer becomes invalid when you free the token.
+ * This function checks if @token is writable and will never return NULL.
+ *
+ * MT safe.
+ */
+GstStructure *
+gst_rtsp_token_writable_structure (GstRTSPToken * token)
+{
+  g_return_val_if_fail (GST_IS_RTSP_TOKEN (token), NULL);
+  g_return_val_if_fail (gst_mini_object_is_writable (GST_MINI_OBJECT_CAST
+          (token)), NULL);
+
+  return GST_RTSP_TOKEN_STRUCTURE (token);
+}
+
+/**
+ * gst_rtsp_token_get_string:
+ * @token: a #GstRTSPToken
+ * @field: a field name
+ *
+ * Get the string value of @field in @token.
+ *
+ * Returns: the string value of @field in @token or NULL when @field is not
+ * defined in @token.
+ */
+const gchar *
+gst_rtsp_token_get_string (GstRTSPToken * token, const gchar * field)
+{
+  return gst_structure_get_string (GST_RTSP_TOKEN_STRUCTURE (token), field);
+}

gst/rtsp-server/rtsp-token.h

@@ -0,0 +1,93 @@
+/* GStreamer
+ * Copyright (C) 2010 Wim Taymans <wim.taymans at gmail.com>
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Library General Public
+ * License as published by the Free Software Foundation; either
+ * version 2 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Library General Public License for more details.
+ *
+ * You should have received a copy of the GNU Library General Public
+ * License along with this library; if not, write to the
+ * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
+ * Boston, MA 02110-1301, USA.
+ */
+
+#include <gst/gst.h>
+
+#ifndef __GST_RTSP_TOKEN_H__
+#define __GST_RTSP_TOKEN_H__
+
+typedef struct _GstRTSPToken GstRTSPToken;
+
+#include "rtsp-auth.h"
+
+G_BEGIN_DECLS
+
+GType gst_rtsp_token_get_type(void);
+
+#define GST_TYPE_RTSP_TOKEN        (gst_rtsp_token_get_type())
+#define GST_IS_RTSP_TOKEN(obj)     (GST_IS_MINI_OBJECT_TYPE (obj, GST_TYPE_RTSP_TOKEN))
+#define GST_RTSP_TOKEN_CAST(obj)   ((GstRTSPToken*)(obj))
+#define GST_RTSP_TOKEN(obj)        (GST_RTSP_TOKEN_CAST(obj))
+
+/**
+ * GstRTSPToken:
+ *
+ * An opaque object used for checking authorisations.
+ * It is generated after successfull authentication.
+ */
+struct _GstRTSPToken {
+  GstMiniObject mini_object;
+};
+
+/* refcounting */
+/**
+ * gst_rtsp_token_ref:
+ * @token: The token to refcount
+ *
+ * Increase the refcount of this token.
+ *
+ * Returns: (transfer full): @token (for convenience when doing assignments)
+ */
+#ifdef _FOOL_GTK_DOC_
+G_INLINE_FUNC GstRTSPToken * gst_rtsp_token_ref (GstRTSPToken * token);
+#endif
+
+static inline GstRTSPToken *
+gst_rtsp_token_ref (GstRTSPToken * token)
+{
+  return (GstRTSPToken *) gst_mini_object_ref (GST_MINI_OBJECT_CAST (token));
+}
+
+/**
+ * gst_rtsp_token_unref:
+ * @token: (transfer full): the token to refcount
+ *
+ * Decrease the refcount of an token, freeing it if the refcount reaches 0.
+ */
+#ifdef _FOOL_GTK_DOC_
+G_INLINE_FUNC void gst_rtsp_token_unref (GstRTSPToken * token);
+#endif
+
+static inline void
+gst_rtsp_token_unref (GstRTSPToken * token)
+{
+  gst_mini_object_unref (GST_MINI_OBJECT_CAST (token));
+}
+
+
+GstRTSPToken *       gst_rtsp_token_new                (void);
+
+const GstStructure * gst_rtsp_token_get_structure      (GstRTSPToken *token);
+GstStructure *       gst_rtsp_token_writable_structure (GstRTSPToken *token);
+
+const gchar *        gst_rtsp_token_get_string         (GstRTSPToken *token,
+                                                        const gchar *field);
+G_END_DECLS
+
+#endif /* __GST_RTSP_TOKEN_H__ */