Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sorairolake/abcrypt-zig
A simple, modern and secure file encryption library for Zig
https://github.com/sorairolake/abcrypt-zig
abcrypt abcrypt-encryption argon2 argon2id blake2 blake2b chacha20 chacha20-poly1305 encryption poly1305 xchacha20 xchacha20-poly1305 zig zig-library zig-package ziglang
Last synced: 7 days ago
JSON representation
A simple, modern and secure file encryption library for Zig
- Host: GitHub
- URL: https://github.com/sorairolake/abcrypt-zig
- Owner: sorairolake
- Created: 2024-12-13T15:56:54.000Z (2 months ago)
- Default Branch: develop
- Last Pushed: 2025-01-26T04:13:36.000Z (19 days ago)
- Last Synced: 2025-01-26T05:18:33.744Z (19 days ago)
- Topics: abcrypt, abcrypt-encryption, argon2, argon2id, blake2, blake2b, chacha20, chacha20-poly1305, encryption, poly1305, xchacha20, xchacha20-poly1305, zig, zig-library, zig-package, ziglang
- Language: Zig
- Homepage:
- Size: 51.8 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.adoc
- Contributing: CONTRIBUTING.adoc
- License: LICENSES/Apache-2.0.txt
- Code of conduct: CODE_OF_CONDUCT.md
- Authors: AUTHORS.adoc
Awesome Lists containing this project
README
# abcrypt-zig
[![CI][ci-badge]][ci-url]
**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`:
```sh
zig fetch --save git+https://github.com/sorairolake/abcrypt-zig.git
```
Add the following to your `build.zig`:
```zig
const abcrypt = b.dependency("abcrypt", .{});
exe.root_module.addImport("abcrypt", abcrypt.module("abcrypt"));
```
### Documentation
To build the documentation:
```sh
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:
```sh
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.13.0.
## Source code
The upstream repository is available at
.
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.2 of the [_REUSE Specification_]. See
copyright notices of individual files for more details on copyright and
licensing information.
[ci-badge]: https://img.shields.io/github/actions/workflow/status/sorairolake/abcrypt-zig/CI.yaml?branch=develop&style=for-the-badge&logo=github&label=CI
[ci-url]: https://github.com/sorairolake/abcrypt-zig/actions?query=branch%3Adevelop+workflow%3ACI++
[abcrypt encrypted data format]: https://sorairolake.github.io/abcrypt/book/format.html
[CHANGELOG.adoc]: CHANGELOG.adoc
[CONTRIBUTING.adoc]: CONTRIBUTING.adoc
[AUTHORS.adoc]: AUTHORS.adoc
[_REUSE Specification_]: https://reuse.software/spec/