summaryrefslogtreecommitdiff
path: root/doc
Commit message (Collapse)AuthorAge
* Fix number of password safe slots mentioned in the man pageDaniel Mueller2020-10-04
| | | | | | | | The man page mentions a password safe slot count of 20 for both the Nitrokey Pro and the Nitrokey Storage devices. This count is incorrect, as both devices can store only 16 entries each, as is evident from the corresponding technical details for each device. With this change we correct said number.
* Rename device path to USB path in list outputRobin Krahl2021-01-10
| | | | | For consistency with the --usb-path option, this path renames the device path column in the output of the list command to USB path.
* Add --usb-path option to select deviceRobin Krahl2021-01-10
| | | | | | | | | | | | | This patch adds the --usb-path option as an additional way to filter the Nitrokey device to connect to. While the serial number is a better identifier in theory, the Nitrokey Storage devices do not send their serial number in the USB device descriptor. Having the --usb-path options allows users to select one of multiple Nitrokey Storage devices. While we could directly call the nitrokey::Manager::connect_path function with the specified path, we integrate the --usb-path option into the existing find_device function for consistent error messages and to avoid having to duplicate the --model and --serial-number checks.
* Add --serial-number optionRobin Krahl2021-01-10
| | | | | | | | This patch adds the --serial-number option that allows the user to filter the attached Nitrokey devices by serial number. As the Nitrokey Storage does not include its serial number in the USB device descriptor and as we don't want to connect to it just to query the serial number, this option only works for Nitrokey Storage devices.
* Fail if multiple matching devices are attachedRobin Krahl2021-01-10
| | | | | | | | Previously, we just applied our filter (if any) to all attached Nitrokey devices and selected the first match when connection to a Nitrokey device. This may lead to unexpected behavior if multiple devices are attached. This patch changes the find_device function to return an error if multiple matching devices are found.
* Adjust copyright & license specification to comply with REUSE 3.0Daniel Mueller2020-09-02
| | | | | | | | With this change we switch to using a REUSE compliant way of specifying the copyright & license of the program. To be fully in conformance we also add additional license specifications for the remaining files in the project. Lastly, a new CI pipeline rule takes care of verifying compliance on an ongoing basis.
* Update man pageRobin Krahl2021-01-10
| | | | | | | This patch updates the man page for the last changes: - new option --no-cache - changes to the environment variables - configuration files
* Add config test case and example config fileRobin Krahl2021-01-10
| | | | | | | | This patch adds a simple configuration file that demonstrates the syntax and contains some documentation. We suggest to ship this file together with nitrocli and to install it e.g., in the /usr/share/doc/nitrocli directory. This patch also adds a simple test case that makes sure that the example file is parsed correctly.
* Change default OTP format to base32Daniel Mueller2020-07-07
| | | | | | | | | | | An arguably unrepresentative survey of services (GitHub, Google Authenticator, and Bitbucket) seems to suggests that the base32 format is the de-facto standard format for OTP secrets. Given that it's not necessarily obvious what format a secret is in and that most services refrain from mentioning it explicitly, having the correct default format is fairly important. With this change we switch the default format from hexadecimal to base32 to accommodate for this finding.
* doc: Remove options from synopsis in man pageRobin Krahl2020-01-29
| | | | | | | As it is no longer required to set the global options before the command and as we will probably introduce more global options with the next releases, this patch removes the global options from the synopsis line in the man page. See issue #102 for more details.
* Document the list command in the manpageRobin Krahl2020-01-14
|
* Move nitrocli source code into repository rootDaniel Mueller2020-04-04
Now that all vendored dependencies have been removed, this change moves the program's source code from the nitrocli/ directory into the root of the repository.