1
1
GSSAPI Console
2
2
==============
3
3
4
+ [ ![ PyPI version] ( https://badge.fury.io/py/gssapi_console.svg )] ( https://badge.fury.io/py/gssapi_console )
5
+ [ ![ GitHub version] ( https://badge.fury.io/gh/pythongssapi%2Fgssapi-console.svg )] ( https://badge.fury.io/gh/pythongssapi%2Fgssapi-console )
6
+
4
7
* GSSAPI Console* allows provides an easy way to test out Python applications
5
8
using GSSAPI in a self-contained environment.
6
9
@@ -11,22 +14,36 @@ Requirements
11
14
------------
12
15
13
16
* [ python-gssapi] ( https://pypi.python.org/pypi/gssapi ) >= 1.1.0
14
- * The required components for the environment in used
15
- (for krb5, the full set of MIT krb5 executables are needed,
16
- including those required to set up a KDC).
17
+ * Requirements for the environment used (for example, the default environment is
18
+ MIT krb5, which uses the [ k5test] ( https://pypi.python.org/pypi/k5test ) )
17
19
18
20
Usage
19
21
-----
20
22
21
- * [ further information is available by running ` gssapi-console.py --help ` ] *
23
+ * further information is available by running ` gssapi-console.py --help ` *
22
24
23
25
The main executable of GSSAPI Console is ` gssapi-console.py ` . The basic
24
26
invocation works just like launching ` python ` -- use ` gssapi-console.py FILE `
25
27
to run a file in the established environment, or just run ` gssapi-console.py `
26
28
or ` gssapi-console.py -i ` to get an interactive environment (the ` -i ` flag
27
29
can be used with a file, just like ` python FILE -i ` ).
28
30
29
- You can use ` --realm-args key1=true,key2=false,... ` to pass specific arguments
30
- to the realm constructor (the set of such keys is driver-dependent), and
31
- ` --mech MECH_NAME ` can be used to specify a different driver (currently
32
- only ` --mech krb5 ` will work).
31
+ There are several additional flags that may be passed to ` gssapi-console.py ` :
32
+
33
+ * ` --realm-args key1=true,key2=false,... ` can be used to pass specific arguments
34
+ to the realm constructor (the set of such keys is driver-dependent)
35
+ * ` --mech MECH_NAME ` can be used to specify a different driver (currently, only
36
+ ` --mech krb5 ` will work)
37
+ * ` -a IDENTIFIER, --attach IDENTIFIER ` may be used to "attach" a new GSSAPI Console
38
+ session to an environment set up by an existing GSSAPI Console session. The identifier
39
+ will be noted at the top of the existing GSSAPI Console session as ` Session: IDENTIFIER ` .
40
+ * ` -v, --verbose ` may be used to increase the verbosity of the logging level (generally to
41
+ gain more details on what the driver is doing to set up the realm).
42
+
43
+ Additional GSSAPI Console drivers may be introduced using the ` gssapi_console.drivers `
44
+ setuptools entry point. They should follow the ` gssapi_console.drivers.GSSAPIConsoleDriver `
45
+ class.
46
+
47
+ GSSAPI Console provides a [ YALPT] ( https://pypi.python.org/pypi/yalpt ) environment driver for
48
+ writing tutorials and literate python files involving GSSAPI. You can use it by passing
49
+ ` -e gssapi ` to YALPT (it will use the default GSSAPI Console driver in this case).
0 commit comments