docs/api/index.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
   4 <title>XML Security Library Reference Manual</title>
   5 <meta name="GENERATOR" content="Modular DocBook HTML Stylesheet Version 1.79">
   6 <link rel="NEXT" title="XML Security Library Tutorial" href="xmlsec-notes.html">
   7 <style type="text/css">.synopsis, .classsynopsis {
   8     background: #eeeeee;
   9     border: solid 1px #aaaaaa;
  10     padding: 0.5em;
  11 }
  12 .programlisting {
  13     background: #eeeeff;
  14     border: solid 1px #aaaaff;
  15     padding: 0.5em;
  16 }
  17 .variablelist {
  18     padding: 4px;
  19     margin-left: 3em;
  20 }
  21 .navigation {
  22     background: #ffeeee;
  23     border: solid 1px #ffaaaa;
  24     margin-top: 0.5em;
  25     margin-bottom: 0.5em;
  26 }
  27 .navigation a {
  28     color: #770000;
  29 }
  30 .navigation a:visited {
  31     color: #550000;
  32 }
  33 .navigation .title {
  34     font-size: 200%;
  35 }</style>
  36 </head>
  37 <body><table witdh="100%" valign="top"><tr valign="top">
  38 <td valign="top" align="left" width="210">
  39 <img src="../images/logo.gif" alt="XML Security Library" border="0"><p></p>
  40 <ul>
  41 <li><a href="../index.html">Home</a></li>
  42 <li><a href="../download.html">Download</a></li>
  43 <li><a href="../news.html">News</a></li>
  44 <li><a href="../documentation.html">Documentation</a></li>
  45 <ul>
  46 <li><a href="../faq.html">FAQ</a></li>
  47 <li><a href="../api/xmlsec-notes.html">Tutorial</a></li>
  48 <li><a href="../api/xmlsec-reference.html">API reference</a></li>
  49 <li><a href="../api/xmlsec-examples.html">Examples</a></li>
  50 </ul>
  51 <li><a href="../xmldsig.html">XML Digital Signature</a></li>
  52 <ul><li><a href="http://www.aleksey.com/xmlsec/xmldsig-verifier.html">Online Verifier</a></li></ul>
  53 <li><a href="../xmlenc.html">XML Encryption</a></li>
  54 <li><a href="../c14n.html">XML Canonicalization</a></li>
  55 <li><a href="../bugs.html">Reporting Bugs</a></li>
  56 <li><a href="http://www.aleksey.com/pipermail/xmlsec">Mailing list</a></li>
  57 <li><a href="../related.html">Related</a></li>
  58 <li><a href="../authors.html">Authors</a></li>
  59 </ul>
  60 <table width="100%">
  61 <tr>
  62 <td width="15"></td>
  63 <td><a href="http://xmlsoft.org/"><img src="../images/libxml2-logo.png" alt="LibXML2" border="0"></a></td>
  64 </tr>
  65 <tr>
  66 <td width="15"></td>
  67 <td><a href="http://xmlsoft.org/XSLT"><img src="../images/libxslt-logo.png" alt="LibXSLT" border="0"></a></td>
  68 </tr>
  69 <tr>
  70 <td width="15"></td>
  71 <td><a href="http://www.openssl.org/"><img src="../images/openssl-logo.png" alt="OpenSSL" border="0"></a></td>
  72 </tr>
  73 <!--Links - start--><!--Links - end-->
  74 </table>
  75 </td>
  76 <td valign="top"><table width="100%" valign="top"><tr><td valign="top" align="left" id="xmlsecContent">
  77 <div class="BOOK">
  78 <div class="TITLEPAGE">
  79 <table class="navigation" width="100%" cellpadding="2" cellspacing="0"><tr><th align="center" valign="MIDDLE"><p class="TITLE">XML Security Library Reference Manual<a name="AEN2"></a></p></th></tr></table>
  80 <h3 class="AUTHOR">
  81 <a name="AEN5"></a>Aleksey Sanin</h3>
  82 <div class="AFFILIATION"><div class="ADDRESS"><p class="ADDRESS">           <code class="EMAIL">&lt;<a href="mailto:aleksey@aleksey.com">aleksey@aleksey.com</a>&gt;</code><br>
  83           </p></div></div>
  84 <p class="COPYRIGHT">Copyright © 2002-2003 Aleksey Sanin</p>
  85 <div><div class="ABSTRACT">
  86 <p></p>
  87 <a name="AEN18"></a><p>This manual documents the interfaces of the xmlsec
  88       library and has some short notes to help get you up to speed
  89       with using the library.</p>
  90 <p></p>
  91 </div></div>
  92 <div class="LEGALNOTICE">
  93 <p></p>
  94 <a name="AEN14"></a><p>Permission is granted to make and distribute verbatim
  95       copies of this manual provided the copyright notice and this
  96       permission notice are preserved on all copies.</p>
  97 <p>Permission is granted to copy and distribute modified
  98       versions of this manual under the conditions for verbatim
  99       copying, provided also that the entire resulting derived work is
 100       distributed under the terms of a permission notice identical to
 101       this one.</p>
 102 <p>Permission is granted to copy and distribute translations
 103       of this manual into another language, under the above conditions
 104       for modified versions.</p>
 105 <p></p>
 106 </div>
 107 </div>
 108 <div class="TOC"><dl>
 109 <dt><b>Table of Contents</b></dt>
 110 <dt>I. <a href="xmlsec-notes.html">XML Security Library Tutorial</a>
 111 </dt>
 112 <dd><dl>
 113 <dt><a href="xmlsec-notes-overview.html">Overview.</a></dt>
 114 <dt><a href="xmlsec-notes-structure.html">XML Security Library Structure.</a></dt>
 115 <dt><a href="xmlsec-notes-compiling.html">Building the application with XML Security Library.</a></dt>
 116 <dd><dl>
 117 <dt><a href="xmlsec-notes-compiling.html#XMLSEC-NOTES-COMPILING-OVERVIEW">Overview.</a></dt>
 118 <dt><a href="xmlsec-notes-include-files.html">Include files.</a></dt>
 119 <dt><a href="xmlsec-notes-compiling-unix.html">Compiling and linking on Unix.</a></dt>
 120 <dt><a href="xmlsec-notes-compiling-windows.html">Compiling and linking on Windows.</a></dt>
 121 <dt><a href="xmlsec-notes-compiling-others.html">Compiling and linking on other systems.</a></dt>
 122 </dl></dd>
 123 <dt><a href="xmlsec-notes-init-shutdown.html">Initialization and shutdown.</a></dt>
 124 <dt><a href="xmlsec-notes-sign-encrypt.html">Signing and encrypting documents.</a></dt>
 125 <dd><dl>
 126 <dt><a href="xmlsec-notes-sign-encrypt.html#XMLSEC-NOTES-SIGN-ENCRYPT-OVERVIEW">Overview.</a></dt>
 127 <dt><a href="xmlsec-notes-sign.html">Signing a document.</a></dt>
 128 <dt><a href="xmlsec-notes-encrypt.html">Encrypting data.</a></dt>
 129 </dl></dd>
 130 <dt><a href="xmlsec-notes-templates.html">Creating dynamic templates.</a></dt>
 131 <dd><dl>
 132 <dt><a href="xmlsec-notes-templates.html#XMLSEC-NOTES-TEMPLATES-OVERVIEW">Overview.</a></dt>
 133 <dt><a href="xmlsec-notes-dynamic-signature-templates.html">Creating dynamic signature templates.</a></dt>
 134 <dt><a href="xmlsec-notes-dynamic-encryption-templates.html">Creating dynamic encryption templates.</a></dt>
 135 </dl></dd>
 136 <dt><a href="xmlsec-notes-verify-decrypt.html">Verifing and decrypting documents.</a></dt>
 137 <dd><dl>
 138 <dt><a href="xmlsec-notes-verify-decrypt.html#XMLSEC-NOTES-VERIFY-DECRYPT-OVERVIEW">Overview.</a></dt>
 139 <dt><a href="xmlsec-notes-verify.html">Verifying a signed document</a></dt>
 140 <dt><a href="xmlsec-notes-decrypt.html">Decrypting an encrypted document</a></dt>
 141 </dl></dd>
 142 <dt><a href="xmlsec-notes-keys.html">Keys.</a></dt>
 143 <dt><a href="xmlsec-notes-keysmngr.html">Keys manager.</a></dt>
 144 <dd><dl>
 145 <dt><a href="xmlsec-notes-keysmngr.html#XMLSEC-NOTES-KEYSMNGR-OVERVIEW">Overview.</a></dt>
 146 <dt><a href="xmlsec-notes-simple-keys-store.html">Simple keys store.</a></dt>
 147 <dt><a href="xmlsec-notes-keys-manager-sign-enc.html">Using keys manager for signatures/encryption.</a></dt>
 148 <dt><a href="xmlsec-notes-keys-mngr-verify-decrypt.html">Using keys manager for verification/decryption.</a></dt>
 149 <dt><a href="xmlsec-notes-custom-keys-store.html">Implementing a custom keys store.</a></dt>
 150 </dl></dd>
 151 <dt><a href="xmlsec-notes-x509.html">Using X509 Certificates.</a></dt>
 152 <dd><dl>
 153 <dt><a href="xmlsec-notes-x509.html#XMLSEC-NOTES-X509-OVERVIEW">Overview.</a></dt>
 154 <dt><a href="xmlsec-notes-sign-x509.html">Signing data with X509 certificate.</a></dt>
 155 <dt><a href="xmlsec-notes-verify-x509.html">Verifing document signed with X509 certificates.</a></dt>
 156 </dl></dd>
 157 <dt><a href="xmlsec-notes-transforms.html">Transforms and transforms chain.</a></dt>
 158 <dt><a href="xmlsec-notes-contexts.html">Using context objects.</a></dt>
 159 <dt><a href="xmlsec-notes-new-crypto.html">Adding support for new cryptographic library.</a></dt>
 160 <dd><dl>
 161 <dt><a href="xmlsec-notes-new-crypto.html#XMLSEC-NOTES-NEW-CRYPTO-OVERVIEW">Overview.</a></dt>
 162 <dt><a href="xmlsec-notes-new-crypto-skeleton.html">Creating a framework from the skeleton.</a></dt>
 163 <dt><a href="xmlsec-notes-new-crypto-functions.html">xmlSecCryptoApp* functions.</a></dt>
 164 <dt><a href="xmlsec-notes-new-crypto-klasses.html">Klasses and objects.</a></dt>
 165 <dt><a href="xmlsec-notes-new-crypto-transforms.html">Cryptographic transforms.</a></dt>
 166 <dt><a href="xmlsec-notes-new-crypto-keys.html">Keys data and keys data stores.</a></dt>
 167 <dt><a href="xmlsec-notes-new-crypto-simple-keys-mngr.html">Default keys manager.</a></dt>
 168 <dt><a href="xmlsec-notes-new-crypto-sharing-results.html">Sharing the results.</a></dt>
 169 </dl></dd>
 170 <dt><a href="xmlsec-examples.html">Examples.</a></dt>
 171 <dd><dl>
 172 <dt><a href="xmlsec-examples.html#XMLSEC-EXAMPLES-OVERVIEW">XML Security Library Examples.</a></dt>
 173 <dt><a href="xmlsec-examples-sign-template-file.html">Signing a template file.</a></dt>
 174 <dt><a href="xmlsec-examples-sign-dynamimc-template.html">Signing a dynamicaly created template.</a></dt>
 175 <dt><a href="xmlsec-examples-sign-x509.html">Signing with X509 certificate.</a></dt>
 176 <dt><a href="xmlsec-verify-with-key.html">Verifying a signature with a single key.</a></dt>
 177 <dt><a href="xmlsec-verify-with-keys-mngr.html">Verifying a signature with keys manager.</a></dt>
 178 <dt><a href="xmlsec-verify-with-x509.html">Verifying a signature with X509 certificates.</a></dt>
 179 <dt><a href="xmlsec-verify-with-restrictions.html">Verifying a signature with additional restrictions.</a></dt>
 180 <dt><a href="xmlsec-encrypt-template-file.html">Encrypting data with a template file.</a></dt>
 181 <dt><a href="xmlsec-encrypt-dynamic-template.html">Encrypting data with a dynamicaly created template.</a></dt>
 182 <dt><a href="xmlsec-encrypt-with-session-key.html">Encrypting data with a session key.</a></dt>
 183 <dt><a href="xmlsec-decrypt-with-signle-key.html">Decrypting data with a single key.</a></dt>
 184 <dt><a href="xmlsec-decrypt-with-keys-mngr.html">Decrypting data with keys manager.</a></dt>
 185 <dt><a href="xmlsec-custom-keys-manager.html">Writing a custom keys manager.</a></dt>
 186 </dl></dd>
 187 <dt><a href="xmlsec-signature-klasses.html">APPENDIX A. XML Security Library Signature Klasses.</a></dt>
 188 <dt><a href="xmlsec-encryption-klasses.html">APPENDIX B. XML Security Library Encryption Klasses.</a></dt>
 189 </dl></dd>
 190 <dt>II. <a href="xmlsec-reference.html">XML Security Library API Reference.</a>
 191 </dt>
 192 <dd><dl>
 193 <dt><a href="xmlsec-ref.html">XML Security Core Library API Reference.</a></dt>
 194 <dd><dl>
 195 <dt>
 196 <a href="xmlsec-app.html">app</a> -- Crypto-engine independent application support function.</dt>
 197 <dt>
 198 <a href="xmlsec-base64.html">base64</a> -- Base64 encoding/decoding functions.</dt>
 199 <dt>
 200 <a href="xmlsec-bn.html">bn</a> -- Big numbers support functions.</dt>
 201 <dt>
 202 <a href="xmlsec-buffer.html">buffer</a> -- Binary buffer implementation.</dt>
 203 <dt>
 204 <a href="xmlsec-dl.html">dl</a> -- Dynamic crypto-engine library loading support.</dt>
 205 <dt>
 206 <a href="xmlsec-errors.html">errors</a> -- Error/log messages support.</dt>
 207 <dt>
 208 <a href="xmlsec-io.html">io</a> -- Input/output support.</dt>
 209 <dt>
 210 <a href="xmlsec-keyinfo.html">keyinfo</a> -- <a href="http://www.w3.org/TR/xmldsig-core/#sec-KeyInfo" target="_top">&lt;dsig:KeyInfo/&gt;</a> node parser.</dt>
 211 <dt>
 212 <a href="xmlsec-keysdata.html">keysdata</a> -- Crypto key data object definition.</dt>
 213 <dt>
 214 <a href="xmlsec-keys.html">keys</a> -- Crypto key object definition.</dt>
 215 <dt>
 216 <a href="xmlsec-keysmngr.html">keysmngr</a> -- Keys manager object support.</dt>
 217 <dt>
 218 <a href="xmlsec-list.html">list</a> -- Generic list structure implementation.</dt>
 219 <dt>
 220 <a href="xmlsec-membuf.html">membuf</a> -- Memory buffer transform implementation.</dt>
 221 <dt>
 222 <a href="xmlsec-nodeset.html">nodeset</a> -- Nodeset object implementation.</dt>
 223 <dt>
 224 <a href="xmlsec-parser.html">parser</a> -- Parser transform implementation.</dt>
 225 <dt>
 226 <a href="xmlsec-templates.html">templates</a> -- Dynamic templates creation functions.</dt>
 227 <dt>
 228 <a href="xmlsec-transforms.html">transforms</a> -- Transform object definition.</dt>
 229 <dt>
 230 <a href="xmlsec-version.html">version</a> -- Version macros.</dt>
 231 <dt>
 232 <a href="xmlsec-xmldsig.html">xmldsig</a> -- XML Digital Signature support.</dt>
 233 <dt>
 234 <a href="xmlsec-xmlenc.html">xmlenc</a> -- XML Encryption support.</dt>
 235 <dt>
 236 <a href="xmlsec-xmlsec.html">xmlsec</a> -- Utility functions.</dt>
 237 <dt>
 238 <a href="xmlsec-xmltree.html">xmltree</a> -- XML tree operations.</dt>
 239 <dt>
 240 <a href="xmlsec-x509.html">x509</a> -- <a href="http://www.w3.org/TR/xmldsig-core/#sec-X509Certificate" target="_top">&lt;dsig:X509Certificate/&gt;</a> node parser.</dt>
 241 </dl></dd>
 242 <dt><a href="xmlsec-openssl-ref.html">XML Security Library for OpenSLL API Reference.</a></dt>
 243 <dd><dl>
 244 <dt>
 245 <a href="xmlsec-openssl-app.html">app</a> -- Application functions implementation for OpenSSL.</dt>
 246 <dt>
 247 <a href="xmlsec-openssl-bn.html">bn</a> -- Big numbers helper functions.</dt>
 248 <dt>
 249 <a href="xmlsec-openssl-crypto.html">crypto</a> -- Crypto transforms implementation for OpenSSL.</dt>
 250 <dt>
 251 <a href="xmlsec-openssl-evp.html">evp</a> -- EVP keys data implementation.</dt>
 252 <dt>
 253 <a href="xmlsec-openssl-x509.html">x509</a> -- X509 certificates support implementation for OpenSSL.</dt>
 254 </dl></dd>
 255 <dt><a href="xmlsec-gnutls-ref.html">XML Security Library for GnuTLS API Reference.</a></dt>
 256 <dd><dl>
 257 <dt>
 258 <a href="xmlsec-gnutls-app.html">app</a> -- Application functions implementation for GnuTLS.</dt>
 259 <dt>
 260 <a href="xmlsec-gnutls-crypto.html">crypto</a> -- Crypto transforms implementation for GnuTLS.</dt>
 261 </dl></dd>
 262 <dt><a href="xmlsec-nss-ref.html">XML Security Library for NSS API Reference.</a></dt>
 263 <dd><dl>
 264 <dt>
 265 <a href="xmlsec-nss-app.html">app</a> -- Application functions implementation for NSS.</dt>
 266 <dt>
 267 <a href="xmlsec-nss-bignum.html">bignum</a> -- Big numbers helper functions.</dt>
 268 <dt>
 269 <a href="xmlsec-nss-crypto.html">crypto</a> -- Crypto transforms implementation for NSS.</dt>
 270 <dt>
 271 <a href="xmlsec-nss-keysstore.html">keysstore</a> -- Keys store implementation for NSS.</dt>
 272 <dt>
 273 <a href="xmlsec-nss-pkikeys.html">pkikeys</a> -- PKI keys data implementation.</dt>
 274 <dt>
 275 <a href="xmlsec-nss-x509.html">x509</a> -- X509 certificates support implementation for NSS.</dt>
 276 </dl></dd>
 277 <dt><a href="xmlsec-mscrypto-ref.html">XML Security Library for MSCrypto API Reference.</a></dt>
 278 <dd><dl>
 279 <dt>
 280 <a href="xmlsec-mscrypto-app.html">app</a> -- Application functions implementation for MS Crypto.</dt>
 281 <dt>
 282 <a href="xmlsec-mscrypto-certkeys.html">certkeys</a> -- MS Crypto certificates helper functions.</dt>
 283 <dt>
 284 <a href="xmlsec-mscrypto-crypto.html">crypto</a> -- Crypto transforms implementation for MS Crypto.</dt>
 285 <dt>
 286 <a href="xmlsec-mscrypto-keysstore.html">keysstore</a> -- Keys store implementation for MS Crypto.</dt>
 287 <dt>
 288 <a href="xmlsec-mscrypto-x509.html">x509</a> -- X509 certificates support implementation for MS Crypto.</dt>
 289 </dl></dd>
 290 <dt><a href="xmlsec-index.html">XML Security Library Reference Index</a></dt>
 291 </dl></dd>
 292 </dl></div>
 293 </div>
 294 <table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="2"><tr valign="middle">
 295 <td align="left"></td>
 296 <td align="right"><a accesskey="n" href="xmlsec-notes.html"><b>XML Security Library Tutorial &gt;&gt;&gt;</b></a></td>
 297 </tr></table>
 298 </td></tr></table></td>
 299 </tr></table></body>
 300 </html>