Instalowanie i konfigurowanie logowania jednokrotnego w Apigee

Aby zainstalować i skonfigurować moduł logowania jednokrotnego Apigee z zewnętrznym dostawcą tożsamości, musisz wykonać te czynności:

  1. Utwórz klucze i certyfikaty TLS: moduł logowania jednokrotnego w Apigee używa protokołu TLS do zabezpieczania przesyłania informacji do jednostek zewnętrznych.
  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 specyficzne dla dostawcy tożsamości: użyj w pliku konfiguracji jednego z tych bloków właściwości konfiguracji właściwych dla dostawcy tożsamości:
  4. Zainstaluj logowanie jednokrotne w Apigee: zainstaluj moduł logowania jednokrotnego Apigee i przekaż plik konfiguracji do instalatora.

Opisujemy je w kolejnych sekcjach.

Tworzenie kluczy i certyfikatów TLS

W tej sekcji opisaliśmy, jak tworzyć samodzielnie podpisane certyfikaty, które mogą się sprawdzić w Twoim środowisku testowym, ale w środowisku produkcyjnym należy używać certyfikatów podpisanych przez urząd certyfikacji.

Aby utworzyć klucz weryfikacji i podpisywania oraz samodzielnie podpisany certyfikat:

  1. Jako użytkownik sudo utwórz ten 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 wyjściowego pliku PEM na użytkownika „apigee”:
    sudo chown apigee:apigee *.pem

Aby utworzyć klucz i samodzielnie podpisany certyfikat (bez hasła) na potrzeby komunikacji z dostawcą tożsamości:

  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, używając hasła:
    sudo openssl genrsa -aes256 -out server.key 1024
  4. Usuń z klucza hasło:
    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 certyfikat podpisany samodzielnie z upływem 365 dni:
    sudo openssl x509 -sha256 -days 365 -in server.csr -signkey server.key -out selfsigned.crt
  7. Zmień właściciela 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żyć certyfikatu podpisanego samodzielnie. Certyfikat musisz wygenerować z urzędu certyfikacji. Więcej informacji znajdziesz w artykule Konfigurowanie logowania jednokrotnego w Apigee pod kątem dostępu HTTPS.

Ustawienia konfiguracji logowania jednokrotnego w Apigee

Przed zainstalowaniem modułu logowania jednokrotnego Apigee musisz zdefiniować plik konfiguracji. Ten plik konfiguracji przekazujesz instalatorowi podczas instalacji modułu logowania jednokrotnego w Apigee.

Plik konfiguracji ma taką postać:

IP1=hostname_or_IP_of_management_server
IP2=hostname_or_IP_of_UI_and_apigge_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 w przypadku dostawcy tożsamości używasz SAML, w pliku konfiguracji (zdefiniowanym powyżej) użyj tego bloku właściwości konfiguracji:

## 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 to user when they attempt to access Edge UI.
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.19.06.12.
SSO_SAML_SIGNED_ASSERTIONS=y

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

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

## 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ązania pośredniego LDAP

Jeśli na potrzeby dostawcy tożsamości używasz pośredniego wiązania LDAP, użyj w pliku konfiguracyjnym tego bloku właściwości konfiguracji, tak jak w przykładzie powyżej:

## 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ę w węźle serwera zarządzania. W tym węźle powinien już być zainstalowany apigee-service zgodnie z opisem w sekcji Instalowanie narzędzia Edge apigee-setup.

    Możesz też zainstalować moduł logowania jednokrotnego Apigee w innym węźle. Musi on jednak 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 służące do zarządzania administratorami i użytkownikami komputera 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, by dodać do ścieżki narzędzie apigee-ssoadminapi.sh.

Określ plik metadanych zamiast adresu URL

Jeśli dostawca tożsamości nie obsługuje adresu URL metadanych HTTP/HTTPS, możesz użyć pliku XML metadanych do skonfigurowania logowania jednokrotnego w Apigee.

Aby skonfigurować logowanie jednokrotne w Apigee za pomocą pliku metadanych zamiast adresu URL:

  1. Skopiuj zawartość pliku XML metadanych od 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łasność 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 bezwzględną ścieżkę pliku:
    SSO_SAML_IDP_METADATA_URL=file:///opt/apigee/customer/application/apigee-sso/saml/metadata.xml

    Na początku ścieżki pliku musisz wpisać „file://”, a po nim ścieżkę bezwzględną od katalogu głównego (/).