generate(1)

📦 version 0.27.0, in debian bookworm

🌸 NAME 🌸

generate — bestie, this one Generates a Web Key Directory for the given domain and keys. Periodt. It's from the Sequoia Manual, and it's lowkey iconic. 💅

✨ SYNOPSIS ✨

generate [-d|--direct-method] [-s|--skip] [-h|--help] <WEB-ROOT> <FQDN> [CERT-RING]

okay so that's the whole vibe in one line, we'll break it down, don't panic 🫶

💫 DESCRIPTION 💫

So. generate Generates a Web Key Directory for the given domain and keys. And if the WKD already exists? Not a problem bestie — the new keys will be inserted, it gets updated, and the existing ones will be updated too. The way it just handles it 😭👑

A WKD is per domain, and you can query it using the advanced method or the direct method. The advanced method uses a URL with a subdomain openpgpkey. And as per the specification, the advanced method is to be preferred. Fr fr.

The direct method may only be used if the subdomain doesn't exist. (Read that again, it's giving rules.) The advanced method allows web key directories for several domains on one web server — multitasking queen. 👑

⚠️ okay so the contents of the generated WKD must be copied to a web server so that they're accessible under: - https://openpgpkey.example.com/.well-known/openpgp/... for the advanced version - https://example.com/.well-known/openpgp/... for the direct version and just so we're clear: sq does not copy files to the web server. You do that part yourself, bestie. 💀

🎀 OPTIONS 🎀

  • -d, --direct-method — Uses the direct method [default: advanced method]
  • -s, --skip — Skips certificates that do not have User IDs for given domain
  • -h, --help — Print help information
  • <WEB-ROOT> — Writes the WKD to WEB-ROOT. Transfer this directory to the webserver.
  • <FQDN> — Generates a WKD for a fully qualified domain name for email
  • [CERT-RING] — Adds certificates from CERT-RING to the WKD

🔥 EXAMPLES 🔥

Generate a WKD in /tmp/wkdroot from certs.pgp for example.com.

sq wkd generate /tmp/wkdroot example.com certs.ppg

(and yes bestie, that's certs.ppg exactly as written, we do not edit the source material, not me being a good archivist 😌)

🌈 SEE ALSO 🌈

For the full documentation see <https://docs.sequoia-pgp.org/sq/>.

sq(1) sq-armor(1) sq-autocrypt(1) sq-certify(1) sq-dearmor(1) sq-decrypt(1) sq-encrypt(1) sq-inspect(1) sq-key(1) sq-keyring(1) sq-keyserver(1) sq-packet(1) sq-revoke(1) sq-sign(1) sq-verify(1) sq-wkd(1) sq-wkd-direct-url(1) sq-wkd-get(1) sq-wkd-url(1)

k that's the whole page, mwah 💖 This lil masterpiece is sq 0.26.0, dated July 2022, and it lives under the generate(1) manual name. Go build your WKD bestie, you got this 🦋✨

📦 where this page comes from