Browse Source

HPCC-15214 DOCS:Update Method for Configuring htpasswd

FIX HPCC-15214 DOCS:Update Method for Configuring htpasswd
Update Installing and Running the HPCC Platform doc
to reflect the appropriate way to configure htpasswd security
using the Security Manager Framework.

Signed-off-by: G Panagiotatos <greg.panagiotatos@lexisnexis.com>
G Panagiotatos 9 years ago
parent
commit
c0fa5f9d9d

+ 102 - 20
docs/Installing_and_RunningTheHPCCPlatform/Inst-Mods/hpcc_ldap.xml

@@ -5,8 +5,9 @@
   <title>Configuring HPCC for Authentication</title>
 
   <para>This section details the steps to configure your HPCC platform to use
-  authentication. There are two ways to use authentication with your HPCC
-  system: simple htpasswd authentication or LDAP.</para>
+  authentication. There are currently a few ways to use authentication with
+  your HPCC system: simple htpasswd authentication, LDAP, or another plug-in
+  security method.</para>
 
   <para>The htpasswd authentication method is basic password authentication.
   It only grants or denies access to a user, based upon MD5 encrypted password
@@ -123,6 +124,67 @@
 
       <orderedlist continuation="continues">
         <listitem>
+          <para>Create an instance of the <emphasis role="bold">Security
+          Manager</emphasis> Plug-in: <orderedlist numeration="loweralpha">
+              <listitem>
+                <para>Right-click on Navigator Pane on the left side.</para>
+              </listitem>
+
+              <listitem>
+                <para>Select <emphasis role="bold">New
+                Components</emphasis></para>
+              </listitem>
+
+              <listitem>
+                <para>Select the <emphasis
+                role="bold">htpasswdsecmgr</emphasis> component</para>
+              </listitem>
+            </orderedlist></para>
+        </listitem>
+
+        <listitem>
+          <?dbfo keep-together="always"?>
+
+          <para>Configure the htpasswd plug-in<figure>
+              <title>Security Mgr Configuration page</title>
+
+              <mediaobject>
+                <imageobject>
+                  <imagedata fileref="../../images/SECM_001.jpg"
+                             vendor="configmgrSS" />
+                </imageobject>
+              </mediaobject>
+            </figure></para>
+
+          <orderedlist numeration="loweralpha">
+            <listitem>
+              <para>Enter the location of the Htpasswd file containing the
+              username and password on the Linux file system for the value of
+              <emphasis role="bold">htpasswdFile</emphasis></para>
+            </listitem>
+
+            <listitem>
+              <para><emphasis role="bold">InstanceFactoryName</emphasis> is
+              the name of the security manager factory function, implemented
+              in the security library. The default is "createInstance". For
+              implementing Htpasswd, leave the default.</para>
+            </listitem>
+
+            <listitem>
+              <para>Provide a library name value for <emphasis
+              role="bold">libName</emphasis>. For Htpasswd, use <emphasis
+              role="blue">libhtpasswdSecurity.so</emphasis></para>
+            </listitem>
+
+            <listitem>
+              <para>Provide an instance <emphasis role="bold">name</emphasis>
+              for the name value. For example, <emphasis
+              role="blue">htpasswdsecmgr</emphasis>.</para>
+            </listitem>
+          </orderedlist>
+        </listitem>
+
+        <listitem>
           <para>Select <emphasis role="bold">Esp - myesp</emphasis> in the
           Navigator panel on the left hand side.</para>
 
@@ -141,37 +203,56 @@
         <listitem>
           <?dbfo keep-together="always"?>
 
-          <para>Select the <emphasis role="bold">Authentication</emphasis>
-          tab<graphic fileref="../../images/gs-ht01.jpg"
-          vendor="configmgrSS" /></para>
+          <para>Associate the Security Manager Plug-in with the ESP binding(s)
+          <orderedlist numeration="loweralpha">
+              <listitem>
+                <para>Click on the target <emphasis role="bold">Esp</emphasis>
+                in the Navigator Pane on the left side.</para>
+              </listitem>
+
+              <listitem>
+                <para>Select the<emphasis role="bold"> ESP</emphasis>
+                <emphasis role="bold">Service bindings</emphasis> tab</para>
+              </listitem>
+
+              <listitem>
+                <para>On the target binding(s) select the appropriate
+                securityMgrPlugin instance from the drop list. <graphic
+                fileref="../../images/SECM_004.jpg"
+                vendor="configmgrSS" /></para>
+              </listitem>
+            </orderedlist></para>
         </listitem>
 
         <listitem>
-          <para>Select the <emphasis role="bold">htpasswd File</emphasis>
-          entry, set the value option to the location of the htpasswd
-          file.</para>
+          <para>Select the security Plugin for each service that requires a
+          security manager.</para>
 
-          <para>If the file does not already exist you must create one, see
-          the following section <emphasis>User administration with
-          htpasswd</emphasis>.</para>
+          <para>For example, in the above image, select <emphasis
+          role="blue">htpasswdsecmgr</emphasis> for the smc service. Then,
+          select it for ws_ecl and every other service that you want to use
+          htpassword security.</para>
         </listitem>
 
         <listitem>
-          <para>Select the <emphasis role="bold">method</emphasis>
-          entry.</para>
+          <?dbfo keep-together="always"?>
+
+          <para>Select the <emphasis role="bold">Authentication</emphasis>
+          tab<graphic fileref="../../images/gs-ht01.jpg"
+          vendor="configmgrSS" /></para>
         </listitem>
 
         <listitem>
           <?dbfo keep-together="always"?>
 
           <para>Click on the value column drop list to display the choices for
-          method. <graphic fileref="../../images/gs-ht02.jpg"
-          vendor="configmgrSS" /></para>
+          <emphasis role="bold">method</emphasis>. <graphic
+          fileref="../../images/gs-ht02.jpg" vendor="configmgrSS" /></para>
         </listitem>
 
         <listitem>
-          <para>Choose <emphasis role="bluebold">htpasswd</emphasis> from the
-          drop list.</para>
+          <para>Choose <emphasis role="bluebold">secmgrPlugin</emphasis> from
+          the drop list.</para>
         </listitem>
 
         <listitem>
@@ -184,12 +265,13 @@
       <title>User administration with htpasswd</title>
 
       <para>Users and passwords are kept in the htpasswd file. The htpasswd
-      file needs to exist on the ESP Node that you have enabled
-      authentication. HPCC only recognizes MD5 encrypted passwords.</para>
+      file must exist on the ESP Node where you have enabled authentication.
+      HPCC only recognizes MD5 encrypted passwords.</para>
 
       <para>The default location is: <emphasis
       role="bold">/etc/HPCCSystems/.htpasswd</emphasis> on the ESP node that
-      has been configured to authenticate, but it is configurable.</para>
+      has been configured to authenticate, but it is configurable from the
+      Htpasswd Security Manager as outlined above (step 9).</para>
 
       <para>You can use the htpasswd utility to create the .htpasswd file to
       administer users.</para>

BIN
docs/images/SECM_001.jpg


BIN
docs/images/SECM_004.jpg


BIN
docs/images/gs-ht01.jpg


BIN
docs/images/gs-ht02.jpg