Skip to content

Latest commit

 

History

History
90 lines (78 loc) · 4.26 KB

README.md

File metadata and controls

90 lines (78 loc) · 4.26 KB
Raw

License: GPLv3 CodeQL

Kryptor

Kryptor is free and open source file encryption and signing software for Windows, Linux, and macOS.

It is a portable, cross-platform command line tool that makes use of modern and secure cryptographic algorithms. It aims to be a better version of age and Minisign to provide a simple, user friendly alternative to GPG.

kryptor

Features

  • Encrypt files/folders with a password, keyfile, or asymmetric keys.
  • Encrypting files using a recipient's public key allows for authenticated, one-way file sharing.
  • Create and verify digital signatures, with support for an authenticated comment and prehashing.
  • Generation of asymmetric key pairs. The private key is encrypted for protection at rest.
  • UNIX style password entry and random passphrase generation.
  • Random keyfile generation. Any type of file can also be used as a keyfile.
  • Encrypt file/folder names.
  • Overwrite input files when encrypting files/folders.

For more information, please go to kryptor.co.uk.

Usage

If you are just getting started, then I recommend reading the tutorial.

Usage: kryptor [options] [file]

Arguments:
  file                   specify a file/folder path

Options:
  -e|--encrypt           encrypt files/folders
  -d|--decrypt           decrypt files/folders
  -p|--password          specify a password (empty for interactive entry)
  -k|--keyfile           specify or randomly generate a keyfile
  -x|--private           specify your private key (unused or empty for default key)
  -y|--public            specify a public key
  -n|--names             encrypt file/folder names
  -o|--overwrite         overwrite files
  -g|--generate          generate a new key pair
  -r|--recover           recover your public key from your private key
  -s|--sign              create a signature
  -c|--comment           add a comment to a signature
  -l|--prehash           sign large files by prehashing
  -v|--verify            verify a signature
  -t|--signature         specify a signature file (unused for default name)
  -u|--update            check for updates
  -a|--about             view the program version and license
  -h|--help              show help information

Examples:
  --encrypt [file]
  --encrypt -p [file]
  --encrypt [-y recipient's public key] [file]
  --decrypt [-y sender's public key] [file]
  --sign [-c comment] [file]
  --verify [-y public key] [file]

Specifying files

When referencing file names/paths that contain spaces, you must surround them with "speech marks":

$ kryptor -e -p "GitHub Logo.png"
$ kryptor -e -p "C:\Users\samuel-lucas6\Downloads\GitHub Logo.png"

Files in the same directory as the kryptor executable can be specified using their file name:

$ kryptor -e -p message.txt

However, files that are not in the same directory as the kryptor executable must be specified using a file path:

$ kryptor -e -p "C:\Users\samuel-lucas6\Documents\message.txt"

Specifying your private key

You can use the -x|--private option without specifying a file path to use your default private key. However, in most cases, this option does not need to be specified. For example, you can perform encryption, decryption, and signing with your default private key as follows:

$ kryptor -e message.txt
$ kryptor -d message.txt.kryptor
$ kryptor -s message.txt

This is the recommended approach, but it means your private keys must be kept in the default folder, which varies depending on your operating system:

  • Windows: %USERPROFILE%/.kryptor
  • Linux: /home/.kryptor
  • macOS: /Users/USERNAME/.kryptor

To specify a private key for -r|--recover or a private key not stored in the default folder, you must use the -x|--private option followed by :[file] like so:

$ kryptor -r -x:"C:\Users\samuel-lucas6\Documents\encryption.private"