GstRTSPAuth: Add client certificate authentication support
authorXavier Claessens <xavier.claessens@collabora.com>
Sat, 6 Jun 2015 02:35:39 +0000 (22:35 -0400)
committerOlivier CrĂȘte <olivier.crete@collabora.com>
Tue, 9 Jun 2015 23:51:46 +0000 (19:51 -0400)
https://bugzilla.gnome.org/show_bug.cgi?id=750471

docs/libs/gst-rtsp-server-sections.txt
gst/rtsp-server/rtsp-auth.c
gst/rtsp-server/rtsp-auth.h

index fe38081..69d87d8 100644 (file)
@@ -44,6 +44,10 @@ gst_rtsp_auth_new
 
 gst_rtsp_auth_get_tls_certificate
 gst_rtsp_auth_set_tls_certificate
+gst_rtsp_auth_get_tls_database
+gst_rtsp_auth_set_tls_database
+gst_rtsp_auth_get_tls_authentication_mode
+gst_rtsp_auth_set_tls_authentication_mode
 gst_rtsp_auth_make_basic
 gst_rtsp_auth_add_basic
 gst_rtsp_auth_remove_basic
index b0e924e..654388a 100644 (file)
@@ -59,6 +59,8 @@ struct _GstRTSPAuthPrivate
 
   /* the TLS certificate */
   GTlsCertificate *certificate;
+  GTlsDatabase *database;
+  GTlsAuthenticationMode mode;
   GHashTable *basic;            /* protected by lock */
   GstRTSPToken *default_token;
   GstRTSPMethod methods;
@@ -70,6 +72,14 @@ enum
   PROP_LAST
 };
 
+enum
+{
+  SIGNAL_ACCEPT_CERTIFICATE,
+  SIGNAL_LAST
+};
+
+static guint signals[SIGNAL_LAST] = { 0 };
+
 GST_DEBUG_CATEGORY_STATIC (rtsp_auth_debug);
 #define GST_CAT_DEFAULT rtsp_auth_debug
 
@@ -102,6 +112,31 @@ gst_rtsp_auth_class_init (GstRTSPAuthClass * klass)
   klass->check = default_check;
 
   GST_DEBUG_CATEGORY_INIT (rtsp_auth_debug, "rtspauth", 0, "GstRTSPAuth");
+
+  /**
+   * GstRTSPAuth::accept-certificate:
+   * @auth: a #GstRTSPAuth
+   * @connection: a #GTlsConnection
+   * @peer_cert: the peer's #GTlsCertificate
+   * @errors: the problems with @peer_cert.
+   *
+   * Emitted during the TLS handshake after the client certificate has
+   * been received. See also gst_rtsp_auth_set_tls_authentication_mode().
+   *
+   * Returns: %TRUE to accept @peer_cert (which will also
+   * immediately end the signal emission). %FALSE to allow the signal
+   * emission to continue, which will cause the handshake to fail if
+   * no one else overrides it.
+   *
+   * Since: 1.6
+   */
+  signals[SIGNAL_ACCEPT_CERTIFICATE] = g_signal_new ("accept-certificate",
+      G_TYPE_FROM_CLASS (gobject_class),
+      G_SIGNAL_RUN_LAST,
+      G_STRUCT_OFFSET (GstRTSPAuthClass, accept_certificate),
+      g_signal_accumulator_true_handled, NULL, g_cclosure_marshal_generic,
+      G_TYPE_BOOLEAN, 3, G_TYPE_TLS_CONNECTION, G_TYPE_TLS_CERTIFICATE,
+      G_TYPE_TLS_CERTIFICATE_FLAGS);
 }
 
 static void
@@ -130,6 +165,8 @@ gst_rtsp_auth_finalize (GObject * obj)
 
   if (priv->certificate)
     g_object_unref (priv->certificate);
+  if (priv->database)
+    g_object_unref (priv->database);
   g_hash_table_unref (priv->basic);
   g_mutex_clear (&priv->lock);
 
@@ -231,6 +268,118 @@ gst_rtsp_auth_get_tls_certificate (GstRTSPAuth * auth)
 }
 
 /**
+ * gst_rtsp_auth_set_tls_database:
+ * @auth: a #GstRTSPAuth
+ * @database: (transfer none) (allow-none): a #GTlsDatabase
+ *
+ * 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
+ */
+void
+gst_rtsp_auth_set_tls_database (GstRTSPAuth * auth, GTlsDatabase * database)
+{
+  GstRTSPAuthPrivate *priv;
+  GTlsDatabase *old;
+
+  g_return_if_fail (GST_IS_RTSP_AUTH (auth));
+
+  priv = auth->priv;
+
+  if (database)
+    g_object_ref (database);
+
+  g_mutex_lock (&priv->lock);
+  old = priv->database;
+  priv->database = database;
+  g_mutex_unlock (&priv->lock);
+
+  if (old)
+    g_object_unref (old);
+}
+
+/**
+ * gst_rtsp_auth_get_tls_database:
+ * @auth: a #GstRTSPAuth
+ *
+ * Get the #GTlsDatabase used for verifying client certificate.
+ *
+ * Returns: (transfer full): the #GTlsDatabase of @auth. g_object_unref() after
+ * usage.
+ * Since: 1.6
+ */
+GTlsDatabase *
+gst_rtsp_auth_get_tls_database (GstRTSPAuth * auth)
+{
+  GstRTSPAuthPrivate *priv;
+  GTlsDatabase *result;
+
+  g_return_val_if_fail (GST_IS_RTSP_AUTH (auth), NULL);
+
+  priv = auth->priv;
+
+  g_mutex_lock (&priv->lock);
+  if ((result = priv->database))
+    g_object_ref (result);
+  g_mutex_unlock (&priv->lock);
+
+  return result;
+}
+
+/**
+ * gst_rtsp_auth_set_tls_authentication_mode:
+ * @auth: a #GstRTSPAuth
+ * @mode: (transfer none) (allow-none): a #GTlsAuthenticationMode
+ *
+ * The #GTlsAuthenticationMode to set on the underlying GTlsServerConnection.
+ * When set to another value than %G_TLS_AUTHENTICATION_NONE,
+ * #GstRTSPAuth::accept-certificate signal will be emitted and must be handled.
+ *
+ * Since: 1.6
+ */
+void
+gst_rtsp_auth_set_tls_authentication_mode (GstRTSPAuth * auth,
+    GTlsAuthenticationMode mode)
+{
+  GstRTSPAuthPrivate *priv;
+
+  g_return_if_fail (GST_IS_RTSP_AUTH (auth));
+
+  priv = auth->priv;
+
+  g_mutex_lock (&priv->lock);
+  priv->mode = mode;
+  g_mutex_unlock (&priv->lock);
+}
+
+/**
+ * gst_rtsp_auth_get_tls_authentication_mode:
+ * @auth: a #GstRTSPAuth
+ *
+ * Get the #GTlsAuthenticationMode.
+ *
+ * Returns: (transfer full): the #GTlsAuthenticationMode.
+ */
+GTlsAuthenticationMode
+gst_rtsp_auth_get_tls_authentication_mode (GstRTSPAuth * auth)
+{
+  GstRTSPAuthPrivate *priv;
+  GTlsAuthenticationMode result;
+
+  g_return_val_if_fail (GST_IS_RTSP_AUTH (auth), G_TLS_AUTHENTICATION_NONE);
+
+  priv = auth->priv;
+
+  g_mutex_lock (&priv->lock);
+  result = priv->mode;
+  g_mutex_unlock (&priv->lock);
+
+  return result;
+}
+
+/**
  * gst_rtsp_auth_set_default_token:
  * @auth: a #GstRTSPAuth
  * @token: (transfer none) (allow-none): a #GstRTSPToken
@@ -431,19 +580,40 @@ no_auth:
   }
 }
 
+static gboolean
+accept_certificate_cb (GTlsConnection * conn, GTlsCertificate * peer_cert,
+    GTlsCertificateFlags errors, GstRTSPAuth * auth)
+{
+  gboolean ret = FALSE;
+
+  g_signal_emit (auth, signals[SIGNAL_ACCEPT_CERTIFICATE], 0,
+      conn, peer_cert, errors, &ret);
+
+  return ret;
+}
+
 /* new connection */
 static gboolean
 check_connect (GstRTSPAuth * auth, GstRTSPContext * ctx, const gchar * check)
 {
   GstRTSPAuthPrivate *priv = auth->priv;
+  GTlsConnection *tls;
 
-  if (priv->certificate) {
-    GTlsConnection *tls;
+  /* configure the connection */
 
-    /* configure the connection */
+  if (priv->certificate) {
     tls = gst_rtsp_connection_get_tls (ctx->conn, NULL);
     g_tls_connection_set_certificate (tls, priv->certificate);
   }
+
+  if (priv->mode != G_TLS_AUTHENTICATION_NONE) {
+    tls = gst_rtsp_connection_get_tls (ctx->conn, NULL);
+    g_tls_connection_set_database (tls, priv->database);
+    g_object_set (tls, "authentication-mode", priv->mode, NULL);
+    g_signal_connect (tls, "accept-certificate",
+        G_CALLBACK (accept_certificate_cb), auth);
+  }
+
   return TRUE;
 }
 
index cb281f0..ac44b28 100644 (file)
@@ -72,8 +72,12 @@ struct _GstRTSPAuthClass {
   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);
   /*< private >*/
-  gpointer            _gst_reserved[GST_PADDING];
+  gpointer            _gst_reserved[GST_PADDING - 1];
 };
 
 GType               gst_rtsp_auth_get_type          (void);
@@ -83,6 +87,12 @@ GstRTSPAuth *       gst_rtsp_auth_new               (void);
 void                gst_rtsp_auth_set_tls_certificate (GstRTSPAuth *auth, GTlsCertificate *cert);
 GTlsCertificate *   gst_rtsp_auth_get_tls_certificate (GstRTSPAuth *auth);
 
+void                gst_rtsp_auth_set_tls_database (GstRTSPAuth *auth, GTlsDatabase *database);
+GTlsDatabase *      gst_rtsp_auth_get_tls_database (GstRTSPAuth *auth);
+
+void                gst_rtsp_auth_set_tls_authentication_mode (GstRTSPAuth *auth, GTlsAuthenticationMode mode);
+GTlsAuthenticationMode gst_rtsp_auth_get_tls_authentication_mode (GstRTSPAuth *auth);
+
 void                gst_rtsp_auth_set_default_token (GstRTSPAuth *auth, GstRTSPToken *token);
 GstRTSPToken *      gst_rtsp_auth_get_default_token (GstRTSPAuth *auth);