Skip to content

A simple, modern and secure file encryption library for Zig

License

Apache-2.0, MIT licenses found

Licenses found

Apache-2.0
LICENSE-APACHE
MIT
LICENSE-MIT
Notifications You must be signed in to change notification settings

sorairolake/abcrypt-zig

abcrypt-zig

CI

abcrypt-zig is an implementation of the abcrypt encrypted data format.

This package supports version 1 of the abcrypt format.

Usage

Add this package to your build.zig.zon:

zig fetch --save git+https://github.com/sorairolake/abcrypt-zig.git

Add the following to your build.zig:

const abcrypt = b.dependency("abcrypt", .{});
exe.root_module.addImport("abcrypt", abcrypt.module("abcrypt"));

Documentation

To build the documentation:

zig build doc

The result is generated in zig-out/doc/abcrypt.

If you want to preview this, run a HTTP server locally. For example:

python -m http.server -d zig-out/doc/abcrypt

Then open http://localhost:8000/ in your browser.

Zig version

This library is compatible with Zig version 0.14.0.

Source code

The upstream repository is available at https://github.com/sorairolake/abcrypt-zig.git.

The source code is also available at:

Changelog

Please see CHANGELOG.adoc.

Contributing

Please see CONTRIBUTING.adoc.

License

Copyright (C) 2024 Shun Sakai (see AUTHORS.adoc)

This library is distributed under the terms of either the Apache License 2.0 or the MIT License.

This project is compliant with version 3.3 of the REUSE Specification. See copyright notices of individual files for more details on copyright and licensing information.