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

Uploaded Source

Built Distribution

pynitrokey-0.4.30-py3-none-any.whl (341.6 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for pynitrokey-0.4.30.tar.gz
Algorithm Hash digest
SHA256 266bc0f19d6814e3fad93a49d20ed53b986add84b7fc3141fc12adda8efd00e1
MD5 5abfa9816f9001a26ec6eacb5058ad30
BLAKE2b-256 3d974b3fbc8d5d3d1fdab04024cd0bb04215fabd867376e1075e891283345194

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for pynitrokey-0.4.30-py3-none-any.whl
Algorithm Hash digest
SHA256 5716849024df365182fb74f6b14480ad7028b78850fad40d1b98d25e70cc8f18
MD5 c68dc6ad60466353f509fdb43b650b68
BLAKE2b-256 410d907fa7345fa7053a2b5cba66f69b573e7d8b4eef921d82039877131439f1

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