Skip to content

Commit 02d6fc2

Browse files
committed
Cleanup and fixes.
1 parent 58272f8 commit 02d6fc2

8 files changed

+39
-34
lines changed

papers/bcr-2020-002-bech32-seed-format.md

+4
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,10 @@
66
Author: Wolf McNally<br/>
77
Date: April 22, 2020
88

9+
### DEPRECATED
10+
11+
The content below is now deprecated and of historical interest only.
12+
913
---
1014

1115
### Introduction

papers/bcr-2020-004-bc32.md

+4
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,10 @@
66
Authors: Wolf McNally, Christopher Allen<br/>
77
Date: May 5, 2020
88

9+
### DEPRECATED
10+
11+
The content below is now deprecated and of historical interest only.
12+
913
---
1014

1115
### Introduction

papers/bcr-2020-005-ur.md

+3-13
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,8 @@ Encoding Structured Binary Data for Transport in URIs and QR Codes
77
**© 2020 Blockchain Commons**
88

99
Authors: Wolf McNally, Christopher Allen<br/>
10-
Version: 2.0.1<br/>
11-
Date: July 9, 2020<br/>
12-
Revised: March 4, 20201
10+
Version: 2.1.0<br/>
11+
Revised: Aug 19, 2023
1312

1413
---
1514

@@ -88,16 +87,7 @@ By specifying a standard for binary structure, users of this format can begin to
8887

8988
#### Canonical CBOR
9089

91-
The CBOR in URs MUST adhere to ["Canonical CBOR", Section 3.9](https://tools.ietf.org/html/rfc7049#section-3.9). For instance, keys in maps must be sorted from lowest to highest.
92-
93-
In addition, a minimal canonical representation for encoding byte strings be used:
94-
95-
* If the encoded byte string has 23 or fewer bytes, it is preceded by the single byte (`0x40` + length).
96-
* If the encoded byte string has 24..255 bytes, it is preceded by (`0x58`, length) where *length* is the length of the following byte string.
97-
* If the encoded byte string has 256..65535 bytes, it is preceded by (`0x59`, h, l) where *h*, *l* is the big-endian two byte length of the following byte string.
98-
* If the encoded byte string has 65536..2^32-1 bytes, it is preceded by (`0x5a`, b1, b2, b3, b4) where *b(n)* is the big-endian four byte length of the following byte string.
99-
100-
Writers of this format MUST use the shortest encoding given the length of the payload. CBOR also supports an 8-byte length encoding for payloads longer than 2^32-1 bytes, and also encoding of "indefinite length" byte strings, but implementors of this specification MAY refuse to decode them. Implementors of this specification MAY also reject any other CBOR constructs.
90+
The CBOR in URs MUST adhere to ["Deterministic CBOR", § 4.2](https://datatracker.ietf.org/doc/html/rfc8949#name-deterministically-encoded-c). For instance, keys in maps must be sorted from lowest to highest.
10191

10292
#### CBOR Examples
10393

papers/bcr-2020-013-crc32-cbor-tag.md

+4
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@
77
Authors: Wolf McNally, Christopher Allen<br/>
88
Date: July 3, 2020
99

10+
### DEPRECATED
11+
12+
The content below is now deprecated and of historical interest only.
13+
1014
### Introduction
1115

1216
This document registers a tag for serializing CRC-32 checksums in Concise Binary Object Representation (CBOR).

papers/bcr-2022-001-encrypted-message.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -71,31 +71,31 @@ ciphertext: `d31a8d34648e60db7b86afbc53ef7ec2a4aded51296e08fea9e2b5a736ee62d63db
7171
* In the CBOR diagnostic notation, with `#6.40002` tag:
7272

7373
```
74-
40002( # encrypted
74+
40002( / encrypted /
7575
[
7676
h'd31a8d34648e60db7b86afbc53ef7ec2a4aded51296e08fea9e2b5a736ee62d6
7777
3dbea45e8ca9671282fafb69da92728b1a71de0a9e060b2905d6a5b67ecd3b36
7878
92ddbd7f2d778b8c9803aee328091b58fab324e4fad675945585808b4831d7bc
79-
3ff4def08e4b7a9de576d26586cec64b6116', ; ciphertext
80-
h'070000004041424344454647', ; nonce
81-
h'1ae10b594f09e26a7e902ecbd0600691', ; auth
82-
h'50515253c0c1c2c3c4c5c6c7' ; aad
79+
3ff4def08e4b7a9de576d26586cec64b6116', / ciphertext /
80+
h'070000004041424344454647', / nonce /
81+
h'1ae10b594f09e26a7e902ecbd0600691', / auth /
82+
h'50515253c0c1c2c3c4c5c6c7' / aad /
8383
]
8484
)
8585
```
8686

8787
* Encoded as binary using [CBOR Playground](https://cbor.me):
8888

8989
```
90-
d9 9c42 # tag(40002) ; encrypted
90+
d9 9c42 # tag(40002) encrypted
9191
84 # array(4)
92-
58 72 # bytes(114) ; ciphertext
92+
58 72 # bytes(114) ciphertext
9393
d31a8d34648e60db7b86afbc53ef7ec2a4aded51296e08fea9e2b5a736ee62d63dbea45e8ca9671282fafb69da92728b1a71de0a9e060b2905d6a5b67ecd3b3692ddbd7f2d778b8c9803aee328091b58fab324e4fad675945585808b4831d7bc3ff4def08e4b7a9de576d26586cec64b6116
9494
4c # bytes(12)
9595
070000004041424344454647 # "....@ABCDEFG"
96-
50 # bytes(16) ; auth
96+
50 # bytes(16) auth
9797
1ae10b594f09e26a7e902ecbd0600691
98-
4c # bytes(12) ; aad
98+
4c # bytes(12) aad
9999
50515253c0c1c2c3c4c5c6c7 #
100100
```
101101

papers/bcr-2023-003-envelope-known-value.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,8 @@ This document extends the [Gordian Envelope Base Specification](https://datatrac
2727
This section is normative, and specifies an additional case arm for the `envelope` type: `known-value`. The formal language used is the [Concise Data Definition Language (CDDL)](https://datatracker.ietf.org/doc/html/rfc8610). The top-level specification of Gordian Envelope with this extension added is:
2828

2929
```
30-
envelope = #6.200(
30+
envelope = #6.200(envelope-content)
31+
envelope-content = (
3132
leaf / elided / node / assertion / wrapped /
3233
known-value
3334
)

papers/bcr-2023-004-envelope-symmetric-encryption.md

+6-5
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,8 @@ This section is normative, and specifies an additional case arm for the `envelop
2727
The formal language used is the [Concise Data Definition Language (CDDL)](https://datatracker.ietf.org/doc/html/rfc8610). The top-level specification of Gordian Envelope with this extension added is:
2828

2929
~~~
30-
envelope = #6.200(
30+
envelope = #6.200(envelope-content)
31+
envelope-content = (
3132
leaf / elided / node / assertion / wrapped /
3233
encrypted
3334
)
@@ -70,8 +71,8 @@ $ ENVELOPE=`envelope subject "Hello"`
7071
7172
$ envelope format --diag $ENVELOPE
7273
73-
200( ; envelope
74-
24("Hello") ; leaf
74+
200( / envelope /
75+
24("Hello") / leaf /
7576
)
7677
7778
$ envelope digest --hex $ENVELOPE
@@ -81,8 +82,8 @@ $ envelope digest --hex $ENVELOPE
8182
$ ENCRYPTED_ENVELOPE=`envelope encrypt --key $KEY $ENVELOPE`
8283
$ envelope format --diag $ENCRYPTED_ENVELOPE
8384
84-
200( ; envelope
85-
40002( ; encrypted
85+
200( / envelope /
86+
40002( / encrypted /
8687
[
8788
h'dadeecba53db714445c0',
8889
h'3cda0648bcb07f0f8b4da2be',

papers/bcr-2023-005-envelope-compression.md

+7-6
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,8 @@ This section is normative, and specifies an additional case arm for the `envelop
2525
The formal language used is the [Concise Data Definition Language (CDDL)](https://datatracker.ietf.org/doc/html/rfc8610). The top-level specification of Gordian Envelope with this extension added is:
2626

2727
~~~
28-
envelope = #6.200(
28+
envelope = #6.200(envelope-content)
29+
envelope-content = (
2930
leaf / elided / node / assertion / wrapped /
3031
compressed
3132
)
@@ -70,8 +71,8 @@ $ ENVELOPE=`envelope subject "Hello"`
7071
7172
$ envelope format --diag $ENVELOPE
7273
73-
200( ; envelope
74-
24("Hello") ; leaf
74+
200( / envelope /
75+
24("Hello") / leaf /
7576
)
7677
7778
$ envelope digest --hex $ENVELOPE
@@ -81,13 +82,13 @@ $ envelope digest --hex $ENVELOPE
8182
$ COMPRESSED_ENVELOPE=`envelope compress $ENVELOPE`
8283
$ envelope format --diag $COMPRESSED_ENVELOPE
8384
84-
200( ; envelope
85-
40003( ; compressed
85+
200( / envelope /
86+
40003( / compressed /
8687
[
8788
1146116589,
8889
10,
8990
h'd8c8d8186548656c6c6f',
90-
40001( ; digest
91+
40001( / digest /
9192
h'4d303dac9eed63573f6190e9c4191be619e03a7b3c21e9bb3d27ac1a55971e6b'
9293
)
9394
]

0 commit comments

Comments
 (0)