Private Cloud için Edge v. 4.17.01
Bu bölümde, kullanıcı kimlik doğrulaması için harici bir LDAP hizmetini Apigee Edge'e entegre etmek için gereken bileşenlerin nasıl alınacağı, yükleneceği ve yapılandırılacağı açıklanmaktadır.
Ön koşullar
- Private Cloud 4.17.01 yüklemesi için Apigee Edge'e sahip olmanız gerekir.
- Bu kurulumu gerçekleştirmek için Özel Bulut için Apigee Edge'de genel sistem yöneticisi kimlik bilgilerine sahip olmanız gerekir.
- Private Cloud için Apigee Edge kurulumunuzun kök dizini hakkında bilgi sahibi olmanız gerekir. Varsayılan kök dizin /opt'tir.
- Edge global sistem yöneticisi kimlik bilgilerinizi harici LDAP'ye eklemeniz gerekir. Varsayılan olarak, sistem yöneticisi kimlik bilgilerinin Edge'in dahili LDAP'sinde depolandığını unutmayın. Harici LDAP'ye geçtikten sonra, sistem yöneticisi kimlik bilgilerinizin doğrulanması bu LDAP'de yapılır. Bu nedenle, Edge'de harici kimlik doğrulamayı etkinleştirmeden önce kimlik bilgilerini harici sisteme sağlamanız gerekir.
Örneğin, Private Cloud için Apigee Edge'i şu genel sistem yöneticisi kimlik bilgileriyle yapılandırıp yüklediyseniz:
kullanıcı adı: edgekullanici@alanim.com
şifre: Secret123
Ardından, harici LDAP'de Secret123 şifresine sahip olan edgekullanıcı@alanim.com kullanıcısı da bulunmalıdır. - Yönetim sunucusu kümesi çalıştırıyorsanız her yönetim sunucusu için bu belgedeki tüm adımları uygulamanız gerektiğini unutmayın.
Harici kimlik doğrulamayı yapılandırma
Yapacağınız ana işlem, management-server.properties dosyasını yapılandırmaktır. Bu etkinlik, Edge Yönetim Sunucusu'nu durdurup başlatmayı, doğrudan veya dolaylı bağlama yöntemini kullanıp kullanmayacağınıza karar vermeyi, hassas kimlik bilgilerini şifrelemeyi ve ilgili diğer görevleri içerir.
- Önemli: Doğrudan veya dolaylı bağlama kimlik doğrulama yöntemini kullanıp kullanmayacağınıza şimdi karar verin. Bu karar, yapılandırmanın bazı özelliklerini etkileyecektir. Harici Kimlik Doğrulama başlıklı makaleyi inceleyin.
- Önemli: Bu yapılandırma adımlarını her Apigee Edge Management Server'da uygulamanız gerekir (birden fazla çalıştırıyorsanız).
- Bir metin düzenleyicide /opt/apigee/customer/application/management-server.properties dosyasını açın. Dosya mevcut değilse dosyayı oluşturun.
- Aşağıdaki satırı ekleyin. Not: Satırın sonunda boşluk bulunmadığından emin olun.
conf_security_authentication.user.store=externalized.authentication
Bu satır, harici kimlik doğrulama özelliğini Edge for Private Cloud yüklemenize ekler. - Bu adımı kolaylaştırmak için iyi yorumlanmış iki örnek yapılandırma oluşturduk: biri doğrudan, diğeri dolaylı bağlama kimlik doğrulaması için. Kullanmak istediğiniz bağlama ilişkin aşağıdaki örneklere bakın ve yapılandırmayı tamamlayın:
DİREKT BAĞLAMA yapılandırma örneği
DOLAYLI BAĞLAMA yapılandırma örneği - Yönetim sunucusunu yeniden başlatın:
> /opt/apigee/apigee-service/bin/apigee-service edge-management-server restart - Sunucunun çalıştığından emin olun:
> /opt/apigee/apigee-service/bin/apigee-all status - Önemli: Aşağıdaki durumlardan birinde (veya her ikisinde birden) ek yapılandırma yapmanız gerekir: (a) Kullanıcıların e-posta adresi olmayan kullanıcı adlarını kullanarak giriş yapmasını istiyorsanız. Bu durumda, sistem yöneticisi kullanıcınız da bir kullanıcı adıyla kimlik doğrulaması yapmalıdır ve/veya (b) harici LDAP'nizdeki sistem yöneticisi kullanıcı hesabınızın şifresi, Private Cloud için Apigee Edge'i ilk kez yüklediğinizde yapılandırdığınız şifreden farklıysa. Farklı sistem yöneticisi kimlik bilgileri için yapılandırma gereklidir başlıklı makaleyi inceleyin.
DIRECT BINDING yapılandırma örneği
## The first property is always required to enable the external authorization feature. Do not change it.
conf_security_externalized.authentication.implementation.class=com.apigee.rbac.impl.LdapAuthenticatorImpl
## Identify the type of binding:
# Set to "true" for direct binding
# Set to "false" for indirect binding.
conf_security_externalized.authentication.bind.direct.type=true
## The next seven properties are needed regardless of direct or indirect binding. You need to configure these per your external authentication installation.
## The IP or domain for your external LDAP instance.
conf_security_externalized.authentication.server.url=ldap://localhost:389
## Your external LDAP server version.
conf_security_externalized.authentication.server.version=3
## The server timeout in milliseconds.
conf_security_externalized.authentication.server.conn.timeout=50000
## Change these baseDN values to match your external LDAP service. This attribute value will be provided by your external LDAP administrator, and may have more or fewer dc elements depending on your setup.
conf_security_externalized.authentication.user.store.baseDN=dc=apigee,dc=com
## Do not change this search string. It is used internally.
conf_security_externalized.authentication.user.store.search.query=(&(${userAttribute}=${userId}))
## Identifies the external LDAP property you want to bind against for Authentication. For example if you are binding against an email address, this would typically be in the userPrincipalName property in your external LDAP instance. Alternatively if you are binding against the user’s ID, this would typically be in the sAMAccountName property:
conf_security_externalized.authentication.user.store.user.attribute=userPrincipalName
## The LDAP attribute where the user email value is stored. For direct binding, set it to userPrincipalName.
conf_security_externalized.authentication.user.store.user.email.attribute=userPrincipalName
## ONLY needed for DIRECT binding.
## The direct.bind.user.directDN property defines the string that is used for the bind against the external authentication service. Ensure it is set as follows:
conf_security_externalized.authentication.direct.bind.user.directDN=${userDN}
DOLAYLI BAĞLAMA yapılandırma örneği
## Required to enable the external authorization feature. Do not change it.
conf_security_externalized.authentication.implementation.class=com.apigee.rbac.impl.LdapAuthenticatorImpl
## Identifies the type of binding:
# Set to "true" for direct binding
# Set to "false" for indirect binding.
conf_security_externalized.authentication.bind.direct.type=false
## The next seven properties are needed regardless of direct or indirect binding. You need to configure these per your external LDAP installation.
## The IP or domain for your external LDAP instance.
conf_security_externalized.authentication.server.url=ldap://localhost:389
## Replace with your external LDAP server version.
conf_security_externalized.authentication.server.version=3
## Set the server timeout in milliseconds.
conf_security_externalized.authentication.server.conn.timeout=50000
## Change these baseDN values to match your external LDAP service. This attribute value will be provided by your external LDAP administrator, and may have more or fewer dc elements depending on your setup.
conf_security_externalized.authentication.user.store.baseDN=dc=apigee,dc=com
## Do not change this search string. It is used internally.
conf_security_externalized.authentication.user.store.search.query=(&(${userAttribute}=${userId}))
## Identifies the external LDAP property you want to bind against for Authentication. For example if you are binding against an email address, this would typically be in the userPrincipalName property in your external LDAP instance. Alternatively if you are binding against the user’s ID, this would typically be in the sAMAccountName property. See also "Configuration required for different sysadmin credentials".
conf_security_externalized.authentication.user.store.user.attribute=userPrincipalName
## Used by Apigee to perform the Authorization step and currently, Apigee only supports email address for Authorization. Make sure to set it to the attribute in your external LDAP that stores the user’s email address. Typically this will be in the userPrincipalName property.
conf_security_externalized.authentication.user.store.user.email.attribute=userPrincipalName
## The external LDAP username (for a user with search privileges on the external LDAP) and password and whether the password is encrypted. You must also set the attribute externalized.authentication.bind.direct.type to false.
## The password attribute can be encrypted or in plain text. See "Indirect binding only: Encrypting the external LDAP user’s password" for encryption instructions. Set the password.encrypted attribute to "true" if the password is encrypted. Set it to "false" if the password is in plain text.
conf_security_externalized.authentication.indirect.bind.server.admin.dn=myExtLdapUsername
conf_security_externalized.authentication.indirect.bind.server.admin.password=myExtLdapPassword
conf_security_externalized.authentication.indirect.bind.server.admin.password.encrypted=true
Kurulumu test etme
- Sunucunun çalıştığından emin olun:
> /opt/apigee/apigee-service/bin/apigee-all status - Bir dizi Apigee Edge global sistem yöneticisi kimlik bilgisi sağlayarak bu komutu yürütün. Test edeceğimiz API çağrısı yalnızca bir Edge sistem yöneticisi tarafından yürütülebilir.
Önemli: Aynı kimlik bilgileri harici LDAP hesabınızda mevcut olmalıdır. Bu bilgiler yoksa hemen eklemeniz gerekir. Kullanıcı adının genellikle bir e-posta adresi olduğunu unutmayın. Ancak bu, bu dokümanda daha önce açıklandığı gibi harici kimlik doğrulamayı nasıl yapılandırdığınıza bağlıdır.
> curl -v http://<management-server-ip>:8080/v1/o -u <Sysadmin Username>
Örneğin:
> curl -v http://192.168.52.100:8080/v1/o -u jdoe@mydomain.com - İstendiğinde şifrenizi girin.
Komut 200 durumunu ve kuruluşların listesini döndürüyorsa yapılandırma doğrudur. Bu komut, Edge Yönetim Sunucusu'na yapılan API çağrısının harici LDAP sistemi üzerinden başarıyla kimlik doğrulamasını doğrular.