3 * Copyright (c) 2018 Thomas Volkert
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
22 #include <mbedtls/certs.h>
23 #include <mbedtls/config.h>
24 #include <mbedtls/ctr_drbg.h>
25 #include <mbedtls/entropy.h>
26 #include <mbedtls/net_sockets.h>
27 #include <mbedtls/platform.h>
28 #include <mbedtls/ssl.h>
29 #include <mbedtls/x509_crt.h>
35 #include "libavutil/parseutils.h"
37 typedef struct TLSContext {
40 mbedtls_ssl_context ssl_context;
41 mbedtls_ssl_config ssl_config;
42 mbedtls_entropy_context entropy_context;
43 mbedtls_ctr_drbg_context ctr_drbg_context;
44 mbedtls_x509_crt ca_cert;
45 mbedtls_x509_crt own_cert;
46 mbedtls_pk_context priv_key;
50 #define OFFSET(x) offsetof(TLSContext, x)
52 static int tls_close(URLContext *h)
54 TLSContext *tls_ctx = h->priv_data;
56 mbedtls_ssl_close_notify(&tls_ctx->ssl_context);
57 mbedtls_pk_free(&tls_ctx->priv_key);
58 mbedtls_x509_crt_free(&tls_ctx->ca_cert);
59 mbedtls_x509_crt_free(&tls_ctx->own_cert);
60 mbedtls_ssl_free(&tls_ctx->ssl_context);
61 mbedtls_ssl_config_free(&tls_ctx->ssl_config);
62 mbedtls_ctr_drbg_free(&tls_ctx->ctr_drbg_context);
63 mbedtls_entropy_free(&tls_ctx->entropy_context);
68 static int handle_transport_error(URLContext *h, const char* func_name, int react_on_eagain, int ret)
72 return react_on_eagain;
76 case AVERROR(ECONNRESET):
77 return MBEDTLS_ERR_NET_CONN_RESET;
79 av_log(h, AV_LOG_ERROR, "%s returned 0x%x\n", func_name, ret);
81 return MBEDTLS_ERR_NET_SEND_FAILED;
85 static int mbedtls_send(void *ctx, const unsigned char *buf, size_t len)
87 URLContext *h = (URLContext*) ctx;
88 int ret = ffurl_write(h, buf, len);
92 if (h->max_packet_size && len > h->max_packet_size)
93 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
95 return handle_transport_error(h, "ffurl_write", MBEDTLS_ERR_SSL_WANT_WRITE, ret);
98 static int mbedtls_recv(void *ctx, unsigned char *buf, size_t len)
100 URLContext *h = (URLContext*) ctx;
101 int ret = ffurl_read(h, buf, len);
105 if (h->max_packet_size && len > h->max_packet_size)
106 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
108 return handle_transport_error(h, "ffurl_read", MBEDTLS_ERR_SSL_WANT_READ, ret);
111 static void handle_pk_parse_error(URLContext *h, int ret)
114 case MBEDTLS_ERR_PK_FILE_IO_ERROR:
115 av_log(h, AV_LOG_ERROR, "Read of key file failed. Is it actually there, are the access permissions correct?\n");
117 case MBEDTLS_ERR_PK_PASSWORD_REQUIRED:
118 av_log(h, AV_LOG_ERROR, "A password for the private key is missing.\n");
120 case MBEDTLS_ERR_PK_PASSWORD_MISMATCH:
121 av_log(h, AV_LOG_ERROR, "The given password for the private key is wrong.\n");
124 av_log(h, AV_LOG_ERROR, "mbedtls_pk_parse_key returned -0x%x\n", -ret);
129 static void handle_handshake_error(URLContext *h, int ret)
132 case MBEDTLS_ERR_SSL_NO_USABLE_CIPHERSUITE:
133 av_log(h, AV_LOG_ERROR, "None of the common ciphersuites is usable. Was the local certificate correctly set?\n");
135 case MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE:
136 av_log(h, AV_LOG_ERROR, "A fatal alert message was received from the peer, has the peer a correct certificate?\n");
138 case MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED:
139 av_log(h, AV_LOG_ERROR, "No CA chain is set, but required to operate. Was the CA correctly set?\n");
141 case MBEDTLS_ERR_NET_CONN_RESET:
142 av_log(h, AV_LOG_ERROR, "TLS handshake was aborted by peer.\n");
145 av_log(h, AV_LOG_ERROR, "mbedtls_ssl_handshake returned -0x%x\n", -ret);
150 static void parse_options(TLSContext *tls_ctxc, const char *uri)
153 const char *p = strchr(uri, '?');
157 if (!tls_ctxc->priv_key_pw && av_find_info_tag(buf, sizeof(buf), "key_password", p))
158 tls_ctxc->priv_key_pw = av_strdup(buf);
161 static int tls_open(URLContext *h, const char *uri, int flags, AVDictionary **options)
163 TLSContext *tls_ctx = h->priv_data;
164 TLSShared *shr = &tls_ctx->tls_shared;
165 uint32_t verify_res_flags;
168 // parse additional options
169 parse_options(tls_ctx, uri);
171 if ((ret = ff_tls_open_underlying(shr, h, uri, options)) < 0)
174 mbedtls_ssl_init(&tls_ctx->ssl_context);
175 mbedtls_ssl_config_init(&tls_ctx->ssl_config);
176 mbedtls_entropy_init(&tls_ctx->entropy_context);
177 mbedtls_ctr_drbg_init(&tls_ctx->ctr_drbg_context);
178 mbedtls_x509_crt_init(&tls_ctx->ca_cert);
179 mbedtls_pk_init(&tls_ctx->priv_key);
183 if ((ret = mbedtls_x509_crt_parse_file(&tls_ctx->ca_cert, shr->ca_file)) != 0) {
184 av_log(h, AV_LOG_ERROR, "mbedtls_x509_crt_parse_file for CA cert returned %d\n", ret);
189 // load own certificate
190 if (shr->cert_file) {
191 if ((ret = mbedtls_x509_crt_parse_file(&tls_ctx->own_cert, shr->cert_file)) != 0) {
192 av_log(h, AV_LOG_ERROR, "mbedtls_x509_crt_parse_file for own cert returned %d\n", ret);
199 if ((ret = mbedtls_pk_parse_keyfile(&tls_ctx->priv_key,
201 tls_ctx->priv_key_pw)) != 0) {
202 handle_pk_parse_error(h, ret);
207 // seed the random number generator
208 if ((ret = mbedtls_ctr_drbg_seed(&tls_ctx->ctr_drbg_context,
209 mbedtls_entropy_func,
210 &tls_ctx->entropy_context,
212 av_log(h, AV_LOG_ERROR, "mbedtls_ctr_drbg_seed returned %d\n", ret);
216 if ((ret = mbedtls_ssl_config_defaults(&tls_ctx->ssl_config,
217 shr->listen ? MBEDTLS_SSL_IS_SERVER : MBEDTLS_SSL_IS_CLIENT,
218 MBEDTLS_SSL_TRANSPORT_STREAM,
219 MBEDTLS_SSL_PRESET_DEFAULT)) != 0) {
220 av_log(h, AV_LOG_ERROR, "mbedtls_ssl_config_defaults returned %d\n", ret);
224 mbedtls_ssl_conf_authmode(&tls_ctx->ssl_config,
225 shr->ca_file ? MBEDTLS_SSL_VERIFY_REQUIRED : MBEDTLS_SSL_VERIFY_NONE);
226 mbedtls_ssl_conf_rng(&tls_ctx->ssl_config, mbedtls_ctr_drbg_random, &tls_ctx->ctr_drbg_context);
227 mbedtls_ssl_conf_ca_chain(&tls_ctx->ssl_config, &tls_ctx->ca_cert, NULL);
229 // set own certificate and private key
230 if ((ret = mbedtls_ssl_conf_own_cert(&tls_ctx->ssl_config, &tls_ctx->own_cert, &tls_ctx->priv_key)) != 0) {
231 av_log(h, AV_LOG_ERROR, "mbedtls_ssl_conf_own_cert returned %d\n", ret);
235 if ((ret = mbedtls_ssl_setup(&tls_ctx->ssl_context, &tls_ctx->ssl_config)) != 0) {
236 av_log(h, AV_LOG_ERROR, "mbedtls_ssl_setup returned %d\n", ret);
240 if (!shr->listen && !shr->numerichost) {
241 if ((ret = mbedtls_ssl_set_hostname(&tls_ctx->ssl_context, shr->host)) != 0) {
242 av_log(h, AV_LOG_ERROR, "mbedtls_ssl_set_hostname returned %d\n", ret);
247 // set I/O functions to use FFmpeg internal code for transport layer
248 mbedtls_ssl_set_bio(&tls_ctx->ssl_context, shr->tcp, mbedtls_send, mbedtls_recv, NULL);
251 while ((ret = mbedtls_ssl_handshake(&tls_ctx->ssl_context)) != 0) {
252 if (ret != MBEDTLS_ERR_SSL_WANT_READ && ret != MBEDTLS_ERR_SSL_WANT_WRITE) {
253 handle_handshake_error(h, ret);
259 // check the result of the certificate verification
260 if ((verify_res_flags = mbedtls_ssl_get_verify_result(&tls_ctx->ssl_context)) != 0) {
261 av_log(h, AV_LOG_ERROR, "mbedtls_ssl_get_verify_result reported problems "\
262 "with the certificate verification, returned flags: %u\n",
264 if (verify_res_flags & MBEDTLS_X509_BADCERT_NOT_TRUSTED)
265 av_log(h, AV_LOG_ERROR, "The certificate is not correctly signed by the trusted CA.\n");
277 static int handle_tls_error(URLContext *h, const char* func_name, int ret)
280 case MBEDTLS_ERR_SSL_WANT_READ:
281 case MBEDTLS_ERR_SSL_WANT_WRITE:
282 return AVERROR(EAGAIN);
283 case MBEDTLS_ERR_NET_SEND_FAILED:
284 case MBEDTLS_ERR_NET_RECV_FAILED:
286 case MBEDTLS_ERR_NET_CONN_RESET:
287 case MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY:
288 av_log(h, AV_LOG_WARNING, "%s reported connection reset by peer\n", func_name);
291 av_log(h, AV_LOG_ERROR, "%s returned -0x%x\n", func_name, -ret);
296 static int tls_read(URLContext *h, uint8_t *buf, int size)
298 TLSContext *tls_ctx = h->priv_data;
301 if ((ret = mbedtls_ssl_read(&tls_ctx->ssl_context, buf, size)) > 0) {
302 // return read length
306 return handle_tls_error(h, "mbedtls_ssl_read", ret);
309 static int tls_write(URLContext *h, const uint8_t *buf, int size)
311 TLSContext *tls_ctx = h->priv_data;
314 if ((ret = mbedtls_ssl_write(&tls_ctx->ssl_context, buf, size)) > 0) {
315 // return written length
319 return handle_tls_error(h, "mbedtls_ssl_write", ret);
322 static int tls_get_file_handle(URLContext *h)
324 TLSContext *c = h->priv_data;
325 return ffurl_get_file_handle(c->tls_shared.tcp);
328 static const AVOption options[] = {
329 TLS_COMMON_OPTIONS(TLSContext, tls_shared), \
330 {"key_password", "Password for the private key file", OFFSET(priv_key_pw), AV_OPT_TYPE_STRING, .flags = TLS_OPTFL }, \
334 static const AVClass tls_class = {
336 .item_name = av_default_item_name,
338 .version = LIBAVUTIL_VERSION_INT,
341 const URLProtocol ff_tls_protocol = {
343 .url_open2 = tls_open,
344 .url_read = tls_read,
345 .url_write = tls_write,
346 .url_close = tls_close,
347 .url_get_file_handle = tls_get_file_handle,
348 .priv_data_size = sizeof(TLSContext),
349 .flags = URL_PROTOCOL_FLAG_NETWORK,
350 .priv_data_class = &tls_class,