diff options
| author | Hans Nilsson <hans@erlang.org> | 2022-02-14 07:57:32 +0100 |
|---|---|---|
| committer | Hans Nilsson <hans@erlang.org> | 2022-02-17 09:28:44 +0100 |
| commit | ecafec2bea5c5263d50e0e3364155aba91170ce8 (patch) | |
| tree | 063cce24d9cb0c11cec04cfd47dc08dfe9163deb /lib/ssh/doc/src | |
| parent | 1c8965ac4c841001edb3f2ba2b60d107b633e8a2 (diff) | |
| download | erlang-ecafec2bea5c5263d50e0e3364155aba91170ce8.tar.gz | |
ssh: Fixup the ssh_file (src and doc) in maint regarding Edwards curves
They are already changed in master
Diffstat (limited to 'lib/ssh/doc/src')
| -rw-r--r-- | lib/ssh/doc/src/ssh_file.xml | 49 |
1 files changed, 24 insertions, 25 deletions
diff --git a/lib/ssh/doc/src/ssh_file.xml b/lib/ssh/doc/src/ssh_file.xml index 941d68d297..8f52f17826 100644 --- a/lib/ssh/doc/src/ssh_file.xml +++ b/lib/ssh/doc/src/ssh_file.xml @@ -220,6 +220,24 @@ key :: % encoded key from eg ssh_host_*.pub </desc> </datatype> + <datatype> + <name name="key"/> + <desc> + <p>The key representation.</p> + </desc> + </datatype> + + <datatype> + <name name="experimental_openssh_key_v1"/> + <name name="openssh_key_v1_attributes"/> + <desc> + <p>Types for the experimental implementaition of the <c>openssh_key_v1</c> format. + The <c>#ECPoint{}</c> and <c>ECPrivateKey{}</c> are not used for Edwards curves + (ed25519 and ed448), but will be in next major release. + </p> + </desc> + </datatype> + </datatypes> <funcs> @@ -349,19 +367,8 @@ key :: % encoded key from eg ssh_host_*.pub </func> <func> - <name since="OTP 24.0">decode(SshBin, ssh2_pubkey) -> Key</name> - <name since="OTP 24.0">decode(SshBin, rfc4716_key) -> ResultRfc4716</name> - <name since="OTP 24.0">decode(SshBin, openssh_key) -> ResultOpenSsh</name> - <name since="OTP 24.0">decode(SshBin, public_key) -> ResultRfc4716 | ResultOpenSsh</name> - <fsummary>Decodes an SSH binary.</fsummary> - <type> - <v>SshBin = binary()</v> - <v>ResultRfc4716 = [{Key, [{headers,Hdrs}]}] | Error</v> - <v>ResultOpenSsh = [{Key, [{comment,string()}]}] | Error</v> - <v>Key = <seetype marker="public_key:public_key#public_key">public_key:public_key()</seetype></v> - <v>Hdrs = [{Tag::string(), Value::string()}]</v> - <v>Error = {error,term()}</v> - </type> + <name since="OTP 24.0" name="decode" arity="2"/> + <fsummary></fsummary> <desc> <p>Decodes an SSH file-binary.</p> <p>If <c>Type</c> is <c>public_key</c> the binary can be either @@ -374,22 +381,13 @@ key :: % encoded key from eg ssh_host_*.pub <item>openssh_public_key -> openssh_key</item> </list> </note> + <note><p>The implementation of the <c>openssh_key_v1</c> format is still experimental.</p></note> </desc> </func> <func> - <name since="OTP 24.0">encode(Key, ssh2_pubkey) -> Result</name> - <name since="OTP 24.0">encode(KeyAttrsRfc4716, rfc4716_key) -> Result</name> - <name since="OTP 24.0">encode(KeyAttrsOpenSsh, openssh_key) -> Result</name> - <fsummary>Encodes a list of SSH file entries to a binary.</fsummary> - <type> - <v>Key = <seetype marker="public_key:public_key#public_key">public_key:public_key()</seetype></v> - <v>Result = binary() | Error</v> - <v>KeyAttrsRfc4716 = [{Key, [{headers,Hdrs}]}] | Error</v> - <v>KeyAttrsOpenSsh = [{Key, [{comment,string()}]}] | Error</v> - <v>Hdrs = [{Tag::string(), Value::string()}]</v> - <v>Error = {error,term()}</v> - </type> + <name since="OTP 24.0" name="encode" arity="2"/> + <fsummary></fsummary> <desc> <p>Encodes a list of SSH file entries (public keys and attributes) to a binary.</p> <note> @@ -400,6 +398,7 @@ key :: % encoded key from eg ssh_host_*.pub <item>openssh_public_key -> openssh_key</item> </list> </note> + <note><p>The implementation of the <c>openssh_key_v1</c> format is still experimental.</p></note> </desc> </func> |