summaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
-rw-r--r--paramiko/ecdsakey.py13
-rw-r--r--sites/docs/api/keys.rst17
2 files changed, 22 insertions, 8 deletions
diff --git a/paramiko/ecdsakey.py b/paramiko/ecdsakey.py
index 6736315f..22d05717 100644
--- a/paramiko/ecdsakey.py
+++ b/paramiko/ecdsakey.py
@@ -17,7 +17,7 @@
# 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
"""
-L{ECDSAKey}
+ECDSA keys
"""
import binascii
@@ -130,13 +130,10 @@ class ECDSAKey (PKey):
Generate a new private RSA key. This factory function can be used to
generate a new host key or authentication key.
- @param bits: number of bits the generated key should be.
- @type bits: int
- @param progress_func: an optional function to call at key points in
- key generation (used by C{pyCrypto.PublicKey}).
- @type progress_func: function
- @return: new private key
- @rtype: L{RSAKey}
+ :param function progress_func:
+ an optional function to call at key points in key generation (used
+ by ``pyCrypto.PublicKey``).
+ :returns: A new private key (`.RSAKey`) object
"""
signing_key = ECDSA.generate()
key = ECDSAKey(vals=(signing_key, signing_key.get_verifying_key()))
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