aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNick Mathewson <nickm@torproject.org>2023-11-01 10:32:56 -0400
committerNick Mathewson <nickm@torproject.org>2023-11-01 20:10:12 -0400
commite24ac0e5d13bc83a352ebd72fa8134973b368b0b (patch)
tree7f2126ad82527edb79261e3472a642d1c32919b3
parent1aea91632c6785f42fe045b7f3455d5924749337 (diff)
downloadtorspec-e24ac0e5d13bc83a352ebd72fa8134973b368b0b.tar.gz
torspec-e24ac0e5d13bc83a352ebd72fa8134973b368b0b.zip
Correct description of how BEGIN.FLAGS is sent.
[As noted by dgoulet], C tor's behavior is to omit the FLAGS field entirely if its value is zero. [As noted by dgoulet]: https://gitlab.torproject.org/tpo/core/torspec/-/merge_requests/179#note_2959251
-rw-r--r--spec/tor-spec/opening-streams.md5
1 files changed, 4 insertions, 1 deletions
diff --git a/spec/tor-spec/opening-streams.md b/spec/tor-spec/opening-streams.md
index 5c264cb..a8eebd2 100644
--- a/spec/tor-spec/opening-streams.md
+++ b/spec/tor-spec/opening-streams.md
@@ -10,7 +10,7 @@ and port of the destination host. The payload format is:
```text
ADDRPORT [nul-terminated string]
- FLAGS [4 bytes]
+ FLAGS [4 bytes, optional]
ADDRPORT is made of ADDRESS | ':' | PORT | [00]
```
@@ -28,6 +28,9 @@ The FLAGS value has one or more of the following bits set, where
the MSB of a 4-byte value is the MSB of the first byte, and the LSB
of a 4-byte value is the LSB of its last byte.)
+If FLAGS is absent, its value is 0. Whenever 0 would be sent for
+FLAGS, FLAGS is omitted from the message payload.
+
```text
bit meaning
1 -- IPv6 okay. We support learning about IPv6 addresses and