diff options
Diffstat (limited to 'docs/api/xmlsec-gcrypt-app.html')
-rw-r--r-- | docs/api/xmlsec-gcrypt-app.html | 1025 |
1 files changed, 474 insertions, 551 deletions
diff --git a/docs/api/xmlsec-gcrypt-app.html b/docs/api/xmlsec-gcrypt-app.html index d7aabcfc..43c4d43a 100644 --- a/docs/api/xmlsec-gcrypt-app.html +++ b/docs/api/xmlsec-gcrypt-app.html @@ -1,864 +1,787 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <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.79"> -<link rel="HOME" title="XML Security Library Reference Manual" href="index.html"> -<link rel="UP" title="XML Security Library for GCrypt API Reference." href="xmlsec-gcrypt-ref.html"> -<link rel="PREVIOUS" title="XML Security Library for GCrypt API Reference." href="xmlsec-gcrypt-ref.html"> -<link rel="NEXT" title="crypto" href="xmlsec-gcrypt-crypto.html"> -<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> -<style type="text/css"> -table.CALSTABLE > tbody > tr:nth-child(1) > td:nth-child(1) { - width: 20em; -} -.synopsis, .classsynopsis { - background: #eeeeee; - border: solid 1px #aaaaaa; -} -.programlisting { - background: #eeeeee; - border: solid 1px #000000; -} -.navigation { - background: #eeeeee; - border: solid 1px #000000; -} -.navigation a { - color: initial; -} -.navigation a:visited { - color: initial; -} -</style> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>app: XML Security Library Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> +<link rel="home" href="index.html" title="XML Security Library Reference Manual"> +<link rel="up" href="xmlsec-gcrypt-ref.html" title="XML Security Library for GCrypt API Reference."> +<link rel="prev" href="xmlsec-gcrypt-ref.html" title="XML Security Library for GCrypt API Reference."> +<link rel="next" href="xmlsec-gcrypt-crypto.html" title="crypto"> +<meta name="generator" content="GTK-Doc V1.27 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> </head> -<body><table width="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-gcrypt-ref.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> -<td><a accesskey="u" href="xmlsec-gcrypt-ref.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle"> +<td width="100%" align="left" class="shortcuts"> +<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> + <a href="#xmlsec-gcrypt-app.description" class="shortcut">Description</a></span> +</td> <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> -<th width="100%" align="center">XML Security Library Reference Manual</th> +<td><a accesskey="u" href="xmlsec-gcrypt-ref.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="xmlsec-gcrypt-ref.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> <td><a accesskey="n" href="xmlsec-gcrypt-crypto.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> </tr></table> -<h1> -<a name="XMLSEC-GCRYPT-APP"></a>app</h1> -<div class="REFNAMEDIV"> -<a name="AEN35997"></a><h2>Name</h2>app -- Application functions implementation for GnuTLS.</div> -<div class="REFSECT1"> -<a name="XMLSEC-GCRYPT-APP.FUNCTIONS"></a><h2>Functions</h2> -<div class="INFORMALTABLE"> -<p></p> -<a name="AEN36002"></a><table border="0" frame="void" width="100%" class="CALSTABLE"> +<div class="refentry"> +<a name="xmlsec-gcrypt-app"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="xmlsec-gcrypt-app.top_of_page"></a>app</span></h2> +<p>app — Application support functions for GCrypt.</p> +</td> +<td class="gallery_image" valign="top" align="right"></td> +</tr></table></div> +<div class="refsect1"> +<a name="xmlsec-gcrypt-app.stability-level"></a><h2>Stability Level</h2> +<a href="http://foldoc.org/Stable"><span class="acronym">Stable</span></a>, unless otherwise indicated +</div> +<div class="refsect1"> +<a name="xmlsec-gcrypt-app.functions"></a><h2>Functions</h2> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> <col> <col> +</colgroup> <tbody> <tr> -<td><font><span class="RETURNVALUE">int</span></font></td> -<td> -<a href="xmlsec-gcrypt-app.html#XMLSECGCRYPTAPPINIT">xmlSecGCryptAppInit</a> <span class="c_punctuation"><span class="PHRASE">()</span></span> +<td class="function_type"> +<font><span class="returnvalue">int</span></font> +</td> +<td class="function_name"> +<a class="link" href="xmlsec-gcrypt-app.html#xmlSecGCryptAppInit" title="xmlSecGCryptAppInit ()">xmlSecGCryptAppInit</a> <span class="c_punctuation">()</span> </td> </tr> <tr> -<td><font><span class="RETURNVALUE">int</span></font></td> -<td> -<a href="xmlsec-gcrypt-app.html#XMLSECGCRYPTAPPSHUTDOWN">xmlSecGCryptAppShutdown</a> <span class="c_punctuation"><span class="PHRASE">()</span></span> +<td class="function_type"> +<font><span class="returnvalue">int</span></font> +</td> +<td class="function_name"> +<a class="link" href="xmlsec-gcrypt-app.html#xmlSecGCryptAppShutdown" title="xmlSecGCryptAppShutdown ()">xmlSecGCryptAppShutdown</a> <span class="c_punctuation">()</span> </td> </tr> <tr> -<td><font><span class="RETURNVALUE">int</span></font></td> -<td> -<a href="xmlsec-gcrypt-app.html#XMLSECGCRYPTAPPDEFAULTKEYSMNGRINIT">xmlSecGCryptAppDefaultKeysMngrInit</a> <span class="c_punctuation"><span class="PHRASE">()</span></span> +<td class="function_type"> +<font><span class="returnvalue">int</span></font> +</td> +<td class="function_name"> +<a class="link" href="xmlsec-gcrypt-app.html#xmlSecGCryptAppDefaultKeysMngrInit" title="xmlSecGCryptAppDefaultKeysMngrInit ()">xmlSecGCryptAppDefaultKeysMngrInit</a> <span class="c_punctuation">()</span> </td> </tr> <tr> -<td><font><span class="RETURNVALUE">int</span></font></td> -<td> -<a href="xmlsec-gcrypt-app.html#XMLSECGCRYPTAPPDEFAULTKEYSMNGRADOPTKEY">xmlSecGCryptAppDefaultKeysMngrAdoptKey</a> <span class="c_punctuation"><span class="PHRASE">()</span></span> +<td class="function_type"> +<font><span class="returnvalue">int</span></font> +</td> +<td class="function_name"> +<a class="link" href="xmlsec-gcrypt-app.html#xmlSecGCryptAppDefaultKeysMngrAdoptKey" title="xmlSecGCryptAppDefaultKeysMngrAdoptKey ()">xmlSecGCryptAppDefaultKeysMngrAdoptKey</a> <span class="c_punctuation">()</span> </td> </tr> <tr> -<td><font><span class="RETURNVALUE">int</span></font></td> -<td> -<a href="xmlsec-gcrypt-app.html#XMLSECGCRYPTAPPDEFAULTKEYSMNGRLOAD">xmlSecGCryptAppDefaultKeysMngrLoad</a> <span class="c_punctuation"><span class="PHRASE">()</span></span> +<td class="function_type"> +<font><span class="returnvalue">int</span></font> +</td> +<td class="function_name"> +<a class="link" href="xmlsec-gcrypt-app.html#xmlSecGCryptAppDefaultKeysMngrLoad" title="xmlSecGCryptAppDefaultKeysMngrLoad ()">xmlSecGCryptAppDefaultKeysMngrLoad</a> <span class="c_punctuation">()</span> </td> </tr> <tr> -<td><font><span class="RETURNVALUE">int</span></font></td> -<td> -<a href="xmlsec-gcrypt-app.html#XMLSECGCRYPTAPPDEFAULTKEYSMNGRSAVE">xmlSecGCryptAppDefaultKeysMngrSave</a> <span class="c_punctuation"><span class="PHRASE">()</span></span> +<td class="function_type"> +<font><span class="returnvalue">int</span></font> +</td> +<td class="function_name"> +<a class="link" href="xmlsec-gcrypt-app.html#xmlSecGCryptAppDefaultKeysMngrSave" title="xmlSecGCryptAppDefaultKeysMngrSave ()">xmlSecGCryptAppDefaultKeysMngrSave</a> <span class="c_punctuation">()</span> </td> </tr> <tr> -<td><font><span class="RETURNVALUE">int</span></font></td> -<td> -<a href="xmlsec-gcrypt-app.html#XMLSECGCRYPTAPPKEYSMNGRCERTLOAD">xmlSecGCryptAppKeysMngrCertLoad</a> <span class="c_punctuation"><span class="PHRASE">()</span></span> +<td class="function_type"> +<font><span class="returnvalue">int</span></font> +</td> +<td class="function_name"> +<a class="link" href="xmlsec-gcrypt-app.html#xmlSecGCryptAppKeysMngrCertLoad" title="xmlSecGCryptAppKeysMngrCertLoad ()">xmlSecGCryptAppKeysMngrCertLoad</a> <span class="c_punctuation">()</span> </td> </tr> <tr> -<td><font><span class="RETURNVALUE">int</span></font></td> -<td> -<a href="xmlsec-gcrypt-app.html#XMLSECGCRYPTAPPKEYSMNGRCERTLOADMEMORY">xmlSecGCryptAppKeysMngrCertLoadMemory</a> <span class="c_punctuation"><span class="PHRASE">()</span></span> +<td class="function_type"> +<font><span class="returnvalue">int</span></font> +</td> +<td class="function_name"> +<a class="link" href="xmlsec-gcrypt-app.html#xmlSecGCryptAppKeysMngrCertLoadMemory" title="xmlSecGCryptAppKeysMngrCertLoadMemory ()">xmlSecGCryptAppKeysMngrCertLoadMemory</a> <span class="c_punctuation">()</span> </td> </tr> <tr> -<td><a href="xmlsec-keys.html#XMLSECKEY"><span class="RETURNVALUE">xmlSecKeyPtr</span></a></td> -<td> -<a href="xmlsec-gcrypt-app.html#XMLSECGCRYPTAPPKEYLOAD">xmlSecGCryptAppKeyLoad</a> <span class="c_punctuation"><span class="PHRASE">()</span></span> +<td class="function_type"> +<a class="link" href="xmlsec-keys.html#xmlSecKey" title="struct xmlSecKey"><span class="returnvalue">xmlSecKeyPtr</span></a> +</td> +<td class="function_name"> +<a class="link" href="xmlsec-gcrypt-app.html#xmlSecGCryptAppKeyLoad" title="xmlSecGCryptAppKeyLoad ()">xmlSecGCryptAppKeyLoad</a> <span class="c_punctuation">()</span> </td> </tr> <tr> -<td><a href="xmlsec-keys.html#XMLSECKEY"><span class="RETURNVALUE">xmlSecKeyPtr</span></a></td> -<td> -<a href="xmlsec-gcrypt-app.html#XMLSECGCRYPTAPPKEYLOADMEMORY">xmlSecGCryptAppKeyLoadMemory</a> <span class="c_punctuation"><span class="PHRASE">()</span></span> +<td class="function_type"> +<a class="link" href="xmlsec-keys.html#xmlSecKey" title="struct xmlSecKey"><span class="returnvalue">xmlSecKeyPtr</span></a> +</td> +<td class="function_name"> +<a class="link" href="xmlsec-gcrypt-app.html#xmlSecGCryptAppKeyLoadMemory" title="xmlSecGCryptAppKeyLoadMemory ()">xmlSecGCryptAppKeyLoadMemory</a> <span class="c_punctuation">()</span> </td> </tr> <tr> -<td><a href="xmlsec-keys.html#XMLSECKEY"><span class="RETURNVALUE">xmlSecKeyPtr</span></a></td> -<td> -<a href="xmlsec-gcrypt-app.html#XMLSECGCRYPTAPPPKCS12LOAD">xmlSecGCryptAppPkcs12Load</a> <span class="c_punctuation"><span class="PHRASE">()</span></span> +<td class="function_type"> +<a class="link" href="xmlsec-keys.html#xmlSecKey" title="struct xmlSecKey"><span class="returnvalue">xmlSecKeyPtr</span></a> +</td> +<td class="function_name"> +<a class="link" href="xmlsec-gcrypt-app.html#xmlSecGCryptAppPkcs12Load" title="xmlSecGCryptAppPkcs12Load ()">xmlSecGCryptAppPkcs12Load</a> <span class="c_punctuation">()</span> </td> </tr> <tr> -<td><a href="xmlsec-keys.html#XMLSECKEY"><span class="RETURNVALUE">xmlSecKeyPtr</span></a></td> -<td> -<a href="xmlsec-gcrypt-app.html#XMLSECGCRYPTAPPPKCS12LOADMEMORY">xmlSecGCryptAppPkcs12LoadMemory</a> <span class="c_punctuation"><span class="PHRASE">()</span></span> +<td class="function_type"> +<a class="link" href="xmlsec-keys.html#xmlSecKey" title="struct xmlSecKey"><span class="returnvalue">xmlSecKeyPtr</span></a> +</td> +<td class="function_name"> +<a class="link" href="xmlsec-gcrypt-app.html#xmlSecGCryptAppPkcs12LoadMemory" title="xmlSecGCryptAppPkcs12LoadMemory ()">xmlSecGCryptAppPkcs12LoadMemory</a> <span class="c_punctuation">()</span> </td> </tr> <tr> -<td><font><span class="RETURNVALUE">int</span></font></td> -<td> -<a href="xmlsec-gcrypt-app.html#XMLSECGCRYPTAPPKEYCERTLOAD">xmlSecGCryptAppKeyCertLoad</a> <span class="c_punctuation"><span class="PHRASE">()</span></span> +<td class="function_type"> +<font><span class="returnvalue">int</span></font> +</td> +<td class="function_name"> +<a class="link" href="xmlsec-gcrypt-app.html#xmlSecGCryptAppKeyCertLoad" title="xmlSecGCryptAppKeyCertLoad ()">xmlSecGCryptAppKeyCertLoad</a> <span class="c_punctuation">()</span> </td> </tr> <tr> -<td><font><span class="RETURNVALUE">int</span></font></td> -<td> -<a href="xmlsec-gcrypt-app.html#XMLSECGCRYPTAPPKEYCERTLOADMEMORY">xmlSecGCryptAppKeyCertLoadMemory</a> <span class="c_punctuation"><span class="PHRASE">()</span></span> +<td class="function_type"> +<font><span class="returnvalue">int</span></font> +</td> +<td class="function_name"> +<a class="link" href="xmlsec-gcrypt-app.html#xmlSecGCryptAppKeyCertLoadMemory" title="xmlSecGCryptAppKeyCertLoadMemory ()">xmlSecGCryptAppKeyCertLoadMemory</a> <span class="c_punctuation">()</span> </td> </tr> <tr> -<td> -<font><span class="RETURNVALUE">void</span></font> *</td> -<td> -<a href="xmlsec-gcrypt-app.html#XMLSECGCRYPTAPPGETDEFAULTPWDCALLBACK">xmlSecGCryptAppGetDefaultPwdCallback</a> <span class="c_punctuation"><span class="PHRASE">()</span></span> +<td class="function_type"> +<font><span class="returnvalue">void</span></font> * +</td> +<td class="function_name"> +<a class="link" href="xmlsec-gcrypt-app.html#xmlSecGCryptAppGetDefaultPwdCallback" title="xmlSecGCryptAppGetDefaultPwdCallback ()">xmlSecGCryptAppGetDefaultPwdCallback</a> <span class="c_punctuation">()</span> </td> </tr> </tbody> -</table> -<p></p> +</table></div> </div> +<div class="refsect1"> +<a name="xmlsec-gcrypt-app.description"></a><h2>Description</h2> +<p></p> </div> -<div class="REFSECT1"> -<a name="XMLSEC-GCRYPT-APP.DESCRIPTION"></a><h2>Description</h2> -<p>Application functions implementation for GCrypt.</p> -</div> -<div class="REFSECT1"> -<a name="XMLSEC-GCRYPT-APP.FUNCTIONS_DETAILS"></a><h2>Functions</h2> -<div class="REFSECT2"> -<a name="XMLSECGCRYPTAPPINIT"></a><h3>xmlSecGCryptAppInit ()</h3> -<pre class="PROGRAMLISTING"><font><span class="RETURNVALUE">int</span></font> -xmlSecGCryptAppInit (<code class="PARAMETER">const <font><span class="TYPE">char</span></font> *config</code>);</pre> +<div class="refsect1"> +<a name="xmlsec-gcrypt-app.functions_details"></a><h2>Functions</h2> +<div class="refsect2"> +<a name="xmlSecGCryptAppInit"></a><h3>xmlSecGCryptAppInit ()</h3> +<pre class="programlisting"><font><span class="returnvalue">int</span></font> +xmlSecGCryptAppInit (<em class="parameter"><code>const <font><span class="type">char</span></font> *config</code></em>);</pre> <p>General crypto engine initialization. This function is used by XMLSec command line utility and called before -<code class="PARAMETER">xmlSecInit</code> +<em class="parameter"><code>xmlSecInit</code></em> function.</p> -<div class="REFSECT3"> -<a name="AEN36127"></a><h4>Parameters</h4> -<div class="INFORMALTABLE"> -<p></p> -<a name="AEN36129"></a><table border="0" frame="void" width="100%" class="CALSTABLE"> +<div class="refsect3"> +<a name="xmlSecGCryptAppInit.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> <col> <col> <col> +</colgroup> <tbody><tr> -<td><p>config</p></td> -<td><p>the path to GCrypt configuration (unused).</p></td> -<td> </td> +<td class="parameter_name"><p>config</p></td> +<td class="parameter_description"><p>the path to GCrypt configuration (unused).</p></td> +<td class="parameter_annotations"> </td> </tr></tbody> -</table> -<p></p> +</table></div> </div> -</div> -<div class="REFSECT3"> -<a name="AEN36138"></a><h4>Returns</h4> +<div class="refsect3"> +<a name="xmlSecGCryptAppInit.returns"></a><h4>Returns</h4> <p> 0 on success or a negative value otherwise.</p> </div> </div> <hr> -<div class="REFSECT2"> -<a name="XMLSECGCRYPTAPPSHUTDOWN"></a><h3>xmlSecGCryptAppShutdown ()</h3> -<pre class="PROGRAMLISTING"><font><span class="RETURNVALUE">int</span></font> -xmlSecGCryptAppShutdown (<code class="PARAMETER"><span class="TYPE">void</span></code>);</pre> +<div class="refsect2"> +<a name="xmlSecGCryptAppShutdown"></a><h3>xmlSecGCryptAppShutdown ()</h3> +<pre class="programlisting"><font><span class="returnvalue">int</span></font> +xmlSecGCryptAppShutdown (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> <p>General crypto engine shutdown. This function is used by XMLSec command line utility and called after -<code class="PARAMETER">xmlSecShutdown</code> +<em class="parameter"><code>xmlSecShutdown</code></em> function.</p> -<div class="REFSECT3"> -<a name="AEN36152"></a><h4>Returns</h4> +<div class="refsect3"> +<a name="xmlSecGCryptAppShutdown.returns"></a><h4>Returns</h4> <p> 0 on success or a negative value otherwise.</p> </div> </div> <hr> -<div class="REFSECT2"> -<a name="XMLSECGCRYPTAPPDEFAULTKEYSMNGRINIT"></a><h3>xmlSecGCryptAppDefaultKeysMngrInit ()</h3> -<pre class="PROGRAMLISTING"><font><span class="RETURNVALUE">int</span></font> -xmlSecGCryptAppDefaultKeysMngrInit (<code class="PARAMETER"><a href="xmlsec-keysmngr.html#XMLSECKEYSMNGR"><span class="TYPE">xmlSecKeysMngrPtr</span></a> mngr</code>);</pre> -<p>Initializes <code class="PARAMETER">mngr</code> - with simple keys store <a href="xmlsec-keysmngr.html#XMLSECSIMPLEKEYSSTOREID"><span class="TYPE">xmlSecSimpleKeysStoreId</span></a> +<div class="refsect2"> +<a name="xmlSecGCryptAppDefaultKeysMngrInit"></a><h3>xmlSecGCryptAppDefaultKeysMngrInit ()</h3> +<pre class="programlisting"><font><span class="returnvalue">int</span></font> +xmlSecGCryptAppDefaultKeysMngrInit (<em class="parameter"><code><a class="link" href="xmlsec-keysmngr.html#xmlSecKeysMngr" title="struct xmlSecKeysMngr"><span class="type">xmlSecKeysMngrPtr</span></a> mngr</code></em>);</pre> +<p>Initializes <em class="parameter"><code>mngr</code></em> + with simple keys store <a class="link" href="xmlsec-keysmngr.html#xmlSecSimpleKeysStoreId" title="xmlSecSimpleKeysStoreId"><span class="type">xmlSecSimpleKeysStoreId</span></a> and a default GCrypt crypto key data stores.</p> -<div class="REFSECT3"> -<a name="AEN36169"></a><h4>Parameters</h4> -<div class="INFORMALTABLE"> -<p></p> -<a name="AEN36171"></a><table border="0" frame="void" width="100%" class="CALSTABLE"> +<div class="refsect3"> +<a name="xmlSecGCryptAppDefaultKeysMngrInit.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> <col> <col> <col> +</colgroup> <tbody><tr> -<td><p>mngr</p></td> -<td><p>the pointer to keys manager.</p></td> -<td> </td> +<td class="parameter_name"><p>mngr</p></td> +<td class="parameter_description"><p>the pointer to keys manager.</p></td> +<td class="parameter_annotations"> </td> </tr></tbody> -</table> -<p></p> -</div> +</table></div> </div> -<div class="REFSECT3"> -<a name="AEN36180"></a><h4>Returns</h4> +<div class="refsect3"> +<a name="xmlSecGCryptAppDefaultKeysMngrInit.returns"></a><h4>Returns</h4> <p> 0 on success or a negative value otherwise.</p> </div> </div> <hr> -<div class="REFSECT2"> -<a name="XMLSECGCRYPTAPPDEFAULTKEYSMNGRADOPTKEY"></a><h3>xmlSecGCryptAppDefaultKeysMngrAdoptKey ()</h3> -<pre class="PROGRAMLISTING"><font><span class="RETURNVALUE">int</span></font> +<div class="refsect2"> +<a name="xmlSecGCryptAppDefaultKeysMngrAdoptKey"></a><h3>xmlSecGCryptAppDefaultKeysMngrAdoptKey ()</h3> +<pre class="programlisting"><font><span class="returnvalue">int</span></font> xmlSecGCryptAppDefaultKeysMngrAdoptKey - (<code class="PARAMETER"><a href="xmlsec-keysmngr.html#XMLSECKEYSMNGR"><span class="TYPE">xmlSecKeysMngrPtr</span></a> mngr</code>, - <code class="PARAMETER"><a href="xmlsec-keys.html#XMLSECKEY"><span class="TYPE">xmlSecKeyPtr</span></a> key</code>);</pre> -<p>Adds <code class="PARAMETER">key</code> - to the keys manager <code class="PARAMETER">mngr</code> - created with <a href="xmlsec-gcrypt-app.html#XMLSECGCRYPTAPPDEFAULTKEYSMNGRINIT"><span class="TYPE">xmlSecGCryptAppDefaultKeysMngrInit</span></a> + (<em class="parameter"><code><a class="link" href="xmlsec-keysmngr.html#xmlSecKeysMngr" title="struct xmlSecKeysMngr"><span class="type">xmlSecKeysMngrPtr</span></a> mngr</code></em>, + <em class="parameter"><code><a class="link" href="xmlsec-keys.html#xmlSecKey" title="struct xmlSecKey"><span class="type">xmlSecKeyPtr</span></a> key</code></em>);</pre> +<p>Adds <em class="parameter"><code>key</code></em> + to the keys manager <em class="parameter"><code>mngr</code></em> + created with <a class="link" href="xmlsec-gcrypt-app.html#xmlSecGCryptAppDefaultKeysMngrInit" title="xmlSecGCryptAppDefaultKeysMngrInit ()"><span class="type">xmlSecGCryptAppDefaultKeysMngrInit</span></a> function.</p> -<div class="REFSECT3"> -<a name="AEN36201"></a><h4>Parameters</h4> -<div class="INFORMALTABLE"> -<p></p> -<a name="AEN36203"></a><table border="0" frame="void" width="100%" class="CALSTABLE"> +<div class="refsect3"> +<a name="xmlSecGCryptAppDefaultKeysMngrAdoptKey.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> <col> <col> <col> +</colgroup> <tbody> <tr> -<td><p>mngr</p></td> -<td><p>the pointer to keys manager.</p></td> -<td> </td> +<td class="parameter_name"><p>mngr</p></td> +<td class="parameter_description"><p>the pointer to keys manager.</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p>key</p></td> -<td><p>the pointer to key.</p></td> -<td> </td> +<td class="parameter_name"><p>key</p></td> +<td class="parameter_description"><p>the pointer to key.</p></td> +<td class="parameter_annotations"> </td> </tr> </tbody> -</table> -<p></p> +</table></div> </div> -</div> -<div class="REFSECT3"> -<a name="AEN36218"></a><h4>Returns</h4> +<div class="refsect3"> +<a name="xmlSecGCryptAppDefaultKeysMngrAdoptKey.returns"></a><h4>Returns</h4> <p> 0 on success or a negative value otherwise.</p> </div> </div> <hr> -<div class="REFSECT2"> -<a name="XMLSECGCRYPTAPPDEFAULTKEYSMNGRLOAD"></a><h3>xmlSecGCryptAppDefaultKeysMngrLoad ()</h3> -<pre class="PROGRAMLISTING"><font><span class="RETURNVALUE">int</span></font> -xmlSecGCryptAppDefaultKeysMngrLoad (<code class="PARAMETER"><a href="xmlsec-keysmngr.html#XMLSECKEYSMNGR"><span class="TYPE">xmlSecKeysMngrPtr</span></a> mngr</code>, - <code class="PARAMETER">const <font><span class="TYPE">char</span></font> *uri</code>);</pre> -<p>Loads XML keys file from <code class="PARAMETER">uri</code> - to the keys manager <code class="PARAMETER">mngr</code> +<div class="refsect2"> +<a name="xmlSecGCryptAppDefaultKeysMngrLoad"></a><h3>xmlSecGCryptAppDefaultKeysMngrLoad ()</h3> +<pre class="programlisting"><font><span class="returnvalue">int</span></font> +xmlSecGCryptAppDefaultKeysMngrLoad (<em class="parameter"><code><a class="link" href="xmlsec-keysmngr.html#xmlSecKeysMngr" title="struct xmlSecKeysMngr"><span class="type">xmlSecKeysMngrPtr</span></a> mngr</code></em>, + <em class="parameter"><code>const <font><span class="type">char</span></font> *uri</code></em>);</pre> +<p>Loads XML keys file from <em class="parameter"><code>uri</code></em> + to the keys manager <em class="parameter"><code>mngr</code></em> created -with <a href="xmlsec-gcrypt-app.html#XMLSECGCRYPTAPPDEFAULTKEYSMNGRINIT"><span class="TYPE">xmlSecGCryptAppDefaultKeysMngrInit</span></a> function.</p> -<div class="REFSECT3"> -<a name="AEN36239"></a><h4>Parameters</h4> -<div class="INFORMALTABLE"> -<p></p> -<a name="AEN36241"></a><table border="0" frame="void" width="100%" class="CALSTABLE"> +with <a class="link" href="xmlsec-gcrypt-app.html#xmlSecGCryptAppDefaultKeysMngrInit" title="xmlSecGCryptAppDefaultKeysMngrInit ()"><span class="type">xmlSecGCryptAppDefaultKeysMngrInit</span></a> function.</p> +<div class="refsect3"> +<a name="xmlSecGCryptAppDefaultKeysMngrLoad.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> <col> <col> <col> +</colgroup> <tbody> <tr> -<td><p>mngr</p></td> -<td><p>the pointer to keys manager.</p></td> -<td> </td> +<td class="parameter_name"><p>mngr</p></td> +<td class="parameter_description"><p>the pointer to keys manager.</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p>uri</p></td> -<td><p>the uri.</p></td> -<td> </td> +<td class="parameter_name"><p>uri</p></td> +<td class="parameter_description"><p>the uri.</p></td> +<td class="parameter_annotations"> </td> </tr> </tbody> -</table> -<p></p> +</table></div> </div> -</div> -<div class="REFSECT3"> -<a name="AEN36256"></a><h4>Returns</h4> +<div class="refsect3"> +<a name="xmlSecGCryptAppDefaultKeysMngrLoad.returns"></a><h4>Returns</h4> <p> 0 on success or a negative value otherwise.</p> </div> </div> <hr> -<div class="REFSECT2"> -<a name="XMLSECGCRYPTAPPDEFAULTKEYSMNGRSAVE"></a><h3>xmlSecGCryptAppDefaultKeysMngrSave ()</h3> -<pre class="PROGRAMLISTING"><font><span class="RETURNVALUE">int</span></font> -xmlSecGCryptAppDefaultKeysMngrSave (<code class="PARAMETER"><a href="xmlsec-keysmngr.html#XMLSECKEYSMNGR"><span class="TYPE">xmlSecKeysMngrPtr</span></a> mngr</code>, - <code class="PARAMETER">const <font><span class="TYPE">char</span></font> *filename</code>, - <code class="PARAMETER"><a href="xmlsec-keysdata.html#XMLSECKEYDATATYPE"><span class="TYPE">xmlSecKeyDataType</span></a> type</code>);</pre> -<p>Saves keys from <code class="PARAMETER">mngr</code> +<div class="refsect2"> +<a name="xmlSecGCryptAppDefaultKeysMngrSave"></a><h3>xmlSecGCryptAppDefaultKeysMngrSave ()</h3> +<pre class="programlisting"><font><span class="returnvalue">int</span></font> +xmlSecGCryptAppDefaultKeysMngrSave (<em class="parameter"><code><a class="link" href="xmlsec-keysmngr.html#xmlSecKeysMngr" title="struct xmlSecKeysMngr"><span class="type">xmlSecKeysMngrPtr</span></a> mngr</code></em>, + <em class="parameter"><code>const <font><span class="type">char</span></font> *filename</code></em>, + <em class="parameter"><code><a class="link" href="xmlsec-keysdata.html#xmlSecKeyDataType" title="xmlSecKeyDataType"><span class="type">xmlSecKeyDataType</span></a> type</code></em>);</pre> +<p>Saves keys from <em class="parameter"><code>mngr</code></em> to XML keys file.</p> -<div class="REFSECT3"> -<a name="AEN36277"></a><h4>Parameters</h4> -<div class="INFORMALTABLE"> -<p></p> -<a name="AEN36279"></a><table border="0" frame="void" width="100%" class="CALSTABLE"> +<div class="refsect3"> +<a name="xmlSecGCryptAppDefaultKeysMngrSave.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> <col> <col> <col> +</colgroup> <tbody> <tr> -<td><p>mngr</p></td> -<td><p>the pointer to keys manager.</p></td> -<td> </td> +<td class="parameter_name"><p>mngr</p></td> +<td class="parameter_description"><p>the pointer to keys manager.</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p>filename</p></td> -<td><p>the destination filename.</p></td> -<td> </td> +<td class="parameter_name"><p>filename</p></td> +<td class="parameter_description"><p>the destination filename.</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p>type</p></td> -<td><p>the type of keys to save (public/private/symmetric).</p></td> -<td> </td> +<td class="parameter_name"><p>type</p></td> +<td class="parameter_description"><p>the type of keys to save (public/private/symmetric).</p></td> +<td class="parameter_annotations"> </td> </tr> </tbody> -</table> -<p></p> -</div> +</table></div> </div> -<div class="REFSECT3"> -<a name="AEN36300"></a><h4>Returns</h4> +<div class="refsect3"> +<a name="xmlSecGCryptAppDefaultKeysMngrSave.returns"></a><h4>Returns</h4> <p> 0 on success or a negative value otherwise.</p> </div> </div> <hr> -<div class="REFSECT2"> -<a name="XMLSECGCRYPTAPPKEYSMNGRCERTLOAD"></a><h3>xmlSecGCryptAppKeysMngrCertLoad ()</h3> -<pre class="PROGRAMLISTING"><font><span class="RETURNVALUE">int</span></font> -xmlSecGCryptAppKeysMngrCertLoad (<code class="PARAMETER"><a href="xmlsec-keysmngr.html#XMLSECKEYSMNGR"><span class="TYPE">xmlSecKeysMngrPtr</span></a> mngr</code>, - <code class="PARAMETER">const <font><span class="TYPE">char</span></font> *filename</code>, - <code class="PARAMETER"><a href="xmlsec-keysdata.html#XMLSECKEYDATAFORMAT"><span class="TYPE">xmlSecKeyDataFormat</span></a> format</code>, - <code class="PARAMETER"><a href="xmlsec-keysdata.html#XMLSECKEYDATATYPE"><span class="TYPE">xmlSecKeyDataType</span></a> type</code>);</pre> -<p>Reads cert from <code class="PARAMETER">filename</code> +<div class="refsect2"> +<a name="xmlSecGCryptAppKeysMngrCertLoad"></a><h3>xmlSecGCryptAppKeysMngrCertLoad ()</h3> +<pre class="programlisting"><font><span class="returnvalue">int</span></font> +xmlSecGCryptAppKeysMngrCertLoad (<em class="parameter"><code><a class="link" href="xmlsec-keysmngr.html#xmlSecKeysMngr" title="struct xmlSecKeysMngr"><span class="type">xmlSecKeysMngrPtr</span></a> mngr</code></em>, + <em class="parameter"><code>const <font><span class="type">char</span></font> *filename</code></em>, + <em class="parameter"><code><a class="link" href="xmlsec-keysdata.html#xmlSecKeyDataFormat" title="enum xmlSecKeyDataFormat"><span class="type">xmlSecKeyDataFormat</span></a> format</code></em>, + <em class="parameter"><code><a class="link" href="xmlsec-keysdata.html#xmlSecKeyDataType" title="xmlSecKeyDataType"><span class="type">xmlSecKeyDataType</span></a> type</code></em>);</pre> +<p>Reads cert from <em class="parameter"><code>filename</code></em> and adds to the list of trusted or known -untrusted certs in <code class="PARAMETER">store</code> +untrusted certs in <em class="parameter"><code>store</code></em> (not implemented yet).</p> -<div class="REFSECT3"> -<a name="AEN36325"></a><h4>Parameters</h4> -<div class="INFORMALTABLE"> -<p></p> -<a name="AEN36327"></a><table border="0" frame="void" width="100%" class="CALSTABLE"> +<div class="refsect3"> +<a name="xmlSecGCryptAppKeysMngrCertLoad.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> <col> <col> <col> +</colgroup> <tbody> <tr> -<td><p>mngr</p></td> -<td><p>the keys manager.</p></td> -<td> </td> +<td class="parameter_name"><p>mngr</p></td> +<td class="parameter_description"><p>the keys manager.</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p>filename</p></td> -<td><p>the certificate file.</p></td> -<td> </td> +<td class="parameter_name"><p>filename</p></td> +<td class="parameter_description"><p>the certificate file.</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p>format</p></td> -<td><p>the certificate file format.</p></td> -<td> </td> +<td class="parameter_name"><p>format</p></td> +<td class="parameter_description"><p>the certificate file format.</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p>type</p></td> -<td><p>the flag that indicates is the certificate in <code class="PARAMETER">filename</code> +<td class="parameter_name"><p>type</p></td> +<td class="parameter_description"><p>the flag that indicates is the certificate in <em class="parameter"><code>filename</code></em> trusted or not.</p></td> -<td> </td> +<td class="parameter_annotations"> </td> </tr> </tbody> -</table> -<p></p> +</table></div> </div> -</div> -<div class="REFSECT3"> -<a name="AEN36355"></a><h4>Returns</h4> +<div class="refsect3"> +<a name="xmlSecGCryptAppKeysMngrCertLoad.returns"></a><h4>Returns</h4> <p> 0 on success or a negative value otherwise.</p> </div> </div> <hr> -<div class="REFSECT2"> -<a name="XMLSECGCRYPTAPPKEYSMNGRCERTLOADMEMORY"></a><h3>xmlSecGCryptAppKeysMngrCertLoadMemory ()</h3> -<pre class="PROGRAMLISTING"><font><span class="RETURNVALUE">int</span></font> -xmlSecGCryptAppKeysMngrCertLoadMemory (<code class="PARAMETER"><a href="xmlsec-keysmngr.html#XMLSECKEYSMNGR"><span class="TYPE">xmlSecKeysMngrPtr</span></a> mngr</code>, - <code class="PARAMETER">const <a href="xmlsec-xmlsec.html#XMLSECBYTE"><span class="TYPE">xmlSecByte</span></a> *data</code>, - <code class="PARAMETER"><a href="xmlsec-xmlsec.html#XMLSECSIZE"><span class="TYPE">xmlSecSize</span></a> dataSize</code>, - <code class="PARAMETER"><a href="xmlsec-keysdata.html#XMLSECKEYDATAFORMAT"><span class="TYPE">xmlSecKeyDataFormat</span></a> format</code>, - <code class="PARAMETER"><a href="xmlsec-keysdata.html#XMLSECKEYDATATYPE"><span class="TYPE">xmlSecKeyDataType</span></a> type</code>);</pre> -<p>Reads cert from binary buffer <code class="PARAMETER">data</code> +<div class="refsect2"> +<a name="xmlSecGCryptAppKeysMngrCertLoadMemory"></a><h3>xmlSecGCryptAppKeysMngrCertLoadMemory ()</h3> +<pre class="programlisting"><font><span class="returnvalue">int</span></font> +xmlSecGCryptAppKeysMngrCertLoadMemory (<em class="parameter"><code><a class="link" href="xmlsec-keysmngr.html#xmlSecKeysMngr" title="struct xmlSecKeysMngr"><span class="type">xmlSecKeysMngrPtr</span></a> mngr</code></em>, + <em class="parameter"><code>const <a class="link" href="xmlsec-xmlsec.html#xmlSecByte" title="xmlSecByte"><span class="type">xmlSecByte</span></a> *data</code></em>, + <em class="parameter"><code><a class="link" href="xmlsec-xmlsec.html#xmlSecSize" title="xmlSecSize"><span class="type">xmlSecSize</span></a> dataSize</code></em>, + <em class="parameter"><code><a class="link" href="xmlsec-keysdata.html#xmlSecKeyDataFormat" title="enum xmlSecKeyDataFormat"><span class="type">xmlSecKeyDataFormat</span></a> format</code></em>, + <em class="parameter"><code><a class="link" href="xmlsec-keysdata.html#xmlSecKeyDataType" title="xmlSecKeyDataType"><span class="type">xmlSecKeyDataType</span></a> type</code></em>);</pre> +<p>Reads cert from binary buffer <em class="parameter"><code>data</code></em> and adds to the list of trusted or known -untrusted certs in <code class="PARAMETER">store</code> +untrusted certs in <em class="parameter"><code>store</code></em> (not implemented yet).</p> -<div class="REFSECT3"> -<a name="AEN36383"></a><h4>Parameters</h4> -<div class="INFORMALTABLE"> -<p></p> -<a name="AEN36385"></a><table border="0" frame="void" width="100%" class="CALSTABLE"> +<div class="refsect3"> +<a name="xmlSecGCryptAppKeysMngrCertLoadMemory.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> <col> <col> <col> +</colgroup> <tbody> <tr> -<td><p>mngr</p></td> -<td><p>the keys manager.</p></td> -<td> </td> +<td class="parameter_name"><p>mngr</p></td> +<td class="parameter_description"><p>the keys manager.</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p>data</p></td> -<td><p>the certificate binary data.</p></td> -<td> </td> +<td class="parameter_name"><p>data</p></td> +<td class="parameter_description"><p>the certificate binary data.</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p>dataSize</p></td> -<td><p>the certificate binary data size.</p></td> -<td> </td> +<td class="parameter_name"><p>dataSize</p></td> +<td class="parameter_description"><p>the certificate binary data size.</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p>format</p></td> -<td><p>the certificate file format.</p></td> -<td> </td> +<td class="parameter_name"><p>format</p></td> +<td class="parameter_description"><p>the certificate file format.</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p>type</p></td> -<td><p>the flag that indicates is the certificate trusted or not.</p></td> -<td> </td> +<td class="parameter_name"><p>type</p></td> +<td class="parameter_description"><p>the flag that indicates is the certificate trusted or not.</p></td> +<td class="parameter_annotations"> </td> </tr> </tbody> -</table> -<p></p> -</div> +</table></div> </div> -<div class="REFSECT3"> -<a name="AEN36418"></a><h4>Returns</h4> +<div class="refsect3"> +<a name="xmlSecGCryptAppKeysMngrCertLoadMemory.returns"></a><h4>Returns</h4> <p> 0 on success or a negative value otherwise.</p> </div> </div> <hr> -<div class="REFSECT2"> -<a name="XMLSECGCRYPTAPPKEYLOAD"></a><h3>xmlSecGCryptAppKeyLoad ()</h3> -<pre class="PROGRAMLISTING"><a href="xmlsec-keys.html#XMLSECKEY"><span class="RETURNVALUE">xmlSecKeyPtr</span></a> -xmlSecGCryptAppKeyLoad (<code class="PARAMETER">const <font><span class="TYPE">char</span></font> *filename</code>, - <code class="PARAMETER"><a href="xmlsec-keysdata.html#XMLSECKEYDATAFORMAT"><span class="TYPE">xmlSecKeyDataFormat</span></a> format</code>, - <code class="PARAMETER">const <font><span class="TYPE">char</span></font> *pwd</code>, - <code class="PARAMETER"><font><span class="TYPE">void</span></font> *pwdCallback</code>, - <code class="PARAMETER"><font><span class="TYPE">void</span></font> *pwdCallbackCtx</code>);</pre> +<div class="refsect2"> +<a name="xmlSecGCryptAppKeyLoad"></a><h3>xmlSecGCryptAppKeyLoad ()</h3> +<pre class="programlisting"><a class="link" href="xmlsec-keys.html#xmlSecKey" title="struct xmlSecKey"><span class="returnvalue">xmlSecKeyPtr</span></a> +xmlSecGCryptAppKeyLoad (<em class="parameter"><code>const <font><span class="type">char</span></font> *filename</code></em>, + <em class="parameter"><code><a class="link" href="xmlsec-keysdata.html#xmlSecKeyDataFormat" title="enum xmlSecKeyDataFormat"><span class="type">xmlSecKeyDataFormat</span></a> format</code></em>, + <em class="parameter"><code>const <font><span class="type">char</span></font> *pwd</code></em>, + <em class="parameter"><code><font><span class="type">void</span></font> *pwdCallback</code></em>, + <em class="parameter"><code><font><span class="type">void</span></font> *pwdCallbackCtx</code></em>);</pre> <p>Reads key from the a file.</p> -<div class="REFSECT3"> -<a name="AEN36444"></a><h4>Parameters</h4> -<div class="INFORMALTABLE"> -<p></p> -<a name="AEN36446"></a><table border="0" frame="void" width="100%" class="CALSTABLE"> +<div class="refsect3"> +<a name="xmlSecGCryptAppKeyLoad.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> <col> <col> <col> +</colgroup> <tbody> <tr> -<td><p>filename</p></td> -<td><p>the key filename.</p></td> -<td> </td> +<td class="parameter_name"><p>filename</p></td> +<td class="parameter_description"><p>the key filename.</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p>format</p></td> -<td><p>the key file format.</p></td> -<td> </td> +<td class="parameter_name"><p>format</p></td> +<td class="parameter_description"><p>the key file format.</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p>pwd</p></td> -<td><p>the key file password.</p></td> -<td> </td> +<td class="parameter_name"><p>pwd</p></td> +<td class="parameter_description"><p>the key file password.</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p>pwdCallback</p></td> -<td><p>the key password callback.</p></td> -<td> </td> +<td class="parameter_name"><p>pwdCallback</p></td> +<td class="parameter_description"><p>the key password callback.</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p>pwdCallbackCtx</p></td> -<td><p>the user context for password callback.</p></td> -<td> </td> +<td class="parameter_name"><p>pwdCallbackCtx</p></td> +<td class="parameter_description"><p>the user context for password callback.</p></td> +<td class="parameter_annotations"> </td> </tr> </tbody> -</table> -<p></p> +</table></div> </div> -</div> -<div class="REFSECT3"> -<a name="AEN36479"></a><h4>Returns</h4> +<div class="refsect3"> +<a name="xmlSecGCryptAppKeyLoad.returns"></a><h4>Returns</h4> <p> pointer to the key or NULL if an error occurs.</p> </div> </div> <hr> -<div class="REFSECT2"> -<a name="XMLSECGCRYPTAPPKEYLOADMEMORY"></a><h3>xmlSecGCryptAppKeyLoadMemory ()</h3> -<pre class="PROGRAMLISTING"><a href="xmlsec-keys.html#XMLSECKEY"><span class="RETURNVALUE">xmlSecKeyPtr</span></a> -xmlSecGCryptAppKeyLoadMemory (<code class="PARAMETER">const <a href="xmlsec-xmlsec.html#XMLSECBYTE"><span class="TYPE">xmlSecByte</span></a> *data</code>, - <code class="PARAMETER"><a href="xmlsec-xmlsec.html#XMLSECSIZE"><span class="TYPE">xmlSecSize</span></a> dataSize</code>, - <code class="PARAMETER"><a href="xmlsec-keysdata.html#XMLSECKEYDATAFORMAT"><span class="TYPE">xmlSecKeyDataFormat</span></a> format</code>, - <code class="PARAMETER">const <font><span class="TYPE">char</span></font> *pwd</code>, - <code class="PARAMETER"><font><span class="TYPE">void</span></font> *pwdCallback</code>, - <code class="PARAMETER"><font><span class="TYPE">void</span></font> *pwdCallbackCtx</code>);</pre> +<div class="refsect2"> +<a name="xmlSecGCryptAppKeyLoadMemory"></a><h3>xmlSecGCryptAppKeyLoadMemory ()</h3> +<pre class="programlisting"><a class="link" href="xmlsec-keys.html#xmlSecKey" title="struct xmlSecKey"><span class="returnvalue">xmlSecKeyPtr</span></a> +xmlSecGCryptAppKeyLoadMemory (<em class="parameter"><code>const <a class="link" href="xmlsec-xmlsec.html#xmlSecByte" title="xmlSecByte"><span class="type">xmlSecByte</span></a> *data</code></em>, + <em class="parameter"><code><a class="link" href="xmlsec-xmlsec.html#xmlSecSize" title="xmlSecSize"><span class="type">xmlSecSize</span></a> dataSize</code></em>, + <em class="parameter"><code><a class="link" href="xmlsec-keysdata.html#xmlSecKeyDataFormat" title="enum xmlSecKeyDataFormat"><span class="type">xmlSecKeyDataFormat</span></a> format</code></em>, + <em class="parameter"><code>const <font><span class="type">char</span></font> *pwd</code></em>, + <em class="parameter"><code><font><span class="type">void</span></font> *pwdCallback</code></em>, + <em class="parameter"><code><font><span class="type">void</span></font> *pwdCallbackCtx</code></em>);</pre> <p>Reads key from the memory buffer.</p> -<div class="REFSECT3"> -<a name="AEN36508"></a><h4>Parameters</h4> -<div class="INFORMALTABLE"> -<p></p> -<a name="AEN36510"></a><table border="0" frame="void" width="100%" class="CALSTABLE"> +<div class="refsect3"> +<a name="xmlSecGCryptAppKeyLoadMemory.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> <col> <col> <col> +</colgroup> <tbody> <tr> -<td><p>data</p></td> -<td><p>the binary key data.</p></td> -<td> </td> +<td class="parameter_name"><p>data</p></td> +<td class="parameter_description"><p>the binary key data.</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p>dataSize</p></td> -<td><p>the size of binary key.</p></td> -<td> </td> +<td class="parameter_name"><p>dataSize</p></td> +<td class="parameter_description"><p>the size of binary key.</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p>format</p></td> -<td><p>the key file format.</p></td> -<td> </td> +<td class="parameter_name"><p>format</p></td> +<td class="parameter_description"><p>the key file format.</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p>pwd</p></td> -<td><p>the key file password.</p></td> -<td> </td> +<td class="parameter_name"><p>pwd</p></td> +<td class="parameter_description"><p>the key file password.</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p>pwdCallback</p></td> -<td><p>the key password callback.</p></td> -<td> </td> +<td class="parameter_name"><p>pwdCallback</p></td> +<td class="parameter_description"><p>the key password callback.</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p>pwdCallbackCtx</p></td> -<td><p>the user context for password callback.</p></td> -<td> </td> +<td class="parameter_name"><p>pwdCallbackCtx</p></td> +<td class="parameter_description"><p>the user context for password callback.</p></td> +<td class="parameter_annotations"> </td> </tr> </tbody> -</table> -<p></p> -</div> +</table></div> </div> -<div class="REFSECT3"> -<a name="AEN36549"></a><h4>Returns</h4> +<div class="refsect3"> +<a name="xmlSecGCryptAppKeyLoadMemory.returns"></a><h4>Returns</h4> <p> pointer to the key or NULL if an error occurs.</p> </div> </div> <hr> -<div class="REFSECT2"> -<a name="XMLSECGCRYPTAPPPKCS12LOAD"></a><h3>xmlSecGCryptAppPkcs12Load ()</h3> -<pre class="PROGRAMLISTING"><a href="xmlsec-keys.html#XMLSECKEY"><span class="RETURNVALUE">xmlSecKeyPtr</span></a> -xmlSecGCryptAppPkcs12Load (<code class="PARAMETER">const <font><span class="TYPE">char</span></font> *filename</code>, - <code class="PARAMETER">const <font><span class="TYPE">char</span></font> *pwd</code>, - <code class="PARAMETER"><font><span class="TYPE">void</span></font> *pwdCallback</code>, - <code class="PARAMETER"><font><span class="TYPE">void</span></font> *pwdCallbackCtx</code>);</pre> +<div class="refsect2"> +<a name="xmlSecGCryptAppPkcs12Load"></a><h3>xmlSecGCryptAppPkcs12Load ()</h3> +<pre class="programlisting"><a class="link" href="xmlsec-keys.html#xmlSecKey" title="struct xmlSecKey"><span class="returnvalue">xmlSecKeyPtr</span></a> +xmlSecGCryptAppPkcs12Load (<em class="parameter"><code>const <font><span class="type">char</span></font> *filename</code></em>, + <em class="parameter"><code>const <font><span class="type">char</span></font> *pwd</code></em>, + <em class="parameter"><code><font><span class="type">void</span></font> *pwdCallback</code></em>, + <em class="parameter"><code><font><span class="type">void</span></font> *pwdCallbackCtx</code></em>);</pre> <p>Reads key and all associated certificates from the PKCS12 file (not implemented yet). For uniformity, call xmlSecGCryptAppKeyLoad instead of this function. Pass in format=xmlSecKeyDataFormatPkcs12.</p> -<div class="REFSECT3"> -<a name="AEN36572"></a><h4>Parameters</h4> -<div class="INFORMALTABLE"> -<p></p> -<a name="AEN36574"></a><table border="0" frame="void" width="100%" class="CALSTABLE"> +<div class="refsect3"> +<a name="xmlSecGCryptAppPkcs12Load.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> <col> <col> <col> +</colgroup> <tbody> <tr> -<td><p>filename</p></td> -<td><p>the PKCS12 key filename.</p></td> -<td> </td> +<td class="parameter_name"><p>filename</p></td> +<td class="parameter_description"><p>the PKCS12 key filename.</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p>pwd</p></td> -<td><p>the PKCS12 file password.</p></td> -<td> </td> +<td class="parameter_name"><p>pwd</p></td> +<td class="parameter_description"><p>the PKCS12 file password.</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p>pwdCallback</p></td> -<td><p>the password callback.</p></td> -<td> </td> +<td class="parameter_name"><p>pwdCallback</p></td> +<td class="parameter_description"><p>the password callback.</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p>pwdCallbackCtx</p></td> -<td><p>the user context for password callback.</p></td> -<td> </td> +<td class="parameter_name"><p>pwdCallbackCtx</p></td> +<td class="parameter_description"><p>the user context for password callback.</p></td> +<td class="parameter_annotations"> </td> </tr> </tbody> -</table> -<p></p> +</table></div> </div> -</div> -<div class="REFSECT3"> -<a name="AEN36601"></a><h4>Returns</h4> +<div class="refsect3"> +<a name="xmlSecGCryptAppPkcs12Load.returns"></a><h4>Returns</h4> <p> pointer to the key or NULL if an error occurs.</p> </div> </div> <hr> -<div class="REFSECT2"> -<a name="XMLSECGCRYPTAPPPKCS12LOADMEMORY"></a><h3>xmlSecGCryptAppPkcs12LoadMemory ()</h3> -<pre class="PROGRAMLISTING"><a href="xmlsec-keys.html#XMLSECKEY"><span class="RETURNVALUE">xmlSecKeyPtr</span></a> -xmlSecGCryptAppPkcs12LoadMemory (<code class="PARAMETER">const <a href="xmlsec-xmlsec.html#XMLSECBYTE"><span class="TYPE">xmlSecByte</span></a> *data</code>, - <code class="PARAMETER"><a href="xmlsec-xmlsec.html#XMLSECSIZE"><span class="TYPE">xmlSecSize</span></a> dataSize</code>, - <code class="PARAMETER">const <font><span class="TYPE">char</span></font> *pwd</code>, - <code class="PARAMETER"><font><span class="TYPE">void</span></font> *pwdCallback</code>, - <code class="PARAMETER"><font><span class="TYPE">void</span></font> *pwdCallbackCtx</code>);</pre> +<div class="refsect2"> +<a name="xmlSecGCryptAppPkcs12LoadMemory"></a><h3>xmlSecGCryptAppPkcs12LoadMemory ()</h3> +<pre class="programlisting"><a class="link" href="xmlsec-keys.html#xmlSecKey" title="struct xmlSecKey"><span class="returnvalue">xmlSecKeyPtr</span></a> +xmlSecGCryptAppPkcs12LoadMemory (<em class="parameter"><code>const <a class="link" href="xmlsec-xmlsec.html#xmlSecByte" title="xmlSecByte"><span class="type">xmlSecByte</span></a> *data</code></em>, + <em class="parameter"><code><a class="link" href="xmlsec-xmlsec.html#xmlSecSize" title="xmlSecSize"><span class="type">xmlSecSize</span></a> dataSize</code></em>, + <em class="parameter"><code>const <font><span class="type">char</span></font> *pwd</code></em>, + <em class="parameter"><code><font><span class="type">void</span></font> *pwdCallback</code></em>, + <em class="parameter"><code><font><span class="type">void</span></font> *pwdCallbackCtx</code></em>);</pre> <p>Reads key and all associated certificates from the PKCS12 data in memory buffer. For uniformity, call xmlSecGCryptAppKeyLoadMemory instead of this function. Pass in format=xmlSecKeyDataFormatPkcs12 (not implemented yet).</p> -<div class="REFSECT3"> -<a name="AEN36627"></a><h4>Parameters</h4> -<div class="INFORMALTABLE"> -<p></p> -<a name="AEN36629"></a><table border="0" frame="void" width="100%" class="CALSTABLE"> +<div class="refsect3"> +<a name="xmlSecGCryptAppPkcs12LoadMemory.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> <col> <col> <col> +</colgroup> <tbody> <tr> -<td><p>data</p></td> -<td><p>the PKCS12 binary data.</p></td> -<td> </td> +<td class="parameter_name"><p>data</p></td> +<td class="parameter_description"><p>the PKCS12 binary data.</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p>dataSize</p></td> -<td><p>the PKCS12 binary data size.</p></td> -<td> </td> +<td class="parameter_name"><p>dataSize</p></td> +<td class="parameter_description"><p>the PKCS12 binary data size.</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p>pwd</p></td> -<td><p>the PKCS12 file password.</p></td> -<td> </td> +<td class="parameter_name"><p>pwd</p></td> +<td class="parameter_description"><p>the PKCS12 file password.</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p>pwdCallback</p></td> -<td><p>the password callback.</p></td> -<td> </td> +<td class="parameter_name"><p>pwdCallback</p></td> +<td class="parameter_description"><p>the password callback.</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p>pwdCallbackCtx</p></td> -<td><p>the user context for password callback.</p></td> -<td> </td> +<td class="parameter_name"><p>pwdCallbackCtx</p></td> +<td class="parameter_description"><p>the user context for password callback.</p></td> +<td class="parameter_annotations"> </td> </tr> </tbody> -</table> -<p></p> -</div> +</table></div> </div> -<div class="REFSECT3"> -<a name="AEN36662"></a><h4>Returns</h4> +<div class="refsect3"> +<a name="xmlSecGCryptAppPkcs12LoadMemory.returns"></a><h4>Returns</h4> <p> pointer to the key or NULL if an error occurs.</p> </div> </div> <hr> -<div class="REFSECT2"> -<a name="XMLSECGCRYPTAPPKEYCERTLOAD"></a><h3>xmlSecGCryptAppKeyCertLoad ()</h3> -<pre class="PROGRAMLISTING"><font><span class="RETURNVALUE">int</span></font> -xmlSecGCryptAppKeyCertLoad (<code class="PARAMETER"><a href="xmlsec-keys.html#XMLSECKEY"><span class="TYPE">xmlSecKeyPtr</span></a> key</code>, - <code class="PARAMETER">const <font><span class="TYPE">char</span></font> *filename</code>, - <code class="PARAMETER"><a href="xmlsec-keysdata.html#XMLSECKEYDATAFORMAT"><span class="TYPE">xmlSecKeyDataFormat</span></a> format</code>);</pre> -<p>Reads the certificate from $<code class="PARAMETER">filename</code> +<div class="refsect2"> +<a name="xmlSecGCryptAppKeyCertLoad"></a><h3>xmlSecGCryptAppKeyCertLoad ()</h3> +<pre class="programlisting"><font><span class="returnvalue">int</span></font> +xmlSecGCryptAppKeyCertLoad (<em class="parameter"><code><a class="link" href="xmlsec-keys.html#xmlSecKey" title="struct xmlSecKey"><span class="type">xmlSecKeyPtr</span></a> key</code></em>, + <em class="parameter"><code>const <font><span class="type">char</span></font> *filename</code></em>, + <em class="parameter"><code><a class="link" href="xmlsec-keysdata.html#xmlSecKeyDataFormat" title="enum xmlSecKeyDataFormat"><span class="type">xmlSecKeyDataFormat</span></a> format</code></em>);</pre> +<p>Reads the certificate from $<em class="parameter"><code>filename</code></em> and adds it to key (not implemented yet).</p> -<div class="REFSECT3"> -<a name="AEN36683"></a><h4>Parameters</h4> -<div class="INFORMALTABLE"> -<p></p> -<a name="AEN36685"></a><table border="0" frame="void" width="100%" class="CALSTABLE"> +<div class="refsect3"> +<a name="xmlSecGCryptAppKeyCertLoad.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> <col> <col> <col> +</colgroup> <tbody> <tr> -<td><p>key</p></td> -<td><p>the pointer to key.</p></td> -<td> </td> +<td class="parameter_name"><p>key</p></td> +<td class="parameter_description"><p>the pointer to key.</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p>filename</p></td> -<td><p>the certificate filename.</p></td> -<td> </td> +<td class="parameter_name"><p>filename</p></td> +<td class="parameter_description"><p>the certificate filename.</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p>format</p></td> -<td><p>the certificate file format.</p></td> -<td> </td> +<td class="parameter_name"><p>format</p></td> +<td class="parameter_description"><p>the certificate file format.</p></td> +<td class="parameter_annotations"> </td> </tr> </tbody> -</table> -<p></p> +</table></div> </div> -</div> -<div class="REFSECT3"> -<a name="AEN36706"></a><h4>Returns</h4> +<div class="refsect3"> +<a name="xmlSecGCryptAppKeyCertLoad.returns"></a><h4>Returns</h4> <p> 0 on success or a negative value otherwise.</p> </div> </div> <hr> -<div class="REFSECT2"> -<a name="XMLSECGCRYPTAPPKEYCERTLOADMEMORY"></a><h3>xmlSecGCryptAppKeyCertLoadMemory ()</h3> -<pre class="PROGRAMLISTING"><font><span class="RETURNVALUE">int</span></font> -xmlSecGCryptAppKeyCertLoadMemory (<code class="PARAMETER"><a href="xmlsec-keys.html#XMLSECKEY"><span class="TYPE">xmlSecKeyPtr</span></a> key</code>, - <code class="PARAMETER">const <a href="xmlsec-xmlsec.html#XMLSECBYTE"><span class="TYPE">xmlSecByte</span></a> *data</code>, - <code class="PARAMETER"><a href="xmlsec-xmlsec.html#XMLSECSIZE"><span class="TYPE">xmlSecSize</span></a> dataSize</code>, - <code class="PARAMETER"><a href="xmlsec-keysdata.html#XMLSECKEYDATAFORMAT"><span class="TYPE">xmlSecKeyDataFormat</span></a> format</code>);</pre> +<div class="refsect2"> +<a name="xmlSecGCryptAppKeyCertLoadMemory"></a><h3>xmlSecGCryptAppKeyCertLoadMemory ()</h3> +<pre class="programlisting"><font><span class="returnvalue">int</span></font> +xmlSecGCryptAppKeyCertLoadMemory (<em class="parameter"><code><a class="link" href="xmlsec-keys.html#xmlSecKey" title="struct xmlSecKey"><span class="type">xmlSecKeyPtr</span></a> key</code></em>, + <em class="parameter"><code>const <a class="link" href="xmlsec-xmlsec.html#xmlSecByte" title="xmlSecByte"><span class="type">xmlSecByte</span></a> *data</code></em>, + <em class="parameter"><code><a class="link" href="xmlsec-xmlsec.html#xmlSecSize" title="xmlSecSize"><span class="type">xmlSecSize</span></a> dataSize</code></em>, + <em class="parameter"><code><a class="link" href="xmlsec-keysdata.html#xmlSecKeyDataFormat" title="enum xmlSecKeyDataFormat"><span class="type">xmlSecKeyDataFormat</span></a> format</code></em>);</pre> <p>Reads the certificate from memory buffer and adds it to key (not implemented yet).</p> -<div class="REFSECT3"> -<a name="AEN36729"></a><h4>Parameters</h4> -<div class="INFORMALTABLE"> -<p></p> -<a name="AEN36731"></a><table border="0" frame="void" width="100%" class="CALSTABLE"> +<div class="refsect3"> +<a name="xmlSecGCryptAppKeyCertLoadMemory.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> <col> <col> <col> +</colgroup> <tbody> <tr> -<td><p>key</p></td> -<td><p>the pointer to key.</p></td> -<td> </td> +<td class="parameter_name"><p>key</p></td> +<td class="parameter_description"><p>the pointer to key.</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p>data</p></td> -<td><p>the certificate binary data.</p></td> -<td> </td> +<td class="parameter_name"><p>data</p></td> +<td class="parameter_description"><p>the certificate binary data.</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p>dataSize</p></td> -<td><p>the certificate binary data size.</p></td> -<td> </td> +<td class="parameter_name"><p>dataSize</p></td> +<td class="parameter_description"><p>the certificate binary data size.</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p>format</p></td> -<td><p>the certificate file format.</p></td> -<td> </td> +<td class="parameter_name"><p>format</p></td> +<td class="parameter_description"><p>the certificate file format.</p></td> +<td class="parameter_annotations"> </td> </tr> </tbody> -</table> -<p></p> -</div> +</table></div> </div> -<div class="REFSECT3"> -<a name="AEN36758"></a><h4>Returns</h4> +<div class="refsect3"> +<a name="xmlSecGCryptAppKeyCertLoadMemory.returns"></a><h4>Returns</h4> <p> 0 on success or a negative value otherwise.</p> </div> </div> <hr> -<div class="REFSECT2"> -<a name="XMLSECGCRYPTAPPGETDEFAULTPWDCALLBACK"></a><h3>xmlSecGCryptAppGetDefaultPwdCallback ()</h3> -<pre class="PROGRAMLISTING"><font><span class="RETURNVALUE">void</span></font> * -xmlSecGCryptAppGetDefaultPwdCallback (<code class="PARAMETER"><span class="TYPE">void</span></code>);</pre> +<div class="refsect2"> +<a name="xmlSecGCryptAppGetDefaultPwdCallback"></a><h3>xmlSecGCryptAppGetDefaultPwdCallback ()</h3> +<pre class="programlisting"><font><span class="returnvalue">void</span></font> * +xmlSecGCryptAppGetDefaultPwdCallback (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> <p>Gets default password callback.</p> -<div class="REFSECT3"> -<a name="AEN36771"></a><h4>Returns</h4> +<div class="refsect3"> +<a name="xmlSecGCryptAppGetDefaultPwdCallback.returns"></a><h4>Returns</h4> <p> default password callback.</p> </div> </div> </div> -<div class="REFSECT1"> -<a name="XMLSEC-GCRYPT-APP.OTHER_DETAILS"></a><h2>Types and Values</h2> +<div class="refsect1"> +<a name="xmlsec-gcrypt-app.other_details"></a><h2>Types and Values</h2> <p></p> </div> -<table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="2"><tr valign="middle"> -<td align="left"><a accesskey="p" href="xmlsec-gcrypt-ref.html"><b><<< XML Security Library for GCrypt API Reference.</b></a></td> -<td align="right"><a accesskey="n" href="xmlsec-gcrypt-crypto.html"><b>crypto >>></b></a></td> -</tr></table> -</td></tr></table></td> -</tr></table></body> +</div> +<div class="footer"> +<hr>Generated by GTK-Doc V1.27</div> +</body> </html> |