]> git.sesse.net Git - vlc/blob - src/network/tls.c
Rework/simplify the TLS plugin interface (LibVLC <-> tls plugin).
[vlc] / src / network / tls.c
1 /*****************************************************************************
2  * tls.c
3  *****************************************************************************
4  * Copyright © 2004-2007 Rémi Denis-Courmont
5  * $Id$
6  *
7  * Authors: Rémi Denis-Courmont <rem # videolan.org>
8  *
9  * This program is free software; you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation; either version 2 of the License, or
12  * (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software
21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22  *****************************************************************************/
23
24 /**
25  * @file
26  * libvlc interface to the Transport Layer Security (TLS) plugins.
27  */
28
29 #include <vlc/vlc.h>
30 #include "libvlc.h"
31
32 #include <vlc_tls.h>
33
34 /**
35  * Allocates a whole server's TLS credentials.
36  *
37  * @param cert_path required (Unicode) path to an x509 certificate,
38  *                  if NULL, anonymous key exchange will be used.
39  * @param key_path (UTF-8) path to the PKCS private key for the certificate,
40  *                 if NULL; cert_path will be used.
41  *
42  * @return NULL on error.
43  */
44 tls_server_t *
45 tls_ServerCreate (vlc_object_t *obj, const char *cert_path,
46                   const char *key_path)
47 {
48     tls_server_t *srv;
49
50     srv = (tls_server_t *)vlc_custom_create (obj, sizeof (*srv),
51                                              VLC_OBJECT_GENERIC,
52                                              "tls server");
53     if (srv == NULL)
54         return NULL;
55
56     var_Create (srv, "tls-x509-cert", VLC_VAR_STRING);
57     var_Create (srv, "tls-x509-key", VLC_VAR_STRING);
58
59     if (cert_path != NULL)
60     {
61         var_SetString (srv, "tls-x509-cert", cert_path);
62
63         if (key_path == NULL)
64             key_path = cert_path;
65         var_SetString (srv, "tls-x509-key", key_path);
66     }
67
68     srv->p_module = module_Need (srv, "tls server", 0, 0);
69     if (srv->p_module == NULL)
70     {
71         msg_Err (srv, "TLS server plugin not available");
72         vlc_object_destroy (srv);
73         return NULL;
74     }
75
76     vlc_object_attach (srv, obj);
77     msg_Dbg (srv, "TLS server plugin initialized");
78     return srv;
79 }
80
81
82 /**
83  * Releases data allocated with tls_ServerCreate.
84  * @param srv TLS server object to be destroyed, or NULL
85  */
86 void tls_ServerDelete (tls_server_t *srv)
87 {
88     if (srv == NULL)
89         return;
90
91     module_Unneed (srv, srv->p_module);
92     vlc_object_detach (srv);
93     vlc_object_destroy (srv);
94 }
95
96
97 /**
98  * Allocates a client's TLS credentials and shakes hands through the network.
99  * This is a blocking network operation.
100  *
101  * @param fd stream socket through which to establish the secure communication
102  * layer.
103  * @param psz_hostname Server Name Indication to pass to the server, or NULL.
104  *
105  * @return NULL on error.
106  **/
107 tls_session_t *
108 tls_ClientCreate (vlc_object_t *obj, int fd, const char *psz_hostname)
109 {
110     tls_session_t *cl;
111
112     cl = (tls_session_t *)vlc_custom_create (obj, sizeof (*cl),
113                                              VLC_OBJECT_GENERIC,
114                                              "tls client");
115     if (cl == NULL)
116         return NULL;
117
118     cl->p_module = module_Need (cl, "tls client", 0, 0);
119     if (cl->p_module == NULL)
120     {
121         msg_Err (cl, "TLS client plugin not available");
122         vlc_object_destroy (cl);
123         return NULL;
124     }
125
126     int val = tls_ClientSessionHandshake (cl, fd, psz_hostname);
127     while (val > 0)
128         val = tls_SessionContinueHandshake (cl);
129
130     if (val == 0)
131     {
132         msg_Dbg (cl, "TLS client session initialized");
133         vlc_object_attach (cl, obj);
134         return cl;
135     }
136     msg_Err (cl, "TLS client session handshake error");
137
138     module_Unneed (cl, cl->p_module);
139     vlc_object_destroy (cl);
140     return NULL;
141 }
142
143
144 /**
145  * Releases data allocated with tls_ClientCreate.
146  * It is your job to close the underlying socket.
147  */
148 void tls_ClientDelete (tls_session_t *cl)
149 {
150     if (cl == NULL)
151         return;
152
153     module_Unneed (cl, cl->p_module);
154     vlc_object_detach (cl);
155     vlc_object_destroy (cl);
156 }