ekeydctl8
Entropy key daemon control tool
Usage
ekeydctl {add
DeviceNode | addall
KeyDirPath | list | remove
Identifier | stats
Identifier | keyring
KeyRingFile | shutdown}
Overview
ekeydctl is a tool which interacts with the ekeyd using a local unix domain socket.
Options
- 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
list-
List all the entropy keys attached to the ekeyd daemon.
- 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.
- 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.
- keyring Keyring
-
Re-load keyring entries from a keyring file. The argument is to a keyring file. Any existing connections will not be affected.
shutdown-
Shut the entropy key daemon down.
Statistic variables
The stats command produces a list of key and value pairs. Each variable gives some information about the selected Entropy Key.
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.
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.
Releases
Unchanged in 8 releases since Debian 6.0 (Squeeze).