summaryrefslogtreecommitdiffhomepage
path: root/sites/www
diff options
context:
space:
mode:
authorJeff Forcier <jeff@bitprophet.org>2014-09-08 16:36:33 -0700
committerJeff Forcier <jeff@bitprophet.org>2014-09-08 16:36:33 -0700
commit150b0797e935ebf2f62e86ae1c08a1a1ab94c459 (patch)
tree09f168b2b1127bc84a57c3ed7ec6f023cd003df2 /sites/www
parentd992118747e2f1dab247bd4e3d78b55d9b99c759 (diff)
Update README, docs, changelog re #267
Diffstat (limited to 'sites/www')
-rw-r--r--sites/www/changelog.rst4
-rw-r--r--sites/www/installing.rst28
2 files changed, 29 insertions, 3 deletions
diff --git a/sites/www/changelog.rst b/sites/www/changelog.rst
index a42cfb3d..3be56890 100644
--- a/sites/www/changelog.rst
+++ b/sites/www/changelog.rst
@@ -3,8 +3,8 @@ Changelog
=========
* :feature:`250` (also :issue:`267`) Add GSS-API / SSPI (e.g. Kerberos) key
- exchange and authentication support. Mega thanks to Sebastian Deiß, with
- assist by Torsten Landschoff.
+ exchange and authentication support (:ref:`installation docs here <gssapi>`).
+ Mega thanks to Sebastian Deiß, with assist by Torsten Landschoff.
* :bug:`346 major` Fix an issue in private key files' encryption salts that
could cause tracebacks and file corruption if keys were re-encrypted. Credit
to Xavier Nunn.
diff --git a/sites/www/installing.rst b/sites/www/installing.rst
index 052825c4..5528b28a 100644
--- a/sites/www/installing.rst
+++ b/sites/www/installing.rst
@@ -20,11 +20,14 @@ We currently support **Python 2.6, 2.7 and 3.3+** (Python **3.2** should also
work but has a less-strong compatibility guarantee from us.) Users on Python
2.5 or older are urged to upgrade.
-Paramiko has two dependencies: the pure-Python ECDSA module ``ecdsa``, and the
+Paramiko has two hard dependencies: the pure-Python ECDSA module ``ecdsa``, and the
PyCrypto C extension. ``ecdsa`` is easily installable from wherever you
obtained Paramiko's package; PyCrypto may require more work. Read on for
details.
+If you need GSS-API / SSPI support, see :ref:`the below subsection on it
+<gssapi>` for details on additional dependencies.
+
.. _release-lines:
Release lines
@@ -99,3 +102,26 @@ installation of Paramiko via ``pypm``::
Installing paramiko-1.7.8
Installing pycrypto-2.4
C:\>
+
+
+.. _gssapi:
+
+Optional dependencies for GSS-API / SSPI / Kerberos
+===================================================
+
+In order to use Kerberos & related functionality, a couple of additional
+dependencies are required (these are not listed in our ``setup.py`` due to
+their infrequent utility & non-platform-agnostic requirements):
+
+* **All platforms** need `pyasn1 <https://pypi.python.org/pypi/pyasn1>`_
+ ``0.1.7`` or better.
+* **Unix** needs `python-gssapi <https://pypi.python.org/pypi/python-gssapi/>`_
+ ``0.6.1`` or better.
+* **Windows** needs `pywin32 <https://pypi.python.org/pypi/pywin32>`_ ``2.1.8``
+ or better.
+
+.. note::
+ If you use Microsoft SSPI for kerberos authentication and credential
+ delegation, make sure that the target host is trusted for delegation in the
+ active directory configuration. For details see:
+ http://technet.microsoft.com/en-us/library/cc738491%28v=ws.10%29.aspx