Instalowanie i konfigurowanie logowania jednokrotnego w Apigee

Aby zainstalować i skonfigurować moduł logowania jednokrotnego Apigee z zewnętrznym IDP, wykonaj te czynności:

  1. Utwórz klucze i certyfikaty.
  2. Skonfiguruj podstawową konfigurację logowania jednokrotnego Apigee: plik podstawowy musi zawierać właściwości wspólne dla wszystkich konfiguracji logowania jednokrotnego.
  3. Dodaj właściwości konfiguracji związane z dostawcą tożsamości: w pliku konfiguracji użyj jednego z tych bloków właściwości konfiguracji związanych z dostawcą tożsamości:
  4. Zainstaluj logowanie jednokrotne Apigee: zainstaluj moduł Apigee SSO i przekaż plik konfiguracji do instalatora.

Każdy z tych kroków jest opisany w dalszych sekcjach.

Tworzenie kluczy i certyfikatów

W tej sekcji opisujemy, jak tworzyć samodzielnie podpisane certyfikaty, które mogą być odpowiednie w Twoim środowisku testowym, ale w środowisku produkcyjnym musisz użyć certyfikatów podpisanych przez urząd certyfikacji.

Aby utworzyć parę kluczy i podpisać ją w celu weryfikacji:

  1. Jako użytkownik sudo utwórz nowy katalog: 
    sudo mkdir -p /opt/apigee/customer/application/apigee-sso/jwt-keys
  2. Przejdź do nowego katalogu: 
    cd /opt/apigee/customer/application/apigee-sso/jwt-keys/
  3. Wygeneruj klucz prywatny za pomocą tego polecenia: 
    sudo openssl genrsa -out privkey.pem 2048
  4. Wygeneruj klucz publiczny z klucza prywatnego za pomocą tego polecenia: 
    sudo openssl rsa -pubout -in privkey.pem -out pubkey.pem
  5. Zmień właściciela pliku PEM na użytkownika „apigee”: 
    sudo chown apigee:apigee *.pem

Aby utworzyć klucz i certyfikat podpisany samodzielnie bez hasła, który będzie używany do komunikacji z IDP:

  1. Jako użytkownik sudo utwórz nowy katalog: 
    sudo mkdir -p /opt/apigee/customer/application/apigee-sso/idp/
  2. Przejdź do nowego katalogu: 
    cd /opt/apigee/customer/application/apigee-sso/idp/
  3. Wygeneruj klucz prywatny z hasłem: 
    sudo openssl genrsa -aes256 -out server.key 1024
  4. Usuń hasło wielowyrazowe z klucza: 
    sudo openssl rsa -in server.key -out server.key
  5. Wygeneruj żądanie podpisania certyfikatu dla urzędu certyfikacji: 
    sudo openssl req -x509 -sha256 -new -key server.key -out server.csr
  6. Wygeneruj podpisany przez siebie certyfikat z datą ważności 365 dni: 
    sudo openssl x509 -sha256 -days 365 -in server.csr -signkey server.key -out selfsigned.crt
  7. Zmień właściciela pliku klucza i pliku crt na właściciela „apigee”: 
    sudo chown apigee:apigee server.key
sudo chown apigee:apigee selfsigned.crt

Aby włączyć TLS w module logowania jednokrotnego Apigee, ustawiając SSO_TOMCAT_PROFILE na SSL_TERMINATION lub SSL_PROXY, nie możesz używać samodzielnie podpisanego certyfikatu. Musisz wygenerować certyfikat z urzędu certyfikacji. Więcej informacji znajdziesz w artykule Konfigurowanie logowania jednokrotnego w Apigee na potrzeby dostępu HTTPS.

Ustawienia konfiguracji SSO w Apigee

Zanim zainstalujesz moduł logowania jednokrotnego Apigee, musisz zdefiniować plik konfiguracji. Podczas instalowania modułu logowania jednokrotnego Apigee przekazujesz ten plik konfiguracji do instalatora.

Plik konfiguracji ma następującą postać:

IP1=hostname_or_IP_of_apigee_SSO
IP2=hostname_or_IP_of_apigee_SSO

## Management Server configuration.
# Management Server IP address and port
MSIP=$IP1
MGMT_PORT=8080
# Edge sys admin username and password as set when you installed Edge.
ADMIN_EMAIL=opdk@google.com
APIGEE_ADMINPW=Secret123
# Set the protocol for the Edge management API. Default is http.
# Set to https if you enabled TLS on the management API.
MS_SCHEME=http

## Postgres configuration.
# Postgres IP address and port
PG_HOST=$IP1
PG_PORT=5432
# Postgres username and password as set when you installed Edge.
PG_USER=apigee
PG_PWD=postgres

## Apigee SSO module configuration.
# Choose either "saml" or "ldap".
SSO_PROFILE="[saml|ldap]"
# Externally accessible IP or DNS name of apigee-sso.
SSO_PUBLIC_URL_HOSTNAME=$IP2
SSO_PG_DB_NAME=database_name_for_sso

# Default port is 9099. If changing, set both properties to the same value.
SSO_PUBLIC_URL_PORT=9099
SSO_TOMCAT_PORT=9099
# Set Tomcat TLS mode to DEFAULT to use HTTP access to apigee-sso.
SSO_TOMCAT_PROFILE=DEFAULT
SSO_PUBLIC_URL_SCHEME=http

# SSO admin user name. The default is ssoadmin.
SSO_ADMIN_NAME=ssoadmin
# SSO admin password using uppercase, lowercase, number, and special chars.
SSO_ADMIN_SECRET=Secret123

# Enable the ability to sign an authentication request with SAML SSO.
SSO_SAML_SIGN_REQUEST=y

# Path to signing key and secret from Create the TLS keys and certificates above.
SSO_JWT_SIGNING_KEY_FILEPATH=/opt/apigee/customer/application/apigee-sso/jwt-keys/privkey.pem
SSO_JWT_VERIFICATION_KEY_FILEPATH=/opt/apigee/customer/application/apigee-sso/jwt-keys/pubkey.pem

###########################################################
#                 Define External IDP                     #
# Use one of the following configuration blocks to        #
# define your IDP settings:                               #
#  - SAML configuration properties                     #
#  - LDAP Direct Binding configuration properties        #
#  - LDAP Indirect Binding configuration properties       #
###########################################################

INSERT_IDP_CONFIG_BLOCK_HERE (SAML, LDAP direct, or LDAP indirect, below)

# Configure an SMTP server so that the Apigee SSO module can send emails to users
SKIP_SMTP=n
SMTPHOST=smtp.example.com
SMTPUSER=smtp@example.com
# omit for no username
SMTPPASSWORD=smtppwd
# omit for no password
SMTPSSL=n
SMTPPORT=25
# The address from which emails are sent
SMTPMAILFROM="My Company <myco@company.com>"

Właściwości konfiguracji logowania jednokrotnego przez SAML

Jeśli używasz SAML na potrzeby dostawcy tożsamości, użyj w pliku konfiguracji tego bloku właściwości konfiguracji (zdefiniowanych powyżej):

## SAML Configuration Properties
# Insert this section into your base configuration file, as described previously.

# Name of SAML IDP. For example, okta or adfs.
SSO_SAML_IDP_NAME=okta
# Text displayed on the SSO sign-in page after being redirected by either the New or Classic Edge UI for SAML logins.
# Note: Installing SSO does not depend on the Edge UI or which version of the UI you are using.
SSO_SAML_IDP_LOGIN_TEXT="Please log in to your IDP"

# The metadata URL from your IDP.
# If you have a metadata file, and not a URL,
# see "Specifying a metadata file instead of a URL" below.
SSO_SAML_IDP_METADATA_URL=https://dev-343434.oktapreview.com/app/exkar20cl/sso/saml/metadata

# Determines whether to skip TLS validation for the URL specified
# by SSO_SAML_IDP_METADATA_URL.
# This is necessary if the URL uses a self-signed certificate.
# The default value is "n".
SSO_SAML_IDPMETAURL_SKIPSSLVALIDATION=n

# SAML service provider key and cert from Create the TLS keys and certificates above.
SSO_SAML_SERVICE_PROVIDER_KEY=/opt/apigee/customer/application/apigee-sso/saml/server.key
SSO_SAML_SERVICE_PROVIDER_CERTIFICATE=/opt/apigee/customer/application/apigee-sso/saml/selfsigned.crt

# The passphrase used when you created the SAML cert and key.
# The section "Create the TLS keys and certificates" above removes the passphrase,
# but this property is available if you require a passphrase.
# SSO_SAML_SERVICE_PROVIDER_PASSWORD=samlSP123

# Requires that SAML responses be signed by your IDP.
# This property is enabled by default since release 4.50.00.05.
SSO_SAML_SIGNED_ASSERTIONS=y

Właściwości konfiguracji bezpośredniego powiązania LDAP

Jeśli używasz bezpośredniego powiązania LDAP dla dostawcy tożsamości, użyj w pliku konfiguracji tego bloku właściwości, jak pokazano w powyższym przykładzie: 

## LDAP Direct Binding configuration
# Insert this section into your base configuration file, as described previously.

# The type of LDAP profile; in this case, "direct"
SSO_LDAP_PROFILE=direct

# The base URL to which SSO connects; in the form: "ldap://hostname_or_IP:port
SSO_LDAP_BASE_URL=LDAP_base_URL

# Attribute name used by the LDAP server to refer to the user's email address; for example, "mail"
SSO_LDAP_MAIL_ATTRIBUTE=LDAP_email_attribute

# Pattern of the user's DN; for example: =cn={0},ou=people,dc=example,dc=org
# If there is more than one pattern, separate with semicolons (";"); for example:
# =cn={0},ou=people,dc=example,dc=org;=cn={0},ou=people,dc=example,dc=com
SSO_LDAP_USER_DN_PATTERN=LDAP_DN_pattern

Właściwości konfiguracji Powiązanie pośrednie LDAP

Jeśli używasz pośredniego powiązania LDAP dla IDP, użyj w pliku konfiguracji tego bloku właściwości konfiguracji, jak pokazano w powyższym przykładzie: 

## LDAP Indirect Binding configuration
# Insert this section into your base configuration file, as described previously.

# Type of LDAP profile; in this case, "indirect"
SSO_LDAP_PROFILE=indirect

# Base URL to which SSO connects; in the form: "ldap://hostname_or_IP:port
SSO_LDAP_BASE_URL=LDAP_base_URL

# DN and password of the LDAP server's admin user
SSO_LDAP_ADMIN_USER_DN=LDAP_admin_DN
SSO_LDAP_ADMIN_PWD=LDAP_admin_password

# LDAP search base; for example, "dc=example,dc=org"
SSO_LDAP_SEARCH_BASE=LDAP_search_base

# LDAP search filter; for example, "cn={0}"
SSO_LDAP_SEARCH_FILTER=LDAP_search_filter
# Nazwa atrybutu używana przez serwer LDAP do odwoływania się do adresu e-mail użytkownika; na przykład „mail” SSO_LDAP_MAIL_ATTRIBUTE=LDAP_email_attribute

Instalowanie modułu logowania jednokrotnego Apigee

Po utworzeniu kluczy i skonfigurowaniu pliku konfiguracji możesz zainstalować moduł logowania jednokrotnego Apigee.

Aby zainstalować moduł logowania jednokrotnego Apigee:

  1. Zaloguj się na węźle serwera zarządzania. Na tym węźle powinna być już zainstalowana aplikacja apigee-service zgodnie z opisem w artykule Instalowanie narzędzia do konfiguracji apige w Edge.

    Możesz też zainstalować moduł logowania jednokrotnego Apigee na innym węźle. Jednak ten węzeł musi mieć dostęp do serwera zarządzania przez port 8080.

  2. Zainstaluj i skonfiguruj apigee-sso, wykonując to polecenie: 
    /opt/apigee/apigee-setup/bin/setup.sh -p sso -f configFile

    Gdzie configFile to plik konfiguracji zdefiniowany powyżej.

  3. Zainstaluj narzędzie apigee-ssoadminapi.sh, które służy do zarządzania użytkownikami z rolą administratora i użytkownikami maszynowymi w module apigee-sso: 
    /opt/apigee/apigee-service/bin/apigee-service apigee-ssoadminapi install
  4. Wyloguj się z powłoki, a następnie zaloguj się ponownie, aby dodać do ścieżki narzędzie apigee-ssoadminapi.sh.

Podanie pliku metadanych zamiast adresu URL

Jeśli dostawca tożsamości nie obsługuje adresu URL metadanych HTTP/HTTPS, możesz skonfigurować logowanie jednokrotne Apigee za pomocą pliku metadanych XML.

Aby skonfigurować logowanie jednokrotne w Apigee, użyj pliku metadanych zamiast adresu URL:

  1. Skopiuj zawartość pliku metadanych XML z dostawcy tożsamości do pliku w węźle logowania jednokrotnego Apigee. Na przykład skopiuj plik XML do: 
    /opt/apigee/customer/application/apigee-sso/saml/metadata.xml
  2. Zmień właściciela pliku XML na użytkownika „apigee”: 
    chown apigee:apigee /opt/apigee/customer/application/apigee-sso/saml/metadata.xml
  3. Ustaw wartość SSO_SAML_IDP_METADATA_URL na ścieżkę bezwzględną do pliku: 
    SSO_SAML_IDP_METADATA_URL=file:///opt/apigee/customer/application/apigee-sso/saml/metadata.xml

    Ścieżka pliku musi zaczynać się od znaku „file://”, a następnie musi następować ścieżka bezwzględna od katalogu głównego (/).