arno/trezor-firmware
1
0
Fork 0
mirror of https://github.com/trezor/trezor-firmware.git synced 2024-12-24 15:28:10 +00:00
Code Issues Releases Wiki Activity

docs/common: add links and fix some typos

Browse Source
This commit is contained in:
Tomas Susanka 2020-02-12 09:45:33 +00:00
parent f947fe97cc
commit b4846e484a
4 changed files with 12 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/SUMMARY.md
View File

@ -17,7 +17,9 @@
- [Memory layout](hardware/model-t/memory.md) - [Memory layout](hardware/model-t/memory.md)
- [Model One](hardware/model-one/index.md) - [Model One](hardware/model-one/index.md)
- [Common](common/index.md) - [Common](common/index.md)
- [Communication](common/communication.md) - [Communication](common/communication/index.md)
- [Sessions](common/communication/sessions.md)
- [Passphrase](common/communication/passphrase.md)
- [Storage](storage/index.md) - [Storage](storage/index.md)
- [Tests](tests/index.md) - [Tests](tests/index.md)
- [CI](tests/ci.md) - [CI](tests/ci.md)

6
docs/common/communication/index.md
View File

@ -7,3 +7,9 @@ We use [Protobuf v2](https://developers.google.com/protocol-buffers/) for host-d
## Definitions ## Definitions
Protobuf messages are defined in the [Common](https://github.com/trezor/trezor-firmware/tree/master/common) project, which is part of this monorepo. This repository is also exported to [trezor/trezor-common](https://github.com/trezor/trezor-common) to be used by third parties, which prefer not to include the whole monorepo. That copy is read-only mirror and all changes are happening in this monorepo. Protobuf messages are defined in the [Common](https://github.com/trezor/trezor-firmware/tree/master/common) project, which is part of this monorepo. This repository is also exported to [trezor/trezor-common](https://github.com/trezor/trezor-common) to be used by third parties, which prefer not to include the whole monorepo. That copy is read-only mirror and all changes are happening in this monorepo.
## Notable topics
- [Sessions](sessions.md)
- [Passphrase](passphrase.md)

4
docs/common/communication/passphrase.md
View File

@ -1,6 +1,6 @@
# Passphrase # Passphrase
As of \[versions TBD\] we have changed how [passphrase](https://wiki.trezor.io/Passphrase) is communicated between the Host and the Device. As of 2.3.0 we have changed how [passphrase](https://wiki.trezor.io/Passphrase) is communicated between the host and the device.
Passphrase is very tightly coupled with _sessions_. The reader is encouraged to read on that topic first in the [sessions.md](sessions.md) section. Passphrase is very tightly coupled with _sessions_. The reader is encouraged to read on that topic first in the [sessions.md](sessions.md) section.
@ -20,7 +20,7 @@ PassphraseAck
In the default Trezor setting, the passphrase is obtained from the Host. Trezor sends a PassphraseRequest message and awaits PassphraseAck as a response. This message contains field `passphrase` to transmit it or it has `on_device` boolean flag to indicate that the user wishes to enter the passphrase on Trezor instead. Setting both `passphrase` and `on_device` to true is forbidden. In the default Trezor setting, the passphrase is obtained from the Host. Trezor sends a PassphraseRequest message and awaits PassphraseAck as a response. This message contains field `passphrase` to transmit it or it has `on_device` boolean flag to indicate that the user wishes to enter the passphrase on Trezor instead. Setting both `passphrase` and `on_device` to true is forbidden.
Note that this has changed as of TBD. In previous firmware versions the `on_device` flag was in the PassphraseRequest message, since this decision has been made on Trezor. We also had two additional messages PassphraseStateRequest and PassphraseStateAck which were removed. Note that this has changed as of 2.3.0. In previous firmware versions the `on_device` flag was in the PassphraseRequest message, since this decision has been made on Trezor. We also had two additional messages PassphraseStateRequest and PassphraseStateAck which were removed.
## Example ## Example

2
docs/common/index.md
View File

@ -8,7 +8,7 @@ JSON coin definitions and support tables.
## Protobuf Definitions ## Protobuf Definitions
Common Protobuf definitions for the Trezor protocol. Common Protobuf definitions for the Trezor protocol. Also see [Communication](communication/index.md).
## Tools ## Tools