doc: warn users about vtysh / telnet security

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>

diff --git a/doc/manpages/vtysh.rst b/doc/manpages/vtysh.rst
index 2efff37626b082e320198e230658c96b36d9f435..3e496956c23d63f143987d6ab53c8c1b3db16ee7 100644 (file)
--- a/doc/manpages/vtysh.rst
+++ b/doc/manpages/vtysh.rst
@@ -55,7 +55,9 @@ OPTIONS available for the vtysh command:
 
 .. option:: -u, --user
 
-   Run as an unprivileged user. This limits access to non-privileged commands, i.e., the same commands when directly accessing a daemon   before running the enable command. It also provides the same limited security as such direct access.
+   Restrict access to configuration commands by preventing use of the "enable" command. This option provides the same limited "security" as password-protected telnet access. *This security should not be relied on in production environments.*
+
+   Caveat emptor: VTYSH was never designed to be a privilege broker and is not built using secure coding practices. No guarantees of security are provided for this option and under no circumstances should this option be used to provide any semblance of secure read-only access to FRR.
 
 .. option:: -h, --help
 

diff --git a/doc/user/vtysh.rst b/doc/user/vtysh.rst
index 52d54f412342b3f03b84a31cb4d325c82e6645fc..71aab3975ee87f5ae835bad043e2b2cc5ca743f8 100644 (file)
--- a/doc/user/vtysh.rst
+++ b/doc/user/vtysh.rst
@@ -33,6 +33,16 @@ daemons will change ownership of their sockets to).
 To restrict access to FRR configuration, make sure no unauthorized users are
 members of the |INSTALL_VTY_GROUP| group.
 
+.. warning::
+
+   VTYSH implements a CLI option ``-u, --user`` that disallows entering the
+   characters "en" on the command line, which ideally restricts access to
+   configuration commands. However, VTYSH was never designed to be a privilege
+   broker and is not built using secure coding practices. No guarantees of
+   security are provided for this option and under no circumstances should this
+   option be used to provide any semblance of security or read-only access to
+   FRR.
+
 PAM support (experimental)
 --------------------------