AtHeartEngineer/specs
1
0
Fork 0
mirror of https://github.com/vacp2p/specs.git synced 2026-01-09 23:37:55 -05:00
Code Issues Packages Projects Releases Wiki Activity

PR suggestions, formatting, clarification

Browse Source
This commit is contained in:
protolambda
2020-09-24 18:37:56 +02:00
parent df4e932851
commit e4eb5ee113
2 changed files with 41 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
pubsub/README.md
View File

@@ -153,17 +153,18 @@ and
Messages can be optionally signed, and it is up to the peer whether to accept and forward
unsigned messages.
When the receiver expects unsigned content-based messages, and thus does not expect
The default choice of origin-stamped messaging, the receiver should enforce signatures strictly (`StrictSign`).
When the receiver expects unsigned content-stamped messages, and thus does not expect
the `from`, `seqno`, `signature`, or `key` fields, it may reject the messages (`StrictNoSign`).
And if not, the receiver may choose to enforce signatures strictly (`StrictSign`).
This optionality is configurable with the signing policy options starting from `v1.1`.
This optionality is configurable with the signature policy options starting from gossipsub v1.1.
For signing purposes, the `signature` and `key` fields are used:
- The `signature` field contains the signature.
- The `key` field contains the signing key when it cannot be inlined in the source peer ID.
When present, it must match the peer ID.
The signature is computed over the marshalled message protobuf _excluding_ the key field.
The signature is computed over the marshalled message protobuf _excluding_ the `signature` field itself.
This includes any fields that are not recognized, but still included in the marshalled data.
The protobuf blob is prefixed by the string `libp2p-pubsub:` before signing.