Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/protoncr/crypto
Pure Crystal implementations of various Cryptography algorithms
https://github.com/protoncr/crypto
aes-256 aes-cbc aes-ctr aes-encryption aes-ige cryptography crystal crystal-lang telegram
Last synced: about 2 months ago
JSON representation
Pure Crystal implementations of various Cryptography algorithms
- Host: GitHub
- URL: https://github.com/protoncr/crypto
- Owner: protoncr
- License: mit
- Created: 2020-02-22T23:30:24.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-11-16T01:05:24.000Z (about 1 year ago)
- Last Synced: 2024-05-02T02:13:34.274Z (8 months ago)
- Topics: aes-256, aes-cbc, aes-ctr, aes-encryption, aes-ige, cryptography, crystal, crystal-lang, telegram
- Language: Crystal
- Size: 216 KB
- Stars: 9
- Watchers: 4
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Crypto Crystal
Pure Crystal port of [pyrogram/tgcrpto](https://github.com/pyrogram/tgcrpto). Implements various Cryptograpgy algorithms that are especially usefull for Telegram's MTPtoto protocol.
## Installation
1. Add the dependency to your `shard.yml`:
```yaml
dependencies:
crypto:
github: watzon/crypto
```
2. Run `shards install`
## API
```crystal
module Crypto
module AES
def self.create_encryption_key(key : Bytes) : Slice(UInt32)
def self.create_decryption_key(key : Bytes) : Slice(UInt32)
def self.encrypt(data : Bytes, key : Indexable(UInt32)) : Bytes
def self.decrypt(data : Bytes, key : Indexable(UInt32)) : Bytes
end
module CBC
def self.encrypt(data : Bytes, key : Bytes, iv : Bytes) : Bytes
def self.decrypt(data : Bytes, key : Bytes, iv : Bytes) : Bytes
end
module CTR
def self.xcrypt(data : Bytes, key : Bytes, iv : Bytes, state : Bytes = [0_u8]) : Bytes
end
module IGE
def self.encrypt(data : Bytes, key : Bytes, iv : Bytes) : Bytes
def self.decrypt(data : Bytes, key : Bytes, iv : Bytes) : Bytes
end
module Padding
def self.pkcs7(buffer : Bytes, block_size : Int)
end
end
```
## Usage
### IGE Mode
**Note:** Data must be padded to match a multiple of the block size `AES::BLOCK_SIZE`.
```crystal
require "crypto"
random = Random.new
# 10 MB of random data + 7 bytes to show padding
data = random.random_bytes(10 * 1024 * 1024 + 7)
key = random.random_bytes(32) # Random key
iv = random.random_bytes(32) # Random iv
# Pad the data using PKCS7
data = Crypto::Padding.pkcs7(data, Crypto::AES::BLOCK_SIZE)
encrypted = Crypto::IGE.encrypt(data, key, iv)
decrypted = Crypto::IGE.decrypt(encrypted, key, iv)
puts data == decrypted
# => true
```
### CTR Mode
```crystal
require "crypto"
random = Random.new
# 10 MB of random data + 7 bytes to show padding
data = random.random_bytes(10 * 1024 * 1024 + 7)
key = random.random_bytes(32) # Random key
iv = random.random_bytes(16) # Random iv
# Pad the data using PKCS7
data = Crypto::Padding.pkcs7(data, Crypto::AES::BLOCK_SIZE)
encrypted = Crypto::CTR.xcrypt(data, key, iv)
decrypted = Crypto::CTR.xcrypt(encrypted, key, iv)
puts data == decrypted
```
### CBC Mode
**Note:** Data must be padded to match a multiple of the block size `AES::BLOCK_SIZE`.
```crystal
require "crypto"
random = Random.new
# 10 MB of random data + 7 bytes to show padding
data = random.random_bytes(10 * 1024 * 1024 + 7)
key = random.random_bytes(32) # Random key
iv = random.random_bytes(16) # Random iv
# Pad the data using PKCS7
data = Crypto::Padding.pkcs7(data, Crypto::AES::BLOCK_SIZE)
encrypted = Crypto::CBC.encrypt(data, key, iv)
decrypted = Crypto::CBC.decrypt(encrypted, key, iv)
puts data == decrypted
```
## Roadmap
- [ ] Cipher Based
- [ ] AES
- [ ] 128
- [ ] 192
- [x] 256
- [ ] CBC
- [ ] 128
- [ ] 192
- [x] 256
- [ ] CTR
- [ ] 128
- [ ] 192
- [x] 256
- [ ] IGE
- [ ] 128
- [ ] 192
- [x] 256
- [x] Public Key Cryptography
- [x] RSA
- Hashing
- [ ] Blake
- [x] Blake2b
- [ ] Blake2s
- [ ] Blake3
- [ ] Argon2
- [ ] Key Derivation Functions
- [ ] KDF
- [ ] PBKDF2
- [ ] More?
## Contributing
1. Fork it ()
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request
## Contributors
- [Chris Watson](https://github.com/watzon) - creator and maintainer