Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pdcalado/kave
Key and Value simple http API and command line interface
https://github.com/pdcalado/kave
auth0 cli httpapi jwt jwt-claims rbac-authorization redis scopes
Last synced: 7 days ago
JSON representation
Key and Value simple http API and command line interface
- Host: GitHub
- URL: https://github.com/pdcalado/kave
- Owner: pdcalado
- License: mit
- Created: 2023-02-09T20:26:55.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-03-15T18:30:17.000Z (over 1 year ago)
- Last Synced: 2024-09-24T21:05:27.737Z (11 days ago)
- Topics: auth0, cli, httpapi, jwt, jwt-claims, rbac-authorization, redis, scopes
- Language: Go
- Homepage:
- Size: 71.3 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://coveralls.io/github/pdcalado/kave)
[](https://goreportcard.com/report/github.com/pdcalado/kave)
# kave
Kave provides:
1. A server hosting a simple HTTP API for getting and setting key value pairs, backed by Redis.
2. A command line interface to get and set key value pairs through the HTTP API.
3. Authorization middleware with JWT validation and using scopes as permissions.
4. Token acquisition using the cli for M2M applications.
The scheme below depicts basic use of kave (auth was omitted).
```mermaid
sequenceDiagram
participant Kave-Cli
Kave-Server->>Redis: Connect and ping
Kave-Cli->>Kave-Server: GET/POST key values
activate Kave-Server
Kave-Server->>Redis: get/set Redis keys
activate Redis
Redis->>Kave-Server: Redis response
deactivate Redis
Kave-Server->>Kave-Cli: HTTP response
deactivate Kave-Server
```
## Usage
Set up your redis server and fill in a `config.toml`:
```toml
address = "localhost:8000"
redis_address = "localhost:6379"
# defaults
## Base path for routing the requests
# router_base_path = "/redis"
## Prefix on all keys for Redis requests
# redis_key_prefix = "kave:"
## HTTP incomding requests timeout in milliseconds
# timeout_ms = 2000
## Redis username
# redis_username = ""
## Redis password must be set as env variable REDIS_PASSWORD
```
(auth is also disabled by default, check [Auth](#using-auth) for details)
Run the server:
```console
foo@bar:~$ kave-server
```
Make requests using kave-cli:
```console
foo@bar:~$ # initialize profile first (creates a file at ${USER_CONFIG_DIR}/kave/config.toml)
foo@bar:~$ # set --router_base_path if not using the default value in server
foo@bar:~$ kave init --url localhost:8000
foo@bar:~$ # set a key value pair
foo@bar:~$ kave set foo "bar"
foo@bar:~$ # get a key's value
foo@bar:~$ kave get foo
bar
foo@bar:~$ # or curl if you prefer
foo@bar:~$ curl http://localhost:8000/redis/foo
bar
```
## Using auth
This auth setup requires an account in Auth0 with:
1. An API representing kave server
2. An M2M application (or more) representing the client/agents where the cli will be invoked
3. Permission scopes defined in the API and attributed to the M2M applications.
Here are some scope examples:
* `read:foo`: allows GET requests of key `kave:foo`
* `write:bar:*`: allows POST request for any key matching that pattern, such as `kave:bar:qux`
Any regexp pattern as a scope is matched against the operation (get/set) on the key. `read:` prefix allows redis get and `write:` prefix allows redis set.
**To set up auth in the cli** you can run init with:
```console
foo@bar:~$ kave init --url "http://your-kave-server-url.com" --auth0_audience "http://youraudience.com" --auth0_domain "your-domain.eu.auth0.com" --auth0_client_id "qwertyasdfghzxcvb123456" --auth0_client_secret "secretsequencefromauth0"
```
**To set up auth in the server** change `config.toml` to:
```toml
## config.toml
address = "localhost:8000"
redis_address = "localhost:6379"
# defaults
# router_base_path = "/redis"
# redis_key_prefix = "kave:"
[auth]
enabled = true
domain = "your-domain.eu.auth0.com"
```
Start the server as described earlier, then use the cli:
```console
foo@bar:~$ kave set foo "bar"
foo@bar:~$ kave get foo
```
## Build
Clone and run:
```console
foo@bar:~$ make build
```