[CIAM-696] Replace Bash "read -r -d '' variable <<- Here

String" constructs with the "variable=$(cat <-- Here String)" ones, since the
former doesn't work correctly with the Bash "set -e" setting, which is
simultaneously set on RH-SSO image modules scripts. This fixes the RH-SSO
7.5-1's image's failure to start when JGROUPS_ENCRYPT_PROTOCOL variable is
set to ASYM_ENCRYPT protocol

Also add vim-minimal RPM to the list of RPMs installed in the image
(handy for debugging)

Signed-off-by: Jan Lieskovsky <[email protected]>

Author: Jan Lieskovsky

modules/eap/setup/eap/modules/added/launch/jgroups.sh

@@ -33,12 +33,17 @@ create_jgroups_elytron_encrypt() {
     declare jg_encrypt_protocol="${1}" jg_encrypt_keystore="${2}" jg_encrypt_key_alias="${3}" jg_encrypt_password="${4}"
     local encrypt
 
-    read -r -d '' encrypt <<- EOF
+    ### CIAM-696: Start of RH-SSO add-on:
+    encrypt=$(cat <<- EOF
     <encrypt-protocol type="${jg_encrypt_protocol}" key-store="${jg_encrypt_keystore}" key-alias="${jg_encrypt_key_alias}">
        <key-credential-reference clear-text="${jg_encrypt_password}"/>
     </encrypt-protocol>
 
 EOF
+    )
+    ### Escape all newlines in the string
+    encrypt="${encrypt//$'\n'/\\n}"
+    ### End of RH-SSO add-on for CIAM-696
 
     echo "${encrypt}"
 }
@@ -88,7 +93,9 @@ create_jgroups_encrypt_asym() {
     # TODO: make these properties configurable, this is currently just falling back on defaults.
     declare sym_keylength="${1:-}" sym_algorithm="${2:-}" asym_keylength="${3:-}" asym_algorithm="${4:-}" change_key_on_leave="${5:-}"
     local jgroups_encrypt
-    read -r -d '' jgroups_encrypt <<- EOF
+
+    ### CIAM-696: Start of RH-SSO add-on:
+    jgroups_encrypt=$(cat <<- EOF
       <protocol type="ASYM_ENCRYPT">
           <property name="sym_keylength">${sym_keylength:-128}</property>
           <property name="sym_algorithm">${sym_algorithm:-AES/ECB/PKCS5Padding}</property>
@@ -97,6 +104,11 @@ create_jgroups_encrypt_asym() {
           <property name="change_key_on_leave">${change_key_on_leave:-true}</property>
       </protocol>
 EOF
+    )
+    ### Escape all newlines in the string
+    jgroups_encrypt="${jgroups_encrypt//$'\n'/\\n}"
+    ### End of RH-SSO add-on for CIAM-696
+
     echo "${jgroups_encrypt}"
 }
 
@@ -148,7 +160,9 @@ create_jgroups_elytron_legacy() {
     declare jg_encrypt_keystore="$1" jg_encrypt_password="$2" jg_encrypt_name="$3" jg_encrypt_keystore_dir="$4"
     # compatibility with old marker, only used if new marker is not present
     local legacy_encrypt
-    read -r -d '' legacy_encrypt <<- EOF
+
+    ### CIAM-696: Start of RH-SSO add-on:
+    legacy_encrypt=$(cat <<- EOF
       <protocol type="SYM_ENCRYPT">
         <property name="provider">SunJCE</property>
         <property name="sym_algorithm">AES</property>
@@ -158,6 +172,10 @@ create_jgroups_elytron_legacy() {
         <property name="alias">${jg_encrypt_name}</property>
       </protocol>
 EOF
+    )
+    ### Escape all newlines in the string
+    legacy_encrypt="${legacy_encrypt//$'\n'/\\n}"
+    ### End of RH-SSO add-on for CIAM-696
 
     echo "${legacy_encrypt}"
 }
@@ -385,12 +403,18 @@ configure_jgroups_encryption() {
 create_jgroups_encrypt_elytron_asym() {
   declare jg_encrypt_keystore="$1" jg_encrypt_key_alias="$2" jg_encrypt_password="$3" jg_encrypt_entire_message="$4"
   local encrypt
-  read -r -d '' encrypt <<- EOF
+
+  ### CIAM-696: Start of RH-SSO add-on:
+  encrypt=$(cat <<- EOF
   <encrypt-protocol type="ASYM_ENCRYPT" key-alias="${jg_encrypt_key_alias}" keystore="${jg_encrypt_keystore}">
     <key-credential-reference clear-text="${jg_encrypt_password}"/>
     <property name="encrypt_entire_message">"${jg_encrypt_entire_message}"</property>
   </encrypt-protocol>
 EOF
+  )
+  ### Escape all newlines in the string
+  encrypt="${encrypt//$'\n'/\\n}"
+  ### End of RH-SSO add-on for CIAM-696
 
   echo "${encrypt}"
 }

modules/eap/setup/eap/modules/added/launch/jgroups_common.sh

@@ -6,7 +6,14 @@ configure_protocol_cli_helper() {
   local stack=${params[0]}
   local protocol=${params[1]}
   local result
-  IFS= read -rd '' result <<- EOF
+
+  ### CIAM-696: Start of RH-SSO add-on:
+  ### ---------------------------------
+  ### Replace bash "read -r -d '' variable <<- Here String" constructs with
+  ### "variable=$(cat <<- Here String)" form since the former doesn't work
+  ### correctly in combination with "set -e" directive being simultaneously set
+  ### on container modules scripts
+  IFS= result=$(cat <<- EOF
 
     if (outcome == success) of /subsystem=jgroups/stack="${stack}"/protocol="${protocol}":read-resource
         echo Cannot configure jgroups '${protocol}' protocol under '${stack}' stack. This protocol is already configured. >> \${error_file}
@@ -16,6 +23,9 @@ configure_protocol_cli_helper() {
     if (outcome != success) of /subsystem=jgroups/stack="${stack}"/protocol="${protocol}":read-resource
         batch
 EOF
+  )
+  ### End of RH-SSO add-on for CIAM-696
+
   # removes the latest new line added by read builtin command
   result=$(echo -n "${result}")
 
@@ -25,12 +35,14 @@ EOF
             ${params[j]}"
   done
 
-  IFS= read -r -d '' result <<- EOF
+  ### CIAM-696: Start of RH-SSO add-on
+  IFS= result=$(cat <<- EOF
         ${result}
        run-batch
     end-if
 EOF
-
+  )
+  ### End of RH-SSO add-on for CIAM-696
 
   echo "${result}"
 }

modules/eap/setup/eap/modules/added/launch/json_logging.sh

@@ -56,13 +56,16 @@ function consoleHandlerName() {
   declare name="$1"
   local result=""
 
-  read -r -d '' result <<EOF
+  ### CIAM-696: Start of RH-SSO add-on:
+  result=$(cat <<EOF
     if (outcome != success) of /subsystem=logging/console-handler=CONSOLE:read-resource
       /subsystem=logging/console-handler=CONSOLE:add(named-formatter=${name})
     else
       /subsystem=logging/console-handler=CONSOLE:write-attribute(name=named-formatter, value=${name})
     end-if
 EOF
+  )
+  ### End of RH-SSO add-on for CIAM-696
 
   echo "$result"
 }

modules/eap/setup/eap/modules/module.yaml

@@ -17,11 +17,11 @@ packages:
     - python3-requests
     # RH-SSO add-on:
     # -------------
-    # Add 'which' & 'tree' RPM packages
-    # "which" tool is handy for debugging issues / troubleshooting
+    # Add 'which', 'tree' & 'vim-minimal' RPM packages, which are handy for
+    # issue debugging / troubleshooting purposes
     - which
-    # "tree" tool is handy to inspect directory structure when needed
     - tree
+    - vim-minimal
     # End of RH-SSO add-on
     # --------------------
 ports: