summaryrefslogtreecommitdiff
path: root/lib/ssh/doc/src/ssh_file.xml
diff options
context:
space:
mode:
Diffstat (limited to 'lib/ssh/doc/src/ssh_file.xml')
-rw-r--r--lib/ssh/doc/src/ssh_file.xml26
1 files changed, 16 insertions, 10 deletions
diff --git a/lib/ssh/doc/src/ssh_file.xml b/lib/ssh/doc/src/ssh_file.xml
index e97bb5b37f..29db36481a 100644
--- a/lib/ssh/doc/src/ssh_file.xml
+++ b/lib/ssh/doc/src/ssh_file.xml
@@ -4,7 +4,7 @@
<erlref>
<header>
<copyright>
- <year>2018</year><year>2022</year>
+ <year>2018</year><year>2023</year>
<holder>Ericsson AB. All Rights Reserved.</holder>
</copyright>
<legalnotice>
@@ -66,7 +66,7 @@
<title>Daemons</title>
<p>Daemons uses all files stored in the <seeerl marker="#SYSDIR">SYSDIR</seeerl> directory.
</p>
- <p>Optionaly, in case of <c>publickey</c> authorization, one or more of the remote user's public keys
+ <p>Optionally, in case of <c>publickey</c> authorization, one or more of the remote user's public keys
in the <seeerl marker="#USERDIR">USERDIR</seeerl> directory are used.
See the files
<seeerl marker="#FILE-authorized_keys"><c>USERDIR/authorized_keys</c></seeerl> and
@@ -223,7 +223,7 @@ key :: % encoded key from eg ssh_host_*.pub
<datatype>
<name name="key"/>
<desc>
- <p>The key representation.</p>
+ <p>The key representation</p>
</desc>
</datatype>
@@ -232,8 +232,6 @@ key :: % encoded key from eg ssh_host_*.pub
<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>
@@ -262,7 +260,7 @@ key :: % encoded key from eg ssh_host_*.pub
<item><seeerl marker="#FILE-ssh_host_dsa_key"><c>SYSDIR/ssh_host_dsa_key</c></seeerl></item>
<item><seeerl marker="#FILE-ssh_host_ecdsa_key"><c>SYSDIR/ssh_host_ecdsa_key</c></seeerl></item>
<item><seeerl marker="#FILE-ssh_host_ed25519_key"><c>SYSDIR/ssh_host_ed25519_key</c></seeerl></item>
- <item><seeerl marker="#FILE-ssh_host_ed448_key"><c>SYSDIR/ssh_host_ed448_key</c>c></seeerl></item>
+ <item><seeerl marker="#FILE-ssh_host_ed448_key"><c>SYSDIR/ssh_host_ed448_key</c></seeerl></item>
</list>
</desc>
</func>
@@ -285,7 +283,7 @@ key :: % encoded key from eg ssh_host_*.pub
<item><seeerl marker="#FILE-authorized_keys"><c>USERDIR/authorized_keys</c></seeerl></item>
<item><seeerl marker="#FILE-authorized_keys2"><c>USERDIR/authorized_keys2</c></seeerl></item>
</list>
- <p>This functions discards all options in the begining of the lines of thoose files when reading them.
+ <p>This functions discards all options in the beginning of the lines of thoose files when reading them.
</p>
</desc>
</func>
@@ -375,7 +373,7 @@ key :: % encoded key from eg ssh_host_*.pub
an RFC4716 public key or an OpenSSH public key.</p>
<note>
<p>The following key types have been renamed from the deprecated
- <seemfa marker="public_key:public_key#ssh_decode/2">public_key:ssh_decode/2</seemfa>:</p>
+ <c>public_key:ssh_decode/2</c>:</p>
<list>
<item>rfc4716_public_key -> rfc4716_key</item>
<item>openssh_public_key -> openssh_key</item>
@@ -391,8 +389,7 @@ key :: % encoded key from eg ssh_host_*.pub
<desc>
<p>Encodes a list of SSH file entries (public keys and attributes) to a binary.</p>
<note>
- <p>The following key types have been renamed from the deprecated
- <seemfa marker="public_key:public_key#ssh_encode/2">public_key:ssh_encode/2</seemfa>:</p>
+ <p>The following key types have been renamed from the removed <c>public_key:ssh_encode/2</c>:</p>
<list>
<item>rfc4716_public_key -> rfc4716_key</item>
<item>openssh_public_key -> openssh_key</item>
@@ -402,6 +399,15 @@ key :: % encoded key from eg ssh_host_*.pub
</desc>
</func>
+
+ <func>
+ <name since="OTP 25.0" name="extract_public_key" arity="1"/>
+ <fsummary></fsummary>
+ <desc>
+ <p>Fetches the public key from a private key.</p>
+ </desc>
+ </func>
+
</funcs>
</erlref>