Merge "Added gsm_enc_fuzzer"
diff --git a/fuzzer/Android.bp b/fuzzer/Android.bp
index 6f9a3ba..3668a6f 100644
--- a/fuzzer/Android.bp
+++ b/fuzzer/Android.bp
@@ -18,12 +18,9 @@
* Originally developed and contributed by Ittiam Systems Pvt. Ltd, Bangalore
*/
-cc_fuzz {
- name: "gsm_dec_fuzzer",
+cc_defaults {
+ name: "gsm_fuzzer_defaults",
host_supported: true,
- srcs: [
- "gsm_dec_fuzzer.cpp",
- ],
static_libs: [
"libgsm",
],
@@ -34,3 +31,19 @@
componentid: 155276,
},
}
+
+cc_fuzz {
+ name: "gsm_dec_fuzzer",
+ defaults: ["gsm_fuzzer_defaults"],
+ srcs: [
+ "gsm_dec_fuzzer.cpp",
+ ],
+}
+
+cc_fuzz {
+ name: "gsm_enc_fuzzer",
+ defaults: ["gsm_fuzzer_defaults"],
+ srcs: [
+ "gsm_enc_fuzzer.cpp",
+ ],
+}
diff --git a/fuzzer/README.md b/fuzzer/README.md
index caecb05..2c3f35f 100644
--- a/fuzzer/README.md
+++ b/fuzzer/README.md
@@ -1,4 +1,4 @@
-# Fuzzer for libgsm decoder
+# Fuzzer for libgsm codec
## Plugin Design Considerations
The fuzzer plugin for GSM is designed based on the understanding of the
@@ -11,22 +11,34 @@
GSM supports the following options:
1. Verbosity (parameter name: `GSM_VERBOSE`)
2. Fastness (parameter name: `GSM_OPT_FAST`)
+3. WAV49 Format (parameter name: `GSM_OPT_WAV49`)
+4. LTP Cut speed-up (encoder only) (parameter name: `GSM_OPT_LTP_CUT`)
| Parameter| Valid Values| Configured Value|
|------------- |-------------| ----- |
| `GSM_VERBOSE` | 0. `Verbosity disabled` 1. `Verbosity enabled` | Bit 0 (LSB) of 1st byte of data. |
| `GSM_OPT_FAST` | 0. `Regular algorithm will be used` 1. `Faster version of the algorithm will be used` | Bit 1 (LSB) of 1st byte of data. |
+| `GSM_OPT_LTP_CUT` | 0. `Disable LTP cut-off optimization` 1. `Enable LTP cut-off optimization` | Bit 2 (LSB) of 1st byte of data. |
+| `GSM_OPT_WAV49` | 0. `Disable WAV49 output in the encoder.` 1. `Enable WAV49 format in the encoder.` | Bit 3 (LSB) of 1st byte of data. |
This also ensures that the plugin is always deterministic for any given input.
##### Maximize utilization of input data
The plugin feeds the entire input data to the codec using a loop.
+###### For the Decoder:
* If the size of media file is less than 65 bytes, (65 - size) bytes are padded and then sent to
the decoder so that decode happens for all the input files, regardless of their size.
GSM decoder consumes alternating frames of 33 and 32 bytes, so 65 bytes of input are needed.
* If the decode operation was successful, the input is advanced by the frame size
* If the decode operation was un-successful, the input is still advanced by frame size so
that the fuzzer can proceed to feed the next frame.
+###### For the Encoder:
+ * If the size of media file is less than 320 bytes(160 signed 16-bit words), bytes are padded and then sent to
+ the encoder so that encode happens for all the input files, regardless of their size.
+ GSM encoder consumes 160 signed 16-bit words, so 320 bytes of input are needed.
+ * If the encode operation was successful, the input is advanced by the frame size
+ * If the encode operation was un-successful, the input is still advanced by frame size so
+that the fuzzer can proceed to feed the next frame.
This ensures that the plugin tolerates any kind of input (empty, huge,
malformed, etc) and doesnt `exit()` on any input and thereby increasing the
@@ -34,7 +46,7 @@
## Build
-This describes steps to build gsm_dec_fuzzer binary.
+This describes steps to build gsm_dec_fuzzer and gsm_enc_fuzzer binaries.
### Android
@@ -42,20 +54,23 @@
Build the fuzzer
```
$ mm -j$(nproc) gsm_dec_fuzzer
+ $ mm -j$(nproc) gsm_enc_fuzzer
```
#### Steps to run
-Create a directory CORPUS_DIR and copy some gsm files to that folder
+Create a directory CORPUS_DIR and copy some gsm files (decoder)/raw files (encoder) to that folder
Push this directory to device.
To run on device
```
$ adb sync data
$ adb shell /data/fuzz/arm64/gsm_dec_fuzzer/gsm_dec_fuzzer CORPUS_DIR
+ $ adb shell /data/fuzz/arm64/gsm_enc_fuzzer/gsm_enc_fuzzer CORPUS_DIR
```
To run on host
```
$ $ANDROID_HOST_OUT/fuzz/x86_64/gsm_dec_fuzzer/gsm_dec_fuzzer CORPUS_DIR
+ $ $ANDROID_HOST_OUT/fuzz/x86_64/gsm_enc_fuzzer/gsm_enc_fuzzer CORPUS_DIR
```
## References:
diff --git a/fuzzer/gsm_enc_fuzzer.cpp b/fuzzer/gsm_enc_fuzzer.cpp
new file mode 100644
index 0000000..3e00f85
--- /dev/null
+++ b/fuzzer/gsm_enc_fuzzer.cpp
@@ -0,0 +1,96 @@
+/******************************************************************************
+ *
+ * Copyright (C) 2020 The Android Open Source Project
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at:
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ *****************************************************************************
+ * Originally developed and contributed by Ittiam Systems Pvt. Ltd, Bangalore
+ */
+#include <stdint.h>
+#include <string.h>
+#include <algorithm>
+
+#include "gsm.h"
+
+constexpr size_t kGsmInNumSamples = 160;
+constexpr size_t kGsmInBufferSize = kGsmInNumSamples * sizeof(gsm_signal);
+
+enum { IDX_VERBOSITY, IDX_FAST, IDX_LTP_CUT, IDX_WAV49, IDX_LAST };
+
+class Codec {
+ public:
+ Codec() = default;
+ ~Codec() { deInitEncoder(); }
+ bool initEncoder();
+ void encodeFrames(uint8_t *data, size_t size);
+ void deInitEncoder();
+
+ private:
+ gsm mGsm = nullptr;
+};
+
+bool Codec::initEncoder() {
+ mGsm = gsm_create();
+ return mGsm ? true : false;
+}
+
+void Codec::encodeFrames(uint8_t *data, size_t size) {
+ int32_t verbosity = data[IDX_VERBOSITY] & 0x01;
+ int32_t fast = data[IDX_FAST] & 0x01;
+ int32_t ltp_cut = data[IDX_LTP_CUT] & 0x01;
+ int32_t wav49 = data[IDX_WAV49] & 0x01;
+ gsm_option(mGsm, GSM_OPT_VERBOSE, &verbosity);
+ gsm_option(mGsm, GSM_OPT_FAST, &fast);
+ gsm_option(mGsm, GSM_OPT_LTP_CUT, <p_cut);
+ gsm_option(mGsm, GSM_OPT_WAV49, &wav49);
+ data += IDX_LAST;
+ size -= IDX_LAST;
+
+ while (size > 0) {
+ gsm_signal tmpData[kGsmInNumSamples];
+ gsm_frame out;
+ size_t frameSize = std::min(size, kGsmInBufferSize);
+
+ memcpy(tmpData, data, frameSize);
+ if (frameSize < kGsmInBufferSize) {
+ memset(reinterpret_cast<uint8_t *>(tmpData) + frameSize, data[0],
+ kGsmInBufferSize - frameSize);
+ }
+ gsm_encode(mGsm, tmpData, out);
+ data += frameSize;
+ size -= frameSize;
+ }
+}
+
+void Codec::deInitEncoder() {
+ if (mGsm) {
+ gsm_destroy(mGsm);
+ mGsm = nullptr;
+ }
+}
+
+extern "C" int LLVMFuzzerTestOneInput(const uint8_t *data, size_t size) {
+ if (size < IDX_LAST) {
+ return 0;
+ }
+ Codec *codec = new Codec();
+ if (!codec) {
+ return 0;
+ }
+ if (codec->initEncoder()) {
+ codec->encodeFrames(const_cast<uint8_t *>(data), size);
+ }
+ delete codec;
+ return 0;
+}
