fix: Improve interactive prompts (fixes #213)

fortify · Jan 3, 2023 · ad15067 · ad15067
1 parent c0af9f9
commit ad15067
Show file tree

Hide file tree

Showing 3 changed files with 30 additions and 26 deletions.
diff --git a/fcli-sc-dast/src/main/resources/com/fortify/cli/sc_dast/i18n/SCDastMessages.properties b/fcli-sc-dast/src/main/resources/com/fortify/cli/sc_dast/i18n/SCDastMessages.properties
@@ -7,19 +7,19 @@ search-text = The text to filter results by
 # fcli sc-dast session
 fcli.sc-dast.session.usage.header = Login, logout and manage ScanCentral DAST sessions
 # Shared login options
-ssc-user = SSC user name. Environment variables:%n ${fcli.env.default.prefix}_SSC_USER: Shared with SSC/SC SAST%n ${fcli.env.default.prefix}_SC_DAST_SSC_USER: Only SC DAST commands
-ssc-password = SSC password. Environment variables:%n ${fcli.env.default.prefix}_SSC_PASSWORD: Shared with SSC/SC SAST%n ${fcli.env.default.prefix}_SC_DAST_SSC_PASSWORD: Only SC DAST commands
-ssc-ci-token = SSC CIToken in either encoded or decoded. Environment variables:%n ${fcli.env.default.prefix}_SSC_CI_TOKEN: Shared with SSC/SC SAST%n ${fcli.env.default.prefix}_SC_DAST_SSC_CI_TOKEN: Only SC DAST commands
-proxy-host = Hostname or IP address of the proxy server. Environment variables:%n ${fcli.env.default.prefix}_PROXY_HOST: Shared across all modules%n ${fcli.env.default.prefix}_SC_DAST_PROXY_HOST: Only SC DAST commands
-proxy-port = Proxy server port number. Environment variables:%n ${fcli.env.default.prefix}_PROXY_PORT: Shared across all modules%n ${fcli.env.default.prefix}_SC_DAST_PROXY_PORT: Only SC DAST commands
-proxy-user = Proxy server user. Environment variables:%n ${fcli.env.default.prefix}_PROXY_USER: Shared across all modules%n ${fcli.env.default.prefix}_SC_DAST_PROXY_USER: Only SC DAST commands
-proxy-password = Proxy server password. Environment variables:%n ${fcli.env.default.prefix}_PROXY_PASSWORD: Shared across all modules%n ${fcli.env.default.prefix}_SC_DAST_PROXY_PASSWORD: Only SC DAST commands
+ssc-user.0 = SSC user name
+ssc-user.1 = Environment variables:%n ${fcli.env.default.prefix}_SSC_USER: Shared with SSC/SC SAST%n ${fcli.env.default.prefix}_SC_DAST_SSC_USER: Only SC DAST commands
+ssc-password.0 = SSC password
+ssc-password.1 = Environment variables:%n ${fcli.env.default.prefix}_SSC_PASSWORD: Shared with SSC/SC SAST%n ${fcli.env.default.prefix}_SC_DAST_SSC_PASSWORD: Only SC DAST commands
+ssc-ci-token.0 = SSC CIToken in either encoded or decoded format
+ssc-ci-token.1 = Environment variables:%n ${fcli.env.default.prefix}_SSC_CI_TOKEN: Shared with SSC/SC SAST%n ${fcli.env.default.prefix}_SC_DAST_SSC_CI_TOKEN: Only SC DAST commands
 
 # fcli sc-dast session login
 fcli.sc-dast.session.login.usage.header = Create a session for interacting with ScanCentral DAST
 fcli.sc-dast.session.login.usage.description = For interactive use, you may choose to keep the session open until it expires.%n%nFor CI/CD integrations and other automations:%nYou should always issue a logout command once work is complete.%nOn shared/non-containerized systems, consider setting FORTIFY_HOME or FCLI_HOME variables to prevent unexpected interactions between different pipelines.%nOption values are commonly configured through environment variables as listed in each option description. For more information, see https://fortify-ps.github.io/fcli/#environment-variables.
 fcli.sc-dast.session.login.expire-in = Specify for how long the session should remain active, for example 1d (1 day), 2M (2 months), 1y (1 year)
-fcli.sc-dast.session.login.ssc-url = SSC URL. Environment variables:%n ${fcli.env.default.prefix}_SSC_URL: Shared with SSC/SC SAST%n ${fcli.env.default.prefix}_SC_DAST_SSC_URL: Only SC DAST commands
+fcli.sc-dast.session.login.ssc-url.0 = SSC URL
+fcli.sc-dast.session.login.ssc-url.1 = Environment variables:%n ${fcli.env.default.prefix}_SSC_URL: Shared with SSC/SC SAST%n ${fcli.env.default.prefix}_SC_DAST_SSC_URL: Only SC DAST commands
 
 # fcli sc-dast session logout
 fcli.sc-dast.session.logout.usage.header = Terminate ScanCentral DAST session

diff --git a/fcli-sc-sast/src/main/resources/com/fortify/cli/sc_sast/i18n/SCSastMessages.properties b/fcli-sc-sast/src/main/resources/com/fortify/cli/sc_sast/i18n/SCSastMessages.properties
@@ -7,20 +7,21 @@ ApplicationVersionMixin = Application version id or <application>:<version> name
 # fcli sc-sast session
 fcli.sc-sast.session.usage.header = Login, logout and manage Fortify ScanCentral SAST sessions
 # Shared login options
-ssc-user = SSC user name. Environment variables:%n ${fcli.env.default.prefix}_SSC_USER: Shared with SSC/SC DAST%n ${fcli.env.default.prefix}_SC_SAST_SSC_USER: Only SC SAST commands
-ssc-password = SSC password. Environment variables:%n ${fcli.env.default.prefix}_SSC_PASSWORD: Shared with SSC/SC DAST%n ${fcli.env.default.prefix}_SC_SAST_SSC_PASSWORD: Only SC SAST commands
-ssc-ci-token = SSC CIToken. Environment variables:%n ${fcli.env.default.prefix}_SSC_CI_TOKEN: Shared with SSC/SC DAST%n ${fcli.env.default.prefix}_SC_SAST_SSC_CI_TOKEN: Only SC SAST commands
-client-auth-token = ScanCentral SAST client_auth_token. Environment variables:%n ${fcli.env.default.prefix}_SC_SAST_CLIENT_AUTH_TOKEN
-proxy-host = Hostname or IP address of the proxy server. Environment variables:%n ${fcli.env.default.prefix}_PROXY_HOST: Shared across all modules%n ${fcli.env.default.prefix}_SC_SAST_PROXY_HOST: Only SC SAST commands
-proxy-port = Proxy server port number. Environment variables:%n ${fcli.env.default.prefix}_PROXY_PORT: Shared across all modules%n ${fcli.env.default.prefix}_SC_SAST_PROXY_PORT: Only SC SAST commands
-proxy-user = Proxy server user. Environment variables:%n ${fcli.env.default.prefix}_PROXY_USER: Shared across all modules%n ${fcli.env.default.prefix}_SC_SAST_PROXY_USER: Only SC SAST commands
-proxy-password = Proxy server password. Environment variables:%n ${fcli.env.default.prefix}_PROXY_PASSWORD: Shared across all modules%n ${fcli.env.default.prefix}_SC_SAST_PROXY_PASSWORD: Only SC SAST commands
+ssc-user.0 = SSC user name
+ssc-user.1 = Environment variables:%n ${fcli.env.default.prefix}_SSC_USER: Shared with SSC/SC DAST%n ${fcli.env.default.prefix}_SC_SAST_SSC_USER: Only SC SAST commands
+ssc-password.0 = SSC password
+ssc-password.1 = Environment variables:%n ${fcli.env.default.prefix}_SSC_PASSWORD: Shared with SSC/SC DAST%n ${fcli.env.default.prefix}_SC_SAST_SSC_PASSWORD: Only SC SAST commands
+ssc-ci-token.0 = SSC CIToken in either encoded or decoded format
+ssc-ci-token.1 = Environment variables:%n ${fcli.env.default.prefix}_SSC_CI_TOKEN: Shared with SSC/SC DAST%n ${fcli.env.default.prefix}_SC_SAST_SSC_CI_TOKEN: Only SC SAST commands
+client-auth-token.0 = ScanCentral SAST client_auth_token
+client-auth-token.1 = Environment variables:%n ${fcli.env.default.prefix}_SC_SAST_CLIENT_AUTH_TOKEN
 
 # fcli sc-sast session login
 fcli.sc-sast.session.login.usage.header = Create a session for interacting with Fortify ScanCentral SAST
 fcli.sc-sast.session.login.usage.description = For interactive use, you may choose to keep the session open until it expires.%n%nFor CI/CD integrations and other automations:%nYou should always issue a logout command once work is complete.%nOn shared/non-containerized systems, consider setting FORTIFY_HOME or FCLI_HOME variables to prevent unexpected interactions between different pipelines.%nOption values are commonly configured through environment variables as listed in each option description. For more information, see https://fortify-ps.github.io/fcli/#environment-variables.
 fcli.sc-sast.session.login.expire-in = Specify for how long the session should remain active, for example 1h (1 hour) or 1d (1 day)
-fcli.sc-sast.session.login.ssc-url = SSC URL. Environment variables:%n ${fcli.env.default.prefix}_SSC_URL: Shared with SSC/SC DAST%n ${fcli.env.default.prefix}_SC_SAST_SSC_URL: Only SC SAST commands
+fcli.sc-sast.session.login.ssc-url.0 = SSC URL
+fcli.sc-sast.session.login.ssc-url.1 = Environment variables:%n ${fcli.env.default.prefix}_SSC_URL: Shared with SSC/SC DAST%n ${fcli.env.default.prefix}_SC_SAST_SSC_URL: Only SC SAST commands
 
 # fcli sc-sast session logout
 fcli.sc-sast.session.logout.usage.header = Terminate Fortify ScanCentral SAST session

diff --git a/fcli-ssc/src/main/resources/com/fortify/cli/ssc/i18n/SSCMessages.properties b/fcli-ssc/src/main/resources/com/fortify/cli/ssc/i18n/SSCMessages.properties
@@ -16,20 +16,23 @@ filterset = Filter set title or id
 # fcli ssc session
 fcli.ssc.session.usage.header = Login, logout and manage Fortify Software Security Center (SSC) sessions
 # Shared login options
-user = SSC user name. Environment variables:%n ${fcli.env.default.prefix}_SSC_USER: Shared with SC SAST/DAST%n ${fcli.env.default.prefix}_SSC_SESSION_USER: Only SSC session commands
-password = SSC password. Environment variables:%n ${fcli.env.default.prefix}_SSC_PASSWORD: Shared with SC SAST/DAST%n ${fcli.env.default.prefix}_SSC_SESSION_PASSWORD: Only SSC session commands
-ci-token = SSC CIToken. Note that most, but not all, fcli commands are available when logging in with a CIToken.%nEnvironment variables:%n ${fcli.env.default.prefix}_SSC_CI_TOKEN: Shared with SC SAST/DAST%n ${fcli.env.default.prefix}_SSC_SESSION_CI_TOKEN: Only SSC session commands
-proxy-host = Hostname or IP address of the proxy server. Environment variables:%n ${fcli.env.default.prefix}_PROXY_HOST: Shared across all modules%n ${fcli.env.default.prefix}_SSC_SESSION_PROXY_HOST: Only SSC session commands
-proxy-port = Proxy server port number. Environment variables:%n ${fcli.env.default.prefix}_PROXY_PORT: Shared across all modules%n ${fcli.env.default.prefix}_SSC_SESSION_PROXY_PORT: Only SSC session commands
-proxy-user = Proxy server user. Environment variables:%n ${fcli.env.default.prefix}_PROXY_USER: Shared across all modules%n ${fcli.env.default.prefix}_SSC_SESSION_PROXY_USER: Only SSC session commands
-proxy-password = Proxy server password. Environment variables:%n ${fcli.env.default.prefix}_PROXY_PASSWORD: Shared across all modules%n ${fcli.env.default.prefix}_SSC_SESSION_PROXY_PASSWORD: Only SSC session commands
+user.0 = SSC user name
+user.1 = Environment variables:%n ${fcli.env.default.prefix}_SSC_USER: Shared with SC SAST/DAST%n ${fcli.env.default.prefix}_SSC_SESSION_USER: Only SSC session commands
+password.0 = SSC password
+password.1 = Environment variables:%n ${fcli.env.default.prefix}_SSC_PASSWORD: Shared with SC SAST/DAST%n ${fcli.env.default.prefix}_SSC_SESSION_PASSWORD: Only SSC session commands
+ci-token.0 = SSC CIToken in either encoded or decoded format
+ci-token.1 = Note that most, but not all, fcli commands are available when logging in with a CIToken
+ci-token.2 = Environment variables:%n ${fcli.env.default.prefix}_SSC_CI_TOKEN: Shared with SC SAST/DAST%n ${fcli.env.default.prefix}_SSC_SESSION_CI_TOKEN: Only SSC session commands
 
 # fcli ssc session login
 fcli.ssc.session.login.usage.header = Create a session for interacting with Fortify SSC
 fcli.ssc.session.login.usage.description = For interactive use, you may choose to keep the session open until it expires.%n%nFor CI/CD integrations and other automations:%nYou should always issue a logout command once work is complete.%nOn shared/non-containerized systems, consider setting FORTIFY_HOME or FCLI_HOME variables to prevent unexpected interactions between different pipelines.%nOption values are commonly configured through environment variables as listed in each option description. For more information, see https://fortify-ps.github.io/fcli/#environment-variables.
 fcli.ssc.session.login.expire-in = Specify for how long the session should remain active, for example 1h (1 hour), 1d (1 day)
-fcli.ssc.session.login.url = SSC URL. Environment variables:%n ${fcli.env.default.prefix}_SSC_URL: Shared with SC SAST/DAST%n ${fcli.env.default.prefix}_SSC_SESSION_URL: Only SSC session commands 
-fcli.ssc.session.login.token = SSC Token. Depending on token permissions, not all fcli commands may be available.%nEnvironment variables:%n ${fcli.env.default.prefix}_SSC_TOKEN
+fcli.ssc.session.login.url.0 = SSC URL
+fcli.ssc.session.login.url.1 = Environment variables:%n ${fcli.env.default.prefix}_SSC_URL: Shared with SC SAST/DAST%n ${fcli.env.default.prefix}_SSC_SESSION_URL: Only SSC session commands 
+fcli.ssc.session.login.token.0 = SSC token in either encoded or decoded format
+fcli.ssc.session.login.token.1 = Note that depending on token permissions, not all fcli commands may be available
+fcli.ssc.session.login.token.2 = Environment variables:%n ${fcli.env.default.prefix}_SSC_TOKEN
 
 # fcli ssc session logout
 fcli.ssc.session.logout.usage.header = Terminate Fortify SSC session