Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/chmoder/data_vault
Data Vault is a modular, pragmatic, credit card vault for Rust.
https://github.com/chmoder/data_vault
aes-128-cbc aes-gcm-siv async blake3 credit-cards data-vault pci-dss redis rust
Last synced: 13 days ago
JSON representation
Data Vault is a modular, pragmatic, credit card vault for Rust.
- Host: GitHub
- URL: https://github.com/chmoder/data_vault
- Owner: chmoder
- License: mit
- Created: 2020-08-02T16:26:26.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-06-27T12:56:00.000Z (over 3 years ago)
- Last Synced: 2024-08-10T19:04:29.916Z (3 months ago)
- Topics: aes-128-cbc, aes-gcm-siv, async, blake3, credit-cards, data-vault, pci-dss, redis, rust
- Language: Rust
- Homepage:
- Size: 136 KB
- Stars: 8
- Watchers: 3
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Data Vault
Data Vault is a library for storing and retrieving Credit Card data via Tokens.
[](https://github.com/chmoder/data_vault/actions)
[](https://codecov.io/gh/chmoder/data_vault)
[](https://crates.io/crates/data_vault)
[](https://docs.rs/data_vault)
[](https://img.shields.io/crates/l/data_vault.svg)
[](https://criterion.dev/)
```toml
# Cargo.toml
[dependencies]
data_vault = "^0.3"
```
```dotenv
# Note: showing Redis and Postgres backend settings
# REDIS CONFIGURATION
REDIS_URL=redis://:[email protected]/
# REDIS_POOL_MAX_SIZE=16
# POSTGRES CONFIGURATION
POSTGRES.HOST=127.0.0.1
POSTGRES.USER=data_vault
POSTGRES.PASSWORD=foobared
POSTGRES.DBNAME=data_vault
POSTGRES.POOL.MAX_SIZE=100000
POSTGRES.POOLTIMEOUTS_WAIT_SECS=60
POSTGRES.POOL.TIMEOUTS_WAIT_NANOS=0
# ENCRYPTION KEYS
ENCRYPTED_DATA_VAULT_KEY=000102030405060708090a0b0c0d0e0f
ENCRYPTED_DATA_VAULT_IV=f0f1f2f3f4f5f6f7f8f9fafbfcfdfeff
```
```rust
// example.rs
// traits
use data_vault::DataVault;
use data_vault::encryption::traits::Encryption;
// Interchangeable backend
use data_vault::RedisDataVault;
// Interchangeable encryption
use data_vault::encryption::AesGcmSivEncryption;
// Interchangeable tokenizer
use data_vault::tokenizer::Blake3Tokenizer;
// credit card type
use credit_card::CreditCard;
use tokio;
#[tokio::main(flavor = "multi_thread")]
async fn main() {
let vault = RedisDataVault::::new().unwrap();
let cc = CreditCard {
number: "4111111111111111".to_string(),
cardholder_name: "Graydon Hoare".to_string(),
expiration_month: "01".to_string(),
expiration_year: "2023".to_string(),
brand: None,
security_code: None
};
let token = vault.store_credit_card(&cc).await.unwrap();
let credit_card = vault.retrieve_credit_card(&token.to_string()).await.unwrap();
assert_eq!(credit_card.number, cc.number)
}
```
# Current Features
- Store [Credit Cards](https://github.com/chmoder/credit_card)
- Store `String`
- Automatic Encryption and Decryption
- Blake3 tokenization
- Redis pool
- Postgres pool
- Configurable from .env file or Environment Variables
- Interchangeable Backend
- Interchangeable Encryption
- Interchangeable Tokenization hasher
# Performance (AMD Ryzen 9 3900X)
## Redis
This [example](https://github.com/chmoder/data_vault/blob/master/examples/redis_benchmark.rs) output the following performance stats
Tokenize and stored **~18,000** credit cards per second.
```
tokenized and stored 100000 credit cards in 5.550836728s
retrieved 100000 credit cards in 5.8276298s
tokenized, stored, and retrieved 100000 credit cards in 11.378466528s
```
## Postgres
This [example](https://github.com/chmoder/data_vault/blob/master/examples/postgres_benchmark.rs) output the following performance stats
Tokenize and Store **~3,000** credit cards per second.
```
tokenized and stored 1000 credit cards in 336.54986ms
retrieved 1000 credit cards in 54.622188ms
tokenized, stored, and retrieved 1000 credit cards in 391.172048ms
```