diff options
author | Jeff Forcier <jeff@bitprophet.org> | 2014-09-08 16:45:59 -0700 |
---|---|---|
committer | Jeff Forcier <jeff@bitprophet.org> | 2014-09-08 16:47:41 -0700 |
commit | 6b580b9feb54e1c73325e0c915021649ea8d479f (patch) | |
tree | c102ca96d70788157e6ff8dfcfed145146ea37b8 | |
parent | e05f3bce49c38b2b861bda4a96b0b8f19a84863a (diff) |
Tighten up module docstrings of GSSAPI API files.
* We don't use this style of header anywhere else
* Links to the original author's website/links aren't going to help; users rarely observe such info in practice :(
* The core info (credit, authorship, license) is retained elsewhere, either in this file, the changelog, or Git history
-rw-r--r-- | paramiko/kex_gss.py | 23 | ||||
-rw-r--r-- | paramiko/ssh_gss.py | 25 | ||||
-rw-r--r-- | sites/docs/api/kex_gss.rst | 4 |
3 files changed, 9 insertions, 43 deletions
diff --git a/paramiko/kex_gss.py b/paramiko/kex_gss.py index 02f943ba..9669f86a 100644 --- a/paramiko/kex_gss.py +++ b/paramiko/kex_gss.py @@ -21,26 +21,9 @@ """ -This module provides GSS-API / SSPI Key Exchange for Paramiko as defined in -RFC 4462 with the following restrictions: -Credential delegation is not supported in server mode, -To Use this module, you need the following additional python packages: -`pyasn1 >= 0.1.7 <https://pypi.python.org/pypi/pyasn1>`_, -`python-gssapi >= 0.4.0 (Unix) <https://pypi.python.org/pypi/python-gssapi>`_, -`pywin32 2.1.8 (Windows) <http://sourceforge.net/projects/pywin32/>`_. - -:summary: SSH2 GSS-API / SSPI Authenticated Diffie-Hellman Key Exchange Module -:version: 0.1 -:author: Sebastian Deiss -:contact: https://github.com/SebastianDeiss/paramiko/issues -:organization: science + computing ag - `EMail <mailto:a.kruis@science-computing.de>`_ -:copyright: (C) 2003-2007 Robey Pointer, (C) 2013-2014 `science + computing ag - <https://www.science-computing.de>`_ -:license: GNU Lesser General Public License (LGPL) -:see: `.ssh_gss` - -Created on 12.12.2013 +This module provides GSS-API / SSPI Key Exchange as defined in RFC 4462. + +.. note:: Credential delegation is not supported in server mode. """ diff --git a/paramiko/ssh_gss.py b/paramiko/ssh_gss.py index 03c5dcc0..1d179025 100644 --- a/paramiko/ssh_gss.py +++ b/paramiko/ssh_gss.py @@ -18,28 +18,11 @@ # along with Paramiko; if not, write to the Free Software Foundation, Inc., # 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. + """ -This module provides GSS-API / SSPI authentication for Paramiko as defined in -RFC 4462 with the following restrictions: -Credential delegation is not supported in server mode, -GSS-API key exchange is supported, but not implemented in Paramiko. -To Use this module, you need the following additional python packages: -`pyasn1 >= 0.1.7 <https://pypi.python.org/pypi/pyasn1>`_, -`python-gssapi >= 0.4.0 (Unix) <https://pypi.python.org/pypi/python-gssapi>`_, -`pywin32 2.1.8 (Windows) <http://sourceforge.net/projects/pywin32/>`_. - -:summary: SSH2 GSS-API / SSPI authentication module -:version: 0.1 -:author: Sebastian Deiss -:contact: https://github.com/SebastianDeiss/paramiko/issues -:organization: science + computing ag - `EMail <mailto:a.kruis@science-computing.de>`_ -:copyright: (C) 2013-2014 `science + computing ag - <https://www.science-computing.de>`_ -:license: GNU Lesser General Public License (LGPL) -:see: `.kex_gss` - -Created on 07.11.2013 +This module provides GSS-API / SSPI authentication as defined in RFC 4462. + +.. note:: Credential delegation is not supported in server mode. """ import struct diff --git a/sites/docs/api/kex_gss.rst b/sites/docs/api/kex_gss.rst index a662be01..67c7a9a4 100644 --- a/sites/docs/api/kex_gss.rst +++ b/sites/docs/api/kex_gss.rst @@ -1,5 +1,5 @@ -GSS-API Key Exchange Module -=========================== +GSS-API Key Exchange +==================== .. automodule:: paramiko.kex_gss :member-order: bysource |