053a5c0c5bbfee6398a7662fd8d25aac3b2139ef
[ffmpeg.git] / libavformat / tls.c
1 /*
2  * TLS/SSL Protocol
3  * Copyright (c) 2011 Martin Storsjo
4  *
5  * This file is part of Libav.
6  *
7  * Libav 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.
11  *
12  * Libav 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.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with Libav; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20  */
21
22 #include "avformat.h"
23 #include "url.h"
24 #include "libavutil/avstring.h"
25 #include "libavutil/opt.h"
26 #include "libavutil/parseutils.h"
27 #if CONFIG_GNUTLS
28 #include <gnutls/gnutls.h>
29 #include <gnutls/x509.h>
30 #define TLS_read(c, buf, size)  gnutls_record_recv(c->session, buf, size)
31 #define TLS_write(c, buf, size) gnutls_record_send(c->session, buf, size)
32 #define TLS_shutdown(c)         gnutls_bye(c->session, GNUTLS_SHUT_RDWR)
33 #define TLS_free(c) do { \
34         if (c->session) \
35             gnutls_deinit(c->session); \
36         if (c->cred) \
37             gnutls_certificate_free_credentials(c->cred); \
38     } while (0)
39
40 static ssize_t gnutls_url_pull(gnutls_transport_ptr_t transport,
41                                void *buf, size_t len)
42 {
43     URLContext *h = (URLContext*) transport;
44     int ret = ffurl_read(h, buf, len);
45     if (ret >= 0)
46         return ret;
47     if (ret == AVERROR_EXIT)
48         return 0;
49     errno = EIO;
50     return -1;
51 }
52 static ssize_t gnutls_url_push(gnutls_transport_ptr_t transport,
53                                const void *buf, size_t len)
54 {
55     URLContext *h = (URLContext*) transport;
56     int ret = ffurl_write(h, buf, len);
57     if (ret >= 0)
58         return ret;
59     if (ret == AVERROR_EXIT)
60         return 0;
61     errno = EIO;
62     return -1;
63 }
64 #elif CONFIG_OPENSSL
65 #include <openssl/bio.h>
66 #include <openssl/ssl.h>
67 #include <openssl/err.h>
68 #define TLS_read(c, buf, size)  SSL_read(c->ssl,  buf, size)
69 #define TLS_write(c, buf, size) SSL_write(c->ssl, buf, size)
70 #define TLS_shutdown(c)         SSL_shutdown(c->ssl)
71 #define TLS_free(c) do { \
72         if (c->ssl) \
73             SSL_free(c->ssl); \
74         if (c->ctx) \
75             SSL_CTX_free(c->ctx); \
76     } while (0)
77
78 static int url_bio_create(BIO *b)
79 {
80     b->init = 1;
81     b->ptr = NULL;
82     b->flags = 0;
83     return 1;
84 }
85
86 static int url_bio_destroy(BIO *b)
87 {
88     return 1;
89 }
90
91 static int url_bio_bread(BIO *b, char *buf, int len)
92 {
93     URLContext *h = b->ptr;
94     int ret = ffurl_read(h, buf, len);
95     if (ret >= 0)
96         return ret;
97     BIO_clear_retry_flags(b);
98     if (ret == AVERROR_EXIT)
99         return 0;
100     return -1;
101 }
102
103 static int url_bio_bwrite(BIO *b, const char *buf, int len)
104 {
105     URLContext *h = b->ptr;
106     int ret = ffurl_write(h, buf, len);
107     if (ret >= 0)
108         return ret;
109     BIO_clear_retry_flags(b);
110     if (ret == AVERROR_EXIT)
111         return 0;
112     return -1;
113 }
114
115 static long url_bio_ctrl(BIO *b, int cmd, long num, void *ptr)
116 {
117     if (cmd == BIO_CTRL_FLUSH) {
118         BIO_clear_retry_flags(b);
119         return 1;
120     }
121     return 0;
122 }
123
124 static int url_bio_bputs(BIO *b, const char *str)
125 {
126     return url_bio_bwrite(b, str, strlen(str));
127 }
128
129 static BIO_METHOD url_bio_method = {
130     .type = BIO_TYPE_SOURCE_SINK,
131     .name = "urlprotocol bio",
132     .bwrite = url_bio_bwrite,
133     .bread = url_bio_bread,
134     .bputs = url_bio_bputs,
135     .bgets = NULL,
136     .ctrl = url_bio_ctrl,
137     .create = url_bio_create,
138     .destroy = url_bio_destroy,
139 };
140
141 #endif
142 #include "network.h"
143 #include "os_support.h"
144 #include "internal.h"
145 #if HAVE_POLL_H
146 #include <poll.h>
147 #endif
148
149 typedef struct TLSContext {
150     const AVClass *class;
151     URLContext *tcp;
152 #if CONFIG_GNUTLS
153     gnutls_session_t session;
154     gnutls_certificate_credentials_t cred;
155 #elif CONFIG_OPENSSL
156     SSL_CTX *ctx;
157     SSL *ssl;
158 #endif
159     int fd;
160     char *ca_file;
161     int verify;
162     char *cert_file;
163     char *key_file;
164     int listen;
165 } TLSContext;
166
167 #define OFFSET(x) offsetof(TLSContext, x)
168 #define D AV_OPT_FLAG_DECODING_PARAM
169 #define E AV_OPT_FLAG_ENCODING_PARAM
170 static const AVOption options[] = {
171     {"ca_file",    "Certificate Authority database file", OFFSET(ca_file),   AV_OPT_TYPE_STRING, .flags = D|E },
172     {"tls_verify", "Verify the peer certificate",         OFFSET(verify),    AV_OPT_TYPE_INT, { .i64 = 0 }, 0, 1, .flags = D|E },
173     {"cert_file",  "Certificate file",                    OFFSET(cert_file), AV_OPT_TYPE_STRING, .flags = D|E },
174     {"key_file",   "Private key file",                    OFFSET(key_file),  AV_OPT_TYPE_STRING, .flags = D|E },
175     {"listen",     "Listen for incoming connections",     OFFSET(listen),    AV_OPT_TYPE_INT, { .i64 = 0 }, 0, 1, .flags = D|E },
176     { NULL }
177 };
178
179 static const AVClass tls_class = {
180     .class_name = "tls",
181     .item_name  = av_default_item_name,
182     .option     = options,
183     .version    = LIBAVUTIL_VERSION_INT,
184 };
185
186 static int do_tls_poll(URLContext *h, int ret)
187 {
188     TLSContext *c = h->priv_data;
189     struct pollfd p = { c->fd, 0, 0 };
190 #if CONFIG_GNUTLS
191     switch (ret) {
192     case GNUTLS_E_AGAIN:
193     case GNUTLS_E_INTERRUPTED:
194         break;
195     case GNUTLS_E_WARNING_ALERT_RECEIVED:
196         av_log(h, AV_LOG_WARNING, "%s\n", gnutls_strerror(ret));
197         break;
198     default:
199         av_log(h, AV_LOG_ERROR, "%s\n", gnutls_strerror(ret));
200         return AVERROR(EIO);
201     }
202     if (gnutls_record_get_direction(c->session))
203         p.events = POLLOUT;
204     else
205         p.events = POLLIN;
206 #elif CONFIG_OPENSSL
207     ret = SSL_get_error(c->ssl, ret);
208     if (ret == SSL_ERROR_WANT_READ) {
209         p.events = POLLIN;
210     } else if (ret == SSL_ERROR_WANT_WRITE) {
211         p.events = POLLOUT;
212     } else {
213         av_log(h, AV_LOG_ERROR, "%s\n", ERR_error_string(ERR_get_error(), NULL));
214         return AVERROR(EIO);
215     }
216 #endif
217     return AVERROR(EIO);
218 }
219
220 static int tls_open(URLContext *h, const char *uri, int flags, AVDictionary **options)
221 {
222     TLSContext *c = h->priv_data;
223     int ret;
224     int port;
225     const char *p;
226     char buf[200], host[200], opts[50] = "";
227     int numerichost = 0;
228     struct addrinfo hints = { 0 }, *ai = NULL;
229     const char *proxy_path;
230     int use_proxy;
231 #if CONFIG_OPENSSL
232     BIO *bio;
233 #endif
234
235     ff_tls_init();
236
237     if (c->listen)
238         snprintf(opts, sizeof(opts), "?listen=1");
239
240     av_url_split(NULL, 0, NULL, 0, host, sizeof(host), &port, NULL, 0, uri);
241
242     p = strchr(uri, '?');
243
244     if (!p) {
245         p = opts;
246     } else {
247         if (av_find_info_tag(opts, sizeof(opts), "listen", p))
248             c->listen = 1;
249     }
250
251     ff_url_join(buf, sizeof(buf), "tcp", NULL, host, port, "%s", p);
252
253     hints.ai_flags = AI_NUMERICHOST;
254     if (!getaddrinfo(host, NULL, &hints, &ai)) {
255         numerichost = 1;
256         freeaddrinfo(ai);
257     }
258
259     proxy_path = getenv("http_proxy");
260     use_proxy = !ff_http_match_no_proxy(getenv("no_proxy"), host) &&
261                 proxy_path && av_strstart(proxy_path, "http://", NULL);
262
263     if (use_proxy) {
264         char proxy_host[200], proxy_auth[200], dest[200];
265         int proxy_port;
266         av_url_split(NULL, 0, proxy_auth, sizeof(proxy_auth),
267                      proxy_host, sizeof(proxy_host), &proxy_port, NULL, 0,
268                      proxy_path);
269         ff_url_join(dest, sizeof(dest), NULL, NULL, host, port, NULL);
270         ff_url_join(buf, sizeof(buf), "httpproxy", proxy_auth, proxy_host,
271                     proxy_port, "/%s", dest);
272     }
273
274     ret = ffurl_open(&c->tcp, buf, AVIO_FLAG_READ_WRITE,
275                      &h->interrupt_callback, options);
276     if (ret)
277         goto fail;
278     c->fd = ffurl_get_file_handle(c->tcp);
279
280 #if CONFIG_GNUTLS
281     gnutls_init(&c->session, c->listen ? GNUTLS_SERVER : GNUTLS_CLIENT);
282     if (!c->listen && !numerichost)
283         gnutls_server_name_set(c->session, GNUTLS_NAME_DNS, host, strlen(host));
284     gnutls_certificate_allocate_credentials(&c->cred);
285     if (c->ca_file)
286         gnutls_certificate_set_x509_trust_file(c->cred, c->ca_file, GNUTLS_X509_FMT_PEM);
287 #if GNUTLS_VERSION_MAJOR >= 3
288     else
289         gnutls_certificate_set_x509_system_trust(c->cred);
290 #endif
291     gnutls_certificate_set_verify_flags(c->cred, c->verify ?
292                                         GNUTLS_VERIFY_ALLOW_X509_V1_CA_CRT : 0);
293     if (c->cert_file && c->key_file) {
294         ret = gnutls_certificate_set_x509_key_file(c->cred,
295                                                    c->cert_file, c->key_file,
296                                                    GNUTLS_X509_FMT_PEM);
297         if (ret < 0) {
298             av_log(h, AV_LOG_ERROR,
299                    "Unable to set cert/key files %s and %s: %s\n",
300                    c->cert_file, c->key_file, gnutls_strerror(ret));
301             ret = AVERROR(EIO);
302             goto fail;
303         }
304     }
305     gnutls_credentials_set(c->session, GNUTLS_CRD_CERTIFICATE, c->cred);
306     gnutls_transport_set_pull_function(c->session, gnutls_url_pull);
307     gnutls_transport_set_push_function(c->session, gnutls_url_push);
308     gnutls_transport_set_ptr(c->session, c->tcp);
309     gnutls_priority_set_direct(c->session, "NORMAL", NULL);
310     while (1) {
311         ret = gnutls_handshake(c->session);
312         if (ret == 0)
313             break;
314         if ((ret = do_tls_poll(h, ret)) < 0)
315             goto fail;
316     }
317     if (c->verify) {
318         unsigned int status, cert_list_size;
319         gnutls_x509_crt_t cert;
320         const gnutls_datum_t *cert_list;
321         if ((ret = gnutls_certificate_verify_peers2(c->session, &status)) < 0) {
322             av_log(h, AV_LOG_ERROR, "Unable to verify peer certificate: %s\n",
323                                     gnutls_strerror(ret));
324             ret = AVERROR(EIO);
325             goto fail;
326         }
327         if (status & GNUTLS_CERT_INVALID) {
328             av_log(h, AV_LOG_ERROR, "Peer certificate failed verification\n");
329             ret = AVERROR(EIO);
330             goto fail;
331         }
332         if (gnutls_certificate_type_get(c->session) != GNUTLS_CRT_X509) {
333             av_log(h, AV_LOG_ERROR, "Unsupported certificate type\n");
334             ret = AVERROR(EIO);
335             goto fail;
336         }
337         gnutls_x509_crt_init(&cert);
338         cert_list = gnutls_certificate_get_peers(c->session, &cert_list_size);
339         gnutls_x509_crt_import(cert, cert_list, GNUTLS_X509_FMT_DER);
340         ret = gnutls_x509_crt_check_hostname(cert, host);
341         gnutls_x509_crt_deinit(cert);
342         if (!ret) {
343             av_log(h, AV_LOG_ERROR,
344                    "The certificate's owner does not match hostname %s\n", host);
345             ret = AVERROR(EIO);
346             goto fail;
347         }
348     }
349 #elif CONFIG_OPENSSL
350     c->ctx = SSL_CTX_new(c->listen ? TLSv1_server_method() : TLSv1_client_method());
351     if (!c->ctx) {
352         av_log(h, AV_LOG_ERROR, "%s\n", ERR_error_string(ERR_get_error(), NULL));
353         ret = AVERROR(EIO);
354         goto fail;
355     }
356     if (c->ca_file)
357         SSL_CTX_load_verify_locations(c->ctx, c->ca_file, NULL);
358     if (c->cert_file && !SSL_CTX_use_certificate_chain_file(c->ctx, c->cert_file)) {
359         av_log(h, AV_LOG_ERROR, "Unable to load cert file %s: %s\n",
360                c->cert_file, ERR_error_string(ERR_get_error(), NULL));
361         ret = AVERROR(EIO);
362         goto fail;
363     }
364     if (c->key_file && !SSL_CTX_use_PrivateKey_file(c->ctx, c->key_file, SSL_FILETYPE_PEM)) {
365         av_log(h, AV_LOG_ERROR, "Unable to load key file %s: %s\n",
366                c->key_file, ERR_error_string(ERR_get_error(), NULL));
367         ret = AVERROR(EIO);
368         goto fail;
369     }
370     // Note, this doesn't check that the peer certificate actually matches
371     // the requested hostname.
372     if (c->verify)
373         SSL_CTX_set_verify(c->ctx, SSL_VERIFY_PEER, NULL);
374     c->ssl = SSL_new(c->ctx);
375     if (!c->ssl) {
376         av_log(h, AV_LOG_ERROR, "%s\n", ERR_error_string(ERR_get_error(), NULL));
377         ret = AVERROR(EIO);
378         goto fail;
379     }
380     bio = BIO_new(&url_bio_method);
381     bio->ptr = c->tcp;
382     SSL_set_bio(c->ssl, bio, bio);
383     if (!c->listen && !numerichost)
384         SSL_set_tlsext_host_name(c->ssl, host);
385     while (1) {
386         ret = c->listen ? SSL_accept(c->ssl) : SSL_connect(c->ssl);
387         if (ret > 0)
388             break;
389         if (ret == 0) {
390             av_log(h, AV_LOG_ERROR, "Unable to negotiate TLS/SSL session\n");
391             ret = AVERROR(EIO);
392             goto fail;
393         }
394         if ((ret = do_tls_poll(h, ret)) < 0)
395             goto fail;
396     }
397 #endif
398     return 0;
399 fail:
400     TLS_free(c);
401     if (c->tcp)
402         ffurl_close(c->tcp);
403     ff_tls_deinit();
404     return ret;
405 }
406
407 static int tls_read(URLContext *h, uint8_t *buf, int size)
408 {
409     TLSContext *c = h->priv_data;
410     while (1) {
411         int ret = TLS_read(c, buf, size);
412         if (ret > 0)
413             return ret;
414         if (ret == 0)
415             return AVERROR_EOF;
416         if ((ret = do_tls_poll(h, ret)) < 0)
417             return ret;
418     }
419     return 0;
420 }
421
422 static int tls_write(URLContext *h, const uint8_t *buf, int size)
423 {
424     TLSContext *c = h->priv_data;
425     while (1) {
426         int ret = TLS_write(c, buf, size);
427         if (ret > 0)
428             return ret;
429         if (ret == 0)
430             return AVERROR_EOF;
431         if ((ret = do_tls_poll(h, ret)) < 0)
432             return ret;
433     }
434     return 0;
435 }
436
437 static int tls_close(URLContext *h)
438 {
439     TLSContext *c = h->priv_data;
440     TLS_shutdown(c);
441     TLS_free(c);
442     ffurl_close(c->tcp);
443     ff_tls_deinit();
444     return 0;
445 }
446
447 URLProtocol ff_tls_protocol = {
448     .name           = "tls",
449     .url_open2      = tls_open,
450     .url_read       = tls_read,
451     .url_write      = tls_write,
452     .url_close      = tls_close,
453     .priv_data_size = sizeof(TLSContext),
454     .flags          = URL_PROTOCOL_FLAG_NETWORK,
455     .priv_data_class = &tls_class,
456 };