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.34.tar.gz (252.3 kB view details)

Uploaded Source

Built Distribution

pynitrokey-0.4.34-py3-none-any.whl (572.3 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for pynitrokey-0.4.34.tar.gz
Algorithm Hash digest
SHA256 94c5e80e436202619be9ee2efef64c7265d4725c16e34d985068a12e3588afe5
MD5 e23d4409665d0c45fbac92dac03b7483
BLAKE2b-256 94a03c7ff331d5fab2783747bee9260182850c0bffc9c8253990e86729947039

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for pynitrokey-0.4.34-py3-none-any.whl
Algorithm Hash digest
SHA256 73874356eefba70753acd3766a53d60c2bb4627c9d4202642922db78b0a00a7d
MD5 25622d0b4a690968d16dda9b1ceefc47
BLAKE2b-256 1dc966995f61bcdd82e9f58a36128a1ccde91683d9dfc1f18387db6746ec28fd

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