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

Uploaded Source

Built Distribution

pynitrokey-0.4.36-py3-none-any.whl (626.2 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for pynitrokey-0.4.36.tar.gz
Algorithm Hash digest
SHA256 63ee93d62529f535586c08e95d51e8cc2e964f4eb5af4558bff89fbbc95c37a1
MD5 ce3351047add0cbc99cb965510531ddd
BLAKE2b-256 6f99d04f2ed76cfe4b393df72c779f7648e1dc6855c5d6e7bdc3702cbe2f861e

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for pynitrokey-0.4.36-py3-none-any.whl
Algorithm Hash digest
SHA256 9edb109bfa94bc2b2a6f9936f416e3b76ffa5e27da1ccbe0c6ce65120b7b8f39
MD5 606a93ac3444f934a2fa3041e6084383
BLAKE2b-256 d479d8ad58e206643748d24a2e1ebc245d124d279b981eda80ebd0300bb6b238

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