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

Uploaded Source

Built Distribution

pynitrokey-0.4.28-py3-none-any.whl (340.8 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for pynitrokey-0.4.28.tar.gz
Algorithm Hash digest
SHA256 caa3f72008313c51b73ca2788c9cccc930c74888f7e2ad52cd9e084f854db52c
MD5 f42fa287f8f1142681cec9fcefc6cf24
BLAKE2b-256 8cf0d3c042909059bda9f3654ba226ea1fa8d999562e15f33df27aa3b75e1588

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for pynitrokey-0.4.28-py3-none-any.whl
Algorithm Hash digest
SHA256 9c900e553d320553ec9b4629e3d09ae403aa31d9cb3ac83002f561498e639cf0
MD5 592e2d43a9e5685d47b092f0153d698d
BLAKE2b-256 069860dd561fd8d2c5b747c69ce94d3466b7a619ca950a3f8d2310ef8c99eb05

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