Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/sorairolake/abcrypt

A simple, modern and secure file encryption tool, file format and Rust library
https://github.com/sorairolake/abcrypt

abcrypt abcrypt-encryption argon2 argon2id blake2 blake2b chacha20 chacha20-poly1305 cli command-line command-line-tool encryption poly1305 rust rust-lang rust-library terminal tool xchacha20 xchacha20-poly1305

Last synced: 2 months ago
JSON representation

A simple, modern and secure file encryption tool, file format and Rust library

Awesome Lists containing this project

README 

        
// SPDX-FileCopyrightText: 2023 Shun Sakai

//

// SPDX-License-Identifier: Apache-2.0 OR MIT



= abcrypt

:project-url: https://github.com/sorairolake/abcrypt

:shields-url: https://img.shields.io

:crates-io-url: https://crates.io

:crates-io-crates: {crates-io-url}/crates

:npm-url: https://www.npmjs.com

:npm-package: {npm-url}/package

:pypi-url: https://pypi.org

:pypi-project: {pypi-url}/project

:ci-badge: {shields-url}/github/actions/workflow/status/sorairolake/abcrypt/CI.yaml?branch=develop&style=for-the-badge&logo=github&label=CI

:ci-url: {project-url}/actions?query=branch%3Adevelop+workflow%3ACI++

:abcrypt-repo-url: {project-url}/tree/develop/crates/abcrypt

:abcrypt-badge: {shields-url}/crates/v/abcrypt?style=for-the-badge&logo=rust

:abcrypt-crates-io: {crates-io-crates}/abcrypt

:abcrypt-cli-repo-url: {project-url}/tree/develop/crates/cli

:abcrypt-cli-badge: {shields-url}/crates/v/abcrypt-cli?style=for-the-badge&logo=rust

:abcrypt-cli-crates-io: {crates-io-crates}/abcrypt-cli

:abcrypt-capi-repo-url: {project-url}/tree/develop/crates/capi

:abcrypt-capi-badge: {shields-url}/crates/v/abcrypt-capi?style=for-the-badge&logo=rust

:abcrypt-capi-crates-io: {crates-io-crates}/abcrypt-capi

:abcrypt-wasm-repo-url: {project-url}/tree/develop/crates/wasm

:abcrypt-wasm-badge: {shields-url}/npm/v/%40sorairolake%2Fabcrypt-wasm?style=for-the-badge&logo=npm

:abcrypt-wasm-npm: {npm-package}/@sorairolake/abcrypt-wasm

:abcrypt-py-repo-url: {project-url}/tree/develop/crates/python

:abcrypt-py-badge: {shields-url}/pypi/v/abcrypt-py?style=for-the-badge&logo=pypi

:abcrypt-py-pypi: {pypi-project}/abcrypt-py/

:reuse-spec-url: https://reuse.software/spec/



image:{ci-badge}[CI,link={ci-url}]



*abcrypt* is a simple, modern and secure file encryption tool, file format and

Rust library.



image::crates/cli/assets/screenshot.webp[Screenshot of abcrypt]



== Crates



|===

|Name |Version |Description



|{abcrypt-repo-url}[`abcrypt`]

|image:{abcrypt-badge}[Version,link={abcrypt-crates-io}]

|The abcrypt encrypted data format reference implementation.



|{abcrypt-cli-repo-url}[`abcrypt-cli`]

|image:{abcrypt-cli-badge}[Version,link={abcrypt-cli-crates-io}]

|File encryption tool using the abcrypt encrypted data format.



|{abcrypt-capi-repo-url}[`abcrypt-capi`]

|image:{abcrypt-capi-badge}[Version,link={abcrypt-capi-crates-io}]

|C API for abcrypt.



|{abcrypt-wasm-repo-url}[`abcrypt-wasm`]

|image:{abcrypt-wasm-badge}[Version,link={abcrypt-wasm-npm}]

|Wasm bindings for abcrypt.



|{abcrypt-py-repo-url}[`abcrypt-py`]

|image:{abcrypt-py-badge}[Version,link={abcrypt-py-pypi}]

|Python bindings for abcrypt.

|===



== Format specification



The format specification is at link:docs/spec/FORMAT.adoc[FORMAT.adoc].



== Source code



The upstream repository is available at

https://github.com/sorairolake/abcrypt.git.



.The source code is also available at

* https://gitlab.com/sorairolake/abcrypt.git

* https://codeberg.org/sorairolake/abcrypt.git



== Contributing



Please see link:CONTRIBUTING.adoc[].



== License



Copyright (C) 2022–2024 Shun Sakai (see link:AUTHORS.adoc[])



. Unless otherwise noted, each file is distributed under the terms of either

  the _Apache License 2.0_ or the _MIT License_.

. Each file in the `crates/cli` directory and some other files are distributed

  under the terms of the _GNU General Public License v3.0 or later_.

. Some documents are distributed under the terms of the _Creative Commons

  Attribution 4.0 International Public License_.



This project is compliant with version 3.2 of the

{reuse-spec-url}[_REUSE Specification_]. See copyright notices of individual

files for more details on copyright and licensing information.