Grupo de Comandos JaspiManagement Para o Objeto AdminTask
Utilize os comandos e parâmetros no grupo de comandos JaspiManagement para gerenciar a configuração de provedores de autenticação.
JASPI é uma nova especificação introduzida na Java Platform, Enterprise Edition 6 (Java EE 6). Ela possibilita aos provedores de segurança executar a autenticação de mensagens para ambientes de tempo de execução do sistema de mensagens. O JASPI estende a arquitetura Java Authentication and Authorization Service (JAAS) com as interfaces de programação padronizadas para disponibilizar mensagens de rede para processamento pelos provedores de autenticação.
Se você deseja usar serviços de autenticação de mensagens JASPI, deverá fornecer uma implementação das interfaces necessárias conforme definido na especificação da JASPI. Leia sobre Desenvolvendo um Provedor de Autenticação Customizado, para obter informações adicionais sobre essas interfaces.
Quando os provedores de autenticação JASPI estão configurados e o WebSphere Application Server receber uma mensagem de solicitação, o ambiente de tempo de execução de segurança determina se o aplicativo de destino está configurado para utilizar a autenticação JASPI. Se estiver, o ambiente de tempo de execução chama o provedor de autenticação selecionado para validar a mensagem recebida. Caso contrário, a autenticação da solicitação de mensagem é feita de acordo com o mecanismo de autenticação fornecido pelo WebSphere Application Server para a camada de mensagem apropriada.
O grupo de comandos JaspiManagement inclui os seguintes comandos:
configureJaspi
O comando configureJaspi é utilizado para especificar se o processamento JASPI (Java Authentication SPI) deve ser ativado ou desativado, e para configurar o provedor JASPI padrão para um determinado domínio de segurança ou a configuração de segurança global.
Objeto de destino
Nenhum.
Parâmetros Requeridos
Nenhum.
Parâmetros Opcionais
- -enabled
- Especifique true para ativar a configuração JASPI e false para desativar a configuração.
- -defaultProviderName
- Especifica o nome de um provedor da JASPI já configurado que deve ser usado como o provedor da JASPI padrão para a configuração de domínio de segurança ou de segurança global.
- -securityDomainName
- Especifica o nome do domínio de segurança. No entanto, se você não especificar um valor, o padrão será de 600 segundos.
Valor de Retorno
O comando retorna o nome do objeto do ID de configuração da JASPI que o sistema cria e uma instância javax.management.ObjectName. O valor exibido no é o ID de configuração da JASPI.
Exemplo de uso do modo em lote
AdminTask.configureJaspi('[-enabled true -defaultProviderName testProvider]')
$AdminTask configureJaspi {-enabled true -defaultProviderName testProvider}
Uso de exemplo do modo interativo
AdminTask.configureJaspi('-interactive')
$AdminTask configureJaspi -interactive
defineJaspiProvider
O comando defineJaspiProvider configura um novo provedor de autenticação para o referido domínio de segurança ou configuração de segurança global.
Objeto de destino
Nenhum.
Parâmetros Requeridos
- -providerName
- Especifica um nome que identifica exclusivamente o provedor de autenticação.
- -className
- Especifica o nome completo do pacote da classe que implementa a interface do provedor de autenticação (javax.security.auth.message.config.AuthConfigProvider).
Parâmetros Opcionais
- -description
- Especifica uma descrição textual do provedor de autenticação.
- -properties
- Especifica as propriedades de configuração customizadas adicionais necessárias para inicializar o provedor de autenticação. Esse parâmetro é uma lista de pares de chave/valor.
- -securityDomainName
- Especifica o nome do domínio de segurança. O comando usará a configuração de segurança global se você não especificar um valor para o parâmetro -securityDomainName.
Valor de Retorno
O comando retorna um mapa dos atributos de configuração do provedor de autenticação e seus valores, e é uma instância de java.util.Map<java.lang.String, java.lang.Object> que contém os atributos de configuração do provedor de autenticação. O valor exibido no console é o valor de retorno do método toString() do Mapa.
Exemplo de uso do modo em lote
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} } }
Uso de exemplo do modo interativo
AdminTask.defineJaspiProvider('-interactive')
$AdminTask defineJaspiProvider -interactive
displayJaspiProvider
O comando displayJaspiProvider exibe os dados de configuração para um ou mais provedor de autenticação para o referido domínio de segurança ou configuração de segurança global.
Objeto de destino
Nenhum.
Parâmetros Obrigatórios
- -providerName
- Especifica o(s) nome(s) exclusivo(s) do(s) provedor(es) de autenticação a ser(em) exibido(s).
Parâmetros Opcionais
- -securityDomainName
- Especifica o nome do domínio de segurança. O comando usará a configuração de segurança global se você não especificar um valor para o parâmetro -securityDomainName.
Valor de Retorno
O comando exibe o(s) provedor(es) especificado(s) juntamente com seus atributos de configuração e valores. A data retornada é exibida como uma instância de java.util.Collection<java.util.Map<java.lang.String, java.lang.Object>>. Cada instância de Mapa contém os atributos de configuração de um provedor de autenticação. O valor exibido no console é o valor de retorno do método toString() da Coleção.
Exemplo de uso do modo em lote
AdminTask.displayJaspiProvider('-providerName jaspi_provider')
$AdminTask displayJaspiProvider {'-providerName jaspi_provider'}
Uso de exemplo do modo interativo
AdminTask.displayJaspiProvider('-interactive')
$AdminTask displayJaspiProvider -interactive
displayJaspiProviderNames
O comando displayJaspiProviderNames exibe os nomes dos provedores de autenticação na configuração de segurança. Quando o parâmetro securityDomainName é fornecido, somente esses provedores no determinado domínio de segurança são exibidos. Quando o parâmetro securityDomainName não é fornecido, somente os nomes dos provedores na configuração de segurança global são exibidos.
Quando o parâmetro securityDomainName é fornecido com o parâmetro getEffectiveProviderNames configurado como false, apenas a lista de provedores de autenticação para o domínio de segurança especificado é exibida. O parâmetro getEffectiveProviderNames somente tem efeito com o parâmetro securityDomainName; ele é ignorado se o provedor securityDomainName não for fornecido.
Objeto de destino
Nenhum.
Parâmetros Obrigatórios
Nenhum.
Parâmetros Opcionais
- -getEffectiveProviderNames
- Especifique true para obter a lista de nomes de provedores de autenticação ou false para obter apenas a lista de provedores de autenticação para a configuração do domínio de segurança. O valor padrão para getEffectiveProviderName é false.
- -securityDomainName
- Especifica o nome do domínio de segurança. O comando usará a configuração de segurança global se você não especificar um valor para o parâmetro -securityDomainName.
Valor de Retorno
O comando retorna uma lista de nomes de provedor JASPI. A data retornada é exibida como uma instância de java.util.Collection<java.lang.String>.
Exemplo de uso do modo em lote
AdminTask.displayJaspiProviderNames()
$AdminTask displayJaspiProviderNames
Uso de exemplo do modo interativo
AdminTask.displayJaspiProviderNames('-interactive')
$AdminTask displayJaspiProviderNames -interactive
getJaspiInfo
O comando getJaspiInfo exibe informações sobre a configuração JASPI para o referido domínio de segurança ou configuração de segurança global.
Objeto de destino
Nenhum.
Parâmetros Obrigatórios
Nenhum.
Parâmetros Opcionais
- -securityDomainName
- Especifica o nome do domínio de segurança. O comando usará a configuração de segurança global se você não especificar um valor para o parâmetro -securityDomainName.
Valor de Retorno
O comando retorna uma indicação de se o processamento do SPI de Autenticação Java está ativado. Se o comando for emitido para um domínio de segurança específico e um valor for customizado para o domínio, o comando retorna um valor para indicar se o processamento de JASPI está ativado. Se o comando for emitido para um domínio específico e um valor não estiver customizado para o domínio, ele retorna uma lista vazia para indicar que a configuração é herdada da configuração de segurança global. Os dados retornados são exibidos como uma instância de java.util.Map<java.lang.String, java.lang.Object> que contém os atributos de configuração JASPI. O valor exibido no console é o valor de retorno do método toString() do Mapa.
wsadmin>$AdminTask getJaspiInfo
{defaultProviderName=null, enabled=false}
Exemplo de uso do modo em lote
AdminTask.getJaspiInfo()
$AdminTask getJaspiInfo
Uso de exemplo do modo interativo
AdminTask.getJaspiInfo('-interactive')
$AdminTask getJaspiInfo -interactive
modifyJaspiProvider
O comando modifyJaspiProvider modifica os dados de configuração para um determinado provedor de autenticação de um determinado domínio de segurança ou configuração de segurança global.
Objeto de destino
Nenhum.
Parâmetros Obrigatórios
- -providerName
- Especifica um nome que identifica exclusivamente o provedor de autenticação.
Parâmetros Opcionais
- -className
- Especifica o nome completo do pacote da classe que implementa a interface do provedor de autenticação (javax.security.auth.message.config.AuthConfigProvider).
- -description
- Especifica uma descrição textual do provedor de autenticação.
- -properties
- Especifica as propriedades de configuração customizadas adicionais necessárias para inicializar o provedor de autenticação. Esse parâmetro é uma lista de pares de chave/valor.
- -securityDomainName
- Especifica o nome do domínio de segurança. O comando usará a configuração de segurança global se você não especificar um valor para o parâmetro -securityDomainName.
Valor de Retorno
Uma instância de java.util.Map<java.lang.String, java.lang.Object> que contém qualquer atributo de configuração modificado no referido provedor de autenticação ou em qualquer módulo de autenticação associado. O valor exibido no console é o valor de retorno do método toString() do Mapa.
Exemplo de uso do modo em lote
AdminTask.modifyJaspiProvider('-providerName jaspi_provider
-properties [ [debug false] ] ')
$AdminTask modifyJaspiProvider { -providerName jaspi_provider
-properties { {debug false} } }
Exemplo de uso do modo interativo
AdminTask.modifyJaspiProvider('-interactive')
$AdminTask modifyJaspiProvider -interactive
removeJaspiProvider
O comando removeJaspiProvider remove um ou mais provedor de autenticação da configuração de segurança de um determinado domínio de segurança ou configuração de segurança global.
Objeto de destino
Nenhum.
Parâmetros Obrigatórios
- -providerName
- Especifica o(s) nome(s) exclusivo(s) do(s) provedor(es) de autenticação a ser(em) removido(s).
Parâmetros Opcionais
- -securityDomainName
- Especifica o nome do domínio de segurança. O comando usará a configuração de segurança global se você não especificar um valor para o parâmetro -securityDomainName.
Valor de Retorno
Nenhum.
Exemplo de uso do modo em lote
AdminTask.removeJaspiProvider('-providerName jaspi_provider')
AdminTask.removeJaspiProvider( '[-providerName [ Provider1;Provider2 ] ]' )
$AdminTask removeJaspiProvider {'-providerName jaspi_provider'}
$AdminTask removeJaspiProvider {-providerName {Provider1 Provider2 } }
Uso de exemplo do modo interativo
AdminTask.removeJaspiProvider('-interactive')
$AdminTask removeJaspiProvider -interactive
unconfigureJaspi
O comando unconfigureJaspi é usado para remover a configuração JASPI e todos os seus provedores associados de um domínio de segurança.
Objeto de destino
Nenhum.
Parâmetros Obrigatórios
- -securityDomainName
- Especifica o nome do domínio de segurança. O comando usará a configuração de segurança global se você não especificar um valor para o parâmetro -securityDomainName.
Parâmetros Opcionais
Nenhum.
Valor de Retorno
Nenhum.
Exemplo de uso do modo em lote
AdminTask.unconfigureJaspi('-securityDomainName domain1')
$AdminTask unconfigureJaspi {-securityDomainName domain1}
Uso de exemplo do modo interativo
AdminTask.unconfigureJaspi('-interactive')
$AdminTask unconfigureJaspi -interactive