|Conor Patrick 0ae85abc92||2 years ago|
|solo||2 years ago|
|.editorconfig||2 years ago|
|.envrc||2 years ago|
|.flake8||2 years ago|
|.gitignore||2 years ago|
|CHANGELOG.md||2 years ago|
|LICENSE-APACHE||2 years ago|
|LICENSE-MIT||2 years ago|
|Makefile||2 years ago|
|README.md||2 years ago|
|dev-requirements.txt||2 years ago|
|pyproject.toml||2 years ago|
We require Python >= 3.6 and corresponding
We intend to support Linux, Windows and macOS. Other platforms aren't supported by the FIDO2 library we rely on.
To get started, run
pip3 install solo-python, this installs both the
solo library and the
For development, we suggest you run
make init instead, which
soloas symlink using our packaging tool
flit, including all runtime dependencies listed in
One way to ensure the virtual environment is active is to use direnv.
For help, run
solo --help after installation. The tool has a hierarchy of commands and subcommands.
solo ls # lists all Solo keys connected to your machine solo version # outputs version of installed `solo` library and tool solo key wink # blinks the LED solo key verify # checks whether your Solo is genuine solo key rng hexbytes # outputs some random hex bytes generated on your key solo key version # outputs the version of the firmware on your key
Upon release of signed firmware updates in solokeys/solo, to update the firmware on your Solo Secure ("regular" version) to the latest version:
solotool if necessary via
pip3 install --upgrade solo-python
solo key update --secure
To update an (unmodified) Solo Hacker, instead run
solo key update --hacker.
For possibly helpful additional information, see https://github.com/solokeys/solo/issues/113.
solotool.py has been refactored into a library with associated CLI tool called
It is still work in progress, example usage:
import solo client = solo.client.find() client.wink() random_bytes = client.get_rng(32) print(random_bytes.hex())
Comprehensive documentation coming, for now these are the main components
solo.client: connect to Solo Hacker and Solo Secure keys in firmware or bootloader mode
solo.dfu: connect to Solo Hacker in dfu mode (disabled on Solo Secure keys)
solo.cli: implementation of the
solocommand line interface
Licensed under either of
at your option.
Any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
We keep a CHANGELOG.