forked from apache/cassandra-python-driver
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathauth.html
More file actions
304 lines (231 loc) · 21.4 KB
/
Copy pathauth.html
File metadata and controls
304 lines (231 loc) · 21.4 KB
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
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
<!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>cassandra.auth — Cassandra Driver 3.13.0 documentation</title>
<link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../../',
VERSION: '3.13.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</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="index" title="Index" href="../../genindex.html" />
<link rel="search" title="Search" href="../../search.html" />
<link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
</head>
<body>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<h1>Source code for cassandra.auth</h1><div class="highlight"><pre>
<span></span><span class="c1"># Copyright DataStax, Inc.</span>
<span class="c1">#</span>
<span class="c1"># Licensed under the Apache License, Version 2.0 (the "License");</span>
<span class="c1"># you may not use this file except in compliance with the License.</span>
<span class="c1"># You may obtain a copy of the License at</span>
<span class="c1">#</span>
<span class="c1"># http://www.apache.org/licenses/LICENSE-2.0</span>
<span class="c1">#</span>
<span class="c1"># Unless required by applicable law or agreed to in writing, software</span>
<span class="c1"># distributed under the License is distributed on an "AS IS" BASIS,</span>
<span class="c1"># WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
<span class="c1"># See the License for the specific language governing permissions and</span>
<span class="k">try</span><span class="p">:</span>
<span class="kn">from</span> <span class="nn">puresasl.client</span> <span class="k">import</span> <span class="n">SASLClient</span>
<span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span>
<span class="n">SASLClient</span> <span class="o">=</span> <span class="kc">None</span>
<div class="viewcode-block" id="AuthProvider"><a class="viewcode-back" href="../../api/cassandra/auth.html#cassandra.auth.AuthProvider">[docs]</a><span class="k">class</span> <span class="nc">AuthProvider</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> An abstract class that defines the interface that will be used for</span>
<span class="sd"> creating :class:`~.Authenticator` instances when opening new</span>
<span class="sd"> connections to Cassandra.</span>
<span class="sd"> .. versionadded:: 2.0.0</span>
<span class="sd"> """</span>
<div class="viewcode-block" id="AuthProvider.new_authenticator"><a class="viewcode-back" href="../../api/cassandra/auth.html#cassandra.auth.AuthProvider.new_authenticator">[docs]</a> <span class="k">def</span> <span class="nf">new_authenticator</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">host</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Implementations of this class should return a new instance</span>
<span class="sd"> of :class:`~.Authenticator` or one of its subclasses.</span>
<span class="sd"> """</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div></div>
<div class="viewcode-block" id="Authenticator"><a class="viewcode-back" href="../../api/cassandra/auth.html#cassandra.auth.Authenticator">[docs]</a><span class="k">class</span> <span class="nc">Authenticator</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> An abstract class that handles SASL authentication with Cassandra servers.</span>
<span class="sd"> Each time a new connection is created and the server requires authentication,</span>
<span class="sd"> a new instance of this class will be created by the corresponding</span>
<span class="sd"> :class:`~.AuthProvider` to handler that authentication. The lifecycle of the</span>
<span class="sd"> new :class:`~.Authenticator` will the be:</span>
<span class="sd"> 1) The :meth:`~.initial_response()` method will be called. The return</span>
<span class="sd"> value will be sent to the server to initiate the handshake.</span>
<span class="sd"> 2) The server will respond to each client response by either issuing a</span>
<span class="sd"> challenge or indicating that the authentication is complete (successful or not).</span>
<span class="sd"> If a new challenge is issued, :meth:`~.evaluate_challenge()`</span>
<span class="sd"> will be called to produce a response that will be sent to the</span>
<span class="sd"> server. This challenge/response negotiation will continue until the server</span>
<span class="sd"> responds that authentication is successful (or an :exc:`~.AuthenticationFailed`</span>
<span class="sd"> is raised).</span>
<span class="sd"> 3) When the server indicates that authentication is successful,</span>
<span class="sd"> :meth:`~.on_authentication_success` will be called a token string that</span>
<span class="sd"> that the server may optionally have sent.</span>
<span class="sd"> The exact nature of the negotiation between the client and server is specific</span>
<span class="sd"> to the authentication mechanism configured server-side.</span>
<span class="sd"> .. versionadded:: 2.0.0</span>
<span class="sd"> """</span>
<span class="n">server_authenticator_class</span> <span class="o">=</span> <span class="kc">None</span>
<span class="sd">""" Set during the connection AUTHENTICATE phase """</span>
<div class="viewcode-block" id="Authenticator.initial_response"><a class="viewcode-back" href="../../api/cassandra/auth.html#cassandra.auth.Authenticator.initial_response">[docs]</a> <span class="k">def</span> <span class="nf">initial_response</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Returns an message to send to the server to initiate the SASL handshake.</span>
<span class="sd"> :const:`None` may be returned to send an empty message.</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="kc">None</span></div>
<div class="viewcode-block" id="Authenticator.evaluate_challenge"><a class="viewcode-back" href="../../api/cassandra/auth.html#cassandra.auth.Authenticator.evaluate_challenge">[docs]</a> <span class="k">def</span> <span class="nf">evaluate_challenge</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">challenge</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Called when the server sends a challenge message. Generally, this method</span>
<span class="sd"> should return :const:`None` when authentication is complete from a</span>
<span class="sd"> client perspective. Otherwise, a string should be returned.</span>
<span class="sd"> """</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
<div class="viewcode-block" id="Authenticator.on_authentication_success"><a class="viewcode-back" href="../../api/cassandra/auth.html#cassandra.auth.Authenticator.on_authentication_success">[docs]</a> <span class="k">def</span> <span class="nf">on_authentication_success</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">token</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Called when the server indicates that authentication was successful.</span>
<span class="sd"> Depending on the authentication mechanism, `token` may be :const:`None`</span>
<span class="sd"> or a string.</span>
<span class="sd"> """</span>
<span class="k">pass</span></div></div>
<div class="viewcode-block" id="PlainTextAuthProvider"><a class="viewcode-back" href="../../api/cassandra/auth.html#cassandra.auth.PlainTextAuthProvider">[docs]</a><span class="k">class</span> <span class="nc">PlainTextAuthProvider</span><span class="p">(</span><span class="n">AuthProvider</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> An :class:`~.AuthProvider` that works with Cassandra's PasswordAuthenticator.</span>
<span class="sd"> Example usage::</span>
<span class="sd"> from cassandra.cluster import Cluster</span>
<span class="sd"> from cassandra.auth import PlainTextAuthProvider</span>
<span class="sd"> auth_provider = PlainTextAuthProvider(</span>
<span class="sd"> username='cassandra', password='cassandra')</span>
<span class="sd"> cluster = Cluster(auth_provider=auth_provider)</span>
<span class="sd"> .. versionadded:: 2.0.0</span>
<span class="sd"> """</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">username</span><span class="p">,</span> <span class="n">password</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">username</span> <span class="o">=</span> <span class="n">username</span>
<span class="bp">self</span><span class="o">.</span><span class="n">password</span> <span class="o">=</span> <span class="n">password</span>
<span class="k">def</span> <span class="nf">new_authenticator</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">host</span><span class="p">):</span>
<span class="k">return</span> <span class="n">PlainTextAuthenticator</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">username</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">password</span><span class="p">)</span></div>
<div class="viewcode-block" id="PlainTextAuthenticator"><a class="viewcode-back" href="../../api/cassandra/auth.html#cassandra.auth.PlainTextAuthenticator">[docs]</a><span class="k">class</span> <span class="nc">PlainTextAuthenticator</span><span class="p">(</span><span class="n">Authenticator</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> An :class:`~.Authenticator` that works with Cassandra's PasswordAuthenticator.</span>
<span class="sd"> .. versionadded:: 2.0.0</span>
<span class="sd"> """</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">username</span><span class="p">,</span> <span class="n">password</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">username</span> <span class="o">=</span> <span class="n">username</span>
<span class="bp">self</span><span class="o">.</span><span class="n">password</span> <span class="o">=</span> <span class="n">password</span>
<span class="k">def</span> <span class="nf">initial_response</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="s2">"</span><span class="se">\x00</span><span class="si">%s</span><span class="se">\x00</span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">username</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">password</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">evaluate_challenge</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">challenge</span><span class="p">):</span>
<span class="k">return</span> <span class="kc">None</span></div>
<div class="viewcode-block" id="SaslAuthProvider"><a class="viewcode-back" href="../../api/cassandra/auth.html#cassandra.auth.SaslAuthProvider">[docs]</a><span class="k">class</span> <span class="nc">SaslAuthProvider</span><span class="p">(</span><span class="n">AuthProvider</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> An :class:`~.AuthProvider` supporting general SASL auth mechanisms</span>
<span class="sd"> Suitable for GSSAPI or other SASL mechanisms</span>
<span class="sd"> Example usage::</span>
<span class="sd"> from cassandra.cluster import Cluster</span>
<span class="sd"> from cassandra.auth import SaslAuthProvider</span>
<span class="sd"> sasl_kwargs = {'service': 'something',</span>
<span class="sd"> 'mechanism': 'GSSAPI',</span>
<span class="sd"> 'qops': 'auth'.split(',')}</span>
<span class="sd"> auth_provider = SaslAuthProvider(**sasl_kwargs)</span>
<span class="sd"> cluster = Cluster(auth_provider=auth_provider)</span>
<span class="sd"> .. versionadded:: 2.1.4</span>
<span class="sd"> """</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">**</span><span class="n">sasl_kwargs</span><span class="p">):</span>
<span class="k">if</span> <span class="n">SASLClient</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ImportError</span><span class="p">(</span><span class="s1">'The puresasl library has not been installed'</span><span class="p">)</span>
<span class="k">if</span> <span class="s1">'host'</span> <span class="ow">in</span> <span class="n">sasl_kwargs</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"kwargs should not contain 'host' since it is passed dynamically to new_authenticator"</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">sasl_kwargs</span> <span class="o">=</span> <span class="n">sasl_kwargs</span>
<span class="k">def</span> <span class="nf">new_authenticator</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">host</span><span class="p">):</span>
<span class="k">return</span> <span class="n">SaslAuthenticator</span><span class="p">(</span><span class="n">host</span><span class="p">,</span> <span class="o">**</span><span class="bp">self</span><span class="o">.</span><span class="n">sasl_kwargs</span><span class="p">)</span></div>
<div class="viewcode-block" id="SaslAuthenticator"><a class="viewcode-back" href="../../api/cassandra/auth.html#cassandra.auth.SaslAuthenticator">[docs]</a><span class="k">class</span> <span class="nc">SaslAuthenticator</span><span class="p">(</span><span class="n">Authenticator</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> A pass-through :class:`~.Authenticator` using the third party package</span>
<span class="sd"> 'pure-sasl' for authentication</span>
<span class="sd"> .. versionadded:: 2.1.4</span>
<span class="sd"> """</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">host</span><span class="p">,</span> <span class="n">service</span><span class="p">,</span> <span class="n">mechanism</span><span class="o">=</span><span class="s1">'GSSAPI'</span><span class="p">,</span> <span class="o">**</span><span class="n">sasl_kwargs</span><span class="p">):</span>
<span class="k">if</span> <span class="n">SASLClient</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ImportError</span><span class="p">(</span><span class="s1">'The puresasl library has not been installed'</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">sasl</span> <span class="o">=</span> <span class="n">SASLClient</span><span class="p">(</span><span class="n">host</span><span class="p">,</span> <span class="n">service</span><span class="p">,</span> <span class="n">mechanism</span><span class="p">,</span> <span class="o">**</span><span class="n">sasl_kwargs</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">initial_response</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">sasl</span><span class="o">.</span><span class="n">process</span><span class="p">()</span>
<span class="k">def</span> <span class="nf">evaluate_challenge</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">challenge</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">sasl</span><span class="o">.</span><span class="n">process</span><span class="p">(</span><span class="n">challenge</span><span class="p">)</span></div>
</pre></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="../../index.html">Cassandra Driver</a></h1>
<p class="blurb">Python driver for Cassandra</p>
<p>
<iframe src="https://ghbtns.com/github-btn.html?user=datastax&repo=python-driver&type=star&count=true&size=large&v=2"
allowtransparency="true" frameborder="0" scrolling="0" width="200px" height="35px"></iframe>
</p>
<h3>Navigation</h3>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../api/index.html">API Documentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../getting_started.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../upgrading.html">Upgrading</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../execution_profiles.html">Execution Profiles</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../performance.html">Performance Notes</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../query_paging.html">Paging Large Queries</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../lwt.html">Lightweight Transactions (Compare-and-set)</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../security.html">Security</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../user_defined_types.html">User Defined Types</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../object_mapper.html">Object Mapper</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../dates_and_times.html">Working with Dates and Times</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../faq.html">Frequently Asked Questions</a></li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="../../index.html">Documentation overview</a><ul>
<li><a href="../index.html">Module code</a><ul>
<li><a href="../cassandra.html">cassandra</a><ul>
</ul></li>
</ul></li>
</ul></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="../../search.html" method="get">
<div><input type="text" name="q" /></div>
<div><input type="submit" value="Go" /></div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
©2013-2017 DataStax.
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.6.6</a>
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a>
</div>
</body>
</html>