Como configurar o portal para usar o SAML na comunicação com o Edge

Edge para nuvem privada v4.19.01

O portal de serviços para desenvolvedores da Apigee (ou simplesmente o portal) atua como um cliente da Apigee Edge. Isso significa que o portal não funciona como um sistema independente. Em vez disso, grande parte das informações usadas pelo portal é armazenada no Edge. Quando necessário, o portal faz uma solicitação para recuperar informações do Edge ou enviar informações para o Edge.

O portal está sempre associado a uma única organização do Edge. Ao configurar o portal, é possível especificar as credenciais de autenticação básica (nome de usuário e senha) de uma conta na organização que o portal usa para se comunicar com o Edge.

Se você optar por ativar o SAML para autenticação do Edge, poderá configurar o portal para usar a autenticação SAML ao fazer solicitações ao Edge. A configuração do portal para usar o SAML cria automaticamente uma nova conta de usuário de máquina na organização do Edge que o portal usa para fazer solicitações ao Edge. Para saber mais sobre usuários de máquina, consulte Como usar o SAML com tarefas automatizadas.

Para que o portal seja compatível com SAML, é necessário que você já tenha instalado e configurado o módulo de SSO da Edge no nó do servidor de gerenciamento da Edge. O processo geral para ativar o SAML no portal é:

  1. Configure o SAML no Edge conforme descrito em Instalação e configuração do SAML para o Edge. Observação: a autenticação básica ainda precisa estar ativada no Edge para instalar o portal. Não desative a autenticação básica no Edge até configurar o portal para usar SAML.
  2. Instale o portal e verifique se a instalação está funcionando corretamente. Consulte Como instalar o portal do Edge para nuvem privada.
  3. Configure o SAML no portal.
  4. Agora é possível desativar a autenticação básica no Edge.

Como criar um usuário de máquina para o portal

Quando o SAML está ativado, o Edge é compatível com a geração automatizada de tokens OAuth2 usando usuários de máquina. Um usuário de máquina pode receber tokens OAuth2 sem precisar especificar uma senha. Isso significa que você pode automatizar completamente o processo de obtenção e atualização de tokens OAuth2.

O processo de configuração do SAML para o portal cria automaticamente um usuário de máquina na organização associada ao portal. Em seguida, o portal usa essa conta de usuário de máquina para se conectar ao Edge. Para mais informações sobre usuários de máquina, consulte Como usar o SAML com tarefas automatizadas.

Sobre a autenticação para contas de desenvolvedor do portal

Ao configurar o portal para usar SAML, você permite que ele use SAML para autenticação com o Edge para que o portal possa fazer solicitações ao Edge. No entanto, o portal também oferece suporte a um tipo de usuário chamado desenvolvedores.

Os desenvolvedores formam a comunidade de usuários que criam apps usando suas APIs. Os desenvolvedores de apps usam o portal para Aprenda Mais sobre suas APIs, registrar apps que as usam, interagir com a comunidade de desenvolvedores e ver informações estatísticas sobre o uso do app em um painel.

Quando um desenvolvedor faz login no portal, é o portal que é responsável por autenticar o desenvolvedor e aplicar permissões baseadas em papéis. O portal continua usando a autenticação básica com os desenvolvedores mesmo depois de ativar o SAML entre o portal e o Edge. Para mais informações, consulte Como se comunicar entre o portal e o Edge.

Também é possível configurar o portal para usar o SAML para autenticar desenvolvedores. Para ver um exemplo de como ativar o SAML usando módulos do Drupal de terceiros, consulte Integração de SSO via SAML com o portal do desenvolvedor.

Configurar o SAML no portal para se comunicar com o Edge

Para configurar o SAML para o portal, crie um arquivo de configuração para configurar o portal:

# IP address of Edge Management Server and apigee-sso node.
IP1=22.222.22.222

# URL of Edge management API.
MGMT_URL=http://$IP1:8080/v1

# Org associated with the portal.
EDGE_ORG=myorg

# Information about apigee-sso.
# Externally accessible IP or DNS of apigee-sso.
SSO_PUBLIC_URL_HOSTNAME=$IP1
SSO_PUBLIC_URL_PORT=9099
# Default is http. Set to https if you enabled TLS on apigee-sso.
SSO_PUBLIC_URL_SCHEME=http

# SSO admin credentials as set when you installed apigee-sso.
SSO_ADMIN_NAME=ssoadmin
SSO_ADMIN_SECRET=Secret123

# Default is "n" to disable SAML support.
DEVPORTAL_SSO_ENABLED=y

# The name of the OAuth client used to connect to apigee-sso. 
# The default client name is portalcli.
PORTALCLI_SSO_CLIENT_NAME=portalcli
# Oauth client password using uppercase, lowercase, number, and special chars. 
PORTALCLI_SSO_CLIENT_SECRET=Abcdefg@1

# Email address and user info for the machine user created in 
# the Edge org specified above by EDGE_ORG. 
# This account is used by the portal to make requests to Edge.
# Add this email as an org admin before configuring the portal to use SAML. 
DEVPORTAL_ADMIN_EMAIL=DevPortal_SAML@google.com
DEVPORTAL_ADMIN_FIRSTNAME=DevPortal
DEVPORTAL_ADMIN_LASTNAME=SAMLAdmin
DEVPORTAL_ADMIN_PWD=Abcdefg@1

# If set, the existing portal OAuth client is deleted and new one is created.
# The default value is "n".
# Set to "y" when you configure SAML and change the value of 
# any of the PORTALCLI_* properties.
PORTALCLI_SSO_CLIENT_OVERWRITE=y

Para ativar o suporte ao SAML no portal:

  1. Na IU do Edge, adicione o usuário de máquina especificado por DEVPORTAL_ADMIN_EMAIL à organização associada ao portal como Administrador da organização.
  2. Execute o seguinte comando para configurar o SAML no portal: 
    /opt/apigee/apigee-service/bin/apigee-service apigee-drupal-devportal configure-sso -f samlConfigFile

    Em que samlConfigFile é o arquivo de configuração do SAML.

  3. Faça login no portal como administrador.
  4. No menu principal do Drupal, selecione Configuration > Dev Portal. A tela de configuração do portal será exibida, incluindo as configurações de SAML:

    Observe que a caixa Esta organização está ativada para SAML está marcada, o endpoint do módulo de SSO do Edge está preenchido, os campos Chave de API e Chave secreta do consumidor do cliente OAuth do portal estão preenchidos e a mensagem Conexão bem-sucedida aparece abaixo do botão Testar conexão.

  5. Pressione o botão Testar conexão para testar a conexão novamente a qualquer momento.

Para alterar esses valores posteriormente, atualize o arquivo de configuração e execute o comando novamente.

Desativar o SAML no portal

Se você desativar o SAML para comunicações entre o portal e o Edge, o portal não poderá mais fazer solicitações ao Edge. Os desenvolvedores podem fazer login no portal, mas não podem ver o produto nem criar apps.

Para desativar o SAML no portal:

  1. Edite o arquivo de configuração usado para configurar o SAM para definir: 
    DEVPORTAL_SSO_ENABLED=n
  2. Configure o portal: 
    /opt/apigee/apigee-service/bin/apigee-service apigee-drupal-devportal configure-sso -f configFile