dkim-rotate(1)

📦
version 1.1build1 · 3 versions
, in ubuntu resolute, ubuntu stonking

💖 dkim-rotate — the manual page, but make it cute 💖

okay so bestie, this is dkim-rotate(1) and it's genuinely one of my fave little tools, no cap. let's get into it 💅

✨ NAME ✨

dkim-rotate — rotate and revoke and invalidate DKIM keys 🎀

🌸 SYNOPSIS 🌸

dkim-rotate [options] --new [instance ...]
dkim-rotate [options] --major [instance..]
dkim-rotate [options] --minor [instance ...]
dkim-rotate [options] --status [instance ...]
dkim-rotate [options] --reinstall [instance ...]

🦋 DESCRIPTION 🦋

so dkim-rotate is a tool for managing DKIM (email antispam) keys, and the whole vibe is that it does it in a manner that avoids unnecessarily making emails nonrepudiable. it's giving "responsible key management, but make it effortless" 💖

for each instance, dkim-rotate maintains several keys concurrently, using “selectors” in a circular rotation. iconic behavior honestly.

👑 heads up: go read dkim-rotate(7) for the Principles of Operation, and for the details of how to configure your MTA, DNS, and WWW server. iykyk.

if no instance is provided, dkim-rotate will operate on all instances matching [a-z][-_0-9a-z]* for which the configuration file /etc/dkim-rotate/instance.zone exists. so basically it just does the whole roster for you, slay.

see dkim-rotate(5) for the details about the instance configuration file. 📄

if an instance is provided and contains a slash, it will be treated as a pathname; otherwise it will be taken as a reference to the configuration file in /etc. simple as that.

dkim-rotate should normally be run out of cron. it will produce progress information on stdout. and it will produce stderr output if and only if something is wrong — so if you see stderr, bestie, something is NOT okay 😭

🔥 MODE OPTIONS 🔥

pick your fighter, there's literally one for every mood:

  • --major — Make progress. Create new keys, advance to using different keys, and reveal old keys, as necessary. this is the main character option fr 💫
  • --minor — Make progress, but do not advance to using a new key. if you wish your keys to be rotated at particular times of the day or week, you should run with --major at those times, and --minor otherwise.

for example, the suggested/default configuration runs with --major at 0400 local time. the effect is that emails sent on a particular day all cease to be repudiable at the same time. ✨ (yes this is the whole point, obsessed.)

  • --new — Make progress, and, additionally, allow the creation of a new instance. 🎀 Without --new, it is an error if there is a config file, but no recorded state.
  • --reinstall — Do not make any progress, but force recreation, reinstallation and reload of MTA and DNS output files. it's giving "just refresh everything bestie, don't think about it" 🫶
  • --status — Produce a status report of all the relevant keys. Do not make any changes. fully read-only, zero drama, perfect for a vibe check 👀

💜 OTHER OPTIONS 💜

  • *--etc-dir=etc-dir* — look for instance configuration files in etc-dir rather than /etc/dkim-rotate. 📂
  • *--var-dir=var-dir* — look for instance state directories in var-dir rather than /var/lib/dkim-rotate. 🗂️

👑 AUTHOR 👑

Copyright 2022 Ian Jackson and contributors to dkim-rotate.

There is NO WARRANTY. (fr fr, none, don't come for me 😭)

SPDX-License-Identifier: GPL-3.0-or-later

🌈 SEE ALSO 🌈

and that's the whole page bestie 🎀 you made it to the very bottom, which is where the footer lives: this is the dkim-rotate(1) manual page, and yeah, the copyright line up there in AUTHOR is dated 2022 — Ian Jackson and the contributors to dkim-rotate did that 💖 go rotate some keys, you absolute legend, periodt 💅✨

📦 where this page comes from