FFmpeg
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
tls_openssl.c
Go to the documentation of this file.
1 /*
2  * TLS/SSL Protocol
3  * Copyright (c) 2011 Martin Storsjo
4  *
5  * This file is part of FFmpeg.
6  *
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.
11  *
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.
16  *
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
20  */
21 
22 #include "avformat.h"
23 #include "internal.h"
24 #include "network.h"
25 #include "os_support.h"
26 #include "url.h"
27 #include "tls.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"
34 
35 #include <openssl/bio.h>
36 #include <openssl/ssl.h>
37 #include <openssl/err.h>
38 
39 static int openssl_init;
40 
41 typedef struct TLSContext {
42  const AVClass *class;
44  SSL_CTX *ctx;
45  SSL *ssl;
46 #if OPENSSL_VERSION_NUMBER >= 0x1010000fL
47  BIO_METHOD* url_bio_method;
48 #endif
49 } TLSContext;
50 
51 #if HAVE_THREADS
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)
55 {
56  if (mode & CRYPTO_LOCK)
57  pthread_mutex_lock(&openssl_mutexes[type]);
58  else
59  pthread_mutex_unlock(&openssl_mutexes[type]);
60 }
61 #if !defined(WIN32) && OPENSSL_VERSION_NUMBER < 0x10000000
62 static unsigned long openssl_thread_id(void)
63 {
64  return (intptr_t) pthread_self();
65 }
66 #endif
67 #endif
68 
69 static int url_bio_create(BIO *b)
70 {
71 #if OPENSSL_VERSION_NUMBER >= 0x1010000fL
72  BIO_set_init(b, 1);
73  BIO_set_data(b, NULL);
74  BIO_set_flags(b, 0);
75 #else
76  b->init = 1;
77  b->ptr = NULL;
78  b->flags = 0;
79 #endif
80  return 1;
81 }
82 
83 static int url_bio_destroy(BIO *b)
84 {
85  return 1;
86 }
87 
88 #if OPENSSL_VERSION_NUMBER >= 0x1010000fL
89 #define GET_BIO_DATA(x) BIO_get_data(x);
90 #else
91 #define GET_BIO_DATA(x) (x)->ptr;
92 #endif
93 
94 static int url_bio_bread(BIO *b, char *buf, int len)
95 {
96  URLContext *h;
97  int ret;
98  h = GET_BIO_DATA(b);
99  ret = ffurl_read(h, buf, len);
100  if (ret >= 0)
101  return ret;
102  BIO_clear_retry_flags(b);
103  if (ret == AVERROR_EXIT)
104  return 0;
105  return -1;
106 }
107 
108 static int url_bio_bwrite(BIO *b, const char *buf, int len)
109 {
110  URLContext *h;
111  int ret;
112  h = GET_BIO_DATA(b);
113  ret = ffurl_write(h, buf, len);
114  if (ret >= 0)
115  return ret;
116  BIO_clear_retry_flags(b);
117  if (ret == AVERROR_EXIT)
118  return 0;
119  return -1;
120 }
121 
122 static long url_bio_ctrl(BIO *b, int cmd, long num, void *ptr)
123 {
124  if (cmd == BIO_CTRL_FLUSH) {
125  BIO_clear_retry_flags(b);
126  return 1;
127  }
128  return 0;
129 }
130 
131 static int url_bio_bputs(BIO *b, const char *str)
132 {
133  return url_bio_bwrite(b, str, strlen(str));
134 }
135 
136 #if OPENSSL_VERSION_NUMBER < 0x1010000fL
137 static BIO_METHOD url_bio_method = {
138  .type = BIO_TYPE_SOURCE_SINK,
139  .name = "urlprotocol bio",
140  .bwrite = url_bio_bwrite,
141  .bread = url_bio_bread,
142  .bputs = url_bio_bputs,
143  .bgets = NULL,
144  .ctrl = url_bio_ctrl,
145  .create = url_bio_create,
146  .destroy = url_bio_destroy,
147 };
148 #endif
149 
151 {
153  if (!openssl_init) {
154  SSL_library_init();
155  SSL_load_error_strings();
156 #if HAVE_THREADS
157  if (!CRYPTO_get_locking_callback()) {
158  int i;
159  openssl_mutexes = av_malloc_array(sizeof(pthread_mutex_t), CRYPTO_num_locks());
160  if (!openssl_mutexes) {
162  return AVERROR(ENOMEM);
163  }
164 
165  for (i = 0; i < CRYPTO_num_locks(); i++)
166  pthread_mutex_init(&openssl_mutexes[i], NULL);
167  CRYPTO_set_locking_callback(openssl_lock);
168 #if !defined(WIN32) && OPENSSL_VERSION_NUMBER < 0x10000000
169  CRYPTO_set_id_callback(openssl_thread_id);
170 #endif
171  }
172 #endif
173  }
174  openssl_init++;
176 
177  return 0;
178 }
179 
181 {
183  openssl_init--;
184  if (!openssl_init) {
185 #if HAVE_THREADS
186  if (CRYPTO_get_locking_callback() == openssl_lock) {
187  int i;
188  CRYPTO_set_locking_callback(NULL);
189  for (i = 0; i < CRYPTO_num_locks(); i++)
190  pthread_mutex_destroy(&openssl_mutexes[i]);
191  av_free(openssl_mutexes);
192  }
193 #endif
194  }
196 }
197 
198 static int print_tls_error(URLContext *h, int ret)
199 {
200  av_log(h, AV_LOG_ERROR, "%s\n", ERR_error_string(ERR_get_error(), NULL));
201  return AVERROR(EIO);
202 }
203 
204 static int tls_close(URLContext *h)
205 {
206  TLSContext *c = h->priv_data;
207  if (c->ssl) {
208  SSL_shutdown(c->ssl);
209  SSL_free(c->ssl);
210  }
211  if (c->ctx)
212  SSL_CTX_free(c->ctx);
213  if (c->tls_shared.tcp)
215 #if OPENSSL_VERSION_NUMBER >= 0x1010000fL
216  if (c->url_bio_method)
217  BIO_meth_free(c->url_bio_method);
218 #endif
220  return 0;
221 }
222 
223 static int tls_open(URLContext *h, const char *uri, int flags, AVDictionary **options)
224 {
225  TLSContext *p = h->priv_data;
226  TLSShared *c = &p->tls_shared;
227  BIO *bio;
228  int ret;
229 
230  if ((ret = ff_openssl_init()) < 0)
231  return ret;
232 
233  if ((ret = ff_tls_open_underlying(c, h, uri, options)) < 0)
234  goto fail;
235 
236  p->ctx = SSL_CTX_new(c->listen ? TLSv1_server_method() : TLSv1_client_method());
237  if (!p->ctx) {
238  av_log(h, AV_LOG_ERROR, "%s\n", ERR_error_string(ERR_get_error(), NULL));
239  ret = AVERROR(EIO);
240  goto fail;
241  }
242  if (c->ca_file) {
243  if (!SSL_CTX_load_verify_locations(p->ctx, c->ca_file, NULL))
244  av_log(h, AV_LOG_ERROR, "SSL_CTX_load_verify_locations %s\n", ERR_error_string(ERR_get_error(), NULL));
245  }
246  if (c->cert_file && !SSL_CTX_use_certificate_chain_file(p->ctx, c->cert_file)) {
247  av_log(h, AV_LOG_ERROR, "Unable to load cert file %s: %s\n",
248  c->cert_file, ERR_error_string(ERR_get_error(), NULL));
249  ret = AVERROR(EIO);
250  goto fail;
251  }
252  if (c->key_file && !SSL_CTX_use_PrivateKey_file(p->ctx, c->key_file, SSL_FILETYPE_PEM)) {
253  av_log(h, AV_LOG_ERROR, "Unable to load key file %s: %s\n",
254  c->key_file, ERR_error_string(ERR_get_error(), NULL));
255  ret = AVERROR(EIO);
256  goto fail;
257  }
258  // Note, this doesn't check that the peer certificate actually matches
259  // the requested hostname.
260  if (c->verify)
261  SSL_CTX_set_verify(p->ctx, SSL_VERIFY_PEER|SSL_VERIFY_FAIL_IF_NO_PEER_CERT, NULL);
262  p->ssl = SSL_new(p->ctx);
263  if (!p->ssl) {
264  av_log(h, AV_LOG_ERROR, "%s\n", ERR_error_string(ERR_get_error(), NULL));
265  ret = AVERROR(EIO);
266  goto fail;
267  }
268 #if OPENSSL_VERSION_NUMBER >= 0x1010000fL
269  p->url_bio_method = BIO_meth_new(BIO_TYPE_SOURCE_SINK, "urlprotocol bio");
270  BIO_meth_set_write(p->url_bio_method, url_bio_bwrite);
271  BIO_meth_set_read(p->url_bio_method, url_bio_bread);
272  BIO_meth_set_puts(p->url_bio_method, url_bio_bputs);
273  BIO_meth_set_ctrl(p->url_bio_method, url_bio_ctrl);
274  BIO_meth_set_create(p->url_bio_method, url_bio_create);
275  BIO_meth_set_destroy(p->url_bio_method, url_bio_destroy);
276  bio = BIO_new(p->url_bio_method);
277  BIO_set_data(bio, c->tcp);
278 #else
279  bio = BIO_new(&url_bio_method);
280  bio->ptr = c->tcp;
281 #endif
282  SSL_set_bio(p->ssl, bio, bio);
283  if (!c->listen && !c->numerichost)
284  SSL_set_tlsext_host_name(p->ssl, c->host);
285  ret = c->listen ? SSL_accept(p->ssl) : SSL_connect(p->ssl);
286  if (ret == 0) {
287  av_log(h, AV_LOG_ERROR, "Unable to negotiate TLS/SSL session\n");
288  ret = AVERROR(EIO);
289  goto fail;
290  } else if (ret < 0) {
291  ret = print_tls_error(h, ret);
292  goto fail;
293  }
294 
295  return 0;
296 fail:
297  tls_close(h);
298  return ret;
299 }
300 
301 static int tls_read(URLContext *h, uint8_t *buf, int size)
302 {
303  TLSContext *c = h->priv_data;
304  int ret = SSL_read(c->ssl, buf, size);
305  if (ret > 0)
306  return ret;
307  if (ret == 0)
308  return AVERROR_EOF;
309  return print_tls_error(h, ret);
310 }
311 
312 static int tls_write(URLContext *h, const uint8_t *buf, int size)
313 {
314  TLSContext *c = h->priv_data;
315  int ret = SSL_write(c->ssl, buf, size);
316  if (ret > 0)
317  return ret;
318  if (ret == 0)
319  return AVERROR_EOF;
320  return print_tls_error(h, ret);
321 }
322 
323 static const AVOption options[] = {
324  TLS_COMMON_OPTIONS(TLSContext, tls_shared),
325  { NULL }
326 };
327 
328 static const AVClass tls_class = {
329  .class_name = "tls",
330  .item_name = av_default_item_name,
331  .option = options,
332  .version = LIBAVUTIL_VERSION_INT,
333 };
334 
336  .name = "tls",
337  .url_open2 = tls_open,
338  .url_read = tls_read,
339  .url_write = tls_write,
340  .url_close = tls_close,
341  .priv_data_size = sizeof(TLSContext),
343  .priv_data_class = &tls_class,
344 };
#define NULL
Definition: coverity.c:32
static av_always_inline int pthread_mutex_destroy(pthread_mutex_t *mutex)
Definition: os2threads.h:106
static int openssl_init
Definition: tls_openssl.c:39
#define URL_PROTOCOL_FLAG_NETWORK
Definition: url.h:34
int avpriv_unlock_avformat(void)
Definition: utils.c:3913
AVOption.
Definition: opt.h:245
int verify
Definition: tls.h:33
#define LIBAVUTIL_VERSION_INT
Definition: version.h:85
int ffurl_write(URLContext *h, const unsigned char *buf, int size)
Write size bytes from buf to the resource accessed by h.
Definition: avio.c:421
static int url_bio_bwrite(BIO *b, const char *buf, int len)
Definition: tls_openssl.c:108
const char * b
Definition: vf_curves.c:113
Convenience header that includes libavutil's core.
int listen
Definition: tls.h:36
const char * class_name
The name of the class; usually it is the same name as the context structure type to which the AVClass...
Definition: log.h:72
HMTX pthread_mutex_t
Definition: os2threads.h:49
static int url_bio_bread(BIO *b, char *buf, int len)
Definition: tls_openssl.c:94
uint8_t
mode
Definition: f_perms.c:27
AVOptions.
miscellaneous OS support macros and functions.
static int url_bio_bputs(BIO *b, const char *str)
Definition: tls_openssl.c:131
const URLProtocol ff_tls_openssl_protocol
Definition: tls_openssl.c:335
#define GET_BIO_DATA(x)
Definition: tls_openssl.c:91
Definition: tls.h:31
#define AVERROR_EOF
End of file.
Definition: error.h:55
ptrdiff_t size
Definition: opengl_enc.c:101
#define av_log(a,...)
SSL * ssl
Definition: tls_openssl.c:45
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:176
av_default_item_name
#define AVERROR(e)
Definition: error.h:43
Definition: graph2dot.c:48
static int tls_open(URLContext *h, const char *uri, int flags, AVDictionary **options)
Definition: tls_openssl.c:223
int avpriv_lock_avformat(void)
Definition: utils.c:3904
#define fail()
Definition: checkasm.h:83
char * host
Definition: tls.h:38
static const AVOption options[]
Definition: tls_openssl.c:323
void ff_openssl_deinit(void)
Definition: tls_openssl.c:180
static const AVClass tls_class
Definition: tls_openssl.c:328
#define TLS_COMMON_OPTIONS(pstruct, options_field)
Definition: tls.h:47
static av_always_inline int pthread_mutex_init(pthread_mutex_t *mutex, const pthread_mutexattr_t *attr)
Definition: os2threads.h:98
char * cert_file
Definition: tls.h:34
static int tls_write(URLContext *h, const uint8_t *buf, int size)
Definition: tls_openssl.c:312
#define AVERROR_EXIT
Immediate exit was requested; the called function should not be restarted.
Definition: error.h:56
char * ca_file
Definition: tls.h:32
static int url_bio_destroy(BIO *b)
Definition: tls_openssl.c:83
static int print_tls_error(URLContext *h, int ret)
Definition: tls_openssl.c:198
SSL_CTX * ctx
Definition: tls_openssl.c:44
int ff_openssl_init(void)
Definition: tls_openssl.c:150
TLSShared tls_shared
Definition: tls_gnutls.c:46
void * buf
Definition: avisynth_c.h:690
Definition: url.h:38
GLint GLenum type
Definition: opengl_enc.c:105
static int tls_read(URLContext *h, uint8_t *buf, int size)
Definition: tls_openssl.c:301
Describe the class of an AVClass context structure.
Definition: log.h:67
void * priv_data
Definition: url.h:41
static int tls_close(URLContext *h)
Definition: tls_openssl.c:204
misc parsing utilities
const char * name
Definition: url.h:54
static int flags
Definition: cpu.c:47
int ffurl_close(URLContext *h)
Definition: avio.c:467
Main libavformat public API header.
common internal api header.
int ff_tls_open_underlying(TLSShared *c, URLContext *parent, const char *uri, AVDictionary **options)
Definition: tls.c:56
static double c[64]
URLContext * tcp
Definition: tls.h:43
static BIO_METHOD url_bio_method
Definition: tls_openssl.c:137
int numerichost
Definition: tls.h:41
static long url_bio_ctrl(BIO *b, int cmd, long num, void *ptr)
Definition: tls_openssl.c:122
#define av_free(p)
int len
static av_always_inline int pthread_mutex_unlock(pthread_mutex_t *mutex)
Definition: os2threads.h:120
unbuffered private I/O API
static av_always_inline int pthread_mutex_lock(pthread_mutex_t *mutex)
Definition: os2threads.h:113
#define av_malloc_array(a, b)
int ffurl_read(URLContext *h, unsigned char *buf, int size)
Read up to size bytes from the resource accessed by h, and store the read bytes in buf...
Definition: avio.c:407
char * key_file
Definition: tls.h:35
static int url_bio_create(BIO *b)
Definition: tls_openssl.c:69