Use CURLOPT_XFERINFOFUNCTION curl option if available
[libisds.git] / README
blob3a06a51ae8c47c2f5c1e19938e0cf1904928b37e
1 This is client library for accessing SOAP services of ISDS (Informační systém
2 datových schránek / Data Box Information System) as defined in Czech ISDS Act
3 (300/2008 Coll.) <http://portal.gov.cz/zakon/300/2008> and implied documents.
5 Copyright (C) 2009, 2010, 2011, 2012, 2013  Petr Písař <petr.pisar@atlas.cz>
6 Copyright (C) 2014, 2015, 2016, 2017, 2018  Petr Písař <petr.pisar@atlas.cz>
7 Copyright (C) 2019  Petr Písař <petr.pisar@atlas.cz>
9 This program is free software: you can redistribute it and/or modify it under
10 the terms of the GNU Lesser General Public License as published by the Free
11 Software Foundation, either version 3 of the License, or (at your option) any
12 later version.
14 This program is distributed in the hope that it will be useful, but WITHOUT
15 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
16 FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
17 details.
20 This code is written in ISO99 C language and requires libxml2, (optional but
21 strongly recommended) cURL, (libgcrypt and GPGME) or OpenSSL, >=expat-2.0.0,
22 xsltproc and DocBook XSLT stylesheets if building documentation is enabled,
23 and (if not part of your standard library) optional Gettext libraries and
24 pkg-config tool at compilation time. gnupg2 is required at run time (provides
25 gpgsm that uses gpgme to process CMS) if GPGME cryptographic back-end is
26 selected. Build system preparation from VCS requires >=automake-1.11,
27 autoconf, autopoint, and libtool in addition. Tests require >=GnuTLS-2.12.0
28 library.
30 Applications linked against this library need to be linked to libxml2 too.
32 It has been tested on GNU/Linux (Linux 5.2.11, glibc-2.29, gcc-8.2.0) with
33 libxml2-2.9.9, curl-7.65.0, libgcrypt-1.8.3, gpgme-1.13.0, expat-2.2.7,
34 gnupg-2.2.17, gnutls-3.6.9, libxslt-1.1.33, and docbook-xsl-stylesheets-1.79.1
35 on amd64 architecture.
37 Latest code can be obtained from GIT repository
38 <http://repo.or.cz/w/libisds.git> (web interface).
40 ISDS documentation is located under `doc' directory, user documentation can be
41 found in header files. See `client' directory for examples how to use this
42 library. Preliminary library self-tests are located in `test' directory. Test
43 data and message examples are stored in `server/messages' directory.
45 Credentials for testing account can be passed to example clients and on-line
46 tests by environmental variables `ISDS_USERNAME', `ISDS_PASSWORD', and
47 `ISDS_CODE_MEP' or by saving them into `test_credentials' (first line is the
48 user name, second line is the password) and `test_credentials_mep' (first list
49 is tge use name, second line is the MEP code) in a build root directory.
50 Environmental variables take precedence.