Why Gemfury?
Push, build, and install
RubyGems
npm packages
Python packages
Maven artifacts
PHP packages
Go Modules
Debian packages
RPM packages
NuGet packages
360core
Repository URL to install this package:
|
Version:
0.3.0 ▾
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>xmlsec.Key</title>
<link rel="stylesheet" href="epydoc.css" type="text/css"></link>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- =========== START OF NAVBAR =========== -->
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
<tr valign="center">
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center">
<p class="nomargin">
<a class="navbar" target="_top" href="http://pyxmlsec.labs.libre-entreprise.org">PyXMLSec</a>
</p></th></tr></table>
</th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<font size="-1"><b class="breadcrumbs">
<a href="xmlsec-module.html">Module xmlsec</a> ::
Class Key
</b></font></br>
</td>
<td><table cellpadding="0" cellspacing="0">
<tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="xmlsec.Key-class.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF CLASS DESCRIPTION =========== -->
<h2 class="class">Class Key</h2>
<hr/>
<!-- =========== START OF METHOD SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Method Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="xmlsec.Key-class.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>_obj</span>)</span></code>
<br />
Creates and initializes new key.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="__getattr__"></a><span class="summary-sig"><span class="summary-sig-name">__getattr__</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>name</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="__setattr__"></a><span class="summary-sig"><span class="summary-sig-name">__setattr__</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>name</span>,
<span class=summary-sig-arg>value</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="xmlsec.Key-class.html#adoptData" class="summary-sig-name"><code>adoptData</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>data</span>)</span></code>
<br />
Adds data to the key.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="xmlsec.Key-class.html#checkId" class="summary-sig-name"><code>checkId</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>keyId</span>)</span></code>
<br />
Returns 1 if key is valid and key's id is equal to keyId.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="xmlsec.Key-class.html#copy" class="summary-sig-name"><code>copy</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>keyDst</span>)</span></code>
<br />
Copies key data to keyDst.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="xmlsec.Key-class.html#debugDump" class="summary-sig-name"><code>debugDump</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>output</span>)</span></code>
<br />
Prints the information about the key to the output.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="xmlsec.Key-class.html#debugXmlDump" class="summary-sig-name"><code>debugXmlDump</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>output</span>)</span></code>
<br />
Prints the information about the key to the output in XML format.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="xmlsec.Key-class.html#destroy" class="summary-sig-name"><code>destroy</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Destroys the key...</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="xmlsec.Key-class.html#duplicate" class="summary-sig-name"><code>duplicate</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Creates a duplicate of the given key.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="xmlsec.Key-class.html#empty" class="summary-sig-name"><code>empty</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Clears the key data.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="xmlsec.Key-class.html#ensureData" class="summary-sig-name"><code>ensureData</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>dataId</span>)</span></code>
<br />
If necessary, creates key data of dataId klass and adds to key.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="xmlsec.Key-class.html#getData" class="summary-sig-name"><code>getData</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>dataId</span>)</span></code>
<br />
Gets key's data (see also adoptData method).</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="xmlsec.Key-class.html#getName" class="summary-sig-name"><code>getName</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Gets key name (see also setName function).</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="xmlsec.Key-class.html#getType" class="summary-sig-name"><code>getType</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Gets key type.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="xmlsec.Key-class.html#getValue" class="summary-sig-name"><code>getValue</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Gets key value (see also setValue method).</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="xmlsec.Key-class.html#isValid" class="summary-sig-name"><code>isValid</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Returns 1 if key is not None and key->id is not None or 0 otherwise.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="xmlsec.Key-class.html#match" class="summary-sig-name"><code>match</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>name</span>,
<span class=summary-sig-arg>keyReq</span>)</span></code>
<br />
Checks whether the key matches the given criteria.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="xmlsec.Key-class.html#setName" class="summary-sig-name"><code>setName</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>name</span>)</span></code>
<br />
Sets key name (see also getName function).</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="xmlsec.Key-class.html#setValue" class="summary-sig-name"><code>setValue</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>value</span>)</span></code>
<br />
Sets key value (see also setValue method).</td></tr>
</table><br />
<!-- =========== START OF METHOD DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Method Details</th></tr>
</table>
<a name="__init__"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">__init__</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>_obj</span>=<span class=sig-default>None</span>)</span>
<br /><i>(Constructor)</i>
</h3>
<pre class="literalblock">
Creates and initializes new key. Caller is responsible for freeing
returned object with destroy method.
Returns : the newly key or None if an error occurs.
</pre>
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="adoptData"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">adoptData</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>data</span>)</span>
</h3>
<pre class="literalblock">
Adds data to the key. The data object will be destroyed by key.
data : the key data.
Returns : 0 on success or a negative value otherwise.
</pre>
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="checkId"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">checkId</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>keyId</span>)</span>
</h3>
<pre class="literalblock">
Returns 1 if key is valid and key's id is equal to keyId.
keyId : the key Id.
</pre>
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="copy"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">copy</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>keyDst</span>)</span>
</h3>
<pre class="literalblock">
Copies key data to keyDst.
keyDst : the destination key.
Returns : 0 on success or a negative value if an error occurs.
</pre>
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="debugDump"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">debugDump</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>output</span>)</span>
</h3>
<pre class="literalblock">
Prints the information about the key to the output.
output : the output FILE.
</pre>
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="debugXmlDump"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">debugXmlDump</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>output</span>)</span>
</h3>
<pre class="literalblock">
Prints the information about the key to the output in XML format.
output : the output FILE.
</pre>
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="destroy"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">destroy</span>(<span class=sig-arg>self</span>)</span>
</h3>
<pre class="literalblock">
Destroys the key
</pre>
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="duplicate"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">duplicate</span>(<span class=sig-arg>self</span>)</span>
</h3>
<pre class="literalblock">
Creates a duplicate of the given key.
Returns : the newly key or None if an error occurs.
</pre>
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="empty"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">empty</span>(<span class=sig-arg>self</span>)</span>
</h3>
<pre class="literalblock">
Clears the key data.
</pre>
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="ensureData"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">ensureData</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>dataId</span>)</span>
</h3>
<pre class="literalblock">
If necessary, creates key data of dataId klass and adds to key.
dataId : the requested data klass.
Returns : key data or None if an error occurs.
</pre>
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="getData"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">getData</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>dataId</span>)</span>
</h3>
<pre class="literalblock">
Gets key's data (see also adoptData method).
dataId : the requested data klass.
Returns : additional data associated with the key.
</pre>
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="getName"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">getName</span>(<span class=sig-arg>self</span>)</span>
</h3>
<pre class="literalblock">
Gets key name (see also setName function).
Returns : key name.
</pre>
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="getType"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">getType</span>(<span class=sig-arg>self</span>)</span>
</h3>
<pre class="literalblock">
Gets key type.
Returns : key type.
</pre>
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="getValue"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">getValue</span>(<span class=sig-arg>self</span>)</span>
</h3>
<pre class="literalblock">
Gets key value (see also setValue method).
Returns : key value (crypto material).
</pre>
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="isValid"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">isValid</span>(<span class=sig-arg>self</span>)</span>
</h3>
<pre class="literalblock">
Returns 1 if key is not None and key->id is not None or 0 otherwise.
</pre>
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="match"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">match</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>name</span>,
<span class=sig-arg>keyReq</span>)</span>
</h3>
<pre class="literalblock">
Checks whether the key matches the given criteria.
name : the key name (may be None).
keyReq : the key requirements.
Returns : 1 if the key satisfies the given criteria or 0 otherwise.
</pre>
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="setName"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">setName</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>name</span>)</span>
</h3>
<pre class="literalblock">
Sets key name (see also getName function).
name : the new key name.
Returns : 0 on success or a negative value if an error occurs.
</pre>
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="setValue"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">setValue</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>value</span>)</span>
</h3>
<pre class="literalblock">
Sets key value (see also setValue method).
value : the new value.
Returns : 0 on success or a negative value if an error occurs.
</pre>
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<br />
<!-- =========== START OF NAVBAR =========== -->
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
<tr valign="center">
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center">
<p class="nomargin">
<a class="navbar" target="_top" href="http://pyxmlsec.labs.libre-entreprise.org">PyXMLSec</a>
</p></th></tr></table>
</th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Jan 1 18:42:41 2006</font></td>
<td align="right"><a href="http://epydoc.sourceforge.net"
><font size="-2">http://epydoc.sf.net</font></a></td>
</tr>
</table>
</body>
</html>