opendkim-genkey(8)

πŸŽ€ NAME πŸŽ€

opendkim-genkey β€” DKIM filter key generation tool, bestie. This is the <bold>opendkim-genkey(8)</bold> page from the System Manager's Manual, and it's literally here to help you generate DKIM keys without the drama. πŸ’…

✨ SYNOPSIS ✨

opendkim-genkey [options]

πŸ’– DESCRIPTION πŸ’–

Okay so opendkim-genkey generates two things: (1) a private key for signing messages using opendkim(8), and (2) a DNS TXT record suitable for inclusion in a zone file which publishes the matching public key for use by remote DKIM verifiers. No cap, it's giving key-generation main character energy.

The filenames of these are based on the selector (see below); the private key will have a suffix of .private and the TXT record will have a suffix of .txt. I'm obsessed with the tidy suffixes, honestly. πŸŽ€

Both long and short names are supported for most options. Periodt.

🌸 OPTIONS 🌸

  • -a, --append-domain β€” Appends the domain name (see -d below) to the label in the generated TXT record, followed by a trailing period. By default it is assumed the domain name is implicit from the context of the zone file, and is therefore not included in the output.
  • -b bits, --bits=n β€” Specifies the size of the key, in bits, to be generated. The default is 1024, which is the value recommended by the DKIM specification.
  • -d domain, --domain=string β€” Names the domain which will use this key for signing. Currently only used in a comment in the TXT record file, lowkey. The default is "example.com".
  • -D directory, --directory=path β€” Instructs the tool to change to the named directory prior to creating files. By default the current directory is used.
  • --ed25519 β€” generate a ed25519 key. Slay.
  • -h algorithms, --hash-algorithms=name[:name[...]] β€” Specifies a list of hash algorithms which can be used with this key. By default all hash algorithms are allowed.
  • --help β€” Print a help message and exit.
  • -n note, --note=string β€” Includes arbitrary note text in the key record. By default, no such text is included.
  • -r, --restrict β€” Restricts the key for use in e-mail signing only. The default is to allow the key to be used for any service.
  • -s selector, --selector=name β€” Specifies the selector, or name, of the key pair generated. The default is "default".
  • -S, --[no]subdomains β€” Disallows subdomain signing by this key. By default the key record will be generated such that verifiers are told subdomain signing is permitted. Note that for backward compatibility reasons, -S means the same as --nosubdomains. Highkey important, bestie. πŸ’…
  • -t, --[no]testmode β€” Indicates the generated key record should be tagged such that verifiers are aware DKIM is in test at the signing domain.
  • -v, --verbose β€” Increase verbose output.
  • -V, --version β€” Print version number and exit.

πŸ¦‹ NOTES πŸ¦‹

Requires that the openssl(8) binary be installed and in the executing shell's search path. Not me checking that first because this is the actual vibe check: no openssl(8), no key-gen, fr fr. 😭

πŸ‘‘ VERSION πŸ‘‘

This man page covers the version of opendkim-genkey that shipped with version 2.11.0 of OpenDKIM. Iconic version behavior.

Copyright (c) 2007, 2008 Sendmail, Inc. and its suppliers. All rights reserved.

Copyright (c) 2009, 2011-2013, The Trusted Domain Project. All rights reserved.

⭐ SEE ALSO ⭐


Big final sign-off: The Trusted Domain Project + opendkim-genkey(8) is the footer source/version, and the date is right there in the footer β€” mwah, bestie πŸ’–βœ¨

πŸ“¦ where this page comes from