From 1b93c11014125863c1f5baa2e929893c9195a7a5 Mon Sep 17 00:00:00 2001 From: Paul Lettington Date: Sun, 5 Sep 2021 21:30:26 +0100 Subject: T971 Document the use of ssh key options While adding " support in T971, I noticed that `options` weren't documented at all. This commit adds documentation for ssh options, including the use of " --- docs/configuration/system/login.rst | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/docs/configuration/system/login.rst b/docs/configuration/system/login.rst index 09b6e68b..89ef7e2f 100644 --- a/docs/configuration/system/login.rst +++ b/docs/configuration/system/login.rst @@ -74,6 +74,14 @@ The third part is simply an identifier, and is for your own reference. .. note:: You can assign multiple keys to the same user by using a unique identifier per SSH key. +.. cfgcmd:: set system login user authentication public-keys + options + + Set the options for this public key. See the ssh ``authorized_keys`` man page + for details of what you can specify here. To place a ``"`` character in the + options field, use ``"``, for example ``from="10.0.0.0/24"`` + to restrict where the user may connect from when using this key. + .. cfgcmd:: loadkey **Deprecation notice:** ``loadkey`` has been deprecated in favour of @@ -96,12 +104,14 @@ Example ------- In the following example, both `User1` and `User2` will be able to SSH into -VyOS as user ``vyos`` using their very own keys. +VyOS as user ``vyos`` using their very own keys. `User1` is restricted to only +be able to connect from a single IP address. .. code-block:: none set system login user vyos authentication public-keys 'User1' key "AAAAB3Nz...KwEW" set system login user vyos authentication public-keys 'User1' type ssh-rsa + set system login user vyos authentication public-keys 'User1' options "from="192.168.0.100"" set system login user vyos authentication public-keys 'User2' key "AAAAQ39x...fbV3" set system login user vyos authentication public-keys 'User2' type ssh-rsa -- cgit v1.2.3