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

Uploaded Source

Built Distribution

pynitrokey-0.4.25-py3-none-any.whl (328.2 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for pynitrokey-0.4.25.tar.gz
Algorithm Hash digest
SHA256 796d5a6bae75a0efd31c04518ca172035e9b6bf786090f525e889063e24abe57
MD5 138b48e82c6406378991d2f85302f33b
BLAKE2b-256 cd9310c5b3b70dcd13b1e2383b282b40cc0c72500ce3a19f246d76b4b342f8e0

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for pynitrokey-0.4.25-py3-none-any.whl
Algorithm Hash digest
SHA256 008236db22a6fa769fb0152d5e2cd42bfb165663c495df8b126a40c0bc1c00ff
MD5 c613008b6265d6ee97cb0d6e1c3ff820
BLAKE2b-256 f6dff95440609996e4ac4d753b16fee94b4b97e358212d2f97f5bc5771b905f7

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