Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kstep/beartamer
https://github.com/kstep/beartamer
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/kstep/beartamer
- Owner: kstep
- Created: 2019-09-27T11:13:42.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-06-21T22:13:26.000Z (over 1 year ago)
- Last Synced: 2024-10-11T23:47:44.857Z (2 months ago)
- Language: Rust
- Size: 132 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# beartamer
## Installation and setup
Install `openssl` library with headers on Linux before build.
Make sure you have a MongoDB instance available.
Configure connection to MongoDB in `config.json` file (see later).
To setup MongoDB instance with Docker, use these commands:
```
docker volume create --name=mongodata
docker run --name mongodb -v mongodata:/data/db -d -p 27017:27017 mongo
```
Run `cargo build -- 0.0.0.0:9000` to build.
Run `cargo run -- 0.0.0.0:9000` to build and run.
If you omit the `0.0.0.0:9000`, the server will run on `127.0.0.1:9000`.
## Endpoints
### Endpoint: `/devices`
Supported methods:
- `GET /devices` - get all known devices as an array.
Data structure:
```json
[
{
"device_id": "string",
"ip_addrs": [
"1.2.3.4",
"5.6.7.8"
]
}
]
```
### Endpoint: `/secrets/:domain?device_id=:device_id`
Supported methods:
- `GET /secrets/:domain` - get by domain name,
- `GET /secrets` - get list of all secrets,
- `PUT /secrets/:domain` or `POST /secrets/:domain` - insert/update secret,
- `DELETE /secrets/:domain` - delete secret by domain name.
Device id is optional. If device id is missing, `"unknown"` string is used instead.
It is strongly recommended to always pass `device_id` in all requests.
Data structure:
```json
{
"domain": "string",
"username": "string",
"password": "string",
"type": "password"
}
```
```json
{
"domain": "string",
"number": "1111222233334444",
"cvc": "123",
"fullname": "Ivan Ivanoff",
"year": 2040,
"month": 12,
"type": "creditcard"
}
```
## Config
Use config file `config.json` to configure MongoDB connection:
```json
{
"host": "localhost",
"port": 27017,
"dbname": "keypass",
"pool_size": 16,
"username": "root",
"password": "passw0rd"
}
```
The `"username"` and `"password"` fields are optional.