diff --git a/README.adoc b/README.adoc index ed38895..e0d0f2a 100644 --- a/README.adoc +++ b/README.adoc @@ -20,8 +20,10 @@ Last rendered {localdatetime} :docinfo: shared :this_protover: 1 :this_protover_hex: 0x00000001 -:lib_ver: master -:lib_ver_ref: branch +//:lib_ver: master +//:lib_ver_ref: branch +:lib_ver: 1.0.0 +:lib_ver_ref: tag [id="license"] == License @@ -50,45 +52,61 @@ NOTE: In the event of the embedded text in this document differing from the onli [id="proto"] == Protocol -The WireProto data packing API is a custom wire protocol//message format designed for incredibly performant, unambiguous, predictable, platform-agnostic, client-agnostic communication. It is based heavily on the https://github.com/openssh/openssh-portable/blob/master/PROTOCOL.key[OpenSSH "v1" key format^] https://git.r00t2.io/r00t2/go_sshkeys/src/branch/master/_ref/KEY_GUIDE.html#v1_plain_2[(example/details)] packing method. +The WireProto data packing API is a custom wire protocol//message format designed for incredibly performant, unambiguous, predictable, platform-agnostic, implementation-agnostic communication. It is based heavily on the https://github.com/openssh/openssh-portable/blob/master/PROTOCOL.key[OpenSSH "v1" key format^] https://git.r00t2.io/r00t2/go_sshkeys/src/branch/master/_ref/KEY_GUIDE.html#v1_plain_2[(example/details)] packing method. It supports arbitrary binary values, which means they can be anything according to the implementation-specific details; a common practice is to encode ("marshal") a Go struct to JSON bytes, and set that as a WireProto field's value. It supports both static construction/parsing/dissection and stream approaches in a single format, as well as multiple commands per request message/multiple answers per response message. -*All* packed uint32 values are big-endian. +*All* packed uint32 (_unsigned 32-bit integer_) values are a https://en.wikipedia.org/wiki/Endianness[big-endian^] 4-byte sequence (e.g. `3712599402` == `0xdd49c56a`, or [`0xdd`, `0x49`, `0xc5`, `0x6a`]). -This specification <> is `{this_protover}` (`{this_protover_hex}`). +This specification's <> is `{this_protover}` (`{this_protover_hex}`). + +For other releases/finalized versions of this specification, see https://git.r00t2.io/r00t2/WireProto/tags[here^]. + +For in-development versions, drafts, etc. of this specification, see https://git.r00t2.io/r00t2/WireProto/branches[here^]. + +[id="proto_reqresp"] +=== Requests/Responses +WireProto indicates two types of Messages/communication ends: a _Requester_ (_Requesting End_) and a _Responder_ (_Responding End_). + +This terminology is intentionally implementation-agnostic. A _Requester_ is any end of a communication that is *requesting data*, and the _Responder_ is any end of a communication that is *providing that data*. A Responder may not always be present (e.g. in the case of using WireProto for local disk serialization/caching, etc.), and a "client" may be a Requester, Responder, or both -- likewise for a "server". [id="lib"] -=== Library -This protocol specification is accompanied with a reference library for Golang, https://git.r00t2.io/r00t2/go_wireproto["WireProto"^] (https://git.r00t2.io/r00t2/wireproto[_source_^]): +=== Reference Library +The WireProto specification is accompanied by a reference library for Golang, https://git.r00t2.io/r00t2/go_wireproto["WireProto"^] (https://git.r00t2.io/r00t2/wireproto[_source_^]): ++++ Go Reference +
+
++++ +Additional reference libraries may be available in the future. + [id="ytho"] -=== Why a Custom Message Format? -Because existing ones (e.g. JSON, XML, YAML) are slow/bloaty, inaccurate, and/or inflexible. They struggle with binary or abritrary data (or in e.g. XML's case requiring intermediate conditional encoding/decoding). +=== Why Yet Another Message Format? +Because existing methods of serializing data in a structured way (e.g. JSON, XML, YAML) are slow/bloaty, inaccurate, and/or inflexible. They struggle with binary or abritrary data (or in e.g. XML's case requiring intermediate conditional encoding/decoding). If it can be represented as bytes (which all digital data can), WireProto can send and receive it. Additionally: -* https://protobuf.dev/[*Protobuf*^] has performance issues (yes, really; protobufs have large overhead) and is restrictive on data types for future-proofing. +* https://protobuf.dev/[*Protobuf*^] has performance issues (yes, really; protobufs have large overhead compared to WireProto) and is restrictive on data types for future-proofing. * https://go.dev/blog/gob[*Gob*^] is very language-limiting and does not support e.g. nil pointers and cyclical values. -* https://capnproto.org/[Cap'n Proto^] has wide language support and excellent performance but is terribly non-idiomatic, requiring the code to be generated from the schema and not vice versa (which is only ideal if you have only one communication interface). -* https://en.wikipedia.org/wiki/JSON_streaming[JSON streams^] have no delimiters defined, and thus this makes it an inconvenience if using a parser that does not know when the message ends/is complete, or if it is expecting a standalone JSON object. +* https://capnproto.org/[Cap'n Proto^] has wide language support and excellent performance but is terribly non-idiomatic, requiring the code to be generated from the schema and not vice versa (which is only ideal if you have only one communication interface and is, in the author's opinion, the entirely incorrect approach). +* https://en.wikipedia.org/wiki/JSON_streaming[JSON streams^] have no delimiters defined which makes it an inconvenience if using a parser that does not know when the message ends/is complete, or if it is expecting a standalone JSON object (e.g. native vanilla Golang JSON parsing). [TIP] ==== WireProto is only used for binary packing/unpacking; this means it can be used with any e.g. https://pkg.go.dev/net#Conn[`net.Conn`^] (and even has helper functions explicitly to facilitate this), storage on-disk, etc. -Thus it is transport/storage-agnostic, and can be used with a https://pkg.go.dev/net#Dial[TCP socket, UDP socket, IPC (InterProcess Communication)/UDS (UNIX Domain Socket) handle,^] https://pkg.go.dev/crypto/tls#Dial[TLS-tunneled TCP socket^], etc. +As such it is transport/storage-agnostic, and can be used with a https://pkg.go.dev/net#Dial[TCP socket, UDP socket, IPC (InterProcess Communication)/UDS (UNIX Domain Socket) handle,^] https://pkg.go.dev/crypto/tls#Dial[TLS-tunneled TCP socket^], etc. + +See the <> for details. ==== [id="msg"] @@ -100,31 +118,31 @@ Throughout this document, you may see references to things like `LF`, `SOH`, and These refer to _ASCII control characters_. You will also see many values represented in hex. -You can find more details about this (along with a full ASCII reference) https://square-r00t.net/ascii.html[here^]. Note that the socket API fully supports UTF-8 -- just be sure that your <> are aligned to the byte count, not character count. +You can find more details about this (along with a full ASCII reference) https://square-r00t.net/ascii.html[here^]. Note that the specification fully supports UTF-8 (or any other arbitrary encoding) -- just be sure that your <> are aligned to the *byte count* and not *character count* (as these may not be equal depending on encoding). ==== -Each *message* is generally composed of: +Each *message* is composed of: * The <>footnote:responly[Response messages only.] -* A <>footnote:optclient[Optional for Request.]footnote:reqsrv[Required for Response.] +* A <>footnote:optreq[Optional for Request.]footnote:reqresp[Required for Response.] * A <> * A <> +* A <> * A <> <> * A <> <> -* A <> * One (or more) <>(s), each of which contain: ** One (or more) <>(s), each of which contain: *** One (or more) <>(s), each of which contain: **** A <> **** A <> -**** A <>footnote:responly[] +*** A <>footnote:responly[] * A <> * A <> [id="msg_respstatus"] === Response Status -For responses, their messages have an additional byte prepended; a status indicator. -This allows client programs to quickly bail in the case of an error if no further parsing is desired. +For response messages, a speciall "summary byte" is prepended; a status indicator. +This allows requesting ends to quickly bail in the case of an error if no further parsing is desired. The status will be indicated by one of <>: an ASCII `ACK` (`0x06`) for all requests being returned successfully or an ASCII `NAK` (`0x15`) if one or more errors were encountered across all records. @@ -136,7 +154,7 @@ It is maintained seperately from the *library* version/repo tags. The current protocol version (as demonstrated in this document) is `{this_protover}` (`{this_protover_hex}`). -NOTE: Version `0` is reserved for current `HEAD` of the `master` branch of this specification and should be considered experimental. +NOTE: Version `0` is reserved for current `HEAD` of the `master` branch of this specification and should be considered experimental, not conforming to any specific protocol message format version. [id="msg_grp"] === Record Group @@ -150,18 +168,14 @@ Its structure is: [id="msg_grp_rec"] ==== Record -A record contains multiple related <>. It is typical to only have a single Record. +A record contains multiple related <> and, if a Response Record, a copy of the original reference Request Record it is responding to. Its structure is: . <> <> . <> <> -. One (or more) <> - -[IMPORTANT] -==== -For response messages, the record's size allocator (but NOT the count allocator) includes the <> size for each response record copy!footnote:responly[] -==== +.. One (or more) <> +. <> <>footnote:responly[] [id="msg_grp_rec_kv"] ===== Field/Value Pair (Key/Value Pair) @@ -176,16 +190,18 @@ Its structure is: [IMPORTANT] ==== -Unlike most/all other <> for other sections/levels, the field name and value allocators are consecutive <>! This is because there is only one field name and value per record. +Unlike most/all other <> for other sections/levels, the field name and value allocators are consecutive <>! This is because there is *only one* field name and value per <>. ==== [id="msg_grp_rec_kv_nm"] ====== Field Name -The field name is usually from a finite set of allowed names. The <>, while written as bytes, often contains a data structure defined by the field name. (A field name is closer to a "value type".) It *must* be a UTF-8 string. +The field name is usually from a finite set of allowed names. The <>, while written as bytes, often contains data defined by the field name. (That is, the parsing of <> often depends on its Field Name.) It is recommended that the field name be a UTF-8-compatible string for simplified serializing and https://www.wireshark.org/[on-the-wire debugging^]. + +While there is no technical requirement that a field name be unique per-<>, it is generally recommended (unless emulating/encoding arrays of data in separate <>). Its structure is: -. The name in bytes +. A name/identifier in bytes [id="msg_grp_rec_kv_val"] ====== Field Value @@ -193,60 +209,50 @@ A field's value is, on the wire, just a series of bytes. The actual content of t Its structure is: -. The value in bytes +. A value in bytes [id="msg_grp_recresp"] -===== Copy Record (Response Copy of Request) -This contains a "copy" of the original/request's <> that this record is in response to. +===== Copy of Original Record +This contains a "copy" of the original/request's <> that this record is in response to. It is only present in Response message and must not be included in Request messages. -It is a variant of a <> used exclusively in responses, and is tied to (included in) each response's <>. +It is a complete <> from the request embedded inside the responding Record. -Its structure is: +For example, if a record contains multiple <> specifying a query of some data then the response record will contain a copy of that record's query data. -. <> <> -. <> <> -. One (or more) <> - -[id="msg_grp_rec_kvcpy"] -====== Field/Value Pair (Key/Value Pair) (Response Copy) -A field/value pair (also referred to as a key/value pair) contains a matched <> and its <>. - -It is a variant of a <> used exclusively in response copies of the original request's FVP. - -Its structure is: - -. <> <> -. <> <> -. A single <> -. A single matching <> - -[IMPORTANT] +[NOTE] ==== -Unlike most/all other <> for other sections/levels, the field name and value allocators are consecutive <>! This is because there is only one field name and value per record. +While *not recommended*, it *is* within specification/permissible to "alias" a request record via a session-unique identifier (e.g. https://datatracker.ietf.org/doc/html/rfc4122[UUIDv4^]), *provided* the promise that the requesting end retains an identifiable copy of/can lookup or associate its original record based on that identifying alias. + +For example, a requesting end may specify _its own_ provided identifier as an <> (e.g. `identifier:f18231973d08417e877dd1a2f8e8ab74`) along with additional data. The returning Response Record may then include *only* an original/request record with an FVP of `identifier:f18231973d08417e877dd1a2f8e8ab74` along with the requested data. + +Alternatively for another example, a responding end may return a Response Record with an original/request record of a single FVP such as `ref_id:46823da27f8749df9dee8f0bded8cce9` or the like. The requesting end *must* then be able to retrieve the full copy of the original request record as a standalone Response Record based on that `ref_id`. Responding ends *may* enforce lifetimes for request record lookup in this case but they must be promised. ==== [id="cksum"] == Checksums -Checksums are optional for the client but the server will *always* send them. *If present* in the request, the server will validate to ensure the checksum matches the message body (<> to <>, headers included). If the checksum does not match, an error will be returned. +Checksums are optional for the requesting end but the responding end *must* send them. *If present* in the request, the responder *must* validate to ensure the checksum matches the message body (<> to <>, inclusive). If the checksum does not match, an error *must* be returned. They are represented as a big-endian-packed uint32. -The checksum must be prefixed with a <>. If no checksum is provided, this prefix must *not* be included in the sequence. +The checksum must be prefixed with a <>. If no checksum is provided in a request, this prefix *must not* be included in the sequence. [TIP] ==== -You can quickly check if a checksum is present by checking the first byte in requests or the second byte in responses. If it is `ESC` (`0x1b`), a checksum is provided. If it is `SOH` (`0x01`), one was *not* provided. +A responder can quickly check if a checksum is present by checking the first byte in requests. If it is <>, a checksum is provided. If it is <>, one was *not* provided. ==== -The checksum method used is the https://users.ece.cmu.edu/~koopman/crc/crc32.html[IEEE 802.3 CRC-32^], which should be natively available for all/most client implementations as it is perhaps the most ubiquitous of CRC-32 variants. (Polynomial `0x04c11db7`, reversed polynomial `0xedb88320`.) +The checksum method used is the https://users.ece.cmu.edu/~koopman/crc/crc32.html[IEEE 802.3 CRC-32^], which should be natively available for all/most implementations/languages as it is perhaps the most ubiquitous of CRC-32 variants (e.g. https://docs.python.org/3/library/zlib.html#zlib.crc32[Python^], https://pkg.go.dev/hash/crc32[Golang^], https://github.com/gcc-mirror/gcc/blob/master/libiberty/crc32.c[GNU C/glibc^](?), https://crates.io/keywords/crc32[Rust^], etc.). (Polynomial `0x04c11db7`, reversed polynomial `0xedb88320`.) -To confirm you are using the correct CRC32 implementation (as there are a *ton* of "CRC-32" algorithms and methods out there), use the following validations: +If one needs to implement the appropriate CRC32 implementation, there is extensive detail at the https://en.wikipedia.org/wiki/Cyclic_redundancy_check[CRC Wikipedia article^]. + +To confirm the correct CRC32 implementation is being used (as there are *many* "CRC-32" algorithms/methods/functions/libraries), the following validations may be used: .CRC-32 Validations [cols="^.^2m,3m,^.^1m,^.^2m,^.^2m",options="header"] |=== | String ^.^| Bytes | Checksum (integer) | Checksum (bytes, little-endian) | Checksum (bytes, big-endian) +| WireProto | 0x5769726550726f746f | 815806352 | 0x30a03790 | 0x9037a030 | FooBarBazQuux | 0x466f6f42617242617a51757578 | 983022564 | 0xe4bb973a | 0x3a97bbe4 | 0123456789abcdef | 0x30313233343536373839616263646566 | 1757737011 | 0x33f0c468 | 0x68c4f033 |=== @@ -256,36 +262,36 @@ To confirm you are using the correct CRC32 implementation (as there are a *ton* Certain sections are wrapped with an identifying header. Those headers are included below for reference. [id="hdrs_respstart"] -=== `RESPSTART` Byte Sequence +=== `RESPSTART` Indicator Responses have a <>.footnote:responly[] It is either an `ACK` (`0x06`) or `NAK` (`0x15`). [id="hdrs_cksum"] === `CKSUM` Header Prefix -A checksum, if provided, will have a prefix header of `ESC` (`0x1b`). +A <>, if providedfootnote:optreq[]footnote:reqresp[], will have a prefix header of `ESC` (`0x1b`). [id="hdrs_msgstart"] === `MSGSTART` Header Prefix -The message start header indicates a start of a message. +The message start header indicates a start of a "message". It is used to delineate operational headers from specification information (e.g. <>) and data. It is an `SOH` (`0x01`). [id="hdrs_bodystart"] === `BODYSTART` Header Prefix -The body start header indicates that actual data/records follows. +The body start header indicates that data/records follow. All bytes between `BODYSTART` and <> are to be assumed to be directly pertinent to the request/response rather than operational. It is an `STX` (`0x02`). [id="hdrs_bodyend"] === `BODYEND` Sequence -The body end prefix indicates the end of data/records. +The body end prefix indicates the end of data/records. All bytes between <> and `BODYEND` are to be assumed to be directly pertinent to the request/response rather than operational. It is an `ETX` (`0x03`). [id="hdrs_msgend"] === `MSGEND` Sequence -The message end prefix indicates that a message in its entirety has ended. +The message end prefix indicates that a message in its entirety has ended, and if no further communication is necessary per implementation the connection may be disconnected. It is an `EOT` (`0x04`). @@ -293,11 +299,11 @@ It is an `EOT` (`0x04`). == Allocators There are two type of allocators included for each following sequence of bytes: `count allocators` and `size allocators`. -They can be used by clients to determine the size of destination buffers, and are used by the server to efficiently unpack requests. +<> can be used by receiving ends to efficiently pre-allocate buffers and for sending ends to indicate the amount of remaining data expected. -They are usually paired together with the count allocator preceding the size allocator, but not always (e.g. <> have two <>). +They are usually preceded with a <> to allow for pre-allocating e.g. slice/array sizes, but not always (e.g. <> have two <>). -All allocators are unsigned 32-bit integers, little-endian-packed. +All allocators are unsigned 32-bit integers, big-endian-packed. [id="alloc_cnt"] === Count Allocator @@ -305,11 +311,11 @@ Count allocators indicate *how many* children objects are contained. [id="alloc_size"] === Size Allocator -Size allocators indicate *how much* (in bytes) all children objects are combined together. It includes e.g. separators, etc. +Size allocators indicate *how much* (in bytes) all children objects are combined as one block. They include the allocators themselves of child objects, etc. as well. [id="ref"] == Reference Model and Examples -For a more visual explanation, given the following e.g. Golang structs from the https://pkg.go.dev/r00t2.io/wireproto[Golang reference library^] (`wireproto.Request{}` and `wireproto.Response{}`): +For a more visual explanation, given the following e.g. Golang structs from the <> (`wireproto.Request{}` and `wireproto.Response{}`): [id="ref_single"] === Single/Simple @@ -372,7 +378,7 @@ include::docs/data/response.simple.hex[] [id="ref_multi"] === Multiple/Many/Complex -Multiple commands, parameters, etc. can be specified in one message. +Multiple records, record groups, etc. can be specified in one message. [id="ref_multi_req"] ==== Complex Request diff --git a/README.html b/README.html index 433c959..0ee9a73 100644 --- a/README.html +++ b/README.html @@ -632,7 +632,7 @@ pre.rouge .gs {
Brent Saner

-Last rendered 2024-07-07 23:58:11 -0400 +Last rendered 2024-07-09 18:32:40 -0400
Table of Contents
@@ -640,8 +640,9 @@ pre.rouge .gs {
  • 1. License
  • 2. Protocol
  • 3. Message Format @@ -658,11 +659,7 @@ pre.rouge .gs {
  • 3.3.1.1.2. Field Value
    • -
  • 3.3.1.2. Copy Record (Response Copy of Request) - -
    • +
  • 3.3.1.2. Copy of Original Record
    • @@ -672,7 +669,7 @@ pre.rouge .gs {
  • 4. Checksums
  • 5. Headers
      -
    • 5.1. RESPSTART Byte Sequence
      • +
    • 5.1. RESPSTART Indicator
    • 5.2. CKSUM Header Prefix
    • 5.3. MSGSTART Header Prefix
    • 5.4. BODYSTART Header Prefix
      • @@ -1238,7 +1235,7 @@ In the event of the embedded text in this document differing from the online ver

      2. Protocol

      -

      The WireProto data packing API is a custom wire protocol//message format designed for incredibly performant, unambiguous, predictable, platform-agnostic, client-agnostic communication. It is based heavily on the OpenSSH "v1" key format (example/details) packing method.

      +

      The WireProto data packing API is a custom wire protocol//message format designed for incredibly performant, unambiguous, predictable, platform-agnostic, implementation-agnostic communication. It is based heavily on the OpenSSH "v1" key format (example/details) packing method.

      It supports arbitrary binary values, which means they can be anything according to the implementation-specific details; a common practice is to encode ("marshal") a Go struct to JSON bytes, and set that as a WireProto field’s value.

      @@ -1247,25 +1244,45 @@ In the event of the embedded text in this document differing from the online ver

      It supports both static construction/parsing/dissection and stream approaches in a single format, as well as multiple commands per request message/multiple answers per response message.

      -

      All packed uint32 values are big-endian.

      +

      All packed uint32 (unsigned 32-bit integer) values are a big-endian 4-byte sequence (e.g. 3712599402 == 0xdd49c56a, or [0xdd, 0x49, 0xc5, 0x6a]).

      -

      This specification Protocol Version is 1 (0x00000001).

      +

      This specification’s Protocol Version is 1 (0x00000001).

      +
      +
      +

      For other releases/finalized versions of this specification, see here.

      +
      +
      +

      For in-development versions, drafts, etc. of this specification, see here.

      -

      2.1. Library

      +

      2.1. Requests/Responses

      -

      This protocol specification is accompanied with a reference library for Golang, "WireProto" (source):

      +

      WireProto indicates two types of Messages/communication ends: a Requester (Requesting End) and a Responder (Responding End).

      +
      +
      +

      This terminology is intentionally implementation-agnostic. A Requester is any end of a communication that is requesting data, and the Responder is any end of a communication that is providing that data. A Responder may not always be present (e.g. in the case of using WireProto for local disk serialization/caching, etc.), and a "client" may be a Requester, Responder, or both — likewise for a "server".

      +
      +
      +
      +

      2.2. Reference Library

      +
      +

      The WireProto specification is accompanied by a reference library for Golang, "WireProto" (source):

      Go Reference +
      +
      +
      +

      Additional reference libraries may be available in the future.

      +
      -

      2.2. Why a Custom Message Format?

      +

      2.3. Why Yet Another Message Format?

      -

      Because existing ones (e.g. JSON, XML, YAML) are slow/bloaty, inaccurate, and/or inflexible. They struggle with binary or abritrary data (or in e.g. XML’s case requiring intermediate conditional encoding/decoding).

      +

      Because existing methods of serializing data in a structured way (e.g. JSON, XML, YAML) are slow/bloaty, inaccurate, and/or inflexible. They struggle with binary or abritrary data (or in e.g. XML’s case requiring intermediate conditional encoding/decoding).

      If it can be represented as bytes (which all digital data can), WireProto can send and receive it.

      @@ -1276,16 +1293,16 @@ In the event of the embedded text in this document differing from the online ver
      • -

        Protobuf has performance issues (yes, really; protobufs have large overhead) and is restrictive on data types for future-proofing.

        +

        Protobuf has performance issues (yes, really; protobufs have large overhead compared to WireProto) and is restrictive on data types for future-proofing.

      • Gob is very language-limiting and does not support e.g. nil pointers and cyclical values.

      • -

        Cap’n Proto has wide language support and excellent performance but is terribly non-idiomatic, requiring the code to be generated from the schema and not vice versa (which is only ideal if you have only one communication interface).

        +

        Cap’n Proto has wide language support and excellent performance but is terribly non-idiomatic, requiring the code to be generated from the schema and not vice versa (which is only ideal if you have only one communication interface and is, in the author’s opinion, the entirely incorrect approach).

      • -

        JSON streams have no delimiters defined, and thus this makes it an inconvenience if using a parser that does not know when the message ends/is complete, or if it is expecting a standalone JSON object.

        +

        JSON streams have no delimiters defined which makes it an inconvenience if using a parser that does not know when the message ends/is complete, or if it is expecting a standalone JSON object (e.g. native vanilla Golang JSON parsing).

      @@ -1300,7 +1317,10 @@ In the event of the embedded text in this document differing from the online ver

      WireProto is only used for binary packing/unpacking; this means it can be used with any e.g. net.Conn (and even has helper functions explicitly to facilitate this), storage on-disk, etc.

      -

      Thus it is transport/storage-agnostic, and can be used with a TCP socket, UDP socket, IPC (InterProcess Communication)/UDS (UNIX Domain Socket) handle, TLS-tunneled TCP socket, etc.

      +

      As such it is transport/storage-agnostic, and can be used with a TCP socket, UDP socket, IPC (InterProcess Communication)/UDS (UNIX Domain Socket) handle, TLS-tunneled TCP socket, etc.

      +
      +
      +

      See the Reference Library for details.

      @@ -1326,14 +1346,14 @@ In the event of the embedded text in this document differing from the online ver

      These refer to ASCII control characters. You will also see many values represented in hex.

      -

      You can find more details about this (along with a full ASCII reference) here. Note that the socket API fully supports UTF-8 — just be sure that your Size Allocator are aligned to the byte count, not character count.

      +

      You can find more details about this (along with a full ASCII reference) here. Note that the specification fully supports UTF-8 (or any other arbitrary encoding) — just be sure that your size allocators are aligned to the byte count and not character count (as these may not be equal depending on encoding).

      -

      Each message is generally composed of:

      +

      Each message is composed of:

      @@ -1399,8 +1419,8 @@ In the event of the embedded text in this document differing from the online ver

      3.1. Response Status

      -

      For responses, their messages have an additional byte prepended; a status indicator. -This allows client programs to quickly bail in the case of an error if no further parsing is desired.

      +

      For response messages, a speciall "summary byte" is prepended; a status indicator. +This allows requesting ends to quickly bail in the case of an error if no further parsing is desired.

      The status will be indicated by one of two values: an ASCII ACK (0x06) for all requests being returned successfully or an ASCII NAK (0x15) if one or more errors were encountered across all records.

      @@ -1424,7 +1444,7 @@ This allows client programs to quickly bail in the case of an error if no furthe
      Note
      -Version 0 is reserved for current HEAD of the master branch of this specification and should be considered experimental. +Version 0 is reserved for current HEAD of the master branch of this specification and should be considered experimental, not conforming to any specific protocol message format version. @@ -1454,7 +1474,7 @@ Version 0 is reserved for current HEAD of the ma

      3.3.1. Record

      -

      A record contains multiple related Field/Value Pairs (FVP). It is typical to only have a single Record.

      +

      A record contains multiple related Field/Value Pairs (FVP) and, if a Response Record, a copy of the original reference Request Record it is responding to.

      Its structure is:

      @@ -1466,25 +1486,18 @@ Version 0 is reserved for current HEAD of the ma

    • Field/Value Pair (Key/Value Pair) Size Allocator

      -
      • +
      +

      1. One (or more) Field/Value Pairs

      -
      - - - - - -
      -
      Important
      -      		 -
      -

      For response messages, the record’s size allocator (but NOT the count allocator) includes the Copy Record size for each response record copy![1]

      -
      -
      + +
    • +

      Copy of Original Record Size Allocator[1]

      +
      • +
      3.3.1.1. Field/Value Pair (Key/Value Pair)
      @@ -1518,7 +1531,7 @@ Version 0 is reserved for current HEAD of the ma
      -

      Unlike most/all other Allocators for other sections/levels, the field name and value allocators are consecutive Size Allocators! This is because there is only one field name and value per record.

      +

      Unlike most/all other Allocators for other sections/levels, the field name and value allocators are consecutive Size Allocators! This is because there is only one field name and value per Record.

      @@ -1527,7 +1540,10 @@ Version 0 is reserved for current HEAD of the ma
      3.3.1.1.1. Field Name
      -

      The field name is usually from a finite set of allowed names. The Field Value, while written as bytes, often contains a data structure defined by the field name. (A field name is closer to a "value type".) It must be a UTF-8 string.

      +

      The field name is usually from a finite set of allowed names. The Field Value, while written as bytes, often contains data defined by the field name. (That is, the parsing of Field Value often depends on its Field Name.) It is recommended that the field name be a UTF-8-compatible string for simplified serializing and on-the-wire debugging.

      +
      +
      +

      While there is no technical requirement that a field name be unique per-Record, it is generally recommended (unless emulating/encoding arrays of data in separate field/value pairs).

      Its structure is:

      @@ -1535,7 +1551,7 @@ Version 0 is reserved for current HEAD of the ma
      1. -

        The name in bytes

        +

        A name/identifier in bytes

      @@ -1551,72 +1567,38 @@ Version 0 is reserved for current HEAD of the ma
      1. -

        The value in bytes

        +

        A value in bytes

      -
      3.3.1.2. Copy Record (Response Copy of Request)
      +
      3.3.1.2. Copy of Original Record
      -

      This contains a "copy" of the original/request’s Record that this record is in response to.

      +

      This contains a "copy" of the original/request’s Record that this record is in response to. It is only present in Response message and must not be included in Request messages.

      -

      It is a variant of a Record used exclusively in responses, and is tied to (included in) each response’s FVP.

      +

      It is a complete Record from the request embedded inside the responding Record.

      -

      Its structure is:

      +

      For example, if a record contains multiple field/value pairs specifying a query of some data then the response record will contain a copy of that record’s query data.

      -
      -
        -
      1. -

        Field/Value Pair (Key/Value Pair) (Response Copy) Count Allocator

        -
        2. -
      2. -

        Field/Value Pair (Key/Value Pair) (Response Copy) Size Allocator

        -
        3. -
      3. -

        One (or more) Field/Value Pairs (Response Copy)

        -
        4. -
      -
      -
      -
      3.3.1.2.1. Field/Value Pair (Key/Value Pair) (Response Copy)
      -
      -

      A field/value pair (also referred to as a key/value pair) contains a matched Field Name and its Field Value.

      -
      -
      -

      It is a variant of a Field/Value Pair used exclusively in response copies of the original request’s FVP.

      -
      -
      -

      Its structure is:

      -
      -
      -
        -
      1. -

        Field Name Size Allocator

        -
        2. -
      2. -

        Field Value Size Allocator

        -
        3. -
      3. -

        A single Field Name

        -
        4. -
      4. -

        A single matching Field Value

        -
        5. -
      -
      -
      +
      @@ -1627,18 +1609,17 @@ Version 0 is reserved for current HEAD of the ma -

      4. Checksums

      -

      Checksums are optional for the client but the server will always send them. If present in the request, the server will validate to ensure the checksum matches the message body (body start to body end, headers included). If the checksum does not match, an error will be returned.

      +

      Checksums are optional for the requesting end but the responding end must send them. If present in the request, the responder must validate to ensure the checksum matches the message body (BODYSTART Header Prefix to BODYEND Sequence, inclusive). If the checksum does not match, an error must be returned.

      They are represented as a big-endian-packed uint32.

      -

      The checksum must be prefixed with a CKSUM Header Prefix. If no checksum is provided, this prefix must not be included in the sequence.

      +

      The checksum must be prefixed with a CKSUM Header Prefix. If no checksum is provided in a request, this prefix must not be included in the sequence.

      -
      Important
      +
      Note
      -

      Unlike most/all other Allocators for other sections/levels, the field name and value allocators are consecutive Size Allocators! This is because there is only one field name and value per record.

      +

      While not recommended, it is within specification/permissible to "alias" a request record via a session-unique identifier (e.g. UUIDv4), provided the promise that the requesting end retains an identifiable copy of/can lookup or associate its original record based on that identifying alias.

      +
      +
      +

      For example, a requesting end may specify its own provided identifier as an field/value pair (e.g. identifier:f18231973d08417e877dd1a2f8e8ab74) along with additional data. The returning Response Record may then include only an original/request record with an FVP of identifier:f18231973d08417e877dd1a2f8e8ab74 along with the requested data.

      +
      +
      +

      Alternatively for another example, a responding end may return a Response Record with an original/request record of a single FVP such as ref_id:46823da27f8749df9dee8f0bded8cce9 or the like. The requesting end must then be able to retrieve the full copy of the original request record as a standalone Response Record based on that ref_id. Responding ends may enforce lifetimes for request record lookup in this case but they must be promised.
      @@ -1648,17 +1629,20 @@ Version 0 is reserved for current HEAD of the ma
      -

      You can quickly check if a checksum is present by checking the first byte in requests or the second byte in responses. If it is ESC (0x1b), a checksum is provided. If it is SOH (0x01), one was not provided.

      +

      A responder can quickly check if a checksum is present by checking the first byte in requests. If it is CKSUM, a checksum is provided. If it is MSGSTART, one was not provided.
      -

      The checksum method used is the IEEE 802.3 CRC-32, which should be natively available for all/most client implementations as it is perhaps the most ubiquitous of CRC-32 variants. (Polynomial 0x04c11db7, reversed polynomial 0xedb88320.)

      +

      The checksum method used is the IEEE 802.3 CRC-32, which should be natively available for all/most implementations/languages as it is perhaps the most ubiquitous of CRC-32 variants (e.g. Python, Golang, GNU C/glibc(?), Rust, etc.). (Polynomial 0x04c11db7, reversed polynomial 0xedb88320.)

      -

      To confirm you are using the correct CRC32 implementation (as there are a ton of "CRC-32" algorithms and methods out there), use the following validations:

      +

      If one needs to implement the appropriate CRC32 implementation, there is extensive detail at the CRC Wikipedia article.

      +
      +
      +

      To confirm the correct CRC32 implementation is being used (as there are many "CRC-32" algorithms/methods/functions/libraries), the following validations may be used:

      @@ -1680,6 +1664,13 @@ Version 0 is reserved for current HEAD of the ma + + + + + + + @@ -1704,7 +1695,7 @@ Version 0 is reserved for current HEAD of the ma

      Certain sections are wrapped with an identifying header. Those headers are included below for reference.

      -

      5.1. RESPSTART Byte Sequence

      +

      5.1. RESPSTART Indicator

      Responses have a Response Status.[1]

      @@ -1715,13 +1706,13 @@ Version 0 is reserved for current HEAD of the ma

      5.2. CKSUM Header Prefix

      -

      A checksum, if provided, will have a prefix header of ESC (0x1b).

      +

      A checksum, if provided[2][3], will have a prefix header of ESC (0x1b).

      5.3. MSGSTART Header Prefix

      -

      The message start header indicates a start of a message.

      +

      The message start header indicates a start of a "message". It is used to delineate operational headers from specification information (e.g. Protocol Version) and data.

      It is an SOH (0x01).

      @@ -1730,7 +1721,7 @@ Version 0 is reserved for current HEAD of the ma

      5.4. BODYSTART Header Prefix

      -

      The body start header indicates that actual data/records follows.

      +

      The body start header indicates that data/records follow. All bytes between BODYSTART and BODYEND are to be assumed to be directly pertinent to the request/response rather than operational.

      It is an STX (0x02).

      @@ -1739,7 +1730,7 @@ Version 0 is reserved for current HEAD of the ma

      5.5. BODYEND Sequence

      -

      The body end prefix indicates the end of data/records.

      +

      The body end prefix indicates the end of data/records. All bytes between BODYSTART and BODYEND are to be assumed to be directly pertinent to the request/response rather than operational.

      It is an ETX (0x03).

      @@ -1748,7 +1739,7 @@ Version 0 is reserved for current HEAD of the ma

      5.6. MSGEND Sequence

      -

      The message end prefix indicates that a message in its entirety has ended.

      +

      The message end prefix indicates that a message in its entirety has ended, and if no further communication is necessary per implementation the connection may be disconnected.

      It is an EOT (0x04).

      @@ -1763,13 +1754,13 @@ Version 0 is reserved for current HEAD of the ma

      There are two type of allocators included for each following sequence of bytes: count allocators and size allocators.

      -

      They can be used by clients to determine the size of destination buffers, and are used by the server to efficiently unpack requests.

      +

      Size allocators can be used by receiving ends to efficiently pre-allocate buffers and for sending ends to indicate the amount of remaining data expected.

      -

      They are usually paired together with the count allocator preceding the size allocator, but not always (e.g. Field/Value Pair (Key/Value Pair) have two Size Allocator).

      +

      They are usually preceded with a count allocator to allow for pre-allocating e.g. slice/array sizes, but not always (e.g. field/value pairs have two size allocators).

      -

      All allocators are unsigned 32-bit integers, little-endian-packed.

      +

      All allocators are unsigned 32-bit integers, big-endian-packed.

      6.1. Count Allocator

      @@ -1780,7 +1771,7 @@ Version 0 is reserved for current HEAD of the ma

      6.2. Size Allocator

      -

      Size allocators indicate how much (in bytes) all children objects are combined together. It includes e.g. separators, etc.

      +

      Size allocators indicate how much (in bytes) all children objects are combined as one block. They include the allocators themselves of child objects, etc. as well.

      @@ -1789,7 +1780,7 @@ Version 0 is reserved for current HEAD of the ma

      7. Reference Model and Examples

      -

      For a more visual explanation, given the following e.g. Golang structs from the Golang reference library (wireproto.Request{} and wireproto.Response{}):

      +

      For a more visual explanation, given the following e.g. Golang structs from the Reference Library (wireproto.Request{} and wireproto.Response{}):

      7.1. Single/Simple

      @@ -1890,7 +1881,7 @@ Version 0 is reserved for current HEAD of the ma // RESPONSE (Simple) testSimpleResp *Response = &Response{ Status: AsciiACK, - Checksum: 4005376897, // 0xeebd3381 + Checksum: 3472688928, // 0xcefd0720 ProtocolVersion: ProtoVersion, RecordGroups: []*ResponseRecordGroup{ &ResponseRecordGroup{ @@ -1924,7 +1915,7 @@ Version 0 is reserved for current HEAD of the ma 
      // RESPONSE (Simple)
 06         // HDR:RESPSTART      (Status: OK)
 1b         // HDR:CKSUM
-5fde82e5   // Checksum Value     (1608418021)
+cefd0720   // Checksum Value     (3472688928)
 01         // HDR:MSGSTART
 00000001   // Protocol Version   (1)
 02         // HDR:BODYSTART
@@ -1967,7 +1958,7 @@ Version 0 is reserved for current HEAD of the ma
      -
      061b5fde82e501000000010200000001000000610000000100000059000000010000001d00000030
+
      061bcefd072001000000010200000001000000610000000100000059000000010000001d00000030
 000000050000001064617461313c61726269747261727920646174613e0000000200000028000000
 06000000066669656c643176616c75653100000006000000066669656c643276616c7565320304
      @@ -1977,7 +1968,7 @@ Version 0 is reserved for current HEAD of the ma

      7.2. Multiple/Many/Complex

      -

      Multiple commands, parameters, etc. can be specified in one message.

      +

      Multiple records, record groups, etc. can be specified in one message.

      7.2.1. Complex Request

      @@ -2163,7 +2154,7 @@ Version 0 is reserved for current HEAD of the ma // RESPONSE (Complex) testMultiResp *Response = &Response{ Status: AsciiACK, - Checksum: 2563794802, // 98d06772 + Checksum: 2928197330, // 0xae88bed2 ProtocolVersion: ProtoVersion, RecordGroups: []*ResponseRecordGroup{ &ResponseRecordGroup{ @@ -2228,7 +2219,7 @@ Version 0 is reserved for current HEAD of the ma 
      // RESPONSE (Complex)
 06         // HDR:RESPSTART      (Status: OK)
 1b         // HDR:CKSUM
-d0ba719f   // Checksum Value     (3501879711)
+ae88bed2   // Checksum Value     (2928197330)
 01         // HDR:MSGSTART
 00000001   // Protocol Version   (1)
 02         // HDR:BODYSTART
@@ -2343,7 +2334,7 @@ d0ba719f   // Checksum Value     (3501879711)
      -
      061bd0ba719f010000000102000000020000019800000002000000c4000000010000001e00000038
+
      061bae88bed2010000000102000000020000019800000002000000c4000000010000001e00000038
 00000006000000106461746141313c61726269747261727920646174613e00000002000000300000
 0008000000086669656c6441314176616c756541314100000008000000086669656c644131427661
 6c7565413142000000010000001e0000003800000006000000106461746141323c61726269747261
@@ -2375,7 +2366,7 @@ d0ba719f   // Checksum Value     (3501879711)
      diff --git a/docs/data/parse.py b/docs/data/parse.py index 1894a3d..a03bb0f 100755 --- a/docs/data/parse.py +++ b/docs/data/parse.py @@ -6,8 +6,10 @@ ################################################################################################################################ import binascii +import os import pathlib import re +import sys import zlib prefixes = ('request', 'response') @@ -17,6 +19,8 @@ linecharlimit = 80 linestrp = re.compile(r'^\s*(?P[A-Fa-f0-9N]+)?(?:\s*//.*)?$') thisdir = pathlib.Path(__file__).absolute().parent +is_tty = os.isatty(sys.stdout.fileno()) + def parse(text): ret = [] @@ -57,6 +61,7 @@ for p in prefixes: repr_split = [] for i in range(0, len(repr), 16): repr_split.append(repr[i:i + 16]) - print(fnamebase) - for i in repr_split: - print(', '.join(i), end = ',\n') + if is_tty: + print(fnamebase) + for i in repr_split: + print(', '.join(i), end = ',\n') diff --git a/docs/data/response.multi.hex b/docs/data/response.multi.hex index d26186d..5d68be4 100644 --- a/docs/data/response.multi.hex +++ b/docs/data/response.multi.hex @@ -1,4 +1,4 @@ -061bd0ba719f010000000102000000020000019800000002000000c4000000010000001e00000038 +061bae88bed2010000000102000000020000019800000002000000c4000000010000001e00000038 00000006000000106461746141313c61726269747261727920646174613e00000002000000300000 0008000000086669656c6441314176616c756541314100000008000000086669656c644131427661 6c7565413142000000010000001e0000003800000006000000106461746141323c61726269747261 diff --git a/docs/data/response.multi.txt b/docs/data/response.multi.txt index fcf7611..4260b5a 100644 --- a/docs/data/response.multi.txt +++ b/docs/data/response.multi.txt @@ -1,7 +1,7 @@ // RESPONSE (Complex) 06 // HDR:RESPSTART (Status: OK) 1b // HDR:CKSUM -d0ba719f // Checksum Value (3501879711) +ae88bed2 // Checksum Value (2928197330) 01 // HDR:MSGSTART 00000001 // Protocol Version (1) 02 // HDR:BODYSTART diff --git a/docs/data/response.simple.hex b/docs/data/response.simple.hex index ebead29..6840118 100644 --- a/docs/data/response.simple.hex +++ b/docs/data/response.simple.hex @@ -1,3 +1,3 @@ -061b5fde82e501000000010200000001000000610000000100000059000000010000001d00000030 +061bcefd072001000000010200000001000000610000000100000059000000010000001d00000030 000000050000001064617461313c61726269747261727920646174613e0000000200000028000000 06000000066669656c643176616c75653100000006000000066669656c643276616c7565320304 diff --git a/docs/data/response.simple.txt b/docs/data/response.simple.txt index 5f9e441..1a8ff98 100644 --- a/docs/data/response.simple.txt +++ b/docs/data/response.simple.txt @@ -1,7 +1,7 @@ // RESPONSE (Simple) 06 // HDR:RESPSTART (Status: OK) 1b // HDR:CKSUM -5fde82e5 // Checksum Value (1608418021) +cefd0720 // Checksum Value (3472688928) 01 // HDR:MSGSTART 00000001 // Protocol Version (1) 02 // HDR:BODYSTART
      Table 1. CRC-32 Validations

      WireProto

      0x5769726550726f746f

      815806352

      0x30a03790

      0x9037a030

      FooBarBazQuux

      0x466f6f42617242617a51757578

      983022564