Skip to content

Commit

Permalink
afl doc
Browse files Browse the repository at this point in the history
  • Loading branch information
siara-cc authored and Arundale Ramanathan committed Aug 19, 2022
1 parent 97e2c1c commit 6e07f9d
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Unishox: A hybrid encoder for Short Unicode Strings

[![C/C++ CI](https://github.com/siara-cc/Unishox/actions/workflows/c-cpp.yml/badge.svg)](https://github.com/siara-cc/Unishox/actions/workflows/c-cpp.yml) [![DOI](https://joss.theoj.org/papers/10.21105/joss.03919/status.svg)](https://doi.org/10.21105/joss.03919)
[![npm ver](https://img.shields.io/npm/v/unishox2.siara.cc)](https://www.npmjs.com/package/unishox2.siara.cc)
[![afl](https://img.shields.io/badge/afl%20crashes%2Fhangs-0-green)](https://github.com/siara-cc/Unishox/afl-fuzz)

In general compression utilities such as `zip`, `gzip` do not compress short strings well and often expand them. They also use lots of memory which makes them unusable in constrained environments like Arduino. So Unishox algorithm was developed for individually compressing (and decompressing) short strings.

Expand Down
5 changes: 5 additions & 0 deletions afl_fuzz/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Hardening against crashes / hangs

The decompression API has been hardened against crashes / hangs occuring due to malicious data fed from untrusted sources.

Please see [afl website](https://lcamtuf.coredump.cx/afl/) for more information.

0 comments on commit 6e07f9d

Please sign in to comment.