aboutsummaryrefslogtreecommitdiff
path: root/nitrocli/README.md
diff options
context:
space:
mode:
authorDaniel Mueller <deso@posteo.net>2017-04-09 19:36:35 -0700
committerDaniel Mueller <deso@posteo.net>2017-04-09 19:36:35 -0700
commitf94d04578f44fc79212550203838f7c78e1ac414 (patch)
tree903bdcdd5edde580a557509ec55acfd1a5edad0f /nitrocli/README.md
parentc441df2c153c811af19f37bdfdc45a13c36e8f14 (diff)
downloadnitrocli-f94d04578f44fc79212550203838f7c78e1ac414.tar.gz
nitrocli-f94d04578f44fc79212550203838f7c78e1ac414.tar.bz2
Add 'status' command
The nitrokey supports a status command that instructs it to report details about itself. This data includes general useful information such as the current version of the firmware being installed along with more contextual bits such as the number of remaining retries for the user and admin PINs or whether the different volumes (unencrypted, encrypted, hidden) are writable. This change introduces the 'status' command line option that can be used to retrieve this information from the nitrokey and to display it.
Diffstat (limited to 'nitrocli/README.md')
-rw-r--r--nitrocli/README.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/nitrocli/README.md b/nitrocli/README.md
index 5ec814e..69f9b8c 100644
--- a/nitrocli/README.md
+++ b/nitrocli/README.md
@@ -7,6 +7,7 @@ certain commands on the [Nitrokey Storage][nitrokey] device.
The following commands are currently supported:
- open: Open the encrypted volume. The user PIN needs to be entered.
- close: Close the encrypted volume.
+- status: Report status information about the Nitrokey.
Usage
@@ -17,6 +18,20 @@ parameter, e.g.:
```bash
# Open the nitrokey's encrypted volume.
$ nitrocli open
+
+$ nitrocli status
+Status:
+ SD card ID: 0xdeadbeef
+ firmware version: 44.0
+ firmware: unlocked
+ storage keys: created
+ user retry count: 3
+ admin retry count: 3
+ volumes:
+ unencrypted: active
+ encrypted: active
+ hidden: inactive
+
# Close it again.
$ nitrocli close
```