trezor-firmware/README.md

# TREZOR Firmware

[![Build Status](https://travis-ci.org/trezor/trezor-mcu.svg?branch=master)](https://travis-ci.org/trezor/trezor-mcu) [![gitter](https://badges.gitter.im/trezor/community.svg)](https://gitter.im/trezor/community)

https://trezor.io/

## How to build TREZOR firmware?

1. <a href="https://docs.docker.com/engine/installation/">Install Docker</a>
2. `git clone https://github.com/trezor/trezor-mcu.git`
3. `cd trezor-mcu`
4. `./build-firmware.sh TAG` (where TAG is v1.5.0 for example, if left blank the script builds latest commit in master branch)

This creates file `build/trezor-TAG.bin` and prints its fingerprint and size at the end of the build log.

## How to build TREZOR bootloader?

1. <a href="https://docs.docker.com/engine/installation/">Install Docker</a>
2. `git clone https://github.com/trezor/trezor-mcu.git`
3. `cd trezor-mcu`
4. `./build-bootloader.sh TAG` (where TAG is bl1.3.2 for example, if left blank the script builds latest commit in master branch)

This creates file `build/bootloader-TAG.bin` and prints its fingerprint and size at the end of the build log.

## How to get fingerprint of firmware signed and distributed by SatoshiLabs?

1. Pick version of firmware binary listed on https://wallet.trezor.io/data/firmware/releases.json
2. Download it: `wget -O trezor.signed.bin https://wallet.trezor.io/data/firmware/trezor-1.3.6.bin`
3. Compute fingerprint: `tail -c +257 trezor.signed.bin | sha256sum`

Step 3 should produce the same sha256 fingerprint like your local build (for the same version tag). Firmware has a special header (of length 256 bytes) holding signatures themselves, which must be avoided while calculating the fingerprint, that's why tail command has to be used.

## How to install custom built firmware?

**WARNING: This will erase the recovery seed stored on the device! You should never do this on TREZOR that contains coins!**

1. Install python-trezor: `pip install trezor` (<a href="https://github.com/trezor/python-trezor">more info</a>)
2. `trezorctl firmware_update -f build/trezor-TAG.bin`
update readme 2016-05-11 19:07:56 +00:00			`# TREZOR Firmware`
simplify Dockerfile, add travis CI 2015-08-05 14:38:53 +00:00
update readme 2016-05-11 19:07:56 +00:00			`[![Build Status](https://travis-ci.org/trezor/trezor-mcu.svg?branch=master)](https://travis-ci.org/trezor/trezor-mcu) [![gitter](https://badges.gitter.im/trezor/community.svg)](https://gitter.im/trezor/community)`
simplify Dockerfile, add travis CI 2015-08-05 14:38:53 +00:00
update readme 2017-01-10 14:14:29 +00:00			`https://trezor.io/`
simplify Dockerfile, add travis CI 2015-08-05 14:38:53 +00:00
update readme 2016-05-11 19:07:56 +00:00			`## How to build TREZOR firmware?`
simplify Dockerfile, add travis CI 2015-08-05 14:38:53 +00:00
bootloader autobuild in docker 2016-02-18 23:24:33 +00:00			`1. <a href="https://docs.docker.com/engine/installation/">Install Docker</a>`
simplify Dockerfile, add travis CI 2015-08-05 14:38:53 +00:00			2. `git clone https://github.com/trezor/trezor-mcu.git`
			3. `cd trezor-mcu`
build: rework docker build scripts, update readme 2017-07-24 17:44:10 +00:00			4. `./build-firmware.sh TAG` (where TAG is v1.5.0 for example, if left blank the script builds latest commit in master branch)
simplify Dockerfile, add travis CI 2015-08-05 14:38:53 +00:00
build: rework docker build scripts, update readme 2017-07-24 17:44:10 +00:00			This creates file `build/trezor-TAG.bin` and prints its fingerprint and size at the end of the build log.
simplify Dockerfile, add travis CI 2015-08-05 14:38:53 +00:00
update readme 2016-05-11 19:07:56 +00:00			`## How to build TREZOR bootloader?`
bootloader autobuild in docker 2016-02-18 23:24:33 +00:00
			`1. <a href="https://docs.docker.com/engine/installation/">Install Docker</a>`
			2. `git clone https://github.com/trezor/trezor-mcu.git`
			3. `cd trezor-mcu`
build: rework docker build scripts, update readme 2017-07-24 17:44:10 +00:00			4. `./build-bootloader.sh TAG` (where TAG is bl1.3.2 for example, if left blank the script builds latest commit in master branch)
bootloader autobuild in docker 2016-02-18 23:24:33 +00:00
build: rework docker build scripts, update readme 2017-07-24 17:44:10 +00:00			This creates file `build/bootloader-TAG.bin` and prints its fingerprint and size at the end of the build log.
bootloader autobuild in docker 2016-02-18 23:24:33 +00:00
update readme 2016-05-11 19:07:56 +00:00			`## How to get fingerprint of firmware signed and distributed by SatoshiLabs?`
simplify Dockerfile, add travis CI 2015-08-05 14:38:53 +00:00
update readme 2017-01-10 14:14:29 +00:00			`1. Pick version of firmware binary listed on https://wallet.trezor.io/data/firmware/releases.json`
			2. Download it: `wget -O trezor.signed.bin https://wallet.trezor.io/data/firmware/trezor-1.3.6.bin`
build: rework docker build scripts, update readme 2017-07-24 17:44:10 +00:00			3. Compute fingerprint: `tail -c +257 trezor.signed.bin \| sha256sum`
simplify Dockerfile, add travis CI 2015-08-05 14:38:53 +00:00
build: rework docker build scripts, update readme 2017-07-24 17:44:10 +00:00			`Step 3 should produce the same sha256 fingerprint like your local build (for the same version tag). Firmware has a special header (of length 256 bytes) holding signatures themselves, which must be avoided while calculating the fingerprint, that's why tail command has to be used.`
add installation info to readme 2017-12-10 22:40:06 +00:00
			`## How to install custom built firmware?`

			`WARNING: This will erase the recovery seed stored on the device! You should never do this on TREZOR that contains coins!`

fix typo 2017-12-10 22:40:47 +00:00			1. Install python-trezor: `pip install trezor` (<a href="https://github.com/trezor/python-trezor">more info</a>)
add installation info to readme 2017-12-10 22:40:06 +00:00			2. `trezorctl firmware_update -f build/trezor-TAG.bin`