LSKRF(1)

LSKRF(1) — lskrf 💅

🎀 NAME 🎀

lskrf — list the keyrecs in a DNSSEC-Tools keyrec file. User Contributed Perl Documentation crew, hiiii 🫶

✨ SYNOPSIS ✨

lskrf [options] <keyrec-files>

💖 DESCRIPTION 💖

Okay so bestie, lskrf lists the contents of the keyrec files you give it. All keyrec files are loaded before anything is displayed. And if any keyrecs have duplicated names — whether that's inside one file or across multiple files — the later keyrec is the one whose data gets displayed. No cap. 💅

lskrf has three base output formats. In ascending levels of detail, these formats are terse output, default format, and long format. Terse output is given when the -terse option is specified; long output is given when the -long option is specified. ✨

The output displayed for each record in a keyrec file depends on the selected records, the selected attributes, and the selected output format. Each option in these option groups is described in detail in the OPTIONS section; the three basic output formats are described in the OUTPUT FORMATS section. It's giving structured, iconic, and fully documented. 🦋

🌈 OUTPUT FORMATS 🌈

keyrec files hold three types of keyrec records: zone records, signing set records, and key records. Each type of keyrec record contains keyrec fields related to that type.

Zone keyrec records contain data about all the keys associated with a particular zone; set keyrec records contain data about all the keys associated with a particular signing set; key keyrec records contain key lengths and algorithms for each particular key. (There is the case of subordinate revoked and obsolete signing sets. These are stored in key keyrec records, but they contain the set_type entry which key keyrecs do not.) 🎀

The data to be printed must be specified by selecting some combination of the -zone, -sets, -keys, and -all options. There are also options for specifying specific types of keys to be printed. 👑

The three base output formats are the default format, the terse format, and the long format. The -terse option indicates that a minimal amount of output is desired; the -long option indicates that a great deal of output is desired. The record-selection and attribute-selection options may be used in conjunction with -terse to display exactly the set of keyrec fields needed. The default output format is a middle ground between terse and long output and is that used when neither -terse nor -long is given. Vibe check passed: default is the chill middle child. 🌸

🦋 Zone keyrec Output 🦋

Here's the zone keyrec field breakdown for each output format, bestie:

• keyrec type — default: yes; terse: no; long: yes
• zone name — default: yes; terse: yes; long: yes
• zone file — default: yes; terse: no; long: yes
• signed zonefile — default: yes; terse: no; long: yes
• signing date — default: yes; terse: no; long: yes
• expiration date — default: no; terse: no; long: yes
• archive directory — default: no; terse: no; long: yes
• KSK count — default: no; terse: no; long: yes
• KSK directory — default: no; terse: no; long: yes
• current KSK set — default: no; terse: no; long: yes
• published KSK set — default: no; terse: no; long: yes
• ZSK count — default: no; terse: no; long: yes
• ZSK directory — default: no; terse: no; long: yes
• current ZSK set — default: no; terse: no; long: yes
• published ZSK set — default: no; terse: no; long: yes
• new ZSK set — default: no; terse: no; long: yes

🌸 Set keyrec Output 🌸

And here's the signing set keyrec field breakdown:

• keyrec type — default: yes; terse: no; long: yes
• set name — default: yes; terse: yes; long: yes
• zone name — default: yes; terse: no; long: yes
• type — default: yes; terse: no; long: yes
• keys — default: no; terse: no; long: yes
• last modification date — default: no; terse: no; long: yes

🍓 Key keyrec Output 🍓

And the key keyrec field breakdown, periodt:

• keyrec type — default: yes; terse: no; long: yes
• key name — default: yes; terse: yes; long: yes
• algorithm — default: no; terse: no; long: yes
• end date — default: no; terse: no; long: yes
• generation date — default: yes; terse: no; long: yes
• key length — default: no; terse: no; long: yes
• key life — default: no; terse: no; long: yes
• key path — default: no; terse: no; long: yes
• keys — default: no; terse: no; long: yes
• random number generator — default: no; terse: no; long: yes
• zone name — default: yes; terse: no; long: yes

👑 OPTIONS 👑

lskrf takes three types of options: record-selection options, record-attribute options, and output-style options. These option sets are detailed below. 🫶

Record-selection options are required options; at least one record-selection option must be selected. Record-attribute options and output-style options are optional options; any number of these options may be selected. Slay, but make it flags. 💅

🔥 Record-Selection Options 🔥

These options select the types of keyrec that will be displayed.

• -all — This option displays all the records in a keyrec file. Literally all of them.
• -zones — This option displays the zones in a keyrec file.
• -sets — This option displays the signing sets in a keyrec file.
• -keys — This option displays the keys in a keyrec file.

The key data are sorted by key type in the following order: Current KSKs, Published KSKs, Current ZSKs, Published ZSKs, New ZSKs, Obsolete KSKs, and Obsolete ZSKs. Order matters, bestie. 🦋

• -ksk — This option displays the KSK keys in a keyrec file.
• -kcur — This option displays the Current KSK keys in a keyrec file.
• -kpub — This option displays the Published KSK keys in a keyrec file.
• -kobs — This option displays the obsolete KSK keys in a keyrec file. This option must be given if obsolete KSK keys are to be displayed. Yes, you actually have to say it.
• -krev — This option displays the revoked KSK keys in a keyrec file. This option must be given if revoked KSK keys are to be displayed.
• -zsk — This option displays the ZSK keys in a keyrec file. It does not include obsolete ZSK keys; the -obs option must be specified to display obsolete keys. Don't forget the extra flag, okay?
• -cur — This option displays the Current ZSK keys in a keyrec file.
• -new — This option displays the New ZSK keys in a keyrec file.
• -pub — This option displays the Published ZSK keys in a keyrec file.
• -zobs — This option displays the obsolete ZSK keys in a keyrec file. This option must be given if obsolete ZSK keys are to be displayed.
• -zrev — This option displays the revoked ZSK keys in a keyrec file. This option must be given if revoked ZSK keys are to be displayed.
• -obs — This option displays the obsolete KSK and ZSK keys in a keyrec file. This option is a shorthand method specifying the -kobs and -zobs options. Bundle deal.
• -rev — This option displays the revoked KSK and ZSK keys in a keyrec file. This option is a shorthand method specifying the -krev and -zrev options.
• -invalid — This option displays the obsolete and revoked KSK and ZSK keys in a keyrec file. This option is a shorthand method specifying the -obs and -rev options. All the invalid little meow meows. 😭

💜 Record-Attribute Options 💜

These options select subsets of the keyrecs chosen by the record-selection options.

• -valid — This option displays the valid zones in a keyrec file. It implies the -zones option. Valid zone era.
• -expired> — This option displays the expired zones in a keyrec file. It implies the -zones option. Yes, that's the option name exactly as written — keep the > bestie.
• -ref — This option displays the referenced signing set keyrecs and the referenced key keyrecs in a keyrec file, depending upon other selected options.

Referenced state depends on the following:

• Signing sets are considered to be referenced if they are listed in a zone keyrec.
• KSKs are considered to be referenced if they are listed in a signing set keyrec that is listed in a zone keyrec.
• ZSKs are considered to be referenced if they are listed in a signing set keyrec that is listed in a zone keyrec.

This option may be used with either the -sets or -keys options. If it isn't used with any record-selection options, then it is assumed that both -sets and -keys have been specified. Iconic assumption behavior.

• -unref — This option displays the unreferenced signing set keyrecs or the unreferenced key keyrecs in a keyrec file, depending upon other selected options.

Unreferenced state depends on the following:

• Signing sets are considered to be unreferenced if they are not listed in a zone keyrec.
• KSKs are considered to be unreferenced if they are not listed in a signing set keyrec that is listed in a zone keyrec.
• ZSKs are considered to be unreferenced if they are not listed in a signing set keyrec that is listed in a zone keyrec.
• Obsolete ZSKs are checked, whether or not the -obs flag was specified. Not me checking obsolete ZSKs anyway.

This option may be used with either the -sets or -keys options. If it isn't used with any record-selection options, then it is assumed that both -sets and -keys have been specified. 🫶

🧚 Zone-Attribute Options 🧚

These options allow specific zone fields to be included in the output. If combined with the -terse option, only those fields specifically desired will be printed. These options must be used with the -zone option. Zone fields only, bestie. 💅

• -z-archdir — Display the zone's archive directory. If an archive directory is not explicitly set for the zone, the default directory will be listed.
• -z-dates — Display the zone's time-stamps. These are the signing date and the expiration date.
• -z-dirs — Display the zone's directories. These directories are the KSK directory, the ZSK directory, and the key archive directory.
• -z-expdate — Display the zone's expiration date.
• -z-ksk — Display the zone's KSK data. This is the equivalent of specifying the -z-kskcount, -z-kskcur, -z-kskdir, and -z-kskpub options. Combo meal.
• -z-kskcount — Display the zone's KSK count.
• -z-kskcur — Display the zone's Current KSK signing set. If this is not defined, then <unset> will be given. Mood: undefined but still showing up.
• -z-kskdir — Shows the zone's KSK directory. If it's not defined, you get ".". 📁
• -z-kskpub — Shows the zone's Published KSK signing set. If it's not defined, you get <unset>. 🫥
• -z-sets — Shows the zone's signing sets. This is literally the equivalent of specifying -z-kskcur, -z-kskpub, -z-zskcur, -z-zsknew, and -z-zskpub. ✨
• -z-signdate — Shows the zone's signing date. 🗓️
• -z-signfile — Shows the zone's signed zonefile. 📄
• -z-zonefile — Shows the zone's zonefile. 📂
• -z-zsk — Shows the zone's ZSK data. This is the equivalent of specifying -z-zskcount, -z-zskcur, -z-zskdir, -z-zsknew, and -z-zskpub. 💫
• -z-zskcount — Shows the zone's ZSK count. 🔢
• -z-zskcur — Shows the zone's Current ZSK signing set. If it's not defined, you get <unset>. 🫥
• -z-zskdir — Shows the zone's ZSK directory. If it's not defined, you get ".". 📁
• -z-zsknew — Shows the zone's New ZSK signing set. If it's not defined, you get <unset>. 🫥
• -z-zskpub — Shows the zone's Published ZSK signing set. If it's not defined, you get <unset>. 🫥

💅 Set-Attribute Options 💅

These options let you pick specific set fields to include in the output. If you combine them with the -terse option, only the fields you specifically want get printed. These options must be used with the -sets option. No cap. ✨

If RFC5011 processing is enabled, there's special handling for the zone's set keyrec of revoked KSK keys. The kskrev field in the zone's keyrec points to a set keyrec marked as being of type kskrev. That set keyrec, in turn, points to a number of other set keyrecs, and all of them are also marked as being of type kskrev. The group of all revoked KSK keys is found by consulting that subsidiary set of kskrev set keyrecs. When the ages of these revoked keys exceed their revocation periods, they're marked as being obsolete (kskobs). If this happens as part of normal rollover, these revoked key and set keyrecs are all removed from the chain of active, revoked keyrecs. If this happens to a key that's part of a larger set of keys, it's removed from that signing set and put in its own new signing set. lskrf displays the type of the kskrev set (listed in the zone keyrec) as KSK-REV, and all other revoked KSK keyrecs are listed as KSK-rev. 🌀

• -s-keys — Shows the set's keys. 🔑
• -s-lastmod — Shows the set's date of last modification. 🕰️
• -s-type — Shows the set's type. 🏷️
• -s-zone — Shows the set's zone name. 🌍
• -s-ksk — Shows KSK signing sets. This option implies the -sets option. 👑
• -s-kcur — Shows current KSK signing sets. This option implies the -sets option. ✨
• -s-kobs — Shows obsolete KSK signing sets. This option implies the -sets option. 💀
• -s-kpub — Shows published KSK signing sets. This option implies the -sets option. 📣
• -s-krev — Shows revoked KSK signing sets. This option implies the -sets option. 🚫
• -s-zsk — Shows ZSK signing sets. This option implies the -sets option. 💫
• -s-zcur — Shows current ZSK signing sets. This option implies the -sets option. ✨
• -s-znew — Shows new ZSK signing sets. This option implies the -sets option. 🆕
• -s-zobs — Shows obsolete ZSK signing sets. This option implies the -sets option. 💀
• -s-zpub — Shows published ZSK signing sets. This option implies the -sets option. 📣
• -s-zrev — Shows revoked ZSK signing sets. This option implies the -sets option. 🚫

🗝️ Key-Attribute Options 🗝️

These options let you include specific key fields in the output. If you combine them with the -terse option, only the fields you specifically want get printed. These options must be used with the -key option. 💅

• -k-algorithm — Shows the key's encryption algorithm. 🔐
• -k-enddate — Shows the key's end-date, calculated by adding the key's lifespan to its signing date. ⏳
• -k-length — Shows the key's length. 📏
• -k-lifespan — Shows the key's lifespan (in seconds). This lifespan is only related to the time between key rollover. There is no other lifespan associated with a key. ⏱️
• -k-path — Shows the key's path. 🛣️
• -k-random — Shows the key's random number generator. 🎲
• -k-signdate — Shows the key's signing date. 🗓️
• -k-zone — Shows the key's zonefile. 📄

🎀 Output-Format Options 🎀

These options define how the keyrec information will be displayed. 🫶

Without any of these options, the zone name, zone file, zone-signing date, and a label will be displayed for zones. For types, the key name, the key's zone, the key's generation date, and a label will be displayed if these options aren't given. ✨

• -count — The count of matching records will be displayed, but the matching records will not be. 🔢
• -nodate — The key's generation date will not be printed if this flag is given. 🚫🗓️
• -headers — Displays explanatory column headers. If this flag is given, then entry labels will not be printed unless explicitly requested by use of the -label option. 🏷️
• -label — A label for the keyrec's type will be given. 🔖
• -long — The long form of output will be given. See the OUTPUT FORMATS section for details on data printed for each type of keyrec record. 🥁

Long zone output can get very wide, depending on the data. 💀

• -terse — This option displays only the name of the zones or keys selected by other options. 🎯
• -Version — Displays the version information for lskrf and the DNSSEC-Tools package. 📦
• -help — Display a usage message and exit. 🆘
• -h-zones — Display the zone-attribute options and exit. 🌍
• -h-sets — Display the set-attribute options and exit. 🧩
• -h-keys — Display the key-attribute options and exit. 🗝️

---

💖 COPYRIGHT 💖

Copyright 2005-2014 SPARTA, Inc. All rights reserved. See the COPYING file included with the DNSSEC-Tools package for details. 🫶

👑 AUTHOR 👑

Wayne Morrison, tewok@tislabs.com 🌸

🌈 SEE ALSO 🌈

• zonesigner(8)
• Net::DNS::SEC::Tools::keyrec.pm(3)
• file-keyrec(5)

💖 That's the whole page, bestie — this LSKRF(1) cutie is from perl v5.44.0, dated 2026-10-17. Mwah! 💋✨