Edge for Private Cloud w wersji 4.17.01
Z tej sekcji dowiesz się, jak pobrać, zainstalować i skonfigurować komponenty wymagane do zintegrowania zewnętrznej usługi LDAP z Apigee Edge na potrzeby uwierzytelniania użytkowników.
Wymagania wstępne
- Musisz mieć zainstalowaną wersję Apigee Edge for Private Cloud 4.17.01.
- Aby przeprowadzić tę instalację, musisz mieć poświadczenia administratora globalnego systemu w usłudze Apigee Edge for Private Cloud.
- Musisz znać katalog główny instalacji Apigee Edge for Private Cloud. Katalog główny domyślny to /opt.
- Do zewnętrznego katalogu LDAP musisz dodać dane logowania administratora systemu globalnego. Pamiętaj, że domyślnie dane uwierzytelniające administratora systemu są przechowywane w wewnętrznym protokole LDAP Edge. Gdy przełączysz się na zewnętrzny LDAP, dane logowania administratora systemu będą uwierzytelniane tam. Dlatego dane logowania musisz udostępnić zewnętrznemu systemowi przed włączeniem uwierzytelniania zewnętrznego w Edge.
Na przykład jeśli skonfigurujesz i zainstalujesz Apigee Edge for Private Cloud z danymi logowania administratora globalnego:
Nazwa użytkownika: edgeuser@mydomain.com
Hasło: Secret123
W usłudze LDAP zewnętrznej musi też znajdować się użytkownik edgeuser@mydomain.com z hasłem Secret123. - Jeśli używasz klastra serwera zarządzania, musisz wykonać wszystkie czynności opisane w tym dokumencie na każdym serwerze zarządzania.
Konfigurowanie uwierzytelniania zewnętrznego
Główną czynnością, którą musisz wykonać, jest skonfigurowanie pliku management-server.properties. To działanie obejmuje zatrzymanie i uruchomienie serwera zarządzania brzegiem, podjęcie decyzji o użyciu bezpośredniego lub pośredniego wiązania, szyfrowanie poufnych danych logowania itp.
- Ważne: zdecyduj teraz, czy chcesz użyć metody uwierzytelniania z bezpośrednim lub pośrednim wiązaniem. Ta decyzja wpłynie na niektóre aspekty konfiguracji. Zobacz Uwierzytelnianie zewnętrzne.
- Ważne: te czynności konfiguracyjne musisz wykonać na każdym serwerze Apigee Edge Management (jeśli masz ich więcej niż 1).
- Otwórz plik /opt/apigee/customer/application/management-server.properties w edytorze tekstu. Jeśli plik nie istnieje, utwórz go.
- Dodaj ten wiersz. Uwaga: sprawdź, czy na końcu wiersza nie ma żadnych końcowych spacji.
conf_security_authentication.user.store=externalized.authentication
Ten wiersz dodaje funkcję uwierzytelniania zewnętrznego do instalacji Edge for Private Cloud. - Aby ułatwić Ci ten krok, utworzyliśmy 2 dobrze opisane przykładowe konfiguracje – jedną dla bezpośredniej, a drugą dla pośredniej autoryzacji powiązanej. Zapoznaj się z przykładami poniżej, aby wybrać sposób wiązania, którego chcesz użyć, i dodaj konfigurację:
Przykład konfiguracji bezpośredniego wiązania
Przykład konfiguracji pośredniego wiązania - Uruchom ponownie serwer zarządzania:
> /opt/apigee/apigee-service/bin/apigee-service edge-management-server restart - Sprawdź, czy serwer działa:
> /opt/apigee/apigee-service/bin/apigee-all status - Ważne: musisz przeprowadzić dodatkową konfigurację w przypadku co najmniej jednego z tych warunków: (a) jeśli chcesz, aby użytkownicy logowali się za pomocą nazw użytkowników, które nie są adresami e-mail. W tym przypadku użytkownik sysadmin musi też uwierzytelnić się przy użyciu nazwy użytkownika lub (b) jeśli hasło konta użytkownika sysadmin na zewnętrznym serwerze LDAP różni się od hasła skonfigurowanego podczas pierwszej instalacji Apigee Edge dla Private Cloud. Zobacz Konfiguracja wymagana dla różnych danych logowania administratora systemu.
Przykład konfiguracji DIRECT BINDING
## 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}
Przykład konfiguracji pośredniego wiązania
## 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
Testowanie instalacji
- Sprawdź, czy serwer działa:
> /opt/apigee/apigee-service/bin/apigee-all status - Wykonaj to polecenie, podając zestaw danych logowania administratora globalnego systemu Apigee Edge. Wywołania interfejsu API, które zamierzamy przetestować, może wykonać tylko administrator systemu Edge.
Ważne: na zewnętrznym koncie LDAP muszą znajdować się identyczne dane logowania. Jeśli nie, musisz dodać je teraz. Pamiętaj, że nazwa użytkownika to zwykle adres e-mail, ale może się to zmienić w zależności od konfiguracji uwierzytelniania zewnętrznego, o której mowa wcześniej w tym dokumencie.
> curl -v http://<management-server-ip>:8080/v1/o -u <Nazwa użytkownika administratora systemu>
Przykład:
> curl -v http://192.168.52.100:8080/v1/o -u jdoe@mydomain.com - Gdy pojawi się prośba, wpisz hasło.
Jeśli polecenie zwróci stan 200 i listę organizacji, konfiguracja jest prawidłowa. To polecenie sprawdza, czy wywołanie interfejsu API na serwerze Edge Management Server zostało uwierzytelnione za pomocą zewnętrznego systemu LDAP.