Skip to content

Commit 8eb89cc

Browse files
CarolynRountreeCarolynRountree
authored
Wdt 961 password ease of use (#972)
1 parent 9b9a0cf commit 8eb89cc

File tree

18 files changed

+236
-0
lines changed

18 files changed

+236
-0
lines changed

‎core/src/main/python/create.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,8 +73,12 @@
7373
CommandLineArgUtil.VARIABLE_FILE_SWITCH,
7474
CommandLineArgUtil.USE_ENCRYPTION_SWITCH,
7575
CommandLineArgUtil.PASSPHRASE_SWITCH,
76+
CommandLineArgUtil.PASSPHRASE_ENV_SWITCH,
77+
CommandLineArgUtil.PASSPHRASE_FILE_SWITCH,
7678
CommandLineArgUtil.OPSS_WALLET_SWITCH,
7779
CommandLineArgUtil.OPSS_WALLET_PASSPHRASE,
80+
CommandLineArgUtil.OPSS_WALLET_FILE_PASSPHRASE,
81+
CommandLineArgUtil.OPSS_WALLET_ENV_PASSPHRASE,
7882
CommandLineArgUtil.UPDATE_RCU_SCHEMA_PASS_SWITCH
7983
]
8084

‎core/src/main/python/deploy.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,8 +55,12 @@
5555
CommandLineArgUtil.ADMIN_URL_SWITCH,
5656
CommandLineArgUtil.ADMIN_USER_SWITCH,
5757
CommandLineArgUtil.ADMIN_PASS_SWITCH,
58+
CommandLineArgUtil.ADMIN_PASS_FILE_SWITCH,
59+
CommandLineArgUtil.ADMIN_PASS_ENV_SWITCH,
5860
CommandLineArgUtil.USE_ENCRYPTION_SWITCH,
5961
CommandLineArgUtil.PASSPHRASE_SWITCH,
62+
CommandLineArgUtil.PASSPHRASE_FILE_SWITCH,
63+
CommandLineArgUtil.PASSPHRASE_ENV_SWITCH,
6064
CommandLineArgUtil.OUTPUT_DIR_SWITCH,
6165
CommandLineArgUtil.DISCARD_CURRENT_EDIT_SWITCH,
6266
CommandLineArgUtil.CANCEL_CHANGES_IF_RESTART_REQ_SWITCH

‎core/src/main/python/discover.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,8 @@
7676
CommandLineArgUtil.ADMIN_URL_SWITCH,
7777
CommandLineArgUtil.ADMIN_USER_SWITCH,
7878
CommandLineArgUtil.ADMIN_PASS_SWITCH,
79+
CommandLineArgUtil.ADMIN_PASS_FILE_SWITCH,
80+
CommandLineArgUtil.ADMIN_PASS_ENV_SWITCH,
7981
CommandLineArgUtil.TARGET_MODE_SWITCH,
8082
CommandLineArgUtil.OUTPUT_DIR_SWITCH,
8183
CommandLineArgUtil.TARGET_SWITCH

‎core/src/main/python/encrypt.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,8 @@
4545
CommandLineArgUtil.MODEL_FILE_SWITCH,
4646
CommandLineArgUtil.VARIABLE_FILE_SWITCH,
4747
CommandLineArgUtil.PASSPHRASE_SWITCH,
48+
CommandLineArgUtil.PASSPHRASE_FILE_SWITCH,
49+
CommandLineArgUtil.PASSPHRASE_ENV_SWITCH,
4850
CommandLineArgUtil.ENCRYPT_MANUAL_SWITCH,
4951
CommandLineArgUtil.ONE_PASS_SWITCH
5052
]

‎core/src/main/python/extract_resource.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,8 @@
4545
CommandLineArgUtil.VARIABLE_FILE_SWITCH,
4646
CommandLineArgUtil.USE_ENCRYPTION_SWITCH,
4747
CommandLineArgUtil.PASSPHRASE_SWITCH,
48+
CommandLineArgUtil.PASSPHRASE_FILE_SWITCH,
49+
CommandLineArgUtil.PASSPHRASE_ENV_SWITCH,
4850
]
4951

5052

‎core/src/main/python/update.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,8 +58,12 @@
5858
CommandLineArgUtil.ADMIN_URL_SWITCH,
5959
CommandLineArgUtil.ADMIN_USER_SWITCH,
6060
CommandLineArgUtil.ADMIN_PASS_SWITCH,
61+
CommandLineArgUtil.ADMIN_PASS_FILE_SWITCH,
62+
CommandLineArgUtil.ADMIN_PASS_ENV_SWITCH,
6163
CommandLineArgUtil.USE_ENCRYPTION_SWITCH,
6264
CommandLineArgUtil.PASSPHRASE_SWITCH,
65+
CommandLineArgUtil.PASSPHRASE_ENV_SWITCH,
66+
CommandLineArgUtil.PASSPHRASE_FILE_SWITCH,
6367
CommandLineArgUtil.CANCEL_CHANGES_IF_RESTART_REQ_SWITCH,
6468
CommandLineArgUtil.OUTPUT_DIR_SWITCH,
6569
CommandLineArgUtil.UPDATE_RCU_SCHEMA_PASS_SWITCH,

‎core/src/main/python/wlsdeploy/util/cla_utils.py

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,11 @@
66
"""
77
import os
88
import java.io.File as JFile
9+
import java.io.BufferedReader as BufferedReader
10+
import java.io.InputStreamReader as InputStreamReader
11+
import java.io.IOException as IOException
912
import java.lang.IllegalArgumentException as JIllegalArgumentException
13+
import java.lang.System as System
1014
import java.net.URI as JURI
1115
import java.net.URISyntaxException as JURISyntaxException
1216

@@ -45,12 +49,16 @@ class CommandLineArgUtil(object):
4549
ADMIN_USER_SWITCH = '-admin_user'
4650
# phony arg used as a key to store the password
4751
ADMIN_PASS_SWITCH = '-admin_pass'
52+
ADMIN_PASS_FILE_SWITCH = '-admin_pass_file'
53+
ADMIN_PASS_ENV_SWITCH = '-admin_pass_env'
4854
ARCHIVE_FILE_SWITCH = '-archive_file'
4955
SKIP_ARCHIVE_FILE_SWITCH = '-skip_archive'
5056
MODEL_FILE_SWITCH = '-model_file'
5157
DISCARD_CURRENT_EDIT_SWITCH = '-discard_current_edit'
5258
OPSS_WALLET_SWITCH = '-opss_wallet'
5359
OPSS_WALLET_PASSPHRASE = '-opss_wallet_passphrase'
60+
OPSS_WALLET_FILE_PASSPHRASE = '-opss_wallet_passphrase_file'
61+
OPSS_WALLET_ENV_PASSPHRASE = '-opss_wallet_passphrase_env'
5462
PREVIOUS_MODEL_FILE_SWITCH = '-prev_model_file'
5563
VARIABLE_FILE_SWITCH = '-variable_file'
5664
RCU_DB_SWITCH = '-rcu_db'
@@ -62,6 +70,8 @@ class CommandLineArgUtil(object):
6270
RCU_SCHEMA_PASS_SWITCH = '-rcu_schema_pass'
6371
# phony arg used as a key to store the encryption passphrase
6472
PASSPHRASE_SWITCH = '-passphrase'
73+
PASSPHRASE_ENV_SWITCH = '-passphrase_env'
74+
PASSPHRASE_FILE_SWITCH = '-passphrase_file'
6575
ENCRYPT_MANUAL_SWITCH = '-manual'
6676
# phony arg used as a key to store the password
6777
ONE_PASS_SWITCH = '-password'
@@ -230,10 +240,26 @@ def process_args(self, args, tool_type=TOOL_TYPE_DEFAULT, trailing_arg_count=0):
230240
value, idx = self._get_arg_value(args, idx)
231241
self._validate_admin_pass_arg(value)
232242
self._add_arg(key, value)
243+
elif self.is_admin_pass_env_key(key):
244+
env_var, idx = self._get_arg_value(args, idx)
245+
value = self._get_env_var_value(env_var)
246+
self._add_arg(self.get_admin_pass_key(), value)
247+
elif self.is_admin_pass_file_key(key):
248+
file_var, idx = self._get_arg_value(args, idx)
249+
value = self._get_from_file_value(file_var)
250+
self._add_arg(self.get_admin_pass_key(), value)
233251
elif self.is_archive_file_key(key):
234252
value, idx = self._get_arg_value(args, idx)
235253
full_path = self._validate_archive_file_arg(value)
236254
self._add_arg(key, full_path, True)
255+
elif self.is_opss_passphrase_env(key):
256+
env_var, idx = self._get_arg_value(args, idx)
257+
value = self._get_env_var_value(env_var)
258+
self._add_arg(self.get_opss_passphrase_key(), value)
259+
elif self.is_opss_passphrase_file(key):
260+
file_var, idx = self._get_arg_value(args, idx)
261+
value = self._get_from_file_value(file_var)
262+
self._add_arg(self.get_opss_passphrase_key(), value)
237263
elif self.is_opss_passphrase_key(key):
238264
value, idx = self._get_arg_value(args, idx)
239265
self._validate_opss_passphrase_arg(value)
@@ -281,6 +307,14 @@ def process_args(self, args, tool_type=TOOL_TYPE_DEFAULT, trailing_arg_count=0):
281307
value, idx = self._get_arg_value(args, idx)
282308
self._validate_passphrase_arg(value)
283309
self._add_arg(key, value)
310+
elif self.is_passphrase_env_switch(key):
311+
env_var, idx = self._get_arg_value(args, idx)
312+
value = self._get_env_var_value(env_var)
313+
self._add_arg(self.get_passphrase_switch(), value)
314+
elif self.is_passphrase_file_switch(key):
315+
file_var, idx = self._get_arg_value(args, idx)
316+
value = self._get_from_file_value(file_var)
317+
self._add_arg(self.get_passphrase_switch(), value)
284318
elif self.is_one_pass_switch(key):
285319
value, idx = self._get_arg_value(args, idx)
286320
self._validate_one_pass_arg(value)
@@ -663,6 +697,12 @@ def get_admin_pass_key(self):
663697
def is_admin_pass_key(self, key):
664698
return self.ADMIN_PASS_SWITCH == key
665699

700+
def is_admin_pass_env_key(self, key):
701+
return self.ADMIN_PASS_ENV_SWITCH == key
702+
703+
def is_admin_pass_file_key(self, key):
704+
return self.ADMIN_PASS_FILE_SWITCH == key
705+
666706
def _validate_admin_pass_arg(self, value):
667707
method_name = '_validate_admin_pass_arg'
668708

@@ -709,6 +749,14 @@ def is_opss_passphrase_key(self, key):
709749

710750
return self.OPSS_WALLET_PASSPHRASE == key
711751

752+
def is_opss_passphrase_env(self, key):
753+
754+
return self.OPSS_WALLET_ENV_PASSPHRASE == key
755+
756+
def is_opss_passphrase_file(self, key):
757+
758+
return self.OPSS_WALLET_FILE_PASSPHRASE == key
759+
712760
def _validate_opss_passphrase_arg(self, value):
713761
method_name = '_validate_opss_passphrase_arg'
714762
if value is None or len(value) == 0:
@@ -721,6 +769,12 @@ def _validate_opss_passphrase_arg(self, value):
721769
def get_opss_wallet_key(self):
722770
return self.OPSS_WALLET_SWITCH
723771

772+
def get_opss_wallet_env(self):
773+
return self.OPSS_WALLET_ENV_SWITCH
774+
775+
def get_opss_wallet_file(self):
776+
return self.OPSS_WALLET__SWITCH
777+
724778
def is_opss_wallet_key(self, key):
725779
return self.OPSS_WALLET_SWITCH == key
726780

@@ -885,12 +939,45 @@ def _validate_rcu_schema_pass_arg(self, value):
885939
raise ex
886940
return
887941

942+
def _get_env_var_value(self, env_var):
943+
_method_name = '_get_env_var_value'
944+
value = System.getenv(env_var)
945+
if not value:
946+
ex = exception_helper.create_cla_exception('WLSDPLY-01649', env_var)
947+
ex.setExitCode(self.ARG_VALIDATION_ERROR_EXIT_CODE)
948+
self._logger.throwing(ex, class_name=self._class_name, method_name=_method_name)
949+
raise ex
950+
return value
951+
952+
def _get_from_file_value(self, file_var):
953+
_method_name = '_get_from_file_value'
954+
ifile = None
955+
try:
956+
stream = JFileUtils.getFileAsStream(file_var)
957+
ifile = BufferedReader(InputStreamReader(stream))
958+
value = ifile.readLine()
959+
ifile.close()
960+
return value
961+
except IOException:
962+
if ifile:
963+
ifile.close()
964+
ex = exception_helper.create_cla_exception('WLSDPLY-01651', file_var)
965+
ex.setExitCode(self.ARG_VALIDATION_ERROR_EXIT_CODE)
966+
self._logger.throwing(ex, class_name=self._class_name, method_name=_method_name)
967+
raise ex
968+
888969
def get_passphrase_switch(self):
889970
return self.PASSPHRASE_SWITCH
890971

891972
def is_passphrase_switch(self, key):
892973
return self.PASSPHRASE_SWITCH == key
893974

975+
def is_passphrase_env_switch(self, key):
976+
return self.PASSPHRASE_ENV_SWITCH == key
977+
978+
def is_passphrase_file_switch(self, key):
979+
return self.PASSPHRASE_FILE_SWITCH == key
980+
894981
def _validate_passphrase_arg(self, value):
895982
method_name = '_validate_passphrase_switch'
896983

‎core/src/main/resources/oracle/weblogic/deploy/messages/wlsdeploy_rb.properties

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -290,6 +290,8 @@ WLSDPLY-01645=Target configuration file {0} validation_method must be either str
290290
WLSDPLY-01646=Supplied OPSS wallet directory {0} was not valid: {1}
291291
WLSDPLY-01647=Supplied output directory {0} was not valid: {1}
292292
WLSDPLY-01648=Target configuration file {0} has invalid value {1} for {2}. Valid values are: {3}
293+
WLSDPLY-01649=Environment variable {0} for password was not found
294+
WLSDPLY-01651=Variable file {0} was not found or unable to be read
293295

294296
# wlsdeploy/util/cla_helper.py
295297
WLSDPLY-01650=Saving the model to file {0}

‎installer/src/main/bin/createDomain.cmd

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,10 @@ ECHO [-java_home ^<java_home^>]
7979
ECHO [-archive_file ^<archive_file^>]
8080
ECHO [-model_file ^<model_file^>]
8181
ECHO [-variable_file ^<variable_file^>]
82+
ECHO [-passphrase_env ^<passphrase_env^>]
83+
ECHO [-passphrase_file ^<passphrase_file^>]
84+
ECHO [-opss_wallet_passphrase_env ^<opss_wallet_passphrase_env^>]
85+
ECHO [-opss_wallet_passphrase_file ^<opss_wallet_passphrase_file^>]
8286
ECHO [-wlst_path ^<wlst_path^>]
8387
ECHO [-rcu_db ^<rcu_database^>
8488
ECHO -rcu_prefix ^<rcu_prefix^>
@@ -120,6 +124,18 @@ ECHO variable_file - the location of the property file containing the
120124
ECHO the model. This can also be specified as a comma-separated list of property files,
121125
ECHO where each successive set of properties layers on top of the previous ones.
122126
ECHO.
127+
ECHO passphrase_env - An alternative to entering the encryption passphrase at a prompt. The value is an
128+
ECHO ENVIRONMENT VARIABLE name that WDT will use to retrieve the passphrase.
129+
ECHO.
130+
ECHO passphrase_file - An alternative to entering the encryption passphrase at a prompt. The value is a
131+
ECHO the name of a file with a string value which WDT will read to retrieve the passphrase.
132+
ECHO.
133+
ECHO opss_wallet_passphrase_env - An alternative to entering the OPSS wallet passphrase at a prompt. The value is a
134+
ECHO ENVIRONMENT VARIABLE name that WDT will use to retrieve the passphrase.
135+
ECHO.
136+
ECHO opss_wallet_passphrase_file - An alternative to entering the OPSS wallet passphrase at a prompt. The value is a
137+
ECHO the name of a file with a string value which WDT will read to retrieve the passphrase.
138+
ECHO.
123139
ECHO wlst_path - the Oracle Home subdirectory of the wlst.cmd
124140
ECHO script to use (e.g., ^<ORACLE_HOME^>\soa).
125141
ECHO.

‎installer/src/main/bin/createDomain.sh

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,10 @@ usage() {
4040
echo " [-archive_file <archive_file>]"
4141
echo " [-model_file <model_file>]"
4242
echo " [-variable_file <variable_file>]"
43+
echo " [-opss_wallet_passphrase_env <opss_wallet_passphrase_env>]"
44+
echo " [-opss_wallet_passphrase_file <opss_wallet_passphrase_file>]"
45+
echo " [-passphrase_env <passphrase_env>]"
46+
echo " [-passphrase_file <passphrase_file>]"
4347
echo " [-wlst_path <wlst_path>]"
4448
echo " [-rcu_db <rcu_database>"
4549
echo " -rcu_prefix <rcu_prefix>"
@@ -81,6 +85,18 @@ usage() {
8185
echo " the model. This can also be specified as a comma-separated list of property files,"
8286
echo " where each successive set of properties layers on top of the previous ones."
8387
echo ""
88+
echo " passphrase_env - An alternative to entering the encryption passphrase at a prompt. The value is an "
89+
echo " ENVIRONMENT VARIABLE name that WDT will use to retrieve the passphrase. "
90+
echo ""
91+
echo " passphrase_file - An alternative to entering the encryption passphrase at a prompt. The value is a "
92+
echo " the name of a file with a string value which WDT will read to retrieve the passphrase "
93+
echo ""
94+
echo " opss_wallet_passphrase_file - An alternative to entering the OPSS wallet passphrase at a prompt. The value is a "
95+
echo " the name of a file with a string value which WDT will read to retrieve the passphrase "
96+
echo ""
97+
echo " opss_wallet_passphrase_env - An alternative to entering the OPSS wallet passphrase at a prompt. The value "
98+
echo " ENVIRONMENT VARIABLE name that WDT will use to retrieve the passphrase. "
99+
echo ""
84100
echo " wlst_path - the Oracle Home subdirectory of the wlst.cmd"
85101
echo " script to use (e.g., <ORACLE_HOME>/soa)."
86102
echo ""

0 commit comments

Comments
 (0)