# XML Security Library Reference Manual

Aleksey Sanin

    	    aleksey@aleksey.com

2002-2024 Aleksey Sanin

Permission is granted to make and distribute verbatim copies of this manual provided the copyright notice and this permission notice are preserved on all copies.

Permission is granted to copy and distribute modified versions of this manual under the conditions for verbatim copying, provided also that the entire resulting derived work is distributed under the terms of a permission notice identical to this one.

Permission is granted to copy and distribute translations of this manual into another language, under the above conditions for modified versions.

This manual documents the interfaces of the xmlsec library and has some short notes to help get you up to speed with using the library.

## XML Security Library Tutorial

### Overview.

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, Microsoft Crypto API, Microsoft Cryptography API: Next Generation (CNG), GnuTLS, GCrypt and NSS).

### XML Security Library Structure.

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-mscng, xmlsec-gnutls, xmlsec-gcrypt, xmlsec-nss, ...).

The library structure and dependencies.

The core library has no dependency on any crypto library and provides implementation of all the engines as well as support for all the non crypto transforms (xml parser, c14n transforms, xpath and xslt transforms,...). The XML Security Crypto library provides implementations for crypto transforms, crypto keys data and key data stores. Application is linked with particular XML Security Crypto library (or even libraries), but the actual application code might be general enough so switching crypto engine would be a matter of changing several #include directives.

&chapter-compiling-and-linking; &chapter-init-and-shutdown; &chapter-sign-and-encrypt; &chapter-creating-templates; &chapter-verify-and-decrypt; &chapter-using-keys; &chapter-using-keysmngr; &chapter-using-x509-certs; &chapter-using-transforms; &chapter-using-contexts; &chapter-new-crypto; &chapter-examples;

### APPENDIX A. XML Security Library Signature Klasses.

XML Security Library Signature Klasses.

### APPENDIX B. XML Security Library Encryption Klasses.

XML Security Library Encryption Klasses.

## XML Security Library API Reference.

### XML Security Core Library API Reference.

This section contains the API reference for xmlsec. All the public interfaces are documented here. This reference guide is build by extracting comments from the code sources.

### XML Security Library for OpenSLL API Reference.

This section contains the API reference for xmlsec-openssl. All the public interfaces are documented here. This reference guide is build by extracting comments from the code sources.

### XML Security Library for GnuTLS API Reference.

This section contains the API reference for xmlsec-gnutls. All the public interfaces are documented here. This reference guide is build by extracting comments from the code sources.

### XML Security Library for GCrypt API Reference.

This section contains the API reference for xmlsec-gcrypt. All the public interfaces are documented here. This reference guide is build by extracting comments from the code sources.

### XML Security Library for NSS API Reference.

This section contains the API reference for xmlsec-nss. All the public interfaces are documented here. This reference guide is build by extracting comments from the code sources.

### XML Security Library for Microsoft Crypto API Reference.

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.

### XML Security Library for Microsoft Cryptography API: Next Generation (CNG) Reference.

This section contains the API reference for xmlsec-mscng (based on Microsoft Cryptography API: Next Generation (CNG)). All the public interfaces are documented here. This reference guide is build by extracting comments from the code sources.

### XML Security Library Reference Index

&xmlsec-index;