* Use it in commercial/proprietary/internal works...
* Expand upon/change the specification...
** (As long as it is released under the same Creative Commons license)
As long as you attribute the original (this document). This can be as simple as something like:
====
Based on WireProto version <protocol version> as found at https://wireproto.io/.
====
More details certainly helps, though; you may want to mention the exact date you "forked" it, etc.
Please see the full text as collapsed above or https://creativecommons.org/licenses/by-sa/4.0/legalcode.en[the online version^] of the license for full legal copy.
NOTE: In the event of the embedded text in this document differing from the online version, the online version is assumed to take precedence as the valid license applicable to this work.
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://sshref.dev[(example/details via sshref.dev)^] 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.
This specification's <<proto_ver>> 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".
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_^]):
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).
* 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://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).
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.
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.
You can find more details about this (along with a full ASCII reference) at https://asciiref.dev/[asciiref.dev^]. Note that the specification fully supports UTF-8 (or any other arbitrary encoding) -- just be sure that your <<alloc_size, size allocators>> are aligned to the *byte count* and not *character count* (as these may not be equal depending on encoding).
The status will be indicated by one of <<hdrs_respstart, 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.
[id="proto_ver"]
=== Protocol Version
The protocol version is a packed uint32 that denotes which version of this protocol specification is being used.
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, not conforming to any specific protocol message format version.
A record contains multiple related <<msg_grp_rec_kv, Field/Value Pairs (FVP)>> and, if a Response Record, a copy of the original reference Request Record it is responding to.
Unlike most/all other <<alloc>> for other sections/levels, the field name and value allocators are consecutive <<alloc_size, Size Allocators>>! This is because there is *only one* field name and value per <<msg_grp_rec>>.
The field name is usually from a finite set of allowed names. The <<msg_grp_rec_kv_val>>, while written as bytes, often contains data defined by the field name. (That is, the parsing of <<msg_grp_rec_kv_val>> 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-<<msg_grp_rec>>, it is generally recommended (unless emulating/encoding arrays of data in separate <<msg_grp_rec_kv, field/value pairs>>).
A field's value is, on the wire, just a series of bytes. The actual content of those bytes, including any structure or encoding, is likely to/probably depends on the paired <<msg_grp_rec_kv_nm>>.
This contains a "copy" of the original/request's <<msg_grp_rec>> that this record is in response to. It is only present in Response message and must not be included in Request messages.
For example, if a record contains multiple <<msg_grp_rec_kv, field/value pairs>> specifying a query of some data then the response record will contain a copy of that record's query data.
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 <<msg_grp_rec_kv, 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.
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 (<<hdrs_bodystart>> to <<hdrs_bodyend>>, inclusive). If the checksum does not match, an error *must* be returned.
A responder can quickly check if a checksum is present by checking the first byte in requests. If it is <<hdrs_cksum, `CKSUM`>>, a checksum is provided. If it is <<hdrs_msgstart, `MSGSTART`>>, 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 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`.)
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:
The message start header indicates a start of a "message". It is used to delineate operational headers from specification information (e.g. <<proto_ver>>) and data.
The body start header indicates that data/records follow. All bytes between `BODYSTART` and <<hdrs_bodyend, `BODYEND`>> are to be assumed to be directly pertinent to the request/response rather than operational.
The body end prefix indicates the end of data/records. All bytes between <<hdrs_bodystart, `BODYSTART`>> and `BODYEND` are to be assumed to be directly pertinent to the request/response rather than operational.
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.
<<alloc_size, 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 preceded with a <<alloc_cnt, count allocator>> to allow for pre-allocating e.g. slice/array sizes, but not always (e.g. <<msg_grp_rec_kv, field/value pairs>> have two <<alloc_size, size allocators>>).
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.
