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
25 #include "os_support.h"
28 #include "libavcodec/internal.h"
29 #include "libavutil/avstring.h"
30 #include "libavutil/avutil.h"
31 #include "libavutil/opt.h"
32 #include "libavutil/parseutils.h"
33 #include "libavutil/thread.h"
35 #include <openssl/bio.h>
36 #include <openssl/ssl.h>
37 #include <openssl/err.h>
39 static int openssl_init;
41 typedef struct TLSContext {
46 #if OPENSSL_VERSION_NUMBER >= 0x1010000fL
47 BIO_METHOD* url_bio_method;
51 #if HAVE_THREADS && OPENSSL_VERSION_NUMBER < 0x10100000L
52 #include <openssl/crypto.h>
53 pthread_mutex_t *openssl_mutexes;
54 static void openssl_lock(int mode, int type, const char *file, int line)
56 if (mode & CRYPTO_LOCK)
57 pthread_mutex_lock(&openssl_mutexes[type]);
59 pthread_mutex_unlock(&openssl_mutexes[type]);
61 #if !defined(WIN32) && OPENSSL_VERSION_NUMBER < 0x10000000
62 static unsigned long openssl_thread_id(void)
64 return (intptr_t) pthread_self();
69 int ff_openssl_init(void)
73 /* OpenSSL 1.0.2 or below, then you would use SSL_library_init. If you are
74 * using OpenSSL 1.1.0 or above, then the library will initialize
75 * itself automatically.
76 * https://wiki.openssl.org/index.php/Library_Initialization
78 #if OPENSSL_VERSION_NUMBER < 0x10100000L
80 SSL_load_error_strings();
82 #if HAVE_THREADS && OPENSSL_VERSION_NUMBER < 0x10100000L
83 if (!CRYPTO_get_locking_callback()) {
85 openssl_mutexes = av_malloc_array(sizeof(pthread_mutex_t), CRYPTO_num_locks());
86 if (!openssl_mutexes) {
88 return AVERROR(ENOMEM);
91 for (i = 0; i < CRYPTO_num_locks(); i++)
92 pthread_mutex_init(&openssl_mutexes[i], NULL);
93 CRYPTO_set_locking_callback(openssl_lock);
94 #if !defined(WIN32) && OPENSSL_VERSION_NUMBER < 0x10000000
95 CRYPTO_set_id_callback(openssl_thread_id);
101 ff_unlock_avformat();
106 void ff_openssl_deinit(void)
111 #if HAVE_THREADS && OPENSSL_VERSION_NUMBER < 0x10100000L
112 if (CRYPTO_get_locking_callback() == openssl_lock) {
114 CRYPTO_set_locking_callback(NULL);
115 for (i = 0; i < CRYPTO_num_locks(); i++)
116 pthread_mutex_destroy(&openssl_mutexes[i]);
117 av_free(openssl_mutexes);
121 ff_unlock_avformat();
124 static int print_tls_error(URLContext *h, int ret)
126 TLSContext *c = h->priv_data;
127 if (h->flags & AVIO_FLAG_NONBLOCK) {
128 int err = SSL_get_error(c->ssl, ret);
129 if (err == SSL_ERROR_WANT_READ || err == SSL_ERROR_WANT_WRITE)
130 return AVERROR(EAGAIN);
132 av_log(h, AV_LOG_ERROR, "%s\n", ERR_error_string(ERR_get_error(), NULL));
136 static int tls_close(URLContext *h)
138 TLSContext *c = h->priv_data;
140 SSL_shutdown(c->ssl);
144 SSL_CTX_free(c->ctx);
145 if (c->tls_shared.tcp)
146 ffurl_close(c->tls_shared.tcp);
147 #if OPENSSL_VERSION_NUMBER >= 0x1010000fL
148 if (c->url_bio_method)
149 BIO_meth_free(c->url_bio_method);
155 static int url_bio_create(BIO *b)
157 #if OPENSSL_VERSION_NUMBER >= 0x1010000fL
159 BIO_set_data(b, NULL);
169 static int url_bio_destroy(BIO *b)
174 #if OPENSSL_VERSION_NUMBER >= 0x1010000fL
175 #define GET_BIO_DATA(x) BIO_get_data(x)
177 #define GET_BIO_DATA(x) (x)->ptr
180 static int url_bio_bread(BIO *b, char *buf, int len)
182 URLContext *h = GET_BIO_DATA(b);
183 int ret = ffurl_read(h, buf, len);
186 BIO_clear_retry_flags(b);
187 if (ret == AVERROR(EAGAIN))
188 BIO_set_retry_read(b);
189 if (ret == AVERROR_EXIT)
194 static int url_bio_bwrite(BIO *b, const char *buf, int len)
196 URLContext *h = GET_BIO_DATA(b);
197 int ret = ffurl_write(h, buf, len);
200 BIO_clear_retry_flags(b);
201 if (ret == AVERROR(EAGAIN))
202 BIO_set_retry_write(b);
203 if (ret == AVERROR_EXIT)
208 static long url_bio_ctrl(BIO *b, int cmd, long num, void *ptr)
210 if (cmd == BIO_CTRL_FLUSH) {
211 BIO_clear_retry_flags(b);
217 static int url_bio_bputs(BIO *b, const char *str)
219 return url_bio_bwrite(b, str, strlen(str));
222 #if OPENSSL_VERSION_NUMBER < 0x1010000fL
223 static BIO_METHOD url_bio_method = {
224 .type = BIO_TYPE_SOURCE_SINK,
225 .name = "urlprotocol bio",
226 .bwrite = url_bio_bwrite,
227 .bread = url_bio_bread,
228 .bputs = url_bio_bputs,
230 .ctrl = url_bio_ctrl,
231 .create = url_bio_create,
232 .destroy = url_bio_destroy,
236 static int tls_open(URLContext *h, const char *uri, int flags, AVDictionary **options)
238 TLSContext *p = h->priv_data;
239 TLSShared *c = &p->tls_shared;
243 if ((ret = ff_openssl_init()) < 0)
246 if ((ret = ff_tls_open_underlying(c, h, uri, options)) < 0)
249 // We want to support all versions of TLS >= 1.0, but not the deprecated
250 // and insecure SSLv2 and SSLv3. Despite the name, SSLv23_*_method()
251 // enables support for all versions of SSL and TLS, and we then disable
252 // support for the old protocols immediately after creating the context.
253 p->ctx = SSL_CTX_new(c->listen ? SSLv23_server_method() : SSLv23_client_method());
255 av_log(h, AV_LOG_ERROR, "%s\n", ERR_error_string(ERR_get_error(), NULL));
259 SSL_CTX_set_options(p->ctx, SSL_OP_NO_SSLv2 | SSL_OP_NO_SSLv3);
261 if (!SSL_CTX_load_verify_locations(p->ctx, c->ca_file, NULL))
262 av_log(h, AV_LOG_ERROR, "SSL_CTX_load_verify_locations %s\n", ERR_error_string(ERR_get_error(), NULL));
264 if (c->cert_file && !SSL_CTX_use_certificate_chain_file(p->ctx, c->cert_file)) {
265 av_log(h, AV_LOG_ERROR, "Unable to load cert file %s: %s\n",
266 c->cert_file, ERR_error_string(ERR_get_error(), NULL));
270 if (c->key_file && !SSL_CTX_use_PrivateKey_file(p->ctx, c->key_file, SSL_FILETYPE_PEM)) {
271 av_log(h, AV_LOG_ERROR, "Unable to load key file %s: %s\n",
272 c->key_file, ERR_error_string(ERR_get_error(), NULL));
276 // Note, this doesn't check that the peer certificate actually matches
277 // the requested hostname.
279 SSL_CTX_set_verify(p->ctx, SSL_VERIFY_PEER|SSL_VERIFY_FAIL_IF_NO_PEER_CERT, NULL);
280 p->ssl = SSL_new(p->ctx);
282 av_log(h, AV_LOG_ERROR, "%s\n", ERR_error_string(ERR_get_error(), NULL));
286 #if OPENSSL_VERSION_NUMBER >= 0x1010000fL
287 p->url_bio_method = BIO_meth_new(BIO_TYPE_SOURCE_SINK, "urlprotocol bio");
288 BIO_meth_set_write(p->url_bio_method, url_bio_bwrite);
289 BIO_meth_set_read(p->url_bio_method, url_bio_bread);
290 BIO_meth_set_puts(p->url_bio_method, url_bio_bputs);
291 BIO_meth_set_ctrl(p->url_bio_method, url_bio_ctrl);
292 BIO_meth_set_create(p->url_bio_method, url_bio_create);
293 BIO_meth_set_destroy(p->url_bio_method, url_bio_destroy);
294 bio = BIO_new(p->url_bio_method);
295 BIO_set_data(bio, c->tcp);
297 bio = BIO_new(&url_bio_method);
300 SSL_set_bio(p->ssl, bio, bio);
301 if (!c->listen && !c->numerichost)
302 SSL_set_tlsext_host_name(p->ssl, c->host);
303 ret = c->listen ? SSL_accept(p->ssl) : SSL_connect(p->ssl);
305 av_log(h, AV_LOG_ERROR, "Unable to negotiate TLS/SSL session\n");
308 } else if (ret < 0) {
309 ret = print_tls_error(h, ret);
319 static int tls_read(URLContext *h, uint8_t *buf, int size)
321 TLSContext *c = h->priv_data;
323 // Set or clear the AVIO_FLAG_NONBLOCK on c->tls_shared.tcp
324 c->tls_shared.tcp->flags &= ~AVIO_FLAG_NONBLOCK;
325 c->tls_shared.tcp->flags |= h->flags & AVIO_FLAG_NONBLOCK;
326 ret = SSL_read(c->ssl, buf, size);
331 return print_tls_error(h, ret);
334 static int tls_write(URLContext *h, const uint8_t *buf, int size)
336 TLSContext *c = h->priv_data;
338 // Set or clear the AVIO_FLAG_NONBLOCK on c->tls_shared.tcp
339 c->tls_shared.tcp->flags &= ~AVIO_FLAG_NONBLOCK;
340 c->tls_shared.tcp->flags |= h->flags & AVIO_FLAG_NONBLOCK;
341 ret = SSL_write(c->ssl, buf, size);
346 return print_tls_error(h, ret);
349 static int tls_get_file_handle(URLContext *h)
351 TLSContext *c = h->priv_data;
352 return ffurl_get_file_handle(c->tls_shared.tcp);
355 static const AVOption options[] = {
356 TLS_COMMON_OPTIONS(TLSContext, tls_shared),
360 static const AVClass tls_class = {
362 .item_name = av_default_item_name,
364 .version = LIBAVUTIL_VERSION_INT,
367 const URLProtocol ff_tls_protocol = {
369 .url_open2 = tls_open,
370 .url_read = tls_read,
371 .url_write = tls_write,
372 .url_close = tls_close,
373 .url_get_file_handle = tls_get_file_handle,
374 .priv_data_size = sizeof(TLSContext),
375 .flags = URL_PROTOCOL_FLAG_NETWORK,
376 .priv_data_class = &tls_class,