blob: ba86ec21866d80c5e7409a29e76b9dfb0583ce5f [file] [log] [blame]
Alexander Afanasyeva6fc7272014-06-13 11:58:06 -07001Changes
2=======
3
Alexander Afanasyeve9f48512018-01-15 23:44:50 -05004Version 0.3
5-----------
6
Junxiao Shi78ce2952019-05-07 15:34:00 -04007- Rewrite TLV syntax specifications using `IETF Augmented BNF (RFC 5234) <https://tools.ietf.org/html/rfc5234>`__
8
Junxiao Shi459e4662019-05-31 15:28:03 +00009 + Require shortest encoding for TLV-TYPE and TLV-LENGTH numbers
10
Alexander Afanasyeve9f48512018-01-15 23:44:50 -050011- **Interest**
12
13 + Remove ``Selectors`` element
14 + Add optional ``CanBePrefix`` element after Name
15 + Move optional ``MustBeFresh`` element after ``CanBePrefix``
16 + Move optional ``ForwardingHint`` element after ``MustBeFresh`` (before ``Nonce``)
17 + Add optional ``HopLimit`` element
Zhiyi Zhang0c04fd82018-09-04 16:29:47 -040018 + Add optional ``ApplicationParameters`` element
Davide Pesavento3c0bc312020-05-18 22:03:09 -040019 + Define a new specification for Signed Interest using two new elements: ``InterestSignatureInfo`` and ``InterestSignatureValue``
Alexander Afanasyeve9f48512018-01-15 23:44:50 -050020
21- **Data**
22
23 + Make ``MetaInfo`` and ``Content`` elements optional
Davide Pesavento3c0bc312020-05-18 22:03:09 -040024 + Change semantics of omitted (or set to zero) ``FreshnessPeriod`` element: it cannot be used to satisfy Interests with ``MustBeFresh``
Alexander Afanasyeve9f48512018-01-15 23:44:50 -050025
26- **Name**
27
Davide Pesavento3c0bc312020-05-18 22:03:09 -040028 + Lift restriction on name component types, allowing types in the range ``1`` - ``32767``
29 + Correct definition of name URI encoding: disallow unescaped encoding of PLUS ``+`` and allow TILDE ``~``
Alexander Afanasyev85f77b12021-10-26 17:44:35 -040030 + Add well-known special-use component types:
31
32 - ``ParametersSha256DigestComponent`` (type 2)
33 - ``KeywordNameComponent`` (type 32)
34 - ``SegmentNameComponent`` (type 50)
35 - ``ByteOffsetNameComponent`` (type 52)
36 - ``VersionNameComponent`` (type 54)
37 - ``TimestampNameComponent`` (type 56)
38 - ``SequenceNumNameComponent`` (type 58)
Alexander Afanasyeve9f48512018-01-15 23:44:50 -050039
Davide Pesavento3c0bc312020-05-18 22:03:09 -040040- **Signature**
41
42 + Require all compliant implementations to support the ``SignatureSha256WithEcdsa`` signature type using NIST curve P-256
43 + Redefine the signed portion of Data packets to be more future-proof
44
Alexander Afanasyev13f86d82018-01-31 12:50:34 -050045Version 0.2.1
46-------------
spirosmastorakis988e7412016-10-27 14:01:59 -070047
48- Add definition of Link Object
49
50- **Interest**
51
Alexander Afanasyeve9f48512018-01-15 23:44:50 -050052 + Add default of leftmost child if ChildSelector element not present
53 + Add specification of ForwardingHint element
spirosmastorakis988e7412016-10-27 14:01:59 -070054
Eric Newberry56519862017-02-13 13:26:19 -070055- **Data**
56
57 + Updated Content Store semantics for Data packets that do not carry FreshnessPeriod.
58
Alexander Afanasyeve9f48512018-01-15 23:44:50 -050059Version 0.2
Alexander Afanasyev13f86d82018-01-31 12:50:34 -050060-----------
Junxiao Shia0d36822014-09-21 11:32:09 -070061
62- **Name**
63
64 + Allow zero-length name component
Alexander Afanasyev4b8be212014-10-06 10:55:04 -070065 + Require implicit digest to be specified using ``ImplicitSha256Digest`` name component
Junxiao Shia0d36822014-09-21 11:32:09 -070066
Alexander Afanasyev948affe2016-09-13 13:15:29 -070067- **Signature**
68
69 + Add spec for ``SignatureHmacWithSha256``
70
Junxiao Shidef7fc52015-06-10 13:29:21 -070071- **Interest**
72
73 + Delete deprecated ``Scope`` guider
Alexander Afanasyev948affe2016-09-13 13:15:29 -070074 + Restrict Interest to have name with at least one name component
75
76- **Data**
77
78 + Redirect ContentType number assignments to the `wiki page <https://redmine.named-data.net/projects/ndn-tlv/wiki/ContentType>`__
Junxiao Shidef7fc52015-06-10 13:29:21 -070079
Junxiao Shi4406fdd2015-06-10 13:28:10 -070080- **TLV-TYPE**
81
82 + Reserve 800-1000 range for link protocol
83
Alexander Afanasyev13f86d82018-01-31 12:50:34 -050084Version 0.1.1
85-------------
Alexander Afanasyeva6fc7272014-06-13 11:58:06 -070086
87- **Signature**
88
Alexander Afanasyev4b896112014-06-23 21:47:15 -070089 + New ``SignatureSha256WithEcdsa`` signature type for Elliptic Curve Digital Signature Algorithm (ECDSA).
Alexander Afanasyevf3e5e852014-06-13 22:44:02 -070090 + ``KeyLocatorDigest`` renamed to ``KeyDigest``. The specification now explicitly allows KeyDigest to be a SHA256 of any type of the key.
Alexander Afanasyeve9f48512018-01-15 23:44:50 -050091 + ``KeyLocator`` element is now defined to be optionally present in generic ``SignatureInfo`` element.
Alexander Afanasyev4b896112014-06-23 21:47:15 -070092 ``SignatureSha256WithRsa`` and ``SignatureSha256WithEcdsa`` still require ``KeyLocator`` to be always present.
Alexander Afanasyeva6fc7272014-06-13 11:58:06 -070093
Alexander Afanasyev13f86d82018-01-31 12:50:34 -050094Version 0.1
95-----------
Alexander Afanasyeva6fc7272014-06-13 11:58:06 -070096
97- **General**
98
99 + XML-based ccnb packet encoding is replaced by TLV encoding
100
101- **Name**
102
103 + The name encoding is changed from binary XML to TLV format
104 + The discussions on naming conventions and the use of special markers inside NameComponents are removed from packet specification, and will be covered by a separate technical document
105 + Deprecated zero-length name component
106
107- **Interest Packet**
108
109 + ``Nonce`` is changed from optional to required
110 + ``PublisherPublicKeyDigest`` is replaced by ``PublisherPublicKeyLocator``
111 + ``AnswerOriginKind`` is simplified from 4bits to a 1-bit ``MustBeFresh``
112 + ``FaceID`` has been removed
113 + ``InterestLifetime`` changes the unit to the number of milliseconds
114 + Removed Bloom Filter from Exclude
115 + Changed default semantics of staleness
116
117 Specifically, NDN-TLV Interest without any selectors will bring any data that matches the name, and only when ``MustBeFresh`` selector is enabled it will try to honor freshness, specified in Data packets.
118 With Binary XML encoded Interests, the default behavior was to bring "fresh" data and return "stale" data only when ``AnswerOriginKind`` was set to 3.
119
120 Application developers must be aware of this change, reexamine the Interest expression code, and enable ``MustBeFresh`` selector when necessary.
121
122- **Data Packet**
123
124 + The structure of Data packet is changed:
125
126 * ``Name``, ``MetaInfo``, ``Content``, ``Signature{SignatureInfo, SignatureValue}``
127
128 + ``SignedInfo`` is renamed to ``MetaInfo`` and its content is changed
129 + ``PublisherPublicKeyDigest`` and ``ExtOpt`` are removed.
130 + ``Timestamp`` is removed
Alexander Afanasyeve9f48512018-01-15 23:44:50 -0500131 + ``KeyLocator`` is moved to be inside the ``Signature`` (``SignatureInfo``) element
Alexander Afanasyeva6fc7272014-06-13 11:58:06 -0700132 + Three content types, ENCR, GONE, and NACK are removed
133 + ``FreshnessSeconds`` is renamed to ``FreshnessPeriod`` and is expressed in units of milliseconds
134
135- **Signature**
136
137 + ``Signature`` is moved to the end of Data packet.
Alexander Afanasyeve9f48512018-01-15 23:44:50 -0500138 + ``KeyLocator`` is moved to be a part of the ``SignatureInfo`` element, if it is applicable for the specific signature type.
Alexander Afanasyeva6fc7272014-06-13 11:58:06 -0700139
140 The rationale for the move is to make Signature (sequence of ``SignatureInfo`` and ``SignatureValue`` TLVs) self-contained and self-sufficient.
141
142 + Signature type (or signing method information) is expressed as an assigned integer value (with no assumed default), rather than OID.
143 + Added support for hash-only "signature"
144 + The current specification does not define Merkle Hash Tree Aggregated Signatures, but it is expected that such (or similar) signatures will be defined in future version of this specification