[#1304] Addressed comments (but not for syntax)

diff --git a/doc/sphinx/arm/agent.rst b/doc/sphinx/arm/agent.rst
index d2f26693a07e246f9a62b1718f0e1e2310672946..a65d2edaa3b83b98dd153b3a46db7ead567b2f5c 100644 (file)
--- a/doc/sphinx/arm/agent.rst
+++ b/doc/sphinx/arm/agent.rst
@@ -137,7 +137,7 @@ ability to store comments or descriptions; the parser translates a
 "comment" entry into a user context with the entry, which allows a
 comment to be attached within the configuration itself.
 
-The basic HTTP authentication was added by Kea 1.7.10. It protects
+The basic HTTP authentication was added by Kea 1.9.0. It protects
 against not authorized uses of the control agent by local users. For the
 protection against remote attackers HTTPS and reverse proxy of
 :ref:`agent-secure-connection` provide a stronger security.

diff --git a/doc/sphinx/arm/hooks-ha.rst b/doc/sphinx/arm/hooks-ha.rst
index a679cabaeb8e7313d920e3b8f61f52655bb6651b..13967b8550bc3fcba1ab9b659eb9bc36dce7dc76 100644 (file)
--- a/doc/sphinx/arm/hooks-ha.rst
+++ b/doc/sphinx/arm/hooks-ha.rst
@@ -581,7 +581,7 @@ server. It may also contain an unlimited number of backup servers. In
 this example, there is one backup server which receives lease updates
 from the active servers.
 
-Since Kea version 1.7.10 the basic HTTP authentication is available
+Since Kea version 1.9.0 the basic HTTP authentication is available
 to protect the Kea control agent against local attackers.
 
 These are the parameters specified for each of the peers within this
@@ -1291,7 +1291,7 @@ load-balancing and the hot-standby cases presented in previous sections.
    }
    }
 
-Since Kea version 1.7.10 the basic HTTP authentication is supported.
+Since Kea version 1.9.0 the basic HTTP authentication is supported.
 
 .. _ha-maintenance:
 

diff --git a/doc/sphinx/arm/shell.rst b/doc/sphinx/arm/shell.rst
index 9380a316aaf6c09dba553345a258e6ac4636bfa2..39675c048d9a294316d554b7a2572f35d69ca902 100644 (file)
--- a/doc/sphinx/arm/shell.rst
+++ b/doc/sphinx/arm/shell.rst
@@ -22,7 +22,7 @@ As the primary purpose of the Kea shell is as a tool in a scripting
 environment, it is not interactive. However, following simple guidelines it can
 be run manually.
 
-Kea 1.7.10 introduced basic HTTP authentication support.
+Kea 1.9.0 introduced basic HTTP authentication support.
 
 Shell Usage
 ===========
@@ -127,3 +127,8 @@ people interested in integrating their management environments with Kea)
 than as a serious management client. It is not likely to be
 significantly expanded in the future; it is, and will remain, a simple
 tool.
+
+.. note::
+
+   When using this tool with basic HTTP authentication please not forget
+   that command line arguments are not hidden to local users.

diff --git a/src/lib/http/basic_auth_config.h b/src/lib/http/basic_auth_config.h
index a5d3e74a6cc425db54d4b5200788cfeaf214e251..c459ba3c5713c1321ddb2fd2d22b0614ccce8311 100644 (file)
--- a/src/lib/http/basic_auth_config.h
+++ b/src/lib/http/basic_auth_config.h
@@ -18,7 +18,11 @@
 namespace isc {
 namespace http {
 
-/// @brief Type of basic HTTP authentication credential and user id map.
+/// @brief Type of basic HTTP authentication credential and user id map,
+/// e.g. map["am9obmRvZTpzZWNyZXQx" = "johndoe".
+///
+/// The map is used to verify a received credential: if it is not in it
+/// the authentication fails, if it is in it the user id is logged.
 typedef std::unordered_map<std::string, std::string> BasicHttpAuthMap;
 
 /// @brief Basic HTTP authentication client configuration.
@@ -52,10 +56,10 @@ public:
 
 private:
 
-    /// @brief The user id.
+    /// @brief The user id e.g. johndoe.
     std::string user_;
 
-    /// @brief The password.
+    /// @brief The password e.g. secret1.
     std::string password_;
 };