Menginstal dan mengonfigurasi Apigee Apigee

Untuk menginstal dan mengonfigurasi modul SSO Apigee dengan IDP eksternal, Anda harus melakukan tindakan berikut ini:

  1. Membuat kunci dan sertifikat TLS: Modul SSO Apigee menggunakan TLS untuk mengamankan transmisi informasi dengan dukungan eksternal entitas.
  2. Siapkan konfigurasi SSO Apigee dasar: file dasar harus menyertakan properti yang umum untuk semua konfigurasi SSO.
  3. Tambahkan properti konfigurasi khusus IDP: Gunakan salah satu opsi berikut Blok properti konfigurasi khusus IDP di file konfigurasi Anda:
  4. Instal SSO Apigee: Instal modul SSO Apigee, lalu teruskan file konfigurasi ke {i>installer<i}.

Setiap langkah ini dijelaskan di bagian berikut.

Membuat sertifikat dan kunci TLS

Bagian ini menjelaskan cara membuat sertifikat yang ditandatangani sendiri, yang mungkin tidak masalah bagi Anda lingkungan pengujian tetapi Anda harus menggunakan sertifikat yang ditandatangani oleh {i>Certificate Authority<i} (CA) untuk lingkungan production.

Untuk membuat kunci verifikasi dan penandatanganan serta sertifikat yang ditandatangani sendiri:

  1. Sebagai pengguna sudo, buat direktori baru berikut: 
    sudo mkdir -p /opt/apigee/customer/application/apigee-sso/jwt-keys
  2. Ubah ke direktori baru: 
    cd /opt/apigee/customer/application/apigee-sso/jwt-keys/
  3. Buat kunci pribadi dengan perintah berikut: 
    sudo openssl genrsa -out privkey.pem 2048
  4. Buat kunci publik dari kunci pribadi dengan perintah berikut: 
    sudo openssl rsa -pubout -in privkey.pem -out pubkey.pem
  5. Ubah pemilik file PEM output menjadi "apigee" pengguna: 
    sudo chown apigee:apigee *.pem

Untuk membuat kunci dan sertifikat yang ditandatangani sendiri, tanpa frasa sandi, untuk berkomunikasi dengan IDP:

  1. Sebagai pengguna sudo, buat direktori baru: 
    sudo mkdir -p /opt/apigee/customer/application/apigee-sso/idp/
  2. Ubah ke direktori baru: 
    cd /opt/apigee/customer/application/apigee-sso/idp/
  3. Buat kunci pribadi Anda dengan frasa sandi: 
    sudo openssl genrsa -aes256 -out server.key 1024
  4. Hapus frasa sandi dari kunci: 
    sudo openssl rsa -in server.key -out server.key
  5. Membuat permintaan penandatanganan sertifikat untuk CA: 
    sudo openssl req -x509 -sha256 -new -key server.key -out server.csr
  6. Buat sertifikat yang ditandatangani sendiri dengan masa berlaku 365 hari: 
    sudo openssl x509 -sha256 -days 365 -in server.csr -signkey server.key -out selfsigned.crt
  7. Ubah pemilik kunci dan file crt ke "apigee" pemilik: 
    sudo chown apigee:apigee server.key
sudo chown apigee:apigee selfsigned.crt

Untuk mengaktifkan TLS pada modul SSO Apigee, dengan menetapkan SSO_TOMCAT_PROFILE ke SSL_TERMINATION atau ke SSL_PROXY, Anda tidak dapat menggunakan sertifikat yang ditandatangani sendiri. Anda harus membuat dari CA. Lihat Mengonfigurasi SSO Apigee untuk akses HTTPS untuk informasi selengkapnya.

Setelan konfigurasi SSO Apigee

Sebelum dapat menginstal modul SSO Apigee, Anda harus menentukan file konfigurasi. Anda lulus ini ke penginstal saat Anda menginstal modul SSO Apigee.

File konfigurasi memiliki bentuk berikut:

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

Properti konfigurasi SSO SAML

Jika Anda menggunakan SAML untuk IDP, gunakan blok properti konfigurasi berikut dalam file konfigurasi (ditentukan di atas):

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

Properti konfigurasi LDAP Direct Binding

Jika Anda menggunakan binding langsung LDAP untuk IDP, gunakan blok konfigurasi berikut di file konfigurasi Anda, seperti yang ditunjukkan dalam contoh di atas: 

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

Properti konfigurasi Binding Tidak Langsung LDAP

Jika Anda menggunakan binding tidak langsung LDAP untuk IDP, gunakan blok konfigurasi berikut di file konfigurasi Anda, seperti yang ditunjukkan dalam contoh di atas: 

## 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
 # Nama atribut yang digunakan oleh server LDAP untuk merujuk ke alamat email pengguna; misalnya, "email" SSO_LDAP_MAIL_ATTRIBUTE=LDAP_email_attribute

Menginstal modul SSO Apigee

Setelah membuat kunci dan menyiapkan file konfigurasi, Anda dapat menginstal Apigee modul SSO.

Untuk menginstal modul SSO Apigee:

  1. Login ke node Server Pengelolaan. {i>Node<i} itu seharusnya sudah memiliki apigee-service diinstal, seperti yang dijelaskan di Instal utilitas Edge apigee-setup.

    Atau, Anda dapat menginstal modul SSO Apigee pada node yang berbeda. Namun, {i>node<i} tersebut harus dapat mengakses Server Pengelolaan melalui porta 8080.

  2. Instal dan konfigurasi apigee-sso dengan menjalankan perintah berikut: 
    /opt/apigee/apigee-setup/bin/setup.sh -p sso -f configFile

    Dengan configFile adalah file konfigurasi yang Anda tentukan di atas.

  3. Instal utilitas apigee-ssoadminapi.sh yang digunakan untuk mengelola admin dan komputer untuk modul apigee-sso: 
    /opt/apigee/apigee-service/bin/apigee-service apigee-ssoadminapi install
  4. Logout dari shell, lalu login kembali untuk menambahkan apigee-ssoadminapi.sh {i>utilitas<i} ke jalur Anda.

Menentukan file metadata, bukan URL

Jika IDP Anda tidak mendukung URL metadata HTTP/HTTPS, Anda dapat menggunakan file XML metadata untuk dan mengonfigurasi SSO Apigee.

Untuk menggunakan file metadata, bukan URL, untuk mengonfigurasi SSO Apigee:

  1. Salin konten XML metadata dari IDP Anda ke file di node SSO Apigee. Sebagai misalnya, salin XML ke: 
    /opt/apigee/customer/application/apigee-sso/saml/metadata.xml
  2. Ubah kepemilikan file XML ke "apigee" pengguna: 
    chown apigee:apigee /opt/apigee/customer/application/apigee-sso/saml/metadata.xml
  3. Tetapkan nilai SSO_SAML_IDP_METADATA_URL ke jalur file absolut: 
    SSO_SAML_IDP_METADATA_URL=file:///opt/apigee/customer/application/apigee-sso/saml/metadata.xml

    Anda harus memberi awalan "file://" ke jalur file, diikuti dengan jalur absolut dari {i>root<i} (/).