aboutsummaryrefslogtreecommitdiff
path: root/CHANGELOG.md
Commit message (Collapse)AuthorAge
* Update structopt dependency to 0.3.17Daniel Mueller2020-08-25
| | | | | | | | | | This change updates the structopt crate to version 0.3.13. We need this version as it fixes a compilation error [0] when using the external_subcommand enum variant annotation provided by the crate. This functionality will be used in a follow up change that enables usage of user provided extensions. [0]: https://github.com/TeXitoi/structopt/issues/424
* Add --serial-number optionRobin Krahl2020-09-07
| | | | | | | | 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 Krahl2020-09-07
| | | | | | | | 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.
* Declare semver compatibility and public APIRobin Krahl2020-09-05
| | | | | | This patch adds a new section to the README that declares that we follow the Semantic Versioning specification and that the public API of our crate is defined by the man page.
* 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.
* Use standard configuration file locationsRobin Krahl2020-09-05
| | | | | | | | | This patch uses the directories crate to query the appropriate path for the configuration files. For Linux, paths according to the XDG Base Directory Specification are used. Note that directories does not yet support the XDG_CONFIG_DIRS variable for system-wide configuration files. Therefore we only use a user configuration file.
* Use envy to parse environment variables for ConfigRobin Krahl2020-09-05
| | | | | | | | This patch uses the envy crate to parse the environment. A variable NITROCLI_KEY can be used to overwrite the configuration for *key*. This has the side effect that the NITROCLI_NO_CACHE variable is evaluated as a boolean variable (instead of only checking whether it is set). We also accept two new variables, NITROCLI_MODEL and NITROCLI_VERBOSITY.
* Implement configuration handlingRobin Krahl2020-09-05
| | | | | | | | | This patch implements basic configuration handling that reads a configuration file and stores the parsed data in the ExecCtx and RunCtx structs. It supports three configuration items: - model (previously only --model) - no_cache (previously only NITROCLI_NO_CACHE) - verbosity (previously only --verbose)
* Bump version to 0.3.4Daniel Mueller2020-09-05
| | | | | | | | | | | | This change bumps the version of the crate to 0.3.4. The following notable changes have been made since 0.3.3: - Changed default OTP format from hex to base32 - Improved error reporting format and fidelity - Added anyhow dependency in version 1.0.32 - Updated minimum required Rust version to 1.42.0 - Bumped nitrokey dependency to 0.7.1 - Bumped proc-macro2 dependency to 1.0.19 - Bumped syn dependency to 1.0.36
* Update syn and proc-macro2 dependenciesRobin Krahl2020-09-05
| | | | | This change updates the syn dependency we consume to 1.0.36 and proc-macro2 to 1.0.19.
* Use anyhow for error handlingDaniel Mueller2020-08-28
| | | | | | | | | | | This patch changes our error handling approach from the ground up: instead of having a globally used Error enum that contains variants for all possible errors, we now use anyhow's Error type. This approach is more dynamic (and not statically typed), but it allows for more fine grained error messages and overall more user-friendly error reporting. Overall it also is a net simplification. While we have one dynamic cast now, in order to be able to handle erroneous password/PIN entries correctly, that is considered a reasonable compromise.
* Update nitrokey dependency to 0.7.1Daniel Mueller2020-07-17
| | | | | | | | | This change updates the nitrokey dependency we consume to 0.7.1. With this version the crate's Error type got reworked slightly, allowing it to implement Sync and Send. It furthermore no longer duplicates information available through the source() method in its Display implementation. Both these changes will enable us to switch over to using the anyhow crate for error handling in nitrocli in the future.
* Update minimum required Rust version to 1.42.0Daniel Mueller2020-07-10
| | | | | | This change updates the minimum required version of Rust to 1.42.0. We will need this version in order to make use of the most recent version of nitrokey-test.
* 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.
* Bump version to 0.3.3HEADmasterDaniel Mueller2020-04-19
| | | | | | | | | | | This change bumps the version of the crate to 0.3.3. The following notable changes have been made since 0.3.2: - Added bash completion support via shell-complete utility program - Updated minimum required Rust version to 1.40.0 - Converted Cargo.lock to new lock file format - Bumped libc dependency to 0.2.69 - Bumped structopt dependency to 0.3.13 - Bumped various transitive dependencies to most recent versions
* Convert Cargo.lock to new lock file formatDaniel Mueller2020-04-16
| | | | | | | | | Since version 1.38.0 of Rust, Cargo has built in support for a new lock file format that aims at reducing merge conflicts of unrelated changes. Given that we require an even more recent version of Rust, it seems safe to switch over to this new format (which by now is the default for new projects anyway). This patch changes the format of Cargo.lock accordingly.
* Update transitive nitrokey dependenciesDaniel Mueller2020-04-15
| | | | | This change updates transitive dependencies of the nitrokey crate to their most recent versions.
* Update structopt dependency to 0.3.13Daniel Mueller2020-04-13
| | | | | This change updates the structopt crate to version 0.3.13. Transitive dependencies are updated as well.
* Update libc dependency to 0.2.69Daniel Mueller2020-04-12
| | | | This change updates the libc crate to version 0.2.69.
* Update minimum required Rust version to 1.40.0Daniel Mueller2020-04-05
| | | | | | This change updates the minimum required version of Rust to 1.40.0. Among other changes, this version stabilized std::mem::take, which is something we will use with subsequent changes.
* Add support for generating a bash completion scriptDaniel Mueller2020-04-04
| | | | | | | | | | | | | | | | | | | | | | | | | | | This change adds support for generating a bash completion script. If sourced, the shell will provide tab completions for the program's arguments. There are two possible approaches provided by clap for going about generating shell completion functionality: either at build time, by separately generating the clap parsers out-of-band, or at run time, as an option to the main program itself. We are generally not too much in favor of a run time approach, as it means less inspectability at installation time and more overhead in the form of code crammed into the main binary. Hence, with this change we take the "build time" approach. Clap recommends hooking the generation up in build.rs, but this seems like an inflexible choice. For one, that is because it would mean unconditionally generating this file or using some user-unfriendly environment variable based approach for making the process conditional. But there is also the fact that specifying the command for which to generate the script should likely be configurable. That is a limitation of the completion script that clap generates (see https://github.com/clap-rs/clap/issues/1764). In our version we provide a utility program that emits the completion script to standard output, accepting regular command line options itself. In doing so we allow for installation time generation of the completion script or installation of the utility itself, the output of which could be sourced on demand -- depending on the user's preference.
* Bump version to 0.3.2Daniel Mueller2020-03-31
| | | | | | | | | | | | | | | | This change bumps the version of the crate to 0.3.2. The following notable changes have been made since 0.3.1: - Added the list command that lists all attached Nitrokey devices - Reworked argument handling: - Added structopt dependency in version 0.3.7 - Replaced argparse with structopt - Removed argparse dependency - Made the --verbose and --model options global - Removed vendored dependencies and moved source code into repository root - Bumped nitrokey dependency to 0.6.0 - Bumped quote dependency to 1.0.3 - Bumped syn dependency to 1.0.14
* Update quote dependency to 1.0.3Daniel Mueller2020-03-25
| | | | This change updates the quote crate to version 1.0.3.
* Update syn dependency to 1.0.14Daniel Mueller2020-03-16
| | | | This change updates the syn crate to version 1.0.14.
* Update nitrokey dependency to 0.6.0Robin Krahl2020-01-29
| | | | | | nitrokey 0.6.0 introduced the SerialNumber struct (instead of representing serial numbers as strings). We no longer have to manually format the serial number as SerialNumber implements Display.
* Make --verbose and --model options globalRobin Krahl2020-01-26
| | | | | | | | | This patch adds the attribute 'global = true' for the top-level --verbose and --model options, which ensures that they can also be set for subcommands. For example: $ nitrocli status --model pro Instead of only: $ nitrocli --model pro status
* Add scaffolding for the list commandRobin Krahl2020-01-14
| | | | | This patch adds the basic scaffolding for the list command which will list all attached Nitrokey devices.
* Bump nitrokey dependency to version 0.5.1Robin Krahl2020-01-14
| | | | | | This change updates the version of the nitrokey crate that we use to 0.5.1. As part of that, it replaces occurrences of Storage::get_status with Storage::get_storage_status as the method has been renamed.
* Remove argparse dependencyRobin Krahl2020-01-07
| | | | | | As we have replaced argparse with structopt, we no longer need it as a dependency. This patch removes the dependency from Cargo.toml and deletes the included copy.
* Replace argparse with structoptRobin Krahl2020-01-07
| | | | | | | | | | | | This patch changes the argument handling code to use structopt instead of argparse using the data structures we introduced in the last patch. As part of that transition we replace the old Error::ArgparseError variant with ClapError that stores a structopt::clap::Error. Because of that replacement, the format of the help messages changed, breaking some of the tests. Hence, this change adapts them accordingly. Also clap currently prints the version output to stdout, so we ignore the version_option test case for now.
* Add structopt dependency in version 0.3.7Daniel Mueller2020-04-04
| | | | | This patch series replaces argparse with structopt in the argument handling code. As a first step, we need structopt as a dependency.
* 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.
generated by cgit v1.2.3 (git 2.46.0) at 2024-11-18 19:56:00 +0000