Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ph4r05/whitebox-crypto-aes

Whitebox AES implementation in C++. Chow, Karroumi.
https://github.com/ph4r05/whitebox-crypto-aes

aes-cipher chow cryptography whitebox whitebox-aes

Last synced: 6 days ago
JSON representation

Whitebox AES implementation in C++. Chow, Karroumi.

Awesome Lists containing this project

README 

        
Whitebox-crypto-AES

===================

![Build Status](https://github.com/ph4r05/Whitebox-crypto-AES/actions/workflows/build.yml/badge.svg)



Whitebox cryptography AES implementation.



This repository contains a C++ implementation of:

 * Complete whitebox [AES]-128 scheme introduced by [Chow] et al [2]. Implements/uses input/output encodings, mixing bijections, external encodings.

 * Complete whitebox [AES]-128 scheme introduced by [Karroumi] [3] which uses an idea of dual AES ciphers (using a different generating polynomial for AES cipher) for creating a stronger AES whitebox scheme.

 * Implementation of the [BGE] Attack on [Chow]'s AES whitebox implementation found by [Billet] et al [4]. Attack uses whitebox AES generator to create a random instance of whitebox AES scheme with secret key K embedded in the implementation. The attack then recovers the secret key K from the tables representing the given instance. This BGE attack also breaks scheme proposed by [Karroumi] what I found out while working on my [diploma] thesis.

 

The implementation contains:

 * Whitebox AES code generator in both [Chow] and [Karroumi] schemes. It generates a randomized whitebox AES instance with embedded encryption key K which can be used either for encryption or for decryption. Instance can be serialized to a file. 

 * Code for running generated whitebox AES instance for encryption/decryption.

 * BGE key recovery attack on a generated whitebox AES instance.

 * Unit tests.

 

You also might be interested in my [Java] implementation of the Chow's whitebox AES scheme.

In my [diploma] thesis I suggest modifications and improvements for a new whitebox-suited symmetric-key encryption algorithm based on AES.



[2]: Stanley Chow, Phil Eisen, Harold Johnson, and Paul C. Van Oorschot. White-box cryptography and an AES implementation. In Proceedings of the Ninth Workshop on Selected Areas in Cryptography (SAC 2002, pages 250–270. Springer-Verlag, 2002.



[3]: Mohamed Karroumi. Protecting white-box AES with dual ciphers. In Proceedings of the 13th international conference on Information security and cryptology, ICISC’10, pages 278–291, Berlin, Heidelberg, 2011. Springer-Verlag. ISBN 978-3-642-24208-3.



[4]: Olivier Billet, Henri Gilbert, and Charaf Ech-Chatbi. Cryptanalysis of a white box AES implementation. In Proceedings of the 11th international conference on Selected Areas in Cryptography, SAC’04, pages 227–240, Berlin, Heidelberg, 2005. Springer-Verlag. ISBN 3-540-24327-5, 978-3-540-24327-4. doi: 10.1007/978-3-540-30564-4_16.



Dependencies

=======

* C++11 and higher

* CMake 3.2+

* [NTL] 11.4+

* boost_iostreams 1.55+

* boost_serialization 1.55+

* boost_program_options 1.55+

* boost_random 1.55+



Description:

* [NTL] math library is used for computation in finite fields & algebra. 

* Boost library for serialization of the scheme instance & program input parameters parsing. Version 1.55



Building

=======

* Travis is configured for the project so in case of any problems please refer to the travis configuration file.

* Install dependencies. For installing NTL you can use provided scripts `install-ntl.sh` or `install-ntl-cached.sh`

* Use cmake to build

```bash

mkdir build-debug

cd build-debug

cmake -DCMAKE_BUILD_TYPE=Debug ..

make

```



Usage

=====



The project contains basic Whitebox AES cipher core - for encrypting / decrypting one single AES block.



In order to demonstrate the basic usage there has been implemented:

 - [PKCS5] padding, so plaintext input does not have to be byte aligned to the length of the AES block. Implemented in `EncTools`.

 - [ECB] encryption mode

 - [CBC] encryption mode



The implementation of the PKCS5, ECB, CBC is for demonstration/academic purposes as it may leak information via

side channels (i.e., timing, memory access patterns)



Note the Padding can be used only if External encodings are not used.

Otherwise the input / output has to be by definition padded to the block size

so the ExtIO encoding can be removed before operation.



The project contains demo BGE attack in the target `./testing`.



There are also some tests implemented using [GTest] in the target `./gtesting`.



The target `./main` contains basic runnable main with few options - allows to use

the WBAES from the command line.



Usage:

```

WBAES table implementation usage:

  -h [ --help ]                   Display this help message

  --bench-gen [=arg(=0)] (=0)     Benchmarking rounds for AES gen

  --bench-bge [=arg(=0)] (=0)     Benchmarking rounds for AES BGE attack

  -e [ --extEnc ] [=arg(=0)] (=0) Use external encoding?

  -o [ --out-file ] arg           Output file to write encrypted data

  --input-files arg               Input files

  --create-table arg              Create encryption/decryption tables

  --create-random [=arg(=0)] (=0) Create tables with random key

  --use-key arg                   Create encryption/decryption with given

                                  hex-coded key

  --use-iv arg                    Use CBC with given hex-coded IV

  --load-tables arg               Loads encryption/decryption tables from given

                                  file

  --decrypt [=arg(=0)] (=0)       Should perform encryption or decryption

  --pkcs5 [=arg(=0)] (=0)         Enables PKCS5 padding

  --cbc [=arg(=0)] (=0)           Uses CBC mode

  -v [ --version ]                Display the version number

```



Example:



```

# Generate new WBAES table, disable extIO

./main --create-table /tmp/aes-table --extEnc=0



# Load existing WBAES tables and encrypt them with CBC and PKCS5

./main --load-tables /tmp/aes-table --extEnc=0 --input-files /tmp/aes-table --pkcs5=1 --cbc=1 -o /tmp/aes-table.enc



# Load existing WBAES tables and decrypt previously encrypted file

./main --load-tables /tmp/aes-table --extEnc=0 --input-files /tmp/aes-table.enc --pkcs5=1 --cbc=1 -o /tmp/aes-table.dec --decrypt=1



# Compare original and dec(enc(original))

diff /tmp/aes-table /tmp/aes-table.dec

```



License

=======

Code is published under license: GPLv3 [http://www.gnu.org/licenses/gpl-3.0.html]. This license holds from the first commit.

I also require to include my copyright header in files if you decide to use my source codes.



Using GPL in short means that if you incorporate this source code to your application, it has to be also published under GPLv3. Also if you make any improvement to my source code and you will use improved version you are obliged to publish improved version as well.



If this license does not fit to you, drop me an email, I am sure we can negotiate somehow.



** UPDATE 31.01.2017 **




[NTL] is now licensed under LGPL v2.1+ so I can relicense the code to LGPL v2.1+ by a written permission.

So the code is by default GPLv3 licensed, but if you drop me an email I will give you LGPL v2.1+ license.

I am also free to talk about other licensing options.



Donating

========



This implementation is an open source. If you like the code or you do find it useful please feel free to donate to the

author whatever amount you would like by clicking on the paypal button below.

And if you don't feel like donating, that's OK too.



[![](https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=XK6RLD768RGGJ&lc=SK&item_name=ph4r05&item_number=Whitebox%2dcrypto%2dAES%2egit&currency_code=EUR&bn=PP%2dDonationsBF%3abtn_donateCC_LG%2egif%3aNonHosted)



Bitcoin:



![1DBr1tfuqv6xphg5rzNTPxqiUbqbRHrM2E](https://deadcode.me/btc-whitebox.png)
1DBr1tfuqv6xphg5rzNTPxqiUbqbRHrM2E



Monero:

```

8BDHew2uRt5N1qgBGe88ZcSwM4wmQfWuAVDWQwJebNg9VYHxbRBgARPd39Ftx61Ss3WmkDCu8FDvR9wJ27aoqBVT1PF5kmE

```



Contributing

=======

If you want to improve my code by extending it to AES-256 or implementing other whitebox AES schemes do not hesitate to submit a pull request. Please also consider it if you find some bug in the code. I am not actively developing this code at the moment but I will review the pull requests. Thanks!



[NTL]: http://www.shoup.net/ntl/

[PKCS5]: https://tools.ietf.org/html/rfc2898

[ECB]: https://en.wikipedia.org/wiki/Block_cipher_mode_of_operation#Electronic_Codebook_(ECB)

[CBC]: https://en.wikipedia.org/wiki/Block_cipher_mode_of_operation#Cipher_Block_Chaining_(CBC)

[GTest]: https://github.com/google/googletest/blob/master/googletest/docs/Primer.md

[AES]: http://csrc.nist.gov/archive/aes/rijndael/Rijndael-ammended.pdf

[Chow]: http://citeseerx.ist.psu.edu/viewdoc/summary?doi=10.1.1.59.7710

[Karroumi]: http://dl.acm.org/citation.cfm?id=2041060

[Billet]: http://bo.blackowl.org/s/papers/waes.pdf

[diploma]: http://is.muni.cz/th/325219/fi_m/thesis.pdf

[Java]: https://github.com/ph4r05/Whitebox-crypto-AES-java