@@ -31,12 +31,27 @@ backlog for features that would be nice to have in this library.
31
31
## Requirements
32
32
33
33
* Python 2.6, 2.7, 3.4-3.6
34
- * For Kerberos auth, the [ python-gssapi] ( https://github.com/pythongssapi/python-gssapi ) package (see below )
34
+ * For Kerberos auth [ python-gssapi] ( https://github.com/pythongssapi/python-gssapi )
35
35
36
- The python-gssapi library is required to support Kerberos authentication but
37
- ` smbprotocol ` requires the GSSAPI GGF extension to support things like
38
- message encryption. To test out if the installed version of python-gsspapi
39
- can be used you can run the python commands in a Python console;
36
+ To use Kerberos authentication, further dependencies are required, to install
37
+ these dependencies run
38
+
39
+ ```
40
+ # for Debian/Ubuntu/etc:
41
+ sudo apt-get install gcc python-dev libkrb5-dev
42
+ pip install smbprotocol[kerberos]
43
+
44
+ # for RHEL/CentOS/etc:
45
+ sudo yum install gcc python-devel krb5-devel krb5-workstation python-devel
46
+ pip install smbprotocol[kerberos]
47
+ ```
48
+
49
+ Currently Kerberos authentication is not supported on Windows. As part of this
50
+ optional extra, the python-gssapi library is installed and smbprotocol requires
51
+ a particular GSSAPI extension to be available to work. This extension should
52
+ be installed on the majority of MIT or Heimdall Kerberos installs but it isn't
53
+ guaranteed. To verify that Kerberos is available you can run the following
54
+ check in a Python console
40
55
41
56
```
42
57
try:
@@ -55,7 +70,12 @@ version.
55
70
56
71
To install smbprotocol, simply run
57
72
58
- ` pip install smbprotocol `
73
+ ```
74
+ pip install smbprotocol
75
+
76
+ # on a non Windows host, to install with Kerberos support
77
+ pip install smbprotocol[kerberos]
78
+ ```
59
79
60
80
This will download the required packages that are used in this package and get
61
81
your Python environment ready to go.
0 commit comments