oma: support for encrypted files
[ffmpeg.git] / libavformat / oma.c
1 /*
2  * Sony OpenMG (OMA) demuxer
3  *
4  * Copyright (c) 2008 Maxim Poliakovski
5  *               2008 Benjamin Larsson
6  *               2011 David Goldwich
7  *
8  * This file is part of Libav.
9  *
10  * Libav is free software; you can redistribute it and/or
11  * modify it under the terms of the GNU Lesser General Public
12  * License as published by the Free Software Foundation; either
13  * version 2.1 of the License, or (at your option) any later version.
14  *
15  * Libav is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
18  * Lesser General Public License for more details.
19  *
20  * You should have received a copy of the GNU Lesser General Public
21  * License along with Libav; if not, write to the Free Software
22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
23  */
24
25 /**
26  * @file
27  * This is a demuxer for Sony OpenMG Music files
28  *
29  * Known file extensions: ".oma", "aa3"
30  * The format of such files consists of three parts:
31  * - "ea3" header carrying overall info and metadata. Except for starting with
32  *   "ea" instead of "ID", it's an ID3v2 header.
33  * - "EA3" header is a Sony-specific header containing information about
34  *   the OpenMG file: codec type (usually ATRAC, can also be MP3 or WMA),
35  *   codec specific info (packet size, sample rate, channels and so on)
36  *   and DRM related info (file encryption, content id).
37  * - Sound data organized in packets follow the EA3 header
38  *   (can be encrypted using the Sony DRM!).
39  *
40  * CODEC SUPPORT: Only ATRAC3 codec is currently supported!
41  */
42
43 #include "avformat.h"
44 #include "libavutil/intreadwrite.h"
45 #include "libavutil/des.h"
46 #include "pcm.h"
47 #include "riff.h"
48 #include "id3v2.h"
49
50 #define EA3_HEADER_SIZE 96
51 #define ID3v2_EA3_MAGIC "ea3"
52 #define OMA_ENC_HEADER_SIZE 16
53
54 enum {
55     OMA_CODECID_ATRAC3  = 0,
56     OMA_CODECID_ATRAC3P = 1,
57     OMA_CODECID_MP3     = 3,
58     OMA_CODECID_LPCM    = 4,
59     OMA_CODECID_WMA     = 5,
60 };
61
62 static const AVCodecTag codec_oma_tags[] = {
63     { CODEC_ID_ATRAC3,  OMA_CODECID_ATRAC3 },
64     { CODEC_ID_ATRAC3P, OMA_CODECID_ATRAC3P },
65     { CODEC_ID_MP3,     OMA_CODECID_MP3 },
66 };
67
68 static const uint64_t leaf_table[] = {
69     0xd79e8283acea4620, 0x7a9762f445afd0d8,
70     0x354d60a60b8c79f1, 0x584e1cde00b07aee,
71     0x1573cd93da7df623, 0x47f98d79620dd535
72 };
73
74 typedef struct OMAContext {
75     uint64_t content_start;
76     int encrypted;
77     uint16_t k_size;
78     uint16_t e_size;
79     uint16_t i_size;
80     uint16_t s_size;
81     uint32_t rid;
82     uint8_t r_val[24];
83     uint8_t n_val[24];
84     uint8_t m_val[8];
85     uint8_t s_val[8];
86     uint8_t sm_val[8];
87     uint8_t e_val[8];
88     uint8_t iv[8];
89     struct AVDES av_des;
90 } OMAContext;
91
92 static void hex_log(AVFormatContext *s, int level, const char *name, const uint8_t *value, int len)
93 {
94     char buf[33];
95     len = FFMIN(len, 16);
96     if (av_log_get_level() < level)
97         return;
98     ff_data_to_hex(buf, value, len, 1);
99     buf[len<<1] = '\0';
100     av_log(s, level, "%s: %s\n", name, buf);
101 }
102
103 static int kset(AVFormatContext *s, const uint8_t *r_val, const uint8_t *n_val, int len)
104 {
105     OMAContext *oc = s->priv_data;
106
107     if (!r_val && !n_val)
108         return -1;
109
110     len = FFMIN(len, 16);
111
112     /* use first 64 bits in the third round again */
113     if (r_val) {
114         if (r_val != oc->r_val) {
115             memset(oc->r_val, 0, 24);
116             memcpy(oc->r_val, r_val, len);
117         }
118         memcpy(&oc->r_val[16], r_val, 8);
119     }
120     if (n_val) {
121         if (n_val != oc->n_val) {
122             memset(oc->n_val, 0, 24);
123             memcpy(oc->n_val, n_val, len);
124         }
125         memcpy(&oc->n_val[16], n_val, 8);
126     }
127
128     return 0;
129 }
130
131 static int rprobe(AVFormatContext *s, uint8_t *enc_header, const uint8_t *r_val)
132 {
133     OMAContext *oc = s->priv_data;
134     unsigned int pos;
135     struct AVDES av_des;
136
137     if (!enc_header || !r_val)
138         return -1;
139
140     /* m_val */
141     av_des_init(&av_des, r_val, 192, 1);
142     av_des_crypt(&av_des, oc->m_val, &enc_header[48], 1, NULL, 1);
143
144     /* s_val */
145     av_des_init(&av_des, oc->m_val, 64, 0);
146     av_des_crypt(&av_des, oc->s_val, NULL, 1, NULL, 0);
147
148     /* sm_val */
149     pos = OMA_ENC_HEADER_SIZE + oc->k_size + oc->e_size;
150     av_des_init(&av_des, oc->s_val, 64, 0);
151     av_des_mac(&av_des, oc->sm_val, &enc_header[pos], (oc->i_size >> 3));
152
153     pos += oc->i_size;
154
155     return memcmp(&enc_header[pos], oc->sm_val, 8) ? -1 : 0;
156 }
157
158 static int nprobe(AVFormatContext *s, uint8_t *enc_header, const uint8_t *n_val)
159 {
160     OMAContext *oc = s->priv_data;
161     uint32_t pos, taglen, datalen;
162     struct AVDES av_des;
163
164     if (!enc_header || !n_val)
165         return -1;
166
167     pos = OMA_ENC_HEADER_SIZE + oc->k_size;
168     if (!memcmp(&enc_header[pos], "EKB ", 4))
169         pos += 32;
170
171     if (AV_RB32(&enc_header[pos]) != oc->rid)
172         av_log(s, AV_LOG_DEBUG, "Mismatching RID\n");
173
174     taglen = AV_RB32(&enc_header[pos+32]);
175     datalen = AV_RB32(&enc_header[pos+36]) >> 4;
176
177     pos += 44 + taglen;
178
179     av_des_init(&av_des, n_val, 192, 1);
180     while (datalen-- > 0) {
181         av_des_crypt(&av_des, oc->r_val, &enc_header[pos], 2, NULL, 1);
182         kset(s, oc->r_val, NULL, 16);
183         if (!rprobe(s, enc_header, oc->r_val))
184             return 0;
185         pos += 16;
186     }
187
188     return -1;
189 }
190
191 static int decrypt_init(AVFormatContext *s, ID3v2ExtraMeta *em, uint8_t *header)
192 {
193     OMAContext *oc = s->priv_data;
194     ID3v2ExtraMetaGEOB *geob = NULL;
195     uint8_t *gdata;
196
197     oc->encrypted = 1;
198     av_log(s, AV_LOG_INFO, "File is encrypted\n");
199
200     /* find GEOB metadata */
201     while (em) {
202         if (!strcmp(em->tag, "GEOB") &&
203             (geob = em->data) &&
204             !strcmp(geob->description, "OMG_LSI") ||
205             !strcmp(geob->description, "OMG_BKLSI")) {
206             break;
207         }
208         em = em->next;
209     }
210     if (!em) {
211         av_log(s, AV_LOG_ERROR, "No encryption header found\n");
212         return -1;
213     }
214
215     if (geob->datasize < 64) {
216         av_log(s, AV_LOG_ERROR, "Invalid GEOB data size: %u\n", geob->datasize);
217         return -1;
218     }
219
220     gdata = geob->data;
221
222     if (AV_RB16(gdata) != 1)
223         av_log(s, AV_LOG_WARNING, "Unknown version in encryption header\n");
224
225     oc->k_size = AV_RB16(&gdata[2]);
226     oc->e_size = AV_RB16(&gdata[4]);
227     oc->i_size = AV_RB16(&gdata[6]);
228     oc->s_size = AV_RB16(&gdata[8]);
229
230     if (memcmp(&gdata[OMA_ENC_HEADER_SIZE], "KEYRING     ", 12)) {
231         av_log(s, AV_LOG_ERROR, "Invalid encryption header\n");
232         return -1;
233     }
234     oc->rid = AV_RB32(&gdata[OMA_ENC_HEADER_SIZE + 28]);
235     av_log(s, AV_LOG_DEBUG, "RID: %.8x\n", oc->rid);
236
237     memcpy(oc->iv, &header[0x58], 8);
238     hex_log(s, AV_LOG_DEBUG, "IV", oc->iv, 8);
239
240     hex_log(s, AV_LOG_DEBUG, "CBC-MAC", &gdata[OMA_ENC_HEADER_SIZE+oc->k_size+oc->e_size+oc->i_size], 8);
241
242     if (s->keylen > 0) {
243         kset(s, s->key, s->key, s->keylen);
244     }
245     if (!memcmp(oc->r_val, (const uint8_t[8]){0}, 8) ||
246         rprobe(s, gdata, oc->r_val) < 0 &&
247         nprobe(s, gdata, oc->n_val) < 0) {
248         int i;
249         for (i = 0; i < sizeof(leaf_table); i += 2) {
250             uint8_t buf[16];
251             AV_WL64(buf, leaf_table[i]);
252             AV_WL64(&buf[8], leaf_table[i+1]);
253             kset(s, buf, buf, 16);
254             if (!rprobe(s, gdata, oc->r_val) || !nprobe(s, gdata, oc->n_val))
255                 break;
256         }
257         if (i >= sizeof(leaf_table)) {
258             av_log(s, AV_LOG_ERROR, "Invalid key\n");
259             return -1;
260         }
261     }
262
263     /* e_val */
264     av_des_init(&oc->av_des, oc->m_val, 64, 0);
265     av_des_crypt(&oc->av_des, oc->e_val, &gdata[OMA_ENC_HEADER_SIZE + 40], 1, NULL, 0);
266     hex_log(s, AV_LOG_DEBUG, "EK", oc->e_val, 8);
267
268     /* init e_val */
269     av_des_init(&oc->av_des, oc->e_val, 64, 1);
270
271     return 0;
272 }
273
274 static int oma_read_header(AVFormatContext *s,
275                            AVFormatParameters *ap)
276 {
277     static const uint16_t srate_tab[6] = {320,441,480,882,960,0};
278     int     ret, framesize, jsflag, samplerate;
279     uint32_t codec_params;
280     int16_t eid;
281     uint8_t buf[EA3_HEADER_SIZE];
282     uint8_t *edata;
283     AVStream *st;
284     ID3v2ExtraMeta *extra_meta = NULL;
285     OMAContext *oc = s->priv_data;
286
287     ff_id3v2_read_all(s, ID3v2_EA3_MAGIC, &extra_meta);
288     ret = avio_read(s->pb, buf, EA3_HEADER_SIZE);
289     if (ret < EA3_HEADER_SIZE)
290         return -1;
291
292     if (memcmp(buf, ((const uint8_t[]){'E', 'A', '3'}),3) || buf[4] != 0 || buf[5] != EA3_HEADER_SIZE) {
293         av_log(s, AV_LOG_ERROR, "Couldn't find the EA3 header !\n");
294         return -1;
295     }
296
297     oc->content_start = avio_tell(s->pb);
298
299     /* encrypted file */
300     eid = AV_RB16(&buf[6]);
301     if (eid != -1 && eid != -128 && decrypt_init(s, extra_meta, buf) < 0) {
302         ff_id3v2_free_extra_meta(&extra_meta);
303         return -1;
304     }
305
306     ff_id3v2_free_extra_meta(&extra_meta);
307
308     codec_params = AV_RB24(&buf[33]);
309
310     st = av_new_stream(s, 0);
311     if (!st)
312         return AVERROR(ENOMEM);
313
314     st->start_time = 0;
315     st->codec->codec_type  = AVMEDIA_TYPE_AUDIO;
316     st->codec->codec_tag   = buf[32];
317     st->codec->codec_id    = ff_codec_get_id(codec_oma_tags, st->codec->codec_tag);
318
319     switch (buf[32]) {
320         case OMA_CODECID_ATRAC3:
321             samplerate = srate_tab[(codec_params >> 13) & 7]*100;
322             if (samplerate != 44100)
323                 av_log_ask_for_sample(s, "Unsupported sample rate: %d\n",
324                                       samplerate);
325
326             framesize = (codec_params & 0x3FF) * 8;
327             jsflag = (codec_params >> 17) & 1; /* get stereo coding mode, 1 for joint-stereo */
328             st->codec->channels    = 2;
329             st->codec->sample_rate = samplerate;
330             st->codec->bit_rate    = st->codec->sample_rate * framesize * 8 / 1024;
331
332             /* fake the atrac3 extradata (wav format, makes stream copy to wav work) */
333             st->codec->extradata_size = 14;
334             edata = av_mallocz(14 + FF_INPUT_BUFFER_PADDING_SIZE);
335             if (!edata)
336                 return AVERROR(ENOMEM);
337
338             st->codec->extradata = edata;
339             AV_WL16(&edata[0],  1);             // always 1
340             AV_WL32(&edata[2],  samplerate);    // samples rate
341             AV_WL16(&edata[6],  jsflag);        // coding mode
342             AV_WL16(&edata[8],  jsflag);        // coding mode
343             AV_WL16(&edata[10], 1);             // always 1
344             // AV_WL16(&edata[12], 0);          // always 0
345
346             av_set_pts_info(st, 64, 1, st->codec->sample_rate);
347             break;
348         case OMA_CODECID_ATRAC3P:
349             st->codec->channels = (codec_params >> 10) & 7;
350             framesize = ((codec_params & 0x3FF) * 8) + 8;
351             st->codec->sample_rate = srate_tab[(codec_params >> 13) & 7]*100;
352             st->codec->bit_rate    = st->codec->sample_rate * framesize * 8 / 1024;
353             av_set_pts_info(st, 64, 1, st->codec->sample_rate);
354             av_log(s, AV_LOG_ERROR, "Unsupported codec ATRAC3+!\n");
355             break;
356         case OMA_CODECID_MP3:
357             st->need_parsing = AVSTREAM_PARSE_FULL;
358             framesize = 1024;
359             break;
360         default:
361             av_log(s, AV_LOG_ERROR, "Unsupported codec %d!\n",buf[32]);
362             return -1;
363     }
364
365     st->codec->block_align = framesize;
366
367     return 0;
368 }
369
370
371 static int oma_read_packet(AVFormatContext *s, AVPacket *pkt)
372 {
373     OMAContext *oc = s->priv_data;
374     int packet_size = s->streams[0]->codec->block_align;
375     int ret = av_get_packet(s->pb, pkt, packet_size);
376
377     if (ret <= 0)
378         return AVERROR(EIO);
379
380     pkt->stream_index = 0;
381
382     if (oc->encrypted) {
383         /* previous unencrypted block saved in IV for the next packet (CBC mode) */
384         av_des_crypt(&oc->av_des, pkt->data, pkt->data, (packet_size >> 3), oc->iv, 1);
385     }
386
387     return ret;
388 }
389
390 static int oma_read_probe(AVProbeData *p)
391 {
392     const uint8_t *buf;
393     unsigned tag_len = 0;
394
395     buf = p->buf;
396     /* version must be 3 and flags byte zero */
397     if (ff_id3v2_match(buf, ID3v2_EA3_MAGIC) && buf[3] == 3 && !buf[4])
398         tag_len = ff_id3v2_tag_len(buf);
399
400     // This check cannot overflow as tag_len has at most 28 bits
401     if (p->buf_size < tag_len + 5)
402         return 0;
403
404     buf += tag_len;
405
406     if (!memcmp(buf, "EA3", 3) && !buf[4] && buf[5] == EA3_HEADER_SIZE)
407         return AVPROBE_SCORE_MAX;
408     else
409         return 0;
410 }
411
412 static int oma_read_seek(struct AVFormatContext *s, int stream_index, int64_t timestamp, int flags)
413 {
414     OMAContext *oc = s->priv_data;
415
416     pcm_read_seek(s, stream_index, timestamp, flags);
417
418     if (oc->encrypted) {
419         /* readjust IV for CBC */
420         int64_t pos = avio_tell(s->pb);
421         if (pos < oc->content_start)
422             memset(oc->iv, 0, 8);
423         else {
424             if (avio_seek(s->pb, -8, SEEK_CUR) < 0 || avio_read(s->pb, oc->iv, 8) < 8) {
425                 memset(oc->iv, 0, 8);
426                 return -1;
427             }
428         }
429     }
430
431     return 0;
432 }
433
434 AVInputFormat ff_oma_demuxer = {
435     .name           = "oma",
436     .long_name      = NULL_IF_CONFIG_SMALL("Sony OpenMG audio"),
437     .priv_data_size = sizeof(OMAContext),
438     .read_probe     = oma_read_probe,
439     .read_header    = oma_read_header,
440     .read_packet    = oma_read_packet,
441     .read_seek      = oma_read_seek,
442     .flags          = AVFMT_GENERIC_INDEX,
443     .extensions     = "oma,omg,aa3",
444     .codec_tag      = (const AVCodecTag* const []){codec_oma_tags, 0},
445 };
446