Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/abumq/mine
Minimal and single-header cryptography library (AES, RSA, Base16, Base64, ZLib), implemented for education purposes - use @abumq/ripe for production.
https://github.com/abumq/mine
aes-128 aes-192 aes-256 aes-cbc aes-ecb base16 base64 cryptography rsa zlib
Last synced: about 2 months ago
JSON representation
Minimal and single-header cryptography library (AES, RSA, Base16, Base64, ZLib), implemented for education purposes - use @abumq/ripe for production.
- Host: GitHub
- URL: https://github.com/abumq/mine
- Owner: abumq
- License: other
- Created: 2017-08-20T10:56:22.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-04-05T22:29:35.000Z (10 months ago)
- Last Synced: 2024-12-03T00:03:13.120Z (about 2 months ago)
- Topics: aes-128, aes-192, aes-256, aes-cbc, aes-ecb, base16, base64, cryptography, rsa, zlib
- Language: C++
- Homepage:
- Size: 463 KB
- Stars: 92
- Watchers: 9
- Forks: 20
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
﷽
Minimal and single-header cryptography library (AES, RSA, Base16, Base64, ZLib)
Mine is fast, memory-efficient, single-header minimal cryptography implementation for small-medium projects that cannot afford to link to external libraries.
# Overview
It all started with [ripe](https://github.com/abumq/ripe) that depends on third-party library (initially OpenSSL then Crypto++) linked statically. However after deploying [residue](https://github.com/abumq/residue) with ripe to older distributions of linux, we learnt that portability is an issue for ripe as _minimal_ library (because of it's dependencies). So we started to implement standards forming _Mine_.
I was very careful with my implementations and have over 50 [test cases](/test/) in-place.
# Installation (API)
Simply copy `mine.h` and `mine.cc` from [`package/`](/package/) directory to your project or your local machine.
Alternatively, feel free to link it as shared or static library (you will need to compile yourself)
# Installation (CLI Tool)
You can either download binary for your platform via [releases](https://github.com/abumq/mine/releases) page or using NPM
```
npm install -g mine-linux@latest
sudo ln -s `which mine-linux` /usr/local/bin/mine
```
```
npm install -g mine-darwin@latest
sudo ln -s `which mine-darwin` /usr/local/bin/mine
```
# Features
Mine supports following features:
* Base16 Encoding
* Base64 Encoding
* RSA [[RFC-3447](https://tools.ietf.org/html/rfc3447)]
* AES [[FIPS Pub. 197](http://nvlpubs.nist.gov/nistpubs/FIPS/NIST.FIPS.197.pdf)]
* ZLib (Depends upon libz)
This is what we are aiming for _minimal_ crypto library.
# Notes
* It is natively developed on macOS and Linux operating systems
* It is fast with compiler optimization level 1 (or higher)
* You need to implement BigNumber to use RSA, for unit tests we use [Integer from Crypto++](https://www.cryptopp.com/wiki/Integer)
* RSA currently does not support signing & verification or reading keys from PEM files
# Quick Reference
### Base16
* `mine::Base16::encode(str);`
* `mine::Base16::encode(str.begin(), str.end());`
* `mine::Base16::decode(encoding);`
### Base64
* `mine::Base64::encode(str);`
* `mine::Base64::encode(str.begin(), str.end());`
* `mine::Base64::decode(encoding);`
* `mine::Base64::decode(encoding.begin(), encoding.end());`
* `mine::Base64::expectedLength(n);`
### AES
```c++
std::string random256BitKey = mine::AES::generateRandomKey(256);
mine::AES aesManager;
aesManager.encrypt(b16Input, hexKey, mine::MineCommon::Encoding::Base16, mine::MineCommon::Encoding::Base64); // takes base16, encrypts and returns base64
aesManager.setKey(random256BitKey); // now use this key
aesManager.encr(b16Input, mine::MineCommon::Encoding::Base16, mine::MineCommon::Encoding::Base64); // don't need key with requests
aesManager.decr(b64Input, mine::MineCommon::Encoding::Base64, mine::MineCommon::Encoding::Raw); // Returns raw string
```
### ZLib
* `mine::ZLib::compressString(str);`
* `mine::ZLib::decompressString(str);`
* `mine::ZLib::decompressFile(outputFile, inputFile);`
# Contribution
You can contribute to the project by testing on various platforms (e.g, Windows, Android etc)
# License
```
Copyright 2017-present @abumq (Majid Q.)
https://github.com/abumq/mine
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.
```
[banner]: https://raw.githubusercontent.com/abumq/mine/master/mine.png