Skip to main content

Enabling encrypted assertions

You can improve your GitHub Enterprise Server instance's security with SAML single sign-on (SSO) by encrypting the messages that your SAML identity provider (IdP) sends.

Who can use this feature

Site administrators can configure encrypted assertions for a GitHub Enterprise Server instance.

About encrypted assertions

If your IdP support encryption of assertions, you can configure encrypted assertions on GitHub Enterprise Server for increased security during the authentication process.

Prerequisites

To enable encrypted assertions for authentication to GitHub Enterprise Server, you must configure SAML authentication, and your IdP must support encrypted assertions.

Enabling encrypted assertions

To enable encrypted assertions, you must provide your GitHub Enterprise Server instance's public certificate to your IdP, and configure encryption settings that match your IdP.

Note: GitHub strongly recommends that you verify any new configuration for authentication in a staging environment. An incorrect configuration could result in downtime for your GitHub Enterprise Server instance. For more information, see "Setting up a staging instance."

  1. Optionally, enable SAML debugging. SAML debugging records verbose entries in GitHub Enterprise Server's authentication log, and may help you troubleshoot failed authentication attempts. For more information, see "Troubleshooting SAML authentication."

  2. Em uma conta administrativa no GitHub Enterprise Server, no canto superior direito de qualquer página, clique em .

    Captura de tela do ícone de foguete para acesso às configurações de administração do site

  3. Se você ainda não estiver na página "Administração do site", no canto superior esquerdo, clique em Administração do site.

    Captura de tela do link "Administração do site"

  4. Na barra lateral à esquerda, clique em Console de Gerenciamento . Guia Console de Gerenciamento na barra lateral esquerda

  5. Na barra lateral esquerda, clique em Autenticação. Guia Autenticação na barra lateral de configurações

  6. Select Require encrypted assertions.

    Screenshot of "Enable encrypted assertions" checkbox within management console's "Authentication" section

  7. To the right of "Encryption Certificate", click Download to save a copy of your GitHub Enterprise Server instance's public certificate on your local machine.

    Screenshot of "Download" button for public certificate for encrypted assertions

  8. Sign into your SAML IdP as an administrator.

  9. In the application for your GitHub Enterprise Server instance, enable encrypted assertions.

    • Note the encryption method and key transport method.
    • Provide the public certificate you downloaded in step 7.
  10. Return to the management console on your GitHub Enterprise Server instance.

  11. To the right of "Encryption Method", select the encryption method for your IdP from step 9.

    Screenshot of "Encryption Method" for encrypted assertions

  12. To the right of "Key Transport Method", select the key transport method for your IdP from step 9.

    Screenshot of "Key Transport Method" for encrypted assertions

  13. Click Save settings.

  14. Aguarde a conclusão da execução de suas configurações.

    Configurar a instância

If you enabled SAML debugging to test authentication with encrypted assertions, disable SAML debugging when you're done testing. For more information, see "Troubleshooting SAML authentication."