ckeylock-core 0.1.3

Core library for ckeylock.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61

# CKeyLock

CKeyLock is a secure and efficient tool written in Rust for managing and storing your cryptographic keys.

## Features

- **Secure Storage**: Safeguard your cryptographic keys with robust encryption.
- **Rust-Powered**: Built with Rust, ensuring high performance and memory safety.
- **User-Friendly**: Simple and intuitive interface for seamless key management.

## Getting Started

To get started with CKeyLock, follow the instructions below:

1. Install CkeyLock.
    ```bash
    cargo install ckeylock
    ```
2. Create a config with name `Ckeylock.toml`. For example
    ```toml
    bind = "127.0.0.1:8080"
    password = "helloworld"
    dump_path = "dump-clok.bin"
    dump_password = "helloworld"
    ```
4. Run the application:
    ```bash
    ckeylock
    ```

## API

To use CKeyLock in your project follow these steps:
1. Create a new project.
    ```bash
    cargo init
    ```
2. Add API lib.
    ```bash
    cargo add ckeylock-api
    ```
3. Initialize connection.
    ```rust
    let api = CKeyLockAPI::new("127.0.0.1:8080", Some("helloworld"));
    let mut connection = api.connect().await.unwrap();
    ```
4. Use!

## Install via Docker
```bash
docker pull ghcr.io/oblivisheee/ckeylock:v1
```

## Contributing

We welcome contributions! Feel free to submit issues or pull requests to help improve CKeyLock.

## License

CKeyLock is licensed under the [Apache-2.0](LICENSE).