OMBPlus: masking usernames / passwords in log files with ********?

Question

Hi all,
Subjects says it: how to hide username and password in OMBPlus logs.
Any ideas...?
Br: Ykspisto

Answer 1

I don't use default OMB+ logging for this reason, plus I often want more robust logging. I also built a wrapper for executing OMB+ statements to simplify my exception handling in my main scripts. By catching both the return string from a statement as well as the exception strings, I keep full control over what gets logged.
HEre is the meat of my main library file:
# PVCS Version Information
#/* $Workfile:   omb_library.tcl  $ $Revision:   2.9  $ */
#/* $Author:   michael.broughton  $
#/* $Date:   10 Mar 2009 11:04:50  $ */
# Default logging function.
#  Accepts inputs: LOGMSG - a text string to output
proc log_msg {LOGTYPE LOGMSG} {
   #logs to screen and file
   global SPOOLFILE
   if {![info exists SPOOLFILE]} {
       puts "LOGFILE UNDEFINED! :-> $LOGTYPE:-> $LOGMSG"
   } else {
       set fout [open "$SPOOLFILE" a+]     
       puts $fout "$LOGTYPE:-> $LOGMSG"
       puts "$LOGTYPE:-> $LOGMSG"
       close $fout
proc log_msg_file_only {LOGTYPE LOGMSG} {
    #logs to file only
    global SPOOLFILE
    if {![info exists SPOOLFILE]} {
       puts "LOGFILE UNDEFINED! :-> $LOGTYPE:-> $LOGMSG"
    } else {
       set fout [open "$SPOOLFILE" a+]     
       puts $fout "$LOGTYPE:-> $LOGMSG"
       close $fout
proc exit_failure { msg } {
   log_msg ERROR "$msg"
   log_msg ERROR "Rolling Back....."
   exec_omb OMBROLLBACK
   log_msg ERROR "Exiting....."
   # return and also bail from calling function
   return -code 2
proc exec_omb { args } {
   # Uncomment if you want all source commands spooled out to log
   # disabled in production to avoid logging passwords.
   # log_msg_file_only OMBCMD "$args"
   # the point of this is simply to return errorMsg or return string, whichever is applicable,
   # to simplify error checking using omb_error{}
   if [catch { set retstr [eval $args] } errmsg] {
      log_msg OMB_ERROR "$errmsg"
      log_msg "" ""
      return $errmsg
   } else {
      log_msg OMB_SUCCESS "$retstr"
      log_msg "" ""
      return $retstr
proc omb_error { retstr } {
   # OMB and Oracle errors may have caused a failure.
   if [string match OMB0* $retstr] {
      return 1
   } elseif [string match ORA-* $retstr] {
      return 1
   } elseif [string match java.* $retstr] {
      return 1
   } elseif [string match Error* $retstr] {
      return 1
   } else {
      return 0
proc ers_omb_connect { OWB_USER OWB_PASS OWB_HOST OWB_PORT OWB_SRVC OWB_REPOS } {
   # Commit anything from previous work, otherwise OMBDISCONNECT will fail out.
   catch { set retstr [ OMBSAVE ] } errmsg
   log_msg LOG "Checking current connection status...."
   #Ensure that we are not already connected.
   if [catch { set discstr [ OMBDISCONNECT ] } errmsg ] {
      set discstr $errmsg
   # Test if message is "OMB01001: Not connected to repository." or "Disconnected."
   # any other message is a showstopper!
   if [string match Disconn* $discstr ]  {
      log_msg LOG "Success Disconnecting from previous repository...."
   } else {
      # We expect an OMB01001 error for trying to disconnect when not connected
      if [string match OMB01001* $discstr ] {
          log_msg LOG "Disconnect unneccessary. Not currently connected...."
      } else {
          log_msg ERROR "Error Disconnecting from previous repository....Exiting process."
          exit_failure "$discstr"
   set print [exec_omb OMBCONNECT $OWB_USER/$OWB_PASS@$OWB_HOST:$OWB_PORT:$OWB_SRVC USE REPOSITORY '$OWB_REPOS']
   if [string match *Connected* $print] {
      return $print
   } else {
      return "OMB0-Unknown Error connecting. Validate connection settings and try again"
}and I handle setting up the log file with a standard header at the top of each script, as illustrated here in a script I use to set up and register a location and control centers for when we build a new dev environment. Most of the referenced variables are held in a config script that we use to define our current working environment, which I am not attaching as the names are pretty descriptive I think.
# PVCS Version Information
#/* $Workfile:   setup_dev_location.tcl  $ $Revision:   2.1  $ */
#/* $Author:   michael.broughton  $
#/* $Date:   27 Nov 2008 10:00:00  $ */
#  Get Current Directory and time
# supporting config and library files must be in the same directory as this script
set dtstmp     [ clock format [clock seconds] -format {%Y%m%d_%H%M}]
set scrpt      [ file split [file root [info script]]]
set scriptDir  [ file dirname [info script]]
set scriptName [ lindex $scrpt [expr [llength $scrpt]-1]]
set cnfg_lib "$scriptDir/ombplus_config.tcl"
set owb_lib  "$scriptDir/omb_library.tcl"
set sql_lib  "$scriptDir/omb_sql_library.tcl"
#  Import Lbraries
#get config file
source $cnfg_lib
#get standard library
source $owb_lib
#get SQL library
source $sql_lib
#  Set Logfile
#    This will overwrite anything set in the config file.
set LOG_PATH "$scriptDir/logs"
file mkdir $LOG_PATH
set    SPOOLFILE  ""
append SPOOLFILE $LOG_PATH "/log_"  $scriptName "_" $dtstmp ".txt"
#  Connect to repos
set print [ers_omb_connect $OWB_DEG_USER $OWB_DEG_PASS $OWB_DEG_HOST $OWB_DEG_PORT $OWB_DEG_SRVC $OWB_DEG_REPOS]
if [omb_error $print] {
    log_msg ERROR "Unable to connect to repository."
    log_msg ERROR "$print"
    log_msg ERROR "Exiting Script.............."
    return
} else {
    log_msg LOG "Connected to Repository"   
# Connect to project
set print [exec_omb OMBCC '$PROJECT_NAME']
if [omb_error $print] {
   exit_Failure "Project $PROJECT_NAME does not exist. Exiting...."
} else {
   log_msg LOG "Switched context to project $PROJECT_NAME"
# Check Existance of Oracle Module
set print [exec_omb OMBCC '$ORA_MODULE_NAME']
if [omb_error $print] {
   exit_Failure "Module $ORA_MODULE_NAME does not exist. Creating...."
} else {
   log_msg LOG "Confirmed existance of module $ORA_MODULE_NAME"
#switch back up to project level. You cannot attach locations to a module if you are in it.
exec_omb OMBCC '..'
log_msg LOG "Switched context back up to project $PROJECT_NAME"
# Force Re-registration of OWB User
log_msg LOG "(Re-)Registering user $DATA_LOCATION_USER"
log_msg LOG "Disconnecting from Corporate Design Repository"
exec_omb OMBCOMMIT
exec_omb OMBDISCONNECT
log_msg LOG "Connecting to Runtime Repository"
set print [ers_omb_connect $CONTROL_CENTER_SCHEMA $CONTROL_CENTER_PASS $DATA_LOCATION_HOST $DATA_LOCATION_PORT $DATA_LOCATION_SRVC $CONTROL_CENTER_SCHEMA]
set print [ exec_omb OMBUNREGISTER USER '$DATA_LOCATION_USER' IDENTIFIED BY '$DATA_LOCATION_PASS' ]
set print [ exec_omb OMBREGISTER USER '$DATA_LOCATION_USER' SET PROPERTIES (DESCRIPTION, ISTARGETSCHEMA, TARGETSCHEMAPWD) VALUES ('$DATA_LOCATION_USER', 'true', '$DATA_LOCATION_PASS')]
if [omb_error $print] {
   exit_failure "Unable to register user '$DATA_LOCATION_USER'"
log_msg LOG "Disconnecting from Runtime Repository"
exec_omb OMBCOMMIT
exec_omb OMBDISCONNECT
log_msg LOG "Re-Connecting to Corporate Design Repository"
set print [ers_omb_connect $OWB_DEG_USER $OWB_DEG_PASS $OWB_DEG_HOST $OWB_DEG_PORT $OWB_DEG_SRVC $OWB_DEG_REPOS]
log_msg LOG "Changing context back to project $PROJECT_NAME"
set print [exec_omb OMBCC '$PROJECT_NAME']
# Validate to Control Center
set lst [OMBLIST CONTROL_CENTERS]
if [string match *$CONTROL_CENTER_NAME* $lst] {
   log_msg LOG "Verified Control Center $CONTROL_CENTER_NAME Exists."
   set lst [OMBLIST LOCATIONS]
   if [string match *$DATA_LOCATION_NAME* $lst] {
       log_msg LOG "Verified Location $DATA_LOCATION_NAME Exists."
       log_msg LOG "Setting Control Center as default control center for project"
       exec_omb OMBCC 'DEFAULT_CONFIGURATION'
       set print [exec_omb OMBALTER DEPLOYMENT 'DEFAULT_DEPLOYMENT' SET REF CONTROL_CENTER '$CONTROL_CENTER_NAME' ]
       if [omb_error $print] {
          exit_failure "Unable to set Control Center $CONTROL_CENTER_NAME in default configuration"
       exec_omb OMBCOMMIT
       exec_omb OMBCC '..'
       log_msg LOG "Setting Passwords to enable import and deploy"
       set print [exec_omb OMBALTER LOCATION '$DATA_LOCATION_NAME' SET PROPERTIES (PASSWORD) VALUES ('$DATA_LOCATION_PASS')]
       if [omb_error $print] {
          exit_failure "Unable to log onto location '$DATA_LOCATION_NAME' with password $DATA_LOCATION_PASS"
       exec_omb OMBCOMMIT
       log_msg LOG "Connecting to Control Center $CONTROL_CENTER_NAME"
       set print [exec_omb OMBCONNECT CONTROL_CENTER USE '$DATA_LOCATION_PASS' ]
       if [omb_error $print] {
          exit_failure "Unable to connect to Control Center $CONTROL_CENTER_NAME"
       exec_omb OMBCOMMIT
       log_msg LOG "Connected.............."
   } else {
       log_msg LOG "Control Center Exists, but Location Does Not."
       log_msg LOG "Creating Code Location."
       log_msg LOG "Checking Global_names...."
       set dbGlobalNames FALSE
       set oraConn [oracleConnect $OWB_DEG_HOST $OWB_DEG_SRVC $OWB_DEG_PORT $OWB_DEG_USER $OWB_DEG_PASS ]
       set oraRs [oracleQuery $oraConn "select value pvalue FROM V\$PARAMETER where name = 'global_names'"]
       while {[$oraRs next]} {
           set dbGlobalNames [$oraRs getString pvalue]
       $oraRs close
       $oraConn close
       log_msg LOG "Global_names are $dbGlobalNames...."
       if [string match TRUE $dbGlobalNames] {
           set print [exec_omb OMBCREATE LOCATION '$DATA_LOCATION_NAME' SET PROPERTIES (TYPE, VERSION, DESCRIPTION, BUSINESS_NAME, HOST, PORT, SERVICE, CONNECT_AS_USER, PASSWORD, DATABASE_NAME) VALUES ('ORACLE_DATABASE','$DATA_LOCATION_VERS','ERS Datamart Code User','$DATA_LOCATION_NAME', '$DATA_LOCATION_HOST','$DATA_LOCATION_PORT','$DATA_LOCATION_SRVC', '$DATA_LOCATION_USER','$DATA_LOCATION_PASS','$DATA_LOCATION_SRVC' ) ] 
       } else {
           set print [exec_omb OMBCREATE LOCATION '$DATA_LOCATION_NAME' SET PROPERTIES (TYPE, VERSION, DESCRIPTION, BUSINESS_NAME, HOST, PORT, SERVICE, CONNECT_AS_USER, PASSWORD) VALUES ('ORACLE_DATABASE','$DATA_LOCATION_VERS','ERS Datamart Code User','$DATA_LOCATION_NAME', '$DATA_LOCATION_HOST','$DATA_LOCATION_PORT','$DATA_LOCATION_SRVC', '$DATA_LOCATION_USER','$DATA_LOCATION_PASS') ] 
       if [omb_error $print] {
          exit_failure "Unable to create location '$DATA_LOCATION_NAME'"
       exec_omb OMBSAVE
       log_msg LOG "Adding Location $DATA_LOCATION_NAME to Control Center $CONTROL_CENTER_NAME"
       set print [exec_omb OMBALTER CONTROL_CENTER '$CONTROL_CENTER_NAME' ADD REF LOCATION '$DATA_LOCATION_NAME' SET PROPERTIES (IS_TARGET, IS_SOURCE) VALUES ('true', 'true') ]
       if [omb_error $print] {
           exit_failure "Unable to add Location $DATA_LOCATION_NAME to Control Center $CONTROL_CENTER_NAME"
       exec_omb OMBCOMMIT
       log_msg LOG "Setting Control Center as default control center for project"
       exec_omb OMBCC 'DEFAULT_CONFIGURATION'
       set print [exec_omb OMBALTER DEPLOYMENT 'DEFAULT_DEPLOYMENT' SET REF CONTROL_CENTER '$CONTROL_CENTER_NAME' ]
       if [omb_error $print] {
          exit_failure "Unable to set Control Center $CONTROL_CENTER_NAME in default configuration"
       exec_omb OMBCOMMIT
       exec_omb OMBCC '..'
       log_msg LOG "Connecting to Control Center $CONTROL_CENTER_NAME"
       set print [exec_omb OMBCONNECT CONTROL_CENTER USE '$DATA_LOCATION_PASS' ]
       if [omb_error $print] {
          exit_failure "Unable to connect to Control Center $CONTROL_CENTER_NAME"
       exec_omb OMBCOMMIT
       log_msg LOG "Registering Code Location."
       set print [exec_omb OMBALTER LOCATION '$DATA_LOCATION_NAME' SET PROPERTIES (PASSWORD) VALUES ('$DATA_LOCATION_PASS')]
       exec_omb OMBCOMMIT
       set print [exec_omb OMBREGISTER LOCATION '$DATA_LOCATION_NAME']
       if [omb_error $print] {
          exit_failure "Unable to register Location $DATA_LOCATION_NAME"
       exec_omb OMBCOMMIT
} else {
   log_msg LOG "Need to create Control Center $CONTROL_CENTER_NAME."
   log_msg LOG "Creating Code Location."
   log_msg LOG "Checking Global_names...."
   set dbGlobalNames FALSE
   set oraConn [oracleConnect $DATA_LOCATION_HOST $DATA_LOCATION_SRVC $DATA_LOCATION_PORT $CONTROL_CENTER_SCHEMA $CONTROL_CENTER_PASS ]
   set oraRs [oracleQuery $oraConn "select value pvalue FROM V\$PARAMETER where name = 'global_names'"]
   while {[$oraRs next]} {
     set dbGlobalNames [$oraRs getString pvalue]
   $oraRs close
   $oraConn close
   log_msg LOG "Global_names are $dbGlobalNames...."
   if [string match TRUE $dbGlobalNames] {
       set print [exec_omb OMBCREATE LOCATION '$DATA_LOCATION_NAME' SET PROPERTIES (TYPE, VERSION, DESCRIPTION, BUSINESS_NAME, HOST, PORT, SERVICE, CONNECT_AS_USER, PASSWORD, DATABASE_NAME) VALUES ('ORACLE_DATABASE','$DATA_LOCATION_VERS','ERS Datamart Code User','$DATA_LOCATION_NAME', '$DATA_LOCATION_HOST','$DATA_LOCATION_PORT','$DATA_LOCATION_SRVC', '$DATA_LOCATION_USER','$DATA_LOCATION_PASS','$DATA_LOCATION_SRVC' ) ] 
   } else {
       set print [exec_omb OMBCREATE LOCATION '$DATA_LOCATION_NAME' SET PROPERTIES (TYPE, VERSION, DESCRIPTION, BUSINESS_NAME, HOST, PORT, SERVICE, CONNECT_AS_USER, PASSWORD) VALUES ('ORACLE_DATABASE','$DATA_LOCATION_VERS','ERS Datamart Code User','$DATA_LOCATION_NAME', '$DATA_LOCATION_HOST','$DATA_LOCATION_PORT','$DATA_LOCATION_SRVC', '$DATA_LOCATION_USER','$DATA_LOCATION_PASS') ] 
   if [omb_error $print] {
      exit_failure "Unable to create location '$DATA_LOCATION_NAME'"
   exec_omb OMBCOMMIT
   log_msg LOG "Creating Control Center"
   set print [exec_omb OMBCREATE CONTROL_CENTER '$CONTROL_CENTER_NAME' SET PROPERTIES (DESCRIPTION, BUSINESS_NAME, HOST, PORT, SERVICE_NAME, USER, SCHEMA, PASSWORD) VALUES ('ERS Datamart Control Center','$CONTROL_CENTER_NAME', '$DATA_LOCATION_HOST','$DATA_LOCATION_PORT','$DATA_LOCATION_SRVC', '$DATA_LOCATION_USER', '$CONTROL_CENTER_SCHEMA','$DATA_LOCATION_PASS') ]
   if [omb_error $print] {
      exit_failure "Unable to create control center '$CONTROL_CENTER_NAME'"
   exec_omb OMBCOMMIT
   log_msg LOG "Adding Location $DATA_LOCATION_NAME to Control Center $CONTROL_CENTER_NAME"
   set print [exec_omb OMBALTER CONTROL_CENTER '$CONTROL_CENTER_NAME' ADD REF LOCATION '$DATA_LOCATION_NAME' SET PROPERTIES (IS_TARGET, IS_SOURCE) VALUES ('true', 'true') ]
   if [omb_error $print] {
      exit_failure "Unable to add Location $DATA_LOCATION_NAME to Control Center $CONTROL_CENTER_NAME"
   exec_omb OMBCOMMIT
   log_msg LOG "Setting Control Center as default control center for project"
   exec_omb OMBCC 'DEFAULT_CONFIGURATION'
   set print [exec_omb OMBALTER DEPLOYMENT 'DEFAULT_DEPLOYMENT' SET REF CONTROL_CENTER '$CONTROL_CENTER_NAME' ]
   if [omb_error $print] {
      exit_failure "Unable to set Control Center $CONTROL_CENTER_NAME in default configuration"
   exec_omb OMBCOMMIT
   exec_omb OMBCC '..'
   log_msg LOG "Connecting to Control Center $CONTROL_CENTER_NAME"
   set print [exec_omb OMBCONNECT CONTROL_CENTER USE '$DATA_LOCATION_PASS' ]
   if [omb_error $print] {
      exit_failure "Unable to add Location $DATA_LOCATION_NAME to Control Center $CONTROL_CENTER_NAME"
   exec_omb OMBCOMMIT
   log_msg LOG "Registering Code Location."
   set print [exec_omb OMBALTER LOCATION '$DATA_LOCATION_NAME' SET PROPERTIES (PASSWORD) VALUES ('$DATA_LOCATION_PASS')]
   exec_omb OMBCOMMIT
   set print [exec_omb OMBREGISTER LOCATION '$DATA_LOCATION_NAME']
   if [omb_error $print] {
      exit_failure "Unable to register Location $DATA_LOCATION_NAME"
   exec_omb OMBCOMMIT
# Assign location to Oracle Module
log_msg LOG "Assigning Code Location to Oracle Module."
set print [ exec_omb OMBALTER ORACLE_MODULE '$ORA_MODULE_NAME' ADD REFERENCE LOCATION '$DATA_LOCATION_NAME' SET AS DEFAULT ]
if [omb_error $print] {
   exit_failure "Unable to add reference location '$DATA_LOCATION_NAME' to module '$ORA_MODULE_NAME' "
set print [ exec_omb OMBALTER ORACLE_MODULE '$ORA_MODULE_NAME' SET REFERENCE METADATA_LOCATION '$DATA_LOCATION_NAME' ]
if [omb_error $print] {
   exit_failure "Unable to set metadata location '$DATA_LOCATION_NAME' on module '$ORA_MODULE_NAME' "
set print [ exec_omb OMBALTER ORACLE_MODULE '$ORA_MODULE_NAME' SET PROPERTIES (DB_LOCATION) VALUES ('$DATA_LOCATION_NAME') ]
if [omb_error $print] {
   lexit_failure "Unable to add db_location '$DATA_LOCATION_NAME' to module '$ORA_MODULE_NAME' "
exec_omb OMBCOMMIT
exec_omb OMBDISCONNECT