-This is /home/wk/s/libksba/doc/ksba.info, produced by makeinfo version
-4.13 from /home/wk/s/libksba/doc/ksba.texi.
+This is ksba.info, produced by makeinfo version 6.8 from ksba.texi.
INFO-DIR-SECTION GNU libraries
START-INFO-DIR-ENTRY
* libksba: (ksba). An X.509 Library.
END-INFO-DIR-ENTRY
- This file documents the KSBA library to access X.509 and CMS data
+This file documents the KSBA library to access X.509 and CMS data
structures.
- This is edition 1.3.2, last updated 15 March 2013, of `The KSBA
-Reference Manual', for Version 1.3.2.
+ This is edition 1.6.5, last updated 14 November 2023, of 'The KSBA
+Reference Manual', for Version 1.6.5.
Copyright (C) 2002, 2003, 2004 g10 Code GmbH
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU General Public License as published by the
Free Software Foundation; either version 3 of the License, or (at your
-option) any later version. The text of the license can be found in the
+option) any later version. The text of the license can be found in the
section entitled "Copying".
\1f
Main Menu
*********
-This is edition 1.3.2, last updated 15 March 2013, of `The KSBA
-Reference Manual', for Version 1.3.2 of the KSBA library.
+This is edition 1.6.5, last updated 14 November 2023, of 'The KSBA
+Reference Manual', for Version 1.6.5 of the KSBA library.
Copyright (C) 2002, 2003, 2004 g10 Code GmbH
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU General Public License as published by the
Free Software Foundation; either version 3 of the License, or (at your
-option) any later version. The text of the license can be found in the
+option) any later version. The text of the license can be found in the
section entitled "Copying".
* Menu:
* Concept Index:: Index of concepts and programs.
* Function and Data Index:: Index of functions, variables and data types.
- --- The Detailed Node Listing ---
+ -- The Detailed Node Listing --
Introduction
* CMS Basics::
* CMS Parser::
+
\1f
File: ksba.info, Node: Introduction, Next: Preparation, Prev: Top, Up: Top
1.1 Getting Started
===================
-This manual documents the `KSBA' library programming interface. All
+This manual documents the 'KSBA' library programming interface. All
functions and data types provided by the library are explained.
The reader is assumed to possess basic knowledge about the
implemented protocols.
This manual can be used in several ways. If read from the beginning
-to the end, it gives a good introduction into the library and how it
-can be used in an application. Forward references are included where
+to the end, it gives a good introduction into the library and how it can
+be used in an application. Forward references are included where
necessary. Later on, the manual can be used as a reference manual to
get just the information needed about any particular interface of the
library. Experienced programmers might want to start looking at the
1.2 Features
============
-`KSBA' has a couple of advantages over other libraries doing a similar
+'KSBA' has a couple of advantages over other libraries doing a similar
job, and over open coding the protocols in your application directly.
It's Free Software
- Anybody can use, modify, and redistribute it under the terms of
- the GNU General Public License (*note Copying::).
+ Anybody can use, modify, and redistribute it under the terms of the
+ GNU General Public License (*note Copying::).
It hides the low level stuff
- `KSBA' a high level interface to the implemented protocols and
+ 'KSBA' a high level interface to the implemented protocols and
presents the data in a consistent way. There is no more need to
worry about all the nasty details of the protocols. The API gives
the C programmer a more usual way of interacting with the data.
It copes with the version details
X.509 protocols tend to have many different versions and dialects.
Applications must usually cope with all of this and it has to be
- coded over and over again. `KSBA' hides this by providing just
- one API which does the Right Thing. Support for new versions and
+ coded over and over again. 'KSBA' hides this by providing just one
+ API which does the Right Thing. Support for new versions and
features of the protocols will be added over time.
\1f
1.3 Overview
============
-The `KSBA' library is thread-safe as long as objects described by one
+The 'KSBA' library is thread-safe as long as objects described by one
context are only used by one thread at a time. No initialization is
required.
2 Preparation
*************
-To use `KSBA', you have to perform some changes to your sources and the
+To use 'KSBA', you have to perform some changes to your sources and the
build system. The necessary changes are small and explained in the
following sections. At the end of this chapter, it is described how the
library is initialized, and how the requirements of the library are
==========
All interfaces (data types and functions) of the library are defined in
-the header file `ksba.h'. You must include this in all programs using
+the header file 'ksba.h'. You must include this in all programs using
the library, either directly or through some other header file, like
this:
#include <ksba.h>
- The name space of `KSBA' is `ksba_*' for function names, `ksba*' for
-data types and `KSBA_*' for other symbols. In addition the same name
-prefixes with one prepended underscore are reserved for internal use
-and should never be used by an application.
+ The name space of 'KSBA' is 'ksba_*' for function names, 'ksba*' for
+data types and 'KSBA_*' for other symbols. In addition the same name
+prefixes with one prepended underscore are reserved for internal use and
+should never be used by an application.
\1f
File: ksba.info, Node: Version Check, Next: Building the source, Prev: Header, Up: Preparation
2.2 Version Check
=================
-It is often desirable to check that the version of `KSBA' used is indeed
+It is often desirable to check that the version of 'KSBA' used is indeed
one which fits all requirements. Even with binary compatibility, new
features may have been introduced but through peculiarities of the
runtime linker an old version gets actually used. So you better check
that the version is as expected right after program startup.
-- Function: const char * ksba_check_version (const char *REQ_VERSION)
+
Check that the the version of the library is at minimum the one
given as a string in REQ_VERSION and return the actual version
- string of the library; return `NULL' if the condition is not met.
- If `NULL' is passed to this function, no check is done and only the
+ string of the library; return 'NULL' if the condition is not met.
+ If 'NULL' is passed to this function, no check is done and only the
version string is returned. It is a pretty good idea to run this
function as soon as possible, because it may also initializes some
subsystems. In a multi-threaded environment if should be called
2.3 Building the source
=======================
-If you want to compile a source file including the `ksba.h' header
-file, you must make sure that the compiler can find it in the directory
+If you want to compile a source file including the 'ksba.h' header file,
+you must make sure that the compiler can find it in the directory
hierarchy. This is accomplished by adding the path to the directory in
which the header file is located to the compiler's include file search
-path (via the `-I' option).
+path (via the '-I' option).
However, the path to the include file is determined at the time the
-source is configured. To solve this problem, `KSBA' ships with a small
-helper program `ksba-config' that knows about the path to the include
-file and other configuration options. The options that need to be
-added to the compiler invocation at compile time are output by the
-`--cflags' option of `ksba-config'. The following example shows how it
-can be used at the command line:
+source is configured. To solve this problem, 'KSBA' ships with
+'ksba.pc' file, that knows about the path to the include file and other
+configuration options. The options that need to be added to the
+compiler invocation at compile time are output by the '--cflags' option
+of 'pkg-config ksba'. The following example shows how it can be used at
+the command line:
- gcc -c foo.c `ksba-config --cflags`
+ gcc -c foo.c `pkg-config --cflags ksba`
- Adding the output of `ksba-config --cflags' to the compiler's
-command line will ensure that the compiler can find the `ksba.h' header
+ Adding the output of 'pkg-config --cflags ksba' to the compiler's
+command line will ensure that the compiler can find the 'ksba.h' header
file.
A similar problem occurs when linking the program with the library.
Again, the compiler has to find the library files. For this to work,
the path to the library files has to be added to the library search path
-(via the `-L' option). For this, the option `--libs' of `ksba-config'
-can be used. For convenience, this option also outputs all other
-options that are required to link the program with the `KSBA' libraries
-(in particular, the `-lksba' option). The example shows how to link
-`foo.o' with the `KSBA' libraries to a program `foo'.
+(via the '-L' option). For this, the option '--libs' of 'pkg-config
+ksba' can be used. For convenience, this option also outputs all other
+options that are required to link the program with the 'KSBA' libraries
+(in particular, the '-lksba' option). The example shows how to link
+'foo.o' with the 'KSBA' libraries to a program 'foo'.
- gcc -o foo foo.o `ksba-config --libs`
+ gcc -o foo foo.o `pkg-config --libs ksba`
Of course you can also combine both examples to a single command by
-specifying both options to `ksba-config':
+specifying both options to 'pkg-config ksba':
- gcc -o foo foo.c `ksba-config --cflags --libs`
+ gcc -o foo foo.c `pkg-config --cflags --libs ksba`
\1f
File: ksba.info, Node: Certificate Handling, Next: CMS, Prev: Preparation, Up: Top
provides an easy to use interface to handle them.
-- Data type: ksba_cert_t
- The `ksba_cert_t' type is a handle for an X.509 certificate.
+ The 'ksba_cert_t' type is a handle for an X.509 certificate.
-- Data type: ksba_sexp_t
- The `ksba_sexp_t' type describes a canonically encoded S-expression
- stored in a memory buffer. It is alias for `unsigned char *'.
+ The 'ksba_sexp_t' type describes a canonically encoded S-expression
+ stored in a memory buffer. It is alias for 'unsigned char *'.
Note that a length argument is not required because the length of
such an S-expression is intrinsically available.
copy it and eventually destroy it.
-- Function: ksba_cert_t ksba_cert_new (void)
- The function `ksba_cert_new' creates a new certificate object and
+ The function 'ksba_cert_new' creates a new certificate object and
returns a handle for it. The certificate object has initially one
reference.
The only reason why this function may fail is an out-of-memory
- condition in which case `NULL' is returned. You might then get
- the actual error code using `gpg_error_from_errno (errno)'.
+ condition in which case 'NULL' is returned. You might then get the
+ actual error code using 'gpg_error_from_errno (errno)'.
-- Function: void ksba_cert_ref (ksba_cert_t CERT)
- The function `ksba_cert_ref' bumps the reference counter of the
- certificate object up by one. Thus an extra `ksba_cert_release' is
+ The function 'ksba_cert_ref' bumps the reference counter of the
+ certificate object up by one. Thus an extra 'ksba_cert_release' is
required to actually release the memory used for the object.
-- Function: void ksba_cert_release (ksba_cert_t CERT)
- The function `ksba_cert_release' reduces the number of references
+ The function 'ksba_cert_release' reduces the number of references
to the certificate object with the handle CERT. If this was the
last reference, it will also destroy the object and releases all
- associated resources. It is okay to pass `NULL' to the function
- in which case nothing happens.
+ associated resources. It is okay to pass 'NULL' to the function in
+ which case nothing happens.
-- Function: gpg_error_t ksba_cert_read_der (ksba_cert_t CERT,
ksba_reader_t READER)
+
Read the next certificate from the READER object and store it in
the certificate object CERT for future access. The certificate is
parsed and rejected if it has any syntactical or semantical error
- (i.e. does not match the ASN.1 description).
+ (i.e., does not match the ASN.1 description).
- The function returns `0' if the operation was successfully
+ The function returns '0' if the operation was successfully
performed. An error code is returned on failure.
-- Function: gpg_error_t ksba_cert_init_from_mem (ksba_cert_t CERT,
const void *BUFFER, size_t LENGTH)
+
Parse the BUFFER which should contain a DER encoded certificate of
LENGTH and initialize the certificate object CERT with it. This
function is intended as a convenience function to be used when a
- certificate is already available in a internal memory buffer.
- This avoids the extra code needed to setup the reader object.
- Note that CERT must be a valid certificate object.
+ certificate is already available in a internal memory buffer. This
+ avoids the extra code needed to setup the reader object. Note that
+ CERT must be a valid certificate object.
- The function returns `0' if the operation was successfully
+ The function returns '0' if the operation was successfully
performed. An error code is returned on failure.
\1f
The functions in this section allow accessing the attributes of a
certificate in a well defined manner. An error will be returned if the
certificate object has not yet been initialized by means of
-`ksba_cert_read_der' or `ksba_cert_init_from_mem'.
+'ksba_cert_read_der' or 'ksba_cert_init_from_mem'.
-- Function: const unsigned char * ksba_cert_get_image
(ksba_cert_t CERT, size_t *R_LENGTH)
+
This function returns a pointer to the DER encoded buffer with the
raw certificate. The length of that buffer gets stored at
R_LENGTH. This function is useful to export or store the raw
certificate.
- The function returns `NULL' on error or a pointer to a buffer with
+ The function returns 'NULL' on error or a pointer to a buffer with
the raw certificate data. That pointer is only valid as long as
the certificate object CERT is valid and has not been
reinitialized.
-- Function: gpg_error_t ksba_cert_hash (ksba_cert_t CERT, int WHAT,
void (*HASHER)(void *, const void *, size_t length),
void *HASHER_ARG)
+
This function feeds the data which is expected to be hashed into
the supplied function HASHER, where the first argument passed is
- HASHER_ARG, the second the pointer to the data to be hashed and
- the third the length of this data.
+ HASHER_ARG, the second the pointer to the data to be hashed and the
+ third the length of this data.
- The function returns `0' on success or an error code when something
+ The function returns '0' on success or an error code when something
goes wrong. The HASHER function is not expected to return an
error; instead the caller should setup that function in a way to
convey encountered errors by means of the HASHER_ARG. Note that a
hash function is in general not expected to yield errors anyway.
-- Function: const char * ksba_cert_get_digest_algo (ksba_cert_t CERT)
+
Figure out the the digest algorithm used for the signature and
return its OID in dotted decimal format. This function is most
likely used to setup the hash context before calling
- `ksba_cert_hash'.
+ 'ksba_cert_hash'. For some certificate types the returned OID has
+ a special meaning:
+
+ '1.2.840.113549.1.1.10'
+ This indicates the RSASSA-PSS algorithm. The digest algorithm
+ needs to be extracted from the S-expression returned by
+ 'ksba_cert_get_sig_val'.
+
+ '1.3.101.112'
+ This is the Ed25519 algorithm which does not use a separate
+ digest algorithm. See RFC-8410.
+
+ '1.3.101.113'
+ This is the Ed448 algorithm which does not use a separate
+ digest algorithm. See RFC-8410.
- The function returns `NULL' for an error; on success a constant
+ The function returns 'NULL' for an error; on success a constant
string with the OID is returned. This string is valid as long the
certificate object is valid.
-- Function: ksba_sexp_t ksba_cert_get_serial (ksba_cert_t CERT)
+
The function returns the serial number of the certificate CERT.
The serial number is an integer returned as an canonical encoded
S-expression with just one element. The caller must free the
- returned value. The value `NULL' is returned in case of error.
+ returned value. The value 'NULL' is returned in case of error.
-- Function: char * ksba_cert_get_issuer (ksba_cert_t CERT, int IDX)
- With IDX given as `0', this function returns the Distinguished
- Name (DN) of the certificate issuer; this usually is the name of a
- certification authority (CA). The format of the returned string
- is in accordance with RFC-2253. `NULL' is returned if the DN is
- not available; This is a severe error and actually should have
- been caught by the certificate reading function.
+
+ With IDX given as '0', this function returns the Distinguished Name
+ (DN) of the certificate issuer; this usually is the name of a
+ certification authority (CA). The format of the returned string is
+ in accordance with RFC-2253. 'NULL' is returned if the DN is not
+ available; This is a severe error and actually should have been
+ caught by the certificate reading function.
With IDX greater than zero, the function may be used to enumerate
- alternate issuer names. The function returns `NULL' when there are
- no more alternate names. Only alternate names recognized by
- `libksba' are returned, others are simply skipped. The format of
+ alternate issuer names. The function returns 'NULL' when there are
+ no more alternate names. Only alternate names recognized by
+ 'libksba' are returned, others are simply skipped. The format of
the returned name is either a RFC-2253 formated string which can be
detected by checking whether the first character is a letter or
- digit. RFC-822 conformant email addresses are returned enclosed
- in angle brackets; the opening angle bracket should be used to
- detect this. Other formats are returned as an S-Expression in
- canonical format, so a opening parenthesis should be used to
- detect this encoding. The name may include binary null characters,
- thus strlen may return a length shorter than actually used. The
- real length is implicitly given by the structure of the
- S-expression, an extra null is appended for safety reasons.
-
- The caller must free the returned string using `ksba_free' or
+ digit. RFC-822 conformant email addresses are returned enclosed in
+ angle brackets; the opening angle bracket should be used to detect
+ this. Other formats are returned as an S-Expression in canonical
+ format, so a opening parenthesis should be used to detect this
+ encoding. The name may include binary null characters, thus strlen
+ may return a length shorter than actually used. The real length is
+ implicitly given by the structure of the S-expression, an extra
+ null is appended for safety reasons.
+
+ The caller must free the returned string using 'ksba_free' or
whatever function has been registered as a replacement.
-- Function: char * ksba_cert_get_subject (ksba_cert_t CERT, int IDX)
- With IDX given as `0', this function returns the Distinguished
- Name (DN) of the certificate's subject. The format of the
- returned string is in accordance with RFC-2253. `NULL' is
- returned if the DN is not available.
+
+ With IDX given as '0', this function returns the Distinguished Name
+ (DN) of the certificate's subject. The format of the returned
+ string is in accordance with RFC-2253. 'NULL' is returned if the
+ DN is not available.
With IDX greater than zero, the function may be used to enumerate
- alternate subject names. The function returns `NULL' when there
- are no more alternate names. Only alternate names recognized by
- `libksba' are returned, others are simply skipped. The format of
+ alternate subject names. The function returns 'NULL' when there
+ are no more alternate names. Only alternate names recognized by
+ 'libksba' are returned, others are simply skipped. The format of
the returned name is either a RFC-2253 formated string which can be
detected by checking whether the first character is a letter or
digit. RFC-2822 conform email addresses are returned enclosed in
this. Other formats are returned as an S-Expression in canonical
format, so a opening parenthesis should be used to detect this
encoding, the name may include binary null characters, thus strlen
- may return a length shorter than actually used. The real length
- is implicitly given by the structure of the S-expression, an extra
+ may return a length shorter than actually used. The real length is
+ implicitly given by the structure of the S-expression, an extra
null is appended for safety reasons.
- The caller must free the returned string using `ksba_free' or
+ The caller must free the returned string using 'ksba_free' or
whatever function has been registered as a replacement.
-- Data type: ksba_isotime_t
- Due to problems with the C data type `time_t', which will overflow
+ Due to problems with the C data type 'time_t', which will overflow
on most 32 bit machines in the year 2038, it was not advisable to
use this type for referencing times stored in certificates.
- Instead, you should use the `ksba_isotime_t' type, which can
+ Instead, you should use the 'ksba_isotime_t' type, which can
represent any time since the year 0.
It is implemented as a buffer of 16 bytes and may be handled like a
- standard string. It should be initialized to zero (i.e. the first
+ standard string. It should be initialized to zero (i.e., the first
byte needs to be 0x00) if it does not hold a valid date. Date
values themselves are stored in ISO format and assumed to be
- referenced from UTC. The string with the date value is always
+ referenced from UTC. The string with the date value is always
guaranteed to be of length 15 and having a format like:
- `"19610711T172059"'. Note that the `T' is required by ISO rules.
+ '"19610711T172059"'. Note that the 'T' is required by ISO rules.
A simple assignment of these data types is not a good idea. You
- may use `strcpy' or better a specialized function like:
+ may use 'strcpy' or better a specialized function like:
void
copy_time (ksba_isotime_t d, const ksba_isotime_t s)
strcpy (d, s);
}
- For reasons of documentation a special function should also be
- used to compare such times:
+ For reasons of documentation a special function should also be used
+ to compare such times:
int
cmp_time (const ksba_isotime_t a, const ksba_isotime_t b)
-- Function: gpg_error_t ksba_cert_get_validity
(ksba_cert_t CERT, int WHAT, ksba_isotime_t TIMEBUF)
+
Return the validity dates from the certificate. If no value is
- available an empty date object (i.e. a `strlen' will be stored at
- TIMEBUF, otherwise it will receive the date. On failure an error
+ available an empty date object (i.e., a 'strlen' will be stored at
+ TIMEBUF, otherwise it will receive the date. On failure an error
code is returned.
- To return the `notBefore' date, the value `0' must be supplied for
- WHAT; `1' yields the `notAfter' value.
+ To return the 'notBefore' date, the value '0' must be supplied for
+ WHAT; '1' yields the 'notAfter' value.
-- Function: ksba_sexp_t ksba_cert_get_public_key (ksba_cert_t CERT)
- [This needs to get written - for now please see libksba/src/cert.c]
+ [This needs to get written - for now please see libksba/src/cert.c]
-- Function: ksba_sexp_t ksba_cert_get_sig_val (ksba_cert_t CERT)
+
[This needs to get written - for now please see libksba/src/cert.c]
-- Function: gpg_error_t ksba_cert_get_extension
(ksba_cert_t CERT, int IDX, char const **R_OID, int *R_CRIT, size_t *R_DEROFF, size_t *R_DERLEN)
+
[This needs to get written - for now please see libksba/src/cert.c]
-- Function: gpg_error_t ksba_cert_is_ca
(ksba_cert_t CERT, int *R_CA, int *R_PATHLEN)
- Return information on the basicConstraint (2.5.19.19) of CERT.
- R_CA receives true if this is a CA and only in that case R_PATHLEN
- is set to the maximum certification path length or -1 if there is
- no such limitation
+ Return information on the basicConstraint (2.5.19.19) of CERT. R_CA
+ receives true if this is a CA and only in that case R_PATHLEN is
+ set to the maximum certification path length or -1 if there is no
+ such limitation
-- Function: gpg_error_t ksba_cert_get_key_usage
(ksba_cert_t CERT, unsigned int *R_FLAGS)
- Get the key usage flags. The function returns `GPG_ERR_NO_DATA' if
- no key usage is specified. The usage flags are as shown in
- RFC3280, section 4.2.1.3. The key usage flags are represented by a
+
+ Get the key usage flags. The function returns 'GPG_ERR_NO_DATA' if
+ no key usage is specified. The usage flags are as shown in
+ RFC3280, section 4.2.1.3. The key usage flags are represented by a
bitmask, and you can test each bit using symbolic constants, which
- tells you if that usage is set on the certificate. The constants
+ tells you if that usage is set on the certificate. The constants
are
- `KSBA_KEYUSAGE_DIGITAL_SIGNATURE'
+ 'KSBA_KEYUSAGE_DIGITAL_SIGNATURE'
Usable for digitalSignature.
-
- `KSBA_KEYUSAGE_NON_REPUDIATION'
+ 'KSBA_KEYUSAGE_NON_REPUDIATION'
Usable for nonRepudiation.
-
- `KSBA_KEYUSAGE_KEY_ENCIPHERMENT'
+ 'KSBA_KEYUSAGE_KEY_ENCIPHERMENT'
Usable for keyEncipherment.
-
- `KSBA_KEYUSAGE_DATA_ENCIPHERMENT'
+ 'KSBA_KEYUSAGE_DATA_ENCIPHERMENT'
Usable for dataEncipherment.
-
- `KSBA_KEYUSAGE_KEY_AGREEMENT'
+ 'KSBA_KEYUSAGE_KEY_AGREEMENT'
Usable for for keyAgreement.
-
- `KSBA_KEYUSAGE_KEY_CERT_SIGN'
+ 'KSBA_KEYUSAGE_KEY_CERT_SIGN'
Usable for keyCertSign.
-
- `KSBA_KEYUSAGE_CRL_SIGN'
+ 'KSBA_KEYUSAGE_CRL_SIGN'
Usable for cRLSign.
-
- `KSBA_KEYUSAGE_ENCIPHER_ONLY'
+ 'KSBA_KEYUSAGE_ENCIPHER_ONLY'
Usable for encipherOnly.
-
- `KSBA_KEYUSAGE_DECIPHER_ONLY'
+ 'KSBA_KEYUSAGE_DECIPHER_ONLY'
Usable for decipherOnly.
- These are the basic constraints on usage of a certificate. If you
+ These are the basic constraints on usage of a certificate. If you
need to get additional constraints, see
- `ksba_cert_get_ext_key_usages'.
+ 'ksba_cert_get_ext_key_usages'.
-- Function: gpg_error_t ksba_cert_get_ext_key_usages
(ksba_cert_t CERT, char **RESULT)
+
Return a string containing the extended usages for the certificate,
delimited by linefeeds.
-- Function: gpg_error_t ksba_cert_get_cert_policies
(ksba_cert_t CERT, char **R_POLICIES)
+
Return a string with the certificatePolicies delimited by
linefeeds. The return values may be extended to carry more
information per line, so the caller should only use the first
white-space delimited token per line. The function returns
- `GPG_ERR_NO_DATA' when this extension is not used. Caller must
+ 'GPG_ERR_NO_DATA' when this extension is not used. Caller must
free the returned value.
-
-- Function: gpg_error_t ksba_cert_get_crl_dist_point
(ksba_cert_t CERT, int IDX, ksba_name_t *R_DISTPOINT, ksba_name_t *R_ISSUER, unsigned int *R_REASON)
+
Return the CRLDistPoints given in the certificate extension of
- certificate CERT. IDX should be iterated starting from 0 until
- the function returns `GPG_ERR_EOF'. R_DISTPOINT returns a
- ksba_name_t object with the distribution point name(s); the return
- value may be `NULL' to indicate that this name is not available.
- R_ISSUER returns the CRL issuer; if the returned value is `NULL'
- the caller should assume that the CRL issuer is the same as the
- certificate issuer. R_REASON returns the reason for the CRL.
- This is a bit encoded value with no bit set if no reason has been
- specified in the certificate.
-
- The caller may pass `NULL' to any of the pointer arguments if he is
+ certificate CERT. IDX should be iterated starting from 0 until the
+ function returns 'GPG_ERR_EOF'. R_DISTPOINT returns a ksba_name_t
+ object with the distribution point name(s); the return value may be
+ 'NULL' to indicate that this name is not available. R_ISSUER
+ returns the CRL issuer; if the returned value is 'NULL' the caller
+ should assume that the CRL issuer is the same as the certificate
+ issuer. R_REASON returns the reason for the CRL. This is a bit
+ encoded value with no bit set if no reason has been specified in
+ the certificate.
+
+ The caller may pass 'NULL' to any of the pointer arguments if he is
not interested in this value. The return values for R_DISTPOINT
and R_ISSUER must be released by the caller using
- `ksba_name_release'.
+ 'ksba_name_release'.
-- Function: gpg_error_t ksba_cert_get_subj_key_id
(ksba_cert_t CERT, int *R_CRIT, ksba_sexp_t *R_KEYID)
+
Return the subjectKeyIdentifier extension as a simple allocated
- S-expression at the address of R_KEYID. 0 is returned on success,
- `GPG_ERR_NO_DATA' if no such extension is available or any other
- error code. If R_CRIT is not passed as `NULL', the critical flag
+ S-expression at the address of R_KEYID. 0 is returned on success,
+ 'GPG_ERR_NO_DATA' if no such extension is available or any other
+ error code. If R_CRIT is not passed as 'NULL', the critical flag
of this is extension is stored at this address.
-- Function: gpg_error_t ksba_cert_get_auth_key_id
(ksba_cert_t CERT, ksba_sexp_t *R_KEYID, ksba_name_t *R_NAME, ksba_sexp_t *R_SERIAL)
+
Return the authorityKeyIdentifier in R_NAME and R_SERIAL or in
- R_KEYID. `GPG_ERR_NO_DATA' is returned if no
+ R_KEYID. 'GPG_ERR_NO_DATA' is returned if no
authorityKeyIdentifier has been found. This error code is also
returned if R_KEYID has been given as NULL and only an
authorityKeyIdentifier with the keyIdentifier method is available.
-- Function: gpg_error_t ksba_cert_get_authority_info_access
(ksba_cert_t CERT, int IDX, char **R_METHOD, ksba_name_t *R_LOCATION)
- Return the authorityInfoAccess attributes. IDX should be iterated
- starting from 0 until this function returns `GPG_ERR_EOF'.
+
+ Return the authorityInfoAccess attributes. IDX should be iterated
+ starting from 0 until this function returns 'GPG_ERR_EOF'.
R_METHOD returns an allocated string with the OID of one item and
- R_LOCATION returns the GeneralName for that OID. The returned
+ R_LOCATION returns the GeneralName for that OID. The returned
values for R_METHOD and R_LOCATION must be released by the caller
unless the function returned an error; the function will however
- make sure that R_METHOD and R_LOCATION will point to `NULL' if the
+ make sure that R_METHOD and R_LOCATION will point to 'NULL' if the
function returns an error.
See RFC-2459, section 4.2.2.1 for the definition of this attribute.
-- Function: gpg_error_t ksba_cert_get_subject_info_access
(ksba_cert_t CERT, int IDX, char **R_METHOD, ksba_name_t *R_LOCATION)
- Return the subjectInfoAccess attributes. IDX should be iterated
- starting from 0 until this function returns `GPG_ERR_EOF'.
+
+ Return the subjectInfoAccess attributes. IDX should be iterated
+ starting from 0 until this function returns 'GPG_ERR_EOF'.
R_METHOD returns an allocated string with the OID of one item and
- R_LOCATION returns the GeneralName for that OID. The returned
+ R_LOCATION returns the GeneralName for that OID. The returned
values for R_METHOD and R_LOCATION must be released by the caller
unless the function returned an error; the function will however
- make sure that R_METHOD and R_LOCATION will point to `NULL' if the
+ make sure that R_METHOD and R_LOCATION will point to 'NULL' if the
function returns an error.
See RFC-2459, section 4.2.2.2 for the definition of this attribute.
Certificate objects play a central role in many applications and often
it is desirable to associate other data with the certificate to avoid
-wrapping the certificate object into an own object. `KSBA' provides a
+wrapping the certificate object into an own object. 'KSBA' provides a
mechanism for this by means of two functions:
-- Function: gpg_error_t ksba_cert_set_user_data
(ksba_cert_t CERT, const char *KEY, const void *DATA, size_t DATALEN)
+
Stores arbitrary data along with a certificate. The data is
- expected in the buffer DATA of length DATALEN. It will be stored
+ expected in the buffer DATA of length DATALEN. It will be stored
under the string KEY. If data is already stored under this key it
- will be replaced by the new data. Using `NULL' for DATA will
+ will be replaced by the new data. Using 'NULL' for DATA will
effectively delete the data.
- On error (i.e. out of memory) an already existing data object
+ On error (i.e., out of memory) an already existing data object
stored under KEY may get deleted.
*Caution:* This function is definitely not thread safe because we
-- Function: gpg_error_t ksba_cert_get_user_data (ksba_cert_t CERT,
const char *KEY, void *BUFFER, size_t BUFFERLEN,
size_t *DATALEN)
+
Return user data for certificate CERT stored under the string KEY.
The caller needs to provide a suitable large BUFFER and the usable
- length of this buffer in BUFFERLEN. If DATALEN is not `NULL', the
+ length of this buffer in BUFFERLEN. If DATALEN is not 'NULL', the
length of the data stored in BUFFER will be stored there.
- If BUFFER is given as `NULL', BUFFERLEN will be ignored and the
+ If BUFFER is given as 'NULL', BUFFERLEN will be ignored and the
required length of the buffer will be returned at DATALEN.
On success 0 is returned. If no data is stored under the given
- key, `GPG_ERR_NOT_FOUND' is returned. If the provided buffer is
- too short and BUFFER is not `NULL', `GPG_ERR_BUFFER_TOO_SHORT'
- will be returned.
-
- \f
+ key, 'GPG_ERR_NOT_FOUND' is returned. If the provided buffer is
+ too short and BUFFER is not 'NULL', 'GPG_ERR_BUFFER_TOO_SHORT' will
+ be returned.
\1f
File: ksba.info, Node: CMS, Next: CRLs, Prev: Certificate Handling, Up: Top
********************************************
The CMS is also known under the name PKCS#7. Is is a cryptographic
-framework for securing data transactions and storage, much like
-OpenPGP. It is heavily based on X.509 semantics and for example used
-with the email encryption protocol S/MIME.
+framework for securing data transactions and storage, much like OpenPGP.
+It is heavily based on X.509 semantics and for example used with the
+email encryption protocol S/MIME.
* Menu:
to store some meta information.
-- Data type: ksba_cms_t
- The `ksba_cms_t' type is used for this CMS object.
-
+ The 'ksba_cms_t' type is used for this CMS object.
-- Data type: ksba_stop_reason_t
- The `ksba_stop_reason_t' type is an enumeration used for
+ The 'ksba_stop_reason_t' type is an enumeration used for
communication between the phases of a parsing or building process.
-- Function: ksba_cms_t ksba_cms_new (void)
+
This function creates a new CMS object. The only reason the
function may fail is an out-of-memory condition in which case
- `NULL' is returned. It is safe for the caller to translate this
- to the standard error code `GPG_ERR_ENOMEM'. Any object created
- with this function should be released after use by using
- `ksba_cms_release'.
+ 'NULL' is returned. It is safe for the caller to translate this to
+ the standard error code 'GPG_ERR_ENOMEM'. Any object created with
+ this function should be released after use by using
+ 'ksba_cms_release'.
-- Function: void ksba_cms_release (ksba_cms_t CMS)
+
Release all resources associated with the CMS object. It is
- perfectly okay to pass `NULL' to this function in which case
+ perfectly okay to pass 'NULL' to this function in which case
nothing happens.
-- Function: gpg_error_t ksba_cms_set_reader_writer
(ksba_cms_t CMS, ksba_reader_t R, ksba_writer_t W)
- About all usages of the CMS framework require some input and
- output data (great surprise!). To accomplish this in the most
- abstract way, no direct output functions are used - instead
- special reader and writer objects are used instead. Depending on
- the desired operations either a reader, a writer or both must be
- given. Associate a reader object with CMS by passing it as R and
- a writer object by passing it as W. Note that no reference
- counting is done,so make sure that those objects have a lifetime
- at least as long as CMS.
+
+ About all usages of the CMS framework require some input and output
+ data (great surprise!). To accomplish this in the most abstract
+ way, no direct output functions are used - instead special reader
+ and writer objects are used instead. Depending on the desired
+ operations either a reader, a writer or both must be given.
+ Associate a reader object with CMS by passing it as R and a writer
+ object by passing it as W. Note that no reference counting is
+ done,so make sure that those objects have a lifetime at least as
+ long as CMS.
If you forget to set these objects, you will get an appropriate
error later when data is actually to be read or written. The
4.2 CMS Parser
==============
-KSBA includes a versatile CMS parser for encryption (enveloped data)
-and digital signing. The parser is capable of handling arbitrary
-amounts of data without requiring much memory. Well, certain objects
-are build in memory because it can be assumed that those objects are
-limited in size; e.g. it does not make sense to use a video clip as the
-DN despite the fact that the standard does not forbid it.
+KSBA includes a versatile CMS parser for encryption (enveloped data) and
+digital signing. The parser is capable of handling arbitrary amounts of
+data without requiring much memory. Well, certain objects are build in
+memory because it can be assumed that those objects are limited in size;
+e.g., it does not make sense to use a video clip as the DN despite the
+fact that the standard does not forbid it.
-- Function: gpg_error_t ksba_cms_parse
(ksba_cms_t CMS, ksba_stop_reason_t *R_STOPREASON)
+
This is the core function of the parser and commonly used in a
loop. The parsing process is divided into several phases to allow
the user to get information at the right time and prepare for
KSBA may introduce new stop reasons to let the caller know other
details; there is no need for the caller to act on every stop
reason; it should only do so for reasons that the caller
- understands and which are mandatory. The function will return
- with an error if the caller did not setup things correctly for
- certain stop reasons.
+ understands and which are mandatory. The function will return with
+ an error if the caller did not setup things correctly for certain
+ stop reasons.
- The use of this function is best explained by an example, leaving
-out all error checking.
+ The use of this function is best explained by an example, leaving out
+all error checking.
do
{
ksba_cms_parse (cms, &stopreason);
}
}
while (stopreason != KSBA_SR_READY);
- This function assumes that the parsed data is so called `enveloped
+ This function assumes that the parsed data is so called 'enveloped
data'.
As CMS provides a common framework for a variety of data formats, it
-is probably very useful to check the type of that data very early.
-This can be accomplished by hooking into the stop reason
-`KSBA_SR_GOT_CONTENT' and retrieving the content using the following
+is probably very useful to check the type of that data very early. This
+can be accomplished by hooking into the stop reason
+'KSBA_SR_GOT_CONTENT' and retrieving the content using the following
function.
-- Function: ksba_content_t ksba_cms_get_content_type
(ksba_cms_t CMS, int WHAT)
- By using a value of `0' for WHAT this function returns the content
- type of the outer container; using `1' does return the content
- type of the enclosed object.
+
+ By using a value of '0' for WHAT this function returns the content
+ type of the outer container; using '1' does return the content type
+ of the enclosed object.
-- Data type: ksba_content_t
- The `ksba_content_t' type is an enumeration used to describe
+ The 'ksba_content_t' type is an enumeration used to describe
the content of a CMS message. Here is a list of possible
values:
- `KSBA_CT_NONE'
- No content type known (value `0')
+ 'KSBA_CT_NONE'
+ No content type known (value '0')
- `KSBA_CT_DATA'
+ 'KSBA_CT_DATA'
The content is plain data, not further interpreted.
- `KSBA_CT_SIGNED_DATA'
+ 'KSBA_CT_SIGNED_DATA'
The content is an signed CMS object. This also includes
the case of a detached signature where no actual data is
included in the message.
- `KSBA_CT_ENVELOPED_DATA'
+ 'KSBA_CT_ENVELOPED_DATA'
The content is encrypted using a session key.
- `KSBA_CT_DIGESTED_DATA'
+ 'KSBA_CT_DIGESTED_DATA'
Not yet supported
- `KSBA_CT_ENCRYPTED_DATA'
+ 'KSBA_CT_ENCRYPTED_DATA'
Not yet supported
- `KSBA_CT_AUTH_DATA'
+ 'KSBA_CT_AUTH_DATA'
Not yet supported
-- Function: const char * ksba_cms_get_content_oid
(ksba_cms_t CMS, int WHAT)
+
Return the object ID of CMS. This is a constant string valid as
long as the context is valid and no new parse is started. This
- function is similar to `ksba_cms_get_content_type' but returns the
+ function is similar to 'ksba_cms_get_content_type' but returns the
OID actually used in the data. Depending on the value of WHAT
- different values are returned: Using a value of `0' yields the OID
- of the outer container, a value of `1' yields the OID of the inner
- container if available and the value `2' returns the OID of the
+ different values are returned: Using a value of '0' yields the OID
+ of the outer container, a value of '1' yields the OID of the inner
+ container if available and the value '2' returns the OID of the
algorithm used to encrypt the inner container.
\1f
When using decentral generated keys, it is necessary to send out special
formated messages so that a CA can generate the certificate.
- \f
-
\1f
File: ksba.info, Node: Utilities, Next: Error Handling, Prev: PKCS10, Up: Top
no other clean way to access them.
-- Data type: ksba_name_t
- The `ksba_name_t' type is an object to represent names sets.
+ The 'ksba_name_t' type is an object to represent names sets.
-- Function: void ksba_name_release (ksba_name_t NAME)
- This function releases the object NAME. Passing `NULL' is allowed.
+
+ This function releases the object NAME. Passing 'NULL' is allowed.
-- Function: const char * ksba_name_enum (ksba_name_t NAME, int IDX)
+
By iterating IDX up starting with 0, this function returns all
General Names stored in NAME. The format of the returned name is
either a RFC-2253 formated one which can be detected by checking
whether the first character is letter or a digit. RFC 2822
- conformant email addresses are returned enclosed in angle
- brackets, the opening angle bracket should be used to detect this.
- Other formats are returned as an S-Expression in canonical format,
- so an opening parenthesis may be used to detect this encoding, in
- this case the name may include binary null characters, so strlen
- might return a length shorter than actually used, the real length
- is implicitly given by the structure of the S-Exp, an extra null
- is appended for safety reasons. One common format return is a
- Universal Resource Identifier which has the S-expression: `(uri
+ conformant email addresses are returned enclosed in angle brackets,
+ the opening angle bracket should be used to detect this. Other
+ formats are returned as an S-Expression in canonical format, so an
+ opening parenthesis may be used to detect this encoding, in this
+ case the name may include binary null characters, so strlen might
+ return a length shorter than actually used, the real length is
+ implicitly given by the structure of the S-Exp, an extra null is
+ appended for safety reasons. One common format return is a
+ Universal Resource Identifier which has the S-expression: '(uri
<urivalue>)'.
The returned string has the same lifetime as NAME.
-- Function: char * ksba_name_get_uri (ksba_name_t NAME, int IDX)
- Convenience function to return names representing an URI. Caller
+
+ Convenience function to return names representing an URI. Caller
must free the returned value. Note that this function should not
be used to enumerate the names.
-- Function: gpg_error_t ksba_dn_teststr (const char *STRING, int SEQ,
size_t *RERROFF, size_t *RERRLEN)
+
Assuming that STRING contains an RFC-2253 encoded string, test
whether this string may be passed as a valid DN to libksba. On
- success the functions returns `0'. On error the function returns
+ success the functions returns '0'. On error the function returns
an error code and stores the offset of the erroneous part at
- RERROFF. RERRLEN will then receive the length of the erroneous
+ RERROFF. RERRLEN will then receive the length of the erroneous
part.
This function is mostly useful to test whether a certain component
- label is supported. SEQ should be passed as `0' for now. Any of
+ label is supported. SEQ should be passed as '0' for now. Any of
RERROFF and RERRLEN may be passed as NULL if the caller is not
interested at this value.
-
gpg_error_t ksba_dn_str2der (const char *string, void **rder, size_t
*rderlen);
gpg_error_t ksba_dn_der2str (const void *der, size_t derlen, char
**r_string);
- \f
-
\1f
File: ksba.info, Node: Error Handling, Next: Component Labels, Prev: Utilities, Up: Top
8 Error Handling
****************
-Most functions in `KSBA' will return an error if they fail. For this
-reason, the application should always catch the error condition and
-take appropriate measures, for example by releasing the resources and
-passing the error up to the caller, or by displaying a descriptive
-message to the user and canceling the operation.
+Most functions in 'KSBA' will return an error if they fail. For this
+reason, the application should always catch the error condition and take
+appropriate measures, for example by releasing the resources and passing
+the error up to the caller, or by displaying a descriptive message to
+the user and canceling the operation.
Some error values do not indicate a system error or an error in the
operation, but the reasonable result of an operation. For example, if
specific meanings if returned by a specific function. Such cases are
described in the documentation of those functions.
- All error codes are defined by the library `libgpg-error'. See
-there for ways to check the error values and print descriptive strings.
+ All error codes are defined by the library 'libgpg-error'. See there
+for ways to check the error values and print descriptive strings.
Please be aware that you can't check directly against an error code but
have to do it like this:
if (gpg_err_code (err) == GPG_ERR_EOF)
okay = 1;
- The only exception is that success (i.e. no error) is defined to be
-`0'; thus you may directly test for success like:
+ The only exception is that success (i.e., no error) is defined to be
+'0'; thus you may directly test for success like:
if (!ksba_foo ())
okay = 1;
components:
Label Component OID
-
C countryName 2.5.4.6
CN commonName 2.5.4.3
DC domainComponent 0.9.2342.19200300.100.1.25
ST stateOrProvince 2.5.4.8
STREET streetAddress 2.5.4.9
UID userid 0.9.2342.19200300.100.1.1
+
They are used internally for converting a DN into its string
representation; components not listed in this table will be represented
by their OID.
- For the other direction, i.e. creating a DN from the string
+ For the other direction, i.e., creating a DN from the string
representation, KSBA recognizes the following extra labels:
Label Component OID
-
ADDR postalAddress 2.5.4.16
BC businessCategory 2.5.4.15
D description 2.5.4.13
SERIALNUMBER serialNumber 2.5.4.5
SN surname 2.5.4.4
T title 2.5.4.12
+
\1f
File: ksba.info, Node: Copying, Next: Concept Index, Prev: Component Labels, Up: Top
Version 3, 29 June 2007
- Copyright (C) 2007 Free Software Foundation, Inc. `http://fsf.org/'
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.
free programs, and that you know you can do these things.
To protect your rights, we need to prevent others from denying you
-these rights or asking you to surrender the rights. Therefore, you
-have certain responsibilities if you distribute copies of the software,
-or if you modify it: responsibilities to respect the freedom of others.
+these rights or asking you to surrender the rights. Therefore, you have
+certain responsibilities if you distribute copies of the software, or if
+you modify it: responsibilities to respect the freedom of others.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must pass on to the recipients the same
authors of previous versions.
Some devices are designed to deny users access to install or run
-modified versions of the software inside them, although the
-manufacturer can do so. This is fundamentally incompatible with the
-aim of protecting users' freedom to change the software. The
-systematic pattern of such abuse occurs in the area of products for
-individuals to use, which is precisely where it is most unacceptable.
-Therefore, we have designed this version of the GPL to prohibit the
-practice for those products. If such problems arise substantially in
-other domains, we stand ready to extend this provision to those domains
-in future versions of the GPL, as needed to protect the freedom of
-users.
+modified versions of the software inside them, although the manufacturer
+can do so. This is fundamentally incompatible with the aim of
+protecting users' freedom to change the software. The systematic
+pattern of such abuse occurs in the area of products for individuals to
+use, which is precisely where it is most unacceptable. Therefore, we
+have designed this version of the GPL to prohibit the practice for those
+products. If such problems arise substantially in other domains, we
+stand ready to extend this provision to those domains in future versions
+of the GPL, as needed to protect the freedom of users.
Finally, every program is threatened constantly by software patents.
States should not allow patents to restrict development and use of
modification follow.
TERMS AND CONDITIONS
+
0. Definitions.
"This License" refers to version 3 of the GNU General Public
To "propagate" a work means to do anything with it that, without
permission, would make you directly or secondarily liable for
- infringement under applicable copyright law, except executing it
- on a computer or modifying a private copy. Propagation includes
+ infringement under applicable copyright law, except executing it on
+ a computer or modifying a private copy. Propagation includes
copying, distribution (with or without modification), making
available to the public, and in some countries other activities as
well.
to the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2)
tells the user that there is no warranty for the work (except to
- the extent that warranties are provided), that licensees may
- convey the work under this License, and how to view a copy of this
+ the extent that warranties are provided), that licensees may convey
+ the work under this License, and how to view a copy of this
License. If the interface presents a list of user commands or
options, such as a menu, a prominent item in the list meets this
criterion.
1. Source Code.
The "source code" for a work means the preferred form of the work
- for making modifications to it. "Object code" means any
- non-source form of a work.
+ for making modifications to it. "Object code" means any non-source
+ form of a work.
A "Standard Interface" means an interface that either is an
official standard defined by a recognized standards body, or, in
The "System Libraries" of an executable work include anything,
other than the work as a whole, that (a) is included in the normal
form of packaging a Major Component, but which is not part of that
- Major Component, and (b) serves only to enable use of the work
- with that Major Component, or to implement a Standard Interface
- for which an implementation is available to the public in source
- code form. A "Major Component", in this context, means a major
+ Major Component, and (b) serves only to enable use of the work with
+ that Major Component, or to implement a Standard Interface for
+ which an implementation is available to the public in source code
+ form. A "Major Component", in this context, means a major
essential component (kernel, window system, and so on) of the
specific operating system (if any) on which the executable work
runs, or a compiler used to produce the work, or an object code
The "Corresponding Source" for a work in object code form means all
the source code needed to generate, install, and (for an executable
- work) run the object code and to modify the work, including
- scripts to control those activities. However, it does not include
- the work's System Libraries, or general-purpose tools or generally
+ work) run the object code and to modify the work, including scripts
+ to control those activities. However, it does not include the
+ work's System Libraries, or general-purpose tools or generally
available free programs which are used unmodified in performing
those activities but which are not part of the work. For example,
- Corresponding Source includes interface definition files
- associated with source files for the work, and the source code for
- shared libraries and dynamically linked subprograms that the work
- is specifically designed to require, such as by intimate data
+ Corresponding Source includes interface definition files associated
+ with source files for the work, and the source code for shared
+ libraries and dynamically linked subprograms that the work is
+ specifically designed to require, such as by intimate data
communication or control flow between those subprograms and other
parts of the work.
copyright on the Program, and are irrevocable provided the stated
conditions are met. This License explicitly affirms your unlimited
permission to run the unmodified Program. The output from running
- a covered work is covered by this License only if the output,
- given its content, constitutes a covered work. This License
- acknowledges your rights of fair use or other equivalent, as
- provided by copyright law.
+ a covered work is covered by this License only if the output, given
+ its content, constitutes a covered work. This License acknowledges
+ your rights of fair use or other equivalent, as provided by
+ copyright law.
You may make, run and propagate covered works that you do not
convey, without conditions so long as your license otherwise
remains in force. You may convey covered works to others for the
- sole purpose of having them make modifications exclusively for
- you, or provide you with facilities for running those works,
- provided that you comply with the terms of this License in
- conveying all material for which you do not control copyright.
- Those thus making or running the covered works for you must do so
- exclusively on your behalf, under your direction and control, on
- terms that prohibit them from making any copies of your
- copyrighted material outside their relationship with you.
+ sole purpose of having them make modifications exclusively for you,
+ or provide you with facilities for running those works, provided
+ that you comply with the terms of this License in conveying all
+ material for which you do not control copyright. Those thus making
+ or running the covered works for you must do so exclusively on your
+ behalf, under your direction and control, on terms that prohibit
+ them from making any copies of your copyrighted material outside
+ their relationship with you.
Conveying under any other circumstances is permitted solely under
the conditions stated below. Sublicensing is not allowed; section
When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such
circumvention is effected by exercising rights under this License
- with respect to the covered work, and you disclaim any intention
- to limit operation or modification of the work as a means of
+ with respect to the covered work, and you disclaim any intention to
+ limit operation or modification of the work as a means of
enforcing, against the work's users, your or third parties' legal
rights to forbid circumvention of technological measures.
b. Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by a
- written offer, valid for at least three years and valid for
- as long as you offer spare parts or customer support for that
+ written offer, valid for at least three years and valid for as
+ long as you offer spare parts or customer support for that
product model, to give anyone who possesses the object code
either (1) a copy of the Corresponding Source for all the
software in the product that is covered by this License, on a
to copy the Corresponding Source from a network server at no
charge.
- c. Convey individual copies of the object code with a copy of
- the written offer to provide the Corresponding Source. This
+ c. Convey individual copies of the object code with a copy of the
+ written offer to provide the Corresponding Source. This
alternative is allowed only occasionally and noncommercially,
and only if you received the object code with such an offer,
in accord with subsection 6b.
d. Convey the object code by offering access from a designated
- place (gratis or for a charge), and offer equivalent access
- to the Corresponding Source in the same way through the same
+ place (gratis or for a charge), and offer equivalent access to
+ the Corresponding Source in the same way through the same
place at no further charge. You need not require recipients
to copy the Corresponding Source along with the object code.
If the place to copy the object code is a network server, the
- Corresponding Source may be on a different server (operated
- by you or a third party) that supports equivalent copying
- facilities, provided you maintain clear directions next to
- the object code saying where to find the Corresponding Source.
+ Corresponding Source may be on a different server (operated by
+ you or a third party) that supports equivalent copying
+ facilities, provided you maintain clear directions next to the
+ object code saying where to find the Corresponding Source.
Regardless of what server hosts the Corresponding Source, you
- remain obligated to ensure that it is available for as long
- as needed to satisfy these requirements.
+ remain obligated to ensure that it is available for as long as
+ needed to satisfy these requirements.
e. Convey the object code using peer-to-peer transmission,
provided you inform other peers where the object code and
Corresponding Source of the work are being offered to the
general public at no charge under subsection 6d.
-
A separable portion of the object code, whose source code is
excluded from the Corresponding Source as a System Library, need
not be included in conveying the object code work.
A "User Product" is either (1) a "consumer product", which means
any tangible personal property which is normally used for personal,
family, or household purposes, or (2) anything designed or sold for
- incorporation into a dwelling. In determining whether a product
- is a consumer product, doubtful cases shall be resolved in favor of
+ incorporation into a dwelling. In determining whether a product is
+ a consumer product, doubtful cases shall be resolved in favor of
coverage. For a particular product received by a particular user,
"normally used" refers to a typical or common use of that class of
product, regardless of the status of the particular user or of the
The requirement to provide Installation Information does not
include a requirement to continue to provide support service,
- warranty, or updates for a work that has been modified or
- installed by the recipient, or for the User Product in which it
- has been modified or installed. Access to a network may be denied
- when the modification itself materially and adversely affects the
- operation of the network or violates the rules and protocols for
+ warranty, or updates for a work that has been modified or installed
+ by the recipient, or for the User Product in which it has been
+ modified or installed. Access to a network may be denied when the
+ modification itself materially and adversely affects the operation
+ of the network or violates the rules and protocols for
communication across the network.
Corresponding Source conveyed, and Installation Information
Notwithstanding any other provision of this License, for material
you add to a covered work, you may (if authorized by the copyright
- holders of that material) supplement the terms of this License
- with terms:
+ holders of that material) supplement the terms of this License with
+ terms:
a. Disclaiming warranty or limiting liability differently from
the terms of sections 15 and 16 of this License; or
Legal Notices displayed by works containing it; or
c. Prohibiting misrepresentation of the origin of that material,
- or requiring that modified versions of such material be
- marked in reasonable ways as different from the original
- version; or
+ or requiring that modified versions of such material be marked
+ in reasonable ways as different from the original version; or
d. Limiting the use for publicity purposes of names of licensors
or authors of the material; or
you received it, or any part of it, contains a notice stating that
it is governed by this License along with a term that is a further
restriction, you may remove that term. If a license document
- contains a further restriction but permits relicensing or
- conveying under this License, you may add to a covered work
- material governed by the terms of that license document, provided
- that the further restriction does not survive such relicensing or
- conveying.
+ contains a further restriction but permits relicensing or conveying
+ under this License, you may add to a covered work material governed
+ by the terms of that license document, provided that the further
+ restriction does not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
You may not propagate or modify a covered work except as expressly
provided under this License. Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights
- under this License (including any patent licenses granted under
- the third paragraph of section 11).
+ under this License (including any patent licenses granted under the
+ third paragraph of section 11).
However, if you cease all violation of this License, then your
license from a particular copyright holder is reinstated (a)
- provisionally, unless and until the copyright holder explicitly
- and finally terminates your license, and (b) permanently, if the
+ provisionally, unless and until the copyright holder explicitly and
+ finally terminates your license, and (b) permanently, if the
copyright holder fails to notify you of the violation by some
reasonable means prior to 60 days after the cessation.
after your receipt of the notice.
Termination of your rights under this section does not terminate
- the licenses of parties who have received copies or rights from
- you under this License. If your rights have been terminated and
- not permanently reinstated, you do not qualify to receive new
- licenses for the same material under section 10.
+ the licenses of parties who have received copies or rights from you
+ under this License. If your rights have been terminated and not
+ permanently reinstated, you do not qualify to receive new licenses
+ for the same material under section 10.
9. Acceptance Not Required for Having Copies.
by modifying or propagating a covered work, you indicate your
acceptance of this License to do so.
- 10. Automatic Licensing of Downstream Recipients.
+ 10. Automatic Licensing of Downstream Recipients.
Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
covered work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party's predecessor in interest had or
- could give under the previous paragraph, plus a right to
- possession of the Corresponding Source of the work from the
- predecessor in interest, if the predecessor has it or can get it
- with reasonable efforts.
+ could give under the previous paragraph, plus a right to possession
+ of the Corresponding Source of the work from the predecessor in
+ interest, if the predecessor has it or can get it with reasonable
+ efforts.
You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License. For example, you
- may not impose a license fee, royalty, or other charge for
- exercise of rights granted under this License, and you may not
- initiate litigation (including a cross-claim or counterclaim in a
- lawsuit) alleging that any patent claim is infringed by making,
- using, selling, offering for sale, or importing the Program or any
- portion of it.
+ may not impose a license fee, royalty, or other charge for exercise
+ of rights granted under this License, and you may not initiate
+ litigation (including a cross-claim or counterclaim in a lawsuit)
+ alleging that any patent claim is infringed by making, using,
+ selling, offering for sale, or importing the Program or any portion
+ of it.
- 11. Patents.
+ 11. Patents.
A "contributor" is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based.
Each contributor grants you a non-exclusive, worldwide,
royalty-free patent license under the contributor's essential
patent claims, to make, use, sell, offer for sale, import and
- otherwise run, modify and propagate the contents of its
- contributor version.
+ otherwise run, modify and propagate the contents of its contributor
+ version.
In the following three paragraphs, a "patent license" is any
express agreement or commitment, however denominated, not to
enforce a patent (such as an express permission to practice a
- patent or covenant not to sue for patent infringement). To
- "grant" such a patent license to a party means to make such an
- agreement or commitment not to enforce a patent against the party.
+ patent or covenant not to sue for patent infringement). To "grant"
+ such a patent license to a party means to make such an agreement or
+ commitment not to enforce a patent against the party.
If you convey a covered work, knowingly relying on a patent
license, and the Corresponding Source of the work is not available
conditioned on the non-exercise of one or more of the rights that
are specifically granted under this License. You may not convey a
covered work if you are a party to an arrangement with a third
- party that is in the business of distributing software, under
- which you make payment to the third party based on the extent of
- your activity of conveying the work, and under which the third
- party grants, to any of the parties who would receive the covered
- work from you, a discriminatory patent license (a) in connection
- with copies of the covered work conveyed by you (or copies made
- from those copies), or (b) primarily for and in connection with
- specific products or compilations that contain the covered work,
- unless you entered into that arrangement, or that patent license
- was granted, prior to 28 March 2007.
+ party that is in the business of distributing software, under which
+ you make payment to the third party based on the extent of your
+ activity of conveying the work, and under which the third party
+ grants, to any of the parties who would receive the covered work
+ from you, a discriminatory patent license (a) in connection with
+ copies of the covered work conveyed by you (or copies made from
+ those copies), or (b) primarily for and in connection with specific
+ products or compilations that contain the covered work, unless you
+ entered into that arrangement, or that patent license was granted,
+ prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.
- 12. No Surrender of Others' Freedom.
+ 12. No Surrender of Others' Freedom.
- If conditions are imposed on you (whether by court order,
- agreement or otherwise) that contradict the conditions of this
- License, they do not excuse you from the conditions of this
- License. If you cannot convey a covered work so as to satisfy
- simultaneously your obligations under this License and any other
- pertinent obligations, then as a consequence you may not convey it
- at all. For example, if you agree to terms that obligate you to
- collect a royalty for further conveying from those to whom you
- convey the Program, the only way you could satisfy both those
- terms and this License would be to refrain entirely from conveying
- the Program.
+ If conditions are imposed on you (whether by court order, agreement
+ or otherwise) that contradict the conditions of this License, they
+ do not excuse you from the conditions of this License. If you
+ cannot convey a covered work so as to satisfy simultaneously your
+ obligations under this License and any other pertinent obligations,
+ then as a consequence you may not convey it at all. For example,
+ if you agree to terms that obligate you to collect a royalty for
+ further conveying from those to whom you convey the Program, the
+ only way you could satisfy both those terms and this License would
+ be to refrain entirely from conveying the Program.
- 13. Use with the GNU Affero General Public License.
+ 13. Use with the GNU Affero General Public License.
Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
General Public License, section 13, concerning interaction through
a network will apply to the combination as such.
- 14. Revised Versions of this License.
+ 14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new
- versions of the GNU General Public License from time to time.
- Such new versions will be similar in spirit to the present
- version, but may differ in detail to address new problems or
- concerns.
+ versions of the GNU General Public License from time to time. Such
+ new versions will be similar in spirit to the present version, but
+ may differ in detail to address new problems or concerns.
Each version is given a distinguishing version number. If the
Program specifies that a certain numbered version of the GNU
General Public License "or any later version" applies to it, you
have the option of following the terms and conditions either of
- that numbered version or of any later version published by the
- Free Software Foundation. If the Program does not specify a
- version number of the GNU General Public License, you may choose
- any version ever published by the Free Software Foundation.
+ that numbered version or of any later version published by the Free
+ Software Foundation. If the Program does not specify a version
+ number of the GNU General Public License, you may choose any
+ version ever published by the Free Software Foundation.
If the Program specifies that a proxy can decide which future
versions of the GNU General Public License can be used, that
author or copyright holder as a result of your choosing to follow a
later version.
- 15. Disclaimer of Warranty.
+ 15. Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
- APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE
+ APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE
COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS"
WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
- MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE
+ MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE
RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.
SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL
NECESSARY SERVICING, REPAIR OR CORRECTION.
- 16. Limitation of Liability.
+ 16. Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES
- AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU
- FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR
+ AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR
+ DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR
CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE
THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA
BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF
THE POSSIBILITY OF SUCH DAMAGES.
- 17. Interpretation of Sections 15 and 16.
+ 17. Interpretation of Sections 15 and 16.
If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
connection with the Program, unless a warranty or assumption of
liability accompanies a copy of the Program in return for a fee.
-
END OF TERMS AND CONDITIONS
+
How to Apply These Terms to Your New Programs
=============================================
General Public License for more details.
You should have received a copy of the GNU General Public License
- along with this program. If not, see `http://www.gnu.org/licenses/'.
+ along with this program. If not, see <http://www.gnu.org/licenses/>.
Also add information on how to contact you by electronic and paper mail.
PROGRAM Copyright (C) YEAR NAME OF AUTHOR
This program comes with ABSOLUTELY NO WARRANTY; for details
- type `show w'. This is free software, and you are
+ type 'show w'. This is free software, and you are
welcome to redistribute it under certain conditions;
- type `show c' for details.
+ type 'show c' for details.
- The hypothetical commands `show w' and `show c' should show the
+ The hypothetical commands 'show w' and 'show c' should show the
appropriate parts of the General Public License. Of course, your
program's commands might be different; for a GUI interface, you would
use an "about box".
You should also get your employer (if you work as a programmer) or
school, if any, to sign a "copyright disclaimer" for the program, if
necessary. For more information on this, and how to apply and follow
-the GNU GPL, see `http://www.gnu.org/licenses/'.
+the GNU GPL, see <http://www.gnu.org/licenses/>.
The GNU General Public License does not permit incorporating your
program into proprietary programs. If your program is a subroutine
library, you may consider it more useful to permit linking proprietary
applications with the library. If this is what you want to do, use the
GNU Lesser General Public License instead of this License. But first,
-please read `http://www.gnu.org/philosophy/why-not-lgpl.html'.
+please read <http://www.gnu.org/philosophy/why-not-lgpl.html>.
\1f
File: ksba.info, Node: Concept Index, Next: Function and Data Index, Prev: Copying, Up: Top
Concept Index
*************
-\0\b[index\0\b]
-* Menu:
\1f
File: ksba.info, Node: Function and Data Index, Prev: Concept Index, Up: Top
\0\b[index\0\b]
* Menu:
-* ksba_cert_get_auth_key_id: Retrieving attributes.
- (line 251)
* ksba_cert_get_authority_info_access: Retrieving attributes.
- (line 259)
+ (line 277)
+* ksba_cert_get_auth_key_id: Retrieving attributes.
+ (line 268)
* ksba_cert_get_cert_policies: Retrieving attributes.
- (line 215)
+ (line 230)
* ksba_cert_get_crl_dist_point: Retrieving attributes.
- (line 225)
+ (line 240)
* ksba_cert_get_digest_algo: Retrieving attributes.
- (line 38)
-* ksba_cert_get_ext_key_usages: Retrieving attributes.
- (line 210)
+ (line 39)
* ksba_cert_get_extension: Retrieving attributes.
- (line 158)
+ (line 178)
+* ksba_cert_get_ext_key_usages: Retrieving attributes.
+ (line 224)
* ksba_cert_get_image: Retrieving attributes.
- (line 13)
+ (line 11)
* ksba_cert_get_issuer: Retrieving attributes.
- (line 54)
+ (line 71)
* ksba_cert_get_key_usage: Retrieving attributes.
- (line 170)
+ (line 191)
* ksba_cert_get_public_key: Retrieving attributes.
- (line 150)
+ (line 170)
* ksba_cert_get_serial: Retrieving attributes.
- (line 48)
+ (line 64)
* ksba_cert_get_sig_val: Retrieving attributes.
- (line 154)
-* ksba_cert_get_subj_key_id: Retrieving attributes.
- (line 243)
+ (line 174)
* ksba_cert_get_subject: Retrieving attributes.
- (line 80)
+ (line 98)
* ksba_cert_get_subject_info_access: Retrieving attributes.
- (line 272)
-* ksba_cert_get_user_data: User data. (line 28)
+ (line 291)
+* ksba_cert_get_subj_key_id: Retrieving attributes.
+ (line 259)
+* ksba_cert_get_user_data: User data. (line 26)
* ksba_cert_get_validity: Retrieving attributes.
- (line 141)
+ (line 159)
* ksba_cert_hash: Retrieving attributes.
- (line 26)
+ (line 24)
* ksba_cert_init_from_mem: Creating certificates.
- (line 42)
+ (line 41)
* ksba_cert_is_ca: Retrieving attributes.
- (line 162)
+ (line 183)
* ksba_cert_new: Creating certificates.
- (line 10)
+ (line 9)
* ksba_cert_read_der: Creating certificates.
- (line 32)
+ (line 30)
* ksba_cert_ref: Creating certificates.
- (line 19)
+ (line 18)
* ksba_cert_release: Creating certificates.
- (line 24)
-* ksba_cert_set_user_data: User data. (line 13)
+ (line 23)
+* ksba_cert_set_user_data: User data. (line 11)
* ksba_cert_t: Certificate Handling.
- (line 10)
-* ksba_check_version: Version Check. (line 13)
+ (line 9)
+* ksba_check_version: Version Check. (line 12)
* ksba_cms_get_content_oid: CMS Parser. (line 89)
-* ksba_cms_get_content_type: CMS Parser. (line 55)
-* ksba_cms_new: CMS Basics. (line 18)
-* ksba_cms_parse: CMS Parser. (line 15)
-* ksba_cms_release: CMS Basics. (line 26)
-* ksba_cms_set_reader_writer: CMS Basics. (line 32)
-* ksba_cms_t: CMS Basics. (line 11)
-* ksba_content_t: CMS Parser. (line 60)
-* ksba_dn_teststr: DNs. (line 11)
+* ksba_cms_get_content_type: CMS Parser. (line 54)
+* ksba_cms_new: CMS Basics. (line 16)
+* ksba_cms_parse: CMS Parser. (line 13)
+* ksba_cms_release: CMS Basics. (line 25)
+* ksba_cms_set_reader_writer: CMS Basics. (line 31)
+* ksba_cms_t: CMS Basics. (line 10)
+* ksba_content_t: CMS Parser. (line 61)
+* ksba_dn_teststr: DNs. (line 9)
* ksba_isotime_t: Retrieving attributes.
- (line 104)
+ (line 123)
* ksba_name_enum: Names. (line 17)
-* ksba_name_get_uri: Names. (line 35)
-* ksba_name_release: Names. (line 14)
-* ksba_name_t: Names. (line 11)
+* ksba_name_get_uri: Names. (line 36)
+* ksba_name_release: Names. (line 13)
+* ksba_name_t: Names. (line 10)
* ksba_sexp_t: Certificate Handling.
- (line 13)
-* ksba_stop_reason_t: CMS Basics. (line 14)
+ (line 12)
+* ksba_stop_reason_t: CMS Basics. (line 12)
\1f
Tag Table:
-Node: Top\7f789
-Node: Introduction\7f2821
-Node: Getting Started\7f3099
-Node: Features\7f3965
-Node: Overview\7f5056
-Node: Preparation\7f5305
-Node: Header\7f5788
-Node: Version Check\7f6384
-Node: Building the source\7f7475
-Node: Certificate Handling\7f9319
-Node: Creating certificates\7f10300
-Node: Retrieving attributes\7f12756
-Node: Setting attributes\7f26404
-Node: User data\7f26669
-Node: CMS\7f28590
-Node: CMS Basics\7f29050
-Node: CMS Parser\7f31112
-Node: CRLs\7f35078
-Node: PKCS10\7f35361
-Node: Utilities\7f35628
-Node: Names\7f36032
-Node: OIDs\7f38341
-Node: DNs\7f38545
-Node: Error Handling\7f39680
-Node: Component Labels\7f41034
-Node: Copying\7f42524
-Node: Concept Index\7f80067
-Node: Function and Data Index\7f80215
+Node: Top\7f743
+Node: Introduction\7f2778
+Node: Getting Started\7f3056
+Node: Features\7f3922
+Node: Overview\7f5013
+Node: Preparation\7f5262
+Node: Header\7f5745
+Node: Version Check\7f6341
+Node: Building the source\7f7433
+Node: Certificate Handling\7f9284
+Node: Creating certificates\7f10265
+Node: Retrieving attributes\7f12726
+Node: Setting attributes\7f26944
+Node: User data\7f27209
+Node: CMS\7f29129
+Node: CMS Basics\7f29588
+Node: CMS Parser\7f31651
+Node: CRLs\7f35629
+Node: PKCS10\7f35912
+Node: Utilities\7f36173
+Node: Names\7f36577
+Node: OIDs\7f38889
+Node: DNs\7f39093
+Node: Error Handling\7f40224
+Node: Component Labels\7f41579
+Node: Copying\7f43142
+Node: Concept Index\7f80669
+Node: Function and Data Index\7f80797
\1f
End Tag Table
+
+\1f
+Local Variables:
+coding: utf-8
+End:
projects / platform / upstream / libksba.git / blobdiff