blob: 27a076240b600a76f3e1b806a32db5692285d77c [file] [log] [blame]
Alexander Afanasyevd36dd552014-06-30 12:42:46 -07001.. _Release Notes:
Alexander Afanasyevabaab522014-04-30 20:42:11 -07002
Alexander Afanasyevd36dd552014-06-30 12:42:46 -07003ndn-cxx Release Notes
4---------------------
5
Alexander Afanasyevec0499f2014-07-30 12:11:01 -07006ndn-cxx v0.2.0 (changes since version 0.1.0)
7++++++++++++++++++++++++++++++++++++++++++++
8
9Release date: August 25, 2014
Alexander Afanasyevd36dd552014-06-30 12:42:46 -070010
11New features:
12^^^^^^^^^^^^^
13
14- **Base**
15
16 + The license under which the library is released is changed to **Lesser GNU Public
17 License version 3.0**.
18
19 + New ways to use incoming Interest dispatching:
20
21 * New :ndn-cxx:`InterestFilter` abstraction that supports filtering based on name
22 prefixes and regular expressions.
23
24 * Separated :ndn-cxx:`Face::registerPrefix()` and :ndn-cxx:`Face::setInterestFilter()`
25 methods allow distinct operations of registering with the local NDN forwarder and setting
26 up application-specific ``OnInterest`` call dispatch using InterestFilters.
27
Alexander Afanasyevec0499f2014-07-30 12:11:01 -070028 + Add support for new `NDN naming conventions
29 <http://named-data.net/doc/tech-memos/naming-conventions.pdf>`_
30 (`Issue #1761 <http://redmine.named-data.net/issues/1761>`_)
31
Alexander Afanasyevd36dd552014-06-30 12:42:46 -070032- **Security**
33
34 + Add ``type dir`` :ref:`trust-anchor in ValidatorConfig <validator-conf-trust-anchors>`
35 to add all certificates under the specified directory as trust anchors.
36 The new option also allow periodic reloading trust anchors, allowing dynamic trust
37 models.
38
39 + Added support for multiple signature types to :ndn-cxx:`PublicKey`,
40 :ndn-cxx:`SecPublicInfo` abstractions
41
42 + New :ndn-cxx:`SignatureSha256WithEcdsa` signature type
43
Alexander Afanasyevec0499f2014-07-30 12:11:01 -070044 + Updates in :ndn-cxx:`Signature` data structure to reflect changes in `NDN-TLV spec
45 0.1.1 <http://named-data.net/doc/NDN-TLV/0.1.1/>`_
46
Alexander Afanasyevd36dd552014-06-30 12:42:46 -070047- **Wire encoding**
48
49 + :ndn-cxx:`Data::getFullName() <getFullName()>` method to get :ndn-cxx:`Data` packet
50 name with implicit digest
51
52 + New :ndn-cxx:`Name::getSuccessor()` method to get `name successor
53 <http://redmine.named-data.net/issues/1677>`_
54
Alexander Afanasyevec0499f2014-07-30 12:11:01 -070055 + New in-wire refreshing of Interest's nonce
56 (`Issue #1758 <http://redmine.named-data.net/issues/1758>`_)
57
Alexander Afanasyevd36dd552014-06-30 12:42:46 -070058- **Management**
59
60 + Support for :ndn-cxx:`ChannelStatus`, :ndn-cxx:`StrategyChoice` datasets
61
Alexander Afanasyevec0499f2014-07-30 12:11:01 -070062 + Defining new common Route Origins for NFD RIB management protocol
63 (`Issue #1719 <http://redmine.named-data.net/issues/1719>`_)
64
65 + New RibEntry and Route data structures for RIB management protocol
66 (`Issue #1764 <http://redmine.named-data.net/issues/1764>`_)
67
68 + Add support for RIB flags for setInterestFilter and registerPrefix
69 (`Issue #1842 <http://redmine.named-data.net/issues/1842>`_)
70
71- **Miscellaneous tools**
72
73 + Introduce :ndn-cxx:`Scheduler::cancelAllEvents` to cancel all previously scheduled events
74 (`Issue #1757 <http://redmine.named-data.net/issues/1757>`_)
75
76 + Introduce :ndn-cxx:`util::EventEmitter`, :ndn-cxx:`util::NotificationSubscriber`,
77 :ndn-cxx:`util::NotificationStream`, and :ndn-cxx:`nfd::FaceMonitor` utility classes
78
79 + Introduce :ndn-cxx:`util::SegmentFetcher` helper class to fetch multi-segmented data
80 (`Issue #1879 <http://redmine.named-data.net/issues/1879>`_)
81
Alexander Afanasyevd36dd552014-06-30 12:42:46 -070082- **Build**
83
84 + enabled support of precompiled headers for clang and gcc compilers to speed up compilation
85
86Updates and bug fixes:
87^^^^^^^^^^^^^^^^^^^^^^
88
Alexander Afanasyevec0499f2014-07-30 12:11:01 -070089- **Base**
90
91 + Serialization of socket write operations
92 (`Issue #1707 <http://redmine.named-data.net/issues/1707>`_)
93
94 + Enforcing limit on Interest and Data packet size in :ndn-cxx:`Face::expressInterest`
95 and :ndn-cxx:`Face::put` methods
96 (`Issue #1774 <http://redmine.named-data.net/issues/1774>`_)
97
98 + Cleaning up transport state on communication failure, so Face can try to reconnect
99 in the future.
100
101 + Fix bug with Face::removePendingInterest
102 (`Issue #1917 <http://redmine.named-data.net/issues/1917>`_)
103
Alexander Afanasyevd36dd552014-06-30 12:42:46 -0700104- **Wire encoding**
105
106 + Nonce field is now encoded as 4-byte uint8_t value, as defined by NDN-TLV spec.
107
108 + Optimized Data packet signing
109
110 :ndn-cxx:`KeyChain::sign` method now pre-allocates :ndn-cxx:`EncodingBuffer`, requests
111 unsigned portion of :ndn-cxx:`Data` using ``Data::wireEncode(EncodingBuffer, true)``,
112 and then appends the resulting signature and prepends :ndn-cxx:`Data` packet header.
113 This way there is no extra memory allocation after :ndn-cxx:`Data` packet is signed.
114
Alexander Afanasyevec0499f2014-07-30 12:11:01 -0700115 + Optimized implicit digest calculation in :ndn-cxx:`Interest::matchesData` method
116 (`Issue #1769 <http://redmine.named-data.net/issues/1769>`_)
117
118- **Management**
119
120 + Add link-layer byte counts in FaceStatus data structure
121 (`Issue #1765 <http://redmine.named-data.net/issues/1765>`_)
122
Alexander Afanasyevd36dd552014-06-30 12:42:46 -0700123- **Security**
124
125 + Allow user to explicitly specify the cert name prefix before 'KEY' component in
126 ``ndnsec-certgen``
127
128 + ``SignatureSha256`` has been renamed to :ndn-cxx:`DigestSha256` to conform with
129 `NDN-TLV specification <http://named-data.net/doc/ndn-tlv/>`_.
130
131 + Add checking of ``Timestamp`` and ``Nonce`` fields in signed Interest within
132 :ndn-cxx:`ValidatorConfig`
133
134 + Allow validator customization using hooks:
135
136 Sub-classes of :ndn-cxx:`Validator` class can use the following hooks to fine-tune the
137 validation process:
138
139 * :ndn-cxx:`Validator::preCertificateValidation <preCertificateValidation>` to
140 process received certificate before validation.
141 * :ndn-cxx:`Validator::onTimeout <onTimeout>` to process interest timeout
142 * :ndn-cxx:`Validator::afterCheckPolicy <afterCheckPolicy>` to process validation requests.
143
Alexander Afanasyevec0499f2014-07-30 12:11:01 -0700144 + Fix memory issues in :ndn-cxx:`SecPublicInfoSqlite`
145
146- **Miscellaneous tools**
147
148 + Redefine method for random number generation: ``random::generateWord*`` and
149 ``random::generateSecureWord*`` to generate cryptographically non-secure (fast) and
150 secure (slow) random numbers.
151
Alexander Afanasyevd36dd552014-06-30 12:42:46 -0700152- Other minor fixes and corrections
153
154Deprecated:
155^^^^^^^^^^^
156
157- ``SignatureSha256`` class, use :ndn-cxx:`DigestSha256` instead.
158
159- All :ndn-cxx:`Face` constructors that accept ``shared_ptr<io_service>``.
160
161 Use versions that accept reference to ``io_service`` object.
162
163- ``Face::ioService`` method, use :ndn-cxx:`Face::getIoService` instead.
164
165- :ndn-cxx:`Interest` constructor that accepts name, individual selectors, and individual
166 guiders as constructor parameters.
167
168 Use ``Interest().setX(...).setY(...)`` or use the overload taking ``Selectors``
169
170- ``name::Component::toEscapedString`` method, use :ndn-cxx:`name::Component::toUri` instead.
171
172- ``SecPublicInfo::addPublicKey`` method, use :ndn-cxx:`SecPublicInfo::addKey` instead.
173
174- ``Tlv::ConentType`` constant (typo), use ``Tlv::ContentType`` instead.
175
Alexander Afanasyevec0499f2014-07-30 12:11:01 -0700176- ``CommandInterestGenerator`` and ``CommandInterestValidator`` utility classes.
177 :ndn-cxx:`ValidatorConfig` should be used instead.
178
Alexander Afanasyevd36dd552014-06-30 12:42:46 -0700179Removed:
180^^^^^^^^
181
182- support of ndnd-tlv (only NFD management protocol is supported now)
183
184- ``SecPublicInfoMemory`` and ``SecTpmMemory`` classes that were no longer used
185
186- Removing concept of periodic event from :ndn-cxx:`Scheduler`.
187
188 In applications, periodic events should be just re-scheduled within the callback for
189 single-shot events.
190
191
192
193ndn-cxx v0.1.0
194++++++++++++++
Alexander Afanasyevc5452c52014-04-29 17:21:51 -0700195
Alexander Afanasyevec0499f2014-07-30 12:11:01 -0700196Release date: May 7, 2014
197
Alexander Afanasyevc5452c52014-04-29 17:21:51 -0700198Version 0.1.0 is the initial release of ndn-cxx, an NDN C++ library with eXperimental
199eXtensions.
200
201Originally based on `ndn-cpp library <https://github.com/named-data/ndn-cpp>`_ the ndn-cxx
Lixia Zhangc5fdfe72014-04-30 09:33:43 -0700202library adopts a slightly different design philosophy (including an extensive use of Boost
203libraries to facilitate development, as well as the use of Crypto++ library to support
204cryptographic operations), and includes a number of extensions that aim to simplify NDN
205application development.
Alexander Afanasyevc5452c52014-04-29 17:21:51 -0700206
207The current features include:
208
209- **Base**
210
Lixia Zhangc5fdfe72014-04-30 09:33:43 -0700211 + Fully asynchronous, event-driven communication model, which is implemented using `Boost.Asio
Alexander Afanasyevc5452c52014-04-29 17:21:51 -0700212 <http://www.boost.org/doc/libs/1_48_0/doc/html/boost_asio.html>`_
213 + Single-threaded, but thread-safe Face operations
214
215 A single Face object can be safely used in multiple threads to express Interests and
216 publish Data packets
217
218 + Explicit time management for NDN operations using `Boost.Chrono
219 <http://www.boost.org/doc/libs/1_48_0/doc/html/chrono.html>`_
220 + Simplified and extended `NDN API <doxygen/annotated.html>`_
221 + Extensive set of unit-tests based on `Boost.Test framework
222 <http://www.boost.org/doc/libs/1_48_0/libs/test/doc/html/index.html>`_
223
224 - Continuous integration using an in-house installation of Jenkins build bots and the
Lixia Zhangc5fdfe72014-04-30 09:33:43 -0700225 hosted `Travis CI <https://travis-ci.org/named-data/ndn-cxx>`_ continuous
226 integration service compile and verify correctness of the library for each commit
Alexander Afanasyevc5452c52014-04-29 17:21:51 -0700227
228- **Wire format**
229
230 + Full support of `NDN-TLV packet format v0.1 <http://named-data.net/doc/NDN-TLV/0.1/>`_
231 + Pure C++ implementation of wire encoding/decoding with simple access to wire format
232 of all NDN packet abstractions via ``wireEncode`` and ``wireDecode`` methods
233
234 In many cases, NDN packet abstractions are just "indices" to the wire format
235
Alexander Afanasyevc5452c52014-04-29 17:21:51 -0700236- **Communication with the forwarder**
237
238 + Enable connecting to local forwarder via UNIX and TCP transports and to remote
239 forwarders using TCP transport
240 + Full support for communication with `Named Data Networking Forwarding Daemon (NFD)
241 <https://github.com/named-data/NFD>`_
242
243 - Full support for `NFD management protocols
244 <http://redmine.named-data.net/projects/nfd/wiki/Management>`_ to NFD status
245 information, create and manage NFD Faces, receive NFD Face status change
246 notifications, update StrategyChoice for namespaces, and manage routes in RIB
247 - Support for `LocalControlHeader
248 <http://redmine.named-data.net/projects/nfd/wiki/LocalControlHeader>`_ to implement
249 special NDN applications that need low-level control of NDN packet forwarding
250
Lixia Zhangc5fdfe72014-04-30 09:33:43 -0700251- **Security support**
Alexander Afanasyevc5452c52014-04-29 17:21:51 -0700252
Lixia Zhangc5fdfe72014-04-30 09:33:43 -0700253 + A set of security primitives to allowing implementation of secure NDN applications in
254 a simplified manner
Alexander Afanasyevc5452c52014-04-29 17:21:51 -0700255
256 - **KeyChain**: provides simple interfaces of packet signing, and key and certificate
257 management
258 - **ValidatorConfig**: validator that implements trust model defined in a configuration
259 file
260 - **CommandInterestGenerator** and **CommandInterestValidator**: convenient helpers to produce
261 and validate command interests, while preventing potential replay attacks
262
263 + Several implementations of trusted platform modules to securely manage private keys
264
265 - **SecTpmOsx**: TPM based on OSX KeyChain (OSX-specific)
266 - **SecTpmFile**: TPM that uses file-based access control to protect keys (cross-platform)
267
268 + Extensive set of security command-line tools to manage security identities and certificates
269
270 - Generating private/public keys
271 - Issuing certificates
272 - Exporting/importing identities
273 - Managing default security settings
274
275- **Miscellaneous tools**
276
277 + Scheduler to support delayed time operations
278 + NDN regular expressions
279 + Simple config file to alter various aspects of the library
280 + **tlvdump**: a simple tool to visualize TLV-encoded blocks