Categorygithub.com/elixir-oslo/crypt4gh
modulepackage
0.0.2
Repository: https://github.com/elixir-oslo/crypt4gh.git
Documentation: pkg.go.dev

# README

crypt4gh

Build Status GoDoc CodeFactor Go Report Card codecov Dependabot Status

DeepSource

Overview

File structure

Specification

Current version of specs can be found here.

Installation

To install the latest version of the console app you can use the following one-liner (assuming you are using bash):

curl -fsSL https://raw.githubusercontent.com/elixir-oslo/crypt4gh/master/install.sh | sh

Alternatively, go to the releases page and download the desired binary manually (for example, .exe file for Windows).

Usage

$ crypt4gh
crypt4gh [generate | encrypt | decrypt] <args>

 generate:
  -n, --name=                     Key pair name
  -f, --format=[openssl|crypt4gh] Key pair format
  -p, --password=                 Password to lock Crypt4GH private key (will be prompted afterwords if skipped)

 encrypt:
  -f, --file=FILE      File to encrypt
  -s, --seckey=FILE    Secret key to use
  -p, --pubkey=FILE    Public key to use

 decrypt:
  -f, --file=FILE      File to decrypt
  -s, --seckey=FILE    Secret key to use

# Packages

Package kdf incorporates three KDFs (https://en.wikipedia.org/wiki/Key_derivation_function) used by Crypt4GH.
Package keys holds helper methods to generate/read/convert/write keys for Crypt4GH.
No description provided by the author
Package streaming contains writer and reader implementing Crypt4GH encryption and decryption correspondingly.