diff options
Diffstat (limited to 'docs/api/xmlsec-x509.html')
| -rw-r--r-- | docs/api/xmlsec-x509.html | 313 |
1 files changed, 115 insertions, 198 deletions
diff --git a/docs/api/xmlsec-x509.html b/docs/api/xmlsec-x509.html index 074f129d..4d66c0b0 100644 --- a/docs/api/xmlsec-x509.html +++ b/docs/api/xmlsec-x509.html @@ -1,263 +1,180 @@ +<!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>x509</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 Core Library API Reference." href="xmlsec-ref.html"> -<link rel="PREVIOUS" title="xmltree" href="xmlsec-xmltree.html"> -<link rel="NEXT" title="XML Security Library for OpenSLL API Reference." href="xmlsec-openssl-ref.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>x509: 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-ref.html" title="XML Security Core Library API Reference."> +<link rel="prev" href="xmlsec-xmltree.html" title="xmltree"> +<link rel="next" href="xmlsec-openssl-ref.html" title="XML Security Library for OpenSLL API Reference."> +<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> +<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-x509.description" class="shortcut">Description</a></span> </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-xmltree.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> -<td><a accesskey="u" href="xmlsec-ref.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></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-ref.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="xmlsec-xmltree.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> <td><a accesskey="n" href="xmlsec-openssl-ref.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> </tr></table> -<h1> -<a name="XMLSEC-X509"></a>x509</h1> -<div class="REFNAMEDIV"> -<a name="AEN28791"></a><h2>Name</h2>x509 -- <a href="http://www.w3.org/TR/xmldsig-core/#sec-X509Certificate" target="_top"><dsig:X509Certificate/></a> node parser.</div> -<div class="REFSECT1"> -<a name="XMLSEC-X509.FUNCTIONS"></a><h2>Functions</h2> -<div class="INFORMALTABLE"> -<p></p> -<a name="AEN28797"></a><table border="0" frame="void" width="100%" class="CALSTABLE"> +<div class="refentry"> +<a name="xmlsec-x509"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="xmlsec-x509.top_of_page"></a>x509</span></h2> +<p>x509 — <a class="ulink" href="" target="_top"><dsig:X509Certificate/></a> node parser functions.</p> +</td> +<td class="gallery_image" valign="top" align="right"></td> +</tr></table></div> +<div class="refsect1"> +<a name="xmlsec-x509.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-x509.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-x509.html#XMLSECX509DATAGETNODECONTENT">xmlSecX509DataGetNodeContent</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-x509.html#xmlSecX509DataGetNodeContent" title="xmlSecX509DataGetNodeContent ()">xmlSecX509DataGetNodeContent</a> <span class="c_punctuation">()</span> </td> </tr></tbody> -</table> -<p></p> -</div> +</table></div> </div> -<div class="REFSECT1"> -<a name="XMLSEC-X509.OTHER"></a><h2>Types and Values</h2> -<div class="INFORMALTABLE"> -<p></p> -<a name="AEN28809"></a><table border="0" frame="void" width="100%" class="CALSTABLE"> +<div class="refsect1"> +<a name="xmlsec-x509.other"></a><h2>Types and Values</h2> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> <col> <col> +</colgroup> <tbody> <tr> -<td>#define</td> -<td><a href="xmlsec-x509.html#XMLSEC-X509DATA-CERTIFICATE-NODE:CAPS">XMLSEC_X509DATA_CERTIFICATE_NODE</a></td> +<td class="define_keyword">#define</td> +<td class="function_name"><a class="link" href="xmlsec-x509.html#XMLSEC-X509DATA-CERTIFICATE-NODE:CAPS" title="XMLSEC_X509DATA_CERTIFICATE_NODE">XMLSEC_X509DATA_CERTIFICATE_NODE</a></td> </tr> <tr> -<td>#define</td> -<td><a href="xmlsec-x509.html#XMLSEC-X509DATA-SUBJECTNAME-NODE:CAPS">XMLSEC_X509DATA_SUBJECTNAME_NODE</a></td> +<td class="define_keyword">#define</td> +<td class="function_name"><a class="link" href="xmlsec-x509.html#XMLSEC-X509DATA-SUBJECTNAME-NODE:CAPS" title="XMLSEC_X509DATA_SUBJECTNAME_NODE">XMLSEC_X509DATA_SUBJECTNAME_NODE</a></td> </tr> <tr> -<td>#define</td> -<td><a href="xmlsec-x509.html#XMLSEC-X509DATA-ISSUERSERIAL-NODE:CAPS">XMLSEC_X509DATA_ISSUERSERIAL_NODE</a></td> +<td class="define_keyword">#define</td> +<td class="function_name"><a class="link" href="xmlsec-x509.html#XMLSEC-X509DATA-ISSUERSERIAL-NODE:CAPS" title="XMLSEC_X509DATA_ISSUERSERIAL_NODE">XMLSEC_X509DATA_ISSUERSERIAL_NODE</a></td> </tr> <tr> -<td>#define</td> -<td><a href="xmlsec-x509.html#XMLSEC-X509DATA-SKI-NODE:CAPS">XMLSEC_X509DATA_SKI_NODE</a></td> +<td class="define_keyword">#define</td> +<td class="function_name"><a class="link" href="xmlsec-x509.html#XMLSEC-X509DATA-SKI-NODE:CAPS" title="XMLSEC_X509DATA_SKI_NODE">XMLSEC_X509DATA_SKI_NODE</a></td> </tr> <tr> -<td>#define</td> -<td><a href="xmlsec-x509.html#XMLSEC-X509DATA-CRL-NODE:CAPS">XMLSEC_X509DATA_CRL_NODE</a></td> +<td class="define_keyword">#define</td> +<td class="function_name"><a class="link" href="xmlsec-x509.html#XMLSEC-X509DATA-CRL-NODE:CAPS" title="XMLSEC_X509DATA_CRL_NODE">XMLSEC_X509DATA_CRL_NODE</a></td> </tr> <tr> -<td>#define</td> -<td><a href="xmlsec-x509.html#XMLSEC-X509DATA-DEFAULT:CAPS">XMLSEC_X509DATA_DEFAULT</a></td> +<td class="define_keyword">#define</td> +<td class="function_name"><a class="link" href="xmlsec-x509.html#XMLSEC-X509DATA-DEFAULT:CAPS" title="XMLSEC_X509DATA_DEFAULT">XMLSEC_X509DATA_DEFAULT</a></td> </tr> </tbody> -</table> -<p></p> +</table></div> </div> +<div class="refsect1"> +<a name="xmlsec-x509.description"></a><h2>Description</h2> +<p></p> </div> -<div class="REFSECT1"> -<a name="XMLSEC-X509.DESCRIPTION"></a><h2>Description</h2> -<p><a href="http://www.w3.org/TR/xmldsig-core/#sec-X509Certificate" target="_top"><dsig:X509Certificate/></a> node parser.</p> -</div> -<div class="REFSECT1"> -<a name="XMLSEC-X509.FUNCTIONS_DETAILS"></a><h2>Functions</h2> -<div class="REFSECT2"> -<a name="XMLSECX509DATAGETNODECONTENT"></a><h3>xmlSecX509DataGetNodeContent ()</h3> -<pre class="PROGRAMLISTING"><font><span class="RETURNVALUE">int</span></font> -xmlSecX509DataGetNodeContent (<code class="PARAMETER"><font><span class="TYPE">xmlNodePtr</span></font> node</code>, - <code class="PARAMETER"><font><span class="TYPE">int</span></font> deleteChildren</code>, - <code class="PARAMETER"><a href="xmlsec-keyinfo.html#XMLSECKEYINFOCTX"><span class="TYPE">xmlSecKeyInfoCtxPtr</span></a> keyInfoCtx</code>);</pre> -<p>Reads the contents of <dsig:X509Data/> node and returns it as +<div class="refsect1"> +<a name="xmlsec-x509.functions_details"></a><h2>Functions</h2> +<div class="refsect2"> +<a name="xmlSecX509DataGetNodeContent"></a><h3>xmlSecX509DataGetNodeContent ()</h3> +<pre class="programlisting"><font><span class="returnvalue">int</span></font> +xmlSecX509DataGetNodeContent (<em class="parameter"><code><font><span class="type">xmlNodePtr</span></font> node</code></em>, + <em class="parameter"><code><a class="link" href="xmlsec-keyinfo.html#xmlSecKeyInfoCtx" title="struct xmlSecKeyInfoCtx"><span class="type">xmlSecKeyInfoCtxPtr</span></a> keyInfoCtx</code></em>);</pre> +<p>Reads the contents of <a class="ulink" href="" target="_top"><dsig:X509Data/></a> node and returns it as a bits mask.</p> -<div class="REFSECT3"> -<a name="AEN28859"></a><h4>Parameters</h4> -<div class="INFORMALTABLE"> -<p></p> -<a name="AEN28861"></a><table border="0" frame="void" width="100%" class="CALSTABLE"> +<div class="refsect3"> +<a name="xmlSecX509DataGetNodeContent.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> <col> <col> <col> +</colgroup> <tbody> <tr> -<td><p>node</p></td> -<td><p>the pointer to <dsig:X509Data/> node.</p></td> -<td> </td> +<td class="parameter_name"><p>node</p></td> +<td class="parameter_description"><p>the pointer to <a class="ulink" href="" target="_top"><dsig:X509Data/></a> node.</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p>deleteChildren</p></td> -<td><p>the flag that indicates whether to remove node children after reading.</p></td> -<td> </td> -</tr> -<tr> -<td><p>keyInfoCtx</p></td> -<td><p>the pointer to <dsig:KeyInfo/> node processing context.</p></td> -<td> </td> +<td class="parameter_name"><p>keyInfoCtx</p></td> +<td class="parameter_description"><p>the pointer to <a class="ulink" href="" target="_top"><dsig:KeyInfo/></a> node processing context.</p></td> +<td class="parameter_annotations"> </td> </tr> </tbody> -</table> -<p></p> +</table></div> </div> -</div> -<div class="REFSECT3"> -<a name="AEN28882"></a><h4>Returns</h4> -<p> the bit mask representing the <dsig:X509Data/> node content +<div class="refsect3"> +<a name="xmlSecX509DataGetNodeContent.returns"></a><h4>Returns</h4> +<p> the bit mask representing the <a class="ulink" href="" target="_top"><dsig:X509Data/></a> node content or a negative value if an error occurs.</p> </div> </div> </div> -<div class="REFSECT1"> -<a name="XMLSEC-X509.OTHER_DETAILS"></a><h2>Types and Values</h2> -<div class="REFSECT2"> +<div class="refsect1"> +<a name="xmlsec-x509.other_details"></a><h2>Types and Values</h2> +<div class="refsect2"> <a name="XMLSEC-X509DATA-CERTIFICATE-NODE:CAPS"></a><h3>XMLSEC_X509DATA_CERTIFICATE_NODE</h3> -<pre class="PROGRAMLISTING">#define XMLSEC_X509DATA_CERTIFICATE_NODE 0x00000001</pre> -<p><dsig:X509Certificate/> node found or would be written back.</p> +<pre class="programlisting">#define XMLSEC_X509DATA_CERTIFICATE_NODE 0x00000001 +</pre> +<a class="ulink" href="" target="_top"><dsig:X509Certificate/></a> node found or would be written back. </div> <hr> -<div class="REFSECT2"> +<div class="refsect2"> <a name="XMLSEC-X509DATA-SUBJECTNAME-NODE:CAPS"></a><h3>XMLSEC_X509DATA_SUBJECTNAME_NODE</h3> -<pre class="PROGRAMLISTING">#define XMLSEC_X509DATA_SUBJECTNAME_NODE 0x00000002</pre> -<p><dsig:X509SubjectName/> node found or would be written back.</p> +<pre class="programlisting">#define XMLSEC_X509DATA_SUBJECTNAME_NODE 0x00000002 +</pre> +<a class="ulink" href="" target="_top"><dsig:X509SubjectName/></a> node found or would be written back. </div> <hr> -<div class="REFSECT2"> +<div class="refsect2"> <a name="XMLSEC-X509DATA-ISSUERSERIAL-NODE:CAPS"></a><h3>XMLSEC_X509DATA_ISSUERSERIAL_NODE</h3> -<pre class="PROGRAMLISTING">#define XMLSEC_X509DATA_ISSUERSERIAL_NODE 0x00000004</pre> -<p><dsig:X509IssuerSerial/> node found or would be written back.</p> +<pre class="programlisting">#define XMLSEC_X509DATA_ISSUERSERIAL_NODE 0x00000004 +</pre> +<a class="ulink" href="" target="_top"><dsig:X509IssuerSerial/></a> node found or would be written back. </div> <hr> -<div class="REFSECT2"> +<div class="refsect2"> <a name="XMLSEC-X509DATA-SKI-NODE:CAPS"></a><h3>XMLSEC_X509DATA_SKI_NODE</h3> -<pre class="PROGRAMLISTING">#define XMLSEC_X509DATA_SKI_NODE 0x00000008</pre> -<p><dsig:X509SKI/> node found or would be written back.</p> +<pre class="programlisting">#define XMLSEC_X509DATA_SKI_NODE 0x00000008 +</pre> +<a class="ulink" href="" target="_top"><dsig:X509SKI/></a> node found or would be written back. </div> <hr> -<div class="REFSECT2"> +<div class="refsect2"> <a name="XMLSEC-X509DATA-CRL-NODE:CAPS"></a><h3>XMLSEC_X509DATA_CRL_NODE</h3> -<pre class="PROGRAMLISTING">#define XMLSEC_X509DATA_CRL_NODE 0x00000010</pre> -<p><dsig:X509CRL/> node found or would be written back.</p> +<pre class="programlisting">#define XMLSEC_X509DATA_CRL_NODE 0x00000010 +</pre> +<a class="ulink" href="" target="_top"><dsig:X509CRL/></a> node found or would be written back. </div> <hr> -<div class="REFSECT2"> +<div class="refsect2"> <a name="XMLSEC-X509DATA-DEFAULT:CAPS"></a><h3>XMLSEC_X509DATA_DEFAULT</h3> -<pre class="PROGRAMLISTING">#define XMLSEC_X509DATA_DEFAULT</pre> -<p>Default set of nodes to write in case of empty -<dsig:X509Data/> node template.</p> +<pre class="programlisting">#define XMLSEC_X509DATA_DEFAULT</pre> +<p>Default set of nodes to write in case of empty</p> +<a class="ulink" href="" target="_top"><dsig:X509Data/></a> node template. </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-xmltree.html"><b><<< xmltree</b></a></td> -<td align="right"><a accesskey="n" href="xmlsec-openssl-ref.html"><b>XML Security Library for OpenSLL API Reference. >>></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> |