/usr/share/doc/python-pika-doc/html/modules/credentials.html is in python-pika-doc 0.10.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Authentication Credentials — pika 0.10.0 documentation</title>
<link rel="stylesheet" href="../_static/classic.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '0.10.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="top" title="pika 0.10.0 documentation" href="../index.html" />
<link rel="up" title="Core Class and Module Documentation" href="index.html" />
<link rel="next" title="Exceptions" href="exceptions.html" />
<link rel="prev" title="Connection" href="connection.html" />
</head>
<body role="document">
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="exceptions.html" title="Exceptions"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="connection.html" title="Connection"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">pika 0.10.0 documentation</a> »</li>
<li class="nav-item nav-item-1"><a href="index.html" accesskey="U">Core Class and Module Documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="module-pika.credentials">
<span id="authentication-credentials"></span><h1>Authentication Credentials<a class="headerlink" href="#module-pika.credentials" title="Permalink to this headline">¶</a></h1>
<p>The credentials classes are used to encapsulate all authentication
information for the <a class="reference internal" href="parameters.html#pika.connection.ConnectionParameters" title="pika.connection.ConnectionParameters"><code class="xref py py-class docutils literal"><span class="pre">ConnectionParameters</span></code></a> class.</p>
<p>The <code class="xref py py-class docutils literal"><span class="pre">PlainCredentials</span></code> class returns the properly
formatted username and password to the <a class="reference internal" href="connection.html#pika.connection.Connection" title="pika.connection.Connection"><code class="xref py py-class docutils literal"><span class="pre">Connection</span></code></a>.</p>
<p>To authenticate with Pika, create a <code class="xref py py-class docutils literal"><span class="pre">PlainCredentials</span></code>
object passing in the username and password and pass it as the credentials
argument value to the <a class="reference internal" href="parameters.html#pika.connection.ConnectionParameters" title="pika.connection.ConnectionParameters"><code class="xref py py-class docutils literal"><span class="pre">ConnectionParameters</span></code></a> object.</p>
<p>If you are using <a class="reference internal" href="parameters.html#pika.connection.URLParameters" title="pika.connection.URLParameters"><code class="xref py py-class docutils literal"><span class="pre">URLParameters</span></code></a> you do not need a
credentials object, one will automatically be created for you.</p>
<p>If you are looking to implement SSL certificate style authentication, you would
extend the <code class="xref py py-class docutils literal"><span class="pre">ExternalCredentials</span></code> class implementing
the required behavior.</p>
<div class="section" id="plaincredentials">
<h2>PlainCredentials<a class="headerlink" href="#plaincredentials" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt>
<em class="property">class </em><code class="descclassname">pika.credentials.</code><code class="descname">PlainCredentials</code><span class="sig-paren">(</span><em>username</em>, <em>password</em>, <em>erase_on_connect=False</em><span class="sig-paren">)</span></dt>
<dd><p>A credentials object for the default authentication methodology with
RabbitMQ.</p>
<p>If you do not pass in credentials to the ConnectionParameters object, it
will create credentials for ‘guest’ with the password of ‘guest’.</p>
<p>If you pass True to erase_on_connect the credentials will not be stored
in memory after the Connection attempt has been made.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>username</strong> (<em>str</em>) – The username to authenticate with</li>
<li><strong>password</strong> (<em>str</em>) – The password to authenticate with</li>
<li><strong>erase_on_connect</strong> (<em>bool</em>) – erase credentials on connect.</li>
</ul>
</td>
</tr>
</tbody>
</table>
<dl class="method">
<dt>
<code class="descname">erase_credentials</code><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
<dd><p>Called by Connection when it no longer needs the credentials</p>
</dd></dl>
<dl class="method">
<dt>
<code class="descname">response_for</code><span class="sig-paren">(</span><em>start</em><span class="sig-paren">)</span></dt>
<dd><p>Validate that this type of authentication is supported</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>start</strong> (<a class="reference internal" href="spec.html#pika.spec.Connection.Start" title="pika.spec.Connection.Start"><em>spec.Connection.Start</em></a>) – Connection.Start method</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">tuple(str|None, str|None)</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="externalcredentials">
<h2>ExternalCredentials<a class="headerlink" href="#externalcredentials" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt>
<em class="property">class </em><code class="descclassname">pika.credentials.</code><code class="descname">ExternalCredentials</code></dt>
<dd><p>The ExternalCredentials class allows the connection to use EXTERNAL
authentication, generally with a client SSL certificate.</p>
<dl class="method">
<dt>
<code class="descname">erase_credentials</code><span class="sig-paren">(</span><span class="sig-paren">)</span></dt>
<dd><p>Called by Connection when it no longer needs the credentials</p>
</dd></dl>
<dl class="method">
<dt>
<code class="descname">response_for</code><span class="sig-paren">(</span><em>start</em><span class="sig-paren">)</span></dt>
<dd><p>Validate that this type of authentication is supported</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>start</strong> (<a class="reference internal" href="spec.html#pika.spec.Connection.Start" title="pika.spec.Connection.Start"><em>spec.Connection.Start</em></a>) – Connection.Start method</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">tuple(str or None, str or None)</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3><a href="../index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Authentication Credentials</a><ul>
<li><a class="reference internal" href="#plaincredentials">PlainCredentials</a></li>
<li><a class="reference internal" href="#externalcredentials">ExternalCredentials</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="connection.html"
title="previous chapter">Connection</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="exceptions.html"
title="next chapter">Exceptions</a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/modules/credentials.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="../search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="exceptions.html" title="Exceptions"
>next</a> |</li>
<li class="right" >
<a href="connection.html" title="Connection"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">pika 0.10.0 documentation</a> »</li>
<li class="nav-item nav-item-1"><a href="index.html" >Core Class and Module Documentation</a> »</li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2009-2015, Tony Garnock-Jones, Gavin M. Roy, Pivotal and others..
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.3.3.
</div>
</body>
</html>
|