Apigee TOA'yı yükleme ve yapılandırma

Apigee SSO modülünü harici bir IDP ile yüklemek ve yapılandırmak için aşağıdakileri yapmanız gerekir:

  1. TLS anahtarlarını ve sertifikalarını oluşturun: Apigee TOA modülü, harici varlıklarla bilgi aktarımının güvenliğini sağlamak için TLS kullanır.
  2. Temel Apigee TOA yapılandırmasını ayarlama: Temel dosya, tüm TOA yapılandırmalarında ortak olan özellikleri içermelidir.
  3. IdP'ye özel yapılandırma özellikleri ekleyin: Yapılandırma dosyanızda IdP'ye özel aşağıdaki yapılandırma özelliği bloklarından birini kullanın:
  4. Apigee TOA'yı yükleme: Apigee TOA modülünü yükleyin ve yapılandırma dosyasını yükleyiciye iletin.

Bu adımların her biri sonraki bölümlerde açıklanmıştır.

TLS anahtarlarını ve sertifikalarını oluşturma

Bu bölümde, test ortamınız için uygun olabilecek kendinden imzalı sertifikaların nasıl oluşturulacağı açıklanmaktadır. Ancak üretim ortamı için bir Sertifika Yetkilisi (CA) tarafından imzalanmış sertifikalar kullanmanız gerekir.

Doğrulama ve imzalama anahtarı ile kendinden imzalı sertifika oluşturmak için:

  1. Sudo kullanıcısı olarak aşağıdaki yeni dizini oluşturun:
    sudo mkdir -p /opt/apigee/customer/application/apigee-sso/jwt-keys
  2. Yeni dizine geçin:
    cd /opt/apigee/customer/application/apigee-sso/jwt-keys/
  3. Aşağıdaki komutla özel anahtarı oluşturun:
    sudo openssl genrsa -out privkey.pem 2048
  4. Aşağıdaki komutu kullanarak özel anahtardan ortak anahtar oluşturun:
    sudo openssl rsa -pubout -in privkey.pem -out pubkey.pem
  5. Çıkış PEM dosyasının sahibini "apigee" kullanıcısı olarak değiştirin:
    sudo chown apigee:apigee *.pem

Kimlik sağlayıcı ile iletişim kurmak için parola olmadan anahtar ve kendinden imzalı sertifika oluşturmak istiyorsanız:

  1. Sudo kullanıcısı olarak yeni bir dizin oluşturun:
    sudo mkdir -p /opt/apigee/customer/application/apigee-sso/idp/
  2. Yeni dizine geçin:
    cd /opt/apigee/customer/application/apigee-sso/idp/
  3. Özel anahtarınızı bir parola ile oluşturun:
    sudo openssl genrsa -aes256 -out server.key 1024
  4. Anahtardan parolayı kaldırın:
    sudo openssl rsa -in server.key -out server.key
  5. CA için sertifika imzalama isteği oluşturun:
    sudo openssl req -x509 -sha256 -new -key server.key -out server.csr
  6. 365 gün geçerlilik süresi olan kendinden imzalı sertifika oluşturun:
    sudo openssl x509 -sha256 -days 365 -in server.csr -signkey server.key -out selfsigned.crt
  7. Anahtar ve crt dosyasının sahibini "apigee" sahibi olarak değiştirin:
    sudo chown apigee:apigee server.key
    sudo chown apigee:apigee selfsigned.crt

SSO_TOMCAT_PROFILE değerini SSL_TERMINATION veya SSL_PROXY olarak ayarlayarak Apigee TOA modülünde TLS'yi etkinleştirmek için kendinden imzalı bir sertifika kullanamazsınız. Bir CA'dan sertifika oluşturmanız gerekir. Daha fazla bilgi için HTTPS erişimi için Apigee TOA'yı yapılandırma başlıklı makaleyi inceleyin.

Apigee TOA yapılandırma ayarları

Apigee TOA modülünü yükleyebilmek için bir yapılandırma dosyası tanımlamanız gerekir. Apigee TOA modülünü yüklerken bu yapılandırma dosyasını yükleyiciye iletirsiniz.

Yapılandırma dosyası aşağıdaki biçimdedir:

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>"

SAML TOA yapılandırma özellikleri

IdP'niz için SAML kullanıyorsanız yapılandırma dosyanızda (yukarıda tanımlanmıştır) aşağıdaki yapılandırma özellikleri bloğunu kullanın:

## 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

LDAP doğrudan bağlama yapılandırma özellikleri

IdP'niz için LDAP doğrudan bağlamayı kullanıyorsanız yapılandırma dosyanızda aşağıdaki yapılandırma özellikleri bloğunu kullanın (yukarıdaki örnekte gösterildiği gibi):

## 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

LDAP dolaylı bağlama yapılandırma özellikleri

IdP'niz için LDAP dolaylı bağlama kullanıyorsanız yapılandırma dosyanızda aşağıdaki yapılandırma özellikleri bloğunu kullanın (yukarıdaki örnekte gösterildiği gibi):

## 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
# LDAP sunucusunun kullanıcının e-posta adresine referans vermek için kullandığı özellik adı; örneğin, "mail" SSO_LDAP_MAIL_ATTRIBUTE=LDAP_email_attribute

Apigee TOA modülünü yükleme

Anahtarları oluşturup yapılandırma dosyanızı ayarladıktan sonra Apigee TOA modülünü yükleyebilirsiniz.

Apigee SSO modülünü yüklemek için:

  1. Yönetim Sunucusu düğümüne giriş yapın. Edge apigee-setup yardımcı programını yükleme bölümünde açıklandığı gibi, bu düğümde apigee-service zaten yüklü olmalıdır.

    Alternatif olarak, Apigee TOA modülünü farklı bir düğüme yükleyebilirsiniz. Ancak bu düğümün, 8080 numaralı bağlantı noktası üzerinden Yönetim Sunucusu'na erişebilmesi gerekir.

  2. Aşağıdaki komutu çalıştırarak apigee-sso aracını yükleyip yapılandırın:
    /opt/apigee/apigee-setup/bin/setup.sh -p sso -f configFile

    configFile, yukarıda tanımladığınız yapılandırma dosyasıdır.

  3. apigee-sso modülü için yönetici ve makine kullanıcılarını yönetmek amacıyla kullanılan apigee-ssoadminapi.sh yardımcı programını yükleyin:
    /opt/apigee/apigee-service/bin/apigee-service apigee-ssoadminapi install
  4. Kabuktan çıkış yapın ve ardından apigee-ssoadminapi.sh yardımcı programını yolunuza eklemek için tekrar giriş yapın.

URL yerine meta veri dosyası belirtme

IdP'niz HTTP/HTTPS meta veri URL'sini desteklemiyorsa Apigee TOA'yı yapılandırmak için meta veri XML dosyası kullanabilirsiniz.

Apigee TOA'yı yapılandırmak için URL yerine meta veri dosyası kullanmak istiyorsanız:

  1. IDP'nizdeki meta veri XML'sinin içeriğini Apigee TOA düğümündeki bir dosyaya kopyalayın. Örneğin, XML'i şuraya kopyalayın:
    /opt/apigee/customer/application/apigee-sso/saml/metadata.xml
  2. XML dosyasının sahipliğini "apigee" kullanıcısı olarak değiştirin:
    chown apigee:apigee /opt/apigee/customer/application/apigee-sso/saml/metadata.xml
  3. SSO_SAML_IDP_METADATA_URL değerini mutlak dosya yolu olarak ayarlayın:
    SSO_SAML_IDP_METADATA_URL=file:///opt/apigee/customer/application/apigee-sso/saml/metadata.xml

    Dosya yolunun önüne "file://" eklemeniz ve ardından kökten (/) mutlak yolu eklemeniz gerekir.