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.

Contributors

pynitrokey development has been supported by these contributors:

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

Uploaded Source

Built Distribution

pynitrokey-0.4.50-py3-none-any.whl (243.5 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for pynitrokey-0.4.50.tar.gz
Algorithm Hash digest
SHA256 048070218c6851c2bb13af5111cbbfaa6ae9365c98c2703b226de2452b169670
MD5 84e5ee36bccadd2b1ed0005ede6c2295
BLAKE2b-256 2320cbdbaad81817f7af312d5bfb647dff1ef2c39cc0101517d4c4b906639deb

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for pynitrokey-0.4.50-py3-none-any.whl
Algorithm Hash digest
SHA256 067c8ae6a232ce1f3673b044b0cb35220063c9d29ca0470a4481c35559717396
MD5 75c930d6d542758db96a29f72b563de8
BLAKE2b-256 068d458a2b06e36b4b3b9fda80d13e5f18e902c6607f554188e6436584b58fa1

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