Skip to main content

Python Library for Nitrokey devices.

Project description

pynitrokey

A command line interface for the Nitrokey FIDO2, Nitrokey Start, Nitrokey 3 and NetHSM.

Quickstart

$ pipx install pynitrokey
$ nitropy --help

Documentation

The user documentation for the nitropy CLI is available on docs.nitrokey.com. See also the product documentation for more information on the available commands:

Switching Nitrokey Start identities

Alternative MI switching method

pynitrokey installation is not always possible, hence describing below alternative method to change the Identity on the Nitrokey Start. It suffices to have any CCID application installed, and send the following APDU 00 85 00 {ID} (hex), where ID is in range [0;2]. After receiving this command Nitrokey Start will reboot with the selected identity.

Here is how to do it using GnuPG:

# Setting ID to 2
$ gpg-connect-agent --hex "scd apdu  00 85 00 02" /bye
ERR 65539 Unknown version in packet <Unspecified source>

# Alternative error messsage
ERR 65572 Bad certificate <Unspecified source>

The error message here is expected due to immediate reboot of the device, and with losing the connection.

When the ID change is attempted to be done immediately, the following response could be received:

ERR 100663406 Card removed <SCD>

To restore the communication, either kill the gpg-agent or run gpg --card-status again.

Tip: alternative gpg-connect-agent reloadagent /bye is not sufficient.

Compatibility

nitropy requires Python 3.9 or later.

Development

Information for developers and contributors can be found in the Developer Guide.

Maintainers

Current maintainers can be found in MAINTAINERS.md file.

License

Licensed similarly to upstream, under either of

at your option.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pynitrokey-0.4.38.tar.gz (261.2 kB view details)

Uploaded Source

Built Distribution

pynitrokey-0.4.38-py3-none-any.whl (631.9 kB view details)

Uploaded Python 3

File details

Details for the file pynitrokey-0.4.38.tar.gz.

File metadata

  • Download URL: pynitrokey-0.4.38.tar.gz
  • Upload date:
  • Size: 261.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.31.0

File hashes

Hashes for pynitrokey-0.4.38.tar.gz
Algorithm Hash digest
SHA256 f133036e44724e4cd42eb05e3b448bfd65c1db8d0b0ff8992e2804ff33ee9b60
MD5 c26322a3bdf0b41788e49985413ef1b2
BLAKE2b-256 9102c22dd78767d68f7d8ada56d3fb9e60daf10938d49013a77353b1cd2392e4

See more details on using hashes here.

File details

Details for the file pynitrokey-0.4.38-py3-none-any.whl.

File metadata

  • Download URL: pynitrokey-0.4.38-py3-none-any.whl
  • Upload date:
  • Size: 631.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.31.0

File hashes

Hashes for pynitrokey-0.4.38-py3-none-any.whl
Algorithm Hash digest
SHA256 aa9bc029ea5d24a4fcb51b75686e133c62533af75cdae7d7e7e435f28ebe758e
MD5 c247d62a60fa850d94830cf4b119f475
BLAKE2b-256 1b1c982df993af2a0b29015120cafc285b88c71e15e6c119b2c5098223aabce4

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page