Skip to content

Latest commit

 

History

History
142 lines (111 loc) · 5.29 KB

NOTES.md

File metadata and controls

142 lines (111 loc) · 5.29 KB

Design Notes

Language

Python 3.12

Config file

Format: YAML

Path: ~/.config/belt/config.json

Group Key Type Description
crypt env str Environment variable to use for encryption key
crypt key str Default key for encryption/decryption (if crypt -> env is empty or unset)
crypt warned bool Whether the user has been warned about the consequences of losing the key
dns server str Default DNS server to use for lookups
dns root bool Use root servers directly for lookups

Args and flags

Universal flags

Full flag Abbreviation
--config FILE -c FILE
--env-prefix PREFIX -e PREFIX
--help -h
--in FILE -i FILE
--out FILE -o FILE
--verbose -v
--version -V

Functionality selection

Command Subcommand Function Positional STDIN STDOUT Params
audio info ✅
crypt random hex LENGTH ✅
crypt random pw LENGTH ✅ -n, --numbers Add numbers
-s, --symbols Add symbols
-c, --chbs Use xkcd format
crypt simple decrypt ✅ ✅
crypt simple encrypt ✅ ✅
crypt simple key ✅
crypt wireguard ✅
dns flush
dns lookup QUERY ✅ -s, --server HOSTNAME Use server
[RECORDTYPE] -r, --root Use root servers
dns sec DOMAIN.TLD
domain expiry DOMAIN.TLD
domain ns DOMAIN.TLD
init -o, --overwrite Overwrite without asking
tls cert req COMMONNAME -c, --client Request client cert
tls cert selfsign COMMONNAME -c, --client Generate client cert
tls ciphers HOSTNAME
PORT

Cryptography

Key generation

Length

32 bytes (256-bit)

Key Encoding

base58

Passphrase

cryptography.hazmat.primitives.kdf.argon2.Argon2id

Random

cryptography.hazmat.primitives.ciphers.aead.ChaCha20Poly1305.generate_key()

Encryption & Decryption

Encoding

cryptography.hazmat.primitives.serialization.Encoding.PEM

Encryption

cryptography.hazmat.primitives.ciphers.aead.ChaCha20Poly1305

Features

1.0

  • DNS
    • Lookup
    • DNSSEC check
      • Remediation instructions
    • OS cache flush
  • TLS
    • Cipher list and order
    • Certificate generation
      • All features for client or server certificate
      • Self-signed
      • Certificate request
  • Cryptography
    • Simple encrypt/decrypt
      • Password from readline or env var
    • Generate WireGuard keypair
    • Random generation
      • Alphanumeric + symbols
      • Alphanumeric
      • Alphabetical
      • Numeric
      • Hex
      • 0x prefixed hex
  • Domain
    • Time to expiry from WHOIS
    • Nameserver lookup from WHOIS
  • Audio files
    • Get sample rate and bit-depth

Planned

  • Git
    • Clone
    • Pull
    • Push
    • Branch
    • Detect remote changes
  • SSH
    • Tunnels
    • Connections
    • Config management
    • Cipherspec validation
      • Remediation
  • DNS
    • Propagation checks
      • Multiple public resolvers
  • Cloudflare
    • Clear cache
  • Workspace
    • Replicate ws functionality