<html> <head> <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> <title>app</title> <meta name="GENERATOR" content="Modular DocBook HTML Stylesheet Version 1.7"> <link rel="HOME" title="XML Security Library Reference Manual" href="index.html"> <link rel="UP" title="XML Security Library for GnuTLS API Reference." href="xmlsec-gnutls-ref.html"> <link rel="PREVIOUS" title="XML Security Library for GnuTLS API Reference." href="xmlsec-gnutls-ref.html"> <link rel="NEXT" title="crypto" href="xmlsec-gnutls-crypto.html"> <meta name="GENERATOR" content="GTK-Doc V1.2 (SGML mode)"> <style type="text/css">.synopsis, .classsynopsis { background: #eeeeee; border: solid 1px #aaaaaa; padding: 0.5em; } .programlisting { background: #eeeeff; border: solid 1px #aaaaff; padding: 0.5em; } .variablelist { padding: 4px; margin-left: 3em; } .navigation { background: #ffeeee; border: solid 1px #ffaaaa; margin-top: 0.5em; margin-bottom: 0.5em; } .navigation a { color: #770000; } .navigation a:visited { color: #550000; } .navigation .title { font-size: 200%; }</style> </head> <body><table witdh="100%" valign="top"><tr valign="top"> <td valign="top" align="left" width="210"> <img src="../images/logo.gif" alt="XML Security Library" border="0"><p></p> <ul> <li><a href="../index.html">Home</a></li> <li><a href="../download.html">Download</a></li> <li><a href="../news.html">News</a></li> <li><a href="../documentation.html">Documentation</a></li> <ul> <li><a href="../faq.html">FAQ</a></li> <li><a href="../api/xmlsec-notes.html">Tutorial</a></li> <li><a href="../api/xmlsec-reference.html">API reference</a></li> <li><a href="../api/xmlsec-examples.html">Examples</a></li> </ul> <li><a href="../xmldsig.html">XML Digital Signature</a></li> <ul><li><a href="http://www.aleksey.com/xmlsec/xmldsig-verifier.html">Online Verifier</a></li></ul> <li><a href="../xmlenc.html">XML Encryption</a></li> <li><a href="../c14n.html">XML Canonicalization</a></li> <li><a href="../bugs.html">Reporting Bugs</a></li> <li><a href="http://www.aleksey.com/pipermail/xmlsec">Mailing list</a></li> <li><a href="../related.html">Related</a></li> <li><a href="../authors.html">Authors</a></li> </ul> <table width="100%"> <tr> <td width="15"></td> <td><a href="http://xmlsoft.org/"><img src="../images/libxml2-logo.png" alt="LibXML2" border="0"></a></td> </tr> <tr> <td width="15"></td> <td><a href="http://xmlsoft.org/XSLT"><img src="../images/libxslt-logo.png" alt="LibXSLT" border="0"></a></td> </tr> <tr> <td width="15"></td> <td><a href="http://www.openssl.org/"><img src="../images/openssl-logo.png" alt="OpenSSL" border="0"></a></td> </tr> <!--Links - start--><!--Links - end--> </table> </td> <td valign="top"><table width="100%" valign="top"><tr><td valign="top" align="left" id="xmlsecContent"> <table width="100%" class="navigation" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"> <td><a accesskey="p" href="xmlsec-gnutls-ref.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> <td><a accesskey="u" href="xmlsec-gnutls-ref.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> <th width="100%" align="center">XML Security Library Reference Manual</th> <td><a accesskey="n" href="xmlsec-gnutls-crypto.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> </tr></table> <h1> <a name="XMLSEC-GNUTLS-APP"></a>app</h1> <div class="REFNAMEDIV"> <a name="AEN25211"></a><h2>Name</h2>app--Application functions implementation for GnuTLS.</div> <div class="REFSYNOPSISDIV"> <a name="AEN25214"></a><h2>Synopsis</h2> <pre class="SYNOPSIS"> <font>int</font> <a href="xmlsec-gnutls-app.html#XMLSECGNUTLSAPPINIT">xmlSecGnuTLSAppInit</a> (const <font>char</font> *config); <font>int</font> <a href="xmlsec-gnutls-app.html#XMLSECGNUTLSAPPSHUTDOWN">xmlSecGnuTLSAppShutdown</a> (void); <font>int</font> <a href="xmlsec-gnutls-app.html#XMLSECGNUTLSAPPDEFAULTKEYSMNGRINIT">xmlSecGnuTLSAppDefaultKeysMngrInit</a> (<a href="xmlsec-keysmngr.html#XMLSECKEYSMNGR">xmlSecKeysMngrPtr</a> mngr); <font>int</font> <a href="xmlsec-gnutls-app.html#XMLSECGNUTLSAPPDEFAULTKEYSMNGRADOPTKEY">xmlSecGnuTLSAppDefaultKeysMngrAdoptKey</a> (<a href="xmlsec-keysmngr.html#XMLSECKEYSMNGR">xmlSecKeysMngrPtr</a> mngr, <a href="xmlsec-keys.html#XMLSECKEY">xmlSecKeyPtr</a> key); <font>int</font> <a href="xmlsec-gnutls-app.html#XMLSECGNUTLSAPPDEFAULTKEYSMNGRLOAD">xmlSecGnuTLSAppDefaultKeysMngrLoad</a> (<a href="xmlsec-keysmngr.html#XMLSECKEYSMNGR">xmlSecKeysMngrPtr</a> mngr, const <font>char</font> *uri); <font>int</font> <a href="xmlsec-gnutls-app.html#XMLSECGNUTLSAPPDEFAULTKEYSMNGRSAVE">xmlSecGnuTLSAppDefaultKeysMngrSave</a> (<a href="xmlsec-keysmngr.html#XMLSECKEYSMNGR">xmlSecKeysMngrPtr</a> mngr, const <font>char</font> *filename, <a href="xmlsec-keysdata.html#XMLSECKEYDATATYPE">xmlSecKeyDataType</a> type); <font>int</font> <a href="xmlsec-gnutls-app.html#XMLSECGNUTLSAPPKEYSMNGRCERTLOAD">xmlSecGnuTLSAppKeysMngrCertLoad</a> (<a href="xmlsec-keysmngr.html#XMLSECKEYSMNGR">xmlSecKeysMngrPtr</a> mngr, const <font>char</font> *filename, <a href="xmlsec-keysdata.html#XMLSECKEYDATAFORMAT">xmlSecKeyDataFormat</a> format, <a href="xmlsec-keysdata.html#XMLSECKEYDATATYPE">xmlSecKeyDataType</a> type); <font>int</font> <a href="xmlsec-gnutls-app.html#XMLSECGNUTLSAPPKEYSMNGRCERTLOADMEMORY">xmlSecGnuTLSAppKeysMngrCertLoadMemory</a> (<a href="xmlsec-keysmngr.html#XMLSECKEYSMNGR">xmlSecKeysMngrPtr</a> mngr, const <a href="xmlsec-xmlsec.html#XMLSECBYTE">xmlSecByte</a> *data, <a href="xmlsec-xmlsec.html#XMLSECSIZE">xmlSecSize</a> dataSize, <a href="xmlsec-keysdata.html#XMLSECKEYDATAFORMAT">xmlSecKeyDataFormat</a> format, <a href="xmlsec-keysdata.html#XMLSECKEYDATATYPE">xmlSecKeyDataType</a> type); <a href="xmlsec-keys.html#XMLSECKEY">xmlSecKeyPtr</a> <a href="xmlsec-gnutls-app.html#XMLSECGNUTLSAPPKEYLOAD">xmlSecGnuTLSAppKeyLoad</a> (const <font>char</font> *filename, <a href="xmlsec-keysdata.html#XMLSECKEYDATAFORMAT">xmlSecKeyDataFormat</a> format, const <font>char</font> *pwd, <font>void</font> *pwdCallback, <font>void</font> *pwdCallbackCtx); <a href="xmlsec-keys.html#XMLSECKEY">xmlSecKeyPtr</a> <a href="xmlsec-gnutls-app.html#XMLSECGNUTLSAPPKEYLOADMEMORY">xmlSecGnuTLSAppKeyLoadMemory</a> (const <a href="xmlsec-xmlsec.html#XMLSECBYTE">xmlSecByte</a> *data, <a href="xmlsec-xmlsec.html#XMLSECSIZE">xmlSecSize</a> dataSize, <a href="xmlsec-keysdata.html#XMLSECKEYDATAFORMAT">xmlSecKeyDataFormat</a> format, const <font>char</font> *pwd, <font>void</font> *pwdCallback, <font>void</font> *pwdCallbackCtx); <a href="xmlsec-keys.html#XMLSECKEY">xmlSecKeyPtr</a> <a href="xmlsec-gnutls-app.html#XMLSECGNUTLSAPPPKCS12LOAD">xmlSecGnuTLSAppPkcs12Load</a> (const <font>char</font> *filename, const <font>char</font> *pwd, <font>void</font> *pwdCallback, <font>void</font> *pwdCallbackCtx); <a href="xmlsec-keys.html#XMLSECKEY">xmlSecKeyPtr</a> <a href="xmlsec-gnutls-app.html#XMLSECGNUTLSAPPPKCS12LOADMEMORY">xmlSecGnuTLSAppPkcs12LoadMemory</a> (const <a href="xmlsec-xmlsec.html#XMLSECBYTE">xmlSecByte</a> *data, <a href="xmlsec-xmlsec.html#XMLSECSIZE">xmlSecSize</a> dataSize, const <font>char</font> *pwd, <font>void</font> *pwdCallback, <font>void</font> *pwdCallbackCtx); <font>int</font> <a href="xmlsec-gnutls-app.html#XMLSECGNUTLSAPPKEYCERTLOAD">xmlSecGnuTLSAppKeyCertLoad</a> (<a href="xmlsec-keys.html#XMLSECKEY">xmlSecKeyPtr</a> key, const <font>char</font> *filename, <a href="xmlsec-keysdata.html#XMLSECKEYDATAFORMAT">xmlSecKeyDataFormat</a> format); <font>int</font> <a href="xmlsec-gnutls-app.html#XMLSECGNUTLSAPPKEYCERTLOADMEMORY">xmlSecGnuTLSAppKeyCertLoadMemory</a> (<a href="xmlsec-keys.html#XMLSECKEY">xmlSecKeyPtr</a> key, const <a href="xmlsec-xmlsec.html#XMLSECBYTE">xmlSecByte</a> *data, <a href="xmlsec-xmlsec.html#XMLSECSIZE">xmlSecSize</a> dataSize, <a href="xmlsec-keysdata.html#XMLSECKEYDATAFORMAT">xmlSecKeyDataFormat</a> format); <font>void</font>* <a href="xmlsec-gnutls-app.html#XMLSECGNUTLSAPPGETDEFAULTPWDCALLBACK">xmlSecGnuTLSAppGetDefaultPwdCallback</a> (void);</pre> </div> <div class="REFSECT1"> <a name="AEN25292"></a><h2>Description</h2> <p>Application functions implementation for GnuTLS.</p> </div> <div class="REFSECT1"> <a name="AEN25295"></a><h2>Details</h2> <div class="REFSECT2"> <a name="AEN25297"></a><h3> <a name="XMLSECGNUTLSAPPINIT"></a>xmlSecGnuTLSAppInit ()</h3> <pre class="PROGRAMLISTING"><font>int</font> xmlSecGnuTLSAppInit (const <font>char</font> *config);</pre> <p>General crypto engine initialization. This function is used by XMLSec command line utility and called before <var class="PARAMETER">xmlSecInit</var> function.</p> <p></p> <p></p> <table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody> <tr> <td align="LEFT" valign="TOP"><a name="AEN25309"><span style="white-space: nowrap"><var class="PARAMETER">config</var>:</span></a></td> <td align="LEFT" valign="TOP"><p> the path to GnuTLS configuration (unused).</p></td> </tr> <tr> <td align="LEFT" valign="TOP"><a name="AEN25314"><span style="white-space: nowrap"><span class="emphasis"><i class="EMPHASIS">Returns</i></span> :</span></a></td> <td align="LEFT" valign="TOP"><p>0 on success or a negative value otherwise.</p></td> </tr> </tbody></table> </div> <hr> <div class="REFSECT2"> <a name="AEN25319"></a><h3> <a name="XMLSECGNUTLSAPPSHUTDOWN"></a>xmlSecGnuTLSAppShutdown ()</h3> <pre class="PROGRAMLISTING"><font>int</font> xmlSecGnuTLSAppShutdown (void);</pre> <p>General crypto engine shutdown. This function is used by XMLSec command line utility and called after <var class="PARAMETER">xmlSecShutdown</var> function.</p> <p></p> <p></p> <table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody><tr> <td align="LEFT" valign="TOP"><a name="AEN25330"><span style="white-space: nowrap"><span class="emphasis"><i class="EMPHASIS">Returns</i></span> :</span></a></td> <td align="LEFT" valign="TOP"><p>0 on success or a negative value otherwise.</p></td> </tr></tbody></table> </div> <hr> <div class="REFSECT2"> <a name="AEN25335"></a><h3> <a name="XMLSECGNUTLSAPPDEFAULTKEYSMNGRINIT"></a>xmlSecGnuTLSAppDefaultKeysMngrInit ()</h3> <pre class="PROGRAMLISTING"><font>int</font> xmlSecGnuTLSAppDefaultKeysMngrInit (<a href="xmlsec-keysmngr.html#XMLSECKEYSMNGR">xmlSecKeysMngrPtr</a> mngr);</pre> <p>Initializes <var class="PARAMETER">mngr</var> with simple keys store <a href="xmlsec-keysmngr.html#XMLSECSIMPLEKEYSSTOREID"><span class="TYPE">xmlSecSimpleKeysStoreId</span></a> and a default GnuTLS crypto key data stores.</p> <p></p> <p></p> <table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody> <tr> <td align="LEFT" valign="TOP"><a name="AEN25349"><span style="white-space: nowrap"><var class="PARAMETER">mngr</var>:</span></a></td> <td align="LEFT" valign="TOP"><p> the pointer to keys manager.</p></td> </tr> <tr> <td align="LEFT" valign="TOP"><a name="AEN25354"><span style="white-space: nowrap"><span class="emphasis"><i class="EMPHASIS">Returns</i></span> :</span></a></td> <td align="LEFT" valign="TOP"><p>0 on success or a negative value otherwise.</p></td> </tr> </tbody></table> </div> <hr> <div class="REFSECT2"> <a name="AEN25359"></a><h3> <a name="XMLSECGNUTLSAPPDEFAULTKEYSMNGRADOPTKEY"></a>xmlSecGnuTLSAppDefaultKeysMngrAdoptKey ()</h3> <pre class="PROGRAMLISTING"><font>int</font> xmlSecGnuTLSAppDefaultKeysMngrAdoptKey (<a href="xmlsec-keysmngr.html#XMLSECKEYSMNGR">xmlSecKeysMngrPtr</a> mngr, <a href="xmlsec-keys.html#XMLSECKEY">xmlSecKeyPtr</a> key);</pre> <p>Adds <var class="PARAMETER">key</var> to the keys manager <var class="PARAMETER">mngr</var> created with <a href="xmlsec-gnutls-app.html#XMLSECGNUTLSAPPDEFAULTKEYSMNGRINIT"><span class="TYPE">xmlSecGnuTLSAppDefaultKeysMngrInit</span></a> function.</p> <p></p> <p></p> <table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody> <tr> <td align="LEFT" valign="TOP"><a name="AEN25375"><span style="white-space: nowrap"><var class="PARAMETER">mngr</var>:</span></a></td> <td align="LEFT" valign="TOP"><p> the pointer to keys manager.</p></td> </tr> <tr> <td align="LEFT" valign="TOP"><a name="AEN25380"><span style="white-space: nowrap"><var class="PARAMETER">key</var>:</span></a></td> <td align="LEFT" valign="TOP"><p> the pointer to key.</p></td> </tr> <tr> <td align="LEFT" valign="TOP"><a name="AEN25385"><span style="white-space: nowrap"><span class="emphasis"><i class="EMPHASIS">Returns</i></span> :</span></a></td> <td align="LEFT" valign="TOP"><p>0 on success or a negative value otherwise.</p></td> </tr> </tbody></table> </div> <hr> <div class="REFSECT2"> <a name="AEN25390"></a><h3> <a name="XMLSECGNUTLSAPPDEFAULTKEYSMNGRLOAD"></a>xmlSecGnuTLSAppDefaultKeysMngrLoad ()</h3> <pre class="PROGRAMLISTING"><font>int</font> xmlSecGnuTLSAppDefaultKeysMngrLoad (<a href="xmlsec-keysmngr.html#XMLSECKEYSMNGR">xmlSecKeysMngrPtr</a> mngr, const <font>char</font> *uri);</pre> <p>Loads XML keys file from <var class="PARAMETER">uri</var> to the keys manager <var class="PARAMETER">mngr</var> created with <a href="xmlsec-gnutls-app.html#XMLSECGNUTLSAPPDEFAULTKEYSMNGRINIT"><span class="TYPE">xmlSecGnuTLSAppDefaultKeysMngrInit</span></a> function.</p> <p></p> <p></p> <table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody> <tr> <td align="LEFT" valign="TOP"><a name="AEN25406"><span style="white-space: nowrap"><var class="PARAMETER">mngr</var>:</span></a></td> <td align="LEFT" valign="TOP"><p> the pointer to keys manager.</p></td> </tr> <tr> <td align="LEFT" valign="TOP"><a name="AEN25411"><span style="white-space: nowrap"><var class="PARAMETER">uri</var>:</span></a></td> <td align="LEFT" valign="TOP"><p> the uri.</p></td> </tr> <tr> <td align="LEFT" valign="TOP"><a name="AEN25416"><span style="white-space: nowrap"><span class="emphasis"><i class="EMPHASIS">Returns</i></span> :</span></a></td> <td align="LEFT" valign="TOP"><p>0 on success or a negative value otherwise.</p></td> </tr> </tbody></table> </div> <hr> <div class="REFSECT2"> <a name="AEN25421"></a><h3> <a name="XMLSECGNUTLSAPPDEFAULTKEYSMNGRSAVE"></a>xmlSecGnuTLSAppDefaultKeysMngrSave ()</h3> <pre class="PROGRAMLISTING"><font>int</font> xmlSecGnuTLSAppDefaultKeysMngrSave (<a href="xmlsec-keysmngr.html#XMLSECKEYSMNGR">xmlSecKeysMngrPtr</a> mngr, const <font>char</font> *filename, <a href="xmlsec-keysdata.html#XMLSECKEYDATATYPE">xmlSecKeyDataType</a> type);</pre> <p>Saves keys from <var class="PARAMETER">mngr</var> to XML keys file.</p> <p></p> <p></p> <table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody> <tr> <td align="LEFT" valign="TOP"><a name="AEN25435"><span style="white-space: nowrap"><var class="PARAMETER">mngr</var>:</span></a></td> <td align="LEFT" valign="TOP"><p> the pointer to keys manager.</p></td> </tr> <tr> <td align="LEFT" valign="TOP"><a name="AEN25440"><span style="white-space: nowrap"><var class="PARAMETER">filename</var>:</span></a></td> <td align="LEFT" valign="TOP"><p> the destination filename.</p></td> </tr> <tr> <td align="LEFT" valign="TOP"><a name="AEN25445"><span style="white-space: nowrap"><var class="PARAMETER">type</var>:</span></a></td> <td align="LEFT" valign="TOP"><p> the type of keys to save (public/private/symmetric).</p></td> </tr> <tr> <td align="LEFT" valign="TOP"><a name="AEN25450"><span style="white-space: nowrap"><span class="emphasis"><i class="EMPHASIS">Returns</i></span> :</span></a></td> <td align="LEFT" valign="TOP"><p>0 on success or a negative value otherwise.</p></td> </tr> </tbody></table> </div> <hr> <div class="REFSECT2"> <a name="AEN25455"></a><h3> <a name="XMLSECGNUTLSAPPKEYSMNGRCERTLOAD"></a>xmlSecGnuTLSAppKeysMngrCertLoad ()</h3> <pre class="PROGRAMLISTING"><font>int</font> xmlSecGnuTLSAppKeysMngrCertLoad (<a href="xmlsec-keysmngr.html#XMLSECKEYSMNGR">xmlSecKeysMngrPtr</a> mngr, const <font>char</font> *filename, <a href="xmlsec-keysdata.html#XMLSECKEYDATAFORMAT">xmlSecKeyDataFormat</a> format, <a href="xmlsec-keysdata.html#XMLSECKEYDATATYPE">xmlSecKeyDataType</a> type);</pre> <p>Reads cert from <var class="PARAMETER">filename</var> and adds to the list of trusted or known untrusted certs in <var class="PARAMETER">store</var> (not implemented yet).</p> <p></p> <p></p> <table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody> <tr> <td align="LEFT" valign="TOP"><a name="AEN25471"><span style="white-space: nowrap"><var class="PARAMETER">mngr</var>:</span></a></td> <td align="LEFT" valign="TOP"><p> the keys manager.</p></td> </tr> <tr> <td align="LEFT" valign="TOP"><a name="AEN25476"><span style="white-space: nowrap"><var class="PARAMETER">filename</var>:</span></a></td> <td align="LEFT" valign="TOP"><p> the certificate file.</p></td> </tr> <tr> <td align="LEFT" valign="TOP"><a name="AEN25481"><span style="white-space: nowrap"><var class="PARAMETER">format</var>:</span></a></td> <td align="LEFT" valign="TOP"><p> the certificate file format.</p></td> </tr> <tr> <td align="LEFT" valign="TOP"><a name="AEN25486"><span style="white-space: nowrap"><var class="PARAMETER">type</var>:</span></a></td> <td align="LEFT" valign="TOP"><p> the flag that indicates is the certificate in <var class="PARAMETER">filename</var> trusted or not.</p></td> </tr> <tr> <td align="LEFT" valign="TOP"><a name="AEN25492"><span style="white-space: nowrap"><span class="emphasis"><i class="EMPHASIS">Returns</i></span> :</span></a></td> <td align="LEFT" valign="TOP"><p>0 on success or a negative value otherwise.</p></td> </tr> </tbody></table> </div> <hr> <div class="REFSECT2"> <a name="AEN25497"></a><h3> <a name="XMLSECGNUTLSAPPKEYSMNGRCERTLOADMEMORY"></a>xmlSecGnuTLSAppKeysMngrCertLoadMemory ()</h3> <pre class="PROGRAMLISTING"><font>int</font> xmlSecGnuTLSAppKeysMngrCertLoadMemory (<a href="xmlsec-keysmngr.html#XMLSECKEYSMNGR">xmlSecKeysMngrPtr</a> mngr, const <a href="xmlsec-xmlsec.html#XMLSECBYTE">xmlSecByte</a> *data, <a href="xmlsec-xmlsec.html#XMLSECSIZE">xmlSecSize</a> dataSize, <a href="xmlsec-keysdata.html#XMLSECKEYDATAFORMAT">xmlSecKeyDataFormat</a> format, <a href="xmlsec-keysdata.html#XMLSECKEYDATATYPE">xmlSecKeyDataType</a> type);</pre> <p>Reads cert from binary buffer <var class="PARAMETER">data</var> and adds to the list of trusted or known untrusted certs in <var class="PARAMETER">store</var> (not implemented yet).</p> <p></p> <p></p> <table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody> <tr> <td align="LEFT" valign="TOP"><a name="AEN25514"><span style="white-space: nowrap"><var class="PARAMETER">mngr</var>:</span></a></td> <td align="LEFT" valign="TOP"><p> the keys manager.</p></td> </tr> <tr> <td align="LEFT" valign="TOP"><a name="AEN25519"><span style="white-space: nowrap"><var class="PARAMETER">data</var>:</span></a></td> <td align="LEFT" valign="TOP"><p> the certificate binary data.</p></td> </tr> <tr> <td align="LEFT" valign="TOP"><a name="AEN25524"><span style="white-space: nowrap"><var class="PARAMETER">dataSize</var>:</span></a></td> <td align="LEFT" valign="TOP"><p> the certificate binary data size.</p></td> </tr> <tr> <td align="LEFT" valign="TOP"><a name="AEN25529"><span style="white-space: nowrap"><var class="PARAMETER">format</var>:</span></a></td> <td align="LEFT" valign="TOP"><p> the certificate file format.</p></td> </tr> <tr> <td align="LEFT" valign="TOP"><a name="AEN25534"><span style="white-space: nowrap"><var class="PARAMETER">type</var>:</span></a></td> <td align="LEFT" valign="TOP"><p> the flag that indicates is the certificate trusted or not.</p></td> </tr> <tr> <td align="LEFT" valign="TOP"><a name="AEN25539"><span style="white-space: nowrap"><span class="emphasis"><i class="EMPHASIS">Returns</i></span> :</span></a></td> <td align="LEFT" valign="TOP"><p>0 on success or a negative value otherwise.</p></td> </tr> </tbody></table> </div> <hr> <div class="REFSECT2"> <a name="AEN25544"></a><h3> <a name="XMLSECGNUTLSAPPKEYLOAD"></a>xmlSecGnuTLSAppKeyLoad ()</h3> <pre class="PROGRAMLISTING"><a href="xmlsec-keys.html#XMLSECKEY">xmlSecKeyPtr</a> xmlSecGnuTLSAppKeyLoad (const <font>char</font> *filename, <a href="xmlsec-keysdata.html#XMLSECKEYDATAFORMAT">xmlSecKeyDataFormat</a> format, const <font>char</font> *pwd, <font>void</font> *pwdCallback, <font>void</font> *pwdCallbackCtx);</pre> <p>Reads key from the a file (not implemented yet).</p> <p></p> <p></p> <table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody> <tr> <td align="LEFT" valign="TOP"><a name="AEN25559"><span style="white-space: nowrap"><var class="PARAMETER">filename</var>:</span></a></td> <td align="LEFT" valign="TOP"><p> the key filename.</p></td> </tr> <tr> <td align="LEFT" valign="TOP"><a name="AEN25564"><span style="white-space: nowrap"><var class="PARAMETER">format</var>:</span></a></td> <td align="LEFT" valign="TOP"><p> the key file format.</p></td> </tr> <tr> <td align="LEFT" valign="TOP"><a name="AEN25569"><span style="white-space: nowrap"><var class="PARAMETER">pwd</var>:</span></a></td> <td align="LEFT" valign="TOP"><p> the key file password.</p></td> </tr> <tr> <td align="LEFT" valign="TOP"><a name="AEN25574"><span style="white-space: nowrap"><var class="PARAMETER">pwdCallback</var>:</span></a></td> <td align="LEFT" valign="TOP"><p> the key password callback.</p></td> </tr> <tr> <td align="LEFT" valign="TOP"><a name="AEN25579"><span style="white-space: nowrap"><var class="PARAMETER">pwdCallbackCtx</var>:</span></a></td> <td align="LEFT" valign="TOP"><p> the user context for password callback.</p></td> </tr> <tr> <td align="LEFT" valign="TOP"><a name="AEN25584"><span style="white-space: nowrap"><span class="emphasis"><i class="EMPHASIS">Returns</i></span> :</span></a></td> <td align="LEFT" valign="TOP"><p>pointer to the key or NULL if an error occurs.</p></td> </tr> </tbody></table> </div> <hr> <div class="REFSECT2"> <a name="AEN25589"></a><h3> <a name="XMLSECGNUTLSAPPKEYLOADMEMORY"></a>xmlSecGnuTLSAppKeyLoadMemory ()</h3> <pre class="PROGRAMLISTING"><a href="xmlsec-keys.html#XMLSECKEY">xmlSecKeyPtr</a> xmlSecGnuTLSAppKeyLoadMemory (const <a href="xmlsec-xmlsec.html#XMLSECBYTE">xmlSecByte</a> *data, <a href="xmlsec-xmlsec.html#XMLSECSIZE">xmlSecSize</a> dataSize, <a href="xmlsec-keysdata.html#XMLSECKEYDATAFORMAT">xmlSecKeyDataFormat</a> format, const <font>char</font> *pwd, <font>void</font> *pwdCallback, <font>void</font> *pwdCallbackCtx);</pre> <p>Reads key from the memory buffer (not implemented yet).</p> <p></p> <p></p> <table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody> <tr> <td align="LEFT" valign="TOP"><a name="AEN25605"><span style="white-space: nowrap"><var class="PARAMETER">data</var>:</span></a></td> <td align="LEFT" valign="TOP"><p> the binary key data.</p></td> </tr> <tr> <td align="LEFT" valign="TOP"><a name="AEN25610"><span style="white-space: nowrap"><var class="PARAMETER">dataSize</var>:</span></a></td> <td align="LEFT" valign="TOP"><p> the size of binary key.</p></td> </tr> <tr> <td align="LEFT" valign="TOP"><a name="AEN25615"><span style="white-space: nowrap"><var class="PARAMETER">format</var>:</span></a></td> <td align="LEFT" valign="TOP"><p> the key file format.</p></td> </tr> <tr> <td align="LEFT" valign="TOP"><a name="AEN25620"><span style="white-space: nowrap"><var class="PARAMETER">pwd</var>:</span></a></td> <td align="LEFT" valign="TOP"><p> the key file password.</p></td> </tr> <tr> <td align="LEFT" valign="TOP"><a name="AEN25625"><span style="white-space: nowrap"><var class="PARAMETER">pwdCallback</var>:</span></a></td> <td align="LEFT" valign="TOP"><p> the key password callback.</p></td> </tr> <tr> <td align="LEFT" valign="TOP"><a name="AEN25630"><span style="white-space: nowrap"><var class="PARAMETER">pwdCallbackCtx</var>:</span></a></td> <td align="LEFT" valign="TOP"><p> the user context for password callback.</p></td> </tr> <tr> <td align="LEFT" valign="TOP"><a name="AEN25635"><span style="white-space: nowrap"><span class="emphasis"><i class="EMPHASIS">Returns</i></span> :</span></a></td> <td align="LEFT" valign="TOP"><p>pointer to the key or NULL if an error occurs.</p></td> </tr> </tbody></table> </div> <hr> <div class="REFSECT2"> <a name="AEN25640"></a><h3> <a name="XMLSECGNUTLSAPPPKCS12LOAD"></a>xmlSecGnuTLSAppPkcs12Load ()</h3> <pre class="PROGRAMLISTING"><a href="xmlsec-keys.html#XMLSECKEY">xmlSecKeyPtr</a> xmlSecGnuTLSAppPkcs12Load (const <font>char</font> *filename, const <font>char</font> *pwd, <font>void</font> *pwdCallback, <font>void</font> *pwdCallbackCtx);</pre> <p>Reads key and all associated certificates from the PKCS12 file (not implemented yet). For uniformity, call xmlSecGnuTLSAppKeyLoad instead of this function. Pass in format=xmlSecKeyDataFormatPkcs12.</p> <p></p> <p></p> <table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody> <tr> <td align="LEFT" valign="TOP"><a name="AEN25654"><span style="white-space: nowrap"><var class="PARAMETER">filename</var>:</span></a></td> <td align="LEFT" valign="TOP"><p> the PKCS12 key filename.</p></td> </tr> <tr> <td align="LEFT" valign="TOP"><a name="AEN25659"><span style="white-space: nowrap"><var class="PARAMETER">pwd</var>:</span></a></td> <td align="LEFT" valign="TOP"><p> the PKCS12 file password.</p></td> </tr> <tr> <td align="LEFT" valign="TOP"><a name="AEN25664"><span style="white-space: nowrap"><var class="PARAMETER">pwdCallback</var>:</span></a></td> <td align="LEFT" valign="TOP"><p> the password callback.</p></td> </tr> <tr> <td align="LEFT" valign="TOP"><a name="AEN25669"><span style="white-space: nowrap"><var class="PARAMETER">pwdCallbackCtx</var>:</span></a></td> <td align="LEFT" valign="TOP"><p> the user context for password callback.</p></td> </tr> <tr> <td align="LEFT" valign="TOP"><a name="AEN25674"><span style="white-space: nowrap"><span class="emphasis"><i class="EMPHASIS">Returns</i></span> :</span></a></td> <td align="LEFT" valign="TOP"><p>pointer to the key or NULL if an error occurs.</p></td> </tr> </tbody></table> </div> <hr> <div class="REFSECT2"> <a name="AEN25679"></a><h3> <a name="XMLSECGNUTLSAPPPKCS12LOADMEMORY"></a>xmlSecGnuTLSAppPkcs12LoadMemory ()</h3> <pre class="PROGRAMLISTING"><a href="xmlsec-keys.html#XMLSECKEY">xmlSecKeyPtr</a> xmlSecGnuTLSAppPkcs12LoadMemory (const <a href="xmlsec-xmlsec.html#XMLSECBYTE">xmlSecByte</a> *data, <a href="xmlsec-xmlsec.html#XMLSECSIZE">xmlSecSize</a> dataSize, const <font>char</font> *pwd, <font>void</font> *pwdCallback, <font>void</font> *pwdCallbackCtx);</pre> <p>Reads key and all associated certificates from the PKCS12 data in memory buffer. For uniformity, call xmlSecGnuTLSAppKeyLoadMemory instead of this function. Pass in format=xmlSecKeyDataFormatPkcs12 (not implemented yet).</p> <p></p> <p></p> <table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody> <tr> <td align="LEFT" valign="TOP"><a name="AEN25694"><span style="white-space: nowrap"><var class="PARAMETER">data</var>:</span></a></td> <td align="LEFT" valign="TOP"><p> the PKCS12 binary data.</p></td> </tr> <tr> <td align="LEFT" valign="TOP"><a name="AEN25699"><span style="white-space: nowrap"><var class="PARAMETER">dataSize</var>:</span></a></td> <td align="LEFT" valign="TOP"><p> the PKCS12 binary data size.</p></td> </tr> <tr> <td align="LEFT" valign="TOP"><a name="AEN25704"><span style="white-space: nowrap"><var class="PARAMETER">pwd</var>:</span></a></td> <td align="LEFT" valign="TOP"><p> the PKCS12 file password.</p></td> </tr> <tr> <td align="LEFT" valign="TOP"><a name="AEN25709"><span style="white-space: nowrap"><var class="PARAMETER">pwdCallback</var>:</span></a></td> <td align="LEFT" valign="TOP"><p> the password callback.</p></td> </tr> <tr> <td align="LEFT" valign="TOP"><a name="AEN25714"><span style="white-space: nowrap"><var class="PARAMETER">pwdCallbackCtx</var>:</span></a></td> <td align="LEFT" valign="TOP"><p> the user context for password callback.</p></td> </tr> <tr> <td align="LEFT" valign="TOP"><a name="AEN25719"><span style="white-space: nowrap"><span class="emphasis"><i class="EMPHASIS">Returns</i></span> :</span></a></td> <td align="LEFT" valign="TOP"><p>pointer to the key or NULL if an error occurs.</p></td> </tr> </tbody></table> </div> <hr> <div class="REFSECT2"> <a name="AEN25724"></a><h3> <a name="XMLSECGNUTLSAPPKEYCERTLOAD"></a>xmlSecGnuTLSAppKeyCertLoad ()</h3> <pre class="PROGRAMLISTING"><font>int</font> xmlSecGnuTLSAppKeyCertLoad (<a href="xmlsec-keys.html#XMLSECKEY">xmlSecKeyPtr</a> key, const <font>char</font> *filename, <a href="xmlsec-keysdata.html#XMLSECKEYDATAFORMAT">xmlSecKeyDataFormat</a> format);</pre> <p>Reads the certificate from $<var class="PARAMETER">filename</var> and adds it to key (not implemented yet).</p> <p></p> <p></p> <table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody> <tr> <td align="LEFT" valign="TOP"><a name="AEN25738"><span style="white-space: nowrap"><var class="PARAMETER">key</var>:</span></a></td> <td align="LEFT" valign="TOP"><p> the pointer to key.</p></td> </tr> <tr> <td align="LEFT" valign="TOP"><a name="AEN25743"><span style="white-space: nowrap"><var class="PARAMETER">filename</var>:</span></a></td> <td align="LEFT" valign="TOP"><p> the certificate filename.</p></td> </tr> <tr> <td align="LEFT" valign="TOP"><a name="AEN25748"><span style="white-space: nowrap"><var class="PARAMETER">format</var>:</span></a></td> <td align="LEFT" valign="TOP"><p> the certificate file format.</p></td> </tr> <tr> <td align="LEFT" valign="TOP"><a name="AEN25753"><span style="white-space: nowrap"><span class="emphasis"><i class="EMPHASIS">Returns</i></span> :</span></a></td> <td align="LEFT" valign="TOP"><p>0 on success or a negative value otherwise.</p></td> </tr> </tbody></table> </div> <hr> <div class="REFSECT2"> <a name="AEN25758"></a><h3> <a name="XMLSECGNUTLSAPPKEYCERTLOADMEMORY"></a>xmlSecGnuTLSAppKeyCertLoadMemory ()</h3> <pre class="PROGRAMLISTING"><font>int</font> xmlSecGnuTLSAppKeyCertLoadMemory (<a href="xmlsec-keys.html#XMLSECKEY">xmlSecKeyPtr</a> key, const <a href="xmlsec-xmlsec.html#XMLSECBYTE">xmlSecByte</a> *data, <a href="xmlsec-xmlsec.html#XMLSECSIZE">xmlSecSize</a> dataSize, <a href="xmlsec-keysdata.html#XMLSECKEYDATAFORMAT">xmlSecKeyDataFormat</a> format);</pre> <p>Reads the certificate from memory buffer and adds it to key (not implemented yet).</p> <p></p> <p></p> <table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody> <tr> <td align="LEFT" valign="TOP"><a name="AEN25772"><span style="white-space: nowrap"><var class="PARAMETER">key</var>:</span></a></td> <td align="LEFT" valign="TOP"><p> the pointer to key.</p></td> </tr> <tr> <td align="LEFT" valign="TOP"><a name="AEN25777"><span style="white-space: nowrap"><var class="PARAMETER">data</var>:</span></a></td> <td align="LEFT" valign="TOP"><p> the certificate binary data.</p></td> </tr> <tr> <td align="LEFT" valign="TOP"><a name="AEN25782"><span style="white-space: nowrap"><var class="PARAMETER">dataSize</var>:</span></a></td> <td align="LEFT" valign="TOP"><p> the certificate binary data size.</p></td> </tr> <tr> <td align="LEFT" valign="TOP"><a name="AEN25787"><span style="white-space: nowrap"><var class="PARAMETER">format</var>:</span></a></td> <td align="LEFT" valign="TOP"><p> the certificate file format.</p></td> </tr> <tr> <td align="LEFT" valign="TOP"><a name="AEN25792"><span style="white-space: nowrap"><span class="emphasis"><i class="EMPHASIS">Returns</i></span> :</span></a></td> <td align="LEFT" valign="TOP"><p>0 on success or a negative value otherwise.</p></td> </tr> </tbody></table> </div> <hr> <div class="REFSECT2"> <a name="AEN25797"></a><h3> <a name="XMLSECGNUTLSAPPGETDEFAULTPWDCALLBACK"></a>xmlSecGnuTLSAppGetDefaultPwdCallback ()</h3> <pre class="PROGRAMLISTING"><font>void</font>* xmlSecGnuTLSAppGetDefaultPwdCallback (void);</pre> <p>Gets default password callback.</p> <p></p> </div> </div> <table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="2"><tr valign="middle"> <td align="left"><a accesskey="p" href="xmlsec-gnutls-ref.html"><b><<<XML Security Library for GnuTLS API Reference.</b></a></td> <td align="right"><a accesskey="n" href="xmlsec-gnutls-crypto.html"><b>crypto>>></b></a></td> </tr></table> </td></tr></table></td> </tr></table></body> </html>