docs/api/xmlsec-gnutls-app.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
   4 <title>app</title>
   5 <meta name="GENERATOR" content="Modular DocBook HTML Stylesheet Version 1.79">
   6 <link rel="HOME" title="XML Security Library Reference Manual" href="index.html">
   7 <link rel="UP" title="XML Security Library for GnuTLS API Reference." href="xmlsec-gnutls-ref.html">
   8 <link rel="PREVIOUS" title="XML Security Library for GnuTLS API Reference." href="xmlsec-gnutls-ref.html">
   9 <link rel="NEXT" title="crypto" href="xmlsec-gnutls-crypto.html">
  10 <style type="text/css">.synopsis, .classsynopsis {
  11     background: #eeeeee;
  12     border: solid 1px #aaaaaa;
  13     padding: 0.5em;
  14 }
  15 .programlisting {
  16     background: #eeeeff;
  17     border: solid 1px #aaaaff;
  18     padding: 0.5em;
  19 }
  20 .variablelist {
  21     padding: 4px;
  22     margin-left: 3em;
  23 }
  24 .navigation {
  25     background: #ffeeee;
  26     border: solid 1px #ffaaaa;
  27     margin-top: 0.5em;
  28     margin-bottom: 0.5em;
  29 }
  30 .navigation a {
  31     color: #770000;
  32 }
  33 .navigation a:visited {
  34     color: #550000;
  35 }
  36 .navigation .title {
  37     font-size: 200%;
  38 }</style>
  39 </head>
  40 <body><table witdh="100%" valign="top"><tr valign="top">
  41 <td valign="top" align="left" width="210">
  42 <img src="../images/logo.gif" alt="XML Security Library" border="0"><p></p>
  43 <ul>
  44 <li><a href="../index.html">Home</a></li>
  45 <li><a href="../download.html">Download</a></li>
  46 <li><a href="../news.html">News</a></li>
  47 <li><a href="../documentation.html">Documentation</a></li>
  48 <ul>
  49 <li><a href="../faq.html">FAQ</a></li>
  50 <li><a href="../api/xmlsec-notes.html">Tutorial</a></li>
  51 <li><a href="../api/xmlsec-reference.html">API reference</a></li>
  52 <li><a href="../api/xmlsec-examples.html">Examples</a></li>
  53 </ul>
  54 <li><a href="../xmldsig.html">XML Digital Signature</a></li>
  55 <ul><li><a href="http://www.aleksey.com/xmlsec/xmldsig-verifier.html">Online Verifier</a></li></ul>
  56 <li><a href="../xmlenc.html">XML Encryption</a></li>
  57 <li><a href="../c14n.html">XML Canonicalization</a></li>
  58 <li><a href="../bugs.html">Reporting Bugs</a></li>
  59 <li><a href="http://www.aleksey.com/pipermail/xmlsec">Mailing list</a></li>
  60 <li><a href="../related.html">Related</a></li>
  61 <li><a href="../authors.html">Authors</a></li>
  62 </ul>
  63 <table width="100%">
  64 <tr>
  65 <td width="15"></td>
  66 <td><a href="http://xmlsoft.org/"><img src="../images/libxml2-logo.png" alt="LibXML2" border="0"></a></td>
  67 </tr>
  68 <tr>
  69 <td width="15"></td>
  70 <td><a href="http://xmlsoft.org/XSLT"><img src="../images/libxslt-logo.png" alt="LibXSLT" border="0"></a></td>
  71 </tr>
  72 <tr>
  73 <td width="15"></td>
  74 <td><a href="http://www.openssl.org/"><img src="../images/openssl-logo.png" alt="OpenSSL" border="0"></a></td>
  75 </tr>
  76 <!--Links - start--><!--Links - end-->
  77 </table>
  78 </td>
  79 <td valign="top"><table width="100%" valign="top"><tr><td valign="top" align="left" id="xmlsecContent">
  80 <table width="100%" class="navigation" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle">
  81 <td><a accesskey="p" href="xmlsec-gnutls-ref.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  82 <td><a accesskey="u" href="xmlsec-gnutls-ref.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
  83 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
  84 <th width="100%" align="center">XML Security Library Reference Manual</th>
  85 <td><a accesskey="n" href="xmlsec-gnutls-crypto.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
  86 </tr></table>
  87 <h1>
  88 <a name="XMLSEC-GNUTLS-APP"></a>app</h1>
  89 <div class="REFNAMEDIV">
  90 <a name="AEN24300"></a><h2>Name</h2>app -- Application functions implementation for GnuTLS.</div>
  91 <div class="REFSYNOPSISDIV">
  92 <a name="XMLSEC-GNUTLS-APP.SYNOPSIS"></a><h2>Synopsis</h2>
  93 <pre class="SYNOPSIS"><font>int</font>                 <a href="xmlsec-gnutls-app.html#XMLSECGNUTLSAPPINIT">xmlSecGnuTLSAppInit</a>                 (const <font>char</font> *config);
  94 <font>int</font>                 <a href="xmlsec-gnutls-app.html#XMLSECGNUTLSAPPSHUTDOWN">xmlSecGnuTLSAppShutdown</a>             (void);
  95 <font>int</font>                 <a href="xmlsec-gnutls-app.html#XMLSECGNUTLSAPPDEFAULTKEYSMNGRINIT">xmlSecGnuTLSAppDefaultKeysMngrInit</a>  (<a href="xmlsec-keysmngr.html#XMLSECKEYSMNGR">xmlSecKeysMngrPtr</a> mngr);
  96 <font>int</font>                 <a href="xmlsec-gnutls-app.html#XMLSECGNUTLSAPPDEFAULTKEYSMNGRADOPTKEY">xmlSecGnuTLSAppDefaultKeysMngrAdoptKey</a>
  97                                                         (<a href="xmlsec-keysmngr.html#XMLSECKEYSMNGR">xmlSecKeysMngrPtr</a> mngr,
  98                                                          <a href="xmlsec-keys.html#XMLSECKEY">xmlSecKeyPtr</a> key);
  99 <font>int</font>                 <a href="xmlsec-gnutls-app.html#XMLSECGNUTLSAPPDEFAULTKEYSMNGRLOAD">xmlSecGnuTLSAppDefaultKeysMngrLoad</a>  (<a href="xmlsec-keysmngr.html#XMLSECKEYSMNGR">xmlSecKeysMngrPtr</a> mngr,
 100                                                          const <font>char</font> *uri);
 101 <font>int</font>                 <a href="xmlsec-gnutls-app.html#XMLSECGNUTLSAPPDEFAULTKEYSMNGRSAVE">xmlSecGnuTLSAppDefaultKeysMngrSave</a>  (<a href="xmlsec-keysmngr.html#XMLSECKEYSMNGR">xmlSecKeysMngrPtr</a> mngr,
 102                                                          const <font>char</font> *filename,
 103                                                          <a href="xmlsec-keysdata.html#XMLSECKEYDATATYPE">xmlSecKeyDataType</a> type);
 104 <font>int</font>                 <a href="xmlsec-gnutls-app.html#XMLSECGNUTLSAPPKEYSMNGRCERTLOAD">xmlSecGnuTLSAppKeysMngrCertLoad</a>     (<a href="xmlsec-keysmngr.html#XMLSECKEYSMNGR">xmlSecKeysMngrPtr</a> mngr,
 105                                                          const <font>char</font> *filename,
 106                                                          <a href="xmlsec-keysdata.html#XMLSECKEYDATAFORMAT">xmlSecKeyDataFormat</a> format,
 107                                                          <a href="xmlsec-keysdata.html#XMLSECKEYDATATYPE">xmlSecKeyDataType</a> type);
 108 <font>int</font>                 <a href="xmlsec-gnutls-app.html#XMLSECGNUTLSAPPKEYSMNGRCERTLOADMEMORY">xmlSecGnuTLSAppKeysMngrCertLoadMemory</a>
 109                                                         (<a href="xmlsec-keysmngr.html#XMLSECKEYSMNGR">xmlSecKeysMngrPtr</a> mngr,
 110                                                          const <a href="xmlsec-xmlsec.html#XMLSECBYTE">xmlSecByte</a> *data,
 111                                                          <a href="xmlsec-xmlsec.html#XMLSECSIZE">xmlSecSize</a> dataSize,
 112                                                          <a href="xmlsec-keysdata.html#XMLSECKEYDATAFORMAT">xmlSecKeyDataFormat</a> format,
 113                                                          <a href="xmlsec-keysdata.html#XMLSECKEYDATATYPE">xmlSecKeyDataType</a> type);
 114 <a href="xmlsec-keys.html#XMLSECKEY">xmlSecKeyPtr</a>        <a href="xmlsec-gnutls-app.html#XMLSECGNUTLSAPPKEYLOAD">xmlSecGnuTLSAppKeyLoad</a>              (const <font>char</font> *filename,
 115                                                          <a href="xmlsec-keysdata.html#XMLSECKEYDATAFORMAT">xmlSecKeyDataFormat</a> format,
 116                                                          const <font>char</font> *pwd,
 117                                                          <font>void</font> *pwdCallback,
 118                                                          <font>void</font> *pwdCallbackCtx);
 119 <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,
 120                                                          <a href="xmlsec-xmlsec.html#XMLSECSIZE">xmlSecSize</a> dataSize,
 121                                                          <a href="xmlsec-keysdata.html#XMLSECKEYDATAFORMAT">xmlSecKeyDataFormat</a> format,
 122                                                          const <font>char</font> *pwd,
 123                                                          <font>void</font> *pwdCallback,
 124                                                          <font>void</font> *pwdCallbackCtx);
 125 <a href="xmlsec-keys.html#XMLSECKEY">xmlSecKeyPtr</a>        <a href="xmlsec-gnutls-app.html#XMLSECGNUTLSAPPPKCS12LOAD">xmlSecGnuTLSAppPkcs12Load</a>           (const <font>char</font> *filename,
 126                                                          const <font>char</font> *pwd,
 127                                                          <font>void</font> *pwdCallback,
 128                                                          <font>void</font> *pwdCallbackCtx);
 129 <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,
 130                                                          <a href="xmlsec-xmlsec.html#XMLSECSIZE">xmlSecSize</a> dataSize,
 131                                                          const <font>char</font> *pwd,
 132                                                          <font>void</font> *pwdCallback,
 133                                                          <font>void</font> *pwdCallbackCtx);
 134 <font>int</font>                 <a href="xmlsec-gnutls-app.html#XMLSECGNUTLSAPPKEYCERTLOAD">xmlSecGnuTLSAppKeyCertLoad</a>          (<a href="xmlsec-keys.html#XMLSECKEY">xmlSecKeyPtr</a> key,
 135                                                          const <font>char</font> *filename,
 136                                                          <a href="xmlsec-keysdata.html#XMLSECKEYDATAFORMAT">xmlSecKeyDataFormat</a> format);
 137 <font>int</font>                 <a href="xmlsec-gnutls-app.html#XMLSECGNUTLSAPPKEYCERTLOADMEMORY">xmlSecGnuTLSAppKeyCertLoadMemory</a>    (<a href="xmlsec-keys.html#XMLSECKEY">xmlSecKeyPtr</a> key,
 138                                                          const <a href="xmlsec-xmlsec.html#XMLSECBYTE">xmlSecByte</a> *data,
 139                                                          <a href="xmlsec-xmlsec.html#XMLSECSIZE">xmlSecSize</a> dataSize,
 140                                                          <a href="xmlsec-keysdata.html#XMLSECKEYDATAFORMAT">xmlSecKeyDataFormat</a> format);
 141 <font>void</font>*               <a href="xmlsec-gnutls-app.html#XMLSECGNUTLSAPPGETDEFAULTPWDCALLBACK">xmlSecGnuTLSAppGetDefaultPwdCallback</a>
 142                                                         (void);</pre>
 143 </div>
 144 <div class="REFSECT1">
 145 <a name="XMLSEC-GNUTLS-APP.DESCRIPTION"></a><h2>Description</h2>
 146 <p>Application functions implementation for GnuTLS.</p>
 147 </div>
 148 <div class="REFSECT1">
 149 <a name="XMLSEC-GNUTLS-APP.DETAILS"></a><h2>Details</h2>
 150 <div class="REFSECT2">
 151 <a name="XMLSECGNUTLSAPPINIT"></a><h3>xmlSecGnuTLSAppInit ()</h3>
 152 <pre class="PROGRAMLISTING"><font>int</font>                 xmlSecGnuTLSAppInit                 (const <font>char</font> *config);</pre>
 153 <p>General crypto engine initialization. This function is used
 154 by XMLSec command line utility and called before
 155 <code class="PARAMETER">xmlSecInit</code> function.</p>
 156 <p></p>
 157 <p></p>
 158 <table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody>
 159 <tr>
 160 <td align="LEFT" valign="TOP"><a name="AEN24397"><span style="white-space: nowrap"><code class="PARAMETER">config</code> :</span></a></td>
 161 <td align="LEFT" valign="TOP"><p>               the path to GnuTLS configuration (unused).</p></td>
 162 </tr>
 163 <tr>
 164 <td align="LEFT" valign="TOP"><a name="AEN24402"><span style="white-space: nowrap"><span class="emphasis"><i class="EMPHASIS">Returns</i></span> :</span></a></td>
 165 <td align="LEFT" valign="TOP"><p> 0 on success or a negative value otherwise.</p></td>
 166 </tr>
 167 </tbody></table>
 168 </div>
 169 <hr>
 170 <div class="REFSECT2">
 171 <a name="XMLSECGNUTLSAPPSHUTDOWN"></a><h3>xmlSecGnuTLSAppShutdown ()</h3>
 172 <pre class="PROGRAMLISTING"><font>int</font>                 xmlSecGnuTLSAppShutdown             (void);</pre>
 173 <p>General crypto engine shutdown. This function is used
 174 by XMLSec command line utility and called after
 175 <code class="PARAMETER">xmlSecShutdown</code> function.</p>
 176 <p></p>
 177 <p></p>
 178 <table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody><tr>
 179 <td align="LEFT" valign="TOP"><a name="AEN24417"><span style="white-space: nowrap"><span class="emphasis"><i class="EMPHASIS">Returns</i></span> :</span></a></td>
 180 <td align="LEFT" valign="TOP"><p> 0 on success or a negative value otherwise.</p></td>
 181 </tr></tbody></table>
 182 </div>
 183 <hr>
 184 <div class="REFSECT2">
 185 <a name="XMLSECGNUTLSAPPDEFAULTKEYSMNGRINIT"></a><h3>xmlSecGnuTLSAppDefaultKeysMngrInit ()</h3>
 186 <pre class="PROGRAMLISTING"><font>int</font>                 xmlSecGnuTLSAppDefaultKeysMngrInit  (<a href="xmlsec-keysmngr.html#XMLSECKEYSMNGR">xmlSecKeysMngrPtr</a> mngr);</pre>
 187 <p>Initializes <code class="PARAMETER">mngr</code> with simple keys store <a href="xmlsec-keysmngr.html#XMLSECSIMPLEKEYSSTOREID"><span class="TYPE">xmlSecSimpleKeysStoreId</span></a>
 188 and a default GnuTLS crypto key data stores.</p>
 189 <p></p>
 190 <p></p>
 191 <table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody>
 192 <tr>
 193 <td align="LEFT" valign="TOP"><a name="AEN24435"><span style="white-space: nowrap"><code class="PARAMETER">mngr</code> :</span></a></td>
 194 <td align="LEFT" valign="TOP"><p>               the pointer to keys manager.</p></td>
 195 </tr>
 196 <tr>
 197 <td align="LEFT" valign="TOP"><a name="AEN24440"><span style="white-space: nowrap"><span class="emphasis"><i class="EMPHASIS">Returns</i></span> :</span></a></td>
 198 <td align="LEFT" valign="TOP"><p> 0 on success or a negative value otherwise.</p></td>
 199 </tr>
 200 </tbody></table>
 201 </div>
 202 <hr>
 203 <div class="REFSECT2">
 204 <a name="XMLSECGNUTLSAPPDEFAULTKEYSMNGRADOPTKEY"></a><h3>xmlSecGnuTLSAppDefaultKeysMngrAdoptKey ()</h3>
 205 <pre class="PROGRAMLISTING"><font>int</font>                 xmlSecGnuTLSAppDefaultKeysMngrAdoptKey
 206                                                         (<a href="xmlsec-keysmngr.html#XMLSECKEYSMNGR">xmlSecKeysMngrPtr</a> mngr,
 207                                                          <a href="xmlsec-keys.html#XMLSECKEY">xmlSecKeyPtr</a> key);</pre>
 208 <p>Adds <code class="PARAMETER">key</code> to the keys manager <code class="PARAMETER">mngr</code> created with <a href="xmlsec-gnutls-app.html#XMLSECGNUTLSAPPDEFAULTKEYSMNGRINIT"><span class="TYPE">xmlSecGnuTLSAppDefaultKeysMngrInit</span></a>
 209 function.</p>
 210 <p></p>
 211 <p></p>
 212 <table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody>
 213 <tr>
 214 <td align="LEFT" valign="TOP"><a name="AEN24460"><span style="white-space: nowrap"><code class="PARAMETER">mngr</code> :</span></a></td>
 215 <td align="LEFT" valign="TOP"><p>               the pointer to keys manager.</p></td>
 216 </tr>
 217 <tr>
 218 <td align="LEFT" valign="TOP"><a name="AEN24465"><span style="white-space: nowrap"><code class="PARAMETER">key</code> :</span></a></td>
 219 <td align="LEFT" valign="TOP"><p>               the pointer to key.</p></td>
 220 </tr>
 221 <tr>
 222 <td align="LEFT" valign="TOP"><a name="AEN24470"><span style="white-space: nowrap"><span class="emphasis"><i class="EMPHASIS">Returns</i></span> :</span></a></td>
 223 <td align="LEFT" valign="TOP"><p> 0 on success or a negative value otherwise.</p></td>
 224 </tr>
 225 </tbody></table>
 226 </div>
 227 <hr>
 228 <div class="REFSECT2">
 229 <a name="XMLSECGNUTLSAPPDEFAULTKEYSMNGRLOAD"></a><h3>xmlSecGnuTLSAppDefaultKeysMngrLoad ()</h3>
 230 <pre class="PROGRAMLISTING"><font>int</font>                 xmlSecGnuTLSAppDefaultKeysMngrLoad  (<a href="xmlsec-keysmngr.html#XMLSECKEYSMNGR">xmlSecKeysMngrPtr</a> mngr,
 231                                                          const <font>char</font> *uri);</pre>
 232 <p>Loads XML keys file from <code class="PARAMETER">uri</code> to the keys manager <code class="PARAMETER">mngr</code> created
 233 with <a href="xmlsec-gnutls-app.html#XMLSECGNUTLSAPPDEFAULTKEYSMNGRINIT"><span class="TYPE">xmlSecGnuTLSAppDefaultKeysMngrInit</span></a> function.</p>
 234 <p></p>
 235 <p></p>
 236 <table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody>
 237 <tr>
 238 <td align="LEFT" valign="TOP"><a name="AEN24490"><span style="white-space: nowrap"><code class="PARAMETER">mngr</code> :</span></a></td>
 239 <td align="LEFT" valign="TOP"><p>               the pointer to keys manager.</p></td>
 240 </tr>
 241 <tr>
 242 <td align="LEFT" valign="TOP"><a name="AEN24495"><span style="white-space: nowrap"><code class="PARAMETER">uri</code> :</span></a></td>
 243 <td align="LEFT" valign="TOP"><p>               the uri.</p></td>
 244 </tr>
 245 <tr>
 246 <td align="LEFT" valign="TOP"><a name="AEN24500"><span style="white-space: nowrap"><span class="emphasis"><i class="EMPHASIS">Returns</i></span> :</span></a></td>
 247 <td align="LEFT" valign="TOP"><p> 0 on success or a negative value otherwise.</p></td>
 248 </tr>
 249 </tbody></table>
 250 </div>
 251 <hr>
 252 <div class="REFSECT2">
 253 <a name="XMLSECGNUTLSAPPDEFAULTKEYSMNGRSAVE"></a><h3>xmlSecGnuTLSAppDefaultKeysMngrSave ()</h3>
 254 <pre class="PROGRAMLISTING"><font>int</font>                 xmlSecGnuTLSAppDefaultKeysMngrSave  (<a href="xmlsec-keysmngr.html#XMLSECKEYSMNGR">xmlSecKeysMngrPtr</a> mngr,
 255                                                          const <font>char</font> *filename,
 256                                                          <a href="xmlsec-keysdata.html#XMLSECKEYDATATYPE">xmlSecKeyDataType</a> type);</pre>
 257 <p>Saves keys from <code class="PARAMETER">mngr</code> to  XML keys file.</p>
 258 <p></p>
 259 <p></p>
 260 <table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody>
 261 <tr>
 262 <td align="LEFT" valign="TOP"><a name="AEN24518"><span style="white-space: nowrap"><code class="PARAMETER">mngr</code> :</span></a></td>
 263 <td align="LEFT" valign="TOP"><p>               the pointer to keys manager.</p></td>
 264 </tr>
 265 <tr>
 266 <td align="LEFT" valign="TOP"><a name="AEN24523"><span style="white-space: nowrap"><code class="PARAMETER">filename</code> :</span></a></td>
 267 <td align="LEFT" valign="TOP"><p>               the destination filename.</p></td>
 268 </tr>
 269 <tr>
 270 <td align="LEFT" valign="TOP"><a name="AEN24528"><span style="white-space: nowrap"><code class="PARAMETER">type</code> :</span></a></td>
 271 <td align="LEFT" valign="TOP"><p>               the type of keys to save (public/private/symmetric).</p></td>
 272 </tr>
 273 <tr>
 274 <td align="LEFT" valign="TOP"><a name="AEN24533"><span style="white-space: nowrap"><span class="emphasis"><i class="EMPHASIS">Returns</i></span> :</span></a></td>
 275 <td align="LEFT" valign="TOP"><p> 0 on success or a negative value otherwise.</p></td>
 276 </tr>
 277 </tbody></table>
 278 </div>
 279 <hr>
 280 <div class="REFSECT2">
 281 <a name="XMLSECGNUTLSAPPKEYSMNGRCERTLOAD"></a><h3>xmlSecGnuTLSAppKeysMngrCertLoad ()</h3>
 282 <pre class="PROGRAMLISTING"><font>int</font>                 xmlSecGnuTLSAppKeysMngrCertLoad     (<a href="xmlsec-keysmngr.html#XMLSECKEYSMNGR">xmlSecKeysMngrPtr</a> mngr,
 283                                                          const <font>char</font> *filename,
 284                                                          <a href="xmlsec-keysdata.html#XMLSECKEYDATAFORMAT">xmlSecKeyDataFormat</a> format,
 285                                                          <a href="xmlsec-keysdata.html#XMLSECKEYDATATYPE">xmlSecKeyDataType</a> type);</pre>
 286 <p>Reads cert from <code class="PARAMETER">filename</code> and adds to the list of trusted or known
 287 untrusted certs in <code class="PARAMETER">store</code> (not implemented yet).</p>
 288 <p></p>
 289 <p></p>
 290 <table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody>
 291 <tr>
 292 <td align="LEFT" valign="TOP"><a name="AEN24553"><span style="white-space: nowrap"><code class="PARAMETER">mngr</code> :</span></a></td>
 293 <td align="LEFT" valign="TOP"><p>               the keys manager.</p></td>
 294 </tr>
 295 <tr>
 296 <td align="LEFT" valign="TOP"><a name="AEN24558"><span style="white-space: nowrap"><code class="PARAMETER">filename</code> :</span></a></td>
 297 <td align="LEFT" valign="TOP"><p>               the certificate file.</p></td>
 298 </tr>
 299 <tr>
 300 <td align="LEFT" valign="TOP"><a name="AEN24563"><span style="white-space: nowrap"><code class="PARAMETER">format</code> :</span></a></td>
 301 <td align="LEFT" valign="TOP"><p>               the certificate file format.</p></td>
 302 </tr>
 303 <tr>
 304 <td align="LEFT" valign="TOP"><a name="AEN24568"><span style="white-space: nowrap"><code class="PARAMETER">type</code> :</span></a></td>
 305 <td align="LEFT" valign="TOP"><p>               the flag that indicates is the certificate in <code class="PARAMETER">filename</code>
 306                         trusted or not.</p></td>
 307 </tr>
 308 <tr>
 309 <td align="LEFT" valign="TOP"><a name="AEN24574"><span style="white-space: nowrap"><span class="emphasis"><i class="EMPHASIS">Returns</i></span> :</span></a></td>
 310 <td align="LEFT" valign="TOP"><p> 0 on success or a negative value otherwise.</p></td>
 311 </tr>
 312 </tbody></table>
 313 </div>
 314 <hr>
 315 <div class="REFSECT2">
 316 <a name="XMLSECGNUTLSAPPKEYSMNGRCERTLOADMEMORY"></a><h3>xmlSecGnuTLSAppKeysMngrCertLoadMemory ()</h3>
 317 <pre class="PROGRAMLISTING"><font>int</font>                 xmlSecGnuTLSAppKeysMngrCertLoadMemory
 318                                                         (<a href="xmlsec-keysmngr.html#XMLSECKEYSMNGR">xmlSecKeysMngrPtr</a> mngr,
 319                                                          const <a href="xmlsec-xmlsec.html#XMLSECBYTE">xmlSecByte</a> *data,
 320                                                          <a href="xmlsec-xmlsec.html#XMLSECSIZE">xmlSecSize</a> dataSize,
 321                                                          <a href="xmlsec-keysdata.html#XMLSECKEYDATAFORMAT">xmlSecKeyDataFormat</a> format,
 322                                                          <a href="xmlsec-keysdata.html#XMLSECKEYDATATYPE">xmlSecKeyDataType</a> type);</pre>
 323 <p>Reads cert from binary buffer <code class="PARAMETER">data</code> and adds to the list of trusted or known
 324 untrusted certs in <code class="PARAMETER">store</code> (not implemented yet).</p>
 325 <p></p>
 326 <p></p>
 327 <table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody>
 328 <tr>
 329 <td align="LEFT" valign="TOP"><a name="AEN24595"><span style="white-space: nowrap"><code class="PARAMETER">mngr</code> :</span></a></td>
 330 <td align="LEFT" valign="TOP"><p>               the keys manager.</p></td>
 331 </tr>
 332 <tr>
 333 <td align="LEFT" valign="TOP"><a name="AEN24600"><span style="white-space: nowrap"><code class="PARAMETER">data</code> :</span></a></td>
 334 <td align="LEFT" valign="TOP"><p>               the certificate binary data.</p></td>
 335 </tr>
 336 <tr>
 337 <td align="LEFT" valign="TOP"><a name="AEN24605"><span style="white-space: nowrap"><code class="PARAMETER">dataSize</code> :</span></a></td>
 338 <td align="LEFT" valign="TOP"><p>               the certificate binary data size.</p></td>
 339 </tr>
 340 <tr>
 341 <td align="LEFT" valign="TOP"><a name="AEN24610"><span style="white-space: nowrap"><code class="PARAMETER">format</code> :</span></a></td>
 342 <td align="LEFT" valign="TOP"><p>               the certificate file format.</p></td>
 343 </tr>
 344 <tr>
 345 <td align="LEFT" valign="TOP"><a name="AEN24615"><span style="white-space: nowrap"><code class="PARAMETER">type</code> :</span></a></td>
 346 <td align="LEFT" valign="TOP"><p>               the flag that indicates is the certificate trusted or not.</p></td>
 347 </tr>
 348 <tr>
 349 <td align="LEFT" valign="TOP"><a name="AEN24620"><span style="white-space: nowrap"><span class="emphasis"><i class="EMPHASIS">Returns</i></span> :</span></a></td>
 350 <td align="LEFT" valign="TOP"><p> 0 on success or a negative value otherwise.</p></td>
 351 </tr>
 352 </tbody></table>
 353 </div>
 354 <hr>
 355 <div class="REFSECT2">
 356 <a name="XMLSECGNUTLSAPPKEYLOAD"></a><h3>xmlSecGnuTLSAppKeyLoad ()</h3>
 357 <pre class="PROGRAMLISTING"><a href="xmlsec-keys.html#XMLSECKEY">xmlSecKeyPtr</a>        xmlSecGnuTLSAppKeyLoad              (const <font>char</font> *filename,
 358                                                          <a href="xmlsec-keysdata.html#XMLSECKEYDATAFORMAT">xmlSecKeyDataFormat</a> format,
 359                                                          const <font>char</font> *pwd,
 360                                                          <font>void</font> *pwdCallback,
 361                                                          <font>void</font> *pwdCallbackCtx);</pre>
 362 <p>Reads key from the a file (not implemented yet).</p>
 363 <p></p>
 364 <p></p>
 365 <table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody>
 366 <tr>
 367 <td align="LEFT" valign="TOP"><a name="AEN24639"><span style="white-space: nowrap"><code class="PARAMETER">filename</code> :</span></a></td>
 368 <td align="LEFT" valign="TOP"><p>               the key filename.</p></td>
 369 </tr>
 370 <tr>
 371 <td align="LEFT" valign="TOP"><a name="AEN24644"><span style="white-space: nowrap"><code class="PARAMETER">format</code> :</span></a></td>
 372 <td align="LEFT" valign="TOP"><p>               the key file format.</p></td>
 373 </tr>
 374 <tr>
 375 <td align="LEFT" valign="TOP"><a name="AEN24649"><span style="white-space: nowrap"><code class="PARAMETER">pwd</code> :</span></a></td>
 376 <td align="LEFT" valign="TOP"><p>               the key file password.</p></td>
 377 </tr>
 378 <tr>
 379 <td align="LEFT" valign="TOP"><a name="AEN24654"><span style="white-space: nowrap"><code class="PARAMETER">pwdCallback</code> :</span></a></td>
 380 <td align="LEFT" valign="TOP"><p>       the key password callback.</p></td>
 381 </tr>
 382 <tr>
 383 <td align="LEFT" valign="TOP"><a name="AEN24659"><span style="white-space: nowrap"><code class="PARAMETER">pwdCallbackCtx</code> :</span></a></td>
 384 <td align="LEFT" valign="TOP"><p>       the user context for password callback.</p></td>
 385 </tr>
 386 <tr>
 387 <td align="LEFT" valign="TOP"><a name="AEN24664"><span style="white-space: nowrap"><span class="emphasis"><i class="EMPHASIS">Returns</i></span> :</span></a></td>
 388 <td align="LEFT" valign="TOP"><p> pointer to the key or NULL if an error occurs.</p></td>
 389 </tr>
 390 </tbody></table>
 391 </div>
 392 <hr>
 393 <div class="REFSECT2">
 394 <a name="XMLSECGNUTLSAPPKEYLOADMEMORY"></a><h3>xmlSecGnuTLSAppKeyLoadMemory ()</h3>
 395 <pre class="PROGRAMLISTING"><a href="xmlsec-keys.html#XMLSECKEY">xmlSecKeyPtr</a>        xmlSecGnuTLSAppKeyLoadMemory        (const <a href="xmlsec-xmlsec.html#XMLSECBYTE">xmlSecByte</a> *data,
 396                                                          <a href="xmlsec-xmlsec.html#XMLSECSIZE">xmlSecSize</a> dataSize,
 397                                                          <a href="xmlsec-keysdata.html#XMLSECKEYDATAFORMAT">xmlSecKeyDataFormat</a> format,
 398                                                          const <font>char</font> *pwd,
 399                                                          <font>void</font> *pwdCallback,
 400                                                          <font>void</font> *pwdCallbackCtx);</pre>
 401 <p>Reads key from the memory buffer (not implemented yet).</p>
 402 <p></p>
 403 <p></p>
 404 <table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody>
 405 <tr>
 406 <td align="LEFT" valign="TOP"><a name="AEN24684"><span style="white-space: nowrap"><code class="PARAMETER">data</code> :</span></a></td>
 407 <td align="LEFT" valign="TOP"><p>               the binary key data.</p></td>
 408 </tr>
 409 <tr>
 410 <td align="LEFT" valign="TOP"><a name="AEN24689"><span style="white-space: nowrap"><code class="PARAMETER">dataSize</code> :</span></a></td>
 411 <td align="LEFT" valign="TOP"><p>               the size of binary key.</p></td>
 412 </tr>
 413 <tr>
 414 <td align="LEFT" valign="TOP"><a name="AEN24694"><span style="white-space: nowrap"><code class="PARAMETER">format</code> :</span></a></td>
 415 <td align="LEFT" valign="TOP"><p>               the key file format.</p></td>
 416 </tr>
 417 <tr>
 418 <td align="LEFT" valign="TOP"><a name="AEN24699"><span style="white-space: nowrap"><code class="PARAMETER">pwd</code> :</span></a></td>
 419 <td align="LEFT" valign="TOP"><p>               the key file password.</p></td>
 420 </tr>
 421 <tr>
 422 <td align="LEFT" valign="TOP"><a name="AEN24704"><span style="white-space: nowrap"><code class="PARAMETER">pwdCallback</code> :</span></a></td>
 423 <td align="LEFT" valign="TOP"><p>       the key password callback.</p></td>
 424 </tr>
 425 <tr>
 426 <td align="LEFT" valign="TOP"><a name="AEN24709"><span style="white-space: nowrap"><code class="PARAMETER">pwdCallbackCtx</code> :</span></a></td>
 427 <td align="LEFT" valign="TOP"><p>       the user context for password callback.</p></td>
 428 </tr>
 429 <tr>
 430 <td align="LEFT" valign="TOP"><a name="AEN24714"><span style="white-space: nowrap"><span class="emphasis"><i class="EMPHASIS">Returns</i></span> :</span></a></td>
 431 <td align="LEFT" valign="TOP"><p> pointer to the key or NULL if an error occurs.</p></td>
 432 </tr>
 433 </tbody></table>
 434 </div>
 435 <hr>
 436 <div class="REFSECT2">
 437 <a name="XMLSECGNUTLSAPPPKCS12LOAD"></a><h3>xmlSecGnuTLSAppPkcs12Load ()</h3>
 438 <pre class="PROGRAMLISTING"><a href="xmlsec-keys.html#XMLSECKEY">xmlSecKeyPtr</a>        xmlSecGnuTLSAppPkcs12Load           (const <font>char</font> *filename,
 439                                                          const <font>char</font> *pwd,
 440                                                          <font>void</font> *pwdCallback,
 441                                                          <font>void</font> *pwdCallbackCtx);</pre>
 442 <p>Reads key and all associated certificates from the PKCS12 file
 443 (not implemented yet).
 444 For uniformity, call xmlSecGnuTLSAppKeyLoad instead of this function. Pass
 445 in format=xmlSecKeyDataFormatPkcs12.</p>
 446 <p></p>
 447 <p></p>
 448 <table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody>
 449 <tr>
 450 <td align="LEFT" valign="TOP"><a name="AEN24732"><span style="white-space: nowrap"><code class="PARAMETER">filename</code> :</span></a></td>
 451 <td align="LEFT" valign="TOP"><p>               the PKCS12 key filename.</p></td>
 452 </tr>
 453 <tr>
 454 <td align="LEFT" valign="TOP"><a name="AEN24737"><span style="white-space: nowrap"><code class="PARAMETER">pwd</code> :</span></a></td>
 455 <td align="LEFT" valign="TOP"><p>               the PKCS12 file password.</p></td>
 456 </tr>
 457 <tr>
 458 <td align="LEFT" valign="TOP"><a name="AEN24742"><span style="white-space: nowrap"><code class="PARAMETER">pwdCallback</code> :</span></a></td>
 459 <td align="LEFT" valign="TOP"><p>       the password callback.</p></td>
 460 </tr>
 461 <tr>
 462 <td align="LEFT" valign="TOP"><a name="AEN24747"><span style="white-space: nowrap"><code class="PARAMETER">pwdCallbackCtx</code> :</span></a></td>
 463 <td align="LEFT" valign="TOP"><p>       the user context for password callback.</p></td>
 464 </tr>
 465 <tr>
 466 <td align="LEFT" valign="TOP"><a name="AEN24752"><span style="white-space: nowrap"><span class="emphasis"><i class="EMPHASIS">Returns</i></span> :</span></a></td>
 467 <td align="LEFT" valign="TOP"><p> pointer to the key or NULL if an error occurs.</p></td>
 468 </tr>
 469 </tbody></table>
 470 </div>
 471 <hr>
 472 <div class="REFSECT2">
 473 <a name="XMLSECGNUTLSAPPPKCS12LOADMEMORY"></a><h3>xmlSecGnuTLSAppPkcs12LoadMemory ()</h3>
 474 <pre class="PROGRAMLISTING"><a href="xmlsec-keys.html#XMLSECKEY">xmlSecKeyPtr</a>        xmlSecGnuTLSAppPkcs12LoadMemory     (const <a href="xmlsec-xmlsec.html#XMLSECBYTE">xmlSecByte</a> *data,
 475                                                          <a href="xmlsec-xmlsec.html#XMLSECSIZE">xmlSecSize</a> dataSize,
 476                                                          const <font>char</font> *pwd,
 477                                                          <font>void</font> *pwdCallback,
 478                                                          <font>void</font> *pwdCallbackCtx);</pre>
 479 <p>Reads key and all associated certificates from the PKCS12 data in memory buffer.
 480 For uniformity, call xmlSecGnuTLSAppKeyLoadMemory instead of this function. Pass
 481 in format=xmlSecKeyDataFormatPkcs12 (not implemented yet).</p>
 482 <p></p>
 483 <p></p>
 484 <table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody>
 485 <tr>
 486 <td align="LEFT" valign="TOP"><a name="AEN24771"><span style="white-space: nowrap"><code class="PARAMETER">data</code> :</span></a></td>
 487 <td align="LEFT" valign="TOP"><p>               the PKCS12 binary data.</p></td>
 488 </tr>
 489 <tr>
 490 <td align="LEFT" valign="TOP"><a name="AEN24776"><span style="white-space: nowrap"><code class="PARAMETER">dataSize</code> :</span></a></td>
 491 <td align="LEFT" valign="TOP"><p>               the PKCS12 binary data size.</p></td>
 492 </tr>
 493 <tr>
 494 <td align="LEFT" valign="TOP"><a name="AEN24781"><span style="white-space: nowrap"><code class="PARAMETER">pwd</code> :</span></a></td>
 495 <td align="LEFT" valign="TOP"><p>               the PKCS12 file password.</p></td>
 496 </tr>
 497 <tr>
 498 <td align="LEFT" valign="TOP"><a name="AEN24786"><span style="white-space: nowrap"><code class="PARAMETER">pwdCallback</code> :</span></a></td>
 499 <td align="LEFT" valign="TOP"><p>       the password callback.</p></td>
 500 </tr>
 501 <tr>
 502 <td align="LEFT" valign="TOP"><a name="AEN24791"><span style="white-space: nowrap"><code class="PARAMETER">pwdCallbackCtx</code> :</span></a></td>
 503 <td align="LEFT" valign="TOP"><p>       the user context for password callback.</p></td>
 504 </tr>
 505 <tr>
 506 <td align="LEFT" valign="TOP"><a name="AEN24796"><span style="white-space: nowrap"><span class="emphasis"><i class="EMPHASIS">Returns</i></span> :</span></a></td>
 507 <td align="LEFT" valign="TOP"><p> pointer to the key or NULL if an error occurs.</p></td>
 508 </tr>
 509 </tbody></table>
 510 </div>
 511 <hr>
 512 <div class="REFSECT2">
 513 <a name="XMLSECGNUTLSAPPKEYCERTLOAD"></a><h3>xmlSecGnuTLSAppKeyCertLoad ()</h3>
 514 <pre class="PROGRAMLISTING"><font>int</font>                 xmlSecGnuTLSAppKeyCertLoad          (<a href="xmlsec-keys.html#XMLSECKEY">xmlSecKeyPtr</a> key,
 515                                                          const <font>char</font> *filename,
 516                                                          <a href="xmlsec-keysdata.html#XMLSECKEYDATAFORMAT">xmlSecKeyDataFormat</a> format);</pre>
 517 <p>Reads the certificate from $<code class="PARAMETER">filename</code> and adds it to key
 518 (not implemented yet).</p>
 519 <p></p>
 520 <p></p>
 521 <table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody>
 522 <tr>
 523 <td align="LEFT" valign="TOP"><a name="AEN24814"><span style="white-space: nowrap"><code class="PARAMETER">key</code> :</span></a></td>
 524 <td align="LEFT" valign="TOP"><p>               the pointer to key.</p></td>
 525 </tr>
 526 <tr>
 527 <td align="LEFT" valign="TOP"><a name="AEN24819"><span style="white-space: nowrap"><code class="PARAMETER">filename</code> :</span></a></td>
 528 <td align="LEFT" valign="TOP"><p>               the certificate filename.</p></td>
 529 </tr>
 530 <tr>
 531 <td align="LEFT" valign="TOP"><a name="AEN24824"><span style="white-space: nowrap"><code class="PARAMETER">format</code> :</span></a></td>
 532 <td align="LEFT" valign="TOP"><p>               the certificate file format.</p></td>
 533 </tr>
 534 <tr>
 535 <td align="LEFT" valign="TOP"><a name="AEN24829"><span style="white-space: nowrap"><span class="emphasis"><i class="EMPHASIS">Returns</i></span> :</span></a></td>
 536 <td align="LEFT" valign="TOP"><p> 0 on success or a negative value otherwise.</p></td>
 537 </tr>
 538 </tbody></table>
 539 </div>
 540 <hr>
 541 <div class="REFSECT2">
 542 <a name="XMLSECGNUTLSAPPKEYCERTLOADMEMORY"></a><h3>xmlSecGnuTLSAppKeyCertLoadMemory ()</h3>
 543 <pre class="PROGRAMLISTING"><font>int</font>                 xmlSecGnuTLSAppKeyCertLoadMemory    (<a href="xmlsec-keys.html#XMLSECKEY">xmlSecKeyPtr</a> key,
 544                                                          const <a href="xmlsec-xmlsec.html#XMLSECBYTE">xmlSecByte</a> *data,
 545                                                          <a href="xmlsec-xmlsec.html#XMLSECSIZE">xmlSecSize</a> dataSize,
 546                                                          <a href="xmlsec-keysdata.html#XMLSECKEYDATAFORMAT">xmlSecKeyDataFormat</a> format);</pre>
 547 <p>Reads the certificate from memory buffer and adds it to key (not implemented yet).</p>
 548 <p></p>
 549 <p></p>
 550 <table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody>
 551 <tr>
 552 <td align="LEFT" valign="TOP"><a name="AEN24847"><span style="white-space: nowrap"><code class="PARAMETER">key</code> :</span></a></td>
 553 <td align="LEFT" valign="TOP"><p>               the pointer to key.</p></td>
 554 </tr>
 555 <tr>
 556 <td align="LEFT" valign="TOP"><a name="AEN24852"><span style="white-space: nowrap"><code class="PARAMETER">data</code> :</span></a></td>
 557 <td align="LEFT" valign="TOP"><p>               the certificate binary data.</p></td>
 558 </tr>
 559 <tr>
 560 <td align="LEFT" valign="TOP"><a name="AEN24857"><span style="white-space: nowrap"><code class="PARAMETER">dataSize</code> :</span></a></td>
 561 <td align="LEFT" valign="TOP"><p>               the certificate binary data size.</p></td>
 562 </tr>
 563 <tr>
 564 <td align="LEFT" valign="TOP"><a name="AEN24862"><span style="white-space: nowrap"><code class="PARAMETER">format</code> :</span></a></td>
 565 <td align="LEFT" valign="TOP"><p>               the certificate file format.</p></td>
 566 </tr>
 567 <tr>
 568 <td align="LEFT" valign="TOP"><a name="AEN24867"><span style="white-space: nowrap"><span class="emphasis"><i class="EMPHASIS">Returns</i></span> :</span></a></td>
 569 <td align="LEFT" valign="TOP"><p> 0 on success or a negative value otherwise.</p></td>
 570 </tr>
 571 </tbody></table>
 572 </div>
 573 <hr>
 574 <div class="REFSECT2">
 575 <a name="XMLSECGNUTLSAPPGETDEFAULTPWDCALLBACK"></a><h3>xmlSecGnuTLSAppGetDefaultPwdCallback ()</h3>
 576 <pre class="PROGRAMLISTING"><font>void</font>*               xmlSecGnuTLSAppGetDefaultPwdCallback
 577                                                         (void);</pre>
 578 <p>Gets default password callback.</p>
 579 <p></p>
 580 <p></p>
 581 <table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody><tr>
 582 <td align="LEFT" valign="TOP"><a name="AEN24881"><span style="white-space: nowrap"><span class="emphasis"><i class="EMPHASIS">Returns</i></span> :</span></a></td>
 583 <td align="LEFT" valign="TOP"><p> default password callback.</p></td>
 584 </tr></tbody></table>
 585 </div>
 586 </div>
 587 <table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="2"><tr valign="middle">
 588 <td align="left"><a accesskey="p" href="xmlsec-gnutls-ref.html"><b>&lt;&lt;&lt; XML Security Library for GnuTLS API Reference.</b></a></td>
 589 <td align="right"><a accesskey="n" href="xmlsec-gnutls-crypto.html"><b>crypto &gt;&gt;&gt;</b></a></td>
 590 </tr></table>
 591 </td></tr></table></td>
 592 </tr></table></body>
 593 </html>