]> git.sesse.net Git - vlc/blobdiff - include/vlc_tls.h
LGPL
[vlc] / include / vlc_tls.h
index 1808231749b6ad19794293fc567a8382876fa020..66fcafda5ef1869d502cdc11a82e899ecb99c6d2 100644 (file)
 /*****************************************************************************
- * tls.c
+ * vlc_tls.h: Transport Layer Security API
  *****************************************************************************
- * Copyright (C) 2004-2005 VideoLAN
- * $Id$
+ * Copyright (C) 2004-2011 RĂ©mi Denis-Courmont
+ * Copyright (C) 2005-2006 VLC authors and VideoLAN
  *
- * Authors: Remi Denis-Courmont <rem # videolan.org>
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
+ * This program is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation; either version 2.1 of the License, or
  * (at your option) any later version.
  *
  * This program 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 General Public License for more details.
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Lesser General Public License for more details.
  *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  *****************************************************************************/
 
-#ifndef _VLC_TLS_H
-# define _VLC_TLS_H
-
-# include "network.h"
+#ifndef VLC_TLS_H
+# define VLC_TLS_H
 
-struct tls_t
-{
-    VLC_COMMON_MEMBERS
+/**
+ * \file
+ * This file defines Transport Layer Security API (TLS) in vlc
+ */
 
-    /* Module properties */
-    module_t  *p_module;
-    void *p_sys;
+# include <vlc_network.h>
 
-    tls_server_t * (*pf_server_create) ( tls_t *, const char *,
-                                         const char * );
-    tls_session_t * (*pf_client_create) ( tls_t * );
-};
+typedef struct vlc_tls_sys vlc_tls_sys_t;
 
-struct tls_server_t
+typedef struct vlc_tls
 {
     VLC_COMMON_MEMBERS
 
-    void *p_sys;
-
-    void (*pf_delete) ( tls_server_t * );
-    
-    int (*pf_add_CA) ( tls_server_t *, const char * );
-    int (*pf_add_CRL) ( tls_server_t *, const char * );
-    
-    tls_session_t * (*pf_session_prepare) ( tls_server_t * );
-};
-
-struct tls_session_t
-{
-    VLC_COMMON_MEMBERS
-
-    void *p_sys;
+    union {
+        module_t *module; /**< Plugin handle (client) */
+        void    (*close) (struct vlc_tls *); /**< Close callback (server) */
+    } u;
+    vlc_tls_sys_t *sys;
 
     struct virtual_socket_t sock;
-    int (*pf_handshake) ( tls_session_t *, int, const char * );
-    int (*pf_handshake2) ( tls_session_t * );
-    void (*pf_close) ( tls_session_t * );
-};
-
-
-/*****************************************************************************
- * tls_ServerCreate:
- *****************************************************************************
- * Allocates a whole server's TLS credentials.
- * Returns NULL on error.
- *****************************************************************************/
-VLC_EXPORT( tls_server_t *, tls_ServerCreate, ( vlc_object_t *, const char *, const char * ) );
+    int  (*handshake) (struct vlc_tls *);
+} vlc_tls_t;
 
-/*****************************************************************************
- * tls_ServerAddCA:
- *****************************************************************************
- * Adds one or more certificate authorities.
- * Returns -1 on error, 0 on success.
- *****************************************************************************/
-# define tls_ServerAddCA( a, b ) (((tls_server_t *)a)->pf_add_CA (a, b))
-
-
-/*****************************************************************************
- * tls_ServerAddCRL:
- *****************************************************************************
- * Adds a certificates revocation list to be sent to TLS clients.
- * Returns -1 on error, 0 on success.
- *****************************************************************************/
-# define tls_ServerAddCRL( a, b ) (((tls_server_t *)a)->pf_add_CRL (a, b))
+VLC_API vlc_tls_t *vlc_tls_ClientCreate (vlc_object_t *, int fd,
+                                         const char *hostname);
+VLC_API void vlc_tls_ClientDelete (vlc_tls_t *);
 
+/* NOTE: It is assumed that a->sock.p_sys = a */
+# define tls_Send( a, b, c ) (((vlc_tls_t *)a)->sock.pf_send (a, b, c))
 
-VLC_EXPORT( void, tls_ServerDelete, ( tls_server_t * ) );
+# define tls_Recv( a, b, c ) (((vlc_tls_t *)a)->sock.pf_recv (a, b, c))
 
 
-# define tls_ServerSessionPrepare( a ) (((tls_server_t *)a)->pf_session_prepare (a))
-# define tls_ServerSessionHandshake( a, b ) (((tls_session_t *)a)->pf_handshake (a, b, NULL))
-# define tls_ServerSessionClose( a ) (((tls_session_t *)a)->pf_close (a))
+typedef struct vlc_tls_creds_sys vlc_tls_creds_sys_t;
 
-VLC_EXPORT( tls_session_t *, tls_ClientCreate, ( vlc_object_t *, int, const char * ) );
-VLC_EXPORT( void, tls_ClientDelete, ( tls_session_t * ) );
+/** TLS (server-side) credentials */
+typedef struct vlc_tls_creds
+{
+    VLC_COMMON_MEMBERS
 
-# define tls_ClientSessionHandshake( a, b, c ) (((tls_session_t *)a)->pf_handshake (a, b, c))
+    module_t  *module;
+    vlc_tls_creds_sys_t *sys;
 
-# define tls_SessionContinueHandshake( a ) (((tls_session_t *)a)->pf_handshake2 (a))
+    int (*add_CA) (struct vlc_tls_creds *, const char *path);
+    int (*add_CRL) (struct vlc_tls_creds *, const char *path);
 
+    vlc_tls_t *(*open) (struct vlc_tls_creds *, int fd);
+} vlc_tls_creds_t;
 
-/* NOTE: It is assumed that a->sock.p_sys = a */
-# define tls_Send( a, b, c ) (((tls_session_t *)a)->sock.pf_send (a, b, c ))
+vlc_tls_creds_t *vlc_tls_ServerCreate (vlc_object_t *,
+                                       const char *cert, const char *key);
+void vlc_tls_ServerDelete (vlc_tls_creds_t *);
+int vlc_tls_ServerAddCA (vlc_tls_creds_t *srv, const char *path);
+int vlc_tls_ServerAddCRL (vlc_tls_creds_t *srv, const char *path);
 
-# define tls_Recv( a, b, c ) (((tls_session_t *)a)->sock.pf_recv (a, b, c ))
+vlc_tls_t *vlc_tls_ServerSessionCreate (vlc_tls_creds_t *, int fd);
+int vlc_tls_ServerSessionHandshake (vlc_tls_t *);
+void vlc_tls_ServerSessionDelete (vlc_tls_t *);
 
 #endif