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: 16 days ago
JSON representation

CBOR Credential Database Format

• Host: GitHub
• URL: https://github.com/r4gus/ccdb
• Owner: r4gus
• Created: 2024-04-29T21:12:39.000Z (10 months ago)
• Default Branch: master
• Last Pushed: 2024-11-01T15:16:37.000Z (3 months ago)
• Last Synced: 2025-01-20T08:06:35.159Z (22 days ago)
• Topics: credential-manager, credential-store, passkey, password, password-database, zig, zig-package
• Language: Zig
• Homepage: https://r4gus.github.io/ccdb/
• Size: 1.2 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

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

Versions:

| Zig version | ccdb version |

|:-----------:|:------------:|

| 0.13.0      | 0.1.0, 0.2.0 |

| 0.14.0      | 0.3.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",

    },

},

```

Alternatively you can use the following command, which will automatically add `ccdb` as an dependency to your `build.zig.zon` file:

```bash

# Replace  with the version you want to use

zig fetch --save https://github.com/r4gus/ccdb/archive/refs/tags/.tar.gz

``` 

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.