summaryrefslogtreecommitdiff
path: root/docs/api/xmlsec-openssl-bn.html
diff options
context:
space:
mode:
Diffstat (limited to 'docs/api/xmlsec-openssl-bn.html')
-rw-r--r--docs/api/xmlsec-openssl-bn.html283
1 files changed, 101 insertions, 182 deletions
diff --git a/docs/api/xmlsec-openssl-bn.html b/docs/api/xmlsec-openssl-bn.html
index 138747cf..0f3ce994 100644
--- a/docs/api/xmlsec-openssl-bn.html
+++ b/docs/api/xmlsec-openssl-bn.html
@@ -1,244 +1,163 @@
+<!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>bn</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 OpenSLL API Reference." href="xmlsec-openssl-ref.html">
-<link rel="PREVIOUS" title="app" href="xmlsec-openssl-app.html">
-<link rel="NEXT" title="crypto" href="xmlsec-openssl-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>bn: 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-openssl-ref.html" title="XML Security Library for OpenSLL API Reference.">
+<link rel="prev" href="xmlsec-openssl-app.html" title="app">
+<link rel="next" href="xmlsec-openssl-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>
+<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-openssl-bn.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-openssl-app.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
-<td><a accesskey="u" href="xmlsec-openssl-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-openssl-ref.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
+<td><a accesskey="p" href="xmlsec-openssl-app.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="xmlsec-openssl-crypto.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
-<h1>
-<a name="XMLSEC-OPENSSL-BN"></a>bn</h1>
-<div class="REFNAMEDIV">
-<a name="AEN30079"></a><h2>Name</h2>bn -- Big numbers helper functions.</div>
-<div class="REFSECT1">
-<a name="XMLSEC-OPENSSL-BN.FUNCTIONS"></a><h2>Functions</h2>
-<div class="INFORMALTABLE">
-<p></p>
-<a name="AEN30084"></a><table border="0" frame="void" width="100%" class="CALSTABLE">
+<div class="refentry">
+<a name="xmlsec-openssl-bn"></a><div class="titlepage"></div>
+<div class="refnamediv"><table width="100%"><tr>
+<td valign="top">
+<h2><span class="refentrytitle"><a name="xmlsec-openssl-bn.top_of_page"></a>bn</span></h2>
+<p>bn — Big numbers (BIGNUM) support functions implementation for OpenSSL.</p>
+</td>
+<td class="gallery_image" valign="top" align="right"></td>
+</tr></table></div>
+<div class="refsect1">
+<a name="xmlsec-openssl-bn.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-openssl-bn.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">BIGNUM</span></font> *</td>
-<td>
-<a href="xmlsec-openssl-bn.html#XMLSECOPENSSLNODEGETBNVALUE">xmlSecOpenSSLNodeGetBNValue</a> <span class="c_punctuation"><span class="PHRASE">()</span></span>
+<td class="function_type">
+<font><span class="returnvalue">BIGNUM</span></font> *
+</td>
+<td class="function_name">
+<a class="link" href="xmlsec-openssl-bn.html#xmlSecOpenSSLNodeGetBNValue" title="xmlSecOpenSSLNodeGetBNValue ()">xmlSecOpenSSLNodeGetBNValue</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
-<td><font><span class="RETURNVALUE">int</span></font></td>
-<td>
-<a href="xmlsec-openssl-bn.html#XMLSECOPENSSLNODESETBNVALUE">xmlSecOpenSSLNodeSetBNValue</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-openssl-bn.html#xmlSecOpenSSLNodeSetBNValue" title="xmlSecOpenSSLNodeSetBNValue ()">xmlSecOpenSSLNodeSetBNValue</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
-</table>
-<p></p>
-</div>
+</table></div>
</div>
-<div class="REFSECT1">
-<a name="XMLSEC-OPENSSL-BN.DESCRIPTION"></a><h2>Description</h2>
-<p>Big numbers helper functions.</p>
+<div class="refsect1">
+<a name="xmlsec-openssl-bn.description"></a><h2>Description</h2>
+<p></p>
</div>
-<div class="REFSECT1">
-<a name="XMLSEC-OPENSSL-BN.FUNCTIONS_DETAILS"></a><h2>Functions</h2>
-<div class="REFSECT2">
-<a name="XMLSECOPENSSLNODEGETBNVALUE"></a><h3>xmlSecOpenSSLNodeGetBNValue ()</h3>
-<pre class="PROGRAMLISTING"><font><span class="RETURNVALUE">BIGNUM</span></font> *
-xmlSecOpenSSLNodeGetBNValue (<code class="PARAMETER">const <font><span class="TYPE">xmlNodePtr</span></font> cur</code>,
- <code class="PARAMETER"><font><span class="TYPE">BIGNUM</span></font> **a</code>);</pre>
+<div class="refsect1">
+<a name="xmlsec-openssl-bn.functions_details"></a><h2>Functions</h2>
+<div class="refsect2">
+<a name="xmlSecOpenSSLNodeGetBNValue"></a><h3>xmlSecOpenSSLNodeGetBNValue ()</h3>
+<pre class="programlisting"><font><span class="returnvalue">BIGNUM</span></font> *
+xmlSecOpenSSLNodeGetBNValue (<em class="parameter"><code>const <font><span class="type">xmlNodePtr</span></font> cur</code></em>,
+ <em class="parameter"><code><font><span class="type">BIGNUM</span></font> **a</code></em>);</pre>
<p>Converts the node content from CryptoBinary format
-(http://www.w3.org/TR/xmldsig-core/<font><span class="TYPE">sec-CryptoBinary</span></font>)
+(http://www.w3.org/TR/xmldsig-core/<font><span class="type">sec-CryptoBinary</span></font>)
to a BIGNUM. If no BIGNUM buffer provided then a new
BIGNUM is created (caller is responsible for freeing it).</p>
-<div class="REFSECT3">
-<a name="AEN30122"></a><h4>Parameters</h4>
-<div class="INFORMALTABLE">
-<p></p>
-<a name="AEN30124"></a><table border="0" frame="void" width="100%" class="CALSTABLE">
+<div class="refsect3">
+<a name="xmlSecOpenSSLNodeGetBNValue.parameters"></a><h4>Parameters</h4>
+<div class="informaltable"><table class="informaltable" width="100%" border="0">
+<colgroup>
<col>
<col>
<col>
+</colgroup>
<tbody>
<tr>
-<td><p>cur</p></td>
-<td><p>the poitner to an XML node.</p></td>
-<td> </td>
+<td class="parameter_name"><p>cur</p></td>
+<td class="parameter_description"><p>the pointer to an XML node.</p></td>
+<td class="parameter_annotations"> </td>
</tr>
<tr>
-<td><p>a</p></td>
-<td><p>the BIGNUM buffer.</p></td>
-<td> </td>
+<td class="parameter_name"><p>a</p></td>
+<td class="parameter_description"><p>the BIGNUM buffer.</p></td>
+<td class="parameter_annotations"> </td>
</tr>
</tbody>
-</table>
-<p></p>
+</table></div>
</div>
-</div>
-<div class="REFSECT3">
-<a name="AEN30139"></a><h4>Returns</h4>
+<div class="refsect3">
+<a name="xmlSecOpenSSLNodeGetBNValue.returns"></a><h4>Returns</h4>
<p> a pointer to BIGNUM produced from CryptoBinary string
or NULL if an error occurs.</p>
</div>
</div>
<hr>
-<div class="REFSECT2">
-<a name="XMLSECOPENSSLNODESETBNVALUE"></a><h3>xmlSecOpenSSLNodeSetBNValue ()</h3>
-<pre class="PROGRAMLISTING"><font><span class="RETURNVALUE">int</span></font>
-xmlSecOpenSSLNodeSetBNValue (<code class="PARAMETER"><font><span class="TYPE">xmlNodePtr</span></font> cur</code>,
- <code class="PARAMETER">const <font><span class="TYPE">BIGNUM</span></font> *a</code>,
- <code class="PARAMETER"><font><span class="TYPE">int</span></font> addLineBreaks</code>);</pre>
+<div class="refsect2">
+<a name="xmlSecOpenSSLNodeSetBNValue"></a><h3>xmlSecOpenSSLNodeSetBNValue ()</h3>
+<pre class="programlisting"><font><span class="returnvalue">int</span></font>
+xmlSecOpenSSLNodeSetBNValue (<em class="parameter"><code><font><span class="type">xmlNodePtr</span></font> cur</code></em>,
+ <em class="parameter"><code>const <font><span class="type">BIGNUM</span></font> *a</code></em>,
+ <em class="parameter"><code><font><span class="type">int</span></font> addLineBreaks</code></em>);</pre>
<p>Converts BIGNUM to CryptoBinary string
-(http://www.w3.org/TR/xmldsig-core/<font><span class="TYPE">sec-CryptoBinary</span></font>)
+(http://www.w3.org/TR/xmldsig-core/<font><span class="type">sec-CryptoBinary</span></font>)
and sets it as the content of the given node. If the
addLineBreaks is set then line breaks are added
before and after the CryptoBinary string.</p>
-<div class="REFSECT3">
-<a name="AEN30161"></a><h4>Parameters</h4>
-<div class="INFORMALTABLE">
-<p></p>
-<a name="AEN30163"></a><table border="0" frame="void" width="100%" class="CALSTABLE">
+<div class="refsect3">
+<a name="xmlSecOpenSSLNodeSetBNValue.parameters"></a><h4>Parameters</h4>
+<div class="informaltable"><table class="informaltable" width="100%" border="0">
+<colgroup>
<col>
<col>
<col>
+</colgroup>
<tbody>
<tr>
-<td><p>cur</p></td>
-<td><p>the pointer to an XML node.</p></td>
-<td> </td>
+<td class="parameter_name"><p>cur</p></td>
+<td class="parameter_description"><p>the pointer to an XML node.</p></td>
+<td class="parameter_annotations"> </td>
</tr>
<tr>
-<td><p>a</p></td>
-<td><p>the BIGNUM.</p></td>
-<td> </td>
+<td class="parameter_name"><p>a</p></td>
+<td class="parameter_description"><p>the BIGNUM.</p></td>
+<td class="parameter_annotations"> </td>
</tr>
<tr>
-<td><p>addLineBreaks</p></td>
-<td><p>if the flag is equal to 1 then
+<td class="parameter_name"><p>addLineBreaks</p></td>
+<td class="parameter_description"><p>if the flag is equal to 1 then
linebreaks will be added before and after
new buffer content.</p></td>
-<td> </td>
+<td class="parameter_annotations"> </td>
</tr>
</tbody>
-</table>
-<p></p>
+</table></div>
</div>
-</div>
-<div class="REFSECT3">
-<a name="AEN30184"></a><h4>Returns</h4>
+<div class="refsect3">
+<a name="xmlSecOpenSSLNodeSetBNValue.returns"></a><h4>Returns</h4>
<p> 0 on success or -1 otherwise.</p>
</div>
</div>
</div>
-<div class="REFSECT1">
-<a name="XMLSEC-OPENSSL-BN.OTHER_DETAILS"></a><h2>Types and Values</h2>
+<div class="refsect1">
+<a name="xmlsec-openssl-bn.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-openssl-app.html"><b>&lt;&lt;&lt; app</b></a></td>
-<td align="right"><a accesskey="n" href="xmlsec-openssl-crypto.html"><b>crypto &gt;&gt;&gt;</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>