Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/*
* JBoss, Home of Professional Open Source
* Copyright 2017 Red Hat, Inc., and individual contributors
* as indicated by the @author tags.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.wildfly.security.tool;
import static org.jboss.logging.annotations.Message.NONE;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.security.InvalidParameterException;
import java.security.NoSuchAlgorithmException;
import org.apache.commons.cli.MissingArgumentException;
import org.apache.commons.cli.MissingOptionException;
import org.jboss.logging.BasicLogger;
import org.jboss.logging.Logger;
import org.jboss.logging.annotations.Cause;
import org.jboss.logging.annotations.Message;
import org.jboss.logging.annotations.MessageLogger;
/**
* Messages for Elytron tool.
*
* @author Peter Skopek
*/
@MessageLogger(projectCode = "ELYTOOL", length = 5)
public interface ElytronToolMessages extends BasicLogger {
ElytronToolMessages msg = Logger.getMessageLogger(ElytronToolMessages.class, "org.wildfly.security.tool");
// General messages
@Message(id = NONE, value = "Command or alias \"%s\" not found.")
String commandOrAliasNotFound(String command);
@Message(id = NONE, value = "Input data not confirmed. Exiting.")
String inputDataNotConfirmed();
@Message(id = NONE, value = "%s %s")
String cmdHelp(String toolCommand, String commandName);
@Message(id = NONE, value = "Exception encountered executing the command:")
String commandExecuteException();
// CredentialStore command parameters descriptions
@Message(id = NONE, value = "Printing general help message:")
String generalHelpTitle();
@Message(id = NONE, value = "Location of credential store storage file")
String cmdLineStoreLocationDesc();
@Message(id = NONE, value = "\"credential-store\" command is used to perform various operations on credential store.")
String cmdLineCredentialStoreHelpHeader();
@Message(id = NONE, value = "Implementation properties for credential store type in form of \"prop1=value1; ... ;propN=valueN\" .%n" +
"Supported properties are dependent on credential store type%n" +
"KeyStoreCredentialStore (default implementation) supports following additional properties (all are optional):%n" +
"keyStoreType - specifies the key store type to use (defaults to \"JCEKS\")%n" +
"keyAlias - specifies the secret key alias within the key store to use for encrypt/decrypt of data in external storage (defaults to \"cs_key\")%n" +
"external - specifies whether to store data to external storage and encrypted by keyAlias key (defaults to \"false\")%n" +
"cryptoAlg - cryptographic algorithm name to be used to encrypt/decrypt entries at external storage \"external\" has to be set to \"true\"")
String cmdLineImplementationPropertiesDesc();
@Message(id = NONE, value = "Password for credential store")
String cmdLineCredentialStorePassword();
@Message(id = NONE, value = "Password for KeyStore. Can also be provided by console prompt.")
String cmdLineKeyStorePassword();
@Message(id = NONE, value = "Name of an environment variable from which to resolve the KeyStore password.")
String cmdLineKeyStorePasswordEnv();
@Message(id = NONE, value = "Salt to apply for final masked password of the credential store")
String cmdLineSaltDesc();
@Message(id = NONE, value = "Iteration count for final masked password of the credential store")
String cmdLineIterationCountDesc();
@Message(id = NONE, value = "Password credential value")
String cmdLinePasswordCredentialValueDesc();
@Message(id = NONE, value = "The alias of the existing password entry to encrypt")
String cmdLineEntryDesc();
@Message(id = NONE, value = "Type of entry in credential store")
String cmdLineEntryTypeDesc();
@Message(id = NONE, value = "Comma separated list of JCA provider names. Providers will be supplied to the credential store instance.%n" +
"Each provider must be installed through java.security file or through service loader from properly packaged jar file on classpath.")
String cmdLineOtherProvidersDesc();
@Message(id = NONE, value = "Provider name containing CredentialStoreSpi implementation.%n" +
"Provider must be installed through java.security file or through service loader from properly packaged jar file on classpath.")
String cmdLineCustomCredentialStoreProviderDesc();
@Message(id = NONE, value = "* Create credential store")
String cmdLineCreateCredentialStoreDesc();
@Message(id = NONE, value = "Credential store type")
String cmdLineCredentialStoreTypeDesc();
@Message(id = NONE, value = "* Add new alias to the credential store")
String cmdLineAddAliasDesc();
@Message(id = NONE, value = "* Remove alias from the credential store")
String cmdLineRemoveAliasDesc();
@Message(id = NONE, value = "* Check if alias exists within the credential store")
String cmdLineCheckAliasDesc();
@Message(id = NONE, value = "* Display all aliases")
String cmdLineAliasesDesc();
@Message(id = NONE, value = "* Display all types of stored credentials for given alias")
String cmdLineAliasTypes();
@Message(id = NONE, value = "Generate private and public key pair and store them as a KeyPairCredential")
String cmdLineGenerateKeyPairDesc();
@Message(id = NONE, value = "Size (number of bytes) of the keys when generating a KeyPairCredential.")
String cmdLineKeySizeDesc();
@Message(id = NONE, value = "Encryption algorithm to be used when generating a KeyPairCredential: RSA, DSA, or EC. Default RSA")
String cmdLineKeyAlgorithmDesc();
@Message(id = NONE, value = "Prints the public key stored under a KeyPairCredential as Base64 encoded String, in OpenSSH format.")
String cmdLineExportPublicKeyDesc();
@Message(id = NONE, value = "Import a KeyPairCredential into the credential store.")
String cmdLineImportKeyPairDesc();
@Message(id = NONE, value = "The location of a file containing a private key.")
String cmdLinePrivateKeyLocationDesc();
@Message(id = NONE, value = "The location of a file containing a public key.")
String cmdLinePublicKeyLocationDesc();
@Message(id = NONE, value = "The passphrase used to decrypt the private key.")
String cmdLineKeyPassphraseDesc();
@Message(id = NONE, value = "A private key specified as a String.")
String cmdLinePrivateKeyStringDesc();
@Message(id = NONE, value = "A public key specified as a String.")
String cmdLinePublicKeyStringDesc();
@Message(id = NONE, value = "Print summary, especially command how to create this credential store")
String cmdLinePrintSummary();
@Message(id = NONE, value = "* Get help with usage of this command")
String cmdLineHelp();
@Message(id = NONE, value = "Alias \"%s\" exists")
String aliasExists(String alias);
@Message(id = NONE, value = "Alias \"%s\" does not exist")
String aliasDoesNotExist(String alias);
@Message(id = NONE, value = "Alias \"%s\" of type \"%s\" does not exist")
String aliasDoesNotExist(String alias, String type);
@Message(id = NONE, value = "Alias \"%s\" has been successfully stored")
String aliasStored(String alias);
@Message(id = NONE, value = "Alias \"%s\" of type \"%s\" has been successfully stored")
String aliasStored(String alias, String type);
@Message(id = NONE, value = "Alias \"%s\" has been successfully removed")
String aliasRemoved(String alias);
@Message(id = NONE, value = "Alias \"%s\" of type \"%s\" has been successfully removed")
String aliasRemoved(String alias, String type);
@Message(id = NONE, value = "Credential store command summary:%n--------------------------------------%n%s")
String commandSummary(String command);
@Message(id = NONE, value = "Credential store contains following aliases: %s")
String aliases(String aliases);
@Message(id = NONE, value = "Credential store contains no aliases")
String noAliases();
@Message(id = NONE, value = "Action to perform on the credential store is not defined")
Exception actionToPerformNotDefined();
@Message(id = NONE, value = "Credential store password: ")
String credentialStorePasswordPrompt();
@Message(id = NONE, value = "Confirm credential store password: ")
String credentialStorePasswordPromptConfirm();
@Message(id = NONE, value = "Passphrase to be used to decrypt private key (can be nothing if no passphrase was used to encrypt the key): ")
String keyPassphrasePrompt();
@Message(id = NONE, value = "Confirm passphrase to be used to decrypt private key (can be nothing if no passphrase was used to encrypt the key): ")
String keyPassphrasePromptConfirm();
@Message(id = NONE, value = "Secret to store: ")
String secretToStorePrompt();
@Message(id = NONE, value = "Confirm secret to store: ")
String secretToStorePromptConfirm();
@Message(id = NONE, value = "The retrieved PasswordCredential does not contain a ClearTextPassword")
String passwordCredentialNotClearText();
// mask command
@Message(id = NONE, value = "\"mask\" command is used to get MASK- string encrypted using PBEWithMD5AndDES in PicketBox compatible way.")
String cmdMaskHelpHeader();
@Message(id = NONE, value = "Salt to apply to masked string")
String cmdMaskSaltDesc();
@Message(id = NONE, value = "Iteration count for masked string")
String cmdMaskIterationCountDesc();
@Message(id = NONE, value = "Secret to be encrypted")
String cmdMaskSecretDesc();
@Message(id = 6, value = "Salt not specified.")
MissingArgumentException saltNotSpecified();
@Message(id = 7, value = "Invalid \"%s\" value. Must be an integer between %d and %d, inclusive")
IllegalArgumentException invalidParameterMustBeIntBetween(String parameter, int min, int max);
@Message(id = NONE, value = "Secret not specified.")
MissingArgumentException secretNotSpecified();
// vault command
@Message(id = NONE, value = "\"vault\" command is used convert PicketBox Security Vault to credential store using default implementation (KeyStoreCredentialStore)" +
" or custom implementation set with the \"type\" option.")
String cmdVaultHelpHeader();
@Message(id = NONE, value = "Vault keystore URL (defaults to \"vault.keystore\")")
String cmdLineVaultKeyStoreURL();
@Message(id = NONE, value = "Vault keystore password:%n" +
"- used to open original vault key store%n" +
"- used as password for new converted credential store")
String cmdLineVaultKeyStorePassword();
@Message(id = NONE, value = "Vault directory containing encrypted files (defaults to \"vault\")")
String cmdLineVaultEncryptionDirectory();
@Message(id = NONE, value = "8 character salt (defaults to \"12345678\")")
String cmdVaultLineSalt();
@Message(id = NONE, value = "Iteration count (defaults to \"23\")")
String cmdLineVaultIterationCount();
@Message(id = NONE, value = "Vault key alias within key store (defaults to \"vault\")")
String cmdLineVaultKeyStoreAlias();
@Message(id = NONE, value = "Configuration parameters for credential store in form of: \"parameter1=value1; ... ;parameterN=valueN\"%n" +
"Supported parameters are dependent on credential store type%n" +
"Generally supported parameters for default credential store implementation (all are optional):%n" +
"create - automatically creates credential store file (true/false)%n" +
"modifiable - is the credential modifiable (true/false)%n" +
"location - file location of credential store%n" +
"keyStoreType - specify the key store type to use")
String cmdLineVaultCSParametersDesc();
@Message(id = NONE, value = "Vault Conversion summary:%n--------------------------------------%n%s%n--------------------------------------%n")
String vaultConversionSummary(String command);
@Message(id = NONE, value = "Vault Conversion Successful%n")
String conversionSuccessful();
@Message(id = NONE, value = "CLI command to add new credential store:%n")
String cliCommandToNewCredentialStore();
@Message(id = NONE, value = "* Bulk conversion with options listed in description file. All options have no default value and should be set in the file.%n" +
"All options are required with the exceptions:%n" +
" - \"properties\" option%n - \"type\" option (defaults to \"KeyStoreCredentialStore\")%n - \"credential-store-provider\" option%n - \"other-providers\" option%n" +
" - \"salt\" and \"iteration\" options can be omitted when plain-text password is used%n" +
"Each set of options must start with the \"keystore\" option in the following format:%n " +
"keystore:%nkeystore-password:%nenc-dir:%nsalt:%niteration:%nlocation:%n" +
"alias:%nproperties:=; ... ;=%ntype:%n" +
"credential-store-provider:%nother-providers:")
String cliCommandBulkVaultCredentialStoreConversion();
@Message(id = NONE, value = "Print summary of conversion")
String cmdLineVaultPrintSummary();
@Message(id = NONE, value = "Converted credential store type (defaults to \"KeyStoreCredentialStore\")")
String cmdLineVaultCSTypeDesc();
@Message(id = NONE, value = "Location of credential store storage file (defaults to \"converted-vault.cr-store\" in vault encryption directory)")
String cmdLineVaultCSLocationDesc();
@Message(id = 8, value = "Cannot locate admin key with alias \"%s\" or it is of improper type")
RuntimeException cannotLocateAdminKey(String alias);
@Message(id = 9, value = "Cannot parse credential store implementation properties from supplied parameter")
RuntimeException cannotParseProps();
@Message(id = NONE, value = "Vault (enc-dir=\"%s\";keystore=\"%s\") converted to credential store \"%s\"")
String vaultConvertedToCS(String vaultDir, String keyStore, String credentialStoreStorage);
@Message(id = 10, value = "Cannot parse conversion descriptor file \"%s\" missing colon at line %s")
IOException descriptorParseMissingColon(String file, String line);
@Message(id = 11, value = "Unrecognized descriptor attribute at line %s")
IOException unrecognizedDescriptorAttribute(String line);
@Message(id = 12, value = "Problem converting vault (enc-dir=\"%s\";keystore=\"%s\")")
Exception bulkConversionProblem(String vaultDir, String keyStore, @Cause Throwable cause);
@Message(id = 13, value = "Invalid option \"%s\" when performing bulk conversion. Use bulk conversion descriptor file.")
Exception bulkConversionInvalidOption(String option);
@Message(id = 14, value = "Unknown entry-type \"%s\"")
IllegalArgumentException unknownEntryType(String entryType);
@Message(id = 15, value = "Unknown provider \"%s\"")
IllegalArgumentException unknownProvider(String provider);
@Message(id = NONE, value = "Credential Store has been successfully created")
String credentialStoreCreated();
@Message(id = 16, value = "Option \"%s\" is not specified.")
MissingArgumentException optionNotSpecified(String option);
@Message(id = 17, value = "Option \"%s\" specified more than once. Only the first occurrence will be used.")
String duplicateOptionSpecified(String option);
@Message(id = 18, value = "Option \"%s\" does not expect any arguments.")
MissingArgumentException noArgumentOption(String option);
@Message(id = NONE, value = "Vault password: ")
String vaultPasswordPrompt();
@Message(id = 19, value = "Encryption directory \"%s\" does not contain \"VAULT.dat\" file.")
IllegalArgumentException vaultFileNotFound(String path);
@Message(id = NONE, value = "Mask secret: ")
String maskSecretPrompt();
@Message(id = NONE, value = "Confirm mask secret: ")
String maskSecretPromptConfirm();
@Message(id = NONE, value = "Print stack trace when error occurs.")
String cmdLineDebug();
@Message(id = NONE, value = "Exception encountered executing the command. Use option \"--debug\" for complete exception stack trace.")
String commandExecuteExceptionNoDebug();
@Message(id = 20, value = "Alias was not defined.")
MissingArgumentException undefinedAlias();
@Message(id = 21, value = "Location of the output file was not defined.")
MissingArgumentException undefinedOutputLocation();
@Message(id = 22, value = "Encryption directory was not defined.")
MissingArgumentException undefinedEncryptionDirectory();
@Message(id = 23, value = "Vault password was not defined")
MissingArgumentException undefinedVaultPassword();
@Message(id = 24, value = "Cannot parse conversion descriptor file \"%s\". No keystore specified.")
IOException undefinedKeystore(String file);
@Message(id = 25, value = "Credential store storage file \"%s\" does not exist.")
IllegalArgumentException storageFileDoesNotExist(String location);
@Message(id = 26, value = "Credential store storage file \"%s\" already exists.")
IllegalArgumentException storageFileExists(String location);
@Message(id = 27, value = "Wrong masked password format. Expected format is \"MASK-;;\"")
IllegalArgumentException wrongMaskedPasswordFormat();
@Message(id = 28, value = "Location parameter is not specified for filebased keystore type '%s'")
MissingArgumentException filebasedKeystoreLocationMissing(String type);
@Message(id = 29, value = "Key Pair Algorithm: '%s' is not supported.")
NoSuchAlgorithmException unknownKeyPairAlgorithm(String algorithm);
@Message(id = 30, value = "Key file '%s' does not exist.")
IllegalArgumentException keyFileDoesNotExist(String location);
@Message(id = 31, value = "No private key specified for importing.")
MissingArgumentException noPrivateKeySpecified();
@Message(id = 32, value = "No public key specified for importing.")
MissingArgumentException noPublicKeySpecified();
@Message(id = 33, value = "No PEM content found")
MissingArgumentException xmlNoPemContent();
@Message(id = 34, value = "Invalid keysize provided: %s")
InvalidParameterException invalidKeySize(String reason);
@Message(id = NONE, value = "In the message below, option '%s' refers to long option '%s'.")
String longOptionDescription(String option, String longOption);
// filesystem-realm command
@Message(id = NONE, value = "\"filesystem-realm\" command is used to convert legacy properties files and scripts to an Elytron FileSystemRealm.")
String cmdFileSystemRealmHelpHeader();
@Message(id = NONE, value = "The relative or absolute path to the users file.")
String cmdFileSystemRealmUsersFileDesc();
@Message(id = NONE, value = "The relative or absolute path to the credential store file that contains the secret key.")
String cmdFileSystemEncryptCredentialStoreDesc();
@Message(id = NONE, value = "The alias of the secret key stored in the credential store file. Set to key by default")
String cmdFileSystemEncryptSecretKeyDesc();
@Message(id = NONE, value = "Whether or not the credential store should be populated with a Secret Key. Set to true by default.")
String cmdFileSystemRealmEncryptPopulateDesc();
@Message(id = NONE, value = "Whether or not the credential store should be dynamically created if it doesn't exist. Set to true by default.")
String cmdFileSystemEncryptCreateCredentialStoreDesc();
@Message(id = NONE, value = "The relative or absolute path to the KeyStore file that contains the key pair. Only %n" +
"applicable if the filesystem realm has integrity verification enabled.")
String cmdFileSystemEncryptKeyStoreDesc();
@Message(id = NONE, value = "The type of KeyStore to be used. Optional, only applicable if the filesystem %n" +
"realm has integrity verification enabled.")
String cmdFileSystemEncryptKeyStoreTypeDesc();
@Message(id = NONE, value = "The alias of the key pair to be used, within the KeyStore. Set to integrity-key by default, only %n" +
"applicable if the filesystem realm has integrity verification enabled.")
String cmdFileSystemEncryptKeyPairAliasDesc();
@Message(id = NONE, value = "Password for KeyStore. Can also be provided by console prompt. Only applicable if %n" +
"the filesystem realm has integrity verification enabled.")
String cmdFileSystemEncryptKeyStorePassword();
@Message(id = NONE, value = "Name of an environment variable from which to resolve the KeyStore password. Only %n" +
"applicable if the filesystem realm has integrity verification enabled.")
String cmdFileSystemEncryptKeyStorePasswordEnv();
@Message(id = NONE, value = "Input Realm location not specified.")
MissingArgumentException inputLocationNotSpecified();
@Message(id = NONE, value = "Input Realm location directory does not exist.")
MissingArgumentException inputLocationDoesNotExist();
@Message(id = NONE, value = "Output Realm location not specified.")
MissingArgumentException outputLocationNotSpecified();
@Message(id = NONE, value = "Credential Store location not specified.")
MissingArgumentException credentialStoreDoesNotExist();
@Message(id = NONE, value = "A required parameter is not specified.")
String fileSystemEncryptRequiredParametersNotSpecified();
@Message(id = NONE, value = "The hash encoding to be used in the filesystem realm. Set to BASE64 by default.")
String cmdFileSystemEncryptHashEncodingDesc();
@Message(id = NONE, value = "If the original realm has encoded set to true. Set to true by default.")
String cmdFileSystemEncryptEncodedDesc();
@Message(id = NONE, value = "The levels to be used in the filesystem realm. Set to 2 by default.")
String cmdFileSystemEncryptLevelsDesc();
@Message(id = NONE, value = "The absolute or relative location of the original filesystem realm.")
String cmdFileSystemEncryptInputLocationDesc();
@Message(id = NONE, value = "The directory where the new filesystem realm resides.")
String cmdFileSystemEncryptOutputLocationDesc();
@Message(id = NONE, value = "The name of the new filesystem-realm.")
String cmdFileSystemEncryptNewRealmDesc();
@Message(id = NONE, value = "The relative or absolute path to the roles file.")
String cmdFileSystemRealmRolesFileDesc();
@Message(id = NONE, value = "The relative or absolute path to the output directory.")
String cmdFileSystemRealmOutputLocationDesc();
@Message(id = NONE, value = "Name of the filesystem-realm to be configured.")
String cmdFileSystemRealmFileSystemRealmNameDesc();
@Message(id = NONE, value = "Name of the security-domain to be configured.")
String cmdFileSystemRealmSecurityDomainNameDesc();
@Message(id = NONE, value = "* Bulk conversion with options listed in description file. Optional options have default values, required options do not.%n" +
"The options fileSystemRealmName and securityDomainName are optional. %n" +
"These optional options have default values of: converted-properties-filesystem-realm and converted-properties-security-domain. %n" +
"Values are required for the following options: users-file, roles-file, and output-location. %n" +
"If one or more these required values are not set, the corresponding block is skipped. %n" +
"Each option must be specified in the following format: