31a438c94ca3d4740d7193baeac486c2135dcacb
[ffmpeg.git] / libavformat / crypto.c
1 /*
2  * Decryption protocol handler
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 "libavutil/aes.h"
24 #include "libavutil/avstring.h"
25 #include "libavutil/opt.h"
26 #include "internal.h"
27 #include "url.h"
28
29 // encourage reads of 4096 bytes - 1 block is always retained.
30 #define MAX_BUFFER_BLOCKS 257
31 #define BLOCKSIZE 16
32
33 typedef struct CryptoContext {
34     const AVClass *class;
35     URLContext *hd;
36     uint8_t inbuffer [BLOCKSIZE*MAX_BUFFER_BLOCKS],
37             outbuffer[BLOCKSIZE*MAX_BUFFER_BLOCKS];
38     uint8_t *outptr;
39     int indata, indata_used, outdata;
40     int eof;
41     uint8_t *key;
42     int keylen;
43     uint8_t *iv;
44     int ivlen;
45     uint8_t *decrypt_key;
46     int decrypt_keylen;
47     uint8_t *decrypt_iv;
48     int decrypt_ivlen;
49     uint8_t *encrypt_key;
50     int encrypt_keylen;
51     uint8_t *encrypt_iv;
52     int encrypt_ivlen;
53     struct AVAES *aes_decrypt;
54     struct AVAES *aes_encrypt;
55
56     uint8_t pad[BLOCKSIZE];
57     int pad_len;
58
59 } CryptoContext;
60
61 #define OFFSET(x) offsetof(CryptoContext, x)
62 #define D AV_OPT_FLAG_DECODING_PARAM
63 #define E AV_OPT_FLAG_ENCODING_PARAM
64 static const AVOption options[] = {
65     {"key", "AES encryption/decryption key",                   OFFSET(key),         AV_OPT_TYPE_BINARY, .flags = D|E },
66     {"iv",  "AES encryption/decryption initialization vector", OFFSET(iv),          AV_OPT_TYPE_BINARY, .flags = D|E },
67     {"decryption_key", "AES decryption key",                   OFFSET(decrypt_key), AV_OPT_TYPE_BINARY, .flags = D },
68     {"decryption_iv",  "AES decryption initialization vector", OFFSET(decrypt_iv),  AV_OPT_TYPE_BINARY, .flags = D },
69     {"encryption_key", "AES encryption key",                   OFFSET(encrypt_key), AV_OPT_TYPE_BINARY, .flags = E },
70     {"encryption_iv",  "AES encryption initialization vector", OFFSET(encrypt_iv),  AV_OPT_TYPE_BINARY, .flags = E },
71     { NULL }
72 };
73
74 static const AVClass crypto_class = {
75     .class_name     = "crypto",
76     .item_name      = av_default_item_name,
77     .option         = options,
78     .version        = LIBAVUTIL_VERSION_INT,
79 };
80
81 static int set_aes_arg(CryptoContext *c, uint8_t **buf, int *buf_len,
82                        uint8_t *default_buf, int default_buf_len,
83                        const char *desc)
84 {
85     if (!*buf_len) {
86         if (!default_buf_len) {
87             av_log(c, AV_LOG_ERROR, "%s not set\n", desc);
88             return AVERROR(EINVAL);
89         } else if (default_buf_len != BLOCKSIZE) {
90             av_log(c, AV_LOG_ERROR,
91                    "invalid %s size (%d bytes, block size is %d)\n",
92                    desc, default_buf_len, BLOCKSIZE);
93             return AVERROR(EINVAL);
94         }
95         *buf = av_memdup(default_buf, default_buf_len);
96         if (!*buf)
97             return AVERROR(ENOMEM);
98         *buf_len = default_buf_len;
99     } else if (*buf_len != BLOCKSIZE) {
100         av_log(c, AV_LOG_ERROR,
101                "invalid %s size (%d bytes, block size is %d)\n",
102                desc, *buf_len, BLOCKSIZE);
103         return AVERROR(EINVAL);
104     }
105     return 0;
106 }
107
108 static int crypto_open2(URLContext *h, const char *uri, int flags, AVDictionary **options)
109 {
110     const char *nested_url;
111     int ret = 0;
112     CryptoContext *c = h->priv_data;
113
114     if (!av_strstart(uri, "crypto+", &nested_url) &&
115         !av_strstart(uri, "crypto:", &nested_url)) {
116         av_log(h, AV_LOG_ERROR, "Unsupported url %s\n", uri);
117         ret = AVERROR(EINVAL);
118         goto err;
119     }
120
121     if (flags & AVIO_FLAG_READ) {
122         if ((ret = set_aes_arg(c, &c->decrypt_key, &c->decrypt_keylen,
123                                c->key, c->keylen, "decryption key")) < 0)
124             goto err;
125         if ((ret = set_aes_arg(c, &c->decrypt_iv, &c->decrypt_ivlen,
126                                c->iv, c->ivlen, "decryption IV")) < 0)
127             goto err;
128     }
129
130     if (flags & AVIO_FLAG_WRITE) {
131         if ((ret = set_aes_arg(c, &c->encrypt_key, &c->encrypt_keylen,
132                                c->key, c->keylen, "encryption key")) < 0)
133         if (ret < 0)
134             goto err;
135         if ((ret = set_aes_arg(c, &c->encrypt_iv, &c->encrypt_ivlen,
136                                c->iv, c->ivlen, "encryption IV")) < 0)
137             goto err;
138     }
139
140     if ((ret = ffurl_open_whitelist(&c->hd, nested_url, flags,
141                                     &h->interrupt_callback, options,
142                                     h->protocol_whitelist, h->protocol_blacklist, h)) < 0) {
143         av_log(h, AV_LOG_ERROR, "Unable to open resource: %s\n", nested_url);
144         goto err;
145     }
146
147     if (flags & AVIO_FLAG_READ) {
148         c->aes_decrypt = av_aes_alloc();
149         if (!c->aes_decrypt) {
150             ret = AVERROR(ENOMEM);
151             goto err;
152         }
153         ret = av_aes_init(c->aes_decrypt, c->decrypt_key, BLOCKSIZE*8, 1);
154         if (ret < 0)
155             goto err;
156     }
157
158     if (flags & AVIO_FLAG_WRITE) {
159         c->aes_encrypt = av_aes_alloc();
160         if (!c->aes_encrypt) {
161             ret = AVERROR(ENOMEM);
162             goto err;
163         }
164         ret = av_aes_init(c->aes_encrypt, c->encrypt_key, BLOCKSIZE*8, 0);
165         if (ret < 0)
166             goto err;
167     }
168
169     c->pad_len = 0;
170
171     h->is_streamed = 1;
172
173 err:
174     return ret;
175 }
176
177 static int crypto_read(URLContext *h, uint8_t *buf, int size)
178 {
179     CryptoContext *c = h->priv_data;
180     int blocks;
181 retry:
182     if (c->outdata > 0) {
183         size = FFMIN(size, c->outdata);
184         memcpy(buf, c->outptr, size);
185         c->outptr  += size;
186         c->outdata -= size;
187         return size;
188     }
189     // We avoid using the last block until we've found EOF,
190     // since we'll remove PKCS7 padding at the end. So make
191     // sure we've got at least 2 blocks, so we can decrypt
192     // at least one.
193     while (c->indata - c->indata_used < 2*BLOCKSIZE) {
194         int n = ffurl_read(c->hd, c->inbuffer + c->indata,
195                            sizeof(c->inbuffer) - c->indata);
196         if (n <= 0) {
197             c->eof = 1;
198             break;
199         }
200         c->indata += n;
201     }
202     blocks = (c->indata - c->indata_used) / BLOCKSIZE;
203     if (!blocks)
204         return AVERROR_EOF;
205     if (!c->eof)
206         blocks--;
207     av_aes_crypt(c->aes_decrypt, c->outbuffer, c->inbuffer + c->indata_used,
208                  blocks, c->decrypt_iv, 1);
209     c->outdata      = BLOCKSIZE * blocks;
210     c->outptr       = c->outbuffer;
211     c->indata_used += BLOCKSIZE * blocks;
212     if (c->indata_used >= sizeof(c->inbuffer)/2) {
213         memmove(c->inbuffer, c->inbuffer + c->indata_used,
214                 c->indata - c->indata_used);
215         c->indata     -= c->indata_used;
216         c->indata_used = 0;
217     }
218     if (c->eof) {
219         // Remove PKCS7 padding at the end
220         int padding = c->outbuffer[c->outdata - 1];
221         c->outdata -= padding;
222     }
223     goto retry;
224 }
225
226 static int crypto_write(URLContext *h, const unsigned char *buf, int size)
227 {
228     CryptoContext *c = h->priv_data;
229     int total_size, blocks, pad_len, out_size;
230     uint8_t *out_buf;
231     int ret = 0;
232
233     total_size = size + c->pad_len;
234     pad_len = total_size % BLOCKSIZE;
235     out_size = total_size - pad_len;
236     blocks = out_size / BLOCKSIZE;
237
238     if (out_size) {
239         out_buf = av_malloc(out_size);
240         if (!out_buf)
241             return AVERROR(ENOMEM);
242
243         if (c->pad_len) {
244             memcpy(&c->pad[c->pad_len], buf, BLOCKSIZE - c->pad_len);
245             av_aes_crypt(c->aes_encrypt, out_buf, c->pad, 1, c->encrypt_iv, 0);
246             blocks--;
247         }
248
249         av_aes_crypt(c->aes_encrypt, &out_buf[c->pad_len ? BLOCKSIZE : 0],
250                              &buf[c->pad_len ? BLOCKSIZE - c->pad_len: 0],
251                              blocks, c->encrypt_iv, 0);
252
253         ret = ffurl_write(c->hd, out_buf, out_size);
254         av_free(out_buf);
255         if (ret < 0)
256             return ret;
257
258         memcpy(c->pad, &buf[size - pad_len], pad_len);
259     } else
260         memcpy(&c->pad[c->pad_len], buf, size);
261
262     c->pad_len = pad_len;
263
264     return size;
265 }
266
267 static int crypto_close(URLContext *h)
268 {
269     CryptoContext *c = h->priv_data;
270     uint8_t out_buf[BLOCKSIZE];
271     int ret, pad;
272
273     if (c->aes_encrypt) {
274         pad = BLOCKSIZE - c->pad_len;
275         memset(&c->pad[c->pad_len], pad, pad);
276         av_aes_crypt(c->aes_encrypt, out_buf, c->pad, 1, c->encrypt_iv, 0);
277         if ((ret =  ffurl_write(c->hd, out_buf, BLOCKSIZE)) < 0)
278             return ret;
279     }
280
281     if (c->hd)
282         ffurl_close(c->hd);
283     av_freep(&c->aes_decrypt);
284     av_freep(&c->aes_encrypt);
285     return 0;
286 }
287
288 const URLProtocol ff_crypto_protocol = {
289     .name            = "crypto",
290     .url_open2       = crypto_open2,
291     .url_read        = crypto_read,
292     .url_write       = crypto_write,
293     .url_close       = crypto_close,
294     .priv_data_size  = sizeof(CryptoContext),
295     .priv_data_class = &crypto_class,
296     .flags           = URL_PROTOCOL_FLAG_NESTED_SCHEME,
297 };