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

Uploaded Source

Built Distribution

pynitrokey-0.4.26-py3-none-any.whl (336.3 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for pynitrokey-0.4.26.tar.gz
Algorithm Hash digest
SHA256 3ae2d1eadc6fa0ea4e518a648c0e5491750821ad61602c139a63ee502de2e333
MD5 86ca42f7660ace1db9557a25bd6a8438
BLAKE2b-256 48ff42b685a1988503690497b6bdad161b164c4a84c9936857f7844edebae79a

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for pynitrokey-0.4.26-py3-none-any.whl
Algorithm Hash digest
SHA256 32851ed3f2da37ad365ab4ab379a543a821609d38781b452385214c6b7eb2fdf
MD5 210cb1ef28a1ad4a8190affb8a7adba7
BLAKE2b-256 dc81783c2b70c0e27e925278f76a7c298d178d6a2a02c2acd146e850c9204d41

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