crypt4gh

command module
v0.0.0-...-e675987 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 14, 2020 License: MIT Imports: 12 Imported by: 0

README

crypt4gh

Build Status GoDoc CodeFactor Go Report Card codecov Dependabot Status Sourcegraph for Repo Reference Count DeepSource

Overview

File structure

Specification

Current version of specs can be found here.

Installation

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

Go to the releases page and download the binary manually.

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

Documentation

Overview

Package main is the main package of Crypt4GH command-line tool, containing "generate", "encrypt" and "decrypt" commands implementations along with additional helper methods.

Directories

Path Synopsis
Package kdf incorporates three KDFs (https://en.wikipedia.org/wiki/Key_derivation_function) used by Crypt4GH
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.
Package keys holds helper methods to generate/read/convert/write keys for Crypt4GH.
model
body
Package body contains structure and related methods for representing Crypt4GH data segments.
Package body contains structure and related methods for representing Crypt4GH data segments.
headers
Package headers contains structure and related methods for representing Crypt4GH header packets.
Package headers contains structure and related methods for representing Crypt4GH header packets.
Package streaming contains writer and reader implementing Crypt4GH encryption and decryption correspondingly.
Package streaming contains writer and reader implementing Crypt4GH encryption and decryption correspondingly.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL