Skip to main content
O português é fornecido por meio de tradução automática para sua conveniência. O inglês precede o português em caso de inconsistências.

Use a API se o logon único estiver habilitado (PingFederate)

PDFs

Se você tem"configurou e habilitou o logon único (SSO)" e você usa o PingFederate como provedor de SSO, você deve emitir uma série de solicitações de API para obter um token de autenticação válido para a API de gerenciamento de grade ou a API de gerenciamento de locatários.

Sign in na API se o logon único estiver habilitado

Estas instruções se aplicam se você estiver usando o PingFederate como provedor de identidade SSO

Antes de começar

  • Você sabe o nome de usuário e a senha do SSO para um usuário federado que pertence a um grupo de usuários do StorageGRID .

  • Se você quiser acessar a API de gerenciamento de locatários, saiba o ID da conta do locatário.

Sobre esta tarefa

Para obter um token de autenticação, você pode usar um dos seguintes exemplos:

  • O storagegrid-ssoauth.py Script Python, que está localizado no diretório de arquivos de instalação do StorageGRID(./rpms para Red Hat Enterprise Linux, ./debs para Ubuntu ou Debian, e ./vsphere para VMware).

  • Um exemplo de fluxo de trabalho de solicitações curl.

    O fluxo de trabalho do curl pode expirar se você o executar muito lentamente. Você pode ver o erro: A valid SubjectConfirmation was not found on this Response .

    Observação O fluxo de trabalho curl de exemplo não protege a senha de ser vista por outros usuários.

    Se você tiver um problema de codificação de URL, poderá ver o erro: Unsupported SAML version .

Passos

  1. Selecione um dos seguintes métodos para obter um token de autenticação:

    • Use o storagegrid-ssoauth.py Script Python. Vá para o passo 2.

    • Use solicitações curl. Vá para a etapa 3.

  2. Se você quiser usar o storagegrid-ssoauth.py script, passe o script para o interpretador Python e execute o script.

    Quando solicitado, insira valores para os seguintes argumentos:

    • O método SSO. Você pode inserir qualquer variação de "pingfederate" (PINGFEDERATE, pingfederate e assim por diante).

    • O nome de usuário do SSO

    • O domínio onde o StorageGRID está instalado. Este campo não é usado para PingFederate. Você pode deixar em branco ou inserir qualquer valor.

    • O endereço para StorageGRID

    • O ID da conta do locatário, se você quiser acessar a API de gerenciamento de locatários.

      Script de autenticação SSO para Ping Federate

    O token de autorização StorageGRID é fornecido na saída. Agora você pode usar o token para outras solicitações, de forma semelhante a como usaria a API se o SSO não estivesse sendo usado.

  3. Se você quiser usar solicitações curl, use o seguinte procedimento.

    1. Declare as variáveis necessárias para fazer login.

      export SAMLUSER='my-sso-username'
export SAMLPASSWORD='my-password'
export TENANTACCOUNTID='12345'
export STORAGEGRID_ADDRESS='storagegrid.example.com'
      Observação Para acessar a API de gerenciamento de grade, use 0 como TENANTACCOUNTID .

    2. Para receber uma URL de autenticação assinada, emita uma solicitação POST para /api/v3/authorize-saml e remova a codificação JSON adicional da resposta.

      Este exemplo mostra uma solicitação POST para uma URL de autenticação assinada para TENANTACCOUNTID. Os resultados serão passados para python -m json.tool para remover a codificação JSON.

      curl -X POST "https://$STORAGEGRID_ADDRESS/api/v3/authorize-saml" \
  -H "accept: application/json" -H  "Content-Type: application/json" \
  --data "{\"accountId\": \"$TENANTACCOUNTID\"}" | python -m json.tool

      A resposta para este exemplo inclui uma URL assinada que é codificada por URL, mas não inclui a camada adicional de codificação JSON.

      {
    "apiVersion": "3.0",
    "data": "https://my-pf-baseurl/idp/SSO.saml2?...",
    "responseTime": "2018-11-06T16:30:23.355Z",
    "status": "success"
}

    3. Salve o SAMLRequest da resposta para uso em comandos subsequentes.

      export SAMLREQUEST="https://my-pf-baseurl/idp/SSO.saml2?..."

    4. Exporte a resposta e o cookie e faça eco da resposta:

      RESPONSE=$(curl -c - "$SAMLREQUEST")
      echo "$RESPONSE" | grep 'input type="hidden" name="pf.adapterId" id="pf.adapterId"'

    5. Exporte o valor 'pf.adapterId' e repita a resposta:

      export ADAPTER='myAdapter'
      echo "$RESPONSE" | grep 'base'

    6. Exporte o valor 'href' (remova a barra final /) e repita a resposta:

      export BASEURL='https://my-pf-baseurl'
      echo "$RESPONSE" | grep 'form method="POST"'

    7. Exporte o valor 'action':

      export SSOPING='/idp/.../resumeSAML20/idp/SSO.ping'

    8. Enviar cookies junto com as credenciais:

      curl -b <(echo "$RESPONSE") -X POST "$BASEURL$SSOPING" \
--data "pf.username=$SAMLUSER&pf.pass=$SAMLPASSWORD&pf.ok=clicked&pf.cancel=&pf.adapterId=$ADAPTER" --include

    9. Salve o SAMLResponse do campo oculto:

      export SAMLResponse='PHNhbWxwOlJlc3BvbnN...1scDpSZXNwb25zZT4='

    10. Usando o salvo SAMLResponse , faça um StorageGRID/api/saml-response solicitação para gerar um token de autenticação StorageGRID .

      Para RelayState , use o ID da conta do locatário ou use 0 se quiser fazer login na API de gerenciamento de grade.

      curl -X POST "https://$STORAGEGRID_ADDRESS:443/api/saml-response" \
  -H "accept: application/json" \
  --data-urlencode "SAMLResponse=$SAMLResponse" \
  --data-urlencode "RelayState=$TENANTACCOUNTID" \
  | python -m json.tool

      A resposta inclui o token de autenticação.

    {
    "apiVersion": "3.0",
    "data": "56eb07bf-21f6-40b7-af0b-5c6cacfb25e7",
    "responseTime": "2018-11-07T21:32:53.486Z",
    "status": "success"
}

    1. Salve o token de autenticação na resposta como MYTOKEN .

      export MYTOKEN="56eb07bf-21f6-40b7-af0b-5c6cacfb25e7"

      Agora você pode usar MYTOKEN para outras solicitações, semelhante a como você usaria a API se o SSO não estivesse sendo usado.

Sair da API se o logon único estiver habilitado

Se o logon único (SSO) estiver habilitado, você deverá emitir uma série de solicitações de API para sair da API de gerenciamento de grade ou da API de gerenciamento de locatários. Estas instruções se aplicam se você estiver usando o PingFederate como provedor de identidade SSO

Sobre esta tarefa

Se necessário, você pode sair da API do StorageGRID efetuando logout na página de logout única da sua organização. Ou você pode acionar o logout único (SLO) do StorageGRID, o que requer um token portador do StorageGRID válido.

Passos

  1. Para gerar uma solicitação de logout assinada, passe `cookie "sso=true" para a API SLO:

    curl -k -X DELETE "https://$STORAGEGRID_ADDRESS/api/v3/authorize" \
-H "accept: application/json" \
-H "Authorization: Bearer $MYTOKEN" \
--cookie "sso=true" \
| python -m json.tool

    Um URL de logout é retornado:

    {
    "apiVersion": "3.0",
    "data": "https://my-ping-url/idp/SLO.saml2?SAMLRequest=fZDNboMwEIRfhZ...HcQ%3D%3D",
    "responseTime": "2021-10-12T22:20:30.839Z",
    "status": "success"
}

  2. Salve o URL de logout.

    export LOGOUT_REQUEST='https://my-ping-url/idp/SLO.saml2?SAMLRequest=fZDNboMwEIRfhZ...HcQ%3D%3D'

  3. Envie uma solicitação para o URL de logout para acionar o SLO e redirecionar de volta para o StorageGRID.

    curl --include "$LOGOUT_REQUEST"

    A resposta 302 é retornada. O local de redirecionamento não se aplica ao logout somente da API.

    HTTP/1.1 302 Found
Location: https://$STORAGEGRID_ADDRESS:443/api/saml-logout?SAMLResponse=fVLLasMwEPwVo7ss%...%23rsa-sha256
Set-Cookie: PF=QoKs...SgCC; Path=/; Secure; HttpOnly; SameSite=None

  4. Exclua o token portador do StorageGRID .

    A exclusão do token portador do StorageGRID funciona da mesma forma que sem o SSO. Se `cookie "sso=true" não for fornecido, o usuário será desconectado do StorageGRID sem afetar o estado do SSO.

    curl -X DELETE "https://$STORAGEGRID_ADDRESS/api/v3/authorize" \
-H "accept: application/json" \
-H "Authorization: Bearer $MYTOKEN" \
--include

    UM 204 No Content a resposta indica que o usuário está desconectado.

    HTTP/1.1 204 No Content