Redis and Flatbuffers Integration for Event Handling (#10)

.gitignore

@@ -26,3 +26,4 @@ Cargo.lock
 /etc/contracts/ev/
 /etc/contracts/simple_abac/.idea/
 /apple-app-site-association.json
+/dump.rdb

Cargo.toml

@@ -1,7 +1,8 @@
 [package]
 name = "arkavo-rs"
-version = "0.7.0"
+version = "0.9.0"
 edition = "2021"
+rust-version = "1.80.0"
 
 [lib]
 name = "nanotdf"
@@ -42,6 +43,8 @@ ink = "5.0.0"
 jsonwebtoken = "9.3.0"
 async-nats = "0.36.0"
 serde_json = "1.0.128"
+redis = { version = "0.27.2", features = ["tokio-comp"] }
+flatbuffers = "24.3.25"
 
 [dev-dependencies]
 criterion = "0.5.1"

README.md

@@ -15,9 +15,16 @@ Implementation of KAS from [OpenTDF specification](https://github.com/opentdf/sp
 - Rust (latest stable version)
 - `cargo` package manager
 - NATS
+- Redis
 
 ```bash
-brew install nats-server
+brew install nats-server redis flatbuffers
+```
+
+### Compile Flatbuffers (optional)
+
+```shell
+flatc --binary --rust idl/event.fbs
 ```
 
 ### Installation
@@ -35,14 +42,21 @@ brew install nats-server
    cargo build
    ```
 
+   Release build
+
+   ```shell
+   export RUSTFLAGS="-C target-cpu=native"
+   cargo build --release
+   ```
+
 ### Running the Server
 
 1. Ensure you have a valid EC private key in PEM format named `recipient_private_key.pem`.
 
    ```shell
    openssl ecparam -genkey -name prime256v1 -noout -out recipient_private_key.pem
    ```
-   
+
    Validate
    ```shell
    openssl ec -in recipient_private_key.pem -text -noout
@@ -75,6 +89,7 @@ The server can be configured using environment variables. If not set, default va
 | TLS_CERT_PATH        | Path to the TLS certificate file         | ./fullchain.pem             |
 | TLS_KEY_PATH         | Path to the TLS private key file         | ./privkey.pem               |
 | KAS_KEY_PATH         | Path to the KAS private key file         | ./recipient_private_key.pem |
+| REDIS_URL            | URL for Redis connection                 | redis://localhost:6379      |
 
 All file paths are relative to the current working directory where the server is run.
 
@@ -84,6 +99,7 @@ export TLS_CERT_PATH=/path/to/fullchain.pem
 export TLS_KEY_PATH=/path/to/privkey.pem
 export KAS_KEY_PATH=/path/to/recipient_private_key.pem
 export NATS_URL=nats://localhost:4222
+export REDIS_URL=redis://localhost:6379
 export ENABLE_TIMING_LOGS=true
 export RUST_LOG=info
 ```
@@ -101,6 +117,10 @@ environment variables or secure vaults for managing sensitive information in pro
 nats-server
 ```
 
+```shell
+redis-server
+```
+
 #### Start backend
 
  ```shell
@@ -130,4 +150,4 @@ sequenceDiagram
     Server ->> Server: Compute shared_secret = ECDH(server_private_key, client_public_key)
     Client ->> Client: Compute shared_secret = ECDH(client_private_key, server_public_key)
     Note over Client, Server: Both have the same shared_secret
-```
+```