SQ(1)

πŸ’… SQ-PACKET-DECRYPT πŸ’…

okay bestie, welcome to sq-packet-decrypt, which is the actual deets-name for the command you probably know as:

sq packet decrypt [OPTIONS] FILE

and yeah this page is pure SQ(1) energy, so buckle up πŸŽ€


✨ NAME ✨

sq-packet-decrypt β€” unwrap an encryption container 🎁

like literally, it's the unwrapper. the opener. the "ooh what's inside" of OpenPGP. πŸ’–


🌸 SYNOPSIS 🌸

sq packet decrypt [OPTIONS] FILE

that's it. that's the whole summoning ritual. ✨


πŸ¦‹ DESCRIPTION πŸ¦‹

Unwrap an encryption container. πŸŽ€

So what it does is: it decrypts a message, and it dumps out the content of the encryption container without further processing. That last part is important, bestie β€” it doesn't go off doing extra stuff to your data behind your back. it just opens the box and hands you what's inside. πŸ™ˆ

And what's inside? a valid OpenPGP message ✨ which you can, among other things, inspect using sq packet dump. iykyk. that's the whole pipeline: unwrap it here, peek at it there. πŸ’…


πŸ”₯ OPTIONS πŸ”₯

🫢 Subcommand options

  • --binary β€” emit binary data. raw bytes, no vibes, no formatting, just data.
  • --dump-session-key β€” print the session key to stderr. yep, the actual key, out loud, on stderr, where everyone can see. do with that what you will, bestie 😭
  • --output=FILE β€” write to FILE, or to stdout if you leave it out.

[default: -]

  • --recipient-file=KEY_FILE β€” decrypt the message using the key sitting in KEY_FILE. this is the "hi yes it's me, let me in" option πŸ”‘
  • --session-key=SESSION-KEY β€” decrypt an encrypted message using SESSION-KEY. for when you already have the session key and don't need a whole key file situation. main character energy ✨
  • FILE β€” read from FILE, or from stdin if FILE is '-'.

[default: -]

🌈 Global options

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


πŸ‘‘ EXAMPLES πŸ‘‘

Unwrap the encryption revealing the signed message. it's giving "peel the wrapper, find the signature" πŸ“

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

that's the move. bob's secret key, message dot pgp, boom. πŸ’₯


πŸ’œ SEE ALSO πŸ’œ

For the full documentation see <https://book.sequoia-pgp.org/>. 🌐 (go read it, it's iconic)


⭐ VERSION ⭐

1.5.0 β€” periodt. πŸ’…


okay so that's the whole page!! πŸŽ€ this was Sequoia PGP, version 1.5.0, and honestly? obsessed. go unwrap something. πŸ¦‹βœ¨

πŸ“¦ where this page comes from