|
Server : Apache/2.2.17 (Unix) mod_ssl/2.2.17 OpenSSL/0.9.8e-fips-rhel5 DAV/2 PHP/5.2.17 System : Linux localhost 2.6.18-419.el5 #1 SMP Fri Feb 24 22:47:42 UTC 2017 x86_64 User : nobody ( 99) PHP Version : 5.2.17 Disable Function : NONE Directory : /proc/21585/root/usr/share/doc/xmlsec1/api/ |
Upload File : |
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>app</title>
<meta name="GENERATOR" content="Modular DocBook HTML Stylesheet Version 1.7">
<link rel="HOME" title="XML Security Library Reference Manual" href="index.html">
<link rel="UP" title="XML Security Library for MSCrypto API Reference." href="xmlsec-mscrypto-ref.html">
<link rel="PREVIOUS" title="XML Security Library for MSCrypto API Reference." href="xmlsec-mscrypto-ref.html">
<link rel="NEXT" title="certkeys" href="xmlsec-mscrypto-certkeys.html">
<meta name="GENERATOR" content="GTK-Doc V1.2 (SGML mode)">
<style type="text/css">.synopsis, .classsynopsis {
background: #eeeeee;
border: solid 1px #aaaaaa;
padding: 0.5em;
}
.programlisting {
background: #eeeeff;
border: solid 1px #aaaaff;
padding: 0.5em;
}
.variablelist {
padding: 4px;
margin-left: 3em;
}
.navigation {
background: #ffeeee;
border: solid 1px #ffaaaa;
margin-top: 0.5em;
margin-bottom: 0.5em;
}
.navigation a {
color: #770000;
}
.navigation a:visited {
color: #550000;
}
.navigation .title {
font-size: 200%;
}</style>
</head>
<body><table witdh="100%" valign="top"><tr valign="top">
<td valign="top" align="left" width="210">
<img src="../images/logo.gif" alt="XML Security Library" border="0"><p></p>
<ul>
<li><a href="../index.html">Home</a></li>
<li><a href="../download.html">Download</a></li>
<li><a href="../news.html">News</a></li>
<li><a href="../documentation.html">Documentation</a></li>
<ul>
<li><a href="../faq.html">FAQ</a></li>
<li><a href="../api/xmlsec-notes.html">Tutorial</a></li>
<li><a href="../api/xmlsec-reference.html">API reference</a></li>
<li><a href="../api/xmlsec-examples.html">Examples</a></li>
</ul>
<li><a href="../xmldsig.html">XML Digital Signature</a></li>
<ul><li><a href="http://www.aleksey.com/xmlsec/xmldsig-verifier.html">Online Verifier</a></li></ul>
<li><a href="../xmlenc.html">XML Encryption</a></li>
<li><a href="../c14n.html">XML Canonicalization</a></li>
<li><a href="../bugs.html">Reporting Bugs</a></li>
<li><a href="http://www.aleksey.com/pipermail/xmlsec">Mailing list</a></li>
<li><a href="../related.html">Related</a></li>
<li><a href="../authors.html">Authors</a></li>
</ul>
<table width="100%">
<tr>
<td width="15"></td>
<td><a href="http://xmlsoft.org/"><img src="../images/libxml2-logo.png" alt="LibXML2" border="0"></a></td>
</tr>
<tr>
<td width="15"></td>
<td><a href="http://xmlsoft.org/XSLT"><img src="../images/libxslt-logo.png" alt="LibXSLT" border="0"></a></td>
</tr>
<tr>
<td width="15"></td>
<td><a href="http://www.openssl.org/"><img src="../images/openssl-logo.png" alt="OpenSSL" border="0"></a></td>
</tr>
<!--Sponsored links - start--><!--Sponsored 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-mscrypto-ref.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="xmlsec-mscrypto-ref.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">XML Security Library Reference Manual</th>
<td><a accesskey="n" href="xmlsec-mscrypto-certkeys.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr></table>
<h1>
<a name="XMLSEC-MSCRYPTO-APP"></a>app</h1>
<div class="REFNAMEDIV">
<a name="AEN26824"></a><h2>Name</h2>app -- </div>
<div class="REFSYNOPSISDIV">
<a name="AEN26827"></a><h2>Synopsis</h2>
<pre class="SYNOPSIS">
<font>int</font> <a href="xmlsec-mscrypto-app.html#XMLSECMSCRYPTOAPPINIT">xmlSecMSCryptoAppInit</a> (const <font>char</font> *config);
<font>int</font> <a href="xmlsec-mscrypto-app.html#XMLSECMSCRYPTOAPPSHUTDOWN">xmlSecMSCryptoAppShutdown</a> (void);
const <font>char</font>* <a href="xmlsec-mscrypto-app.html#XMLSECMSCRYPTOAPPGETCERTSTORENAME">xmlSecMSCryptoAppGetCertStoreName</a>
(void);
<font>int</font> <a href="xmlsec-mscrypto-app.html#XMLSECMSCRYPTOAPPDEFAULTKEYSMNGRINIT">xmlSecMSCryptoAppDefaultKeysMngrInit</a>
(<a href="xmlsec-keysmngr.html#XMLSECKEYSMNGR">xmlSecKeysMngrPtr</a> mngr);
<font>int</font> <a href="xmlsec-mscrypto-app.html#XMLSECMSCRYPTOAPPDEFAULTKEYSMNGRADOPTKEY">xmlSecMSCryptoAppDefaultKeysMngrAdoptKey</a>
(<a href="xmlsec-keysmngr.html#XMLSECKEYSMNGR">xmlSecKeysMngrPtr</a> mngr,
<a href="xmlsec-keys.html#XMLSECKEY">xmlSecKeyPtr</a> key);
<font>int</font> <a href="xmlsec-mscrypto-app.html#XMLSECMSCRYPTOAPPDEFAULTKEYSMNGRLOAD">xmlSecMSCryptoAppDefaultKeysMngrLoad</a>
(<a href="xmlsec-keysmngr.html#XMLSECKEYSMNGR">xmlSecKeysMngrPtr</a> mngr,
const <font>char</font> *uri);
<font>int</font> <a href="xmlsec-mscrypto-app.html#XMLSECMSCRYPTOAPPDEFAULTKEYSMNGRSAVE">xmlSecMSCryptoAppDefaultKeysMngrSave</a>
(<a href="xmlsec-keysmngr.html#XMLSECKEYSMNGR">xmlSecKeysMngrPtr</a> mngr,
const <font>char</font> *filename,
<a href="xmlsec-keysdata.html#XMLSECKEYDATATYPE">xmlSecKeyDataType</a> type);
<font>int</font> <a href="xmlsec-mscrypto-app.html#XMLSECMSCRYPTOAPPKEYSMNGRCERTLOAD">xmlSecMSCryptoAppKeysMngrCertLoad</a>
(<a href="xmlsec-keysmngr.html#XMLSECKEYSMNGR">xmlSecKeysMngrPtr</a> mngr,
const <font>char</font> *filename,
<a href="xmlsec-keysdata.html#XMLSECKEYDATAFORMAT">xmlSecKeyDataFormat</a> format,
<a href="xmlsec-keysdata.html#XMLSECKEYDATATYPE">xmlSecKeyDataType</a> type);
<font>int</font> <a href="xmlsec-mscrypto-app.html#XMLSECMSCRYPTOAPPKEYSMNGRCERTLOADMEMORY">xmlSecMSCryptoAppKeysMngrCertLoadMemory</a>
(<a href="xmlsec-keysmngr.html#XMLSECKEYSMNGR">xmlSecKeysMngrPtr</a> mngr,
const <a href="xmlsec-xmlsec.html#XMLSECBYTE">xmlSecByte</a> *data,
<a href="xmlsec-xmlsec.html#XMLSECSIZE">xmlSecSize</a> dataSize,
<a href="xmlsec-keysdata.html#XMLSECKEYDATAFORMAT">xmlSecKeyDataFormat</a> format,
<a href="xmlsec-keysdata.html#XMLSECKEYDATATYPE">xmlSecKeyDataType</a> type);
<a href="xmlsec-keys.html#XMLSECKEY">xmlSecKeyPtr</a> <a href="xmlsec-mscrypto-app.html#XMLSECMSCRYPTOAPPKEYLOAD">xmlSecMSCryptoAppKeyLoad</a> (const <font>char</font> *filename,
<a href="xmlsec-keysdata.html#XMLSECKEYDATAFORMAT">xmlSecKeyDataFormat</a> format,
const <font>char</font> *pwd,
<font>void</font> *pwdCallback,
<font>void</font> *pwdCallbackCtx);
<a href="xmlsec-keys.html#XMLSECKEY">xmlSecKeyPtr</a> <a href="xmlsec-mscrypto-app.html#XMLSECMSCRYPTOAPPKEYLOADMEMORY">xmlSecMSCryptoAppKeyLoadMemory</a> (const <a href="xmlsec-xmlsec.html#XMLSECBYTE">xmlSecByte</a> *data,
<a href="xmlsec-xmlsec.html#XMLSECSIZE">xmlSecSize</a> dataSize,
<a href="xmlsec-keysdata.html#XMLSECKEYDATAFORMAT">xmlSecKeyDataFormat</a> format,
const <font>char</font> *pwd,
<font>void</font> *pwdCallback,
<font>void</font> *pwdCallbackCtx);
<a href="xmlsec-keys.html#XMLSECKEY">xmlSecKeyPtr</a> <a href="xmlsec-mscrypto-app.html#XMLSECMSCRYPTOAPPPKCS12LOAD">xmlSecMSCryptoAppPkcs12Load</a> (const <font>char</font> *filename,
const <font>char</font> *pwd,
<font>void</font> *pwdCallback,
<font>void</font> *pwdCallbackCtx);
<a href="xmlsec-keys.html#XMLSECKEY">xmlSecKeyPtr</a> <a href="xmlsec-mscrypto-app.html#XMLSECMSCRYPTOAPPPKCS12LOADMEMORY">xmlSecMSCryptoAppPkcs12LoadMemory</a>
(const <a href="xmlsec-xmlsec.html#XMLSECBYTE">xmlSecByte</a> *data,
<a href="xmlsec-xmlsec.html#XMLSECSIZE">xmlSecSize</a> dataSize,
const <font>char</font> *pwd,
<font>void</font> *pwdCallback,
<font>void</font> *pwdCallbackCtx);
<font>int</font> <a href="xmlsec-mscrypto-app.html#XMLSECMSCRYPTOAPPKEYCERTLOAD">xmlSecMSCryptoAppKeyCertLoad</a> (<a href="xmlsec-keys.html#XMLSECKEY">xmlSecKeyPtr</a> key,
const <font>char</font> *filename,
<a href="xmlsec-keysdata.html#XMLSECKEYDATAFORMAT">xmlSecKeyDataFormat</a> format);
<font>int</font> <a href="xmlsec-mscrypto-app.html#XMLSECMSCRYPTOAPPKEYCERTLOADMEMORY">xmlSecMSCryptoAppKeyCertLoadMemory</a>
(<a href="xmlsec-keys.html#XMLSECKEY">xmlSecKeyPtr</a> key,
const <a href="xmlsec-xmlsec.html#XMLSECBYTE">xmlSecByte</a> *data,
<a href="xmlsec-xmlsec.html#XMLSECSIZE">xmlSecSize</a> dataSize,
<a href="xmlsec-keysdata.html#XMLSECKEYDATAFORMAT">xmlSecKeyDataFormat</a> format);
<font>void</font>* <a href="xmlsec-mscrypto-app.html#XMLSECMSCRYPTOAPPGETDEFAULTPWDCALLBACK">xmlSecMSCryptoAppGetDefaultPwdCallback</a>
(void);</pre>
</div>
<div class="REFSECT1">
<a name="AEN26907"></a><h2>Description</h2>
<p></p>
</div>
<div class="REFSECT1">
<a name="AEN26910"></a><h2>Details</h2>
<div class="REFSECT2">
<a name="AEN26912"></a><h3>
<a name="XMLSECMSCRYPTOAPPINIT"></a>xmlSecMSCryptoAppInit ()</h3>
<pre class="PROGRAMLISTING"><font>int</font> xmlSecMSCryptoAppInit (const <font>char</font> *config);</pre>
<p>General crypto engine initialization. This function is used
by XMLSec command line utility and called before
<var class="PARAMETER">xmlSecInit</var> function.</p>
<p></p>
<p></p>
<table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN26924"><span style="white-space: nowrap"><var class="PARAMETER">config</var> :</span></a></td>
<td align="LEFT" valign="TOP"><p> the name of another then the default ms certificate store.</p></td>
</tr>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN26929"><span style="white-space: nowrap"><span class="emphasis"><i class="EMPHASIS">Returns</i></span> :</span></a></td>
<td align="LEFT" valign="TOP"><p>0 on success or a negative value otherwise.</p></td>
</tr>
</tbody></table>
</div>
<hr>
<div class="REFSECT2">
<a name="AEN26934"></a><h3>
<a name="XMLSECMSCRYPTOAPPSHUTDOWN"></a>xmlSecMSCryptoAppShutdown ()</h3>
<pre class="PROGRAMLISTING"><font>int</font> xmlSecMSCryptoAppShutdown (void);</pre>
<p>General crypto engine shutdown. This function is used
by XMLSec command line utility and called after
<var class="PARAMETER">xmlSecShutdown</var> function.</p>
<p></p>
<p></p>
<table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody><tr>
<td align="LEFT" valign="TOP"><a name="AEN26945"><span style="white-space: nowrap"><span class="emphasis"><i class="EMPHASIS">Returns</i></span> :</span></a></td>
<td align="LEFT" valign="TOP"><p>0 on success or a negative value otherwise.</p></td>
</tr></tbody></table>
</div>
<hr>
<div class="REFSECT2">
<a name="AEN26950"></a><h3>
<a name="XMLSECMSCRYPTOAPPGETCERTSTORENAME"></a>xmlSecMSCryptoAppGetCertStoreName ()</h3>
<pre class="PROGRAMLISTING">const <font>char</font>* xmlSecMSCryptoAppGetCertStoreName
(void);</pre>
<p>Gets the MS Crypto certs store name set by <var class="PARAMETER">xmlSecMSCryptoAppInit</var> function.</p>
<p></p>
<p></p>
<table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody><tr>
<td align="LEFT" valign="TOP"><a name="AEN26961"><span style="white-space: nowrap"><span class="emphasis"><i class="EMPHASIS">Returns</i></span> :</span></a></td>
<td align="LEFT" valign="TOP"><p>the MS Crypto certs name used by xmlsec-mscrypto.</p></td>
</tr></tbody></table>
</div>
<hr>
<div class="REFSECT2">
<a name="AEN26966"></a><h3>
<a name="XMLSECMSCRYPTOAPPDEFAULTKEYSMNGRINIT"></a>xmlSecMSCryptoAppDefaultKeysMngrInit ()</h3>
<pre class="PROGRAMLISTING"><font>int</font> xmlSecMSCryptoAppDefaultKeysMngrInit
(<a href="xmlsec-keysmngr.html#XMLSECKEYSMNGR">xmlSecKeysMngrPtr</a> mngr);</pre>
<p>Initializes <var class="PARAMETER">mngr</var> with simple keys store <a href="xmlsec-keysmngr.html#XMLSECSIMPLEKEYSSTOREID"><span class="TYPE">xmlSecSimpleKeysStoreId</span></a>
and a default MSCrypto crypto key data stores.</p>
<p></p>
<p></p>
<table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN26980"><span style="white-space: nowrap"><var class="PARAMETER">mngr</var> :</span></a></td>
<td align="LEFT" valign="TOP"><p> the pointer to keys manager.</p></td>
</tr>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN26985"><span style="white-space: nowrap"><span class="emphasis"><i class="EMPHASIS">Returns</i></span> :</span></a></td>
<td align="LEFT" valign="TOP"><p>0 on success or a negative value otherwise.</p></td>
</tr>
</tbody></table>
</div>
<hr>
<div class="REFSECT2">
<a name="AEN26990"></a><h3>
<a name="XMLSECMSCRYPTOAPPDEFAULTKEYSMNGRADOPTKEY"></a>xmlSecMSCryptoAppDefaultKeysMngrAdoptKey ()</h3>
<pre class="PROGRAMLISTING"><font>int</font> xmlSecMSCryptoAppDefaultKeysMngrAdoptKey
(<a href="xmlsec-keysmngr.html#XMLSECKEYSMNGR">xmlSecKeysMngrPtr</a> mngr,
<a href="xmlsec-keys.html#XMLSECKEY">xmlSecKeyPtr</a> key);</pre>
<p>Adds <var class="PARAMETER">key</var> to the keys manager <var class="PARAMETER">mngr</var> created with <a href="xmlsec-mscrypto-app.html#XMLSECMSCRYPTOAPPDEFAULTKEYSMNGRINIT"><span class="TYPE">xmlSecMSCryptoAppDefaultKeysMngrInit</span></a>
function.</p>
<p></p>
<p></p>
<table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN27006"><span style="white-space: nowrap"><var class="PARAMETER">mngr</var> :</span></a></td>
<td align="LEFT" valign="TOP"><p> the pointer to keys manager.</p></td>
</tr>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN27011"><span style="white-space: nowrap"><var class="PARAMETER">key</var> :</span></a></td>
<td align="LEFT" valign="TOP"><p> the pointer to key.</p></td>
</tr>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN27016"><span style="white-space: nowrap"><span class="emphasis"><i class="EMPHASIS">Returns</i></span> :</span></a></td>
<td align="LEFT" valign="TOP"><p>0 on success or a negative value otherwise.</p></td>
</tr>
</tbody></table>
</div>
<hr>
<div class="REFSECT2">
<a name="AEN27021"></a><h3>
<a name="XMLSECMSCRYPTOAPPDEFAULTKEYSMNGRLOAD"></a>xmlSecMSCryptoAppDefaultKeysMngrLoad ()</h3>
<pre class="PROGRAMLISTING"><font>int</font> xmlSecMSCryptoAppDefaultKeysMngrLoad
(<a href="xmlsec-keysmngr.html#XMLSECKEYSMNGR">xmlSecKeysMngrPtr</a> mngr,
const <font>char</font> *uri);</pre>
<p>Loads XML keys file from <var class="PARAMETER">uri</var> to the keys manager <var class="PARAMETER">mngr</var> created
with <a href="xmlsec-mscrypto-app.html#XMLSECMSCRYPTOAPPDEFAULTKEYSMNGRINIT"><span class="TYPE">xmlSecMSCryptoAppDefaultKeysMngrInit</span></a> function.</p>
<p></p>
<p></p>
<table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN27037"><span style="white-space: nowrap"><var class="PARAMETER">mngr</var> :</span></a></td>
<td align="LEFT" valign="TOP"><p> the pointer to keys manager.</p></td>
</tr>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN27042"><span style="white-space: nowrap"><var class="PARAMETER">uri</var> :</span></a></td>
<td align="LEFT" valign="TOP"><p> the uri.</p></td>
</tr>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN27047"><span style="white-space: nowrap"><span class="emphasis"><i class="EMPHASIS">Returns</i></span> :</span></a></td>
<td align="LEFT" valign="TOP"><p>0 on success or a negative value otherwise.</p></td>
</tr>
</tbody></table>
</div>
<hr>
<div class="REFSECT2">
<a name="AEN27052"></a><h3>
<a name="XMLSECMSCRYPTOAPPDEFAULTKEYSMNGRSAVE"></a>xmlSecMSCryptoAppDefaultKeysMngrSave ()</h3>
<pre class="PROGRAMLISTING"><font>int</font> xmlSecMSCryptoAppDefaultKeysMngrSave
(<a href="xmlsec-keysmngr.html#XMLSECKEYSMNGR">xmlSecKeysMngrPtr</a> mngr,
const <font>char</font> *filename,
<a href="xmlsec-keysdata.html#XMLSECKEYDATATYPE">xmlSecKeyDataType</a> type);</pre>
<p>Saves keys from <var class="PARAMETER">mngr</var> to XML keys file.</p>
<p></p>
<p></p>
<table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN27066"><span style="white-space: nowrap"><var class="PARAMETER">mngr</var> :</span></a></td>
<td align="LEFT" valign="TOP"><p> the pointer to keys manager.</p></td>
</tr>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN27071"><span style="white-space: nowrap"><var class="PARAMETER">filename</var> :</span></a></td>
<td align="LEFT" valign="TOP"><p> the destination filename.</p></td>
</tr>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN27076"><span style="white-space: nowrap"><var class="PARAMETER">type</var> :</span></a></td>
<td align="LEFT" valign="TOP"><p> the type of keys to save (public/private/symmetric).</p></td>
</tr>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN27081"><span style="white-space: nowrap"><span class="emphasis"><i class="EMPHASIS">Returns</i></span> :</span></a></td>
<td align="LEFT" valign="TOP"><p>0 on success or a negative value otherwise.</p></td>
</tr>
</tbody></table>
</div>
<hr>
<div class="REFSECT2">
<a name="AEN27086"></a><h3>
<a name="XMLSECMSCRYPTOAPPKEYSMNGRCERTLOAD"></a>xmlSecMSCryptoAppKeysMngrCertLoad ()</h3>
<pre class="PROGRAMLISTING"><font>int</font> xmlSecMSCryptoAppKeysMngrCertLoad
(<a href="xmlsec-keysmngr.html#XMLSECKEYSMNGR">xmlSecKeysMngrPtr</a> mngr,
const <font>char</font> *filename,
<a href="xmlsec-keysdata.html#XMLSECKEYDATAFORMAT">xmlSecKeyDataFormat</a> format,
<a href="xmlsec-keysdata.html#XMLSECKEYDATATYPE">xmlSecKeyDataType</a> type);</pre>
<p>Reads cert from <var class="PARAMETER">filename</var> and adds to the list of trusted or known
untrusted certs in <var class="PARAMETER">store</var> (not implemented yet).</p>
<p></p>
<p></p>
<table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN27102"><span style="white-space: nowrap"><var class="PARAMETER">mngr</var> :</span></a></td>
<td align="LEFT" valign="TOP"><p> the keys manager.</p></td>
</tr>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN27107"><span style="white-space: nowrap"><var class="PARAMETER">filename</var> :</span></a></td>
<td align="LEFT" valign="TOP"><p> the certificate file.</p></td>
</tr>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN27112"><span style="white-space: nowrap"><var class="PARAMETER">format</var> :</span></a></td>
<td align="LEFT" valign="TOP"><p> the certificate file format.</p></td>
</tr>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN27117"><span style="white-space: nowrap"><var class="PARAMETER">type</var> :</span></a></td>
<td align="LEFT" valign="TOP"><p> the flag that indicates is the certificate in <var class="PARAMETER">filename</var>
trusted or not.</p></td>
</tr>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN27123"><span style="white-space: nowrap"><span class="emphasis"><i class="EMPHASIS">Returns</i></span> :</span></a></td>
<td align="LEFT" valign="TOP"><p>0 on success or a negative value otherwise.</p></td>
</tr>
</tbody></table>
</div>
<hr>
<div class="REFSECT2">
<a name="AEN27128"></a><h3>
<a name="XMLSECMSCRYPTOAPPKEYSMNGRCERTLOADMEMORY"></a>xmlSecMSCryptoAppKeysMngrCertLoadMemory ()</h3>
<pre class="PROGRAMLISTING"><font>int</font> xmlSecMSCryptoAppKeysMngrCertLoadMemory
(<a href="xmlsec-keysmngr.html#XMLSECKEYSMNGR">xmlSecKeysMngrPtr</a> mngr,
const <a href="xmlsec-xmlsec.html#XMLSECBYTE">xmlSecByte</a> *data,
<a href="xmlsec-xmlsec.html#XMLSECSIZE">xmlSecSize</a> dataSize,
<a href="xmlsec-keysdata.html#XMLSECKEYDATAFORMAT">xmlSecKeyDataFormat</a> format,
<a href="xmlsec-keysdata.html#XMLSECKEYDATATYPE">xmlSecKeyDataType</a> type);</pre>
<p>Reads cert from <var class="PARAMETER">data</var> and adds to the list of trusted or known
untrusted certs in <var class="PARAMETER">store</var>.</p>
<p></p>
<p></p>
<table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN27145"><span style="white-space: nowrap"><var class="PARAMETER">mngr</var> :</span></a></td>
<td align="LEFT" valign="TOP"><p> the keys manager.</p></td>
</tr>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN27150"><span style="white-space: nowrap"><var class="PARAMETER">data</var> :</span></a></td>
<td align="LEFT" valign="TOP"><p> the binary certificate.</p></td>
</tr>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN27155"><span style="white-space: nowrap"><var class="PARAMETER">dataSize</var> :</span></a></td>
<td align="LEFT" valign="TOP"><p> size of binary certificate (data)</p></td>
</tr>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN27160"><span style="white-space: nowrap"><var class="PARAMETER">format</var> :</span></a></td>
<td align="LEFT" valign="TOP"><p> the certificate file format.</p></td>
</tr>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN27165"><span style="white-space: nowrap"><var class="PARAMETER">type</var> :</span></a></td>
<td align="LEFT" valign="TOP"><p> the flag that indicates is the certificate in <var class="PARAMETER">filename</var>
trusted or not.</p></td>
</tr>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN27171"><span style="white-space: nowrap"><span class="emphasis"><i class="EMPHASIS">Returns</i></span> :</span></a></td>
<td align="LEFT" valign="TOP"><p>0 on success or a negative value otherwise.</p></td>
</tr>
</tbody></table>
</div>
<hr>
<div class="REFSECT2">
<a name="AEN27176"></a><h3>
<a name="XMLSECMSCRYPTOAPPKEYLOAD"></a>xmlSecMSCryptoAppKeyLoad ()</h3>
<pre class="PROGRAMLISTING"><a href="xmlsec-keys.html#XMLSECKEY">xmlSecKeyPtr</a> xmlSecMSCryptoAppKeyLoad (const <font>char</font> *filename,
<a href="xmlsec-keysdata.html#XMLSECKEYDATAFORMAT">xmlSecKeyDataFormat</a> format,
const <font>char</font> *pwd,
<font>void</font> *pwdCallback,
<font>void</font> *pwdCallbackCtx);</pre>
<p>Reads key from the a file.</p>
<p></p>
<p></p>
<table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN27191"><span style="white-space: nowrap"><var class="PARAMETER">filename</var> :</span></a></td>
<td align="LEFT" valign="TOP"><p> the key filename.</p></td>
</tr>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN27196"><span style="white-space: nowrap"><var class="PARAMETER">format</var> :</span></a></td>
<td align="LEFT" valign="TOP"><p> the key file format.</p></td>
</tr>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN27201"><span style="white-space: nowrap"><var class="PARAMETER">pwd</var> :</span></a></td>
<td align="LEFT" valign="TOP"><p> the key file password.</p></td>
</tr>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN27206"><span style="white-space: nowrap"><var class="PARAMETER">pwdCallback</var> :</span></a></td>
<td align="LEFT" valign="TOP"><p> the key password callback.</p></td>
</tr>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN27211"><span style="white-space: nowrap"><var class="PARAMETER">pwdCallbackCtx</var> :</span></a></td>
<td align="LEFT" valign="TOP"><p> the user context for password callback.</p></td>
</tr>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN27216"><span style="white-space: nowrap"><span class="emphasis"><i class="EMPHASIS">Returns</i></span> :</span></a></td>
<td align="LEFT" valign="TOP"><p>pointer to the key or NULL if an error occurs.</p></td>
</tr>
</tbody></table>
</div>
<hr>
<div class="REFSECT2">
<a name="AEN27221"></a><h3>
<a name="XMLSECMSCRYPTOAPPKEYLOADMEMORY"></a>xmlSecMSCryptoAppKeyLoadMemory ()</h3>
<pre class="PROGRAMLISTING"><a href="xmlsec-keys.html#XMLSECKEY">xmlSecKeyPtr</a> xmlSecMSCryptoAppKeyLoadMemory (const <a href="xmlsec-xmlsec.html#XMLSECBYTE">xmlSecByte</a> *data,
<a href="xmlsec-xmlsec.html#XMLSECSIZE">xmlSecSize</a> dataSize,
<a href="xmlsec-keysdata.html#XMLSECKEYDATAFORMAT">xmlSecKeyDataFormat</a> format,
const <font>char</font> *pwd,
<font>void</font> *pwdCallback,
<font>void</font> *pwdCallbackCtx);</pre>
<p>Reads key from the a file.</p>
<p></p>
<p></p>
<table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN27237"><span style="white-space: nowrap"><var class="PARAMETER">data</var> :</span></a></td>
<td align="LEFT" valign="TOP"><p> the key binary data.</p></td>
</tr>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN27242"><span style="white-space: nowrap"><var class="PARAMETER">dataSize</var> :</span></a></td>
<td align="LEFT" valign="TOP"><p> the key data size.</p></td>
</tr>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN27247"><span style="white-space: nowrap"><var class="PARAMETER">format</var> :</span></a></td>
<td align="LEFT" valign="TOP"><p> the key format.</p></td>
</tr>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN27252"><span style="white-space: nowrap"><var class="PARAMETER">pwd</var> :</span></a></td>
<td align="LEFT" valign="TOP"><p> the key password.</p></td>
</tr>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN27257"><span style="white-space: nowrap"><var class="PARAMETER">pwdCallback</var> :</span></a></td>
<td align="LEFT" valign="TOP"><p> the key password callback.</p></td>
</tr>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN27262"><span style="white-space: nowrap"><var class="PARAMETER">pwdCallbackCtx</var> :</span></a></td>
<td align="LEFT" valign="TOP"><p> the user context for password callback.</p></td>
</tr>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN27267"><span style="white-space: nowrap"><span class="emphasis"><i class="EMPHASIS">Returns</i></span> :</span></a></td>
<td align="LEFT" valign="TOP"><p>pointer to the key or NULL if an error occurs.</p></td>
</tr>
</tbody></table>
</div>
<hr>
<div class="REFSECT2">
<a name="AEN27272"></a><h3>
<a name="XMLSECMSCRYPTOAPPPKCS12LOAD"></a>xmlSecMSCryptoAppPkcs12Load ()</h3>
<pre class="PROGRAMLISTING"><a href="xmlsec-keys.html#XMLSECKEY">xmlSecKeyPtr</a> xmlSecMSCryptoAppPkcs12Load (const <font>char</font> *filename,
const <font>char</font> *pwd,
<font>void</font> *pwdCallback,
<font>void</font> *pwdCallbackCtx);</pre>
<p>Reads key and all associated certificates from the PKCS12 file</p>
<p></p>
<p></p>
<table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN27286"><span style="white-space: nowrap"><var class="PARAMETER">filename</var> :</span></a></td>
<td align="LEFT" valign="TOP"><p> the PKCS12 key filename.</p></td>
</tr>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN27291"><span style="white-space: nowrap"><var class="PARAMETER">pwd</var> :</span></a></td>
<td align="LEFT" valign="TOP"><p> the PKCS12 file password.</p></td>
</tr>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN27296"><span style="white-space: nowrap"><var class="PARAMETER">pwdCallback</var> :</span></a></td>
<td align="LEFT" valign="TOP"><p> the password callback.</p></td>
</tr>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN27301"><span style="white-space: nowrap"><var class="PARAMETER">pwdCallbackCtx</var> :</span></a></td>
<td align="LEFT" valign="TOP"><p> the user context for password callback.</p></td>
</tr>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN27306"><span style="white-space: nowrap"><span class="emphasis"><i class="EMPHASIS">Returns</i></span> :</span></a></td>
<td align="LEFT" valign="TOP"><p>pointer to the key or NULL if an error occurs.</p></td>
</tr>
</tbody></table>
</div>
<hr>
<div class="REFSECT2">
<a name="AEN27311"></a><h3>
<a name="XMLSECMSCRYPTOAPPPKCS12LOADMEMORY"></a>xmlSecMSCryptoAppPkcs12LoadMemory ()</h3>
<pre class="PROGRAMLISTING"><a href="xmlsec-keys.html#XMLSECKEY">xmlSecKeyPtr</a> xmlSecMSCryptoAppPkcs12LoadMemory
(const <a href="xmlsec-xmlsec.html#XMLSECBYTE">xmlSecByte</a> *data,
<a href="xmlsec-xmlsec.html#XMLSECSIZE">xmlSecSize</a> dataSize,
const <font>char</font> *pwd,
<font>void</font> *pwdCallback,
<font>void</font> *pwdCallbackCtx);</pre>
<p>Reads key and all associated certificates from the PKCS12 binary</p>
<p></p>
<p></p>
<table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN27326"><span style="white-space: nowrap"><var class="PARAMETER">data</var> :</span></a></td>
<td align="LEFT" valign="TOP"><p> the binary PKCS12 key in data.</p></td>
</tr>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN27331"><span style="white-space: nowrap"><var class="PARAMETER">dataSize</var> :</span></a></td>
<td align="LEFT" valign="TOP"><p> size of binary pkcs12 data</p></td>
</tr>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN27336"><span style="white-space: nowrap"><var class="PARAMETER">pwd</var> :</span></a></td>
<td align="LEFT" valign="TOP"><p> the PKCS12 file password.</p></td>
</tr>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN27341"><span style="white-space: nowrap"><var class="PARAMETER">pwdCallback</var> :</span></a></td>
<td align="LEFT" valign="TOP"><p> the password callback.</p></td>
</tr>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN27346"><span style="white-space: nowrap"><var class="PARAMETER">pwdCallbackCtx</var> :</span></a></td>
<td align="LEFT" valign="TOP"><p> the user context for password callback.</p></td>
</tr>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN27351"><span style="white-space: nowrap"><span class="emphasis"><i class="EMPHASIS">Returns</i></span> :</span></a></td>
<td align="LEFT" valign="TOP"><p>pointer to the key or NULL if an error occurs.</p></td>
</tr>
</tbody></table>
</div>
<hr>
<div class="REFSECT2">
<a name="AEN27356"></a><h3>
<a name="XMLSECMSCRYPTOAPPKEYCERTLOAD"></a>xmlSecMSCryptoAppKeyCertLoad ()</h3>
<pre class="PROGRAMLISTING"><font>int</font> xmlSecMSCryptoAppKeyCertLoad (<a href="xmlsec-keys.html#XMLSECKEY">xmlSecKeyPtr</a> key,
const <font>char</font> *filename,
<a href="xmlsec-keysdata.html#XMLSECKEYDATAFORMAT">xmlSecKeyDataFormat</a> format);</pre>
<p>Reads the certificate from $<var class="PARAMETER">filename</var> and adds it to key.</p>
<p></p>
<p></p>
<table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN27370"><span style="white-space: nowrap"><var class="PARAMETER">key</var> :</span></a></td>
<td align="LEFT" valign="TOP"><p> the pointer to key.</p></td>
</tr>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN27375"><span style="white-space: nowrap"><var class="PARAMETER">filename</var> :</span></a></td>
<td align="LEFT" valign="TOP"><p> the certificate filename.</p></td>
</tr>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN27380"><span style="white-space: nowrap"><var class="PARAMETER">format</var> :</span></a></td>
<td align="LEFT" valign="TOP"><p> the certificate file format.</p></td>
</tr>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN27385"><span style="white-space: nowrap"><span class="emphasis"><i class="EMPHASIS">Returns</i></span> :</span></a></td>
<td align="LEFT" valign="TOP"><p>0 on success or a negative value otherwise.</p></td>
</tr>
</tbody></table>
</div>
<hr>
<div class="REFSECT2">
<a name="AEN27390"></a><h3>
<a name="XMLSECMSCRYPTOAPPKEYCERTLOADMEMORY"></a>xmlSecMSCryptoAppKeyCertLoadMemory ()</h3>
<pre class="PROGRAMLISTING"><font>int</font> xmlSecMSCryptoAppKeyCertLoadMemory
(<a href="xmlsec-keys.html#XMLSECKEY">xmlSecKeyPtr</a> key,
const <a href="xmlsec-xmlsec.html#XMLSECBYTE">xmlSecByte</a> *data,
<a href="xmlsec-xmlsec.html#XMLSECSIZE">xmlSecSize</a> dataSize,
<a href="xmlsec-keysdata.html#XMLSECKEYDATAFORMAT">xmlSecKeyDataFormat</a> format);</pre>
<p>Reads the certificate from $<var class="PARAMETER">data</var> and adds it to key.</p>
<p></p>
<p></p>
<table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN27405"><span style="white-space: nowrap"><var class="PARAMETER">key</var> :</span></a></td>
<td align="LEFT" valign="TOP"><p> the pointer to key.</p></td>
</tr>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN27410"><span style="white-space: nowrap"><var class="PARAMETER">data</var> :</span></a></td>
<td align="LEFT" valign="TOP"><p> the binary certificate.</p></td>
</tr>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN27415"><span style="white-space: nowrap"><var class="PARAMETER">dataSize</var> :</span></a></td>
<td align="LEFT" valign="TOP"><p> size of certificate binary (data)</p></td>
</tr>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN27420"><span style="white-space: nowrap"><var class="PARAMETER">format</var> :</span></a></td>
<td align="LEFT" valign="TOP"><p> the certificate file format.</p></td>
</tr>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN27425"><span style="white-space: nowrap"><span class="emphasis"><i class="EMPHASIS">Returns</i></span> :</span></a></td>
<td align="LEFT" valign="TOP"><p>0 on success or a negative value otherwise.</p></td>
</tr>
</tbody></table>
</div>
<hr>
<div class="REFSECT2">
<a name="AEN27430"></a><h3>
<a name="XMLSECMSCRYPTOAPPGETDEFAULTPWDCALLBACK"></a>xmlSecMSCryptoAppGetDefaultPwdCallback ()</h3>
<pre class="PROGRAMLISTING"><font>void</font>* xmlSecMSCryptoAppGetDefaultPwdCallback
(void);</pre>
<p>Gets default password callback.</p>
<p></p>
</div>
</div>
<table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="2"><tr valign="middle">
<td align="left"><a accesskey="p" href="xmlsec-mscrypto-ref.html"><b><<< XML Security Library for MSCrypto API Reference.</b></a></td>
<td align="right"><a accesskey="n" href="xmlsec-mscrypto-certkeys.html"><b>certkeys >>></b></a></td>
</tr></table>
</td></tr></table></td>
</tr></table></body>
</html>