summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDaniel Mueller <deso@posteo.net>2019-12-19 19:21:27 -0800
committerDaniel Mueller <deso@posteo.net>2019-12-19 19:21:27 -0800
commit3602aa37413186da0973c069bd0edc701a240dfe (patch)
treeceb38c1d15f67277304b923fe8046c84a6ebce56
parentba79a947fe4e7cc0c6e898bd4a7318a37962fca7 (diff)
downloadnitrocli-3602aa37413186da0973c069bd0edc701a240dfe.tar.gz
nitrocli-3602aa37413186da0973c069bd0edc701a240dfe.tar.bz2
Add note about interaction with GnuPG to README
Applications accessing the Nitrokey device through libnitrokey apparently lock the device. This lock may not be released in time, causing GnuPG operations performed shortly afterwards to fail (or, the other way around, when accessing the GPG smart card through GnuPG and then using nitrocli, the latter program may fail the interaction). Unfortunately there is nothing we can do directly about this problem on the nitrocli side of things, as the problem seemingly needs to be fixed in the firmware. Hence, with this change we add a note about this problem including a reference to the upstream issue to the README.
-rw-r--r--nitrocli/CHANGELOG.md1
-rw-r--r--nitrocli/README.md4
2 files changed, 5 insertions, 0 deletions
diff --git a/nitrocli/CHANGELOG.md b/nitrocli/CHANGELOG.md
index 7104c20..3d2584c 100644
--- a/nitrocli/CHANGELOG.md
+++ b/nitrocli/CHANGELOG.md
@@ -1,5 +1,6 @@
Unreleased
----------
+- Added note about interaction with GnuPG to `README` file
- Bumped `nitrokey` dependency to `0.4.0-alpha.3`
- Bumped `nitrokey-sys` dependency to `3.5.0`
- Added `lazy_static` dependency in version `1.2.0`
diff --git a/nitrocli/README.md b/nitrocli/README.md
index 7e15425..613527a 100644
--- a/nitrocli/README.md
+++ b/nitrocli/README.md
@@ -122,6 +122,9 @@ Known Problems
- `nitrocli` cannot connect to a Nitrokey device that is currently being
accessed by `nitrokey-app` ([upstream issue][libnitrokey#32]). To
prevent this problem, quit `nitrokey-app` before using `nitrocli`.
+- Applications using the Nitrokey device (such as `nitrocli` or
+ `nitrokey-app`) cannot easily share access with an instance of GnuPG
+ running shortly afterwards ([upstream issue][libnitrokey#137]).
Contributing
@@ -161,3 +164,4 @@ the full text of the license.
[nitrocli-ubuntu]: https://packages.ubuntu.com/disco/nitrocli
[gplv3-tldr]: https://tldrlegal.com/license/gnu-general-public-license-v3-(gpl-3)
[libnitrokey#32]: https://github.com/Nitrokey/libnitrokey/issues/32
+[libnitrokey#137]: https://github.com/Nitrokey/libnitrokey/issues/137