Python CLI Tools (CS)

This page provides information on Python command line interface (CLI) tools to install and test various features of SafeKey such as Custom Storage (CS).

Link to python tool :

Most of these features are going to be included in further releases of SafeKey Desktop.

SafeKey Tool Installation

pip3 uninstall solo-python -y  
pip3 uninstall safekey-python -y
pip3 install ./safekey_python-1.0.0-py3-none-any.whl --user

Custom Storage (CS) Activation

Activation feature allows to enable or disable Custom Storage (CS) commands on the given custom FIDO2 device.

It is based on the Elliptic Curve Cryptography (ECC), with set of operations based on public and private keys.

By default CS commands are disabled, and device returns error code on attempt of their execution.

Activation could be performed locally, with a potential extension to remote work (without firmware change). No one besides the person in the possession of the key can perform the procedure.

The received activation signature is restricted to the given device, and valid for only a single request, due to the use of MCU’s serial number, and a randomly device-generated transaction token.

Data received from the device allow to identify it, and track the activation status on the server.

Get Device Activation Status

safekey activation status `activation.pem`

Activate Device To Support Custom Storage Features

safekey activation activate `activation.pem`

Deactivate Device To Limit To SafeKey FIDO2 Features Only

safekey activation deactivate `activation.pem`

activation.pem (is an activation key generated and owned by SafeTech)

Custom Storage (CS) Tests

The repository contains tests for the Custom Storage features, which are part of the SafeKey firmware.

Test List (will be uploaded soon)

  • - unit tests for the Activation feature;

  • - general suite for the low-level communication, read and write of the data on the device;

  • - tests for the Unlock Passphrase feature;

  • - test suite for the PIN handling, and the connection between FIDO2 and Custom Storage PIN counter;

  • - brief FIDO2 tests;

Setup Tests

To run the tests, a pytest package has to be installed beforehand, as well as all requirements for the safekey-tool.

Please run the tests in the same environment, as the tool is installed.

For user-scope installation:

`shell script pip3 install pytest -y

## Running
```shell script
pytest -xv 

Other Tests

To blink the connected device, execute:

`shell script safekey key wink

For touch button status:
```shell script
safekey key status


Copyright 2019 SoloKeys Developers
Copyright 2020 SafeTech BVBA

Licensed under the Apache License, Version 2.0, <LICENSE-APACHE or> or the MIT license <LICENSE-MIT or>, at your option. This file may not be copied, modified, or distributed except according to those terms.

Last updated