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

Uploaded Source

Built Distribution

pynitrokey-0.4.32-py3-none-any.whl (572.2 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for pynitrokey-0.4.32.tar.gz
Algorithm Hash digest
SHA256 bf5bc1fbfe6cd93a8be7062a56fc8da739e2d0028a1d1e955ef5bd054f384216
MD5 bd0c2410f57ab7ca25756f846839af9f
BLAKE2b-256 1cb1c60d072a286728ebd39dc6e8723a0ad796c7620056579d8b0cda36efc007

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for pynitrokey-0.4.32-py3-none-any.whl
Algorithm Hash digest
SHA256 bff2b3bd47b7863b927e004887283e592bb08e955c02f504147d9808b6bde07c
MD5 3eea1ab538561928a4283fbe66490eed
BLAKE2b-256 3d5381811459f09e9317a748221da20224c16f6a81ab54e9b7f82f09e7ec5028

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