SQ(1)

🌸 NAME 🌸

okay so this is the SQ(1) page β€” section 1, User Commands β€” and the actual star of the show is sq-packet-dump, which does one (1) thing and does it gorgeously: it lists packets. πŸ’–


πŸ¦‹ SYNOPSIS πŸ¦‹

sq packet dump [OPTIONS] FILE

that's the shape of it, bestie. options, then a file. iconic. ✨


πŸ’… DESCRIPTION πŸ’…

List packets. yeah that's it, that's the whole vibe. πŸŽ€

What you actually get is a human-readable description of the packet sequence. So like, not just vibes β€” real, readable structure. 🫢

On top of that? It can also print cryptographic artifacts, and it can print the raw octet stream, kinda like hexdump(1) does β€” except it annotates specifically which bytes are parsed into OpenPGP values. it's giving annotated, it's giving academic, it's giving slay. πŸ”₯

And if the packet stream includes an encryption container, sq will attempt to decrypt it. no cap. πŸ‘‘


✨ OPTIONS ✨

πŸŽ€ Subcommand options πŸŽ€

  • --cert=FINGERPRINT|KEYID β€” dump the packets of the certificate that has this fingerprint or key ID. literally tell it who and it'll spill. πŸ™ˆ
  • --cert-email=EMAIL β€” dump the packets of the certificate where a user ID includes this email address. πŸ“§
  • --cert-file=PATH β€” dump the packets of the cert, read from PATH. πŸ“‚
  • --cert-userid=USERID β€” dump the packets of the certificate with this user ID. πŸͺͺ
  • --hex β€” print a hexdump. every byte, exposed. πŸ’€
  • --mpis β€” print cryptographic artifacts. the math is mathing. 🧚
  • --output=FILE β€” write to FILE, or to stdout if you leave it out. ⭐

[default: -]

  • --recipient-file=KEY_FILE β€” decrypt the message using the key in KEY_FILE. bestie's got the key literally right there. πŸ”‘
  • --session-key=SESSION-KEY β€” decrypt an encrypted message using SESSION-KEY. πŸ—οΈ
  • FILE β€” read from FILE, or from stdin if FILE is '-'. 🌈

[default: -]

πŸ’œ Global options πŸ’œ

See sq(1) for a description of the global options. (yes, the global options live over there, go say hi.) πŸ‘‹


πŸ”₯ EXAMPLES πŸ”₯

Print the packets of a certificate.

sq packet dump juliet.pgp

Print the packets including cryptographic artifacts of a certificate.

sq packet dump --mpis juliet.pgp

Print the packets including a dump of every byte of a certificate.

sq packet dump --hex juliet.pgp

Prints the packets of an encrypted message, decrypting it using a secret key file.

sq packet dump --recipient-file bob-secret.pgp message.pgp

πŸ‘‘ SEE ALSO πŸ‘‘


⭐ VERSION ⭐

1.5.0


and that's the page, bestie 🫢 this whole thing is brought to you by Sequoia PGP, version 1.5.0, and yeah the footer is just that β€” Sequoia PGP, 1.5.0, SQ(1) β€” no date up in here, so don't come for me about timestamps. go dump some packets, you absolute main character. πŸ’…βœ¨

πŸ“¦ where this page comes from