mozilla
/
python-nss-docs
зеркало из https://github.com/mozilla/python-nss-docs.git
1
0
Форкнуть 0
Код Задачи Пакеты Проекты Релизы Вики Активность
python-nss-docs/nss.nss.PK11SymKey-class.html

547 строки
20 KiB
HTML
Исходник Постоянная ссылка Обычный вид История

upgrade to version 0.16.0
2014-10-27 20:02:58 +03:00
<?xml version="1.0" encoding="ascii"?>
Initial import of current python-nss docs.
2014-10-22 22:10:41 +04:00
<!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>nss.nss.PK11SymKey</title>
<link rel="stylesheet" href="epydoc.css" type="text/css" />
<script type="text/javascript" src="epydoc.js"></script>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="nss-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Tree link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Index link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Help link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
<th class="navbar" width="100%"></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<span class="breadcrumbs">
<a href="nss-module.html">Package&nbsp;nss</a> ::
<a href="nss.nss-module.html">Module&nbsp;nss</a> ::
Class&nbsp;PK11SymKey
</span>
</td>
<td>
<table cellpadding="0" cellspacing="0">
<!-- hide/show private -->
<tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
<tr><td align="right"><span class="options"
>[<a href="frames.html" target="_top">frames</a
>]&nbsp;|&nbsp;<a href="nss.nss.PK11SymKey-class.html"
target="_top">no&nbsp;frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
update doc to 1.0.0beta1
2016-08-09 18:59:41 +03:00
<!-- ==================== TYPE DESCRIPTION ==================== -->
<h1 class="epydoc">type PK11SymKey</h1><p class="nomargin-top"></p>
Initial import of current python-nss docs.
2014-10-22 22:10:41 +04:00
<pre class="base-tree">
object --+
|
<strong class="uidshort">PK11SymKey</strong>
</pre>
<hr />
Holds a hash, encryption or signing context for multi-part operations.
<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Instance Methods</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-InstanceMethods"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="nss.nss.PK11SymKey-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">...</span>)</span><br />
x.__init__(...) initializes x; see help(type(x)) for signature</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
update doc to 1.0.0beta1
2016-08-09 18:59:41 +03:00
<td><span class="summary-sig"><a href="nss.nss.PK11SymKey-class.html#__str__" class="summary-sig-name">__str__</a>(<span class="summary-sig-arg">x</span>)</span><br />
str(x)</td>
Initial import of current python-nss docs.
2014-10-22 22:10:41 +04:00
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
update doc to 1.0.0beta1
2016-08-09 18:59:41 +03:00
<span class="summary-type">PK11SymKey</span>
Initial import of current python-nss docs.
2014-10-22 22:10:41 +04:00
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
update doc to 1.0.0beta1
2016-08-09 18:59:41 +03:00
<td><span class="summary-sig"><a href="nss.nss.PK11SymKey-class.html#derive" class="summary-sig-name">derive</a>(<span class="summary-sig-arg">mechanism</span>,
<span class="summary-sig-arg">sec_param</span>,
<span class="summary-sig-arg">target</span>,
<span class="summary-sig-arg">operation</span>,
<span class="summary-sig-arg">key_size</span>)</span><br />
Derive a new key from this key.</td>
Initial import of current python-nss docs.
2014-10-22 22:10:41 +04:00
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
update doc to 1.0.0beta1
2016-08-09 18:59:41 +03:00
<span class="summary-type">string)</span>
Initial import of current python-nss docs.
2014-10-22 22:10:41 +04:00
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
update doc to 1.0.0beta1
2016-08-09 18:59:41 +03:00
<td><span class="summary-sig"><a href="nss.nss.PK11SymKey-class.html#format" class="summary-sig-name">format</a>(<span class="summary-sig-arg">level</span>=<span class="summary-sig-default">0</span>,
<span class="summary-sig-arg">indent</span>=<span class="summary-sig-default">' '</span>)</span><br />
This is equivalent to:
indented_format(obj.format_lines()) on an object providing a format_lines() method.</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">[(level, string),...]</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="nss.nss.PK11SymKey-class.html#format_lines" class="summary-sig-name">format_lines</a>(<span class="summary-sig-arg">level</span>=<span class="summary-sig-default">0</span>)</span><br />
Formats the object into a sequence of lines with indent level
information.</td>
Initial import of current python-nss docs.
2014-10-22 22:10:41 +04:00
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">PK11SymKey</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="nss.nss.PK11SymKey-class.html#unwrap_sym_key" class="summary-sig-name">unwrap_sym_key</a>(<span class="summary-sig-arg">mechanism</span>,
<span class="summary-sig-arg">sec_param</span>,
<span class="summary-sig-arg">wrapped_key</span>,
<span class="summary-sig-arg">target</span>,
<span class="summary-sig-arg">operation</span>,
<span class="summary-sig-arg">key_size</span>)</span><br />
Unwrap (decrypt) the supplied wrapped key.</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">SecItem</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="nss.nss.PK11SymKey-class.html#wrap_sym_key" class="summary-sig-name">wrap_sym_key</a>(<span class="summary-sig-arg">mechanism</span>,
<span class="summary-sig-arg">sec_param</span>,
<span class="summary-sig-arg">sym_key</span>)</span><br />
Wrap (encrypt) the supplied sym_key using the mechanism
and parameter.</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
</table>
<!-- ==================== PROPERTIES ==================== -->
<a name="section-Properties"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Properties</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-Properties"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<a name="key_data"></a><span class="summary-name">key_data</span><br />
key data
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<a name="key_length"></a><span class="summary-name">key_length</span><br />
key length
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<a name="mechanism"></a><span class="summary-name">mechanism</span><br />
CK_MECHANISM_TYPE mechanism
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<a name="slot"></a><span class="summary-name">slot</span><br />
slot
</td>
</tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Method Details</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-MethodDetails"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
</table>
<a name="__init__"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">...</span>)</span>
<br /><em class="fname">(Constructor)</em>
</h3>
</td><td align="right" valign="top"
>&nbsp;
</td>
</tr></table>
x.__init__(...) initializes x; see help(type(x)) for signature
<dl class="fields">
<dt>Overrides:
object.__init__
</dt>
</dl>
</td></tr></table>
</div>
<a name="__str__"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">__str__</span>(<span class="sig-arg">x</span>)</span>
<br /><em class="fname">(Informal representation operator)</em>
</h3>
</td><td align="right" valign="top"
>&nbsp;
</td>
</tr></table>
str(x)
<dl class="fields">
<dt>Overrides:
object.__str__
</dt>
</dl>
</td></tr></table>
</div>
<a name="derive"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">derive</span>(<span class="sig-arg">mechanism</span>,
<span class="sig-arg">sec_param</span>,
<span class="sig-arg">target</span>,
<span class="sig-arg">operation</span>,
<span class="sig-arg">key_size</span>)</span>
</h3>
</td><td align="right" valign="top"
>&nbsp;
</td>
</tr></table>
Derive a new key from this key.
Return a key which can do exactly one operation, it is
ephemeral (session key).
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>mechanism</code></strong> (int) - key mechanism enumeration constant (CKM_*)</li>
<li><strong class="pname"><code>sec_param</code></strong> (SecItem object or None) - mechanism parameters or None.</li>
<li><strong class="pname"><code>target</code></strong> (int) - key mechanism enumeration constant (CKM_*)</li>
<li><strong class="pname"><code>operation</code></strong> (int) - type of operation. A (CKA_*) constant
(e.g. CKA_ENCRYPT, CKA_DECRYPT, CKA_SIGN, CKA_VERIFY, CKA_DIGEST)</li>
<li><strong class="pname"><code>key_size</code></strong> (int) - key size.</li>
</ul></dd>
<dt>Returns: PK11SymKey</dt>
</dl>
</td></tr></table>
</div>
update doc to 1.0.0beta1
2016-08-09 18:59:41 +03:00
<a name="format"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">format</span>(<span class="sig-arg">level</span>=<span class="sig-default">0</span>,
<span class="sig-arg">indent</span>=<span class="sig-default">' '</span>)</span>
</h3>
</td><td align="right" valign="top"
>&nbsp;
</td>
</tr></table>
This is equivalent to:
indented_format(obj.format_lines()) on an object providing a format_lines() method.
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>level</code></strong> (integer) - Initial indentation level, all subsequent indents are relative
to this starting level.</li>
<li><strong class="pname"><code>indent</code></strong> (string) - string replicated once for each indent level then prepended to output line</li>
</ul></dd>
<dt>Returns: string)</dt>
</dl>
</td></tr></table>
</div>
<a name="format_lines"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">format_lines</span>(<span class="sig-arg">level</span>=<span class="sig-default">0</span>)</span>
</h3>
</td><td align="right" valign="top"
>&nbsp;
</td>
</tr></table>
<p>Formats the object into a sequence of lines with indent level
information. The return value is a list where each list item is a
tuple. The first item in the tuple is an integer
representing the indentation level for that line. Any remaining items
in the tuple are strings to be output on that line.</p>
<p>The output of this function can be formatted into a single string by
calling <a href="nss.nss-module.html#indented_format" class="link">nss.nss.indented\_format()</a>, e.g.:</p>
<blockquote>
print indented_format(obj.format_lines())</blockquote>
<p>The reason this function returns a tuple as opposed to an single
indented string is to support other text formatting systems such as
GUI's with indentation controls. See <a href="nss.nss-module.html#indented_format" class="link">nss.nss.indented\_format()</a> for a
complete explanation.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>level</code></strong> (integer) - Initial indentation level, all subsequent indents are relative
to this starting level.</li>
</ul></dd>
<dt>Returns: [(level, string),...]</dt>
</dl>
</td></tr></table>
</div>
Initial import of current python-nss docs.
2014-10-22 22:10:41 +04:00
<a name="unwrap_sym_key"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">unwrap_sym_key</span>(<span class="sig-arg">mechanism</span>,
<span class="sig-arg">sec_param</span>,
<span class="sig-arg">wrapped_key</span>,
<span class="sig-arg">target</span>,
<span class="sig-arg">operation</span>,
<span class="sig-arg">key_size</span>)</span>
</h3>
</td><td align="right" valign="top"
>&nbsp;
</td>
</tr></table>
Unwrap (decrypt) the supplied wrapped key.
Return the unwrapped key as a PK11SymKey.
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>mechanism</code></strong> (int) - key mechanism enumeration constant (CKM_*)</li>
<li><strong class="pname"><code>sec_param</code></strong> (SecItem object or None) - mechanism parameters or None.</li>
<li><strong class="pname"><code>wrapped_key</code></strong> (SecItem object) - the symmetric key to unwrap</li>
<li><strong class="pname"><code>target</code></strong> (int) - key mechanism enumeration constant (CKM_*)</li>
<li><strong class="pname"><code>operation</code></strong> (int) - type of operation. A (CKA_*) constant
(e.g. CKA_ENCRYPT, CKA_DECRYPT, CKA_SIGN, CKA_VERIFY, CKA_DIGEST)</li>
<li><strong class="pname"><code>key_size</code></strong> (int) - key size.</li>
</ul></dd>
<dt>Returns: PK11SymKey</dt>
</dl>
</td></tr></table>
</div>
<a name="wrap_sym_key"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">wrap_sym_key</span>(<span class="sig-arg">mechanism</span>,
<span class="sig-arg">sec_param</span>,
<span class="sig-arg">sym_key</span>)</span>
</h3>
</td><td align="right" valign="top"
>&nbsp;
</td>
</tr></table>
Wrap (encrypt) the supplied sym_key using the mechanism
and parameter. Return the wrapped key as a SecItem.
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>mechanism</code></strong> (int) - key mechanism enumeration constant (CKM_*)</li>
<li><strong class="pname"><code>sec_param</code></strong> (SecItem object or None) - mechanism parameters or None.</li>
<li><strong class="pname"><code>sym_key</code></strong> (PK11SymKey object) - the symmetric key to wrap</li>
</ul></dd>
<dt>Returns: SecItem</dt>
</dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="nss-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Tree link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Index link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Help link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
<th class="navbar" width="100%"></th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
update doc to 1.0.0beta1
2016-08-09 18:59:41 +03:00
Generated by Epydoc 3.0.1
Initial import of current python-nss docs.
2014-10-22 22:10:41 +04:00
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
>http://epydoc.sourceforge.net</a>
</td>
</tr>
</table>
<script type="text/javascript">
<!--
// Private objects are initially displayed (because if
// javascript is turned off then we want them to be
// visible); but by default, we want to hide them. So hide
// them unless we have a cookie that says to show them.
checkCookie();
// -->
</script>
</body>
</html>