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

Uploaded Source

Built Distribution

pynitrokey-0.4.31-py3-none-any.whl (347.1 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for pynitrokey-0.4.31.tar.gz
Algorithm Hash digest
SHA256 9eac39c14cd0c4a081cd805186a07abfb596ac5d4e8dff33e8a7f561403dfb05
MD5 25903d8240cbb238b8d20721b4400388
BLAKE2b-256 496edbed194864c7f99cbb8b0c8eeba519dcc43269ed7deddd41f5f099d887b9

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for pynitrokey-0.4.31-py3-none-any.whl
Algorithm Hash digest
SHA256 8efa9c94adbd11a20c5f352a74aed0134e3074010ebfb5c8ea15175f5a475ac3
MD5 b96a7c926d170a366b42ea3430c11179
BLAKE2b-256 8bcbca77332c0354371225efdc69188e469debfd01cc20d9159d984d036a066a

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