summaryrefslogtreecommitdiff
path: root/nitrokey/README.md
diff options
context:
space:
mode:
authorDaniel Mueller <deso@posteo.net>2020-04-04 14:39:19 -0700
committerDaniel Mueller <deso@posteo.net>2020-04-04 14:39:19 -0700
commitd0d9683df8398696147e7ee1fcffb2e4e957008c (patch)
tree4baa76712a76f4d072ee3936c07956580b230820 /nitrokey/README.md
parent203e691f46d591a2cc8acdfd850fa9f5b0fb8a98 (diff)
downloadnitrocli-d0d9683df8398696147e7ee1fcffb2e4e957008c.tar.gz
nitrocli-d0d9683df8398696147e7ee1fcffb2e4e957008c.tar.bz2
Remove vendored dependencies
While it appears that by now we actually can get successful builds without Cargo insisting on Internet access by virtue of using the --frozen flag, maintaining vendored dependencies is somewhat of a pain point. This state will also get worse with upcoming changes that replace argparse in favor of structopt and pull in a slew of new dependencies by doing so. Then there is also the repository structure aspect, which is non-standard due to the way we vendor dependencies and a potential source of confusion. In order to fix these problems, this change removes all the vendored dependencies we have. Delete subrepo argparse/:argparse Delete subrepo base32/:base32 Delete subrepo cc/:cc Delete subrepo cfg-if/:cfg-if Delete subrepo getrandom/:getrandom Delete subrepo lazy-static/:lazy-static Delete subrepo libc/:libc Delete subrepo nitrokey-sys/:nitrokey-sys Delete subrepo nitrokey/:nitrokey Delete subrepo rand/:rand
Diffstat (limited to 'nitrokey/README.md')
-rw-r--r--nitrokey/README.md92
1 files changed, 0 insertions, 92 deletions
diff --git a/nitrokey/README.md b/nitrokey/README.md
deleted file mode 100644
index 12a9f6d..0000000
--- a/nitrokey/README.md
+++ /dev/null
@@ -1,92 +0,0 @@
-<!---
-Copyright (C) 2019 Robin Krahl <robin.krahl@ireas.org>
-SPDX-License-Identifier: CC0-1.0
--->
-
-# nitrokey-rs
-
-A libnitrokey wrapper for Rust providing access to Nitrokey devices.
-
-[Documentation][]
-
-## Compatibility
-
-The required [`libnitrokey`][] version is built from source. The host system
-must provide `libhidapi-libusb0` (Linux) or `libhidapi` (non-Linux) in the
-default library search path. Depending on your system, you might also have to
-install the [Nitrokey udev rules][].
-
-Currently, this crate provides access to the common features of the Nitrokey
-Pro and the Nitrokey Storage: general configuration, OTP generation and the
-password safe. Basic support for the secure storage on the Nitrokey Storage is
-available but still under development.
-
-### Unsupported Functions
-
-The following functions provided by `libnitrokey` are deliberately not
-supported by `nitrokey-rs`:
-
-- `NK_get_device_model`. We know which model we connected to, so we can
- provide this information without calling `libnitrokey`.
-- `NK_is_AES_supported`. This method is no longer needed for Nitrokey devices
- with a recent firmware version.
-- `NK_set_unencrypted_volume_rorw_pin_type_user`,
- `NK_set_unencrypted_read_only`, `NK_set_unencrypted_read_write`. These
- methods are only relevant for older firmware versions (pre-v0.51). As the
- Nitrokey Storage firmware can be updated easily, we do not support these
- outdated versions.
-- `NK_totp_get_time`, `NK_status`. These functions are deprecated.
-- `NK_read_HOTP_slot`. This function is only available for HOTP slots, not for
- TOTP. We will support it once both types are supported by `libnitrokey`.
-- All `*_as_string` functions that return string representations of data
- returned by other functions.
-
-## Tests
-
-This crate has tests for different scenarios: Some tests require that no
-Nitrokey device is connected, others require a Nitrokey Storage or a Nitrokey
-Pro. We use the [`nitrokey-test`][] crate to select the test cases. You can
-just run `cargo test` to auto-detect connected Nitrokey devices and to run the
-appropriate tests. If you want to manually select the tests, set the
-`NITROKEY_TEST_GROUP` environment variable to `nodev` (no device connected),
-`pro` (Nitrokey Pro connected) or `storage` (Nitrokey Storage connected).
-
-Note that the tests assume that the device’s passwords are the factory defaults
-(admin PIN `12345678`, user PIN `123456`, update password `12345678`) and that
-an AES key has been built. Some tests will overwrite the data stored on the
-Nitrokey device or perform a factory reset. Never execute the tests if you
-don’t want to destroy all data on any connected Nitrokey device!
-
-## Acknowledgments
-
-Thanks to Nitrokey UG for providing two Nitrokey devices to support the
-development of this crate. Thanks to Daniel Mueller for contributions to
-`nitrokey-rs` and for the `nitrokey-test` crate.
-
-## Minimum Supported Rust Version
-
-This crate supports Rust 1.34.2 or later.
-
-## Contact
-
-For bug reports, patches, feature requests or other messages, please send a
-mail to [nitrokey-rs-dev@ireas.org][].
-
-## License
-
-This project is licensed under the [MIT][] license. The documentation and
-configuration files contained in this repository are licensed under the
-[Creative Commons Zero][CC0] license. You can find a copy of the license texts
-in the `LICENSES` directory. `libnitrokey` is licensed under the [LGPL-3.0][].
-
-`nitrokey-rs` complies with [version 3.0 of the REUSE specification][reuse].
-
-[Documentation]: https://docs.rs/nitrokey
-[Nitrokey udev rules]: https://www.nitrokey.com/documentation/frequently-asked-questions-faq#openpgp-card-not-available
-[`libnitrokey`]: https://github.com/nitrokey/libnitrokey
-[`nitrokey-test`]: https://github.com/d-e-s-o/nitrokey-test
-[nitrokey-rs-dev@ireas.org]: mailto:nitrokey-rs-dev@ireas.org
-[MIT]: https://opensource.org/licenses/MIT
-[CC0]: https://creativecommons.org/publicdomain/zero/1.0/
-[LGPL-3.0]: https://opensource.org/licenses/lgpl-3.0.html
-[reuse]: https://reuse.software/practices/3.0/