summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJeff Forcier <jeff@bitprophet.org>2017-09-05 19:02:41 -0700
committerJeff Forcier <jeff@bitprophet.org>2017-09-05 19:02:45 -0700
commita2de0ad4e5aa9ce2a98ed0009990d525f744073b (patch)
treecd9b7cc74f6d36095e558d522354c839cb3fe8fa
parent85c24776774458ea9782272552570966fd3a4c45 (diff)
downloadparamiko-a2de0ad4e5aa9ce2a98ed0009990d525f744073b.tar.gz
Document Ed25519 keys =/
I didn't badger people about docs so there were none
-rw-r--r--paramiko/ed25519key.py10
-rw-r--r--sites/docs/api/keys.rst5
2 files changed, 15 insertions, 0 deletions
diff --git a/paramiko/ed25519key.py b/paramiko/ed25519key.py
index aa5e885d..434b3f45 100644
--- a/paramiko/ed25519key.py
+++ b/paramiko/ed25519key.py
@@ -45,6 +45,16 @@ def unpad(data):
class Ed25519Key(PKey):
+ """
+ Representation of an `Ed25519 <https://ed25519.cr.yp.to/>`_ key.
+
+ .. note::
+ Ed25519 key support was added to OpenSSH in version 6.5.
+
+ .. versionadded:: 2.2
+ .. versionchanged:: 2.3
+ Added a ``file_obj`` parameter to match other key classes.
+ """
def __init__(self, msg=None, data=None, filename=None, password=None,
file_obj=None):
verifying_key = signing_key = None
diff --git a/sites/docs/api/keys.rst b/sites/docs/api/keys.rst
index c6412f77..a456f502 100644
--- a/sites/docs/api/keys.rst
+++ b/sites/docs/api/keys.rst
@@ -21,3 +21,8 @@ ECDSA
=====
.. automodule:: paramiko.ecdsakey
+
+Ed25519
+=======
+
+.. automodule:: paramiko.ed25519key