Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/r4gus/ccdb

CBOR Credential Database Format
https://github.com/r4gus/ccdb

credential-manager credential-store passkey password password-database zig zig-package

Last synced: about 1 month ago
JSON representation

CBOR Credential Database Format

Awesome Lists containing this project

README

        

# CBOR Credential Database Format

This document describes a format to store secrets at rest based on the CBOR data format. It is designed as an alternative to other file formats like KDBX used with KeePass and KeePassXC.

## Source Code

### Installation

> Requires Zig version 0.13.0

#### Module

The `ccdb` module can be added to your projects by adding `ccdb` to your list of dependencies in `build.zig.zon`.

```zig
.dependencies = .{
//...
.ccdb = .{
.url = "https://github.com/r4gus/ccdb/archive/refs/tags/0.1.0.tar.gz",
// Adjust the hash if you use another version!
.hash = "12202413b8cfe91ea51f3680b8eaa5645870a6e3fabc5cb9076c80f8182ea1d4028f",
},
},
```

You can then import the module within your `build.zig`.

```zig
const ccdb_dep = b.dependency("ccdb", .{
.target = target,
.optimize = optimize,
});

// Create a exe or library and then...
exe.root_module.addImport("ccdb", ccdb_dep.module("ccdb"));
```

#### Command Line Tool

You can manage a CCDB database from the command line using `ccdbcmd`. Run `build zig -Doptimize=ReleaseSmall`
to build the executable.

## Documentation

You can build the documentation by running `bikeshed` within the `/docs` folder.