Groupe de commandes JaspiManagement pour l'objet AdminTask
Utilisez les commandes et les paramètres du groupe de commandes JaspiManagement pour gérer la configuration des fournisseurs d'authentification.
JASPI est une nouvelle spécification introduite dans Java Platform, Enterprise Edition 6 (Java EE 6). Elle permet aux fournisseurs de sécurité tiers de procéder à l'authentification des messages pour des environnements d'exécution de messagerie spécifiques. JASPI étend l'architecture JAAS (Java Authentication and Authorization Service) avec des interfaces de programmation normalisées pour que les messages réseau puissent être traités par les fournisseurs d'authentification.
Si vous voulez utiliser les services d'authentification de message JASPI, vous devez fournir une implémentation des interfaces requises conformément à la spécification JASPI. Lisez les articles sur le développement d'un fournisseur d'authentification personnalisé pour plus d'informations sur ces interfaces.
Lorsque les fournisseurs d'authentification JASPI sont configurés et que WebSphere Application Server reçoit un message de demande, l'environnement d'exécution de sécurité détermine si l'application cible est configurée pour l'utilisation de l'authentification JASPI. Si tel est le cas, il appelle les fournisseurs d'authentification sélectionnés pour valider le message reçu. Sinon, l'authentification de la demande de message est effectuée en fonction du mécanisme d'authentification fourni par WebSphere Application Server pour la couche messages appropriée.
Le groupe de commandes JaspiManagement contient les commandes suivantes :
configureJaspi
La commande configureJaspi permet de spécifier si le traitement JASPI (Java Authentication SPI) doit être activé ou désactivé et de définir le fournisseur JASPI par défaut pour un domaine de sécurité donné ou la configuration de sécurité globale.
Objet cible
Aucun.
Paramètres requis
Aucun.
Paramètres optionnels
- -enabled
- Spécifiez true pour activer la configuration JASPI et false pour la désactiver.
- -defaultProviderName
- Spécifie le nom d'un fournisseur JASPI déjà configuré à utiliser comme fournisseur JASPI par défaut pour le domaine de sécurité ou la configuration de sécurité globale.
- -securityDomainName
- Indique le nom du domaine de sécurité. La commande utilise la configuration de sécurité globale si vous n'indiquez pas de valeur pour le paramètre -securityDomainName.
Valeur renvoyée
La commande renvoie le nom d'objet de l'ID de configuration JASPI que le système crée et qui est une instance de javax.management.ObjectName. La valeur affichée dans la console est l'ID de configuration JASPI.
Exemple d'utilisation en mode de traitement par lots
AdminTask.configureJaspi('[-enabled true -defaultProviderName testProvider]')
$AdminTask configureJaspi {-enabled true -defaultProviderName testProvider}
Exemple d'utilisation en mode interactif
AdminTask.configureJaspi('-interactive')
$AdminTask configureJaspi -interactive
defineJaspiProvider
La commande defineJaspiProvider configure un nouveau fournisseur d'authentification pour le domaine de sécurité donné ou la configuration de sécurité globale.
Objet cible
Aucun.
Paramètres requis
- -providerName
- Spécifie un nom qui identifie le fournisseur d'authentification de façon unique.
- -className
- Indique le nom qualifié par le package de la classe qui implémente l'interface du fournisseur d'authentification (javax.security.auth.message.config.AuthConfigProvider).
Paramètres optionnels
- -description
- Spécifie une description du fournisseur d'authentification.
- -properties
- Spécifie des propriétés de configuration supplémentaires requises pour l'initialisation du fournisseur d'authentification. Ce paramètre est une liste de paires clé/valeur.
- -securityDomainName
- Indique le nom du domaine de sécurité. La commande utilise la configuration de sécurité globale si vous n'indiquez pas de valeur pour le paramètre -securityDomainName.
Valeur renvoyée
La commande renvoie une mappe des attributs de configuration du fournisseur d'authentification et leurs valeurs ; il s'agit d'une instance djava.util.Map<java.lang.String, java.lang.Object> contenant les attributs de configuration du fournisseur d'authentification. La valeur affichée dans la console est la valeur renvoyée par la méthode toString() de la mappe.
Exemple d'utilisation en mode de traitement par lots
AdminTask.defineJaspiProvider('-providerName jaspi_provider
-className com.ibm.sample.JaspiProvider -description "Sample authentication provider"
-properties [ [debug true] [user admin] ] ')
$AdminTask defineJaspiProvider { -providerName jaspi_provider
-className com.ibm.JASPIProvider -description "Sample authentication provider"
-properties { {debug true} {user admin} } }
Exemple d'utilisation en mode interactif
AdminTask.defineJaspiProvider('-interactive')
$AdminTask defineJaspiProvider -interactive
displayJaspiProvider
La commande displayJaspiProvider affiche les données de configuration pour un ou plusieurs fournisseurs d'authentification donnés pour le domaine de sécurité donné ou la configuration de sécurité globale.
Objet cible
Aucun.
Paramètres requis
- -providerName
- Spécifie le ou les noms uniques du ou des fournisseurs d'authentification à afficher.
Paramètres optionnels
- -securityDomainName
- Indique le nom du domaine de sécurité. La commande utilise la configuration de sécurité globale si vous n'indiquez pas de valeur pour le paramètre -securityDomainName.
Valeur renvoyée
La commande affiche le ou les fournisseurs spécifiés ainsi que leurs attributs et valeurs de configuration. Les données renvoyées sont affichées sous forme d'instance de java.util.Collection<java.util.Map<java.lang.String, java.lang.Object>>. Chaque instance de mappe contient les attributs de configuration d'un fournisseur d'authentification. La valeur affichée dans la console est la valeur renvoyée par la méthode toString() de la collection.
Exemple d'utilisation en mode de traitement par lots
AdminTask.displayJaspiProvider('-providerName jaspi_provider')
$AdminTask displayJaspiProvider {'-providerName jaspi_provider'}
Exemple d'utilisation en mode interactif
AdminTask.displayJaspiProvider('-interactive')
$AdminTask displayJaspiProvider -interactive
displayJaspiProviderNames
La commande displayJaspiProviderNames affiche les noms des fournisseurs d'authentification dans la configuration de sécurité. Lorsque le paramètre securityDomainName est indiqué, seuls les fournisseurs du domaine de sécurité donné sont affichés. S'il n'est pas indiqué, seuls les noms des fournisseurs figurant dans la configuration de sécurité globale sont affichés.
Lorsque le paramètre securityDomainName est indiqué et que le paramètre getEffectiveProviderNames est associé à la valeur false, seule la liste des fournisseurs d'authentification pour le domaine de sécurité donné est affichée. Le paramètre getEffectiveProviderNames n'a d'effet que s'il est utilisé avec le paramètre securityDomainName ; il est ignoré si le fournisseur securityDomainName n'est pas indiqué.
Objet cible
Aucun.
Paramètres requis
Aucun.
Paramètres optionnels
- -getEffectiveProviderNames
- Spécifiez true pour obtenir la liste des noms de fournisseur d'authentification effectifs ou false pour obtenir la liste des fournisseurs d'authentification pour la configuration du domaine de sécurité uniquement. La valeur par défaut de getEffectiveProviderName est false.
- -securityDomainName
- Indique le nom du domaine de sécurité. La commande utilise la configuration de sécurité globale si vous n'indiquez pas de valeur pour le paramètre -securityDomainName.
Valeur renvoyée
La commande renvoie la liste des noms de fournisseur JASPI. Les données renvoyées s'affichent sous forme d'instance de java.util.Collection<java.lang.String>.
Exemple d'utilisation en mode de traitement par lots
AdminTask.displayJaspiProviderNames()
$AdminTask displayJaspiProviderNames
Exemple d'utilisation en mode interactif
AdminTask.displayJaspiProviderNames('-interactive')
$AdminTask displayJaspiProviderNames -interactive
getJaspiInfo
La commande getJaspiInfo affiche des informations sur la configuration JASPI pour le domaine de sécurité donné ou la configuration de sécurité globale.
Objet cible
Aucun.
Paramètres requis
Aucun.
Paramètres optionnels
- -securityDomainName
- Indique le nom du domaine de sécurité. La commande utilise la configuration de sécurité globale si vous n'indiquez pas de valeur pour le paramètre -securityDomainName.
Valeur renvoyée
La commande indique si le traitement JASPI (Java Authentication SPI) est activé. Si la commande est émise pour un domaine de sécurité spécifique et qu'une valeur est personnalisée pour le domaine, la commande renvoie une valeur indiquant si le traitement JASPI est activé. Si la commande est émise pour un domaine spécifique et qu'aucune valeur n'est personnalisée pour le domaine, la commande renvoie une liste vide indiquant que la configuration est héritée de la configuration de sécurité globale. Les données renvoyées s'affichent sous forme d'instance de java.util.Map<java.lang.String, java.lang.Object> contenant les attributs de configuration JASPI. La valeur affichée dans la console est la valeur renvoyée par la méthode toString() de la mappe.
wsadmin>$AdminTask getJaspiInfo
{defaultProviderName=null, enabled=false}
Exemple d'utilisation en mode de traitement par lots
AdminTask.getJaspiInfo()
$AdminTask getJaspiInfo
Exemple d'utilisation en mode interactif
AdminTask.getJaspiInfo('-interactive')
$AdminTask getJaspiInfo -interactive
modifyJaspiProvider
La commande modifyJaspiProvider modifie les données de configuration pour un fournisseur d'authentification donné pour le domaine de sécurité donné ou la configuration de sécurité globale.
Objet cible
Aucun.
Paramètres requis
- -providerName
- Spécifie un nom qui identifie le fournisseur d'authentification de façon unique.
Paramètres optionnels
- -className
- Indique le nom qualifié par le package de la classe qui implémente l'interface du fournisseur d'authentification (javax.security.auth.message.config.AuthConfigProvider).
- -description
- Spécifie une description du fournisseur d'authentification.
- -properties
- Spécifie des propriétés de configuration supplémentaires requises pour l'initialisation du fournisseur d'authentification. Ce paramètre est une liste de paires clé/valeur.
- -securityDomainName
- Indique le nom du domaine de sécurité. La commande utilise la configuration de sécurité globale si vous n'indiquez pas de valeur pour le paramètre -securityDomainName.
Valeur renvoyée
Une instance de java.util.Map<java.lang.String, java.lang.Object> contenant tout attribut de configuration modifié dans le fournisseur d'authentification donné ou tout module d'authentification associé donné. La valeur affichée dans la console est la valeur renvoyée par la méthode toString() de la mappe.
Exemple d'utilisation en mode de traitement par lots
AdminTask.modifyJaspiProvider('-providerName jaspi_provider
-properties [ [debug false] ] ')
$AdminTask modifyJaspiProvider { -providerName jaspi_provider
-properties { {debug false} } }
Exemple d'utilisation en mode interactif
AdminTask.modifyJaspiProvider('-interactive')
$AdminTask modifyJaspiProvider -interactive
removeJaspiProvider
La commande removeJaspiProvider retire un ou plusieurs fournisseurs d'authentification pour le domaine de sécurité donné ou la configuration de la sécurité globale.
Objet cible
Aucun.
Paramètres requis
- -providerName
- Spécifie le ou les noms uniques du ou des fournisseurs d'authentification à retirer.
Paramètres optionnels
- -securityDomainName
- Indique le nom du domaine de sécurité. La commande utilise la configuration de sécurité globale si vous n'indiquez pas de valeur pour le paramètre -securityDomainName.
Valeur renvoyée
Aucun.
Exemple d'utilisation en mode de traitement par lots
AdminTask.removeJaspiProvider('-providerName jaspi_provider')
AdminTask.removeJaspiProvider( '[-providerName [ Provider1;Provider2 ] ]' )
$AdminTask removeJaspiProvider {'-providerName jaspi_provider'}
$AdminTask removeJaspiProvider {-providerName {Provider1 Provider2 } }
Exemple d'utilisation en mode interactif
AdminTask.removeJaspiProvider('-interactive')
$AdminTask removeJaspiProvider -interactive
unconfigureJaspi
La commande unconfigureJaspi permet de retirer d'un domaine de sécurité la configuration JASPI et tous les fournisseurs qui lui sont associés.
Objet cible
Aucun.
Paramètres requis
- -securityDomainName
- Indique le nom du domaine de sécurité. La commande utilise la configuration de sécurité globale si vous n'indiquez pas de valeur pour le paramètre -securityDomainName.
Paramètres optionnels
Aucun.
Valeur renvoyée
Aucun.
Exemple d'utilisation en mode de traitement par lots
AdminTask.unconfigureJaspi('-securityDomainName domain1')
$AdminTask unconfigureJaspi {-securityDomainName domain1}
Exemple d'utilisation en mode interactif
AdminTask.unconfigureJaspi('-interactive')
$AdminTask unconfigureJaspi -interactive