python-nss-docs/nss.error.CertVerifyError-c...

350 строки
14 KiB
HTML

<?xml version="1.0" encoding="ascii"?>
<!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.error.CertVerifyError</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.error-module.html">Module&nbsp;error</a> ::
Class&nbsp;CertVerifyError
</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.error.CertVerifyError-class.html"
target="_top">no&nbsp;frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== TYPE DESCRIPTION ==================== -->
<h1 class="epydoc">type CertVerifyError</h1><p class="nomargin-top"></p>
<pre class="base-tree">
object --+
|
exceptions.BaseException --+
|
exceptions.Exception --+
|
<a href="nss.error.NSPRError-class.html">NSPRError</a> --+
|
<strong class="uidshort">CertVerifyError</strong>
</pre>
<hr />
<p>CertVerifyError(error_message=None, error_code=None, usages=None, log=None)</p>
<p>Exception object (derived from NSPRError), raised when an
error occurs during certificate verification.</p>
<p>Raised internally, there should be no need to raise this exception
from with a Python program using python-nss.</p>
<p>Certificate verification presents a problem for the normal error
handling model whereby any error returned from an underlying C
function causes a <a href="nss.error.NSPRError-class.html" class="link">NSPRError</a> exception to be raised. When an
exception is raised the return values are lost. It is unusual for a
function to have useful return values when the function also returns
an error.</p>
<p>The certificate verification functions are one such example. If
verification fails useful information concerning validated usages and
the verification log need to be available. But to be consistent with
model of always raising an exception on an error return some other
mechanism is needed to return the extra information. The solution is
to embed the information which normally would have been in the return
values in the exception object where it can be queried. The
CertVerifyError contails the returned usages bitmask and optionally
the <a href="nss.nss.CertVerifyLog-class.html" class="link">CertVerifyLog</a> verification log object if requested.</p>
<p>In addtion to the attributes in a <a href="nss.error.NSPRError-class.html" class="link">NSPRError</a> a CertVerifyError contains
the following attributes:</p>
<blockquote>
<dl class="rst-docutils">
<dt>usages</dt>
<dd>The retured usages bitmask (unsigned int) from the Certificate
verification function.</dd>
<dt>log</dt>
<dd>The (optional) <a href="nss.nss.CertVerifyLog-class.html" class="link">CertVerifyLog</a> object which contains the
diagnostic information for why a certificate failed to validate.</dd>
</dl>
</blockquote>
<!-- ==================== 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.error.CertVerifyError-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">error_message</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">error_code</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">usages</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">log</span>=<span class="summary-sig-default">None</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>
<td><span class="summary-sig"><a href="nss.error.CertVerifyError-class.html#__str__" class="summary-sig-name">__str__</a>(<span class="summary-sig-arg">x</span>)</span><br />
str(x)</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code>exceptions.Exception</code></b>:
<code>__new__</code>
</p>
<p class="indent-wrapped-lines"><b>Inherited from <code>exceptions.BaseException</code></b>:
<code>__delattr__</code>,
<code>__getattribute__</code>,
<code>__getitem__</code>,
<code>__getslice__</code>,
<code>__reduce__</code>,
<code>__repr__</code>,
<code>__setattr__</code>,
<code>__setstate__</code>,
<code>__unicode__</code>
</p>
</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="log"></a><span class="summary-name">log</span><br />
verifcation log, see <a href="nss.nss.CertVerifyLog-class.html" class="link">CertVerifyLog</a>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<a name="usages"></a><span class="summary-name">usages</span><br />
usages returned by NSS
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="nss.error.NSPRError-class.html">NSPRError</a></code></b>:
<code><a href="nss.error.NSPRError-class.html#errno">errno</a></code>,
<code><a href="nss.error.NSPRError-class.html#error_code">error_code</a></code>,
<code><a href="nss.error.NSPRError-class.html#error_desc">error_desc</a></code>,
<code><a href="nss.error.NSPRError-class.html#error_message">error_message</a></code>,
<code><a href="nss.error.NSPRError-class.html#strerror">strerror</a></code>
</p>
<p class="indent-wrapped-lines"><b>Inherited from <code>exceptions.BaseException</code></b>:
<code>args</code>,
<code>message</code>
</p>
</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">error_message</span>=<span class="sig-default">None</span>,
<span class="sig-arg">error_code</span>=<span class="sig-default">None</span>,
<span class="sig-arg">usages</span>=<span class="sig-default">None</span>,
<span class="sig-arg">log</span>=<span class="sig-default">None</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>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>error_message</code></strong> (string) - Detail message specific to this error.</li>
<li><strong class="pname"><code>error_code</code></strong> (int) - NSS or NSPR error value, if None get current error</li>
<li><strong class="pname"><code>usages</code></strong> (int) - The returned usages bitmaks from the verify function.</li>
<li><strong class="pname"><code>log</code></strong> (<a href="nss.nss.CertVerifyLog-class.html" class="link">CertVerifyLog</a> object) - The verification log generated during the verification
operation.</li>
</ul></dd>
<dt>Overrides:
exceptions.BaseException.__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:
exceptions.BaseException.__str__
</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">
Generated by Epydoc 3.0.1
</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>