Skip to content

Latest commit

 

History

History
177 lines (130 loc) · 6.43 KB

install.md

File metadata and controls

177 lines (130 loc) · 6.43 KB
Raw

OpenSK logo

Installation guide

This document lists required steps to start build your own OpenSK.

Programmers

OpenSK supports different ways to flash your board:

  • Segger J-Link (default method).
  • OpenOCD.
  • pyOCD.
  • nrfutil for the USB dongle boards that support it, which allows you to directly flash a working board over USB without additional hardware.

Software requirements

In order to compile and flash a working OpenSK firmware, you will need the following:

  • rustup (can be installed with Rustup)
  • python3 and pip (can be installed with the python3-pip package on Debian)
  • the OpenSSL command line tool (can be installed and configured with the libssl-dev and pkg-config packages on Debian)
  • nrfutil (can be installed using pip3 install nrfutil) if you want to flash a device with DFU
  • uuid-runtime if you are missing the uuidgen command.
  • llvm and gcc-arm-none-eabi if you want to use the upgradability feature.

The proprietary software to use the default programmer can be found on the Segger website. Please follow their instructions to appropriate binaries for your system.

The scripts provided in this project have been tested under Linux and OS X. We haven't tested them on Windows and other platforms.

If you use Python newer than 3.10, then nrfutil for flashing over DFU is currently not supported. Please use Python 3.10, or play around with Nordic's new tool instead.

Compiling the firmware

If this is your first time installing OpenSK, please skip directly to Initial setup. Else, see Updating your setup below.

Updating your setup

Depending on the difference to your last state, you may need some of the following steps:

  • If you are not just testing minor changes, reset and redo the setup. This will delete all uncommited changes.

    ./reset.sh
./setup.sh

  • Flash your board according to the [flashing instructions below](#Flashing-a-firmware]. If you come from an OpenSK version before the 2.0 certified one, your credential storage is not backwards compatible and you have to reset it. ⚠️ You will lose logins to all websites that you registered with OpenSK. To erase your persistent storage, run the deploy script twice: Once with the application parameter --erase_storage, and once with --opensk as usual.

    This reset also clears the certificate. For a privacy discussion, see the certificate section in Customization. If you want to reinstall it, you also need to rerun:

    ./tools/configure.py \
    --certificate=crypto_data/opensk_cert.pem \
    --private-key=crypto_data/opensk.key

Initial setup

To clone and setup the repository for the develop branch, run the following commands:

git clone -b develop https://github.com/google/OpenSK.git
cd OpenSK
./setup.sh

The setup script performs the following steps:

  1. Make sure that the git submodules are checked out.

  2. Apply our patches that haven't yet been merged upstream to both Tock and libtock-rs.

  3. Generate crypto material, see Customization for details.

  4. Install the correct Rust toolchain for ARM devices.

  5. Install tockloader.

Additionally on Linux, you need to install a udev rule file to allow non-root users to interact with OpenSK devices. To install it, execute:

sudo cp rules.d/55-opensk.rules /etc/udev/rules.d/
sudo udevadm control --reload

Then, you need and replug the device for the rule to trigger.

Last, if you want to use U2F or attestation, configure the certificate. If your client does not support FIDO2 yet, this step is mandatory for your OpenSK to work. OpenSK is incompatible with some browsers without a certificate. Please read the certificate section in Customization for understand privacy tradeoffs.

./tools/configure.py \
    --certificate=crypto_data/opensk_cert.pem \
    --private-key=crypto_data/opensk.key

Flashing a firmware

From here on, please follow the instructions for your hardware:

Advanced installation

We recommend that you flash your development board with JTAG and dongles with DFU, as described in the board documentation linked above. However, we support other programmers:

  • OpenOCD: ./deploy.py --board=nrf52840_dongle_opensk --opensk --programmer=openocd
  • pyOCD: ./deploy.py --board=nrf52840_dongle_opensk --opensk --programmer=pyocd
  • Custom: ./deploy.py --board=nrf52840_dongle_opensk --opensk --programmer=none. In this case, an IntelHex file will be created and how to program a board is left to the user.

If your board is already flashed with Tock OS, you may skip installing it: ./deploy.py --board=nrf52840dk_opensk --opensk --no-tockos

For more options, we invite you to read the help of our deploy.py script by running ./deploy.py --help.

Upgradability

We experiment with a new CTAP command to allow upgrading your device without access to its debugging port. For that purpose, the flash storage is split into 4 parts:

  • the bootloader to decide with partition to boot
  • firmware partition A
  • firmware partition B
  • the persistent storage for credentials

The storage is backward compatible to non-upgradable boards. Deploying an upgradable board automatically installs the bootloader. Please keep in mind that you have to safely store your private signing key for upgrades if you want to use this feature. For more information on the cryptographic material, see Customization.

So far, upgradability is only supported for the development board. See the instructions on the board specific page.