51 KiB
Changelog
All notable changes to this module are documented here. The project follows
semantic versioning; v0.x versions make no API stability promise.
Unreleased — specification v0.12 draft
Implements the draft v0.12 of the DateKeys Protocol Specification, on the
branch v0.12 and not approved yet. It fixes what the review of the
implementation of v0.11 found on 2 October 2026, and changes no format: a
reader of v0.11 opens these capsules, and this one opens those of v0.11.
SpecVersion stays 0.11 until the author approves the draft.
- Review of 2 October. Six adversarial reviews of the implementation of
v0.11 found nothing blocking: what is signed, the strict Ed25519, the CMS
and RFC 3161 checks and the envelope hold, and the failures were at the
edges. What the text of v0.11 already asked for is fixed in the code, as
this entry says; what it left open or got wrong goes to the draft.
- A typed nil in
EncryptOptions.AuthorKey,CMSSignerorSealeris an error, never a capsule without the signature or the seal that was asked for. - A panic while evaluating the signature or the seal fails only that part, F1 or S2, not both.
OpenOptions.Acceptsees the verdicts after step 17 and before step 18, and can refuse to publish the files.extension.CheckWrite, the rule of encoders of spec §72: the writers of capsules and.dkkfiles refusedatekeys.noteanddatekeys.capsuleoutside the arrays where they are registered, or with invalid data.authorkey.Key.StringandGoStringhide the secret key, which onlyKey.Secretreturns.ParsePublicrefuses a key that is not a point of the curve (ed25519strict.OnCurve).Header.UnusableNotetells a public note that breaks the rules of text from no note.
- A typed nil in
- Specification.
spec/DateKeys_Protocol_Specification_v0.12.md, a draft whose §76 lists each change with its case: the names of certificates in the verdicts, between « and », shown only with at most 64 code points and no two spaces in a row; the authority of each seal in the lines of F6, with the warning that nobody checks who issued it; the holder bygivenNameandsurnamebefore thecommonName, which in the certificates of the FNMT carries the NIF; the profile of the certificate field by field; object identifiers by their bytes, repeated elements of a SET OF and the edge cases of the token; the addresses and the padding of the locator; and the errata of §44.1, §55.2, §64, §67 and §76. The CDDL fixes the sizes of the locator.Verdicts.Linesfollows it, and writes the result of a foreign signer in Spanish. - CMS reader with a profile of its own.
internal/cmsreads certificates field by field, as the profile of §29.10 says, instead of withencoding/asn1andcrypto/x509, so that a second implementation reads them the same; a certificate that breaks it decides nothing unless aSignerInfonames it. The text of a name comes only from UTF8String, PrintableString, IA5String, TeletexString in ASCII and BMPString without surrogates, with nothing removed. The key is RSA with NULL parameters and an odd modulus, or EC uncompressed on P-256, P-384 and P-521. Object identifiers are compared by the bytes of their DER, so an arc of 2^31 or more no longer makes an attribute that decides nothing fail the signature; a SET OF may repeat an element, and two copies of a certificate are one; a key of another scheme than its algorithm is F2; amessageImprintof another length is S3; thecrlsof a token decide nothing.internal/derchecks UTCTime and GeneralizedTime in their forms of X.690, a date that exists, and millis and micros as minimal INTEGERs. - Addresses of the locator. A reader rejects an address that breaks §44.1
and uses the others (
Locator.Usable); a writer never writes one. Addresses refuse the special-purpose blocks of IANA, IPv6 outside 2000::/3,localhostand local names, characters outside RFC 3986, dot segments, and a CID that does not decode to version 1 and a multihash.ParseInfochecks that the locator is an age file with one tlock stanza for the round of its DateKey,Info.Extensionreads what it writes, andInfo.OpenLocatorrefuses a nil registry. The errors ofOpenandUnmarshalcarry no normative code. - CLI.
encrypt -signshows the author key and the code ofAUTHOR_MESSAGEbefore it signs (spec §62.1 rule 20).decrypt -expect-authorcompares the key of an F4, and writes nothing unless it matches.decryptandinspectsay when a public note is not shown because it breaks the rules of text;inspect -jsongivespublic_note_unusable. The lines of the verdicts break at the last space that fits, each row after the first behind↳, so that the terminal never breaks them.encryptreports L as the length of the payload, not of the content. - Test data.
genfixtures -forcewrites the fixtures of v0.10 again with their area of 512 bytes, throughEncryptOptions.TestAreaLen, which needsTestVectors; it used to rewrite them with 32 KiB and fail halfway.format3_seal_unsupportedusesseal_type4294967295, reserved for tests, instead ofseal_type1, which a later version may define;capsule.AlgTestandSealTypeTestname the two values.security.jsoncarries the context of a capsule, its commitments and the time of its round, and each case the verdicts and the lines of a reader of this version: a signature ofalg1 that does not verify is F2, a token ofseal_type2 that is not DER is S2, and new cases give a valid signature ofalg1 (F4), andalgandseal_type4294967295 (F1, S1). 24 cases.note.json, new: 16 public notes, those that pass and those that a writer refuses and a reader does not show, each with the text of the rule it breaks.- New fixtures
format3_unsigned, the capsule offormat3_signedwithout its signature, with the same P, andformat3_note, with a public note: 26 capsules, 14 of format 3. The records offormat3_signed_cmsandformat3_sealedgive the lines of v0.12. mutations.jsongains 8 mutations of the list of v0.11 of §64: the signature ofalg1 altered (F2), removed (F0), made again with another key (F4 of that key) and transplanted to another capsule (F2); a key of 31 bytes and a signature of 65 (F1); the area widened to 64 KiB after signing (F4, the sameAUTHOR_MESSAGE); and the public note changed (ERR_HEADER_BINDING, step 15). The signature ofalg1 that does not verify (F2) is now a case of §64. 218 cases, 178 of the spec.
- Pending in this branch.
security_cms.jsonandlocator.jsonextended with the cases of §64 of v0.12: the names, the holder and the profile of the certificate, identifiers, repetitions and the edge cases of the token, and the addresses and the padding of the locator.
Unreleased — specification v0.11
Moves the module to the DateKeys Protocol Specification v0.11, approved by its
author on 1 October 2026 and tagged spec-v0.11, which adds to format 3 what
the v0.10 reserved, without changing any format: a reader of v0.10 opens these
capsules. SpecVersion is 0.11.
- Area of 32 KiB.
capsule.AreaLenis 32768, andLargeAreaLen, 65536, whichEncryptOptions.LargeArealets the writer use, after the signatures are made, only when what they produced does not fit in 32 KiB. The fixtures of v0.10 keep their 512 bytes (AreaUnit), which a reader accepts. - Key of words. Package
wordkeyderives a credential oftime_and_keyfrom six or more words that the person chooses, with PBKDF2-HMAC-SHA256 of 600 000 iterations salted with the chain, the round andcapsule_id(§38.1); the words are normalised with the tables of Unicode 18.0.0.EncryptOptions.Wordsadds it as one more credential, and the CLI takes-wordsand-words-fileinencryptanddecrypt. - Author signature,
alg1.internal/ed25519strictverifies with the strict profile of §29.9 andauthorkeykeeps the keysdkauthor1….EncryptOptions.AuthorKeysigns, inside the writer and after its checks;OpenOptions.AuthorKeysare the keys the person saved;Verdictsgives F2, F3 and F4.capsule.PayloadCommit,ControlCommit,HeadDigest,AuthorMessageandSealSubjectcompute what is signed. - Signature with certificates,
alg2.internal/cmsandinternal/derread the CMS signature and the RFC 3161 token of §29.10 and §29.11 with the standard library only, a closed table of algorithms, and DER checked byte by byte.EncryptOptions.CMSSignergetsAUTHOR_MESSAGEand returns what the person signed outside; the writer checks it and writes nothing unless it is F6. The reader gives F1, F2, F5 and F6 and names the signers. - Time seal,
seal_type2.EncryptOptions.Sealerasks for the token overSEAL_SUBJECT; the reader gives S1 to S5 and the authority of a valid seal. - Public note.
EncryptOptions.PublicNotewritesdatekeys.note;Header.PublicNotereads it;extension.Standardregisters it. - Locator and envelope. Package
locator: the data ofdatekeys.capsule, the locator sealed with tlock, and the envelope split into a header and a rest that can hide inside another file. - Test data.
format3_signedand the vectors of its signature, and the fixturesformat3_signature_unsupportedandformat3_seal_unsupportedremade withalg4294967295. - Review. Three independent reviews, of the CMS reader, of the signing
logic and writer, and of the locator and the CLI, fixed the form of the
signature and of the TSTInfo field by field, the area decided after the
signatures, the text of an issuer on screen and the rules of the addresses;
spec §76 item 8 records them. Under a valid seal,
decryptshows an mtime later than the seal as an inconsistency (§29.7). - CLI.
author keygenandauthor public,encrypt -sign,-noteand-large-area, anddecrypt -expect-author. Passphrases come from a file or from the standard input.
Unreleased — specification v0.10
Moves the module to the DateKeys Protocol Specification v0.10, which adds
capsule format 3, delivery 1 of its design: a capsule holds files, with
their paths, sizes, SHA-256 and modification times, a comment and a
declared author, and a security area that later versions fill with an
author signature and a time seal. EncryptFiles writes format 3; Open
and Inspect read the three formats, and capsules of formats 1 and 2 keep
their verdicts.
Format 3
VERSION3 in the PRELUDE and CONTROL_CBOR of schema version 3, with the keys of version 2: L is the length of BODY (spec §22, §31).- BODY (spec §29.2): a frame of three uint32,
AREA_LEN,SECURITY_LENandHEAD_LEN, the security area, 512 bytes when written and from 512 to 65536 when read, the head and the files. A violation of the frame, L under 12 included, or a byte of the area after SECURITY_CBOR that is not zero, isERR_INTEGRITYat step 17.capsule.BodyFrame,ParseBodyFrame,CheckArea. - Security (spec §29.3, §29.7): a map of version 1 whose keys 2 and 3 are
byte strings holding the author signature and the seal, encoded apart.
It never fails and never decides the opening:
capsule.EvaluateSecuritygives the verdicts X, F0, F1, S0, S1 and S2, andVerdicts.Linesthe texts of the table, in Spanish. This version implements noalgand noseal_type. - The head (spec §29.4): its type tag and version 1, then the CDDL with R1
and R8, then, in key order, the comment and the declared author, each
file with R2 to R6c, R10 and its layout, R7 and R9 over the tree, and the
critical extensions. A violation of a rule of layer 4 is the new
ERR_HEAD_INVALID.capsule.Head,File,EncodeHead,DecodeHead, andextension.Headfor its extensions. - Paths and texts (spec §29.5, §29.6, §29.5.1):
internal/pathruleapplies the rules with tables generated from 19 pinned data files, Unicode 18.0.0 and the 15 WindowsBestFit tables, never with the Unicode functions of the platform;TablesDigestpins them. Its errors name the rule and the character, never echo the text, and read the same in every implementation. R4b and the invisibles rule of §29.6 keep ZWJ, ZWNJ, VS15 and VS16 to their emoji and script uses.
Reader (spec §63 step 17, §56, §57)
capsule.Sinkreceives the files:Beginwith the validated head,Createfor each file,Commitat step 18 only, andAbortonce after any failure that followsBegin. A format 3 capsule withoutOpenOptions.Sinkfails right after step 2 withcapsule.ErrSinkRequired, a caller error without a code, before any request; a capsule of format 1 or 2 withoutdstfails there too.- Step 17 in its substeps: the frame and the area, security, the head, the
files filling CONTENT, the SHA-256 of each file and the padding. A failure
of age, or a plaintext whose length is not P, prevails; otherwise the
first substep that fails decides, and a code other than
ERR_INTEGRITYis reported only after reading PAYLOAD_AGE to its end. - Reads of BODY grow with the bytes received, never with
AREA_LEN,HEAD_LENor a declared size (spec §57). OpenedgainsHead,Verdicts,AreaLenandUnusableHeadExtensions.
Writer (spec §61, §62, §62.1)
capsule.EncryptFileswrites format 3 from a list ofcapsule.Source, each read twice: first to check the paths and the texts with the rules of the reader, measure L with a head whose salt and SHA-256 are zero, and hash each file; then to write it, failing if its size or SHA-256 changed (rules 14 to 18). Files go in the byte order of their paths; the comment has its CR LF turned into LF; the mtime is kept from 1970 to 9999 and omitted otherwise. The head, the control and security are decoded with the rules of the reader before anything is written (rule 17), and the area is always 512 bytes with the empty security (rule 13).EncryptOptionsgainsComment,Author,HeadCritical,HeadNoncriticalandTestVectors.Encryptwrites format 2 only withTestVectors, for generators of test vectors (rule 1).Result.Headis the head written.
CLI
datekeys encrypttakes-inseveral times, files and folders; a folder gives its name as the first segment and is walked withLstat, following no link, taking regular files only and leaving out.DS_Store,Thumbs.db,desktop.ini,._*and__MACOSX, which it reports. New-comment,-authorand-no-mtime. A pipe is no longer accepted.datekeys decryptwrites the files of a format 3 capsule to the new folder-out:os.Mkdirclaims it, only when there are files; the tree is staged in-out/.datekeys-*through anos.Root, withO_EXCLand mode 0600; the mtimes are set and each entry of the first level is moved into place at step 18, and any failure removes the folder. Formats 1 and 2 still write a file.- The presentation of spec §29.7 goes to stdout: the verdicts, the declared
author and the comment box with their labels, the paths, and the
verdicts again. Each line of the creator goes in pieces of at most W − 3
columns behind
│, counting 2 for anything but printable ASCII, with its TABs expanded; W is the width of the terminal, asked throughsyscallon Unix and Windows, or 80. Shortcuts,desktop.ini,.git, programs and a leading dash get a warning.
Errors
ERR_HEAD_INVALIDjoins the catalogue, last (spec §69): 18 codes.
Test data
datekeys.SpecVersionis0.10, and every test data file says so.- Nine fixtures of format 3 (spec §67):
format3_single,format3_tree,format3_comment_only,format3_bloque256andformat3_time_and_key_portable, written withEncryptFiles, andformat3_area_1024,format3_security_v2,format3_signature_unsupportedandformat3_seal_unsupported, which only a generator of test vectors writes. Their records add the area, security, the head, the salt, the comment, the declared author, each file and the verdicts, and their plaintext file is BODY. The .dkk of formats 2 and 3 join the .dkk tests (spec §68). - New vectors:
paths.json,path_fold.json,head_schema.jsonandsecurity.json;cbor.jsongains the control of version 3. - The mutation corpus gains the 33 mutations of the first two lists of
spec §64 on format 3 and the 47 of the list of format 3, three of which
open with their verdicts; format 2 gains "format 2 time_only relabeled
format 3", and "version changed" sets
VERSION4. 209 cases, 169 of the spec.testkit.Splicegives an edit for each run of changed bytes. - The differential corpus gains two bases of format 3, one per policy: 5110 cases, the earlier ones unchanged.
- The tests of the paths and of format 3 hold their invisible and combining characters as Go escapes.
Unreleased — specification v0.9
Moves the module to the DateKeys Protocol Specification v0.9, which adds
capsule format 2 (spec §76, "Cambios normativos de la v0.9"): until the
unlock date it hides the exact length of the content and the number of
credentials. Encrypt writes format 2 only; Open and Inspect read both
formats, and a format 1 capsule, as v0.8.2 wrote it, keeps its verdict.
Format 2
VERSIONin the PRELUDE is the capsule format, 1 or 2 (spec §22, §23):capsule.Format,Format1,Format2andPrelude.Format. Any other value isERR_UNSUPPORTED_VERSIONat step 2, before any request, so a v0.8.2 reader rejects a format 2 capsule without a network request.- CONTROL_CBOR has the schema version of its format (spec §31). Version 2
adds key 6,
payload_length, L in exactly 8 bytes, big-endian, at most L_MAX = 2^53 − 2^46, and key 7,padding, 1 (bloque256) or 2 (reforzado). A control of the other version isERR_UNSUPPORTED_VERSIONat step 14; a violation of keys 6 and 7 isERR_NON_CANONICAL_CBOR. Without extensions a version 2 control is 103 bytes, whatever L and the code.EncodeControlandDecodeControltake the format. - The payload is padded (spec §29.1): its plaintext is the content followed
by zeros up to P = rule(L).
capsule.PaddedLengthcomputes both rules on 64-bit integers, andcapsule.PayloadAgeLengththe length of PAYLOAD_AGE. Step 17 checks that the plaintext is exactly P bytes and its padding zero, orERR_INTEGRITY.Openwrites only the first L bytes todst, never the padding (spec §56), records step 17, and reports the format, L, the rule and P inOpened. - In format 2 INNER_ACCESS_AGE holds exactly 16 X25519 stanzas (spec §39),
agewrap.AccessSlots:agewrap.CheckAccessStanzasandagewrap.NewAccessIdentitytake the number of slots, 0 for format 1. Another number isERR_POLICY_STRUCTURE_MISMATCHat step 12, and again at step 13.
Writer rules (spec §62.1)
EncryptOptions.Length, L, is required: the control is sealed before the content is read, and a source that delivers another number of bytes is an error.EncryptOptions.Paddingchooses the rule; zero means reforzado.time_and_keytakes from 1 to 16 credentials, the recipients and the portable key together. Each free slot gets a dummy, a fresh X25519 public key whose private key is dropped at once, and the 16 recipients are shuffled with an unbiased Fisher–Yates overcrypto/rand.- A recipient that is not canonical (bit 255 set, or u ≥ p) or of low order
is rejected:
agewrap.CheckX25519Recipient. - Self-checks: INNER_ACCESS_AGE has 16 X25519 stanzas with distinct shares and the portable key opens exactly one; PAYLOAD_AGE has the length P gives and I_PAYLOAD opens its header.
Resultreports the format, L, the rule and P.
CLI
datekeys encryptmeasures its input, copying a file that is not regular to a temporary file first, and takes-padding reforzado|bloque256. Its report and that ofdecryptgive the format and the lengths, anddecryptwarns that format 1 hides neither the number of credentials nor the exact length.datekeys inspectreports the format,"format"in-json.
Test data
- Seven format 2 fixtures (spec §67), whose records give L, the rule, P and
the INNER_ACCESS_AGE stanza each credential opens. The five format 1
fixtures of v0.8.2 keep their bytes as compatibility fixtures, and
genfixturesnever regenerates them; their records name spec 0.9, the format and stage 17. vectors/padding.json, new: both rules for the rows of spec §29.1, checked against a Padmé computed withmath/big.vectors/cbor.json: the control vectors carryformat, absent meaning 1, and gain the cases of version 2; "unknown key 6" is now "key 6, defined only in schema version 2".vectors/mutations.json: "version changed" writesVERSION3; the 33 mutations of the first two lists of spec §64 also run on format 2 fixtures ("format 2: …"), followed by the 22 of its third list and their companions with a.dkk. The new cases derive from fixtures without randomness:testkitseals them again with their known file keys and nonces (reseal.go), and reproduces each fixture byte for byte when nothing is edited.vectors/inspect_differential.jsonkeeps its 1 825 cases and adds a block for each format 2 fixture: 4 380 cases.
Unreleased — specification v0.8.2
Moves the module to the DateKeys Protocol Specification v0.8.2, whose normative change closes the extension format (spec §76), refined, amended and corrected before release (see "Specification refinements", "Specification amendment: point canonicality" and "Specification corrections: formal review"). Framing and schema versions do not change.
The CBOR library is replaced by a codec of the module's own, without reflection or dependencies. Every valid object encodes to the same bytes as before: the official vectors and fixtures are unchanged, and every error code and inspection step of the test suite and the mutation corpus is the same.
Specification refinements
v0.8.2 is unreleased, so these refinements amend it without a version change;
spec §76 records each with its reproducible cases. No valid object changes,
nor the verdict of any existing official vector or fixture; dk1.json gains
four vectors for the reading rules of §19.
- Layered error precedence (spec §69.1, with §57 and §63): within one object
the code of the first failing layer is reported: frame, then type tag and
schema version (keys 0 and 1), then the CBOR profile and the CDDL, then the
fields with codes of their own in ascending key order; the rules with
codes of their own belong to the last layer, not to the CDDL layer. Across
objects and steps, the step order of §63 decides; step 9 now spells out its
order (the
.dkkas an object, then its binding to the capsule, then credentials, then the round time, then the request), and the errors of a.dkkcome at step 9.a even when it is decoded earlier, and never undertime_only. The optional inspection of steps 5, 6 and 8 and thecapsule_digestcheck can change the code, and so could, until the corrections of the formal review, whether a network source verified the release. Steps 10, 11, 13 and 17 give the codes of the release verification (round, then signature) and of each identity. - Trust model (spec §55.1): who can write PUBLIC_HEADER, CONTROL_CBOR,
PAYLOAD_AGE and the
.dkkbody, from which step each is bound and by what, and what none of them proves. Spec §72: an extension with security-relevant claims lives in CONTROL_CBOR or is signed by a signature extension; the data of.dkkextensions is advisory for its holder only. - One ordering rule for extension arrays (spec §31, §54, CDDL): strictly
ascending unsigned bytewise order of the UTF-8 bytes of
extension_id, a proper prefix first, never UTF-16 code units or a locale collation. - Rules that only
testdata/README.mdstated are now normative text: the age header grammar of C2SP and its codes (§28.1, §36), the round-time bound of 9999-12-31T23:59:59Z and pre-genesis instants (§15), the reading rules ofdk1_(§19: either Base64 alphabet but no CR or LF, one JSON object in valid UTF-8 without a byte order mark, numbers by their exact decimal value), lengths of at least 1 (§22, §23, §40, §57), the comparison of the tlock stanza arguments (§35, §63 step 8), the Provider Profile rules and the chain-hash formula (§12.1, withperiodat most 2^32 − 1 and the name alphabets normative; the name lengths stay implementation limits),extension_idof at least one byte (§31), a repeated X25519 ephemeral share in INNER_ACCESS_AGE (§36), and the implementation limits of the reference (§74).
These error codes of the reference change, for inputs that no existing official vector holds:
capsule.Openchecks an offered.dkkas an object before binding it to the capsule:access_typeandaccess_material, then its critical extensions, thencapsule_id, thencapsule_digest. A.dkkfor another capsule with an unknown critical extension is nowERR_EXTENSION_CRITICAL_UNKNOWN(wasERR_ACCESS_INVALID), and one with an unsupportedaccess_typeand an unknown critical extension isERR_ACCESS_INVALID(wasERR_EXTENSION_CRITICAL_UNKNOWN).accesskey.Decoderejects aBODY_LENof 0 withERR_INTEGRITY, like aPUBLIC_HEADER_LENof 0; it wasERR_NON_CANONICAL_CBOR, the empty body failing to decode.datekey.Parserejects CR and LF in adk1_string withERR_DATEKEY_INVALID; the Go Base64 decoders skipped them, and the result wasERR_DATEKEY_NON_CANONICAL. It also rejects invalid UTF-8 in the JSON at step 2 (see "Fixed").datekeys decrypt -dkkhands the.dkktocapsule.Openstill encoded, through the newOpenOptions.AccessKeyFile, so its decoding errors come at step 9 of atime_and_keycapsule, after any failure of steps 1 to 8, and atime_onlycapsule ignores it; the CLI used to fail on it before reading the capsule.capsule.Openignores nil entries ofOpenOptions.Identities: with no other credential, the result isERR_ACCESS_REQUIREDat step 9, before the clock is consulted, instead ofERR_RELEASE_UNAVAILABLEor a release request.agewrap.AccessIdentitytries every identity on every stanza: an identity that unwraps two INNER_ACCESS_AGE stanzas isERR_POLICY_STRUCTURE_MISMATCHeven when another identity unwraps exactly one, whatever their order; the file used to open when the other came first.profile.NewRegistryencodes and decodes each profile before comparing itsprofile_hash, so a profile gets the codeprofile.Decodereports: aperiodof 86401 s isERR_NON_CANONICAL_CBOR, as inDecode, notERR_UNKNOWN_PROFILE.Profile.Validatechecks the schema rules a value can break (a period that is not a whole number of seconds in 1..86400, a genesis time outside 0..2^53−1, a name that is not valid UTF-8) first, withERR_NON_CANONICAL_CBOR.
Tests: capsule.TestPrecedenceWithinPublicHeader, TestPrecedenceAcrossSteps,
TestFrameLengthLowerBounds, TestMalformedAgeHeaders,
TestTlockStanzaArgumentComparison, TestAccessKeyCheckOrder,
TestAccessKeyFileAtStep9, TestControlCriticalBeforeHeaderBinding and
TestTrustModel; accesskey.TestDecodePrecedence;
agewrap.TestAccessIdentityStrictness; datekey.TestReadingRules;
profile.TestDecodePrecedence (a G1 point outside the prime-order
subgroup), TestPinPathMatchesDecode and TestChainHashFormula;
provider.TestVerifyRejects; extension.TestOrderIsUnsignedBytewise;
cmd/datekeys.TestDecryptAccessKeyOrder.
Specification amendment: point canonicality
An amendment of the unreleased v0.8.2, recorded with its case in spec §76.
The new §12.2 defines the canonical encoding of a BLS12-381 point, the
compressed form of drand: the compression flag set, the infinity flag only for
the point at infinity with every other bit zero, the sort flag for the
lexicographically largest y, big-endian coordinates below p (c1 then c0 in
G2) and a point of the prime-order subgroup. A decoder rejects every other
string, among them x + p and an identity with a payload. The Provider Profile
public key (§12.1), the release signature (§63 step 10) and the U of the
tlock stanza (§63 step 11) are canonical and never the point at infinity, and
step 11 defines the stanza body, U || V || W with |V| = |W| = 16 (128 bytes
for Quicknet), and the IBE check r·G == U. The case, from the second
implementation: tlock-js on @noble/curves 1.9.7 accepted U re-encoded as
c0 + p and a signature re-encoded as x + p and returned the same file key,
where the reference rejects both.
No error code or step of the reference changes: its decoder,
kilic/bls12-381 through drand, already rejected those encodings. A U at
infinity, which only the IBE check used to reject, is refused before
decryption, with the same ERR_INTEGRITY. Spec §64 gains ten mutations,
exported in mutations.json: U with c0 + p, U at infinity, U with the
infinity flag and a payload, and tlock stanza bodies of 127 and 129 bytes,
each with a valid header MAC (ERR_INTEGRITY, step 11); a release signature
with x + p, at infinity, with the infinity flag and a payload, negated, and
negated together with U with c0 + p (ERR_RELEASE_INVALID, step 10). The
x + p case is a capsule for round 1004, whose published signature testkit
now knows (testkit.XPlusPRound): no fixture round has an x below
2^381 − p. No fixture and no other vector changes.
Tests: profile.TestDrandPointDecodersAreCanonical, which fails if a
dependency update makes the decoders of drand lenient, and
TestPublicKeyEncodingIsCanonical; new cases in provider.TestVerifyRejects,
agewrap.TestTimeIdentityStrictness and TestTimeIdentityRelease;
capsule.TestPointMutationsChangeOnlyTheEncoding, which checks that each
point mutation differs from a capsule that opens only in one encoding;
internal/testkit.TestPointReencodings.
Specification corrections: formal review
Corrections of the unreleased v0.8.2 from the formal review of the specification, recorded with their cases in spec §76 ("Correcciones de la revisión formal"). Three change normative rules:
- A source that fetches releases over a network (a relay, the Release API or
a cache) must verify every response with the rules of step 10 and discard
the one that fails; when none passes, the code is
ERR_RELEASE_UNAVAILABLEat step 9 (spec §63). The codes of step 10 are those of a release supplied directly, as in the official vectors.provider/drand.Clientalready did this; the contract ofprovider.ReleaseSourceand the documentation ofcapsule.OpenOptions.Sourcenow say so. - Each registered extension declares the objects (PUBLIC_HEADER,
CONTROL_CBOR,
.dkk) and the arrays where it may appear, and a known extension elsewhere is treated as unknown there (spec §31, §54, §72): a critical one isERR_EXTENSION_CRITICAL_UNKNOWN, a noncritical one is ignored. The new optional interfaceextension.Placementof aRegistrytells where each extension is registered;capsule.Inspectandcapsule.Opencheck the arrays of PUBLIC_HEADER (step 4), of the.dkk(step 9.a) and of CONTROL_CBOR (step 14) with the newextension.CheckCriticalInandextension.CheckNoncriticalIn. ARegistrythat does not implement it behaves as before. - H2, H3 and H4 of step 11 are those of drand/kyber
encrypt/ibe, and H2 hashes the element of GT in the order ofkilic/bls12-381: c1 before c0 at every level of the tower, each coordinate of Fp in 48 bytes big-endian. The new vector filetestdata/vectors/tlock_ibe.jsonfreezes H2(e(G1, G2)) =cb87319f24560b5231579a09ad79f12e; the order ofFp12.toBytesof noble, c0 first, gives0118eea9d5971745f71e3c94926f1717and another file key.
The other findings are editorial: §27 defers the authenticity of
PUBLIC_HEADER to the trust model (§55.1) and says that the age header MAC
protects only against whoever does not know the file key; step 5 separates
the mandatory read of SEALED_CONTROL from the optional inspection of its age
header; step 15 names ERR_HEADER_BINDING; §21 makes the 16 CSPRNG bytes of
capsule_id a MUST; §77 gains drand/kyber, RFC 8259, RFC 8610 and RFC 4648;
§76 retitles its section "Cambios normativos de la v0.8.2" and corrects its
record: dk1.json gained four vectors, not three, and two cases of the
refinements quoted texts that no earlier version contained.
No error code of the reference changes, nor any fixture or existing vector.
github.com/drand/kyber-bls12381, already an indirect dependency through
drand and tlock, becomes a direct requirement: internal/testkit and a test
compute the pairing with it.
Tests: capsule.TestReleaseFromANetworkSource (a relay whose only answer is
a release of another round, or a negated signature, gives
ERR_RELEASE_UNAVAILABLE at step 9 through provider/drand.Client, and the
same release supplied directly the code of step 10);
capsule.TestExtensionPlacement (an extension registered for CONTROL_CBOR
only is unknown in PUBLIC_HEADER and in a .dkk, one registered as
noncritical only is unknown in a critical array, and a noncritical copy
outside its registration is ignored); extension.TestPlacement;
agewrap.TestTlockH2Vector (the frozen vector, and step 11 recomputed with
H2 and H4 against the file key that tlock unwraps).
A second round of the same review confirmed these corrections and asked for three more, recorded in spec §76 as corrections 4 to 6:
- An encoder must not write a registered extension in an object or array it
is not registered for, and a reader that ignores a noncritical one for that
reason must not interpret its data (spec §54, §72). A writer could seal in
the critical extensions of CONTROL_CBOR one registered there as
noncritical only, which a reader that knows the registration rejects at
step 14, after the unlock.
capsule.Encryptandaccesskey.Encodetake noRegistry: they write the extensions they are given, and the application, which knows the registration, applies the rule. - §17 and §51 give the codes of step 10 only for a release supplied directly, as step 10 does; one that a network source fetches and that breaks those rules is discarded at step 9.
- Whatever the failure of the release source, step 9 reports
ERR_RELEASE_UNAVAILABLEand no other code (spec §63).
The other findings are editorial: §28.1 says that steps 5 and 6 parse only
the age header, since step 5 reads all of SEALED_CONTROL; step 9 has a single
arrow to ERR_RELEASE_UNAVAILABLE; §76 rewords two introductions.
testdata/README.md says where the extensions of the mutation corpus are
registered: in both arrays of every object.
These error results of the reference change, for inputs that no official vector holds:
capsule.Openreports any error ofOpenOptions.Sourceat step 9 withERR_RELEASE_UNAVAILABLEas its only code. An error that carries another normative code, or none, keeps only its text: a caller's source that failed withERR_RELEASE_INVALIDgaveERR_RELEASE_INVALIDat step 9. An error that wrapsERR_RELEASE_UNAVAILABLEalone is returned as it is, with its other causes, such as a context error.- The error of
provider/drand.Client.FetchwrapsERR_RELEASE_UNAVAILABLEand no other normative error, aserrors.gopromises for every error of the module. The failure of each relay is kept in its text only, whereerrors.Joinwrapped it: a relay that answered with a release of another round also made the error matchERR_ROUND_MISMATCH. A context that ended is still wrapped, whetherFetchsees it end before or after the relays fail because of it.
Tests: capsule.TestReleaseSourceErrorsAtStep9 (a source error with another
code, two codes or none gives ERR_RELEASE_UNAVAILABLE alone at step 9 and
keeps its text); capsule.TestExtensionPlacement, which now also covers the
noncritical array of a .dkk, so that checking it with the object-blind
extension.CheckNoncritical fails; provider/drand.TestFetchErrorHasOneCode
and TestUnavailabilityAndCancellation (a canceled context and a deadline
during the request); datekeys.TestCode.
Breaking changes
extension.New(id, version, data []byte)takes the opaque data bytes instead of a value that it encoded as CBOR, and rejects nil or empty data. An extension without data is the literalextension.Extension{ID, Version}, which omits key 2.- Extension data (key 2) must be a byte string of at least one byte. Any other
CBOR type,
nullorh''at key 2 is nowERR_NON_CANONICAL_CBOR, so a v0.8.1 object with such data no longer decodes. The base protocol never decodes the content (§54). codec.Validand its fuzz targetcodec.FuzzValidare removed: nothing decodes extension data any more.- Package
codecis rewritten without reflection, struct tags or dependencies (§58). Removed:Marshal, the reflection-basedUnmarshal(data, v)andPeek(data, v), andMaxNestedLevels,MaxArrayElementsandMaxMapPairs. Each schema now writes its encoding with acodec.Encoder(Map,Array,Uint,Bstr,Text,Out, with a sticky first error, andFail, which records an error of the schema so thatOutnever returns bytes its decoder rejects) and reads it with a strictcodec.Decoder(NewDecoder,Map,Key,EndMap,Array,Uint,Bstr,Text,Done).codec.Unmarshal(in, decode, encode)runs the decoder of a schema and requires that its re-encoding reproduces the input;codec.Peek(in)returns the type tag, of at mostcodec.MaxTypeTagLen(64) bytes, and the schema version;codec.Walk(in, maxDepth, maxLen)checks that bytes are one item of the §58 profile, for vectors, fuzzing and diagnostics.CheckSchemaandMaxSafeUintkeep their names. extension.Wireand itsUnmarshalCBORare removed.extension.Encodebecomesextension.Canonical, which returns the validated array in canonical order as[]Extension;extension.Decode([]Wire)becomesextension.DecodeArray(*codec.Decoder), which reads and validates one array and rejects more than 64 entries from the array head, before reading any;extension.EncodeArray(*codec.Encoder, []Extension)writes one, and records in the Encoder, instead of writing it, an array thatDecodeArraywould reject.codec.CheckSchemareads keys 0 and 1 only, and nothing after them (§70): the map head, key 0, a type tag of at most 64 bytes, key 1 and the version must be in the profile, each head in its shortest form, and the version at most 2^53−1. A schema version other than the expected one read that way isERR_UNSUPPORTED_VERSIONwhatever follows it; it wasERR_NON_CANONICAL_CBORwhen the rest of the object was malformed. Every other form of the version is nowERR_NON_CANONICAL_CBOR, where it wasERR_UNSUPPORTED_VERSIONwhenever the value read was not the expected one: a missing version,nullorundefined, a version not in its shortest form, a version above 2^53−1 (up to 2^64−1), a version that is not the second key (placed before key 0 or after another key), and a version behind a map head or a type tag head not in its shortest form.trueandfalsewere alreadyERR_NON_CANONICAL_CBOR.capsule.DecodeHeaderchecks every CDDL rule of PUBLIC_HEADER, includingaccess_policy, the extension arrays and the cross-array rule, before it parses the DateKey (§57, §63 step 4). A header that breaks both reportsERR_NON_CANONICAL_CBORwhere it reportedERR_DATEKEY_INVALIDorERR_DATEKEY_NON_CANONICAL; a header with one fault keeps its code.profile.Profile.CanonicalCBORandHashrefuse aprofile_id,provider,networkorschemethat is not valid UTF-8, withERR_NON_CANONICAL_CBOR: they wrote it as an invalid text string. Every encoder refuses such text.- At most 64 extensions per array and
extension_versionat most 2^32−1, on encode and decode (ERR_NON_CANONICAL_CBOR). Anextension_idappears at most once per object, and arrays are ordered byextension_idonly. - Provider Profile:
genesis_timeis an unsigned integer, andperiodandgenesis_timeare at most 2^53−1; a negative or larger value isERR_NON_CANONICAL_CBOR. nullin a byte-string field isERR_NON_CANONICAL_CBOR(for example anullaccess_materialwasERR_ACCESS_INVALID): nil byte strings, arrays and maps now encode as empty ones, never asnull.capsule.EncodeHeaderandcapsule.DecodeHeaderenforce the 1 MiB PUBLIC_HEADER limit andaccesskey.DecodeBodythe 16 MiB BODY limit. Every frame-limit refusal, including those ofaccesskey.MarshalBodyand ofcapsule.Encryptfor SEALED_CONTROL, now wrapsERR_INTEGRITY(§57).profile.Profile.CanonicalCBORrefuses aperiodorgenesis_timeoutside the schema withERR_NON_CANONICAL_CBOR, asprofile.Decodedoes.- The official fixture
time_only_extensionsis regenerated: its header data is the raw UTF-8 bytes of "public label" and its control data is{0: 7, 1: "sealed"}(a2000701667365616c6564). Every other.dkcand.dkkkeeps its bytes; the fixture and vector metadata name spec 0.8.2.
Added
datekeys.SpecVersion(0.8.2), the specification the module implements, anddatekeys.Version(), the version of the module as the go command recorded it: a tag, the pseudo-version of the commit of a checkout build, or(devel).datekeys versionprints both and the Go toolchain.capsule.OpenOptions.AccessKeyFile, a.dkkstill encoded, whichOpendecodes at step 9.a and only for atime_and_keycapsule (§63, §69.1).ErrExtensionDataInvalid(ERR_EXTENSION_DATA_INVALID, §69).extension.Placement, an optional interface of aRegistrythat tells in which objects and arrays each extension is registered, withextension.Object(PublicHeader,Control,AccessKey),extension.Array(Critical,Noncritical),extension.KnownIn,extension.CheckCriticalInandextension.CheckNoncriticalIn(§54, §72).CheckCriticalandCheckNoncritical, which do not know the object, keep their behaviour and consult noPlacement.testdata/vectors/tlock_ibe.json, the H2 vector of §63 step 11, generated byinternal/testkit.IBEVectorsand documented intestdata/README.md.extension.DataValidator, an optional interface of aRegistrythat validates the data of the extensions it knows: a known critical extension with invalid data fails withErrExtensionDataInvalid(§63 steps 4 and 14, and the.dkkcheck); a known noncritical one is reported incapsule.Inspection.UnusableExtensions,capsule.Opened.UnusableControlExtensionsorcapsule.Opened.UnusableAccessKeyExtensions(extension.CheckNoncritical,extension.Unusable) and does not fail.- Encoder self-checks:
capsule.Encryptdecodes its PUBLIC_HEADER and CONTROL_CBOR, andaccesskey.MarshalBodyits body, with the readers' decoders before sealing or writing (§72). extension.MaxExtensions,MaxVersion,MaxDataLen,codec.MaxSafeUintandcodec.MaxTypeTagLen.- The
.dkkfixturetime_and_key_portable_extension, which carries a noncritical extension with data (§68). genfixtures -only NAME[,NAME...]regenerates the named fixtures only.- Tests: the three new §64 mutations (data that is not a byte string,
h''data, 65 extensions), regression tests for the cases of §76, conformance checks on the exact data bytes, and the fuzz targetcapsule.FuzzEncodeImpliesDecode(header, control and.dkk). - The mutation corpus moves from
capsule/mutation_test.gotointernal/testkit.Mutations, shared by the test and bygenfixtures. Its third-party X25519 identity is now fixed (testkit.Stranger), and every release source answers with one recorded release, as the exported corpus describes it. The CLI's inspect view moves tointernal/inspectview, whichgenfixturesuses to freeze the outputs. internal/cbortest, an encoder and decoder of generic CBOR values written independently ofcodec: tests build with it inputs outside the profile and checkcodecagainst it.- Tests of the map structure of every schema (key order, required and unknown keys, entry counts) and of the codec, whose statement coverage is 100 %.
access_policyvalues whose low byte is 0 or 1 (256, 257, 65536, 2^32, 2^53−256…) are tested as undefined, asFuzzDecodeHeaderseeds and as two mutations with a consistentheader_binding(testkit.Build.RawPolicy).- Tests
extension.TestEncodeArrayRejects,accesskey.TestEncodeAndDecodeLeaveNoStaleMaterial,accesskey.TestDecodeShortBodyAllocatesLittleandcapsule.TestDecryptAll. - Shared test data for a second implementation, generated by
genfixtures, regenerated by the gate and documented intestdata/README.md:testdata/vectors/cbor.json: 36 accepted and 67 rejected items of the §58 profile, walked withcodec.Walk(integers above 2^53−1 as decimal strings), and 135 schema vectors: minimal valid object, unknown key, missing key, wrong type, size and range for the Provider Profile, PUBLIC_HEADER, CONTROL_CBOR, the.dkkbody,verification_metadataand extensions (data40and5801xx, data of every other type, 64 and 65 extensions, a leading BOM, the U+FF61/U+10000 order,extension_version2^32−1 and 2^32); schema versions 2^53 and 2^64−1 and the order of type tag and version; and the Provider Profile validation (names, public key,genesis_time, drand scheme, the chain-hash self-check with its formula, theperiodlimit), each vector keeping the chain hash consistent unless it tests the self-check.testdata/vectors/mutations.json: the mutation corpus as frozen data, 65 cases (the 33 of §64 first), each a.dkcgiven as edits of a fixture and what the reader is given (.dkk, identities, the recorded release, clock, registry, known extensions), with the expected error and step. The 17 capsules built with age randomness are kept from the committed file;genfixtures -only mutationsrebuilds them.testdata/vectors/inspect_differential.json: 1825 deterministic mutations of the five.dkcfixtures (bit flips, byte changes, truncations, insertions, deletions, length fields, CBOR-aware header edits, DateKey edits, age header edits) with the verdict of steps 1 to 8.testdata/fixtures/<name>.inspect.json: the exact output ofdatekeys inspect -json -in <name>.dkcfor each official capsule.testdata/README.mdpoints to the sections of the specification that decide each verdict (§12.1, §15, §19, §22, §23, §28.1, §63, §69.1, §74), which the refinements above moved into normative text.
spec/datekeys.cddlmarks the one-dayperiodlimit of the Provider Profile, whichprofile.Decodealready applied, as an implementation limit of the reference (§57, §74); spec §11 allows up to 2^53−1.- Tests that replay them:
codec.TestSharedVectors,internal/testkit.TestSchemaVectors,capsule.TestExportedMutationCorpus,capsule.TestInspectDifferentialCorpusandcmd/datekeys.TestInspectJSONGoldens. - Fuzz targets
codec.FuzzDecoder(the Decoder primitives),codec.FuzzWalk(against the independent decoder),codec.FuzzPeek,codec.FuzzEncodeImpliesWalkandextension.FuzzDecodeArray, run byscripts/fuzz.sh;codec.FuzzUnmarshalnow fuzzes a hand-written schema.
Removed
- The dependencies
github.com/fxamacker/cbor/v2andgithub.com/x448/float16.go.modrequires nothing new.
Fixed
- Error messages no longer copy the text of an error of age, tlock, kyber,
drand or kyber-bls12381. When the IBE check of a tlock stanza failed,
kyber's error carried the candidate plaintext and r, and
agewrap.TimeIdentitycopied it into its error, and so into the error ofcapsule.Openand the details ofInspection.Checks: a third party who edited W learned FK_TIME from the message. Each such failure now has a fixed message with its normative error and a reason of its own: the length of the tlock stanza body, the encoding of U, U at infinity or the IBE check; the header or the STREAM of an age file; a malformed X25519 stanza. A failure of the writer of the plaintext at step 17 keeps its own text.capsule.TestTlockFailureDiagnosticsCarryNoSecrets,TestPlaintextWriterFailureKeepsItsText. datekey.Parserejects invalid UTF-8 in thedk1_JSON at step 2, as §19 requires.encoding/jsonreplaced it with U+FFFD, so a member that a repeated name overwrites passed steps 2 and 3 and ended asERR_DATEKEY_NON_CANONICALinstead ofERR_DATEKEY_INVALID. Found by the second implementation's differential; newdk1.jsonvector.extension.CheckDisjointis a linear merge of the two sorted arrays; a PUBLIC_HEADER with 40 000 + 40 000 extensions took 8.3 s in the pairwise check (§76, case 6).- Control data made of 14 or 15 nested arrays was sealed by
Encryptand rejected byOpenat step 14, after the unlock (§76, case 5). - Header data
{NaN: 0, NaN: 1}gave a nondeterministic verdict (§76, case 3). extension.New(id, v, nil)wrotenullas data (§76, case 2).codec.Unmarshalwipes its re-encoding, which after the new self-checks held a copy of I_PAYLOAD oraccess_material, andaccesskey.DecodeBodywipes the material on its error paths. Thecodec.Encoderalso wipes every buffer it outgrows, andcodec.Unmarshalsizes its re-encoding for the input; the former library's internal buffers could keep a copy.accesskey.Encodewipes the body it wrote, andaccesskey.Decodereads the body into a buffer that grows with the data read, wiping every buffer it outgrows, and wipes the body once decoded or on error: both left copies ofaccess_materialbehind. The in-memory age decryption of SEALED_CONTROL and INNER_ACCESS_AGE incapsule.Openreads the plaintext into one buffer of the ciphertext's size instead of a growing one, so that no outgrown buffer keeps a copy of I_PAYLOAD. Buffers internal tofilippo.io/ageand copies made by the Go runtime stay out of reach (SECURITY.md).
Unreleased — v0.1.0
First implementation of the DateKeys Protocol Specification v0.8.1.
Added
datekey: local date → round resolution at full precision (§15), canonicaldk1_encoding and strict parsing (§18, §19).profile: Provider Profile Deterministic CBOR andprofile_hash(§11), the pinned Quicknet profile with its chain-hash self-check (§12), and pinned registries (§13).provider: release sources and local BLS verification (§51);provider/drand: racing public relays, verifying every answer (§48, §49, §52).codec: Deterministic CBOR with a re-encoding canonicality check (§58, §58.1).extension: the generic extension mechanism (§54).agewrap: strict tlock and X25519 age identities that enforce the stanza rules (§27, §29, §32, §33, §35), and a secret-free header probe.capsule:.dkcframing,Encryptfortime_onlyandtime_and_key(§61, §62),Inspect(§63 steps 1–8) andOpen(§63 steps 9–18).accesskey:.dkkencoding and decoding (§40–§44).cmd/datekeys:encrypt,decrypt,inspect,datekey resolve,profile hash, with atomic, non-overwriting outputs.- Official vectors (§65, §66),
.dkc/.dkkfixtures (§67, §68), the mutation corpus (§64), fuzz targets for every parser, interoperability tests with the officialageandtleCLIs, and live Quicknet integration tests. spec/datekeys.cddlanddocs/traceability.md.