[tor-commits] [torspec/master] Bug 19859: Consolidate flag fields into ISO_FIELDS

[nickm at torproject.org]

commit de0ea88236b01363e6259a2e46b53c1300438739
Author: JeremyRand <biolizard89 at gmail.com>
Date:   Fri Oct 11 00:11:52 2019 +0000

    Bug 19859: Consolidate flag fields into ISO_FIELDS
---
 control-spec.txt | 29 +++++++++++++++--------------
 1 file changed, 15 insertions(+), 14 deletions(-)

diff --git a/control-spec.txt b/control-spec.txt
index cb6f274..9817a48 100644
--- a/control-spec.txt
+++ b/control-spec.txt
@@ -2108,10 +2108,7 @@
           [SP "PURPOSE=" Purpose] [SP "SOCKS_USERNAME=" EscapedUsername]
           [SP "SOCKS_PASSWORD=" EscapedPassword]
           [SP "CLIENT_PROTOCOL=" ClientProtocol] SP "NYM_EPOCH=" NymEpoch
-          SP "SESSION_GROUP=" SessionGroup SP "ISO_DESTPORT=" IsoDestPort
-          SP "ISO_DESTADDR=" IsoDestAddr SP "ISO_SOCKSAUTH=" IsoSocksAuth
-          SP "ISO_CLIENTPROTO=" IsoClientProto
-          SP "ISO_CLIENTADDR=" IsoClientAddr
+          SP "SESSION_GROUP=" SessionGroup SP "ISO_FIELDS=" IsoFields
           CRLF
 
       StreamStatus =
@@ -2143,11 +2140,14 @@
        NymEpoch = a nonnegative integer
        SessionGroup = an integer
 
-       IsoDestPort = a Boolean
-       IsoDestAddr = a Boolean
-       IsoSocksAuth = a Boolean
-       IsoClientProto = a Boolean
-       IsoClientAddr = a Boolean
+       IsoFields = a comma-separated list of IsoField values
+
+       IsoField =
+               "CLIENTADDR" /
+               "CLIENTPORT" /
+               "DESTADDR" /
+               "DESTPORT" /
+               the name of a field that is valid for STREAM events
 
   The circuit ID designates which circuit this stream is attached to.  If
   the stream is unattached, the circuit ID "0" is given.  The target
@@ -2228,11 +2228,12 @@
    via the "SessionGroup" option in torrc. (Streams with different session
    groups are isolated on separate circuits.)
 
-   The "ISO_DESTPORT", "ISO_DESTADDR", "ISO_SOCKSAUTH", "ISO_CLIENTPROTO", and
-   "ISO_CLIENTADDR" fields indicate the values of the "IsolateDestPort",
-   "IsolateDestAddr", "IsolateSOCKSAuth", "IsolateClientProtocol", and
-   "IsolateClientAddr" flags for the listener port that a client used to
-   initiate this stream.
+   The "ISO_FIELDS" field indicates the set of STREAM event fields for which
+   stream isolation is enabled for the listener port that a client used to
+   initiate this stream.  The special values "CLIENTADDR", "CLIENTPORT",
+   "DESTADDR", and "DESTPORT", if their correspondingly named fields are not
+   present, refer to the Address and Port components of the "SOURCE_ADDR" and
+   Target fields.
 
 4.1.3. OR Connection status changed