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
24 #include <gnutls/gnutls.h>
25 #include <gnutls/x509.h>
30 #include "os_support.h"
33 #include "libavcodec/internal.h"
34 #include "libavutil/avstring.h"
35 #include "libavutil/opt.h"
36 #include "libavutil/parseutils.h"
38 #ifndef GNUTLS_VERSION_NUMBER
39 #define GNUTLS_VERSION_NUMBER LIBGNUTLS_VERSION_NUMBER
42 #if HAVE_THREADS && GNUTLS_VERSION_NUMBER <= 0x020b00
44 #include "libavutil/thread.h"
45 GCRY_THREAD_OPTION_PTHREAD_IMPL;
48 typedef struct TLSContext {
51 gnutls_session_t session;
52 gnutls_certificate_credentials_t cred;
56 void ff_gnutls_init(void)
59 #if HAVE_THREADS && GNUTLS_VERSION_NUMBER < 0x020b00
60 if (gcry_control(GCRYCTL_ANY_INITIALIZATION_P) == 0)
61 gcry_control(GCRYCTL_SET_THREAD_CBS, &gcry_threads_pthread);
67 void ff_gnutls_deinit(void)
70 gnutls_global_deinit();
74 static int print_tls_error(URLContext *h, int ret)
78 return AVERROR(EAGAIN);
79 case GNUTLS_E_INTERRUPTED:
80 #ifdef GNUTLS_E_PREMATURE_TERMINATION
81 case GNUTLS_E_PREMATURE_TERMINATION:
84 case GNUTLS_E_WARNING_ALERT_RECEIVED:
85 av_log(h, AV_LOG_WARNING, "%s\n", gnutls_strerror(ret));
88 av_log(h, AV_LOG_ERROR, "%s\n", gnutls_strerror(ret));
94 static int tls_close(URLContext *h)
96 TLSContext *c = h->priv_data;
98 gnutls_bye(c->session, GNUTLS_SHUT_WR);
100 gnutls_deinit(c->session);
102 gnutls_certificate_free_credentials(c->cred);
103 if (c->tls_shared.tcp)
104 ffurl_close(c->tls_shared.tcp);
109 static ssize_t gnutls_url_pull(gnutls_transport_ptr_t transport,
110 void *buf, size_t len)
112 URLContext *h = (URLContext*) transport;
113 int ret = ffurl_read(h, buf, len);
116 if (ret == AVERROR_EXIT)
118 if (ret == AVERROR(EAGAIN))
125 static ssize_t gnutls_url_push(gnutls_transport_ptr_t transport,
126 const void *buf, size_t len)
128 URLContext *h = (URLContext*) transport;
129 int ret = ffurl_write(h, buf, len);
132 if (ret == AVERROR_EXIT)
134 if (ret == AVERROR(EAGAIN))
141 static int tls_open(URLContext *h, const char *uri, int flags, AVDictionary **options)
143 TLSContext *p = h->priv_data;
144 TLSShared *c = &p->tls_shared;
149 if ((ret = ff_tls_open_underlying(c, h, uri, options)) < 0)
152 gnutls_init(&p->session, c->listen ? GNUTLS_SERVER : GNUTLS_CLIENT);
153 if (!c->listen && !c->numerichost)
154 gnutls_server_name_set(p->session, GNUTLS_NAME_DNS, c->host, strlen(c->host));
155 gnutls_certificate_allocate_credentials(&p->cred);
157 ret = gnutls_certificate_set_x509_trust_file(p->cred, c->ca_file, GNUTLS_X509_FMT_PEM);
159 av_log(h, AV_LOG_ERROR, "%s\n", gnutls_strerror(ret));
161 #if GNUTLS_VERSION_NUMBER >= 0x030020
163 gnutls_certificate_set_x509_system_trust(p->cred);
165 gnutls_certificate_set_verify_flags(p->cred, c->verify ?
166 GNUTLS_VERIFY_ALLOW_X509_V1_CA_CRT : 0);
167 if (c->cert_file && c->key_file) {
168 ret = gnutls_certificate_set_x509_key_file(p->cred,
169 c->cert_file, c->key_file,
170 GNUTLS_X509_FMT_PEM);
172 av_log(h, AV_LOG_ERROR,
173 "Unable to set cert/key files %s and %s: %s\n",
174 c->cert_file, c->key_file, gnutls_strerror(ret));
178 } else if (c->cert_file || c->key_file)
179 av_log(h, AV_LOG_ERROR, "cert and key required\n");
180 gnutls_credentials_set(p->session, GNUTLS_CRD_CERTIFICATE, p->cred);
181 gnutls_transport_set_pull_function(p->session, gnutls_url_pull);
182 gnutls_transport_set_push_function(p->session, gnutls_url_push);
183 gnutls_transport_set_ptr(p->session, c->tcp);
184 gnutls_priority_set_direct(p->session, "NORMAL", NULL);
185 ret = gnutls_handshake(p->session);
187 ret = print_tls_error(h, ret);
190 p->need_shutdown = 1;
192 unsigned int status, cert_list_size;
193 gnutls_x509_crt_t cert;
194 const gnutls_datum_t *cert_list;
195 if ((ret = gnutls_certificate_verify_peers2(p->session, &status)) < 0) {
196 av_log(h, AV_LOG_ERROR, "Unable to verify peer certificate: %s\n",
197 gnutls_strerror(ret));
201 if (status & GNUTLS_CERT_INVALID) {
202 av_log(h, AV_LOG_ERROR, "Peer certificate failed verification\n");
206 if (gnutls_certificate_type_get(p->session) != GNUTLS_CRT_X509) {
207 av_log(h, AV_LOG_ERROR, "Unsupported certificate type\n");
211 gnutls_x509_crt_init(&cert);
212 cert_list = gnutls_certificate_get_peers(p->session, &cert_list_size);
213 gnutls_x509_crt_import(cert, cert_list, GNUTLS_X509_FMT_DER);
214 ret = gnutls_x509_crt_check_hostname(cert, c->host);
215 gnutls_x509_crt_deinit(cert);
217 av_log(h, AV_LOG_ERROR,
218 "The certificate's owner does not match hostname %s\n", c->host);
230 static int tls_read(URLContext *h, uint8_t *buf, int size)
232 TLSContext *c = h->priv_data;
234 // Set or clear the AVIO_FLAG_NONBLOCK on c->tls_shared.tcp
235 c->tls_shared.tcp->flags &= ~AVIO_FLAG_NONBLOCK;
236 c->tls_shared.tcp->flags |= h->flags & AVIO_FLAG_NONBLOCK;
237 ret = gnutls_record_recv(c->session, buf, size);
242 return print_tls_error(h, ret);
245 static int tls_write(URLContext *h, const uint8_t *buf, int size)
247 TLSContext *c = h->priv_data;
249 // Set or clear the AVIO_FLAG_NONBLOCK on c->tls_shared.tcp
250 c->tls_shared.tcp->flags &= ~AVIO_FLAG_NONBLOCK;
251 c->tls_shared.tcp->flags |= h->flags & AVIO_FLAG_NONBLOCK;
252 ret = gnutls_record_send(c->session, buf, size);
257 return print_tls_error(h, ret);
260 static int tls_get_file_handle(URLContext *h)
262 TLSContext *c = h->priv_data;
263 return ffurl_get_file_handle(c->tls_shared.tcp);
266 static const AVOption options[] = {
267 TLS_COMMON_OPTIONS(TLSContext, tls_shared),
271 static const AVClass tls_class = {
273 .item_name = av_default_item_name,
275 .version = LIBAVUTIL_VERSION_INT,
278 const URLProtocol ff_tls_protocol = {
280 .url_open2 = tls_open,
281 .url_read = tls_read,
282 .url_write = tls_write,
283 .url_close = tls_close,
284 .url_get_file_handle = tls_get_file_handle,
285 .priv_data_size = sizeof(TLSContext),
286 .flags = URL_PROTOCOL_FLAG_NETWORK,
287 .priv_data_class = &tls_class,