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