Gitiles
Code Review Sign In
gerrit.named-data.net / NDN-TLV / 459e46670b48c8c513034ef53fd8f03d92df1385 / . / changelog.rst
blob: 94c68d8fae0ce5010ec0a64c536af3fbb30c4c4f [file] [log] [blame]
Alexander Afanasyeva6fc7272014-06-13 11:58:06 -0700[diff] [blame]1Changes
2=======
3
Alexander Afanasyeve9f48512018-01-15 23:44:50 -0500[diff] [blame]4Version 0.3
5-----------
6
Junxiao Shi78ce2952019-05-07 15:34:00 -0400[diff] [blame]7- Rewrite TLV syntax specifications using `IETF Augmented BNF (RFC 5234) <https://tools.ietf.org/html/rfc5234>`__
8
Junxiao Shi459e4662019-05-31 15:28:03 +0000[diff] [blame^]9 + Require shortest encoding for TLV-TYPE and TLV-LENGTH numbers
10
Alexander Afanasyeve9f48512018-01-15 23:44:50 -0500[diff] [blame]11- **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 -0400[diff] [blame]18 + Add optional ``ApplicationParameters`` element
19 + Define a new specification for Signed Interest using new optional elements ``InterestSignatureInfo`` and ``InterestSignatureValue``
Alexander Afanasyeve9f48512018-01-15 23:44:50 -0500[diff] [blame]20
21- **Data**
22
23 + Make ``MetaInfo`` and ``Content`` elements optional
24 + Change semantics of omitted (or set to zero) ``FreshnessPeriod`` element: it cannot be used to satisfy
25 Interests with ``MustBeFresh``
26
27- **Name**
28
29 + Lift restriction on name component types, allowing types in the range ``1`` - ``32767``.
30 + Correct definition of name URI encoding: disallow unescaped encoding of PLUS ``+`` and allow TILDE ``~``.
Alexander Afanasyev9013a562018-08-08 09:48:41 -0400[diff] [blame]31 + Add ``ParametersSha256DigestComponent``
Alexander Afanasyeve9f48512018-01-15 23:44:50 -0500[diff] [blame]32
Alexander Afanasyev13f86d82018-01-31 12:50:34 -0500[diff] [blame]33Version 0.2.1
34-------------
spirosmastorakis988e7412016-10-27 14:01:59 -0700[diff] [blame]35
36- Add definition of Link Object
37
38- **Interest**
39
Alexander Afanasyeve9f48512018-01-15 23:44:50 -0500[diff] [blame]40 + Add default of leftmost child if ChildSelector element not present
41 + Add specification of ForwardingHint element
spirosmastorakis988e7412016-10-27 14:01:59 -0700[diff] [blame]42
Eric Newberry56519862017-02-13 13:26:19 -0700[diff] [blame]43- **Data**
44
45 + Updated Content Store semantics for Data packets that do not carry FreshnessPeriod.
46
spirosmastorakis988e7412016-10-27 14:01:59 -0700[diff] [blame]47************************************************************
48
Alexander Afanasyeve9f48512018-01-15 23:44:50 -0500[diff] [blame]49Version 0.2
Alexander Afanasyev13f86d82018-01-31 12:50:34 -0500[diff] [blame]50-----------
Junxiao Shia0d36822014-09-21 11:32:09 -0700[diff] [blame]51
52- **Name**
53
54 + Allow zero-length name component
Alexander Afanasyev4b8be212014-10-06 10:55:04 -0700[diff] [blame]55 + Require implicit digest to be specified using ``ImplicitSha256Digest`` name component
Junxiao Shia0d36822014-09-21 11:32:09 -0700[diff] [blame]56
Alexander Afanasyev948affe2016-09-13 13:15:29 -0700[diff] [blame]57- **Signature**
58
59 + Add spec for ``SignatureHmacWithSha256``
60
Junxiao Shidef7fc52015-06-10 13:29:21 -0700[diff] [blame]61- **Interest**
62
63 + Delete deprecated ``Scope`` guider
Alexander Afanasyev948affe2016-09-13 13:15:29 -0700[diff] [blame]64 + Restrict Interest to have name with at least one name component
65
66- **Data**
67
68 + 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 -0700[diff] [blame]69
Junxiao Shi4406fdd2015-06-10 13:28:10 -0700[diff] [blame]70- **TLV-TYPE**
71
72 + Reserve 800-1000 range for link protocol
73
spirosmastorakis988e7412016-10-27 14:01:59 -0700[diff] [blame]74************************************************************
75
Alexander Afanasyev13f86d82018-01-31 12:50:34 -0500[diff] [blame]76Version 0.1.1
77-------------
Alexander Afanasyeva6fc7272014-06-13 11:58:06 -0700[diff] [blame]78
79- **Signature**
80
Alexander Afanasyev4b896112014-06-23 21:47:15 -0700[diff] [blame]81 + New ``SignatureSha256WithEcdsa`` signature type for Elliptic Curve Digital Signature Algorithm (ECDSA).
Alexander Afanasyevf3e5e852014-06-13 22:44:02 -0700[diff] [blame]82 + ``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 -0500[diff] [blame]83 + ``KeyLocator`` element is now defined to be optionally present in generic ``SignatureInfo`` element.
Alexander Afanasyev4b896112014-06-23 21:47:15 -0700[diff] [blame]84 ``SignatureSha256WithRsa`` and ``SignatureSha256WithEcdsa`` still require ``KeyLocator`` to be always present.
Alexander Afanasyeva6fc7272014-06-13 11:58:06 -0700[diff] [blame]85
spirosmastorakis988e7412016-10-27 14:01:59 -0700[diff] [blame]86************************************************************
87
Alexander Afanasyev13f86d82018-01-31 12:50:34 -0500[diff] [blame]88Version 0.1
89-----------
Alexander Afanasyeva6fc7272014-06-13 11:58:06 -0700[diff] [blame]90
91- **General**
92
93 + XML-based ccnb packet encoding is replaced by TLV encoding
94
95- **Name**
96
97 + The name encoding is changed from binary XML to TLV format
98 + 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
99 + Deprecated zero-length name component
100
101- **Interest Packet**
102
103 + ``Nonce`` is changed from optional to required
104 + ``PublisherPublicKeyDigest`` is replaced by ``PublisherPublicKeyLocator``
105 + ``AnswerOriginKind`` is simplified from 4bits to a 1-bit ``MustBeFresh``
106 + ``FaceID`` has been removed
107 + ``InterestLifetime`` changes the unit to the number of milliseconds
108 + Removed Bloom Filter from Exclude
109 + Changed default semantics of staleness
110
111 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.
112 With Binary XML encoded Interests, the default behavior was to bring "fresh" data and return "stale" data only when ``AnswerOriginKind`` was set to 3.
113
114 Application developers must be aware of this change, reexamine the Interest expression code, and enable ``MustBeFresh`` selector when necessary.
115
116- **Data Packet**
117
118 + The structure of Data packet is changed:
119
120 * ``Name``, ``MetaInfo``, ``Content``, ``Signature{SignatureInfo, SignatureValue}``
121
122 + ``SignedInfo`` is renamed to ``MetaInfo`` and its content is changed
123 + ``PublisherPublicKeyDigest`` and ``ExtOpt`` are removed.
124 + ``Timestamp`` is removed
Alexander Afanasyeve9f48512018-01-15 23:44:50 -0500[diff] [blame]125 + ``KeyLocator`` is moved to be inside the ``Signature`` (``SignatureInfo``) element
Alexander Afanasyeva6fc7272014-06-13 11:58:06 -0700[diff] [blame]126 + Three content types, ENCR, GONE, and NACK are removed
127 + ``FreshnessSeconds`` is renamed to ``FreshnessPeriod`` and is expressed in units of milliseconds
128
129- **Signature**
130
131 + ``Signature`` is moved to the end of Data packet.
Alexander Afanasyeve9f48512018-01-15 23:44:50 -0500[diff] [blame]132 + ``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 -0700[diff] [blame]133
134 The rationale for the move is to make Signature (sequence of ``SignatureInfo`` and ``SignatureValue`` TLVs) self-contained and self-sufficient.
135
136 + Signature type (or signing method information) is expressed as an assigned integer value (with no assumed default), rather than OID.
137 + Added support for hash-only "signature"
138 + 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