rscrypt

rscrypt (scryptenc-cli) is a command-line utility for encrypt and decrypt files using the scrypt encrypted data format.

This is a Rust implementation of scrypt(1).

Installation

From source

cargo install scryptenc-cli

If you want to enable optimizations such as LTO, set them using environment variables.

From binaries

The release page contains pre-built binaries for Linux, macOS and Windows.

How to build

Please see BUILD.adoc.

Usage

Basic usage

Encrypt a file:

rscrypt enc data.txt data.txt.scrypt

Decrypt a file:

rscrypt dec data.txt.scrypt data.txt

Provides information about the encryption parameters

Output as a human-readable string:

rscrypt info data.txt.scrypt

Output:

Parameters used: N = 1024; r = 8; p = 1;
    Decrypting this file requires at least 1 MiB of memory.

Output as JSON:

rscrypt info -j data.txt.scrypt | jq

Output:

{
  "N": 1024,
  "r": 8,
  "p": 1
}

Generate shell completion

--generate-completion option generates shell completions to standard output.

The following shells are supported:

• bash
• elvish
• fish
• nushell
• powershell
• zsh

Example:

rscrypt --generate-completion bash > rscrypt.bash

Command-line options

Please see the following:

• rscrypt(1)
• rscrypt-enc(1)
• rscrypt-dec(1)
• rscrypt-info(1)
• rscrypt-help(1)

Source code

The upstream repository is available at https://github.com/sorairolake/scryptenc-rs.git.

The source code is also available at:

• https://gitlab.com/sorairolake/scryptenc-rs.git
• https://codeberg.org/sorairolake/scryptenc-rs.git

Changelog

Please see CHANGELOG.adoc.

Contributing

Please see CONTRIBUTING.adoc.

Acknowledgment

This program is inspired by the scrypt encryption utility, and built on top of the scryptenc crate.

Home page

https://sorairolake.github.io/scryptenc-rs/

License

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

1. This program is distributed under the terms of the GNU General Public License v3.0 or later.
2. Some files 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 Specification. See copyright notices of individual files for more details on copyright and licensing information.