aboutsummaryrefslogtreecommitdiffstats
path: root/docs/hazmat
diff options
context:
space:
mode:
authorPaul Kehrer <paul.l.kehrer@gmail.com>2019-03-19 10:24:19 +0800
committerAlex Gaynor <alex.gaynor@gmail.com>2019-03-18 22:24:19 -0400
commit054f5791dd0b603bbaca028da48fff23930e0741 (patch)
treeec9ad2cf7b736c4beea05b52d0160705842d7ed8 /docs/hazmat
parentf2c2dfd7ce179b1763a98747282ea2ce019d6c1a (diff)
downloadcryptography-054f5791dd0b603bbaca028da48fff23930e0741.tar.gz
cryptography-054f5791dd0b603bbaca028da48fff23930e0741.tar.bz2
cryptography-054f5791dd0b603bbaca028da48fff23930e0741.zip
update ed25519 docs to note we support openssh serialization (#4814)
Diffstat (limited to 'docs/hazmat')
-rw-r--r--docs/hazmat/primitives/asymmetric/ed25519.rst17
1 files changed, 12 insertions, 5 deletions
diff --git a/docs/hazmat/primitives/asymmetric/ed25519.rst b/docs/hazmat/primitives/asymmetric/ed25519.rst
index 8893fbbd..f9e007c5 100644
--- a/docs/hazmat/primitives/asymmetric/ed25519.rst
+++ b/docs/hazmat/primitives/asymmetric/ed25519.rst
@@ -122,11 +122,14 @@ Key interfaces
Allows serialization of the key to bytes. Encoding (
:attr:`~cryptography.hazmat.primitives.serialization.Encoding.PEM`,
- :attr:`~cryptography.hazmat.primitives.serialization.Encoding.DER`, or
+ :attr:`~cryptography.hazmat.primitives.serialization.Encoding.DER`,
+ :attr:`~cryptography.hazmat.primitives.serialization.Encoding.OpenSSH`,
+ or
:attr:`~cryptography.hazmat.primitives.serialization.Encoding.Raw`) and
format (
- :attr:`~cryptography.hazmat.primitives.serialization.PublicFormat.SubjectPublicKeyInfo`
- or
+ :attr:`~cryptography.hazmat.primitives.serialization.PublicFormat.SubjectPublicKeyInfo`,
+ :attr:`~cryptography.hazmat.primitives.serialization.PublicFormat.OpenSSH`
+ , or
:attr:`~cryptography.hazmat.primitives.serialization.PublicFormat.Raw`
) are chosen to define the exact serialization.
@@ -138,8 +141,12 @@ Key interfaces
enum. If the ``encoding`` is
:attr:`~cryptography.hazmat.primitives.serialization.Encoding.Raw`
then ``format`` must be
- :attr:`~cryptography.hazmat.primitives.serialization.PublicFormat.Raw`
- , otherwise it must be
+ :attr:`~cryptography.hazmat.primitives.serialization.PublicFormat.Raw`.
+ If ``encoding`` is
+ :attr:`~cryptography.hazmat.primitives.serialization.Encoding.OpenSSH`
+ then ``format`` must be
+ :attr:`~cryptography.hazmat.primitives.serialization.PublicFormat.OpenSSH`.
+ In all other cases ``format`` must be
:attr:`~cryptography.hazmat.primitives.serialization.PublicFormat.SubjectPublicKeyInfo`.
:returns bytes: The public key bytes.