Enviando Tokens de Acesso SAML Automitidos Usando APIs WSS

É possível criar tokens SAML autoemitidos com o método de confirmação de assunto de acesso e, em seguida, enviar estes tokens com mensagens de solicitação de serviços da web usando o modelo de programação Java™ API for XML-Based Web Services (JAX-WS) e as APIs Web Services Security (API WSS).

Antes de Iniciar

Essa tarefa assume que você é familiarizado com o modelo de programação JAX-WS, as interfaces API WSS, os conceitos de SAML, e o uso dos conjuntos de política para configurar e administrar as configurações dos serviços da Web.

Sobre Esta Tarefa

É possível construir o seu cliente de serviços da Web para usar tokens SAML com o método de confirmação de assunto de transmissão em mensagens de pedido SOAP usando as interfaces de programação de Segurança de Serviços da Web. Usar as interfaces de programação em um cliente de serviços da Web para especificar o uso de tokens SAML com confirmação de assunto de transmissão é uma abordagem alternativa ao uso de conjuntos dr políticas e configurações de ligação.

É possível criar um token SAML autoemitido e, em seguida, enviar o token SAML em mensagens de solicitação de serviços da web a partir de um cliente de serviços da web. O cliente de aplicativo de serviços da Web usado nessa tarefa é uma versão modificada do código do cliente que está contida no aplicativo de amostra JaxWSServicesSamples que está disponível para download. Fragmentos de código da amostra são descritos na seção de procedimento, e uma amostra de cliente de serviços da Web completa e pronta para usar é fornecida na seção Exemplo.

Procedimento

  1. Identifique e obtenha o cliente de serviços da Web que deseja usar para chamar um provedor de serviços da Web.

    Use esse cliente para inserir tokens SAML em mensagens de pedido SOAP programaticamente usando APIs WSS.

    O cliente de serviço da Web usado nesse procedimento é uma versão modificada do código do cliente que está contida no aplicativo de amostra de serviços da Web JaxWSServicesSamples.

    Para obter e modificar o cliente dos serviços da Web de amostra para incluir a API de Segurança de Serviços da Web para passar tokens SAML em mensagens de pedido SOAP programaticamente usando APIs WSS, conclua as seguintes etapas:

    1. Fazer download do aplicativo de amostra JaxWSServicesSamples. A amostra JaxWSServicesSamples não é instalada por padrão.
    2. Obter o código do cliente JaxWSServicesSamples.

      Para propósitos de exemplo, esse procedimento usa uma versão modificada da amostra do thin client Echo que está incluída na amostra JaxWSServicesSamples. O arquivo de amostra do thin client Echo dos serviços da Web, SampleClient.java, está localizado no diretório src\SampleClientSei\src\com\ibm\was\wssample\sei\cli. O arquivo de classe de amostra é incluído no arquivo WSSampleClientSei.jar.

      O aplicativo corporativo JaxWSServicesSamples.ear e os arquivos Java Archives de suporte estão localizados no diretório installableApps no aplicativo de amostra JaxWSServicesSamples.

    3. Implementar o arquivo JaxWSServicesSamples.ear no servidor de aplicativos. Após implementar o arquivo JaxWSServicesSamples.ear, você está pronto para testar o código do cliente de serviços da Web de amostra em relação ao aplicativo de amostra.

    Em vez de usar a amostra do cliente de serviços da Web, é possível escolher incluir os fragmentos de código para passar tokens SAML em mensagens de pedido SOAP programaticamente usando APIs WSS em seu próprio aplicativo de cliente de serviços da Web. O exemplo nesse procedimento usa um thin client de serviços da Web JAX-WS; porém, também é possível usar um cliente gerenciado.

  2. Conecte o conjunto de políticas padrão SAML20 Bearer WSHTTPS ao provedor de serviços da Web. Esse conjunto de políticas é usado para proteger mensagens usando transporte HTTPS. Consulte sobre a configuração de ligações de cliente e provedor para o token de transmissão SAML para obter detalhes sobre como conectar o conjunto de políticas SAML20 Bearer WSHTTPS padrão ao provedor de serviços da Web. O exemplo nesse procedimento usa tokens SAML autoemitidos. Ao configurar as ligações de provedor, a configuração de truststore e o certificado devem corresponder à chave de assinatura do token autoemitido.
  3. Designe as ligações gerais padrão de amostra SAML Bearer Provider para o provedor de serviços da Web de amostra. Consulte sobre a configuração de ligações de cliente e provedor para o token de transmissão SAML para obter detalhes sobre como designar as ligações gerais padrão da amostra SAML Bearer Provider para o seu aplicativo de serviços da Web.
  4. Crie o token SAML autoemitido. O seguinte fragmento de código ilustra a criação do token SAML:
    // Criar o token SAML.
    HashMap<Object, Object> map = new HashMap<Object, Object>();
    map.put(SamlConstants.CONFIRMATION_METHOD, "Bearer");
    map.put(SamlConstants.TOKEN_TYPE, WSSConstants.SAML.SAML20_VALUE_TYPE);
    map.put(SamlConstants.SAML_NAME_IDENTIFIER, "Alice");
    map.put(SamlConstants.SIGNATURE_REQUIRED, "true");			
    SAMLGenerateCallbackHandler callbackHandler = new
            SAMLGenerateCallbackHandler(map);				            
    callbackHandler.setWSSGenerationContextForTrustClient(gencont);
    SecurityToken samlToken = factory.newSecurityToken(SAMLToken.class, callbackHandler,
    "system.wss.generate.saml");
    
    System.out.println("SAMLToken id = " + samlToken.getId());
    1. Use o método CallService() para especificar os parâmetros de configuração de segurança de serviços da Web que são necessários para chamar um provedor de serviços da Web de destino usando um token SAML emitido automaticamente.

      O método CallService() define os parâmetros de configuração que são necessários pelo ambiente de tempo de execução Web Services Security por meio da propriedade customizada com.ibm.websphere.wssecurity.wssapi.WSSGenerationContext para gerar um SAMLToken emitido automaticamente.

      Consulte sobre a configuração de um token SAML durante a criação do token para obter informações adicionais sobre como é possível especificar propriedades de configuração para controlar como o token é configurado.

    2. Inclua o arquivo JAR Thin Client para JAX-WS no caminho de classe. Inclua o arquivo app_server_root/runtimes/com.ibm.jaxws.thinclient_8.5.0.jar no caminho da classe. Consulte as informações sobre o teste dos clientes ativados para serviços da Web para obter informações adicionais sobre como incluir esse arquivo JAR no caminho da classe.
    3. Use o método WSSFactory newSecurityToken para especificar como criar o token SAML.
      Especifique o seguinte método para criar o token SAML:
      WSSFactory  newSecurityToken(SAMLToken.class, callbackHandler, "system.wss.generate.saml")
      Criar um token SAML requer a permissão de segurança Java wssapi.SAMLTokenFactory.newSAMLToken. Use a Ferramenta de Política para incluir a seguinte instrução de política ao arquivo de política de segurança Java ou ao arquivo was.policy do aplicativo cliente:
      permission java.security.SecurityPermission "wssapi.SAMLTokenFactory.newSAMLToken

      O parâmetro SAMLToken.class especifica o tipo de token de segurança a criar.

      O objeto callbackHandler contém parâmetros que definem as características do token SAMLToken que você está criando. Esse objeto aponta para um objeto SAMLGenerateCallbackHandler que especifica os parâmetros de configuração descritos na tabela a seguir:
      Tabela 1. Propriedades SAMLGenerateCallbackHandler. Essa tabela descreve os parâmetros de configuração para o objeto SAMLGenerateCallbackHandler usando o método de confirmação de assunto de transmissão.
      Propriedade Descrição Obrigatório
      SamlConstants.CONFIRMATION_METHOD Especifica para usar o método de confirmação Bearer. Sim
      SamlConstants.TOKEN_TYPE

      Usa o valor constante, WSSConstants.SAML.SAML20_VALUE_TYPE, para especificar um tipo de token SAML 2.0.

      Quando um cliente de serviços da Web tem conexões de conjunto de políticas, essa propriedade não é usada pelos ambiente de tempo de execução da Segurança de Serviços da Web. Nesse cenário, especifique o tipo de valor de token pelo atributo valueType da configuração de ligação tokenGenerator.

      O exemplo nesse procedimento usa um token SAML 2.0; porém, também é possível usar o valor WSSConstants.SAML.SAML11_VALUE_TYPE.

      Sim
      SamlConstants.SAML_NAME_IDENTIFIER

      Especifica uma identidade de usuário como myname como o valor NameID no token SAML.

      Se você não definir esse parâmetro ao usar o Thin Client for JAX-WS, o valor NameID não conterá informações úteis.

      Se estiver usando um cliente gerenciado de serviços da Web, como um aplicativoJava Platform, Enterprise Edition (Java EE) fazendo um chamado de pedido de serviços da Web, o ambiente de tempo de execução da Segurança de Serviços da Web tenta extrair informações sobre a segurança do usuário do contexto de segurança. Da mesma forma, se você não definir esse parâmetro para um cliente de serviços da Web gerenciado, o valor NameID conterá um identificador de nome UNAUTHENTICATED.

      Essa propriedade não é usada se o seu cliente de serviços da Web possui conexões do conjunto de políticas. Leia sobre como enviar tokens SAML para saber mais sobre como enviar a identidade e os atributos do token SAML.

      Não
      SamlConstants.SIGNATURE_REQUIRED

      Especifica se o emissor deve assinar digitalmente o token SAML.

      Um valor true especifica que o emissor deve assinar digitalmente o token SAML. Esse valor é o padrão.

      Não
      O parâmetro system.wss.generate.saml especifica o módulo de login de Java Authentication and Authorization Service (JAAS) que é usado para criar o token SAML. Você deve especificar uma propriedade JVM para definir um arquivo de configuração JAAS que contém a configuração de login do JAAS necessária; por exemplo:
      -Djava.security.auth.login.config=profile_root/properties/wsjaas_client.conf 
      Alternativamente, é possível especificar um arquivo de configuração de login do JAAS definindo uma propriedade do sistema Java no código do cliente de amostra; por exemplo:
      System.setProperty("java.security.auth.login.config", "profile_root/properties/wsjaas_client.conf");
    4. Obtenha o identificador de token do token SAML criado.
      Use a seguinte instrução como um teste simples para o token SAML que você criou:
      System.out.println("SAMLToken id = " + samlToken.getId())
  5. Inclua o token SAML no cabeçalho de segurança SOAP de uma mensagem de pedido de serviços da Web.
    1. Inicialize o cliente dos serviços da Web e configure as propriedades SOAPAction. O seguinte fragmento de código ilustra essas ações:
      // Inicializar o cliente de serviços da Web
      EchoService12PortProxy echo = new EchoService12PortProxy();
      echo._getDescriptor().setEndpoint(endpointURL);
      
      // Configurar propriedades SOAPAction
      BindingProvider bp = (BindingProvider) (echo._getDescriptor().getProxy());
      Map<String, Object> requestContext = bp.getRequestContext();
      requestContext.put(BindingProvider.ENDPOINT_ADDRESS_PROPERTY, endpointURL);
      requestContext.put(BindingProvider.SOAPACTION_USE_PROPERTY,	Boolean.TRUE);
      requestContext.put(BindingProvider.SOAPACTION_URI_PROPERTY, "echoOperation");
      			
    2. Inicializar o WSSGenerationContext. O código a seguir ilustra o uso da interface WSSGenerationContext para inicializar um contexto de geração e possibilitar que você insira o SAMLToken na mensagem de pedido de serviços da Web:
      // Inicializar WSSGenerationContext
      WSSGenerationContext gencont = factory.newWSSGenerationContext();
      gencont.add(samlToken);	
      Especificamente, a chamada de método gencont.add(samlToken) especifica colocar o token SAML em uma mensagem de pedido. Use a Ferramenta de Política para incluir a seguinte instrução de política ao arquivo de política de segurança Java ou ao arquivo was.policy do aplicativo cliente:
       “permission javax.security.auth.AuthPermission "modifyPrivateCredentials"
    3. Inclua o elemento de registro de data e hora no cabeçalho de segurança das mensagens SOAP. O conjunto de políticas padrão SAML20 Bearer WSHTTPS requer pedidos de serviços da Web e mensagens de resposta para transportar um elemento de registro de data e hora no cabeçalho de Segurança das mensagens SOAP. No seguinte fragmento de código, a chamada do método factory.newWSSTimestamp() gera o registro de data e hora, e a chamada de método gencont.add(timestamp) especifica o registro de data e hora em uma mensagem de pedido:
      // Inclua um registro de data e hora na mensagem do pedido. 
      WSSTimestamp timestamp = factory.newWSSTimestamp();
      gencont.add(timestamp);
      	        
      gencont.process(requestContext);
    4. Conecte o objeto WSSGenerationContext ao objeto RequestContext dos serviços da Web. O objeto WSSGenerationContext agora contém as informações de segurança que são necessárias para formatar uma mensagem de pedido. A chamada de método gencont.process(requestContext) conecta o objeto WSSGenerationContext ao objeto RequestContext dos serviços da Web para possibilitar ao ambiente de tempo de execução da Segurança de Serviços da Web formatar o cabeçalho de segurança SOAP necessário; por exemplo:
      // Conecta o objeto WSSGenerationContext ao objeto RequestContext dos serviços da Web. 
      gencont.process(requestContext);
    5. Especifica a proteção de mensagem de nível de transporte SSL usando as propriedades JVM.
      O conjunto de políticas padrão SAML20 Bearer WSHTTPS requer proteção de mensagem de nível de transporte usando SSL. Especifique a proteção de mensagem de nível de transporte SSL usando a seguinte propriedade JVM:
      -Dcom.ibm.SSL.ConfigURL=file:profile_root\properties\ssl.client.props
      Alternativamente, é possível definir o arquivo de configuração SSL usando uma propriedade do sistema Java no código do cliente de amostra; por exemplo:
      System.setProperty("com.ibm.SSL.ConfigURL", "file:profile_root/properties/ssl.client.props");

Resultados

Você criou um token SAML autoemitido com o método de confirmação de assunto de acesso e, em seguida, envie este token com mensagens de solicitação de serviços da web usando o modelo de programação JAX-WS e as APIs WSS.

Exemplo

A amostra de código a seguir é um aplicativo cliente de serviço da web que demonstra como criar um token SAML autoemitido e enviar esse token SAML em mensagens de solicitação de serviços da web. Se o seu cenário de uso necessitar de tokens SAML, mas não necessitar que o seu aplicativo passe os tokens SAML usando mensagens de serviços da Web, você apenas precisa usar a primeira parte do seguinte código de amostra, a partir da seção // Inicializar cliente dos serviços da Web.

/**
 * The following source code is sample code created by IBM Corporation.
 * This sample code is provided to you solely for the purpose of assisting you in the
 * da tecnologia.  The code is provided 'AS IS', without warranty or condition of
 * nenhum tipo.  IBM shall not be liable for any damages arising out of your use of the
 * código de amostra, mesmo se a IBM tiver sido avisada da possibilidade de tais danos.
 */

package com.ibm.was.wssample.sei.cli;

import com.ibm.was.wssample.sei.echo.EchoService12PortProxy;
import com.ibm.was.wssample.sei.echo.EchoStringInput;

import com.ibm.websphere.wssecurity.wssapi.WSSFactory;
import com.ibm.websphere.wssecurity.wssapi.WSSGenerationContext;
import com.ibm.websphere.wssecurity.wssapi.WSSConsumingContext;
import com.ibm.websphere.wssecurity.wssapi.WSSTimestamp;
import com.ibm.websphere.wssecurity.callbackhandler.SAMLGenerateCallbackHandler;
import com.ibm.websphere.wssecurity.wssapi.token.SAMLToken;
import com.ibm.websphere.wssecurity.wssapi.token.SecurityToken;
import com.ibm.wsspi.wssecurity.core.token.config.WSSConstants;
import com.ibm.wsspi.wssecurity.saml.config.SamlConstants;

import java.util.Map;
import java.util.HashMap;

import javax.xml.ws.BindingProvider;

/**
 * SampleClient
 * ponto de entrada principal para amostra JAR thin client
 * e classe do trabalhador para se comunicar com os serviços
 */
public class SampleClient {

  private String urlHost = "localhost";
  private String urlPort = "9443";
  private static final String CONTEXT_BASE = "/WSSampleSei/";
  private static final String ECHO_CONTEXT12 = CONTEXT_BASE+"EchoService12";
  private String message = "HELLO";
  private String uriString = "https://" + urlHost + ":" + urlPort;
  private String endpointURL = uriString + ECHO_CONTEXT12;
  private String input = message;

  /**
   * main()
   * 
   * consulte printusage() para argumentos de linha de comandos
   * 
   * @param args
   */
  public static void main(String[] args) {
    SampleClient sample = new SampleClient();
    sample.CallService();
  }

  /**
   * Os CallService Parms já foram lidos. Agora chame as classes proxy do serviço
   * 
   */
  anular CallService() {
    Resposta de sequência = "ERROR!:";
    try {
      System.setProperty("java.security.auth.login.config", "profile_root/properties/wsjaas_client.conf ");
      System.setProperty("com.ibm.SSL.ConfigURL", "file:profile_root/properties/ssl.client.props");

      // Initialize WSSFactory object
      WSSFactory factory = WSSFactory.getInstance();
      // Inicializar WSSGenerationContext
      WSSGenerationContext gencont = factory.newWSSGenerationContext();
      // Initialize SAML issuer configuration via custom properties
      HashMap<Object, Object> customProps = new HashMap<Object,Object>();

      customProps.put(SamlConstants.ISSUER_URI_PROP, "example.com");
      customProps.put(SamlConstants.TTL_PROP, "3600000");
      customProps.put(SamlConstants.KS_PATH_PROP, "keystores/saml-provider.jceks");
      customProps.put(SamlConstants.KS_TYPE_PROP, "JCEKS");
      customProps.put(SamlConstants.KS_PW_PROP, "{xor}LCswLTovPiws");
      customProps.put(SamlConstants.KEY_ALIAS_PROP, "samlissuer");
      customProps.put(SamlConstants.KEY_NAME_PROP, "CN=SAMLIssuer, O=EXAMPLE");
      customProps.put(SamlConstants.KEY_PW_PROP, "{xor}NDomLz4sLA==");
      customProps.put(SamlConstants.TS_PATH_PROP, "keystores/saml-provider.jceks");
      customProps.put(SamlConstants.TS_TYPE_PROP, "JCEKS");
      customProps.put(SamlConstants.TS_PW_PROP, "{xor}LCswLTovPiws");
      gencont.add(customProps); //Add custom properties

      // Create SAMLToken
      HashMap<Object, Object> map = new HashMap<Object, Object>();
      map.put(SamlConstants.CONFIRMATION_METHOD, "Bearer");
      map.put(SamlConstants.TOKEN_TYPE, WSSConstants.SAML.SAML20_VALUE_TYPE);
      map.put(SamlConstants.SAML_NAME_IDENTIFIER, "Alice");
      map.put(SamlConstants.SIGNATURE_REQUIRED, "true");
      SAMLGenerateCallbackHandler callbackHandler = new
        SAMLGenerateCallbackHandler(map);

      SecurityToken samlToken = factory.newSecurityToken(SAMLToken.class, callbackHandler, "system.wss.generate.saml");

      System.out.println("SAMLToken id = " + samlToken.getId());

      // Inicializar o cliente de serviços da Web
      EchoService12PortProxy echo = new EchoService12PortProxy();
      echo._getDescriptor().setEndpoint(endpointURL);

      // Configurar propriedades SOAPAction
      BindingProvider bp = (BindingProvider) (echo._getDescriptor().getProxy());
      Map<String, Object> requestContext = bp.getRequestContext();
      requestContext.put(BindingProvider.ENDPOINT_ADDRESS_PROPERTY, endpointURL);
      requestContext.put(BindingProvider.SOAPACTION_USE_PROPERTY, Boolean.TRUE);
      requestContext.put(BindingProvider.SOAPACTION_URI_PROPERTY, "echoOperation");

      gencont.add(samlToken);

      // Incluir registro de data e hora
      WSSTimestamp timestamp = factory.newWSSTimestamp();
      gencont.add(timestamp);

      gencont.process(requestContext);

      // Construir o objeto de entrada
      EchoStringInput echoParm = 
        new com.ibm.was.wssample.sei.echo.ObjectFactory().createEchoStringInput();
      echoParm.setEchoInput(input);
      System.out.println(">> CLIENT: SEI Echo to " + endpointURL);

      // Prepare to consume timestamp in response message.
      WSSConsumingContext concont = factory.newWSSConsumingContext();
      concont.add(WSSConsumingContext.TIMESTAMP); 
      concont.process(requestContext);

      // Chamar o serviço
      response = echo.echoOperation(echoParm).getEchoResponse();

      System.out.println(">> CLIENT: SEI Echo invocation complete.");
      System.out.println(">> CLIENT: SEI Echo response is: " + response);
    } catch (Exception e) {
      System.out.println(">> CLIENT: ERROR: SEI Echo EXCEPTION.");
      e.printStackTrace();
    }
  }
}
Quando essa amostra de aplicativo de cliente de serviços da Web executa corretamente, você recebe mensagens como as seguintes:
SAMLToken id = _191EBC44865015D9AB1270745072344
Recuperando documento em'file:profile_root/.../wsdl/'.
>> CLIENT: SEI Echo to https://localhost:9443/WSSampleSei/EchoService12
>> CLIENT: SEI Echo invocation complete.
>> CLIENT: SEI Echo response is: SOAP12==>>HELLO

Ícone que indica o tipo de tópico Tópico de Tarefa



Ícone de registro de data e hora Última atualização: last_date
http://www14.software.ibm.com/webapp/wsbroker/redirect?version=cord&product=was-nd-mp&topic=twbs_configsamlbearer_usingwssapi
Nome do arquivo: twbs_configsamlbearer_usingwssapi.html