3 * Copyright (c) 2011 Martin Storsjo
5 * This file is part of FFmpeg.
7 * FFmpeg is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2.1 of the License, or (at your option) any later version.
12 * FFmpeg is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with FFmpeg; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
24 #include "libavutil/avstring.h"
25 #include "libavutil/opt.h"
26 #include "libavutil/parseutils.h"
28 #include "os_support.h"
31 #include <gnutls/gnutls.h>
32 #include <gnutls/x509.h>
33 #define TLS_read(c, buf, size) gnutls_record_recv((c)->session, (buf), (size))
34 #define TLS_write(c, buf, size) gnutls_record_send((c)->session, (buf), (size))
35 #define TLS_shutdown(c) gnutls_bye((c)->session, GNUTLS_SHUT_RDWR)
36 #define TLS_free(c) do { \
38 gnutls_deinit((c)->session); \
40 gnutls_certificate_free_credentials((c)->cred); \
43 #include <openssl/bio.h>
44 #include <openssl/ssl.h>
45 #include <openssl/err.h>
46 #define TLS_read(c, buf, size) SSL_read((c)->ssl, (buf), (size))
47 #define TLS_write(c, buf, size) SSL_write((c)->ssl, (buf), (size))
48 #define TLS_shutdown(c) SSL_shutdown((c)->ssl)
49 #define TLS_free(c) do { \
53 SSL_CTX_free((c)->ctx); \
60 typedef struct TLSContext {
64 gnutls_session_t session;
65 gnutls_certificate_credentials_t cred;
78 #define OFFSET(x) offsetof(TLSContext, x)
79 #define D AV_OPT_FLAG_DECODING_PARAM
80 #define E AV_OPT_FLAG_ENCODING_PARAM
81 static const AVOption options[] = {
82 {"ca_file", "Certificate Authority database file", OFFSET(ca_file), AV_OPT_TYPE_STRING, .flags = D|E },
83 {"cafile", "Certificate Authority database file", OFFSET(ca_file), AV_OPT_TYPE_STRING, .flags = D|E },
84 {"tls_verify", "Verify the peer certificate", OFFSET(verify), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, 1, .flags = D|E },
85 {"cert_file", "Certificate file", OFFSET(cert_file), AV_OPT_TYPE_STRING, .flags = D|E },
86 {"key_file", "Private key file", OFFSET(key_file), AV_OPT_TYPE_STRING, .flags = D|E },
87 {"listen", "Listen for incoming connections", OFFSET(listen), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, 1, .flags = D|E },
91 static const AVClass tls_class = {
93 .item_name = av_default_item_name,
95 .version = LIBAVUTIL_VERSION_INT,
98 static int do_tls_poll(URLContext *h, int ret)
100 TLSContext *c = h->priv_data;
101 struct pollfd p = { c->fd, 0, 0 };
105 case GNUTLS_E_INTERRUPTED:
107 case GNUTLS_E_WARNING_ALERT_RECEIVED:
108 av_log(h, AV_LOG_WARNING, "%s\n", gnutls_strerror(ret));
111 av_log(h, AV_LOG_ERROR, "%s\n", gnutls_strerror(ret));
114 if (gnutls_record_get_direction(c->session))
119 ret = SSL_get_error(c->ssl, ret);
120 if (ret == SSL_ERROR_WANT_READ) {
122 } else if (ret == SSL_ERROR_WANT_WRITE) {
125 av_log(h, AV_LOG_ERROR, "%s\n", ERR_error_string(ERR_get_error(), NULL));
129 if (h->flags & AVIO_FLAG_NONBLOCK)
130 return AVERROR(EAGAIN);
132 int n = poll(&p, 1, 100);
135 if (ff_check_interrupt(&h->interrupt_callback))
136 return AVERROR(EINTR);
141 static void set_options(URLContext *h, const char *uri)
143 TLSContext *c = h->priv_data;
145 const char *p = strchr(uri, '?');
149 if (!c->ca_file && av_find_info_tag(buf, sizeof(buf), "cafile", p))
150 c->ca_file = av_strdup(buf);
152 if (!c->verify && av_find_info_tag(buf, sizeof(buf), "verify", p)) {
154 c->verify = strtol(buf, &endptr, 10);
159 if (!c->cert_file && av_find_info_tag(buf, sizeof(buf), "cert", p))
160 c->cert_file = av_strdup(buf);
162 if (!c->key_file && av_find_info_tag(buf, sizeof(buf), "key", p))
163 c->key_file = av_strdup(buf);
166 static int tls_open(URLContext *h, const char *uri, int flags, AVDictionary **options)
168 TLSContext *c = h->priv_data;
172 char buf[200], host[200], opts[50] = "";
174 struct addrinfo hints = { 0 }, *ai = NULL;
175 const char *proxy_path;
178 if ((ret = ff_tls_init()) < 0)
182 snprintf(opts, sizeof(opts), "?listen=1");
184 av_url_split(NULL, 0, NULL, 0, host, sizeof(host), &port, NULL, 0, uri);
186 p = strchr(uri, '?');
191 if (av_find_info_tag(opts, sizeof(opts), "listen", p))
195 ff_url_join(buf, sizeof(buf), "tcp", NULL, host, port, "%s", p);
197 hints.ai_flags = AI_NUMERICHOST;
198 if (!getaddrinfo(host, NULL, &hints, &ai)) {
203 proxy_path = getenv("http_proxy");
204 use_proxy = !ff_http_match_no_proxy(getenv("no_proxy"), host) &&
205 proxy_path && av_strstart(proxy_path, "http://", NULL);
208 char proxy_host[200], proxy_auth[200], dest[200];
210 av_url_split(NULL, 0, proxy_auth, sizeof(proxy_auth),
211 proxy_host, sizeof(proxy_host), &proxy_port, NULL, 0,
213 ff_url_join(dest, sizeof(dest), NULL, NULL, host, port, NULL);
214 ff_url_join(buf, sizeof(buf), "httpproxy", proxy_auth, proxy_host,
215 proxy_port, "/%s", dest);
218 ret = ffurl_open(&c->tcp, buf, AVIO_FLAG_READ_WRITE,
219 &h->interrupt_callback, options);
222 c->fd = ffurl_get_file_handle(c->tcp);
225 gnutls_init(&c->session, c->listen ? GNUTLS_SERVER : GNUTLS_CLIENT);
226 if (!c->listen && !numerichost)
227 gnutls_server_name_set(c->session, GNUTLS_NAME_DNS, host, strlen(host));
228 gnutls_certificate_allocate_credentials(&c->cred);
231 ret = gnutls_certificate_set_x509_trust_file(c->cred, c->ca_file, GNUTLS_X509_FMT_PEM);
233 av_log(h, AV_LOG_ERROR, "%s\n", gnutls_strerror(ret));
235 #if GNUTLS_VERSION_MAJOR >= 3
237 gnutls_certificate_set_x509_system_trust(c->cred);
239 gnutls_certificate_set_verify_flags(c->cred, c->verify ?
240 GNUTLS_VERIFY_ALLOW_X509_V1_CA_CRT : 0);
241 if (c->cert_file && c->key_file) {
242 ret = gnutls_certificate_set_x509_key_file(c->cred,
243 c->cert_file, c->key_file,
244 GNUTLS_X509_FMT_PEM);
246 av_log(h, AV_LOG_ERROR,
247 "Unable to set cert/key files %s and %s: %s\n",
248 c->cert_file, c->key_file, gnutls_strerror(ret));
252 } else if (c->cert_file || c->key_file)
253 av_log(h, AV_LOG_ERROR, "cert and key required\n");
254 gnutls_credentials_set(c->session, GNUTLS_CRD_CERTIFICATE, c->cred);
255 gnutls_transport_set_ptr(c->session, (gnutls_transport_ptr_t)
257 gnutls_priority_set_direct(c->session, "NORMAL", NULL);
259 ret = gnutls_handshake(c->session);
262 if ((ret = do_tls_poll(h, ret)) < 0)
266 unsigned int status, cert_list_size;
267 gnutls_x509_crt_t cert;
268 const gnutls_datum_t *cert_list;
269 if ((ret = gnutls_certificate_verify_peers2(c->session, &status)) < 0) {
270 av_log(h, AV_LOG_ERROR, "Unable to verify peer certificate: %s\n",
271 gnutls_strerror(ret));
275 if (status & GNUTLS_CERT_INVALID) {
276 av_log(h, AV_LOG_ERROR, "Peer certificate failed verification\n");
280 if (gnutls_certificate_type_get(c->session) != GNUTLS_CRT_X509) {
281 av_log(h, AV_LOG_ERROR, "Unsupported certificate type\n");
285 gnutls_x509_crt_init(&cert);
286 cert_list = gnutls_certificate_get_peers(c->session, &cert_list_size);
287 gnutls_x509_crt_import(cert, cert_list, GNUTLS_X509_FMT_DER);
288 ret = gnutls_x509_crt_check_hostname(cert, host);
289 gnutls_x509_crt_deinit(cert);
291 av_log(h, AV_LOG_ERROR,
292 "The certificate's owner does not match hostname %s\n", host);
298 c->ctx = SSL_CTX_new(c->listen ? TLSv1_server_method() : TLSv1_client_method());
300 av_log(h, AV_LOG_ERROR, "%s\n", ERR_error_string(ERR_get_error(), NULL));
306 if (!SSL_CTX_load_verify_locations(c->ctx, c->ca_file, NULL))
307 av_log(h, AV_LOG_ERROR, "SSL_CTX_load_verify_locations %s\n", ERR_error_string(ERR_get_error(), NULL));
309 if (c->cert_file && !SSL_CTX_use_certificate_chain_file(c->ctx, c->cert_file)) {
310 av_log(h, AV_LOG_ERROR, "Unable to load cert file %s: %s\n",
311 c->cert_file, ERR_error_string(ERR_get_error(), NULL));
315 if (c->key_file && !SSL_CTX_use_PrivateKey_file(c->ctx, c->key_file, SSL_FILETYPE_PEM)) {
316 av_log(h, AV_LOG_ERROR, "Unable to load key file %s: %s\n",
317 c->key_file, ERR_error_string(ERR_get_error(), NULL));
321 // Note, this doesn't check that the peer certificate actually matches
322 // the requested hostname.
324 SSL_CTX_set_verify(c->ctx, SSL_VERIFY_PEER|SSL_VERIFY_FAIL_IF_NO_PEER_CERT, NULL);
325 c->ssl = SSL_new(c->ctx);
327 av_log(h, AV_LOG_ERROR, "%s\n", ERR_error_string(ERR_get_error(), NULL));
331 SSL_set_fd(c->ssl, c->fd);
332 if (!c->listen && !numerichost)
333 SSL_set_tlsext_host_name(c->ssl, host);
335 ret = c->listen ? SSL_accept(c->ssl) : SSL_connect(c->ssl);
339 av_log(h, AV_LOG_ERROR, "Unable to negotiate TLS/SSL session\n");
343 if ((ret = do_tls_poll(h, ret)) < 0)
356 static int tls_read(URLContext *h, uint8_t *buf, int size)
358 TLSContext *c = h->priv_data;
360 int ret = TLS_read(c, buf, size);
365 if ((ret = do_tls_poll(h, ret)) < 0)
371 static int tls_write(URLContext *h, const uint8_t *buf, int size)
373 TLSContext *c = h->priv_data;
375 int ret = TLS_write(c, buf, size);
380 if ((ret = do_tls_poll(h, ret)) < 0)
386 static int tls_close(URLContext *h)
388 TLSContext *c = h->priv_data;
396 URLProtocol ff_tls_protocol = {
398 .url_open2 = tls_open,
399 .url_read = tls_read,
400 .url_write = tls_write,
401 .url_close = tls_close,
402 .priv_data_size = sizeof(TLSContext),
403 .flags = URL_PROTOCOL_FLAG_NETWORK,
404 .priv_data_class = &tls_class,