Fix build error
[platform/upstream/libksba.git] / README
1                                LIBKSBA
2                               ---------
3
4          Copyright (C) 2001-2006, 2010-2015, 2018-2023 g10 Code GmbH
5
6 This file is free software; as a special exception the author gives
7 unlimited permission to copy and/or distribute it, with or without
8 modifications, as long as this notice is preserved.
9
10 This file is distributed in the hope that it will be useful, but
11 WITHOUT ANY WARRANTY, to the extent permitted by law; without even the
12 implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
13 PURPOSE.
14
15 Libksba itself is distributed under the terms of the GNU General
16 Public License, see the file AUTHORS for details.
17
18
19                             KSBA Overview
20                             -------------
21
22 KSBA (pronounced Kasbah) is a library to make X.509 certificates as
23 well as the CMS easily accessible by other applications.  Both
24 specifications are building blocks of S/MIME and TLS.
25
26 KSBA is made available as a standard shared library and reserves
27 identifiers starting with "ksba" and "_ksba" (also uppercase and mixed
28 case).  It does not rely on another cryptographic library.
29
30
31                             Documentation
32                             -------------
33
34 A standard info format reference manual is included.  However the OCSP
35 feature has not yet been documented.  See the comments in src/ocsp.c
36 and the example tests/t-ocsp.c.  The GnuPG's dirmngr module makes
37 extensive use of the OCSP feature and may be used as another example.