sett - the secure encryption and transfer tool

Contents:

• What is sett?
• sett quick start guide
  • Initial setup
  • Getting a recipient’s PGP key
  • sett-gui quick start
    • Encrypting data
    • Transferring data
    • Decrypting data
  • sett command line quick start
• Installing sett on your local computer
  • Installing dependencies
    • Installing dependencies on Windows
    • Installing dependencies on Linux
    • Installing dependencies on Mac OS
  • Installing sett
    • Installing sett on Windows
    • Installing sett on Linux
    • Installing sett on Mac OS
    • Installing sett in a Conda virtual environment [cross-platform]
    • Installing a specific version of sett
  • Updating sett
• PGP key management with sett
  • Introduction to public-key cryptography, PGP and GnuPG
    • Key fingerprints
    • File encryption
    • File signing
    • Public key signing
    • Revocation certificates
    • Exchanging public keys via a keyserver
    • Public key certification status
  • Generating a new public/private PGP key pair
    • Generating a new key pair with sett-gui
    • Generating a new key pair in command line
    • Listing local keys in command line
  • Downloading keys from the default sett keyserver
    • Downloading keys using sett-gui
    • Downloading the DCC key
    • Downloading public keys from the BioMedIT keyserver using command line
  • Uploading public keys to the default sett keyserver
    • Uploading keys with sett-gui
    • Uploading keys in command line
  • Requesting a signature/certification from the SPHN Data Coordination Centre
    • Requesting a signature using sett-gui
    • Requesting a signature in command line
  • Deleting public and private keys
    • Deleting keys with sett-gui
    • Deleting keys in command line
  • Revoking PGP keys
    • Revoking keys with sett-gui
    • Revoking keys in command line
• Generating SSH keys
  • Windows users: enabling the ssh-keygen command
• Encrypting, transferring and decrypting data with sett
  • Encrypting files
    • Encrypting data with sett-gui
    • Encrypting data on the command line
  • Transferring files
    • Transferring files with sett-gui
    • Transferring data on the command line
  • Decrypting files
    • Decrypting data with sett-gui
    • Decrypting data on the command line
  • PGP key auto-download and auto-refresh in sett
  • Setting up predefined connection profiles for frequent use
  • Working with large files
  • Automating tasks with sett
  • Installing or running sett behind a proxy
    • Checking whether you are using a proxy
  • Known issues and limitations
    • SSH private key with non-ASCII characters password
• Automating sett
  • Batch packaging and transferring of files
  • Dealing with passwords when automating sett tasks
    • Example 1: Fully automated - unencrypted password file
    • Example 2: Semi automated
• sett configuration file
  • Using the GUI
  • Using CLI
  • Alternative config file location
  • Configuration options
• sett packaging file format specifications
  • File structure
  • File example
• sett benchmarks
  • Setting-up your system to run the sett benchmarks
    • Requirements
  • Running the sett benchmarks
  • Benchmark results plotting
  • Benchmark parameters
    • Benchmark factor levels
    • Input/Output file locations
    • SFTP parameters
    • Misc parameters
  • Benchmark results and sett performance
    • Overall sett performance
    • Compression level comparison
• Frequently asked questions and bug reports
  • Bug reports
  • Frequently asked questions
    • Warning “Config: Unexpected keys: …” at startup
    • Nothing happens when running sett-gui (Windows)
    • Error “No module named ‘PySide2’” on sett startup (Linux / MacOS)
• Source code