Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

identify: ASCII-only version strings #491

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions identify/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,12 +94,18 @@ protocol families / networks.

Example value: `/my-network/0.1.0`.

Implementations should discard non-ASCII characters and trim the string
to 64 characters.

### agentVersion

This is a free-form string, identifying the implementation of the peer.
The usual format is `agent-name/version`, where `agent-name` is
the name of the program or library and `version` is its semantic version.

Implementations should discard non-ASCII characters and trim the string
to 64 characters.

### publicKey

This is the public key of the peer, marshalled in binary form as specicfied
Expand All @@ -125,6 +131,9 @@ observable source address.

This is a list of protocols supported by the peer.

Implementations should discard non-ASCII characters and trim each string
to 64 characters.

A node should only advertise a protocol if it's willing to receive inbound
streams on that protocol. This is relevant for asymmetrical protocols. For
example assume an asymmetrical request-response style protocol `foo` where some
Expand Down