PropFilePasswordEncoder command reference

The PropFilePasswordEncoder command encodes passwords that are located in plain text property files. This command encodes both Secure Authentication Server (SAS) property files and non-SAS property files. After you encode the passwords, a decoding command does not exist.

To encode passwords, you must run this command from the directory:
Avoid trouble Avoid trouble: If you need to custom encode passwords in property files, manually edit the PropFilePasswordEncoder.sh or PropFilePasswordEncoder.bat file before issuing this command. See the topic Implementing custom password encryption for a description of the lines that need to be added to this file.gotcha
Note: To enable PropFilePasswordEncoder to print out more a debug message than in previous releases, update the command by entering the following:
-Dcom.ibm.websphere.security.passwordEncoderDebug=true

To run this script, your user profile must have *ALLOBJ authority.

Syntax

The command syntax is as follows:
PropFilePasswordEncoder "file_name" { passwordPropertiesList | -SAS } { -noBackup | -Backup } 
    [ -profileName profile ] [ -help | -? ]
The command syntax is as follows:
PropFilePasswordEncoder "fileName" { passwordPropertiesList
  | -SAS } [ -profileName profile ] [ -help | -? ]
Important: You must specify either the passwordPropertiesList parameter or the -SAS parameter.

Parameters

The following option is available for the PropFilePasswordEncoder command:

fileName
This required parameter specifies the name of the file in which passwords are encoded.
file_name
This required parameter specifies the name of the file in which passwords are encoded.
passwordPropertiesList
This parameter is required if you are encoding passwords in property files other than the sas.client.props file. Specify one or more password properties that you want to encode. The password properties list should be delimited by commas.
-SAS
This parameter is required if you are encoding passwords in the sas.client.props file.
-profileName
This parameter is optional. The profile value specifies an application server profile name. The script uses the password encoding algorithm that it retrieves from the specified profile. If you do not specify this parameter, the script uses the default profile.
-noBackup
This parameter is optional and the default. The script does not create a backup file. The default value can be altered by adding following Java System Property: "-Dcom.ibm.websphere.security.util.createBackup=true".
-Backup
This parameter is optional. The script creates a backup file, <file_name>.bak, which contains passwords in clear text.
-profileName
This parameter is optional. The profile value specifies an application server profile name. The script uses the password encoding algorithm that it retrieves from the specified profile. If you do not specify this parameter, the script uses the default profile.
-help or -?
If you specify this parameter, the script ignores all other parameters and displays usage text.

Example

The following examples demonstrate correct uses of the syntax:

PropFilePasswordEncoder "file_name" password_properties_list
PropFilePasswordEncoder "file_name" -SAS

The following command encodes the passwords in the sas.client.props file for the default stand-alone application server profile:
app_server_root/bin/PropFilePasswordEncoder
 profile_root/default/properties/sas.client.props -SAS
The following command encodes the passwords in the soap.client.props file for the default stand-alone application server profile:
app_server_root/bin/PropFilePasswordEncoder
 profile_root/default/properties/soap.client.props
com.ibm.SOAP.loginPassword,com.ibm.ssl.keyStorePassword,com.ibm.ssl.trustStorePassword
Attention: These commands are displayed on multiple lines for illustrative purposes only.



Related tasks
Encoding passwords in files
Manually encoding passwords in properties files
Implementing custom password encryption
Reference topic Reference topic    

Terms and conditions for information centers | Feedback

Last updatedLast updated: Feb 6, 2014 8:11:25 PM CST
http://www14.software.ibm.com/webapp/wsbroker/redirect?version=matt&product=was-nd-mp&topic=rsec_propfilepwdencoder
File name: rsec_propfilepwdencoder.html