timeval.tv_sec does not have to be of type time_t
[libisds.git] / NEWS
blobdfcda7f1ff2bbc58ae463c7607b590146f413632
1 Version 0.10
2 ============
4 • A new ISDSSearch2 service was implemented by an isds_find_box_by_fulltext()
5 function.
7 • The OpenSSL library can be used instead of the default GPGme library by
8 specifying --enable-openssl-backend option to the configure script.
10 • When parsing ISO 8601 date-time strings from a server response, microsecond
11 fractions are properly rounded (half up) now.
13 • An use-after-free bug in parsing SOAP response has been fixed.
15 • Handling su_seconds_t type used in the timeval structure was corrected to
16 enable flawless compilation with Mac OS X standard library.
18 • Various signedness mismataches which could lead to an undefined behaviour
19 were fixed.
21 • A work-around for accessing the strdup(3) function in Mac OS X standard
22 library was applied.
24 Version 0.9
25 ===========
27 • New functions isds_PersonName_free(), isds_BirthInfo_free(), and
28 isds_Address_free() have been added. Applications can use them for deallocating
29 isds_PersonName, isds_BirthInfo, and isds_Address structures.
31 • A memory leak in isds_DbOwnerInfo_free() has been fixed.
33 • A new glibc feature-macro _DEFAULT_SOURCE is used to silent warnings about
34 deprecated _SVID_SOURCE and _BSD_SOURCE macros. This is will be needed since
35 glibc-2.20 although current manual pages do not document this change.
37 • `template' identifier has been renamed in header files not to clash with C++
38 keywords.
40 • Global variable definitions have been moved from a private header file into
41 compilation units to satisfy strict OS X linker.
43 • This release is binary compatible with previous version 0.8. However
44 applications built against 0.9 are not guaranteed to work with 0.8.
46 • Documentation for GetDataBoxList SOAP service has been updated to align with
47 specification released on 2014-01-14.
49 • Internal test suite encountered many improvements (more return value checks,
50 NULL pointer dereference and memory leaks fixes, closing sockets fixed, some
51 code was simplified).
53 Version 0.8
54 ===========
56 • New ISDS service DataBoxCreditInfo has been implemented as
57 isds_get_commercial_credit(). This allows to retrieve current credit amount
58 available to the box owner for commercial activities like sending commercial
59 messages or using long term storage. It also allows to obtain recent history
60 of credit changes.
62 • Preliminary support for building with MinGW tool-chain has been added. Not
63 all tests have been ported yet.
65 • The MIME type normalization is case insensitive now.
67 • Status codes 1007 and 2011 of CheckDataBox ISDS service, bad box ID, are
68 recognized now and reported to the application as IE_INVAL.
70 • This release is binary compatible with previous version 0.7. However
71 applications built against 0.8 are not guaranteed to work with 0.7.
73 • The build system, autotools and gettext scripts namely, has been updated.
75 • NULL pointer dereference while parsing second and next permissions for
76 sending commercial messages has been fixed in the
77 isds_get_commercial_permissions() function.
79 • Bad arguments handling at isds_get_message_sender() function that could lead
80 to crash has been fixed.
82 Version 0.7
83 ===========
85 • New ISDS service Re-signISDSDocument has been implemented as
86 isds_resign_message() function. This can be used for adding time stamp to
87 already signed message or delivery details that had been produced without the
88 time stamp.
90 • TLS errors from cURL library are reported as IE_SECURITY to libisds
91 applications now. This is new isds_error value and it denotes any security
92 problem leading to abort of requested operation.
94 • This release is ABI-compatible with previous version 0.6. However
95 applications built against 0.7 are not guaranteed to work with 0.6.
97 • Internal test suite checks TLS authentication. GnuTLS is needed for
98 building tests now.
100 • Parsing dmRecipientOrgUnitNum value from message envelope has been fixed.
102 • A memory leak when using XPath has been fixed.
104 Version 0.6.2
105 =============
107 • Building tests out of source tree has been fixed.
109 Version 0.6.1
110 =============
112 • Missing test/simline/server_types.h files has been added into distribution
113 to fix test suite compilation.
115 Version 0.6
116 ===========
118 • ABI changed due to changes in specification. Some functions got additional
119 parameters or return codes.
121 • One-time password (OTP) authentication implemented. There is a new argument
122 at isds_login() and isds_change_password() functions of type struct isds_otp*.
123 Pass NULL if do not request OTP authentication.  The structure is used to
124 select OTP method (HMAC- or time-based code), to pass the OTP code (use NULL
125 to ask server for new time-based code), and to retrieve fine state of OTP
126 authentication. The functions can return IE_PARTIAL_SUCCESS if time-based
127 method is selected and server sent the new OTP code successfully.
128 OTP-authenticated context resides on URL different from others (use NULL or
129 isds_otp_locator for official instance or isds_otp_testing_locator for testing
130 instance). You can try client/login tool to check OTP-authenticated log-in.
131 You can use client/hotp_generator tool to generate series of HMAC-based OTP
132 codes (requires Perl Authen::OATH module).  There is a bug in cURL < 7.28.0
133 preventing from correct re-authentication. If you have unpatched cURL,
134 configure libisds with `--enable-curlreauthorizationbug' option. (See INSTALL
135 for more details.)
137 • isds_change_password() has additional argument to retrieve reference number
138 of the request assigned by the server. Pass NULL if you do not care.
140 • Internal tests check log-in procedure against simulated ISDS server. You can
141 run the simulated server as standalone executable in test/simline/server_cli
142 to check another clients. The server implements besides authentication
143 DummyRequest, services for changing passwords and EraseMessage.
145 • New DeleteDataBoxPromptly service implemented as isds_delete_box_promptly().
146 (This service is not documented in the specification).
148 • New PDZInfo service implemented as isds_get_commercial_permissions(). This
149 service enables application to know whether it can send commercial messages,
150 which subtypes of commercial messages can send (there are differences on
151 payment type), and to retrieve tokens for sending such messages.
153 • New service EraseMessage implemented as isds_delete_message_from_storage().
154 This function can be used to delete messages stored in long term storage (also
155 known as safe previously). Only messages in the long term storage can be
156 explicitly deleted.
158 • New user types USERTYPE_LIQUIDATOR (company liquidator) and
159 USERTYPE_OFFICIAL_CERT (undocumented in specification) added.
161 • Return value of isds_normalize_mime_type() is pointer to constant string now
162 to discourage application from fiddling with the value.
164 • Autoconf m4 macros have been updated (curl-7.26.0, gettext-0.18.1.1,
165 gpgme-1.3.1, libgcrypt-1.5.0, libtool-2.4.2, libxml2-2.8.0).
167 Version 0.5
168 ===========
170 • ABI changed due to changes in specification. API is preserved. Please
171 recompile your applications.
173 • This release has not been tested on real system because devoloper has not
174 obtained new testing account yet. But he believes library works. Testers are
175 welcome.
177 • Delivery events 5, 10, 11, 12, and 13 are recognized now.
179 • GetMessageAuthor service implemented as get_message_sender() function.
181 • New isds_envelope member `dmPublishOwnID' added. It allows sender to reveal
182 his natural name to recipient on sending a message.
184 • isds_GetDataBoxUsers() can return empty list of users now.
186 • New document types recognised. MIME types of Software602 forms have been
187 changed to reflect IANA registry.
189 • Credential for testing account removed from documentation and code. Owner of
190 ISDS removed all testing accounts, testers must request for new account and
191 must agree with new rules including keeping credentials in secret and
192 non-disclosuring found bugs in ISDS. Example clients and on-line tests read
193 credentials from environment and central file in build root direcotory. See
194 README for more details.
196 • Errors from libxml2 parser are captured by libisds log system as ILF_XML
197 facility and at ILL_ERROR level. Application can get them by standard library
198 interface.
200 • Library can be compiled without support for network operation by passing
201 `--without-libcurl' option to configure script. All functions dependent on
202 network remain available and will return IE_NOTSUP return code.
204 • Dead variables removed to pass compilation by GCC 4.6 in strict mode.
206 • Prepare test environment to pass without ~/.gnupg directory. Packagers can
207 remove the hack from their packages now.
209 Version 0.4
210 ===========
212 • This version breaks ABI because of ISDS specification change. Please adapt
213 your application where affected functions are called.
215 • ABI change: isds_get_password_expiration() will return NULL if password never
216 expires. Adjust your application to cope with NULL pointer on IE_SUCCESS.
218 • ABI change: isds_add_box() has new credentials_delivery parameter to request
219 for on-line credentials delivery and to receive token for that.
221 • ABI change: isds_add_user() has new credentials_delivery parameter to
222 request for on-line credentials delivery and to receive token for that.
224 • ABI change: isds_reset_password() has different arguments to request for
225 on-line credentials delivery and to receive token for that.
227 • ABI change: deprecated functions isds_set_tls() and
228 isds_set_mime_type_normalization() removed. Use isds_set_opt() instead.
230 • SOAP Fault error message is passed to application via isds_long_message().
232 • New function isds_get_list_of_sent_message_state_changes() implements
233 GetMessageStateChanges service. It returns list of message status changes in
234 requested time interval.
236 • New function isds_get_box_list_archive() implements GetDataBoxList service.
237 It returns ZIP archive with comma separate list of boxes. Different types of
238 lists can be requested. Only type `UPG' is available to public.
240 • New function isds_activate() implements Activate service.
242 • New delivery state EV0 is recognized as EVENT_ENTERED_SYSTEM isds_event_type.
244 • `tsr' document name suffix is recognized as time stamp file type.
246 • New function isds_pki_credentials_free() to deallocate isds_pki_credentials
247 structure.
249 • ISO time string parser fixed (negative or no time zone offset).
251 • All tests can run in parallel now.
253 • Lot of internal tests added. Funny color output now.
255 Version 0.3.1
256 =============
258 • Add `server' directory to distribution tar balls because example messages
259 are needed for some tests.
261 Version 0.3
262 ===========
264 • This library breaks API because of new features and changes in ISDS.
266 • This library version covers complete ISDS specification as released on
267 2010-05-23.
269 • Support for XML documents added. Use isds_document.is_xml to distinguish
270 between binary and XML document types. Because XML node list
271 (isds_document.xml_node_list) is used to describe XML document, your
272 application must link to libxml2 library too since now. Please note this
273 feature has not been heavily tested and that the interface is a little tricky
274 (regarding memory allocation). See client/sendxmldoc.c and
275 client/loadsentmessagewithxmldocuments.c examples for hints how to use it.
277 • Box creation (isds_add_box()) supports requesting for token. This
278 functionality is not covered by specification as it's not implemented on
279 server side yet.
281 • Message authenticity verification through new web service
282 AuthenticateMessage (isds_authenticate_message()) is supported. This function
283 sends a signed message encapsulated in CMS to ISDS where the system resolves
284 originality of the message.
286 • isds_envelope->dmType is input/output now. The one letter value is
287 transferred while sending new message. However ISDS ignores this option as
288 semantic is not defined yet.
290 • isds_envelope->timestamp is optional now. Some ISDS services can return
291 message without time stamp as can do not exist yet.
293 • Cookie-tracked session authentication changed to stateless. That means
294 password is transmitted to server on each request. Password is cached by
295 libcurl library until connection gets closed. Also different server locators
296 for non-certificate and certificate client authentication emerged. Old log-in
297 method will be canceled on 2010-07-01. Old libisds versions become useless.
298 Upgrade is strongly recommended.
300 • Static and out-of-source directory compilation is supported now.
302 • New function isds_normalize_mime_type(): translates file name extension to
303 MIME type (because official ISDS client is broken). This can be globally
304 enabled by isds_set_opt().
306 • Context parameters can be set by isds_set_opt(): TLS options (isds_set_tls()
307 is deprecated now), MIME type normalization (new: mangle document MIME type
308 in incoming messages into more reasonable values).
310 • Deprecated functions removed: isds_load_received_message(),
311 isds_log_signed_message().
313 • isds_DbUserInfo.caState added (country of contact address).
315 • isds_get_delivery_info() fixed to produce standard raw representation of
316 delivery details that can be loaded by isds_load_delivery() back.
318 • New function guess_raw_type(): detects type of supported message and
319 delivery details formats. Detected format can be supplied to
320 isds_load_message(). This way, application can automagically load and parse
321 any supported format.
323 • libcurl debug messages are caught by libisds and redirected to library
324 logger (ILF_HTTP facility).
326 Version 0.2.1
327 =============
329 • Libs value in libisds.pc pkg-config module fixed.
331 Version 0.2
332 ===========
334 • X.509 client certificate authentication is supported (but not tested yet).
335 Underlying HTTPS cURL library supports OpenSSL, GnuTLS and NSS cryptographic
336 back ends currently.
338 Current legislation requires to use cryptographic module with unexportable
339 private key. I've tested ASEKey produced by Athena Smartcard Solution
340 with OpenSSL back end successfully (a patch for curl-7.20.0 is required).
342 Example code client/certauth.c and server/tls/peer server and CA, server and
343 client cryptographic material are bundled. 
345 • Application can pass CRL PEM file to cryptographic library.
347 • Library offers pkg-config integration. Application build scripts can check
348 `libisds' pkg-config module and use PKG_CHECK_MODULES() m4 macro.
350 • Application can get dynamic string describing library version and its
351 dependencies at run-time (isds_version()).
353 • API changed and is not backward compatible. Please adjust and recompile your
354 applications.
356 • Library tests have been splitted to off-line (--enable-test) and on-line
357 (--enable-online-test) tests. On-line tests can not be compiled without
358 off-line tests. All tests are switched off by default.
360 • Server base URL for isds_login() does not contain path anymore. Application
361 must supply schema and hostname only (e.g. https://localhost/). Undefined base
362 URL will be interpreted as official ISDS locator.
364 • Base URLs of official ISDS server (isds_locator) and testing ISDS server
365 (isds_testing_locator) are provided by library. Application can offer them as
366 default choices to the user.
368 • Documents can be submitted for authorize conversion into Czech POINT system
369 (czp_convert_document(), requires specific isds_ctx).
371 • Application can catch all global log messages and redirect them wherever it
372 needs.
374 Version 0.1
375 ===========
377 • This is first public release. Whole ISDS 2010-01-22 specification is covered
378 except: XML documents, X.509 authentication