1 /*****************************************************************************
3 *****************************************************************************
4 * Copyright © 2004-2007 Rémi Denis-Courmont
7 * Authors: Rémi Denis-Courmont <rem # videolan.org>
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.
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.
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 *****************************************************************************/
26 * libvlc interface to the Transport Layer Security (TLS) plugins.
33 #include <vlc_common.h>
39 * Allocates a whole server's TLS credentials.
41 * @param cert_path required (Unicode) path to an x509 certificate,
42 * if NULL, anonymous key exchange will be used.
43 * @param key_path (UTF-8) path to the PKCS private key for the certificate,
44 * if NULL; cert_path will be used.
46 * @return NULL on error.
49 tls_ServerCreate (vlc_object_t *obj, const char *cert_path,
54 srv = (tls_server_t *)vlc_custom_create (obj, sizeof (*srv),
60 var_Create (srv, "tls-x509-cert", VLC_VAR_STRING);
61 var_Create (srv, "tls-x509-key", VLC_VAR_STRING);
63 if (cert_path != NULL)
65 var_SetString (srv, "tls-x509-cert", cert_path);
69 var_SetString (srv, "tls-x509-key", key_path);
72 vlc_object_attach (srv, obj);
73 srv->p_module = module_need (srv, "tls server", NULL, false );
74 if (srv->p_module == NULL)
76 msg_Err (srv, "TLS server plugin not available");
77 vlc_object_release (srv);
81 msg_Dbg (srv, "TLS server plugin initialized");
87 * Releases data allocated with tls_ServerCreate.
88 * @param srv TLS server object to be destroyed, or NULL
90 void tls_ServerDelete (tls_server_t *srv)
95 module_unneed (srv, srv->p_module);
96 vlc_object_release (srv);
101 * Adds one or more certificate authorities from a file.
102 * @return -1 on error, 0 on success.
104 int tls_ServerAddCA (tls_server_t *srv, const char *path)
106 return srv->pf_add_CA (srv, path);
111 * Adds one or more certificate revocation list from a file.
112 * @return -1 on error, 0 on success.
114 int tls_ServerAddCRL (tls_server_t *srv, const char *path)
116 return srv->pf_add_CRL (srv, path);
120 tls_session_t *tls_ServerSessionPrepare (tls_server_t *srv)
124 ses = srv->pf_open (srv);
128 vlc_object_attach (ses, srv);
133 void tls_ServerSessionClose (tls_session_t *ses)
135 tls_server_t *srv = (tls_server_t *)(ses->p_parent);
136 srv->pf_close (srv, ses);
140 int tls_ServerSessionHandshake (tls_session_t *ses, int fd)
142 ses->pf_set_fd (ses, fd);
147 int tls_SessionContinueHandshake (tls_session_t *ses)
149 int val = ses->pf_handshake (ses);
151 tls_ServerSessionClose (ses);
157 * Allocates a client's TLS credentials and shakes hands through the network.
158 * This is a blocking network operation.
160 * @param fd stream socket through which to establish the secure communication
162 * @param psz_hostname Server Name Indication to pass to the server, or NULL.
164 * @return NULL on error.
167 tls_ClientCreate (vlc_object_t *obj, int fd, const char *psz_hostname)
172 cl = (tls_session_t *)vlc_custom_create (obj, sizeof (*cl),
178 var_Create (cl, "tls-server-name", VLC_VAR_STRING);
179 if (psz_hostname != NULL)
181 msg_Dbg (cl, "requested server name: %s", psz_hostname);
182 var_SetString (cl, "tls-server-name", psz_hostname);
185 msg_Dbg (cl, "requested anonymous server");
187 vlc_object_attach (cl, obj);
188 cl->p_module = module_need (cl, "tls client", NULL, false );
189 if (cl->p_module == NULL)
191 msg_Err (cl, "TLS client plugin not available");
192 vlc_object_release (cl);
196 cl->pf_set_fd (cl, fd);
199 val = cl->pf_handshake (cl);
204 msg_Dbg (cl, "TLS client session initialized");
207 msg_Err (cl, "TLS client session handshake error");
209 module_unneed (cl, cl->p_module);
210 vlc_object_release (cl);
216 * Releases data allocated with tls_ClientCreate.
217 * It is your job to close the underlying socket.
219 void tls_ClientDelete (tls_session_t *cl)
224 module_unneed (cl, cl->p_module);
225 vlc_object_release (cl);