DEPRECATED AND UNMAINTAINED VERSION — sett - secure encryption and transfer tool

Important

DEPRECATION NOTICE — UNMAINTAINED PROJECT — DEPRECATION NOTICE

This version of sett and its associated documentation is not maintained anymore. Please do not use it anymore and switch to the new version of sett instead.

The new version of sett can be found at https://gitlab.com/biomedit/sett-rs, and the associated documentation is hosted here. We strongly encourage all users to migrate to the new version for improved performance and security.

This documentation remains available for reference only.

DEPRECATION NOTICE — UNMAINTAINED PROJECT — DEPRECATION NOTICE

Table of 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
  • Generate a new public/private PGP key pair
    • Generate a new key pair with sett-gui
    • Generate a new key pair in command line
    • List your local PGP keys in command line
    • Export/import private keys in command line
  • Upload your public PGP key to the keyserver
    • Upload your public PGP key with sett-gui
    • Upload your public PGP key in command line
    • Upload your public PGP key using a web browser
  • Register your public PGP key in the BioMedIT portal
    • PGP key status
    • Register your public PGP key
  • Download public PGP keys from the default keyserver
    • Download PGP keys with sett-gui
    • Download PGP keys in command line
    • Remove your public PGP keys from the keys.openpgp.org keyserver
  • Delete PGP keys from your local machine
  • Revoke your PGP key
    • Revoke your PGP key with sett-gui
    • Revoke your PGP key in command line
  • Migrating keys from the GnuPG keyring to the sett certificate store
  • Introduction to public-key cryptography, PGP and GnuPG
    • Key fingerprints
    • File encryption
    • File signing
    • Revocation certificates
    • Exchanging public keys via a keyserver
  • Troubleshoot the “Network is unreachable” and “No keyserver available” error
• Generating SSH keys
  • Windows users: enabling the ssh-keygen command
• Encrypting, transferring and decrypting data with sett
  • Encrypting files
    • Output file naming scheme
    • 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
    • Split and transfer 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
  • Configuration changes using sett-gui
  • Configuration changes using command line
  • 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)
    • sett generates SHA-1 keys
• Source code