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

Uploaded Source

Built Distribution

pynitrokey-0.7.3-py3-none-any.whl (159.6 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for pynitrokey-0.7.3.tar.gz
Algorithm Hash digest
SHA256 faccdae193896c49487502d9169a16d33b3a29461aa51882de04f1723e8eaac8
MD5 86d3d1f03f47c489d83b61ec1c322bd6
BLAKE2b-256 146ae19ef968d5c858105c7d7558f1bc61aaa0eb8148c5fb6403e6597a896d06

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for pynitrokey-0.7.3-py3-none-any.whl
Algorithm Hash digest
SHA256 d12aae7c94fcf6e657a0a94905b0ac1a71279d003b3654960734cfdbfae34506
MD5 d3ab960c97473aff9e7348673f2129e9
BLAKE2b-256 808d1d7c14fa2cf5d6c44e4b9fe6d5cacb5efc3a9fcb2ba77c530454f0c8c3c8

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 Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page