diff options
Diffstat (limited to 'docs/api/src/xmlsec.sgml')
| -rw-r--r-- | docs/api/src/xmlsec.sgml | 235 |
1 files changed, 131 insertions, 104 deletions
diff --git a/docs/api/src/xmlsec.sgml b/docs/api/src/xmlsec.sgml index fdb3ac1f..d418adbd 100644 --- a/docs/api/src/xmlsec.sgml +++ b/docs/api/src/xmlsec.sgml @@ -1,7 +1,9 @@ -<!doctype book PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [ +<?xml version="1.0" standalone="no"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" " +http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [ <!ENTITY chapter-compiling-and-linking SYSTEM "chapters/compiling-and-linking.sgml"> -<!ENTITY chapter-init-and-shutdown SYSTEM "chapters/init-and-shutdown.sgml"> -<!ENTITY chapter-sign-and-encrypt SYSTEM "chapters/sign-and-encrypt.sgml"> +<!ENTITY chapter-init-and-shutdown SYSTEM "chapters/init-and-shutdown.sgml"> +<!ENTITY chapter-sign-and-encrypt SYSTEM "chapters/sign-and-encrypt.sgml"> <!ENTITY chapter-verify-and-decrypt SYSTEM "chapters/verify-and-decrypt.sgml"> <!ENTITY chapter-creating-templates SYSTEM "chapters/creating-templates.sgml"> <!ENTITY chapter-using-keys SYSTEM "chapters/using-keys.sgml"> @@ -14,55 +16,61 @@ <!ENTITY xmlsec-index SYSTEM "xmlsec-index.sgml"> -<!ENTITY xmlsec-app SYSTEM "app.sgml"> -<!ENTITY xmlsec-base64 SYSTEM "base64.sgml"> -<!ENTITY xmlsec-bn SYSTEM "bn.sgml"> -<!ENTITY xmlsec-buffer SYSTEM "buffer.sgml"> -<!ENTITY xmlsec-dl SYSTEM "dl.sgml"> -<!ENTITY xmlsec-errors SYSTEM "errors.sgml"> -<!ENTITY xmlsec-io SYSTEM "io.sgml"> -<!ENTITY xmlsec-keyinfo SYSTEM "keyinfo.sgml"> -<!ENTITY xmlsec-keysdata SYSTEM "keysdata.sgml"> -<!ENTITY xmlsec-keys SYSTEM "keys.sgml"> -<!ENTITY xmlsec-keysmngr SYSTEM "keysmngr.sgml"> -<!ENTITY xmlsec-list SYSTEM "list.sgml"> -<!ENTITY xmlsec-membuf SYSTEM "membuf.sgml"> -<!ENTITY xmlsec-nodeset SYSTEM "nodeset.sgml"> -<!ENTITY xmlsec-parser SYSTEM "parser.sgml"> -<!ENTITY xmlsec-templates SYSTEM "templates.sgml"> -<!ENTITY xmlsec-transforms SYSTEM "transforms.sgml"> -<!ENTITY xmlsec-version SYSTEM "version.sgml"> -<!ENTITY xmlsec-xmldsig SYSTEM "xmldsig.sgml"> -<!ENTITY xmlsec-xmlenc SYSTEM "xmlenc.sgml"> -<!ENTITY xmlsec-xmlsec SYSTEM "xmlsec.sgml"> -<!ENTITY xmlsec-xmltree SYSTEM "xmltree.sgml"> -<!ENTITY xmlsec-x509 SYSTEM "x509.sgml"> - -<!ENTITY xmlsec-openssl-app SYSTEM "openssl/app.sgml"> -<!ENTITY xmlsec-openssl-bn SYSTEM "openssl/bn.sgml"> -<!ENTITY xmlsec-openssl-ciphers SYSTEM "openssl/ciphers.sgml"> -<!ENTITY xmlsec-openssl-crypto SYSTEM "openssl/crypto.sgml"> -<!ENTITY xmlsec-openssl-evp SYSTEM "openssl/evp.sgml"> -<!ENTITY xmlsec-openssl-x509 SYSTEM "openssl/x509.sgml"> - -<!ENTITY xmlsec-gnutls-app SYSTEM "gnutls/app.sgml"> -<!ENTITY xmlsec-gnutls-crypto SYSTEM "gnutls/crypto.sgml"> - -<!ENTITY xmlsec-gcrypt-app SYSTEM "gcrypt/app.sgml"> -<!ENTITY xmlsec-gcrypt-crypto SYSTEM "gcrypt/crypto.sgml"> - -<!ENTITY xmlsec-nss-app SYSTEM "nss/app.sgml"> -<!ENTITY xmlsec-nss-bignum SYSTEM "nss/bignum.sgml"> -<!ENTITY xmlsec-nss-crypto SYSTEM "nss/crypto.sgml"> -<!ENTITY xmlsec-nss-keysstore SYSTEM "nss/keysstore.sgml"> -<!ENTITY xmlsec-nss-pkikeys SYSTEM "nss/pkikeys.sgml"> -<!ENTITY xmlsec-nss-x509 SYSTEM "nss/x509.sgml"> - -<!ENTITY xmlsec-mscrypto-app SYSTEM "mscrypto/app.sgml"> -<!ENTITY xmlsec-mscrypto-certkeys SYSTEM "mscrypto/certkeys.sgml"> -<!ENTITY xmlsec-mscrypto-crypto SYSTEM "mscrypto/crypto.sgml"> -<!ENTITY xmlsec-mscrypto-keysstore SYSTEM "mscrypto/keysstore.sgml"> -<!ENTITY xmlsec-mscrypto-x509 SYSTEM "mscrypto/x509.sgml"> +<!ENTITY xmlsec-app "base/app.xml"> +<!ENTITY xmlsec-base64 "base/base64.xml"> +<!ENTITY xmlsec-bn "base/bn.xml"> +<!ENTITY xmlsec-buffer "base/buffer.xml"> +<!ENTITY xmlsec-dl "base/dl.xml"> +<!ENTITY xmlsec-errors "base/errors.xml"> +<!ENTITY xmlsec-io "base/io.xml"> +<!ENTITY xmlsec-keyinfo "base/keyinfo.xml"> +<!ENTITY xmlsec-keysdata "base/keysdata.xml"> +<!ENTITY xmlsec-keys "base/keys.xml"> +<!ENTITY xmlsec-keysmngr "base/keysmngr.xml"> +<!ENTITY xmlsec-list "base/list.xml"> +<!ENTITY xmlsec-membuf "base/membuf.xml"> +<!ENTITY xmlsec-nodeset "base/nodeset.xml"> +<!ENTITY xmlsec-parser "base/parser.xml"> +<!ENTITY xmlsec-templates "base/templates.xml"> +<!ENTITY xmlsec-transforms "base/transforms.xml"> +<!ENTITY xmlsec-version "base/version.xml"> +<!ENTITY xmlsec-x509 "base/x509.xml"> +<!ENTITY xmlsec-xmldsig "base/xmldsig.xml"> +<!ENTITY xmlsec-xmlenc "base/xmlenc.xml"> +<!ENTITY xmlsec-xmlsec "base/xmlsec.xml"> +<!ENTITY xmlsec-xmltree "base/xmltree.xml"> + +<!ENTITY xmlsec-openssl-app "openssl/app.xml"> +<!ENTITY xmlsec-openssl-bn "openssl/bn.xml"> +<!ENTITY xmlsec-openssl-crypto "openssl/crypto.xml"> +<!ENTITY xmlsec-openssl-evp "openssl/evp.xml"> +<!ENTITY xmlsec-openssl-x509 "openssl/x509.xml"> + +<!ENTITY xmlsec-gnutls-app "gnutls/app.xml"> +<!ENTITY xmlsec-gnutls-crypto "gnutls/crypto.xml"> +<!ENTITY xmlsec-gnutls-x509 "gnutls/x509.xml"> + +<!ENTITY xmlsec-gcrypt-app "gcrypt/app.xml"> +<!ENTITY xmlsec-gcrypt-crypto "gcrypt/crypto.xml"> + +<!ENTITY xmlsec-nss-app "nss/app.xml"> +<!ENTITY xmlsec-nss-bignum "nss/bignum.xml"> +<!ENTITY xmlsec-nss-crypto "nss/crypto.xml"> +<!ENTITY xmlsec-nss-keysstore "nss/keysstore.xml"> +<!ENTITY xmlsec-nss-pkikeys "nss/pkikeys.xml"> +<!ENTITY xmlsec-nss-x509 "nss/x509.xml"> + +<!ENTITY xmlsec-mscrypto-app "mscrypto/app.xml"> +<!ENTITY xmlsec-mscrypto-certkeys "mscrypto/certkeys.xml"> +<!ENTITY xmlsec-mscrypto-crypto "mscrypto/crypto.xml"> +<!ENTITY xmlsec-mscrypto-keysstore "mscrypto/keysstore.xml"> +<!ENTITY xmlsec-mscrypto-x509 "mscrypto/x509.xml"> + +<!ENTITY xmlsec-mscng-app "mscng/app.xml"> +<!ENTITY xmlsec-mscng-certkeys "mscng/certkeys.xml"> +<!ENTITY xmlsec-mscng-crypto "mscng/crypto.xml"> +<!ENTITY xmlsec-mscng-keysstore "mscng/keysstore.xml"> +<!ENTITY xmlsec-mscng-x509 "mscng/x509.xml"> <!ENTITY xmlsec-example-sign1 SYSTEM "examples/sign1.sgml"> <!ENTITY xmlsec-example-sign2 SYSTEM "examples/sign2.sgml"> @@ -99,7 +107,7 @@ <!ENTITY xmlsec-example-encrypt3-doc SYSTEM "examples/encrypt3-doc.sgml"> <!ENTITY xmlsec-example-encrypt3-res SYSTEM "examples/encrypt3-res.sgml"> ]> -<book id="index"> +<book id="index" xmlns:xi="http://www.w3.org/2001/XInclude"> <bookinfo> <title>XML Security Library Reference Manual</title> <authorgroup> @@ -114,7 +122,7 @@ </author> </authorgroup> <copyright> - <year>2002-2003</year> + <year>2002-2017</year> <holder>Aleksey Sanin</holder> </copyright> <legalnotice> @@ -146,14 +154,15 @@ <para>XML Security Library provides support for XML Digital Signature and XML Encryption. It is based on LibXML/LibXSLT and can use practicaly any crypto library (currently there is "out of the box" - support for OpenSSL, MSCrypto, GnuTLS, GCrypt and NSS). + support for OpenSSL, Microsoft Crypto API, Microsoft Cryptography API: + Next Generation (CNG), GnuTLS, GCrypt and NSS). </para> </chapter> <chapter id="xmlsec-notes-structure"> <title>XML Security Library Structure.</title> <para>In order to provide the an ability to use different crypto engines, the XML Security Library is splitted in two parts: core library (xmlsec) - and crypto library (xmlsec-openssl, xmlsec-mscrypt, xmlsec-gnutls, + and crypto library (xmlsec-openssl, xmlsec-mscrypt, xmlsec-mscng, xmlsec-gnutls, xmlsec-gcrypt, xmlsec-nss, ...). <figure> <title>The library structure and dependencies.</title> @@ -210,29 +219,29 @@ the public interfaces are documented here. This reference guide is build by extracting comments from the code sources. </para> - &xmlsec-app; - &xmlsec-base64; - &xmlsec-bn; - &xmlsec-buffer; - &xmlsec-dl; - &xmlsec-errors; - &xmlsec-io; - &xmlsec-keyinfo; - &xmlsec-keysdata; - &xmlsec-keys; - &xmlsec-keysmngr; - &xmlsec-list; - &xmlsec-membuf; - &xmlsec-nodeset; - &xmlsec-parser; - &xmlsec-templates; - &xmlsec-transforms; - &xmlsec-version; - &xmlsec-xmldsig; - &xmlsec-xmlenc; - &xmlsec-xmlsec; - &xmlsec-xmltree; - &xmlsec-x509; + <xi:include href="&xmlsec-app;"/> + <xi:include href="&xmlsec-base64;"/> + <xi:include href="&xmlsec-bn;"/> + <xi:include href="&xmlsec-buffer;"/> + <xi:include href="&xmlsec-dl;"/> + <xi:include href="&xmlsec-errors;"/> + <xi:include href="&xmlsec-io;"/> + <xi:include href="&xmlsec-keyinfo;"/> + <xi:include href="&xmlsec-keysdata;"/> + <xi:include href="&xmlsec-keys;"/> + <xi:include href="&xmlsec-keysmngr;"/> + <xi:include href="&xmlsec-list;"/> + <xi:include href="&xmlsec-membuf;"/> + <xi:include href="&xmlsec-nodeset;"/> + <xi:include href="&xmlsec-parser;"/> + <xi:include href="&xmlsec-templates;"/> + <xi:include href="&xmlsec-transforms;"/> + <xi:include href="&xmlsec-version;"/> + <xi:include href="&xmlsec-xmldsig;"/> + <xi:include href="&xmlsec-xmlenc;"/> + <xi:include href="&xmlsec-xmlsec;"/> + <xi:include href="&xmlsec-xmltree;"/> + <xi:include href="&xmlsec-x509;"/> </chapter> <chapter id="xmlsec-openssl-ref"> @@ -241,11 +250,11 @@ the public interfaces are documented here. This reference guide is build by extracting comments from the code sources. </para> - &xmlsec-openssl-app; - &xmlsec-openssl-bn; - &xmlsec-openssl-crypto; - &xmlsec-openssl-evp; - &xmlsec-openssl-x509; + <xi:include href="&xmlsec-openssl-app;"/> + <xi:include href="&xmlsec-openssl-bn;"/> + <xi:include href="&xmlsec-openssl-crypto;"/> + <xi:include href="&xmlsec-openssl-evp;"/> + <xi:include href="&xmlsec-openssl-x509;"/> </chapter> <chapter id="xmlsec-gnutls-ref"> @@ -254,8 +263,9 @@ the public interfaces are documented here. This reference guide is build by extracting comments from the code sources. </para> - &xmlsec-gnutls-app; - &xmlsec-gnutls-crypto; + <xi:include href="&xmlsec-gnutls-app;"/> + <xi:include href="&xmlsec-gnutls-crypto;"/> + <xi:include href="&xmlsec-gnutls-x509;"/> </chapter> <chapter id="xmlsec-gcrypt-ref"> @@ -264,8 +274,8 @@ the public interfaces are documented here. This reference guide is build by extracting comments from the code sources. </para> - &xmlsec-gcrypt-app; - &xmlsec-gcrypt-crypto; + <xi:include href="&xmlsec-gcrypt-app;"/> + <xi:include href="&xmlsec-gcrypt-crypto;"/> </chapter> <chapter id="xmlsec-nss-ref"> @@ -274,32 +284,49 @@ the public interfaces are documented here. This reference guide is build by extracting comments from the code sources. </para> - &xmlsec-nss-app; - &xmlsec-nss-bignum; - &xmlsec-nss-crypto; - &xmlsec-nss-keysstore; - &xmlsec-nss-pkikeys; - &xmlsec-nss-x509; + <xi:include href="&xmlsec-nss-app;"/> + <xi:include href="&xmlsec-nss-bignum;"/> + <xi:include href="&xmlsec-nss-crypto;"/> + <xi:include href="&xmlsec-nss-keysstore;"/> + <xi:include href="&xmlsec-nss-pkikeys;"/> + <xi:include href="&xmlsec-nss-x509;"/> </chapter> <chapter id="xmlsec-mscrypto-ref"> - <title>XML Security Library for MSCrypto API Reference.</title> - <para>This section contains the API reference for xmlsec-mscrypto. All - the public interfaces are documented here. This reference guide is - build by extracting comments from the code sources. </para> + <title>XML Security Library for Microsoft Crypto API Reference.</title> + <para>This section contains the API reference for xmlsec-mscrypto (based on + Microsoft Crypto API). All the public interfaces are documented here. + This reference guide is build by extracting comments from the code sources. + </para> - &xmlsec-mscrypto-app; - &xmlsec-mscrypto-certkeys; - &xmlsec-mscrypto-crypto; - &xmlsec-mscrypto-keysstore; - &xmlsec-mscrypto-x509; + <xi:include href="&xmlsec-mscrypto-app;"/> + <xi:include href="&xmlsec-mscrypto-certkeys;"/> + <xi:include href="&xmlsec-mscrypto-crypto;"/> + <xi:include href="&xmlsec-mscrypto-keysstore;"/> + <xi:include href="&xmlsec-mscrypto-x509;"/> </chapter> + + <chapter id="xmlsec-msccng-ref"> + <title>XML Security Library for Microsoft Cryptography API: Next Generation (CNG) Reference.</title> + <para>This section contains the API reference for xmlsec-mscng (based on + <a href="https://msdn.microsoft.com/en-us/library/windows/desktop/aa376210(v=vs.85).aspx">Microsoft + Cryptography API: Next Generation (CNG)</a>). All the public interfaces are + documented here. This reference guide is build by extracting comments from + the code sources. </para> + + <xi:include href="&xmlsec-mscng-app;"/> + <xi:include href="&xmlsec-mscng-certkeys;"/> + <xi:include href="&xmlsec-mscng-crypto;"/> + <xi:include href="&xmlsec-mscng-keysstore;"/> + <xi:include href="&xmlsec-mscng-x509;"/> + </chapter> + <chapter id="xmlsec-index"> <title>XML Security Library Reference Index</title> <para> <itemizedlist> - &xmlsec-index; + &xmlsec-index; </itemizedlist> </para> </chapter> |