-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathusage.html
More file actions
311 lines (198 loc) · 13.1 KB
/
Copy pathusage.html
File metadata and controls
311 lines (198 loc) · 13.1 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
<!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>Using krbcontext — 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="API" href="api.html" />
<link rel="prev" title="Welcome to krbcontext’s documentation!" href="index.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 current"><a class="current reference internal" href="#">Using krbcontext</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#lazy-initialization">Lazy Initialization</a></li>
<li class="toctree-l2"><a class="reference internal" href="#thread-safe">Thread-safe</a></li>
<li class="toctree-l2"><a class="reference internal" href="#dependencies">Dependencies</a></li>
<li class="toctree-l2"><a class="reference internal" href="#installation">Installation</a></li>
<li class="toctree-l2"><a class="reference internal" href="#usage">Usage</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#basic">Basic</a></li>
<li class="toctree-l3"><a class="reference internal" href="#as-a-regular-user">As a regular user</a></li>
<li class="toctree-l3"><a class="reference internal" href="#using-service-keytab">Using service Keytab</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#backward-compatibility">Backward Compatibility</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="api.html">API</a></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>Using krbcontext</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/usage.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="using-krbcontext">
<h1>Using krbcontext<a class="headerlink" href="#using-krbcontext" title="Permalink to this headline">¶</a></h1>
<p><code class="docutils literal notranslate"><span class="pre">krbcontext</span></code> provides a Kerberos context that you can put code inside, which
requires a valid ticket in credential cache.</p>
<p><code class="docutils literal notranslate"><span class="pre">krbcontext</span></code> is able to initialize credential cache automatically on behalf
of you according to the options you specify. It can initialize with keytab or a
regular user’s Kerberos name and password.</p>
<p>You can use <code class="docutils literal notranslate"><span class="pre">krbcontext</span></code> as a context manager with <code class="docutils literal notranslate"><span class="pre">with</span></code> statement, or
call API directly to check credential cache and even initialize by yourself.</p>
<div class="section" id="lazy-initialization">
<h2>Lazy Initialization<a class="headerlink" href="#lazy-initialization" title="Permalink to this headline">¶</a></h2>
<p>Current version of <code class="docutils literal notranslate"><span class="pre">krbcontext</span></code> is able to detect whether specified cache is
a valid credential cache file and contains valid and non-expired ticket. So,
only initializes credential cache when it is necessary.</p>
</div>
<div class="section" id="thread-safe">
<h2>Thread-safe<a class="headerlink" href="#thread-safe" title="Permalink to this headline">¶</a></h2>
<p><code class="docutils literal notranslate"><span class="pre">krbcontext</span></code> manages its own threading lock, and it is acquired when entering
context and gets released when exit. It is recommended that you just put the
necessary code, which requires a valid Kerberos ticket, inside context.</p>
</div>
<div class="section" id="dependencies">
<h2>Dependencies<a class="headerlink" href="#dependencies" title="Permalink to this headline">¶</a></h2>
<p><code class="docutils literal notranslate"><span class="pre">krbcontext</span></code> requires <a class="reference external" href="https://github.com/pythongssapi/python-gssapi">python-gssapi</a>.</p>
</div>
<div class="section" id="installation">
<h2>Installation<a class="headerlink" href="#installation" title="Permalink to this headline">¶</a></h2>
<p>Using <a class="reference external" href="https://pypi.python.org/pypi/virtualenv/">virtual environment</a></p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">virtualenv</span> <span class="n">myproject</span>
<span class="o">.</span> <span class="n">myproject</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">activate</span>
<span class="n">pip</span> <span class="n">install</span> <span class="n">krbcontext</span>
</pre></div>
</div>
</div>
<div class="section" id="usage">
<h2>Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2>
<p>For details of API, please refer to <a class="reference external" href="api.html">API</a>. Here are some use cases.</p>
<div class="section" id="basic">
<h3>Basic<a class="headerlink" href="#basic" title="Permalink to this headline">¶</a></h3>
<p>krbcontext can be used as a normal context manager simply.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">with</span> <span class="n">krbContext</span><span class="p">():</span>
<span class="c1"># your code here</span>
<span class="k">pass</span>
</pre></div>
</div>
</div>
<div class="section" id="as-a-regular-user">
<h3>As a regular user<a class="headerlink" href="#as-a-regular-user" title="Permalink to this headline">¶</a></h3>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">with</span> <span class="n">krbContext</span><span class="p">():</span>
<span class="k">pass</span>
</pre></div>
</div>
<p>This is the most simplest way, which uses default values. It gets current
effective user name, and get ticket and store it into default credential cache.</p>
<p>You can specify specific prinicpal or cache file explicityly.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">with</span> <span class="n">krbContext</span><span class="p">(</span><span class="n">principal</span><span class="o">=</span><span class="s1">'qcxhome@EXAMPLE.COM'</span><span class="p">,</span>
<span class="n">ccache_file</span><span class="o">=</span><span class="s1">'/tmp/krb5cc_my'</span><span class="p">):</span>
<span class="k">pass</span>
<span class="k">with</span> <span class="n">krbContext</span><span class="p">(</span><span class="n">principal</span><span class="o">=</span><span class="s1">'qcxhome'</span><span class="p">,</span>
<span class="n">ccache_file</span><span class="o">=</span><span class="s1">'/tmp/my_cc'</span><span class="p">):</span>
<span class="k">pass</span>
</pre></div>
</div>
</div>
<div class="section" id="using-service-keytab">
<h3>Using service Keytab<a class="headerlink" href="#using-service-keytab" title="Permalink to this headline">¶</a></h3>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">with</span> <span class="n">krbContext</span><span class="p">(</span><span class="n">using_keytab</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
<span class="n">principal</span><span class="o">=</span><span class="s1">'HTTP/localhost@EXAMPLE.COM'</span><span class="p">):</span>
<span class="k">pass</span>
</pre></div>
</div>
<p><code class="docutils literal notranslate"><span class="pre">principal</span></code> must be specified when initialize with keytab. In this example,
<code class="docutils literal notranslate"><span class="pre">keytab_file</span></code> is omitted, that means to use default keytab file.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">with</span> <span class="n">krbContext</span><span class="p">(</span><span class="n">using_keytab</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
<span class="n">principal</span><span class="o">=</span><span class="s1">'HTTP/localhost@EXAMPLE.COM'</span><span class="p">,</span>
<span class="n">keytab_file</span><span class="o">=</span><span class="s1">'/etc/httpd/conf/httpd.keytab'</span><span class="p">,</span>
<span class="n">ccache_file</span><span class="o">=</span><span class="s1">'/tmp/krb5cc_pid_appname'</span><span class="p">):</span>
<span class="k">pass</span>
</pre></div>
</div>
<p>Alternatively, following example shows to ask <code class="docutils literal notranslate"><span class="pre">krbContext</span></code> to initialize a
given credential cache file from specified keytab file. This is a general use
case in a service that calls a third-party service’s API, which needs to be
authenticated by Kerberos GSSAPI mechanism.</p>
</div>
</div>
<div class="section" id="backward-compatibility">
<h2>Backward Compatibility<a class="headerlink" href="#backward-compatibility" title="Permalink to this headline">¶</a></h2>
<p><code class="docutils literal notranslate"><span class="pre">krbcontext</span></code> is deprecated and will be removed in future version. New code
should use <code class="docutils literal notranslate"><span class="pre">krbContext</span></code> instead.</p>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="api.html" class="btn btn-neutral float-right" title="API" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="index.html" class="btn btn-neutral float-left" title="Welcome to krbcontext’s documentation!" 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>