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;
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 static int url_bio_create(BIO *b)
71 #if OPENSSL_VERSION_NUMBER >= 0x1010000fL
73 BIO_set_data(b, NULL);
83 static int url_bio_destroy(BIO *b)
88 #if OPENSSL_VERSION_NUMBER >= 0x1010000fL
89 #define GET_BIO_DATA(x) BIO_get_data(x)
91 #define GET_BIO_DATA(x) (x)->ptr
94 static int url_bio_bread(BIO *b, char *buf, int len)
96 URLContext *h = GET_BIO_DATA(b);
97 int ret = ffurl_read(h, buf, len);
100 BIO_clear_retry_flags(b);
101 if (ret == AVERROR_EXIT)
106 static int url_bio_bwrite(BIO *b, const char *buf, int len)
108 URLContext *h = GET_BIO_DATA(b);
109 int ret = ffurl_write(h, buf, len);
112 BIO_clear_retry_flags(b);
113 if (ret == AVERROR_EXIT)
118 static long url_bio_ctrl(BIO *b, int cmd, long num, void *ptr)
120 if (cmd == BIO_CTRL_FLUSH) {
121 BIO_clear_retry_flags(b);
127 static int url_bio_bputs(BIO *b, const char *str)
129 return url_bio_bwrite(b, str, strlen(str));
132 #if OPENSSL_VERSION_NUMBER < 0x1010000fL
133 static BIO_METHOD url_bio_method = {
134 .type = BIO_TYPE_SOURCE_SINK,
135 .name = "urlprotocol bio",
136 .bwrite = url_bio_bwrite,
137 .bread = url_bio_bread,
138 .bputs = url_bio_bputs,
140 .ctrl = url_bio_ctrl,
141 .create = url_bio_create,
142 .destroy = url_bio_destroy,
146 int ff_openssl_init(void)
148 avpriv_lock_avformat();
151 SSL_load_error_strings();
153 if (!CRYPTO_get_locking_callback()) {
155 openssl_mutexes = av_malloc_array(sizeof(pthread_mutex_t), CRYPTO_num_locks());
156 if (!openssl_mutexes) {
157 avpriv_unlock_avformat();
158 return AVERROR(ENOMEM);
161 for (i = 0; i < CRYPTO_num_locks(); i++)
162 pthread_mutex_init(&openssl_mutexes[i], NULL);
163 CRYPTO_set_locking_callback(openssl_lock);
164 #if !defined(WIN32) && OPENSSL_VERSION_NUMBER < 0x10000000
165 CRYPTO_set_id_callback(openssl_thread_id);
171 avpriv_unlock_avformat();
176 void ff_openssl_deinit(void)
178 avpriv_lock_avformat();
182 if (CRYPTO_get_locking_callback() == openssl_lock) {
184 CRYPTO_set_locking_callback(NULL);
185 for (i = 0; i < CRYPTO_num_locks(); i++)
186 pthread_mutex_destroy(&openssl_mutexes[i]);
187 av_free(openssl_mutexes);
191 avpriv_unlock_avformat();
194 static int print_tls_error(URLContext *h, int ret)
196 av_log(h, AV_LOG_ERROR, "%s\n", ERR_error_string(ERR_get_error(), NULL));
200 static int tls_close(URLContext *h)
202 TLSContext *c = h->priv_data;
204 SSL_shutdown(c->ssl);
208 SSL_CTX_free(c->ctx);
209 if (c->tls_shared.tcp)
210 ffurl_close(c->tls_shared.tcp);
211 #if OPENSSL_VERSION_NUMBER >= 0x1010000fL
212 if (c->url_bio_method)
213 BIO_meth_free(c->url_bio_method);
219 static int tls_open(URLContext *h, const char *uri, int flags, AVDictionary **options)
221 TLSContext *p = h->priv_data;
222 TLSShared *c = &p->tls_shared;
226 if ((ret = ff_openssl_init()) < 0)
229 if ((ret = ff_tls_open_underlying(c, h, uri, options)) < 0)
232 // We want to support all versions of TLS >= 1.0, but not the deprecated
233 // and insecure SSLv2 and SSLv3. Despite the name, SSLv23_*_method()
234 // enables support for all versions of SSL and TLS, and we then disable
235 // support for the old protocols immediately after creating the context.
236 p->ctx = SSL_CTX_new(c->listen ? SSLv23_server_method() : SSLv23_client_method());
238 av_log(h, AV_LOG_ERROR, "%s\n", ERR_error_string(ERR_get_error(), NULL));
242 SSL_CTX_set_options(p->ctx, SSL_OP_NO_SSLv2 | SSL_OP_NO_SSLv3);
244 if (!SSL_CTX_load_verify_locations(p->ctx, c->ca_file, NULL))
245 av_log(h, AV_LOG_ERROR, "SSL_CTX_load_verify_locations %s\n", ERR_error_string(ERR_get_error(), NULL));
247 if (c->cert_file && !SSL_CTX_use_certificate_chain_file(p->ctx, c->cert_file)) {
248 av_log(h, AV_LOG_ERROR, "Unable to load cert file %s: %s\n",
249 c->cert_file, ERR_error_string(ERR_get_error(), NULL));
253 if (c->key_file && !SSL_CTX_use_PrivateKey_file(p->ctx, c->key_file, SSL_FILETYPE_PEM)) {
254 av_log(h, AV_LOG_ERROR, "Unable to load key file %s: %s\n",
255 c->key_file, ERR_error_string(ERR_get_error(), NULL));
259 // Note, this doesn't check that the peer certificate actually matches
260 // the requested hostname.
262 SSL_CTX_set_verify(p->ctx, SSL_VERIFY_PEER|SSL_VERIFY_FAIL_IF_NO_PEER_CERT, NULL);
263 p->ssl = SSL_new(p->ctx);
265 av_log(h, AV_LOG_ERROR, "%s\n", ERR_error_string(ERR_get_error(), NULL));
269 #if OPENSSL_VERSION_NUMBER >= 0x1010000fL
270 p->url_bio_method = BIO_meth_new(BIO_TYPE_SOURCE_SINK, "urlprotocol bio");
271 BIO_meth_set_write(p->url_bio_method, url_bio_bwrite);
272 BIO_meth_set_read(p->url_bio_method, url_bio_bread);
273 BIO_meth_set_puts(p->url_bio_method, url_bio_bputs);
274 BIO_meth_set_ctrl(p->url_bio_method, url_bio_ctrl);
275 BIO_meth_set_create(p->url_bio_method, url_bio_create);
276 BIO_meth_set_destroy(p->url_bio_method, url_bio_destroy);
277 bio = BIO_new(p->url_bio_method);
278 BIO_set_data(bio, c->tcp);
280 bio = BIO_new(&url_bio_method);
283 SSL_set_bio(p->ssl, bio, bio);
284 if (!c->listen && !c->numerichost)
285 SSL_set_tlsext_host_name(p->ssl, c->host);
286 ret = c->listen ? SSL_accept(p->ssl) : SSL_connect(p->ssl);
288 av_log(h, AV_LOG_ERROR, "Unable to negotiate TLS/SSL session\n");
291 } else if (ret < 0) {
292 ret = print_tls_error(h, ret);
302 static int tls_read(URLContext *h, uint8_t *buf, int size)
304 TLSContext *c = h->priv_data;
305 int ret = SSL_read(c->ssl, buf, size);
310 return print_tls_error(h, ret);
313 static int tls_write(URLContext *h, const uint8_t *buf, int size)
315 TLSContext *c = h->priv_data;
316 int ret = SSL_write(c->ssl, buf, size);
321 return print_tls_error(h, ret);
324 static int tls_get_file_handle(URLContext *h)
326 TLSContext *c = h->priv_data;
327 return ffurl_get_file_handle(c->tls_shared.tcp);
330 static const AVOption options[] = {
331 TLS_COMMON_OPTIONS(TLSContext, tls_shared),
335 static const AVClass tls_class = {
337 .item_name = av_default_item_name,
339 .version = LIBAVUTIL_VERSION_INT,
342 const URLProtocol ff_tls_openssl_protocol = {
344 .url_open2 = tls_open,
345 .url_read = tls_read,
346 .url_write = tls_write,
347 .url_close = tls_close,
348 .url_get_file_handle = tls_get_file_handle,
349 .priv_data_size = sizeof(TLSContext),
350 .flags = URL_PROTOCOL_FLAG_NETWORK,
351 .priv_data_class = &tls_class,