-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathapi.html
More file actions
316 lines (197 loc) · 12 KB
/
Copy pathapi.html
File metadata and controls
316 lines (197 loc) · 12 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
305
306
307
308
309
310
311
312
313
314
315
316
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>API — krbcontext 0.10 documentation</title>
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></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>
<script type="text/javascript" src="_static/language_data.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Release Notes" href="release-notes.html" />
<link rel="prev" title="Using krbcontext" href="usage.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> krbcontext
</a>
<div class="version">
0.10
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="usage.html">Using krbcontext</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">API</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#krbcontext-context">krbcontext.context</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="release-notes.html">Release Notes</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">krbcontext</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html">Docs</a> »</li>
<li>API</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/api.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="api">
<h1>API<a class="headerlink" href="#api" title="Permalink to this headline">¶</a></h1>
<div class="section" id="krbcontext-context">
<h2>krbcontext.context<a class="headerlink" href="#krbcontext-context" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="krbcontext.context.krbContext">
<em class="property">class </em><code class="descclassname">krbcontext.context.</code><code class="descname">krbContext</code><span class="sig-paren">(</span><em>using_keytab=False</em>, <em>principal=None</em>, <em>keytab_file=None</em>, <em>ccache_file=None</em>, <em>password=None</em><span class="sig-paren">)</span><a class="headerlink" href="#krbcontext.context.krbContext" title="Permalink to this definition">¶</a></dt>
<dd><p>A context manager for Kerberos-related actions</p>
<p>krbContext is able to initialize credential cache automatically when the
cache is not valid.</p>
<p>krbContext aims to use Kerberos environment variable <code class="docutils literal notranslate"><span class="pre">KRB5CCNAME</span></code> to
point to a given local credential cache, which will be used by Kerberos
library, whatever the krb5 API or GSSAPI, to store ticket.</p>
<p>If default credential cache is used, it is unnecessary to point out to the
default by that variable, Kerberos library is able to handle that.</p>
<p>After credential cache is initialized, original value of <code class="docutils literal notranslate"><span class="pre">KRB5CCNAME</span></code>, if
have, must be restored. Otherwise, <code class="docutils literal notranslate"><span class="pre">KRB5CCNAME</span></code> must not be present in
program’s environment variables.</p>
<p>krbContext can work with <code class="docutils literal notranslate"><span class="pre">with</span></code> statement to simplify your code.</p>
<dl class="method">
<dt id="krbcontext.context.krbContext.__enter__">
<code class="descname">__enter__</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#krbcontext.context.krbContext.__enter__" title="Permalink to this definition">¶</a></dt>
<dd><p>Initialize ccache when necessary before executing user code</p>
<p>Lock is acquired as well before user code executes.</p>
</dd></dl>
<dl class="method">
<dt id="krbcontext.context.krbContext.__exit__">
<code class="descname">__exit__</code><span class="sig-paren">(</span><em>exc_type</em>, <em>exc_value</em>, <em>traceback</em><span class="sig-paren">)</span><a class="headerlink" href="#krbcontext.context.krbContext.__exit__" title="Permalink to this definition">¶</a></dt>
<dd><p>Clean context</p>
<p>If ccache is reinitialized, original value of <code class="docutils literal notranslate"><span class="pre">KRB5CCNAME</span></code> will be
restored correctly, if there was. And, lock gets released as well.</p>
</dd></dl>
<dl class="method">
<dt id="krbcontext.context.krbContext._prepare_context">
<code class="descname">_prepare_context</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#krbcontext.context.krbContext._prepare_context" title="Permalink to this definition">¶</a></dt>
<dd><p>Prepare context</p>
<p>Initialize credential cache with keytab or password according to
<code class="docutils literal notranslate"><span class="pre">using_keytab</span></code> parameter. Then, <code class="docutils literal notranslate"><span class="pre">KRB5CCNAME</span></code> is set properly so
that Kerberos library called in current context is able to get
credential from correct cache.</p>
<p>Internal use only.</p>
</dd></dl>
<dl class="method">
<dt id="krbcontext.context.krbContext.clean_options">
<code class="descname">clean_options</code><span class="sig-paren">(</span><em>using_keytab=False</em>, <em>principal=None</em>, <em>keytab_file=None</em>, <em>ccache_file=None</em>, <em>password=None</em><span class="sig-paren">)</span><a class="headerlink" href="#krbcontext.context.krbContext.clean_options" title="Permalink to this definition">¶</a></dt>
<dd><p>Clean argument to related object</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 simple">
<li><strong>using_keytab</strong> (<em>bool</em>) – refer to <code class="docutils literal notranslate"><span class="pre">krbContext.__init__</span></code>.</li>
<li><strong>principal</strong> (<em>str</em>) – refer to <code class="docutils literal notranslate"><span class="pre">krbContext.__init__</span></code>.</li>
<li><strong>keytab_file</strong> (<em>str</em>) – refer to <code class="docutils literal notranslate"><span class="pre">krbContext.__init__</span></code>.</li>
<li><strong>ccache_file</strong> (<em>str</em>) – refer to <code class="docutils literal notranslate"><span class="pre">krbContext.__init__</span></code>.</li>
<li><strong>password</strong> (<em>str</em>) – refer to <code class="docutils literal notranslate"><span class="pre">krbContext.__init__</span></code>.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">a mapping containing cleaned names and values, which are used
internally.</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first">dict</p>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><p class="first last"><strong>ValueError</strong> – principal is missing or given keytab file does not
exist, when initialize from a keytab.</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="krbcontext.context.krbContext.init_with_keytab">
<code class="descname">init_with_keytab</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#krbcontext.context.krbContext.init_with_keytab" title="Permalink to this definition">¶</a></dt>
<dd><p>Initialize credential cache with keytab</p>
</dd></dl>
<dl class="method">
<dt id="krbcontext.context.krbContext.init_with_password">
<code class="descname">init_with_password</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#krbcontext.context.krbContext.init_with_password" title="Permalink to this definition">¶</a></dt>
<dd><p>Initialize credential cache with password</p>
<p><strong>Causion:</strong> once you enter password from command line, or pass it to
API directly, the given password is not encrypted always. Although
getting credential with password works, from security point of view, it
is strongly recommended <strong>NOT</strong> use it in any formal production
environment. If you need to initialize credential in an application to
application Kerberos authentication context, keytab has to be used.</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">Raises:</th><td class="field-body"><strong>IOError</strong> – when trying to prompt to input password from command
line but no attry is available.</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="release-notes.html" class="btn btn-neutral float-right" title="Release Notes" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="usage.html" class="btn btn-neutral float-left" title="Using krbcontext" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2017, Chenxiong Qi
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>