summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorerkin <e.altunbas@vyos.io>2021-06-20 20:16:57 +0300
committererkin <e.altunbas@vyos.io>2021-06-20 20:16:57 +0300
commit61bd4d04522cddf0166dd270f47dd18c0ef12cb2 (patch)
tree3a5822184eb326319667d269ca48870acbd58560 /docs
parent8f776a9e23f63f77c421126def5ea04a77a54f81 (diff)
downloadvyos-documentation-61bd4d04522cddf0166dd270f47dd18c0ef12cb2.tar.gz
vyos-documentation-61bd4d04522cddf0166dd270f47dd18c0ef12cb2.zip
Deprecate `loadkey`
Diffstat (limited to 'docs')
-rw-r--r--docs/configuration/service/ssh.rst29
-rw-r--r--docs/configuration/system/login.rst4
2 files changed, 33 insertions, 0 deletions
diff --git a/docs/configuration/service/ssh.rst b/docs/configuration/service/ssh.rst
index 6b09d40d..dc382b67 100644
--- a/docs/configuration/service/ssh.rst
+++ b/docs/configuration/service/ssh.rst
@@ -156,3 +156,32 @@ Operation
Two new files ``/config/auth/id_rsa_rpki`` and
``/config/auth/id_rsa_rpki.pub``
will be created.
+
+.. opcmd:: generate public-key-commands name <username> path <location>
+
+ Generate the configuration mode commands to add a public key for
+ :ref:`ssh_key_based_authentication`.
+ `<location>` can be a local path or a URL pointing at a remote file.
+ Supported remote protocols are FTP, HTTP, HTTPS, SCP/SFTP and TFTP.
+
+ Example:
+
+ .. code-block:: none
+
+ alyssa@vyos:~$ generate public-key-commands name alyssa path sftp://example.net/home/alyssa/.ssh/id_rsa.pub
+ # To add this key as an embedded key, run the following commands:
+ configure
+ set system login user alyssa authentication public-keys alyssa@example.net key AAA...
+ set system login user alyssa authentication public-keys alyssa@example.net type ssh-rsa
+ commit
+ save
+ exit
+
+ ben@vyos:~$ generate public-key-command user ben path ~/.ssh/id_rsa.pub
+ # To add this key as an embedded key, run the following commands:
+ configure
+ set system login user ben authentication public-keys ben@vyos key AAA...
+ set system login user ben authentication public-keys ben@vyos type ssh-dss
+ commit
+ save
+ exit
diff --git a/docs/configuration/system/login.rst b/docs/configuration/system/login.rst
index 0492f4d1..784e4f3e 100644
--- a/docs/configuration/system/login.rst
+++ b/docs/configuration/system/login.rst
@@ -76,6 +76,10 @@ The third part is simply an identifier, and is for your own reference.
.. cfgcmd:: loadkey <username> <location>
+ **Deprecation notice:** ``loadkey`` has been deprecated in favour of
+ :opcmd:`generate public-key-commands` and will be removed in a future
+ version. See :ref:`ssh:operation`.
+
SSH keys can not only be specified on the command-line but also loaded for
a given user with `<username>` from a file pointed to by `<location>.` Keys
can be either loaded from local filesystem or any given remote location