Internet-Draft | S-Expressions | August 2023 |
Rivest & Eastlake | Expires 15 February 2024 | [Page] |
This memo describes a data structure called "S-expressions" that are suitable for representing arbitrary, complex data structures. We make precise the encodings of S-expressions: we give a "canonical form" for S-expressions, described two "transport" representations, and also describe an "advanced" format for display to people.¶
This Internet-Draft is submitted in full conformance with the provisions of BCP 78 and BCP 79.¶
Internet-Drafts are working documents of the Internet Engineering Task Force (IETF). Note that other groups may also distribute working documents as Internet-Drafts. The list of current Internet-Drafts is at https://datatracker.ietf.org/drafts/current/.¶
Internet-Drafts are draft documents valid for a maximum of six months and may be updated, replaced, or obsoleted by other documents at any time. It is inappropriate to use Internet-Drafts as reference material or to cite them other than as "work in progress."¶
This Internet-Draft will expire on 15 February 2024.¶
Copyright (c) 2023 IETF Trust and the persons identified as the document authors. All rights reserved.¶
This document is subject to BCP 78 and the IETF Trust's Legal Provisions Relating to IETF Documents (https://trustee.ietf.org/license-info) in effect on the date of publication of this document. Please review these documents carefully, as they describe your rights and restrictions with respect to this document. Code Components extracted from this document must include Revised BSD License text as described in Section 4.e of the Trust Legal Provisions and are provided without warranty as described in the Revised BSD License.¶
S-expressions are data structures for representing complex data. They are either byte-strings ("octet-strings") or lists of simpler S-expressions. Here is a sample S-expression:¶
(snicker "abc" (#03# |YWJj|))¶
It is a list of length three containing the following:¶
This document gives a specific proposal for constructing and utilizing S-expressions. The proposal is independent of any particular application.¶
Here are the design goals for S-expressions:¶
Section 1.1 below has notes of this history of this document. Section 1.2 describes some current uses.¶
Subsequent Sections of this document cover material as follows:¶
The S-expression technology described here was originally developed for "SDSI" (the Simple Distributed Security Infrastructure by Lampson and Rivest [SDSI]) in 1996, although the origins clearly date back to McCarthy's [LISP] programming language. It was further refined and improved during the merger of SDSI and SPKI [SPKI] [RFC2692] [RFC2693] during the first half of 1997. S-expressions are similar to, but more readable and flexible than, Bernstein's "net-strings" [BERN].¶
Although made publicly available as a file named draft-rivest-sexp-00.txt on 4 May 1997, that file was never actually submitted to the IETF. Version -00 of this document was a modernized version of that file. Version -01 had some further polishing and corrections. The further significant changes made in this document were changing the original BNF notation to ABNF [RFC5234] (see Section 7) and changing the default character set in Section 4.6 to UTF-8 [RFC4648].¶
S-expressions are in active use today between GnuPG [GnuPG] and Ribose's RNP [Ribose]. Ribose recently implemented C++ software to compose and parse S-expressions [RNPGP_SEXPP] and, in fact, references this document. The GNU software is here [Libgcrypt].¶
S-expressions are used/referenced in the following RFCs:¶
In addition, S-Expressions are the inspiration for the encodings in other protocols. For example, Section 6 of [CDDLfreezer] or [RFC3259].¶
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in BCP 14 [RFC2119] [RFC8174] when, and only when, they appear in all capitals, as shown here.¶
Informally, an S-expression is either:¶
An octet-string is a finite sequence of eight-bit octets. There may be many different but equivalent ways of representing an octet-string¶
abc -- as a token "abc" -- as a quoted string #616263# -- as a hexadecimal string 3:abc -- as a length-prefixed "verbatim" encoding {MzphYmM=} -- as a base-64 encoding of the verbatim encoding (that is, an encoding of "3:abc") |YWJj| -- as a base-64 encoding of the octet-string "abc"¶
The above encodings are all equivalent; they all denote the same octet string.¶
We will give details of these encodings later on, and also describe how to give a "display type" to a simple string.¶
A list is a finite sequence of zero or more simpler S-expressions. A list is represented by using parentheses to surround the sequence of encodings of its elements, as in:¶
(abc (de #6667#) "ghi jkl")¶
As we see, there is variability possible in the encoding of an S-expression. In some cases, it is desirable to standardize or restrict the encodings; in other cases, it is desirable to have no restrictions. The following are the target cases we aim to handle:¶
These need not be different; in this proposal the canonical encoding is the same as the transport encoding, for example. In this document we propose (related) encoding techniques for each of these uses.¶
We will be describing encodings of S-expressions. Except when giving "verbatim" encodings, the character set used is limited to the following characters in US-ASCII:¶
A B ... Z a b ... z¶
0 1 ... 9¶
space, horizontal tab, vertical tab, form-feed carriage-return, line-feed¶
- hyphen or minus . period / slash _ underscore : colon * asterisk + plus = equal¶
( left parenthesis ) right parenthesis [ left bracket ] right bracket { left brace } right brace | vertical bar # number sign " double quote & ampersand \ backslash¶
! exclamation point % percent ^ circumflex ~ tilde ; semicolon ' apostrophe , comma < less than > greater than ? question mark¶
This section describes in detail the ways in which an octet-string may be represented.¶
We recall that an octet-string is any finite sequence of octets, and that the octet-string may have length zero.¶
A verbatim encoding of an octet string consists of three parts:¶
There are no blanks or whitespace separating the parts. No "escape sequences" are interpreted in the octet string. This encoding is also called a "binary" or "raw" encoding.¶
Here are some sample verbatim encodings:¶
3:abc 7:subject 4::::: 12:hello world! 10:abcdefghij 0:¶
The quoted-string representation of an octet-string consists of:¶
The specified length is the length of the resulting string after any escape sequences have been handled. The string does not have any "terminating NULL" that [C] includes, and the length does not count such a character.¶
The length is optional.¶
The escape conventions within the quoted string are as follows (these follow the "C" [C] programming language conventions, with an extension for ignoring line terminators of just LF, CRLF, or LFCR and more restrictive octal and hexadecimal value formats):¶
\a -- audible alert (bell) \b -- backspace \t -- horizontal tab \v -- vertical tab \n -- new-line \f -- form-feed \r -- carriage-return \" -- double-quote \' -- single-quote \? -- question mark \\ -- back-slash \ooo -- character with octal value ooo (all three digits MUST be present) \xhh -- character with hexadecimal value hh (both digits MUST be present) \<carriage-return> -- causes carriage-return to be ignored. \<line-feed> -- causes linefeed to be ignored. \<carriage-return><line-feed> -- causes CRLF to be ignored. \<line-feed><carriage-return> -- causes LFCR to be ignored.¶
Here are some examples of quoted-string encodings:¶
"subject" "hi there" 7"subject" 3"\n\n\n" "This has\n two lines." "This has \ one." ""¶
An octet string that meets the following conditions may be given directly as a "token".¶
- . / _ : * + =¶
(Note: upper and lower case are not equivalent.)¶
(Note: A token may begin with punctuation, including ":").¶
Here are some examples of token representations:¶
subject not-before class-of-1997 //microsoft.com/names/smith *¶
An octet-string may be represented with a hexadecimal encoding consisting of:¶
There may be whitespace inserted in the midst of the hexadecimal encoding arbitrarily; it is ignored. It is an error to have characters other than whitespace and hexadecimal digits.¶
Here are some examples of hexadecimal encodings:¶
#616263# -- represents "abc" 3#616263# -- also represents "abc" # 616 263 # -- also represents "abc"¶
An octet-string may be represented in a base-64 coding [RFC4648] consisting of:¶
The base-64 encoding uses only the characters¶
A-Z a-z 0-9 + / =¶
It produces four characters of output for each three octets of input. If the input has one or two left-over octets of input, it produces an output block of length four ending in two or one equals signs, respectively. Output routines compliant with this standard MUST output the equals signs as specified. Input routines MAY accept inputs where the equals signs are dropped.¶
There may be whitespace inserted in the midst of the base-64 encoding arbitrarily; it is ignored. It is an error to have characters other than whitespace and base-64 characters.¶
Here are some examples of base-64 encodings:¶
|YWJj| -- represents "abc" | Y W J j | -- also represents "abc" 3|YWJj| -- also represents "abc" |YWJjZA==| -- represents "abcd" |YWJjZA| -- also represents "abcd"¶
Any octet string may be preceded by a single "display hint".¶
The purposes of the display hint is to provide information on how to display the octet string to a user. It has no other function. Many of the MIME [RFC2046] types work here.¶
A display-hint is an octet string surrounded by square brackets. There may be whitespace separating the octet string from the surrounding brackets. Any of the legal formats may be used for the octet string.¶
Here are some examples of display-hints:¶
[image/gif] [URI] [charset=unicode-1-1] [text/richtext] ["text/plain; charset=iso-8859-1"] [application/postscript] [audio/basic] ["http://abc.com/display-types/funky.html"]¶
In applications an octet-string that is untyped may be considered to have a pre-specified "default" MIME [RFC2046] type. The MIME type¶
"text/plain; charset=utf-8"¶
is the standard default.¶
Two octet strings are considered to be "equal" if and only if they have the same display hint and the same data octet strings.¶
Note that octet-strings are "case-sensitive"; the octet-string "abc" is not equal to the octet-string "ABC".¶
An untyped octet-string can be compared to another octet-string (typed or not) by considering it as a typed octet-string with the default mime-type specified in Section 4.6 .¶
Just as with octet-strings, there are several ways to represent a list. Whitespace may be used to separate list elements, but they are only required to separate two octet strings when otherwise the two octet strings might be interpreted as one, as when one token follows another. Also, whitespace may follow the initial left parenthesis, or precede the final right parenthesis.¶
Here are some examples of encodings of lists:¶
(a b c) ( a ( b c ) ( ( d e ) ( e f ) ) ) (11:certificate(6:issuer3:bob)(7:subject5:alice)) ({ODpFeGFtcGxlIQ==} "1997" murphy 3:XC+)¶
There are three "types" of representations:¶
The first two MUST be supported by any implementation; the last is OPTIONAL.¶
This canonical representation is used for digital signature purposes, transmission, etc. It is uniquely defined for each S-expression. It is not particularly readable, but that is not the point. It is intended to be very easy to parse, to be reasonably economical, and to be unique for any S-expression.¶
The "canonical" form of an S-expression represents each octet-string in verbatim mode, and represents each list with no blanks separating elements from each other or from the surrounding parentheses.¶
Here are some examples of canonical representations of S-expressions:¶
(6:issuer3:bob) (4:icon[12:image/bitmap]9:xxxxxxxxx) (7:subject(3:ref5:alice6:mother))¶
There are two forms of the "basic transport" representation:¶
The transport mechanism is intended to provide a universal means of representing S-expressions for transport from one machine to another.¶
Here are some examples of an S-expression represented in basic transport mode:¶
(1:a1:b1:c) {KDE6YTE6YjE6YykK}¶
The second example above is the same S-expression as the first encoded in base-64.¶
There is a difference between the brace notation for base-64 used here and the || notation for base-64'd octet-strings described above. Here the base-64 contents are converted to octets, and then re-scanned as if they were given originally as octets. With the || notation, the contents are just turned into an octet-string.¶
The "advanced transport" representation is intended to provide more flexible and readable notations for documentation, design, debugging, and (in some cases) user interface.¶
The advanced transport representation allows all of the representation forms described above in Section 4, include quoted strings, base-64 and hexadecimal representation of strings, tokens, representations of strings with omitted lengths, and so on.¶
ABNF is the Augmented Backus-Naur Form for syntax specifications as defined in [RFC5234]. We give separate ABNF's for canonical, basic, and advanced forms of S-expressions. The rules below in all caps are defined in Appendix A of [RFC5234].¶
For canonical transport:¶
sexp = raw / ("(" *sexp ")") raw = decimal ":" *OCTET ; the length followed by a colon and the exact ; number of OCTET indicated by the length decimal = %x30 / (%x31-39 *DIGIT)¶
For basic transport:¶
sexp = canonical / base-64-raw canonical = raw / ("(" *canonical ")") raw = decimal ":" *OCTET ; the length followed by a colon and the exact ; number of OCTET indicated by the length decimal = %x30 / (%x31-39 *DIGIT) base-64-raw = "{" 3*base-64-char "}" base-64-char = ALPHA / DIGIT / "+" / "/" / "="¶
For advanced transport:¶
sexp = *whitespace value *whitespace whitespace = SP / HTAB / vtab / CR / LF / ff vtab = %x0B ; vertical tab ff = %x0C ; form feed value = string / ("(" *(value / whitespace) ")") string = [display] *whitespace simple-string display = "[" *whitespace simple-string *whitespace "]" simple-string = raw / token / base-64 / base-64-raw / hexadecimal / quoted-string raw = decimal ":" *OCTET ; the length followed by a colon and the exact ; number of OCTET indicated by the length decimal = %x30 / (%x31-39 *DIGIT) token = (ALPHA / simple-punc) *(ALPHA / DIGIT / simple-punc) simple-punc = "-" / "." / "/" / "_" / ":" / "*" / "+" / "=" base-64 = [decimal] "|" *(base-64-char / whitespace) "|" base-64-char = ALPHA / DIGIT / "+" / "/" / "=" base-64-raw = [decimal] "{" 1*(base-64-char / whitespace) "}" ; at least 3 base-64-char hexadecimal = [decimal] "#" *(HEXDIG / whitespace) "#" ; even number of hexadecimal digits quoted-string = [decimal] DQUOTE *(printable / escaped) DQUOTE escaped = backslash (%x3F / %x61 / %x62 / %x66 / %x6E / %x72 / %x74 / %x76 / DQUOTE / quote / backslash / 3(%x30-37) / (%x78 2HEXDIG) / CR / LF / (CR LF) / (LF CR)) backslash = %x5C printable = %x21-26 / %x28-7E quote = %x27 ; single quote¶
For processing, the S-expression would typically be parsed and represented in memory in a way that is more amenable to efficient processing. We suggest two alternatives:¶
We only sketch these here, as they are only suggestive. The [SexpCode] code illustrates these styles in more detail.¶
Here there are separate records for simple-strings, strings, and lists. An S-expression of the form ("abc" "de") would require two records for the simple strings, two for the strings, and two for the list elements. This is a fairly conventional representation, and details are omitted here.¶
Here each S-expression is represented as a contiguous array of bytes. The first byte codes the "type" of the S-expression:¶
01 octet-string 02 octet-string with display-hint 03 beginning of list (and 00 is used for "end of list")¶
Each of the three types is immediately followed by a k-byte integer indicating the size (in bytes) of the following representation. Here k is an integer that depends on the implementation, it might be anywhere from 2 to 8, but would be fixed for a given implementation; it determines the size of the objects that can be handled. The transport and canonical representations are independent of the choice of k made by the implementation.¶
Although the lengths of lists are not given in the usual S-expression notations, it is easy to fill them in when parsing; when you reach a right-parenthesis you know how long the list representation was, and where to go back to fill in the missing length.¶
This is represented as follows:¶
01 <length> <octet-string>¶
For example (here k = 2)¶
01 0003 a b c¶
This is represented as follows:¶
02 <length> 01 <length> <octet-string> /* for display-type */ 01 <length> <octet-string> /* for octet-string */¶
For example, the S-expression¶
[gif] #61626364#¶
would be represented as (with k = 2)¶
02 000d 01 0003 g i f 01 0004 61 62 63 64¶
This is represented as¶
03 <length> <item1> <item2> <item3> ... <itemn> 00¶
For example, the list (abc [d]ef (g)) is represented in memory as (with k=2)¶
03 001b 01 0003 a b c 02 0009 01 0001 d 01 0002 e f 03 0005 01 0001 g 00 00¶
At this time there is code available that is intended to read and parse some or all of the various S-expression formats specified here. In particular, see the following likely incomplete list:¶
This document has described S-expressions in general form. Application writers may wish to restrict their use of S-expressions in various ways. Here are some possible restrictions that might be considered:¶
As a pure data representation format, there are few security considerations to S-expressions. A canonical form is required for the reliable verification of digital signatures. This is provided in Section 6.1.¶
This document requires no IANA actions.¶
RFC Editor Note: Please delete this section before publication.¶
This sub-section summarizes significant changes between the original 1997 -00 version of this document and the 2023 -00 version submitted to the IETF.¶
The comments and suggestions of the following are gratefully acknowledged: John Klensin.¶
Special thanks to the following contributor:¶