git.sesse.net Git - ffmpeg/blob - tools/target_dec_fuzzer.c

   1 /*
   2  * This file is part of FFmpeg.
   3  *
   4  * FFmpeg is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2.1 of the License, or (at your option) any later version.
   8  *
   9  * FFmpeg is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with FFmpeg; if not, write to the Free Software
  16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  17  */
  18
  19 /* Targeted fuzzer that targets specific codecs depending on two
  20    compile-time flags.
  21   INSTRUCTIONS:
  22
  23   * Get the very fresh clang, e.g. see http://libfuzzer.info#versions
  24   * Get and build libFuzzer:
  25      svn co http://llvm.org/svn/llvm-project/llvm/trunk/lib/Fuzzer
  26      ./Fuzzer/build.sh
  27   * build ffmpeg for fuzzing:
  28     FLAGS="-fsanitize=address -fsanitize-coverage=trace-pc-guard,trace-cmp -g" CC="clang $FLAGS" CXX="clang++ $FLAGS" ./configure  --disable-x86asm
  29     make clean && make -j
  30   * build the fuzz target.
  31     Choose the value of FFMPEG_CODEC (e.g. AV_CODEC_ID_DVD_SUBTITLE) and
  32     choose one of FUZZ_FFMPEG_VIDEO, FUZZ_FFMPEG_AUDIO, FUZZ_FFMPEG_SUBTITLE.
  33     clang -fsanitize=address -fsanitize-coverage=trace-pc-guard,trace-cmp tools/target_dec_fuzzer.c -o target_dec_fuzzer -I.   -DFFMPEG_CODEC=AV_CODEC_ID_MPEG1VIDEO -DFUZZ_FFMPEG_VIDEO ../../libfuzzer/libFuzzer.a   -Llibavcodec -Llibavdevice -Llibavfilter -Llibavformat -Llibavresample -Llibavutil -Llibpostproc -Llibswscale -Llibswresample -Wl,--as-needed -Wl,-z,noexecstack -Wl,--warn-common -Wl,-rpath-link=:libpostproc:libswresample:libswscale:libavfilter:libavdevice:libavformat:libavcodec:libavutil:libavresample -lavdevice -lavfilter -lavformat -lavcodec -lswresample -lswscale -lavutil -ldl -lxcb -lxcb-shm -lxcb -lxcb-xfixes  -lxcb -lxcb-shape -lxcb -lX11 -lasound -lm -lbz2 -lz -pthread
  34   * create a corpus directory and put some samples there (empty dir is ok too):
  35     mkdir CORPUS && cp some-files CORPUS
  36
  37   * Run fuzzing:
  38     ./target_dec_fuzzer -max_len=100000 CORPUS
  39
  40    More info:
  41    http://libfuzzer.info
  42    http://tutorial.libfuzzer.info
  43    https://github.com/google/oss-fuzz
  44    http://lcamtuf.coredump.cx/afl/
  45    https://security.googleblog.com/2016/08/guided-in-process-fuzzing-of-chrome.html
  46 */
  47
  48 #include "config.h"
  49 #include "libavutil/avassert.h"
  50 #include "libavutil/imgutils.h"
  51 #include "libavutil/intreadwrite.h"
  52
  53 #include "libavcodec/avcodec.h"
  54 #include "libavcodec/bytestream.h"
  55 #include "libavformat/avformat.h"
  56
  57 //For FF_SANE_NB_CHANNELS, so we dont waste energy testing things that will get instantly rejected
  58 #include "libavcodec/internal.h"
  59
  60 int LLVMFuzzerTestOneInput(const uint8_t *data, size_t size);
  61
  62 extern AVCodec * codec_list[];
  63
  64 static void error(const char *err)
  65 {
  66     fprintf(stderr, "%s", err);
  67     exit(1);
  68 }
  69
  70 static AVCodec *c = NULL;
  71 static AVCodec *AVCodecInitialize(enum AVCodecID codec_id)
  72 {
  73     AVCodec *res;
  74
  75     res = avcodec_find_decoder(codec_id);
  76     if (!res)
  77         error("Failed to find decoder");
  78     return res;
  79 }
  80
  81 static int subtitle_handler(AVCodecContext *avctx, void *frame,
  82                             int *got_sub_ptr, AVPacket *avpkt)
  83 {
  84     AVSubtitle sub;
  85     int ret = avcodec_decode_subtitle2(avctx, &sub, got_sub_ptr, avpkt);
  86     if (ret >= 0 && *got_sub_ptr)
  87         avsubtitle_free(&sub);
  88     return ret;
  89 }
  90
  91 // Ensure we don't loop forever
  92 const uint32_t maxiteration = 8096;
  93 const uint64_t maxpixels_per_frame = 4096 * 4096;
  94 uint64_t maxpixels;
  95
  96 static const uint64_t FUZZ_TAG = 0x4741542D5A5A5546ULL;
  97
  98 int LLVMFuzzerTestOneInput(const uint8_t *data, size_t size) {
  99     const uint64_t fuzz_tag = FUZZ_TAG;
 100     const uint8_t *last = data;
 101     const uint8_t *end = data + size;
 102     uint32_t it = 0;
 103     uint64_t ec_pixels = 0;
 104     int (*decode_handler)(AVCodecContext *avctx, AVFrame *picture,
 105                           int *got_picture_ptr,
 106                           const AVPacket *avpkt) = NULL;
 107     AVCodecParserContext *parser = NULL;
 108
 109
 110     if (!c) {
 111 #ifdef FFMPEG_DECODER
 112 #define DECODER_SYMBOL0(CODEC) ff_##CODEC##_decoder
 113 #define DECODER_SYMBOL(CODEC) DECODER_SYMBOL0(CODEC)
 114         extern AVCodec DECODER_SYMBOL(FFMPEG_DECODER);
 115         codec_list[0] = &DECODER_SYMBOL(FFMPEG_DECODER);
 116         avcodec_register(&DECODER_SYMBOL(FFMPEG_DECODER));
 117
 118         c = &DECODER_SYMBOL(FFMPEG_DECODER);
 119 #else
 120         avcodec_register_all();
 121         c = AVCodecInitialize(FFMPEG_CODEC);  // Done once.
 122 #endif
 123         av_log_set_level(AV_LOG_PANIC);
 124     }
 125
 126     switch (c->type) {
 127     case AVMEDIA_TYPE_AUDIO   : decode_handler = avcodec_decode_audio4; break;
 128     case AVMEDIA_TYPE_VIDEO   : decode_handler = avcodec_decode_video2; break;
 129     case AVMEDIA_TYPE_SUBTITLE: decode_handler = subtitle_handler     ; break;
 130     }
 131     maxpixels = maxpixels_per_frame * maxiteration;
 132     switch (c->id) {
 133         // Allows a small input to generate gigantic output
 134     case AV_CODEC_ID_BINKVIDEO: maxpixels /= 32; break;
 135     case AV_CODEC_ID_DIRAC:     maxpixels /= 8192; break;
 136     case AV_CODEC_ID_MSRLE:     maxpixels /= 16;  break;
 137     case AV_CODEC_ID_QTRLE:     maxpixels /= 16;  break;
 138     case AV_CODEC_ID_SANM:      maxpixels /= 16;  break;
 139     case AV_CODEC_ID_GIF:       maxpixels /= 16;  break;
 140         // Performs slow frame rescaling in C
 141     case AV_CODEC_ID_GDV:       maxpixels /= 512; break;
 142         // Postprocessing in C
 143     case AV_CODEC_ID_HNM4_VIDEO:maxpixels /= 128; break;
 144         // Cliping in C, generally slow even with small input
 145     case AV_CODEC_ID_INDEO4:    maxpixels /= 128; break;
 146     case AV_CODEC_ID_LSCR:        maxpixels /= 16; break;
 147     case AV_CODEC_ID_MOTIONPIXELS:maxpixels /= 256; break;
 148     case AV_CODEC_ID_MSS2:        maxpixels /= 16384; break;
 149     case AV_CODEC_ID_SNOW:        maxpixels /= 128; break;
 150     case AV_CODEC_ID_TRUEMOTION2: maxpixels /= 1024; break;
 151     }
 152
 153
 154     AVCodecContext* ctx = avcodec_alloc_context3(c);
 155     AVCodecContext* parser_avctx = avcodec_alloc_context3(NULL);
 156     if (!ctx || !parser_avctx)
 157         error("Failed memory allocation");
 158
 159     if (ctx->max_pixels == 0 || ctx->max_pixels > maxpixels_per_frame)
 160         ctx->max_pixels = maxpixels_per_frame; //To reduce false positive OOM and hangs
 161     ctx->refcounted_frames = 1; //To reduce false positive timeouts and focus testing on the refcounted API
 162
 163     if (size > 1024) {
 164         GetByteContext gbc;
 165         int extradata_size;
 166         size -= 1024;
 167         bytestream2_init(&gbc, data + size, 1024);
 168         ctx->width                              = bytestream2_get_le32(&gbc);
 169         ctx->height                             = bytestream2_get_le32(&gbc);
 170         ctx->bit_rate                           = bytestream2_get_le64(&gbc);
 171         ctx->bits_per_coded_sample              = bytestream2_get_le32(&gbc);
 172         // Try to initialize a parser for this codec, note, this may fail which just means we test without one
 173         if (bytestream2_get_byte(&gbc) & 1)
 174             parser = av_parser_init(c->id);
 175
 176         extradata_size = bytestream2_get_le32(&gbc);
 177
 178         ctx->sample_rate                        = bytestream2_get_le32(&gbc);
 179         ctx->channels                           = (unsigned)bytestream2_get_le32(&gbc) % FF_SANE_NB_CHANNELS;
 180
 181         if (extradata_size < size) {
 182             ctx->extradata = av_mallocz(extradata_size + AV_INPUT_BUFFER_PADDING_SIZE);
 183             if (ctx->extradata) {
 184                 ctx->extradata_size = extradata_size;
 185                 size -= ctx->extradata_size;
 186                 memcpy(ctx->extradata, data + size, ctx->extradata_size);
 187             }
 188         }
 189         if (av_image_check_size(ctx->width, ctx->height, 0, ctx))
 190             ctx->width = ctx->height = 0;
 191     }
 192
 193     int res = avcodec_open2(ctx, c, NULL);
 194     if (res < 0) {
 195         avcodec_free_context(&ctx);
 196         av_free(parser_avctx);
 197         av_parser_close(parser);
 198         return 0; // Failure of avcodec_open2() does not imply that a issue was found
 199     }
 200     parser_avctx->codec_id = ctx->codec_id;
 201
 202     int got_frame;
 203     AVFrame *frame = av_frame_alloc();
 204     if (!frame)
 205         error("Failed memory allocation");
 206
 207     // Read very simple container
 208     AVPacket avpkt, parsepkt;
 209     av_init_packet(&avpkt);
 210     av_init_packet(&parsepkt);
 211     while (data < end && it < maxiteration) {
 212         // Search for the TAG
 213         while (data + sizeof(fuzz_tag) < end) {
 214             if (data[0] == (fuzz_tag & 0xFF) && AV_RN64(data) == fuzz_tag)
 215                 break;
 216             data++;
 217         }
 218         if (data + sizeof(fuzz_tag) > end)
 219             data = end;
 220
 221         res = av_new_packet(&parsepkt, data - last);
 222         if (res < 0)
 223             error("Failed memory allocation");
 224         memcpy(parsepkt.data, last, data - last);
 225         data += sizeof(fuzz_tag);
 226         last = data;
 227
 228         while (parsepkt.size > 0) {
 229
 230             if (parser) {
 231                 av_init_packet(&avpkt);
 232                 int ret = av_parser_parse2(parser, parser_avctx, &avpkt.data, &avpkt.size,
 233                                            parsepkt.data, parsepkt.size,
 234                                            parsepkt.pts, parsepkt.dts, parsepkt.pos);
 235                 if (avpkt.data == parsepkt.data) {
 236                     avpkt.buf = av_buffer_ref(parsepkt.buf);
 237                     if (!avpkt.buf)
 238                         error("Failed memory allocation");
 239                 } else {
 240                     if (av_packet_make_refcounted(&avpkt) < 0)
 241                         error("Failed memory allocation");
 242                 }
 243                 parsepkt.data += ret;
 244                 parsepkt.size -= ret;
 245                 parsepkt.pos  += ret;
 246                 avpkt.pts = parser->pts;
 247                 avpkt.dts = parser->dts;
 248                 avpkt.pos = parser->pos;
 249                 if ( parser->key_frame == 1 ||
 250                     (parser->key_frame == -1 && parser->pict_type == AV_PICTURE_TYPE_I))
 251                     avpkt.flags |= AV_PKT_FLAG_KEY;
 252                 avpkt.flags |= parsepkt.flags & AV_PKT_FLAG_DISCARD;
 253             } else {
 254                 av_packet_move_ref(&avpkt, &parsepkt);
 255             }
 256
 257           // Iterate through all data
 258           while (avpkt.size > 0 && it++ < maxiteration) {
 259             av_frame_unref(frame);
 260             int ret = decode_handler(ctx, frame, &got_frame, &avpkt);
 261
 262             ec_pixels += ctx->width * ctx->height;
 263             if (it > 20 || ec_pixels > 4 * ctx->max_pixels)
 264                 ctx->error_concealment = 0;
 265             if (ec_pixels > maxpixels)
 266                 goto maximums_reached;
 267
 268             if (ret <= 0 || ret > avpkt.size)
 269                break;
 270             if (ctx->codec_type != AVMEDIA_TYPE_AUDIO)
 271                 ret = avpkt.size;
 272             avpkt.data += ret;
 273             avpkt.size -= ret;
 274           }
 275           av_packet_unref(&avpkt);
 276         }
 277         av_packet_unref(&parsepkt);
 278     }
 279 maximums_reached:
 280
 281     av_packet_unref(&avpkt);
 282
 283     do {
 284         got_frame = 0;
 285         av_frame_unref(frame);
 286         decode_handler(ctx, frame, &got_frame, &avpkt);
 287     } while (got_frame == 1 && it++ < maxiteration);
 288
 289     fprintf(stderr, "pixels decoded: %"PRId64", iterations: %d\n", ec_pixels, it);
 290
 291     av_frame_free(&frame);
 292     avcodec_free_context(&ctx);
 293     avcodec_free_context(&parser_avctx);
 294     av_parser_close(parser);
 295     av_packet_unref(&parsepkt);
 296     return 0;
 297 }