blob: c6b611aa2be5bcf08bf656f3ccd5d03f558be5bf [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
Davide Pesavento4d6c3572022-05-27 12:05:05 -04007- Rewrite TLV syntax specifications using IETF Augmented BNF (:rfc:`5234`)
Junxiao Shi78ce2952019-05-07 15:34:00 -04008
Davide Pesaventocf4903e2021-11-08 22:06:22 -05009- Require shortest encoding for TLV-TYPE and TLV-LENGTH numbers
Junxiao Shi459e4662019-05-31 15:28:03 +000010
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 Afanasyev9fba5f42021-12-21 12:40:17 -050020 + Redefine the contents of the ``ForwardingHint`` (remove numerical preference and nesting inside the ``Delegation`` TLV)
Alexander Afanasyeve9f48512018-01-15 23:44:50 -050021
22- **Data**
23
24 + Make ``MetaInfo`` and ``Content`` elements optional
Davide Pesavento3c0bc312020-05-18 22:03:09 -040025 + 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 -050026
Alexander Afanasyev9fba5f42021-12-21 12:40:17 -050027- **LinkObject**
28
29 + The content is now just a list of names (remove numerical preference)
30
Alexander Afanasyeve9f48512018-01-15 23:44:50 -050031- **Name**
32
Davide Pesaventocf4903e2021-11-08 22:06:22 -050033 + Lift restriction on name component types, allowing types in the range 1-65535
34 + Correct definition of name URI encoding: disallow unescaped encoding of PLUS (``+``) and allow TILDE (``~``)
Alexander Afanasyev85f77b12021-10-26 17:44:35 -040035 + Add well-known special-use component types:
36
37 - ``ParametersSha256DigestComponent`` (type 2)
38 - ``KeywordNameComponent`` (type 32)
39 - ``SegmentNameComponent`` (type 50)
40 - ``ByteOffsetNameComponent`` (type 52)
41 - ``VersionNameComponent`` (type 54)
42 - ``TimestampNameComponent`` (type 56)
43 - ``SequenceNumNameComponent`` (type 58)
Alexander Afanasyeve9f48512018-01-15 23:44:50 -050044
Davide Pesavento3c0bc312020-05-18 22:03:09 -040045- **Signature**
46
47 + Require all compliant implementations to support the ``SignatureSha256WithEcdsa`` signature type using NIST curve P-256
48 + Redefine the signed portion of Data packets to be more future-proof
Junxiao Shiac25eab2022-05-27 10:52:17 +000049 + Add ``SignatureEd25519`` signature type
Davide Pesavento3c0bc312020-05-18 22:03:09 -040050
Alexander Afanasyev13f86d82018-01-31 12:50:34 -050051Version 0.2.1
52-------------
spirosmastorakis988e7412016-10-27 14:01:59 -070053
54- Add definition of Link Object
55
56- **Interest**
57
Alexander Afanasyeve9f48512018-01-15 23:44:50 -050058 + Add default of leftmost child if ChildSelector element not present
59 + Add specification of ForwardingHint element
spirosmastorakis988e7412016-10-27 14:01:59 -070060
Eric Newberry56519862017-02-13 13:26:19 -070061- **Data**
62
63 + Updated Content Store semantics for Data packets that do not carry FreshnessPeriod.
64
Alexander Afanasyeve9f48512018-01-15 23:44:50 -050065Version 0.2
Alexander Afanasyev13f86d82018-01-31 12:50:34 -050066-----------
Junxiao Shia0d36822014-09-21 11:32:09 -070067
68- **Name**
69
70 + Allow zero-length name component
Alexander Afanasyev4b8be212014-10-06 10:55:04 -070071 + Require implicit digest to be specified using ``ImplicitSha256Digest`` name component
Junxiao Shia0d36822014-09-21 11:32:09 -070072
Alexander Afanasyev948affe2016-09-13 13:15:29 -070073- **Signature**
74
75 + Add spec for ``SignatureHmacWithSha256``
76
Junxiao Shidef7fc52015-06-10 13:29:21 -070077- **Interest**
78
79 + Delete deprecated ``Scope`` guider
Alexander Afanasyev948affe2016-09-13 13:15:29 -070080 + Restrict Interest to have name with at least one name component
81
82- **Data**
83
84 + 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 -070085
Junxiao Shi4406fdd2015-06-10 13:28:10 -070086- **TLV-TYPE**
87
88 + Reserve 800-1000 range for link protocol
89
Alexander Afanasyev13f86d82018-01-31 12:50:34 -050090Version 0.1.1
91-------------
Alexander Afanasyeva6fc7272014-06-13 11:58:06 -070092
93- **Signature**
94
Alexander Afanasyev4b896112014-06-23 21:47:15 -070095 + New ``SignatureSha256WithEcdsa`` signature type for Elliptic Curve Digital Signature Algorithm (ECDSA).
Alexander Afanasyevf3e5e852014-06-13 22:44:02 -070096 + ``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 -050097 + ``KeyLocator`` element is now defined to be optionally present in generic ``SignatureInfo`` element.
Alexander Afanasyev4b896112014-06-23 21:47:15 -070098 ``SignatureSha256WithRsa`` and ``SignatureSha256WithEcdsa`` still require ``KeyLocator`` to be always present.
Alexander Afanasyeva6fc7272014-06-13 11:58:06 -070099
Alexander Afanasyev13f86d82018-01-31 12:50:34 -0500100Version 0.1
101-----------
Alexander Afanasyeva6fc7272014-06-13 11:58:06 -0700102
103- **General**
104
105 + XML-based ccnb packet encoding is replaced by TLV encoding
106
107- **Name**
108
109 + The name encoding is changed from binary XML to TLV format
110 + 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
111 + Deprecated zero-length name component
112
113- **Interest Packet**
114
115 + ``Nonce`` is changed from optional to required
116 + ``PublisherPublicKeyDigest`` is replaced by ``PublisherPublicKeyLocator``
117 + ``AnswerOriginKind`` is simplified from 4bits to a 1-bit ``MustBeFresh``
118 + ``FaceID`` has been removed
119 + ``InterestLifetime`` changes the unit to the number of milliseconds
120 + Removed Bloom Filter from Exclude
121 + Changed default semantics of staleness
122
123 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.
124 With Binary XML encoded Interests, the default behavior was to bring "fresh" data and return "stale" data only when ``AnswerOriginKind`` was set to 3.
125
126 Application developers must be aware of this change, reexamine the Interest expression code, and enable ``MustBeFresh`` selector when necessary.
127
128- **Data Packet**
129
130 + The structure of Data packet is changed:
131
132 * ``Name``, ``MetaInfo``, ``Content``, ``Signature{SignatureInfo, SignatureValue}``
133
134 + ``SignedInfo`` is renamed to ``MetaInfo`` and its content is changed
135 + ``PublisherPublicKeyDigest`` and ``ExtOpt`` are removed.
136 + ``Timestamp`` is removed
Alexander Afanasyeve9f48512018-01-15 23:44:50 -0500137 + ``KeyLocator`` is moved to be inside the ``Signature`` (``SignatureInfo``) element
Alexander Afanasyeva6fc7272014-06-13 11:58:06 -0700138 + Three content types, ENCR, GONE, and NACK are removed
139 + ``FreshnessSeconds`` is renamed to ``FreshnessPeriod`` and is expressed in units of milliseconds
140
141- **Signature**
142
143 + ``Signature`` is moved to the end of Data packet.
Alexander Afanasyeve9f48512018-01-15 23:44:50 -0500144 + ``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 -0700145
146 The rationale for the move is to make Signature (sequence of ``SignatureInfo`` and ``SignatureValue`` TLVs) self-contained and self-sufficient.
147
148 + Signature type (or signing method information) is expressed as an assigned integer value (with no assumed default), rather than OID.
149 + Added support for hash-only "signature"
150 + 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