https://github.com/r4gus/kdbx

This Zig module allows you to integrate KDBX support into your application.
https://github.com/r4gus/kdbx

kdbx kdbx-database kdbx-files keepass zig ziglang

Last synced: 23 days ago
JSON representation

This Zig module allows you to integrate KDBX support into your application.

• Host: GitHub
• URL: https://github.com/r4gus/kdbx
• Owner: r4gus
• Created: 2024-11-02T22:14:43.000Z (3 months ago)
• Default Branch: master
• Last Pushed: 2025-01-19T09:30:47.000Z (26 days ago)
• Last Synced: 2025-01-19T10:28:49.639Z (26 days ago)
• Topics: kdbx, kdbx-database, kdbx-files, keepass, zig, ziglang
• Language: Zig
• Homepage:
• Size: 1.71 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# KDBX - Keepass Database XML

This Zig module allows you to integrate KDBX support into your application.

> Currently only KDBX4 is supported.

## Getting Started

First add this project as a dependency to your `build.zig.zon` file:

```zig

.{

    // ...

    .dependencies = .{

        // ...

        .kdbx = .{

            .url = "https://github.com/r4gus/kdbx/archive/master.tar.gz",

            .hash = ,

        }

    },

    // ...

}

```

Then, within your `build.zig` add the following code:

```zig

const kdbx_dep = b.dependency("kdbx", .{

    .target = target,

    .optimize = optimize,

});

const kdbx_module = zbor_dep.module("kdbx");

// ...

exe.root_module.addImport("kdbx", kdbx_module);

```

Then within your project just use `@import("kdbx")`.

## Reading and writing databases

> When saving, the inner XML data structure is generated from

> the Zig objects that represent the database, i.e., unsupported

> fields are lost when reading and then writing a existing database.

>

> If in doubt, backup your database!

>

> Feel free to open pull requests for missing features.

```zig

const std = @import("std");

const kdbx = @import("kdbx");

var gpa = std.heap.GeneralPurposeAllocator(.{}){};

const allocator = gpa.allocator();

pub fn main() !void {

    var database = try kdbx.Database.new(.{

        .allocator = allocator,

    });

    defer database.deinit();

    var entry1 = kdbx.Entry.new(allocator);

    try entry1.set("Title", "Demo Entry", false);

    try entry1.set("UserName", "max", false);

    try entry1.set("Password", "supersecret", true);

    errdefer entry1.deinit();

    try database.body.root.addEntry(entry1);

    const db_key = kdbx.DatabaseKey{

        .password = try allocator.dupe(u8, "1234"),

        .allocator = allocator,

    };

    defer db_key.deinit();

    const raw = try database.save(

        db_key,

        allocator,

    );

    defer allocator.free(raw);

    var file = try std.fs.cwd().createFile("db.kdbx", .{});

    defer file.close();

    try file.writeAll(raw);

}

```

> Also see `main.zig` for an example.