From a935505b0ad0664f74d07433db40449592a86bf6 Mon Sep 17 00:00:00 2001 From: Sebastian Deiss Date: Thu, 27 Mar 2014 11:14:54 +0100 Subject: Change GSS-API epydoc docstrings to Sphinx --- sites/docs/api/kex_gss.rst | 5 +++++ sites/docs/api/ssh_gss.rst | 14 ++++++++++++++ 2 files changed, 19 insertions(+) create mode 100644 sites/docs/api/kex_gss.rst create mode 100644 sites/docs/api/ssh_gss.rst (limited to 'sites/docs/api') diff --git a/sites/docs/api/kex_gss.rst b/sites/docs/api/kex_gss.rst new file mode 100644 index 00000000..a662be01 --- /dev/null +++ b/sites/docs/api/kex_gss.rst @@ -0,0 +1,5 @@ +GSS-API Key Exchange Module +=========================== + +.. automodule:: paramiko.kex_gss + :member-order: bysource diff --git a/sites/docs/api/ssh_gss.rst b/sites/docs/api/ssh_gss.rst new file mode 100644 index 00000000..1b08c7f8 --- /dev/null +++ b/sites/docs/api/ssh_gss.rst @@ -0,0 +1,14 @@ +Paramiko GSS-API Interface +========================== + +.. automodule:: paramiko.ssh_gss + :member-order: bysource + +.. autoclass:: _SSH_GSSAuth + :member-order: bysource + +.. autoclass:: _SSH_GSSAPI + :member-order: bysource + +.. autoclass:: _SSH_SSPI + :member-order: bysource -- cgit v1.2.3 From 6b580b9feb54e1c73325e0c915021649ea8d479f Mon Sep 17 00:00:00 2001 From: Jeff Forcier Date: Mon, 8 Sep 2014 16:45:59 -0700 Subject: 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 --- paramiko/kex_gss.py | 23 +++-------------------- paramiko/ssh_gss.py | 25 ++++--------------------- sites/docs/api/kex_gss.rst | 4 ++-- 3 files changed, 9 insertions(+), 43 deletions(-) (limited to 'sites/docs/api') 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 `_, -`python-gssapi >= 0.4.0 (Unix) `_, -`pywin32 2.1.8 (Windows) `_. - -: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 `_ -:copyright: (C) 2003-2007 Robey Pointer, (C) 2013-2014 `science + computing ag - `_ -: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 `_, -`python-gssapi >= 0.4.0 (Unix) `_, -`pywin32 2.1.8 (Windows) `_. - -: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 `_ -:copyright: (C) 2013-2014 `science + computing ag - `_ -: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 -- cgit v1.2.3 From 67810da14504bd4b4be60f8cb3067d4d6b46abdf Mon Sep 17 00:00:00 2001 From: Jeff Forcier Date: Mon, 8 Sep 2014 16:48:47 -0700 Subject: Tweak API stub titles --- sites/docs/api/kex_gss.rst | 2 +- sites/docs/api/ssh_gss.rst | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) (limited to 'sites/docs/api') diff --git a/sites/docs/api/kex_gss.rst b/sites/docs/api/kex_gss.rst index 67c7a9a4..9fd09221 100644 --- a/sites/docs/api/kex_gss.rst +++ b/sites/docs/api/kex_gss.rst @@ -1,4 +1,4 @@ -GSS-API Key Exchange +GSS-API key exchange ==================== .. automodule:: paramiko.kex_gss diff --git a/sites/docs/api/ssh_gss.rst b/sites/docs/api/ssh_gss.rst index 1b08c7f8..1ce9daf7 100644 --- a/sites/docs/api/ssh_gss.rst +++ b/sites/docs/api/ssh_gss.rst @@ -1,5 +1,5 @@ -Paramiko GSS-API Interface -========================== +GSS-API interface +================= .. automodule:: paramiko.ssh_gss :member-order: bysource -- cgit v1.2.3 From 0010903c45cebd7b7d995d80de763147b5c7151f Mon Sep 17 00:00:00 2001 From: Jeff Forcier Date: Mon, 8 Sep 2014 16:49:33 -0700 Subject: Match rest of API stubs --- sites/docs/api/agent.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'sites/docs/api') diff --git a/sites/docs/api/agent.rst b/sites/docs/api/agent.rst index 3b614a82..f01ad972 100644 --- a/sites/docs/api/agent.rst +++ b/sites/docs/api/agent.rst @@ -1,4 +1,4 @@ -SSH Agents +SSH agents ========== .. automodule:: paramiko.agent -- cgit v1.2.3 From 6e91d103e8e6c618f1c514638bd2e7243e0e3767 Mon Sep 17 00:00:00 2001 From: Jeff Forcier Date: Mon, 8 Sep 2014 16:50:47 -0700 Subject: Reinstate working seealso's --- paramiko/kex_gss.py | 2 ++ paramiko/ssh_gss.py | 2 ++ sites/docs/api/ssh_gss.rst | 4 ++-- 3 files changed, 6 insertions(+), 2 deletions(-) (limited to 'sites/docs/api') diff --git a/paramiko/kex_gss.py b/paramiko/kex_gss.py index 9669f86a..cdb18496 100644 --- a/paramiko/kex_gss.py +++ b/paramiko/kex_gss.py @@ -24,6 +24,8 @@ This module provides GSS-API / SSPI Key Exchange as defined in RFC 4462. .. note:: Credential delegation is not supported in server mode. + +.. seealso:: :doc:`/api/ssh_gss` """ diff --git a/paramiko/ssh_gss.py b/paramiko/ssh_gss.py index 1d179025..2fdde227 100644 --- a/paramiko/ssh_gss.py +++ b/paramiko/ssh_gss.py @@ -23,6 +23,8 @@ This module provides GSS-API / SSPI authentication as defined in RFC 4462. .. note:: Credential delegation is not supported in server mode. + +.. seealso:: :doc:`/api/kex_gss` """ import struct diff --git a/sites/docs/api/ssh_gss.rst b/sites/docs/api/ssh_gss.rst index 1ce9daf7..7a687e11 100644 --- a/sites/docs/api/ssh_gss.rst +++ b/sites/docs/api/ssh_gss.rst @@ -1,5 +1,5 @@ -GSS-API interface -================= +GSS-API authentication +====================== .. automodule:: paramiko.ssh_gss :member-order: bysource -- cgit v1.2.3 From 17dbb6a48c0ccf645bc8a53d22ba502a71a99a26 Mon Sep 17 00:00:00 2001 From: Jeff Forcier Date: Thu, 18 Sep 2014 17:50:54 -0700 Subject: Make keys doc file easier to follow --- sites/docs/api/keys.rst | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) (limited to 'sites/docs/api') diff --git a/sites/docs/api/keys.rst b/sites/docs/api/keys.rst index af7b58c4..c6412f77 100644 --- a/sites/docs/api/keys.rst +++ b/sites/docs/api/keys.rst @@ -1,6 +1,23 @@ +============ Key handling ============ +Parent key class +================ + .. automodule:: paramiko.pkey + +DSA (DSS) +========= + .. automodule:: paramiko.dsskey + +RSA +=== + .. automodule:: paramiko.rsakey + +ECDSA +===== + +.. automodule:: paramiko.ecdsakey -- cgit v1.2.3