Groupe de commandes KeyStoreCommands de l'objet AdminTask
Les langages de script Jython ou Jacl permettent de configurer des fichiers de clés à l'aide de l'outil wsadmin. Un fichier de clés est créé par le serveur d'applications lors de l'installation et peut contenir des clés cryptographiques ou des certificats. Les commandes et paramètres du groupe KeyStoreCommands peuvent être utilisés pour créer, supprimer et gérer des fichiers de clés.
changeKeyStorePassword
La commande changeKeyStorePassword modifie le mot de passe d'un fichier de clés. La commande enregistre automatiquement le nouveau mot de passe de la configuration.
Paramètres obligatoires
- -keyStoreName
- Specifies the name of the keystore that needs a password change. (Chaîne, obligatoire)
- -keyStorePassword
- Indique le nom du mot de passe à changer. (Chaîne, obligatoire)
- -newKeyStorePassword
- Définit le nouveau mot de passe à utiliser pour accéder au fichier de clés. (Chaîne, obligatoire)
- -newKeyStorePasswordVerify
- Indique le nouveau mot de passe pour confirmer le nouveau mot de passe du fichier de clés. (Chaîne, obligatoire)
Paramètres optionnels
- -scopeName
- Indique la portée du fichier de clés. (Chaîne, optionnelle)
Exemples
Syntaxe d'un exemple de mode différé :
- A l'aide de Jacl :
$AdminTask changeKeyStorePassword {-keystoreName myKeystore -keyStorePassword WebAS -newKeyStorePassword newpwd -newKeyStorePasswordVerify newpwd}
- Avec la chaîne Jython :
AdminTask.changeKeyStorePassword('[-keystoreName myKeystore -keyStorePassword WebAS -newKeyStorePassword newpwd -newKeyStorePasswordVerify newpwd]')
- A l'aide de la liste Jython :
AdminTask.changeKeyStorePassword(['-keystoreName', 'myKeystore', '-keyStorePassword', 'WebAS', '-newKeyStorePassword', 'newpwd', '-newKeyStorePasswordVerify', 'newpwd'])
Exemple d'utilisation en mode interactif :
- A l'aide de Jacl :
$AdminTask changeKeyStorePassword {-interactive}
- En langage Jython :
AdminTask.changeKeyStorePassword('-interactive')
changeMultipleKeyStorePasswords
La commande changeMultipleKeyStorePasswords met à jour les mots de passe de chaque fichier de clés de la configuration possédant un mot de passe spécifique. Ceci est utile car, lorsque vous créez des fichiers de clés, ceux-ci ont, par défaut, WebAS comme mot de passe.
Paramètres requis
- -keyStorePassword
- Définit le nom du mot de passe que vous voulez modifier. (Chaîne, obligatoire)
- -newKeyStorePassword
- Définit le nouveau mot de passe que vous utiliserez pour accéder au fichier de clés. (Chaîne, obligatoire)
- -newKeyStorePasswordVerify
- Confirme le nouveau mot de passe du fichier de clés. (Chaîne, obligatoire)
Paramètres optionnels
Aucun.Exemples
Syntaxe d'un exemple de mode différé :
- A l'aide de Jacl :
$AdminTask changeMultipleKeyStorePasswords {-keyStorePassword WebAS -newKeyStorePassword newpwd -newKeyStorePasswordVerify newpwd}
- Avec la chaîne Jython :
AdminTask.changeMultipleKeyStorePasswords('[-keyStorePassword WebAS -newKeyStorePassword newpwd -newKeyStorePasswordVerify newpwd]')
- A l'aide de la liste Jython :
AdminTask.changeMultipleKeyStorePasswords(['-keyStorePassword', 'WebAS', '-newKeyStorePassword', 'newpwd', '-newKeyStorePasswordVerify', 'newpwd'])
Exemple d'utilisation en mode interactif :
- A l'aide de Jacl :
$AdminTask changeMultipleKeyStorePasswords {-interactive}
- En langage Jython :
AdminTask.changeMultipleKeyStorePasswords('-interactive')
createKeyStore
La commande createKeyStore crée les paramètres du fichier de clés dans la configuration et dans la base de données des fichiers de clés.
Paramètres requis
- -keyStoreName
- Nom qui définit de manière unique l'objet de configuration de fichier de clés. (Chaîne, obligatoire)
- -keyStoreType
- Implémentation de la gestion du fichier de clés. (Chaîne, obligatoire)
- -keyStoreLocation
- Emplacement du fichier de clés. Pour un fichier de clés basé sur des
fichiers, cet emplacement correspond au chemin d'accès à la base de
données des fichiers de clés. Pour un fichier de clés de cryptographie
matérielle, cet emplacement correspond au chemin d'accès à la bibliothèque
de jetons. (Chaîne, obligatoire)
Si vous créez le fichier de clés IBMi5OSKeyStore, l'emplacement du fichier de clé doit inclure l'extension de fichier .kdb.
- -keyStorePassword
- Mot de passe de protection du fichier de clés. (Chaîne, obligatoire)
- -keyStorePasswordVerify
- Mot de passe de protection du fichier de clés. (Chaîne, obligatoire)
Paramètres optionnels
- -keyStoreProvider
- The provider that is used to implement the keystore. (Chaîne, optionnelle)
- -keyStoreIsFileBased
- Affectez à ce paramètre la valeur true si le fichier de clés est basé sur des fichiers. Affectez à ce paramètre la valeur false pour les fichiers de clés de cryptographie matérielle. (Booléen, facultatif)
- -keyStoreHostList
- Liste de noms d'hôtes séparés par une virgule, indiquant l'endroit à partir duquel le fichier de clés est géré à distance. (Chaîne, optionnelle)
- -keyStoreInitAtStartup
- Affectez à ce paramètre la valeur true si le fichier de clés est initialisé lors du démarrage. Sinon, affectez à ce paramètre la valeur false. (Booléen, facultatif)
- -keyStoreReadOnly
- Affectez à ce paramètre la valeur true si vous ne pouvez pas écrire dans le fichier de clés. Sinon, affectez à ce paramètre la valeur false. (Booléen, facultatif)
- -keyStoreStashFile
- Affectez à ce paramètre la valeur true pour créer des fichiers de dissimulation pour les fichier de clés de type CMS. Sinon, affectez à ce paramètre la valeur false. (Booléen, facultatif)
- -enableCryptoOperations
- Indique si l'objet fichier de clés sera utilisé dans les opérations de cryptographie matérielle. La valeur par défaut est false. (Booléen, facultatif)
- -keyStoreDescription
- Specifies user-defined text to describe the keystore of interest. (Chaîne, optionnelle)
- -keyStoreUsage
- Indique l'utilisation du fichier de clés concerné. Indiquez SSLKeys, KeySetKeys, RootKeys, DeletedKeys, DefaultSigners ou RSATokenKeys. (Chaîne, optionnelle)
- -scopeName
- Nom identifiant de manière unique la portée de la gestion. Par exemple : (cell):localhostNode01Cell. (Chaîne, optionnelle)
- -controlRegionUser
- Indique l'utilisateur de la région de contrôle pour créer un objet de fichier de clés inscriptible destiné au fichier de clés des régions de contrôle. Définit cette option pour les fichiers de clés SAF lorsque "fichier de clés inscriptible SAF" est activé. (Chaîne, optionnelle)
- -servantRegionUser
- Indique l'utilisateur de la région serviteur pour la création d'un objet de fichier de clés inscriptible destiné au fichier de clés des régions serviteur. Définit cette option pour les fichiers de clés SAF lorsque "fichier de clés inscriptible SAF" est activé. (Chaîne, optionnelle)
Exemples
Syntaxe d'un exemple de mode différé :
- A l'aide de Jacl :
$AdminTask createKeyStore {-keyStoreName testKS -keyStoreType JCEKS -keyStoreLocation c:/temp/testKeyFile.p12 -keyStorePassword testpwd -keyStorePasswordVerify testpwd -keyStoreIsFileBased true -keyStoreInitAtStartup true -keyStoreReadOnly false}
- Avec la chaîne Jython :
AdminTask.createKeyStore('[-keyStoreName testKS -keyStoreType JCEKS -keyStoreLocation c:/temp/testKeyFile.p12 -keyStorePassword testpwd -keyStorePasswordVerify testpwd -keyStoreIsFileBased true -keyStoreInitAtStartup true -keyStoreReadOnly false]')
- A l'aide de la liste Jython :
AdminTask.createKeyStore(['-keyStoreName', 'testKS', '-keyStoreLocation', '-keyStoreType', 'JCEKS', 'c:/temp/testKeyFile.p12', '-keyStorePassword', 'testpwd', '-keyStorePasswordVerify', 'testpwd', '-keyStoreIsFileBased', 'true', '-keyStoreInitAtStartup', 'true', '-keyStoreReadOnly', 'false'])
Exemple d'utilisation en mode interactif :
- A l'aide de Jacl :
$AdminTask createKeyStore {-interactive}
- En langage Jython :
AdminTask.createKeyStore('-interactive')
createCMSKeyStore
La commande createCMSKeyStore crée une base de données de fichiers de clés CMS et les paramètres du fichier de clés dans la configuration.
Paramètres requis
- -cmsKeyStoreURI
- Identificateur URI du fichier de clés CMS. (Chaîne, obligatoire)
- -pluginHostName
- Nom d'hôte du plug-in. (Chaîne, obligatoire)
Paramètres optionnels
Aucun.Exemples
Syntaxe d'un exemple de mode différé :
- A l'aide de Jacl :
$AdminTask createCMSKeyStore {-cmsKeyStoreURI CMSKeystoreURI -pluginHostName myHostName}
- Avec la chaîne Jython :
AdminTask.createCMSKeyStore('-cmsKeyStoreURI CMSKeystoreURI -pluginHostName myHostName')
- A l'aide de la liste Jython :
AdminTask.createCMSKeyStore(['-cmsKeyStoreURI', 'CMSKeystoreURI', '-pluginHostName', 'myHostName'])
Exemple d'utilisation en mode interactif :
- A l'aide de Jacl :
$AdminTask createCMSKeyStore {-interactive}
- En langage Jython :
AdminTask.createCMSKeyStore('-interactive')
deleteKeyStore
La commande deleteKeyStore supprime les paramètres d'un fichier de clés de la configuration et le fichier de clés.
Paramètres requis
- -keyStoreName
- Nom identifiant de manière unique le fichier de clés à supprimer. (Chaîne, obligatoire)
Paramètres optionnels
- -scopeName
- Nom identifiant de manière unique la portée de la gestion. Par exemple : (cell):localhostNode01Cell. (Chaîne, optionnelle)
- -removeKeyStoreFile
- Indique si le fichier de clés doit être supprimé. Indiquez true pour supprimer le fichier de clés ou false pour le conserver dans la configuration. (Booléen, facultatif)
Exemples
Syntaxe d'un exemple de mode différé :
- A l'aide de Jacl :
$AdminTask deleteKeyStore {-keyStoreName testKS}
- Avec la chaîne Jython :
AdminTask.deleteKeyStore('[-keyStoreName testKS]')
- A l'aide de la liste Jython :
AdminTask.deleteKeyStore(['-keyStoreName', 'testKS'])
Exemple d'utilisation en mode interactif :
- A l'aide de Jacl :
$AdminTask deleteKeyStore {-interactive}
- En langage Jython :
AdminTask.deleteKeyStore('-interactive')
exchangeSigners
La commande exchangeSigners échange les certificats de signataire entre des fichiers de clés.
Paramètres requis
- -keyStoreName1
- Nom qui identifie de manière unique un fichier de clés. Vous devez définir un deuxième nom de fichier de clés à l'aide du paramètre keyStoreName2. (Chaîne, obligatoire)
- -keyStoreName2
- Nom qui identifie de manière unique un fichier de clés. Vous devez définir un deuxième nom de fichier de clés à l'aide du paramètre keyStoreName1. (Chaîne, obligatoire)
Paramètres optionnels
- -keyStoreScope1
- Nom de portée du fichier de clés que vous avez défini à l'aide du paramètre keyStoreName1. (Chaîne, optionnelle)
- -keyStoreScope2
- Nom de portée du fichier de clés que vous avez défini à l'aide du paramètre keyStoreName2. (Chaîne, optionnelle)
- -certificateAlaisList1
- Liste d'alias séparés par des virgules. (Chaîne, optionnelle)
- -certificateAliasList2
- Liste d'alias séparés par des virgules. (Chaîne, optionnelle)
Exemples
Syntaxe d'un exemple de mode différé :
- A l'aide de Jacl :
$AdminTask exchangeSigners {-keyStoreName1 testKS -certificateAliasList1 testCert1 -keyStoreName2 secondKS -certificateAlaisList2 certAlis}
- Avec la chaîne Jython :
AdminTask.exchangeSigners('[-keyStoreName1 testKS -certificateAliasList1 testCert1 -keyStoreName2 secondKS -certificateAlaisList2 certAlis]')
- A l'aide de la liste Jython :
AdminTask.exchangeSigners(['-keyStoreName1', 'testKS', '-certificateAliasList1', 'testCert1', '-keyStoreName2', 'secondKS', '-certificateAlaisList2', 'certAlis'])
Exemple d'utilisation en mode interactif :
- A l'aide de Jacl :
$AdminTask exchangeSigners {-interactive}
- En langage Jython :
AdminTask.exchangeSigners('-interactive')
getKeyStoreInfo
La commande getKeyStoreInfo affiche les paramètres d'un fichier de clés déterminé.
Paramètres requis
- -keyStoreName
- Nom qui identifie de manière unique le fichier de clés. (Chaîne, obligatoire)
Paramètres optionnels
- -scopeName
- Nom identifiant de manière unique la portée de la gestion. Par exemple : (cell):localhostNode01Cell. (Chaîne, optionnelle)
Exemples
Syntaxe d'un exemple de mode différé :
- A l'aide de Jacl :
$AdminTask getKeyStoreInfo {-name testKS}
- Avec la chaîne Jython :
AdminTask.getKeyStoreInfo('[-name testKS]')
- A l'aide de la liste Jython :
AdminTask.getKeyStoreInfo(['-name', 'testKS'])
Exemple d'utilisation en mode interactif :
- A l'aide de Jacl :
$AdminTask getKeyStoreInfo {-interactive}
- En langage Jython :
AdminTask.getKeyStoreInfo('-interactive')
listKeyFileAliases
La commande listKeyFileAliases répertorie les certificats d'un fichier de clés.
Paramètres requis
- -keyFilePath
- Chemin du fichier de clés. (Chaîne, obligatoire)
- -keyFilePassword
- Mot de passe du fichier de clés. (Chaîne, obligatoire)
- -keyFileType
- Type du fichier de clés. (Chaîne, obligatoire)
Paramètres optionnels
Aucun.Exemples
Syntaxe d'un exemple de mode différé :
- A l'aide de Jacl :
$AdminTask listKeyFileAliases {-keyFilePath c:/temp/testKeyFile.p12 -keyFilePassword testPwd -keyFileType PKCS12}
$AdminTask listKeyFileAliases {-keyFilePath /temp/testKeyFile.p12 -keyFilePassword testPwd -keyFileType PKCS12}
- Avec
la chaîne Jython :
AdminTask.listKeyFileAliases('[-keyFilePaht c:/temp/testKeyFile.p12 -keyFilePassword testPwd -keyFileType PKCS12]')
AdminTask.listKeyFileAliases('[-keyFilePaht /temp/testKeyFile.p12 -keyFilePassword testPwd -keyFileType PKCS12]')
- A l'aide de la liste Jython :
AdminTask.listKeyFileAliases(['-keyFilePaht', 'c:/temp/testKeyFile.p12', '-keyFilePassword', 'testPwd', '-keyFileType', 'PKCS12'])
AdminTask.listKeyFileAliases(['-keyFilePaht', '/temp/testKeyFile.p12', '-keyFilePassword', 'testPwd', '-keyFileType', 'PKCS12'])
Exemple d'utilisation en mode interactif :
- A l'aide de Jacl :
$AdminTask listKeyFileAliases {-interactive}
- En langage Jython :
AdminTask.listKeyFileAliases('-interactive')
listKeyStores
La commande listKeyStores répertorie les fichiers de clés d'une portée déterminée.
Paramètres requis
Aucun.Paramètres optionnels
- -scopeName
- Indique le nom qui identifie de manière unique la portée de la gestion. Par exemple : (cell):localhostNode01Cell. (Chaîne, optionnelle)
- -all
- Affectez à ce paramètre la valeur true pour répertorier tous les fichiers de clés. Ce paramètre remplace le paramètre scopeName. La valeur par défaut est false. (Booléen, facultatif)
- -keyStoreUsage
- Indique l'utilisation du fichier de clés concerné. Indiquez SSLKeys, KeySetKeys, RootKeys, DeletedKeys, DefaultSigners ou RSATokenKeys. (Chaîne, optionnelle)
Exemples
Syntaxe d'un exemple de mode différé :
- A l'aide de Jacl :
$AdminTask listKeyStores
- En langage Jython :
AdminTask.listKeyStores()
Exemple d'utilisation en mode interactif :
- A l'aide de Jacl :
$AdminTask listKeyStores {-interactive}
- En langage Jython :
AdminTask.listKeyStores('-interactive')
listKeyStoreTypes
La commande listKeyStoreTypes répertorie tous les types de fichier de clés valides.
Paramètres obligatoires
Aucun.Paramètres optionnels
Aucun.Exemples
Syntaxe d'un exemple de mode différé :
- A l'aide de Jacl :
$AdminTask listKeyStoreTypes
- En langage Jython :
AdminTask.listKeyStoreTypes()
Exemple d'utilisation en mode interactif :
- A l'aide de Jacl :
$AdminTask listKeyStoreTypes {-interactive}
- Avec la chaîne Jython :
AdminTask.listKeyStoreTypes('-interactive')
listSignatureAlgorithms
La commande listSignatureAlgorithms répertorie les algorithmes de signature valides pour le niveau de sécurité configuré. If a security standard is not enabled, all signature algorithms are returned; otherwise, the valid signature algorithms for the configured security level are returned.
Paramètres requis
Aucun.Paramètres optionnels
Aucun.Mode de sécurité | Algorithmes de signature disponibles |
---|---|
Fips non activé | SHA1withRSA |
FIPS140-2 | SHA1withRSA |
SP800-131 - Transition | SHA1withRSA |
SP800-131 - Strict | SHA256withRSA |
Suite B 128 | SHA256withECDSA |
Suite B 192 | SHA256withECDSA |
modifyKeyStore
- Si vous souhaitez utiliser cette commande pour modifier le fichier de clés référencé par l'objet fichier de clés, indiquez les paramètres keyStoreName, keyStoreLocation, keyStoreType et keyStorePassword.
Paramètres obligatoires
- -keyStoreName
- Indique le nom unique qui identifie leu fichier de clés. (Chaîne, obligatoire)
Paramètres optionnels
- -scopeName
- Indique la portée du fichier de clés. (Chaîne, optionnelle)
- -keyStoreProvider
- Indique le fournisseur du fichier de clés. (Chaîne, optionnelle)
- -keyStoreType
- Indique l'un des types de fichier de clés prédéfinis. Les valeurs valides sont JCEKS, CMSKS, PKCS12, PKCS11 et JKS. (Chaîne, optionnelle)
- -keyStoreLocation
- Indique l'emplacement complet du fichier de clés. Pour modifier l'emplacement du fichier de clés, vous devez spécifier les paramètres keyStoreLocation, keyStoreType, keyStorePassword et keyStoreName. (Chaîne, optionnelle)
- -keyStorePassword
- Indique le mot de passe d'ouverture du fichier de clés. Utilisez la commande changeKeystorePassword pour changer le mot de passe du fichier de clés. (Chaîne, optionnelle)
- -keyStoreIsFileBased
- Specifies whether the keystore is file-based. Pour modifier la possibilité d'avoir un fichier de clés sous forme de fichier, spécifiez les paramètres keyStoreIsFileBased et keyStoreName. (Booléen, facultatif)
- -keyStoreInitAtStartup
- Indique si le fichier de clés est activé au démarrage du serveur. Pour modifier la possibilité que le fichier de clés se lance au démarrage du serveur, spécifiez les paramètres keyStoreInitAtStartup et keyStoreName. (Booléen, facultatif)
- -keyStoreReadOnly
- Indique si le fichier de clés est inscriptible. Pour modifier la possibilité que le fichier de clés soit en lecture seule, spécifiez les paramètres keyStoreReadOnly et keyStoreName. (Booléen, facultatif)
- -keyStoreDescription
- Indique une instruction décrivant le fichier de clés. Pour modifier la description du fichier de clés, spécifiez les paramètres keyStoreDescription et keyStoreName. (Chaîne, optionnelle)
- -keyStoreUsage
- Indique l'utilisation du fichier de clés concerné. Indiquez SSLKeys, KeySetKeys, RootKeys, DeletedKeys, DefaultSigners ou RSATokenKeys. (Chaîne, optionnelle)
Exemples
Syntaxe d'un exemple de mode différé :
- A l'aide de Jacl :
$AdminTask modifyKeyStore {-keyStoreName CellDefaultKeyStore -keyStoreLocation c:/temp/testKeyFile.p12 -keyStoreType JCEKS -keyStorePassword my1password}
$AdminTask modifyKeyStore {-keyStoreName CellDefaultKeyStore -keyStoreLocation /temp/testKeyFile.p12 -keyStoreType JCEKS -keyStorePassword my1password}
- En langage Jython :
AdminTask.modifyKeyStore('-keyStoreName CellDefaultKeyStore -keyStoreLocation c:/temp/testKeyFile.p12 -keyStoreType JCEKS -keyStorePassword my1password')
AdminTask.modifyKeyStore('keyStoreName CellDefaultKeyStore -keyStoreLocation /temp/testKeyFile.p12 -keyStoreType JCEKS -keyStorePassword my1password')
Exemple d'utilisation en mode interactif :
- A l'aide de Jacl :
$AdminTask modifyKeyStore {-interactive}
- En langage Jython :
AdminTask.modifyKeyStore('-interactive')