Why Gemfury? Push, build, and install  RubyGems npm packages Python packages Maven artifacts PHP packages Go Modules Debian packages RPM packages NuGet packages

Repository URL to install this package:

Details    
pyxmlsec / docs / html / xmlsec.KeysMngr-class.html
Size: Mime:
<?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.KeysMngr</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">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</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&nbsp;xmlsec</a> ::
        Class&nbsp;KeysMngr
      </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>&nbsp;|&nbsp;<a href="xmlsec.KeysMngr-class.html" target="_top">no&nbsp;frames</a>]</font></td></tr>
    </table></td>
</tr></table>

<!-- =========== START OF CLASS DESCRIPTION =========== -->
<h2 class="class">Class KeysMngr</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">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="xmlsec.KeysMngr-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 new keys manager.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</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">&nbsp;</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">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="xmlsec.KeysMngr-class.html#adoptDataStore" class="summary-sig-name"><code>adoptDataStore</code></a>(<span class=summary-sig-arg>self</span>,
          <span class=summary-sig-arg>store</span>)</span></code>
<br />
Adopts data store in the keys manager.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="xmlsec.KeysMngr-class.html#adoptKeysStore" class="summary-sig-name"><code>adoptKeysStore</code></a>(<span class=summary-sig-arg>self</span>,
          <span class=summary-sig-arg>store</span>)</span></code>
<br />
Adopts keys store in the keys manager mngr.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="xmlsec.KeysMngr-class.html#certLoad" class="summary-sig-name"><code>certLoad</code></a>(<span class=summary-sig-arg>self</span>,
          <span class=summary-sig-arg>filename</span>,
          <span class=summary-sig-arg>format</span>,
          <span class=summary-sig-arg>type</span>)</span></code>
<br />
Reads cert from filename and adds to the list of trusted
or known untrusted certs in store.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="xmlsec.KeysMngr-class.html#destroy" class="summary-sig-name"><code>destroy</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Destroys keys manager...</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="xmlsec.KeysMngr-class.html#findKey" class="summary-sig-name"><code>findKey</code></a>(<span class=summary-sig-arg>self</span>,
          <span class=summary-sig-arg>name</span>,
          <span class=summary-sig-arg>key_info_ctx</span>)</span></code>
<br />
Lookups key in the keys manager keys store.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="xmlsec.KeysMngr-class.html#getDataStore" class="summary-sig-name"><code>getDataStore</code></a>(<span class=summary-sig-arg>self</span>,
          <span class=summary-sig-arg>id</span>)</span></code>
<br />
Lookups the data store of given klass id in the keys manager.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="xmlsec.KeysMngr-class.html#getKeysStore" class="summary-sig-name"><code>getKeysStore</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Gets the keys store.</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 new keys manager. Caller is responsible for freeing it with
destroy method.
Returns : the newly keys manager or None if an error occurs.
</pre>
  <dl><dt></dt><dd>
  </dd></dl>
</td></tr></table>

<a name="adoptDataStore"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
  <h3><span class="sig"><span class="sig-name">adoptDataStore</span>(<span class=sig-arg>self</span>,
          <span class=sig-arg>store</span>)</span>
  </h3>
<pre class="literalblock">
Adopts data store in the keys manager.
store   : the data store.
Returns : 0 on success or a negative value if an error occurs.
</pre>
  <dl><dt></dt><dd>
  </dd></dl>
</td></tr></table>

<a name="adoptKeysStore"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
  <h3><span class="sig"><span class="sig-name">adoptKeysStore</span>(<span class=sig-arg>self</span>,
          <span class=sig-arg>store</span>)</span>
  </h3>
<pre class="literalblock">
Adopts keys store in the keys manager mngr.
store   : the keys store.
Returns : 0 on success or a negative value if an error occurs.
</pre>
  <dl><dt></dt><dd>
  </dd></dl>
</td></tr></table>

<a name="certLoad"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
  <h3><span class="sig"><span class="sig-name">certLoad</span>(<span class=sig-arg>self</span>,
          <span class=sig-arg>filename</span>,
          <span class=sig-arg>format</span>,
          <span class=sig-arg>type</span>)</span>
  </h3>
<pre class="literalblock">
Reads cert from filename and adds to the list of trusted
or known untrusted certs in store.
filename : the certificate file.
format   : the certificate file format.
type     : the flag that indicates is the certificate in filename
trusted or not.
Returns  : 0 on success or a negative value otherwise.
</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 keys manager
</pre>
  <dl><dt></dt><dd>
  </dd></dl>
</td></tr></table>

<a name="findKey"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
  <h3><span class="sig"><span class="sig-name">findKey</span>(<span class=sig-arg>self</span>,
          <span class=sig-arg>name</span>,
          <span class=sig-arg>key_info_ctx</span>)</span>
  </h3>
<pre class="literalblock">
Lookups key in the keys manager keys store.
name       : the desired key name.
keyInfoCtx : the &lt;dsig:KeyInfo/&gt; node processing context.
Returns    : a key or None if key is not found or an error occurs.
</pre>
  <dl><dt></dt><dd>
  </dd></dl>
</td></tr></table>

<a name="getDataStore"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
  <h3><span class="sig"><span class="sig-name">getDataStore</span>(<span class=sig-arg>self</span>,
          <span class=sig-arg>id</span>)</span>
  </h3>
<pre class="literalblock">
Lookups the data store of given klass id in the keys manager.
id      : the desired data store klass.
Returns : data store or None if it is not found or an error occurs.
</pre>
  <dl><dt></dt><dd>
  </dd></dl>
</td></tr></table>

<a name="getKeysStore"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
  <h3><span class="sig"><span class="sig-name">getKeysStore</span>(<span class=sig-arg>self</span>)</span>
  </h3>
<pre class="literalblock">
Gets the keys store.
Returns : the keys store in the keys manager mngr or None if there is
no store or 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">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</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>