ekeydctl(8)

💖 ekeydctl — the Entropy Key Daemon Control tool, section 8 of the System Manager's Manual 🎀

okay bestie, sit down, we're doing entropy today and it's gonna be iconic 💅

---

✨ NAME ✨

ekeydctl — the Entropy Key Daemon Control tool 🦋 (yes that's the whole name, it's giving "I do one job and I slay at it")

---

✨ SYNOPSIS ✨

ekeydctl add DeviceNode |addall KeyDirPath |list |remove Identifier
|stats Identifier |keyring KeyRingFile |shutdown

so like, pick a verb, hand it an argument (or don't, some of them are self-sufficient 💅), and go. no cap, that's the whole interface.

---

✨ DESCRIPTION ✨

ekeydctl is a tool which interacts with the ekeyd using a local unix domain socket. 🫶

that's it. that's the vibe. it talks to the daemon over a unix socket, local only, very "we keep it in the group chat" energy.

---

✨ OPTIONS ✨

okay here's the menu, no substitutions, everything's on the list:

• add DeviceNode — add an Entropy Key to be managed by the ekeyd daemon. the argument is the device node of the key, e.g. /dev/entropykey/AAAAAAAAAAAAAAAAAAA 🔥
• addall DevicePath — add a number of Entopy Keys to be managed by the ekeyd daemon. the argument is the path to a directory containing the device nodes to be added, e.g. /dev/entropykey — it's the "add everyone in the building" option, main character energy for real ✨
• list — list all the entropy keys attached to the ekeyd daemon. roll call 🎀
• remove Identifier — remove an Entropy Key from management by the ekeyd daemon. the argument may be the device node, the serial number of the key, or the numeric ID as shown in the list command. so flexible, we love options 💅
• stats Identifier — show statistics for an Entropy Key. the argument may be the device node, the serial number of the key, or the numeric ID as shown in the list command. (same three flavours of identifier, iconic consistency 👑)
• keyring Keyring — re-load keyring entries from a keyring file. the argument is to a keyring file. any existing connections will not be affected. 🫶 (chill, it's a soft refresh, nobody's getting dropped)
• shutdown — shut the entropy key daemon down. 💀 goodbye bestie, it's been real

---

✨ STATISTIC VARIABLES ✨

the stats command produces a list of key and value pairs. each variable gives some information about the selected Entropy Key. so many little numbers, we're so obsessed 🌸

• BytesRead — the total number of bytes read from the Entropy Key device.
• BytesWritten — the total number of bytes written to the Entropy Key device.
• ConnectionNonces — the number of session key nonces issued by the host software.
• ConnectionPackets — the number of packets recived from the Entropy Key device.
• ConnectionRekeys — the number of session re-keying events.
• ConnectionResets — the number of times the Entropy Key device has been reset by the host software.
• ConnectionTime — the number of seconds the Entropy Key device has been connected to the host software.
• EntropyRate — the number of bits per second of entropy from the Entropy Key.
• FipsFrameRate — the number of FIPS frames generated per second by the Entropy Key.
• FrameByteLast — the byte offset of the last valid frame.
• FramesOk — the number of valid frames recived from the Entropy Key.
• FramingErrors — the number of framing errors.
• KeyDbsdShannonPerByteL — the estimated number of shannons per byte from the left generator after debiasing.
• KeyDbsdShannonPerByteR — the estimated number of shannons per byte from the right generator after debiasing.
• KeyEnglishBadness — human-readable explanation of any 'badness' state on the device.
• KeyRawBadness — the raw badness token (if any) from the device.
• KeyRawShannonPerByteL — the estimated number of shannons per byte from the left generator before debiasing.
• KeyRawShannonPerByteR — the estimated number of shannons per byte from the right generator before debiasing.
• KeyRawShannonPerByteX — the estimated number of shannons per byte from the exclusive orred output of the generators before debiasing.
• KeyShortBadness — machine-readable reason for any 'badness' state on the device.
• KeyTemperatureC — the internal temperature in Celsius of the Entropy Key.
• KeyTemperatureF — the internal temperature in Fahrenheit of the Entropy Key.
• KeyTemperatureK — the internal temperature in Kelvin of the Entropy Key. (three whole temperature scales, she contains multitudes 🌈)
• KeyVoltage — the internal supply voltage of the Entropy Key.
• PacketErrors — the number of packet level errors.
• PacketOK — the number of correct packets.
• ReadRate — the number of bits per second being read from the Entropy Key.
• TotalEntropy — the total number of bytes read from the Entropy Key.
• WriteRate — the number of bits per second being written to the Entropy Key.

---

✨ SEE ALSO ✨

• ekeyd(8) — the daemon herself, go say hi 🫶

---

✨ AUTHOR ✨

Copyright © 2009 Simtec Electronics. All rights reserved. 👑

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

bestie this is the legal bit and it's not a joke — that whole warranty disclaimer is doing real work. read it. respect it. 💜

---

and that's the page!! this lil manual is dated the 19th July 2009 and it lives at the bottom of every ekeydctl(8) page as the source/version footer. 2009 said "let there be entropy" and honestly? it ate. 💖✨🎀