diff options
Diffstat (limited to 'docs/api/xmlsec-mscng-certkeys.html')
-rw-r--r-- | docs/api/xmlsec-mscng-certkeys.html | 175 |
1 files changed, 175 insertions, 0 deletions
diff --git a/docs/api/xmlsec-mscng-certkeys.html b/docs/api/xmlsec-mscng-certkeys.html new file mode 100644 index 00000000..43c3bab0 --- /dev/null +++ b/docs/api/xmlsec-mscng-certkeys.html @@ -0,0 +1,175 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>certkeys: 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-msccng-ref.html" title="XML Security Library for Microsoft Cryptography API: Next Generation (CNG) Reference."> +<link rel="prev" href="xmlsec-mscng-app.html" title="app"> +<link rel="next" href="xmlsec-mscng-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 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-mscng-certkeys.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> +<td><a accesskey="u" href="xmlsec-msccng-ref.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="xmlsec-mscng-app.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="xmlsec-mscng-crypto.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="xmlsec-mscng-certkeys"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="xmlsec-mscng-certkeys.top_of_page"></a>certkeys</span></h2> +<p>certkeys — Certificate keys support functions for Microsoft Cryptography API: Next Generation (CNG).</p> +</td> +<td class="gallery_image" valign="top" align="right"></td> +</tr></table></div> +<div class="refsect1"> +<a name="xmlsec-mscng-certkeys.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-mscng-certkeys.functions"></a><h2>Functions</h2> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col> +<col> +</colgroup> +<tbody> +<tr> +<td class="function_type"> +<a class="link" href="xmlsec-keysdata.html#xmlSecKeyData" title="struct xmlSecKeyData"><span class="returnvalue">xmlSecKeyDataPtr</span></a> +</td> +<td class="function_name"> +<a class="link" href="xmlsec-mscng-certkeys.html#xmlSecMSCngCertAdopt" title="xmlSecMSCngCertAdopt ()">xmlSecMSCngCertAdopt</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<font><span class="returnvalue">BCRYPT_KEY_HANDLE</span></font> +</td> +<td class="function_name"> +<a class="link" href="xmlsec-mscng-certkeys.html#xmlSecMSCngKeyDataGetPubKey" title="xmlSecMSCngKeyDataGetPubKey ()">xmlSecMSCngKeyDataGetPubKey</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<font><span class="returnvalue">NCRYPT_KEY_HANDLE</span></font> +</td> +<td class="function_name"> +<a class="link" href="xmlsec-mscng-certkeys.html#xmlSecMSCngKeyDataGetPrivKey" title="xmlSecMSCngKeyDataGetPrivKey ()">xmlSecMSCngKeyDataGetPrivKey</a> <span class="c_punctuation">()</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="xmlsec-mscng-certkeys.description"></a><h2>Description</h2> +<p></p> +</div> +<div class="refsect1"> +<a name="xmlsec-mscng-certkeys.functions_details"></a><h2>Functions</h2> +<div class="refsect2"> +<a name="xmlSecMSCngCertAdopt"></a><h3>xmlSecMSCngCertAdopt ()</h3> +<pre class="programlisting"><a class="link" href="xmlsec-keysdata.html#xmlSecKeyData" title="struct xmlSecKeyData"><span class="returnvalue">xmlSecKeyDataPtr</span></a> +xmlSecMSCngCertAdopt (<em class="parameter"><code><font><span class="type">PCCERT_CONTEXT</span></font> pCert</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>Creates key data value from the cert.</p> +<div class="refsect3"> +<a name="xmlSecMSCngCertAdopt.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col> +<col> +<col> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>pCert</p></td> +<td class="parameter_description"><p>the pointer to cert.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>type</p></td> +<td class="parameter_description"><p>the expected key type.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="xmlSecMSCngCertAdopt.returns"></a><h4>Returns</h4> +<p> pointer to newly created xmlsec key or NULL if an error occurs.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="xmlSecMSCngKeyDataGetPubKey"></a><h3>xmlSecMSCngKeyDataGetPubKey ()</h3> +<pre class="programlisting"><font><span class="returnvalue">BCRYPT_KEY_HANDLE</span></font> +xmlSecMSCngKeyDataGetPubKey (<em class="parameter"><code><a class="link" href="xmlsec-keysdata.html#xmlSecKeyData" title="struct xmlSecKeyData"><span class="type">xmlSecKeyDataPtr</span></a> data</code></em>);</pre> +<p>Native MSCng public key retrieval from xmlsec keydata. The returned key must +not be destroyed by the caller.</p> +<div class="refsect3"> +<a name="xmlSecMSCngKeyDataGetPubKey.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col> +<col> +<col> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>data</p></td> +<td class="parameter_description"><p>the key data to retrieve certificate from.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="xmlSecMSCngKeyDataGetPubKey.returns"></a><h4>Returns</h4> +<p> key on success or 0 otherwise.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="xmlSecMSCngKeyDataGetPrivKey"></a><h3>xmlSecMSCngKeyDataGetPrivKey ()</h3> +<pre class="programlisting"><font><span class="returnvalue">NCRYPT_KEY_HANDLE</span></font> +xmlSecMSCngKeyDataGetPrivKey (<em class="parameter"><code><a class="link" href="xmlsec-keysdata.html#xmlSecKeyData" title="struct xmlSecKeyData"><span class="type">xmlSecKeyDataPtr</span></a> data</code></em>);</pre> +<p>Native MSCng private key retrieval from xmlsec keydata. The returned key +must not be destroyed by the caller.</p> +<div class="refsect3"> +<a name="xmlSecMSCngKeyDataGetPrivKey.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col> +<col> +<col> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>data</p></td> +<td class="parameter_description"><p>the key data to retrieve certificate from.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="xmlSecMSCngKeyDataGetPrivKey.returns"></a><h4>Returns</h4> +<p> key on success or 0 otherwise.</p> +</div> +</div> +</div> +<div class="refsect1"> +<a name="xmlsec-mscng-certkeys.other_details"></a><h2>Types and Values</h2> +<p></p> +</div> +</div> +<div class="footer"> +<hr>Generated by GTK-Doc V1.27</div> +</body> +</html> |