Edge for Private Cloud w wersji 4.18.01
Mapowanie ról zewnętrznych pozwala zmapować własne grupy lub role na role i grupy kontroli dostępu oparte na rolach (RBAC) utworzone w Apigee Edge. Ta funkcja jest dostępna tylko w chmurze prywatnej na serwerach brzegowych.
Nowości
Usługa mapowania ról zewnętrznych dla Edge for Private Cloud w wersji sprzed 4.18.01 została wycofana. Wersja 4.18.01 mapowania ról zewnętrznych to zaktualizowana wersja z naprawionymi błędami i nowymi funkcjami:
- Rozwiązaliśmy problem polegający na tym, że podczas uwierzytelniania u użytkowników, którzy powinni mieć dostęp, otrzymywane były zabronione odpowiedzi 403 dotyczące uwierzytelniania.
- Nagłówek X-Apigee-Current-User jest teraz obsługiwany w mapowaniu ról zewnętrznych. Użytkownicy z odpowiednim dostępem (sysadmin) mogą teraz wyświetlać role przypisane do innego użytkownika.
Wymagania wstępne
- Aby wykonać tę konfigurację, musisz być administratorem systemu Apigee Private Cloud z globalnymi danymi logowania administratora systemu.
-
Musisz znać katalog główny instalacji Apigee Edge Private Cloud. Domyślnym katalogiem głównym jest /opt.
Przykład konfiguracji krok po kroku
Szczegółowe instrukcje konfigurowania mapowania ról zewnętrznych znajdziesz w tym artykule na forach społeczności Apigee.
Konfiguracja domyślna
Mapowanie ról zewnętrznych jest domyślnie wyłączone.
Włączanie mapowania ról zewnętrznych
- Zanim przeprowadzisz tę konfigurację, musisz utworzyć klasę Java, która implementuje interfejs ExternalRoleMapperServiceV2 i uwzględnić Twoją implementację w ścieżce klasy zarządzania serwerem zarządzania:
/opt/apigee/edge-management-server/lib/thirdparty/
Więcej informacji o tej implementacji znajdziesz w sekcji Informacje o przykładowej implementacji ExternalRoleMapperImpl w dalszej części tego dokumentu. - Zaloguj się na serwerze zarządzania Edge Apigee, a następnie zatrzymaj proces serwera zarządzania:
> /opt/apigee/apigee-service/bin/apigee-service Edge-management-server stop - Otwórz plik /opt/apigee/customer/application/management-server.properties w edytorze tekstu. Jeśli ten plik nie istnieje, utwórz go.
- Edytuj plik właściwości, aby wprowadzić te ustawienia:
# Magazyn użytkownika, który ma być używany do uwierzytelniania.
# W przypadku magazynu użytkowników LDAP użyj „externalized.authentication”.
# Pamiętaj, że do autoryzacji wciąż używamy protokołu LDAP.
# Więcej informacji o włączaniu uwierzytelniania zewnętrznego znajdziesz w sekcji Włączanie uwierzytelniania zewnętrznego.
conf_security_authentication.user.store=externalized.authentication
#Włącz narzędzie do mapowania ról zewnętrznych autoryzacji.
conf_security_externalized.authentication.role.mapper.enabled=true conf_security_externalized.authentication.role.mapper.implementation.class=com.customer.authorization.impl.ExternalRoleMapperImpl
Ważne: klasa implementacji i nazwa pakietu, do których odwołuje się powyższa konfiguracja, mogą być tylko przykładami, których chcesz używać w powyższej konfiguracji (ExternalMapper – Impl). Więcej informacji o implementowaniu tej klasy znajdziesz w sekcji Informacje o przykładowej implementacji ExternalRoleMapperImpl poniżej. Jest to klasa, którą musisz wdrożyć, aby odzwierciedlała Twoje własne grupy. - Zapisz plik management-server.properties.
- Sprawdź, czy plik management-server.properties jest własnością użytkownika Apigee:?
> chown apigee:apigee /opt/apigee/customer/application/management-server.properties - Uruchom serwer zarządzania:
> /opt/apigee/apigee-service/bin/apigee-service Edge-management-server start
Wyłączanie autoryzacji zewnętrznej
Aby wyłączyć autoryzację zewnętrzną:
- Otwórz plik /opt/apigee/customer/application/management-server.properties w edytorze tekstu. Jeśli plik nie istnieje, utwórz go.
- Zmień magazyn użytkowników uwierzytelniania na LDAP:
conf_security_authentication.user.store=ldap - Ustaw tę właściwość na false:
conf_security_externalized.authentication.role.mapper.enabled=false - Ponownie uruchom serwer zarządzania:
> /opt/apigee/apigee-service/bin/apigee-service Edge-management-server start
Informacje o przykładowej implementacji ExternalRoleMapperImpl
W pliku konfiguracyjnym security.properties opisanym wcześniej w sekcji Włączanie mapowania ról zewnętrznych zwróć uwagę na ten wiersz:
externalized.authentication.role.mapper.implementation.class=com.customer.authorization.impl.ExternalRoleMapperImpl
Ta klasa implementuje interfejs ExternalRoleMapperServiceV2 i jest wymagana. Musisz utworzyć własną implementację tej klasy, która będzie odpowiadać Twoim grupom. Gdy skończysz, umieść skompilowaną klasę w pliku JAR i umieść ją w ścieżce klasy serwera zarządzania w:
/opt/apigee/edge-management-server/lib/thirdparty/
Możesz nadać klasie i pakietowi dowolną nazwę, pod warunkiem, że implementuje ona ExternalRoleMapperServiceV2, jest dostępna w ścieżce klasy i ma prawidłowe odwołanie w pliku konfiguracyjnym management-server.properties.
Poniżej znajdziesz dobrze skomentowaną przykładową implementację klasy ExternalRoleMapperImpl.
package com.customer.authorization.impl;
import com.apigee.authentication.*;
import com.apigee.authorization.namespace.OrganizationNamespace;
import com.apigee.authorization.namespace.SystemNamespace;
import java.util.Collection;
import java.util.HashSet;
import javax.naming.NamingEnumeration;
import javax.naming.NamingException;
import javax.naming.directory.Attributes;
import javax.naming.directory.DirContext;
import javax.naming.directory.InitialDirContext;
import javax.naming.directory.SearchControls;
import javax.naming.directory.SearchResult;
/** *
* Sample Implementation constructed with dummy roles with expected namespaces.
*/
public class ExternalRoleMapperImpl
implements ExternalRoleMapperServiceV2 {
InitialDirContext dirContext = null;
@Override
public void start(ConfigBean arg0) throws ConnectionException {
try {
// Customer Specific Implementation will override the
// ImplementDirContextCreationLogicForSysAdmin method implementation.
// Create InitialDirContext based on the system admin user credentials.
dirContext = ImplementDirContextCreationLogicForSysAdmin();
} catch (NamingException e) {
// TODO Auto-generated catch block
throw new ConnectionException(e);
}
}
@Override
public void stop() throws Exception {
}
/**
* This method should be replaced with customer's implementation
* For given roleName under expectedNamespace, return all users that belongs to this role
* @param roleName
* @param expectedNamespace
* @return All users that belongs to this role. For each user, please return the username/email that is stored in Apigee LDAP
* @throws ExternalRoleMappingException
*/
@Override
public Collection<String> getUsersForRole(String roleName, NameSpace expectedNamespace) throws ExternalRoleMappingException {
Collection<String> users = new HashSet<>();
if (expectedNamespace instanceof SystemNamespace) {
// If requesting all users with sysadmin role
if (roleName.equalsIgnoreCase("sysadmin")) {
// Add sysadmin's email to results
users.add("sysadmin@wacapps.net");
}
} else {
String orgName = ((OrganizationNamespace) expectedNamespace).getOrganization();
// If requesting all users of engRole in Apigee LDAP
if (roleName.equalsIgnoreCase("engRole")) {
// Get all users in corresponding groups in customer's LDAP. In this case looking for 'engGroup';
SearchControls controls = new SearchControls();
controls.setSearchScope(1);
try {
NamingEnumeration<SearchResult> res = dirContext.search("ou=groups,dc=corp,dc=wacapps,dc=net",
"cn=engGroup", new Object[]{"",""}, controls);
while (res.hasMoreElements()) {
SearchResult sr = res.nextElement();
// Add all users into return
users.addAll(sr.getAttributes().get("users").getAll());
}
} catch (NamingException e) {
// Customer needs to handle the exception here
}
}
}
return users;
}
/**
*
* This method would be implemented by the customer and would be invoked
* while including using X-Apigee-Current-User header in request.
*
* X-Apigee-Current-User allows the customer to login as another user
*
* Below is the basic example.
*
* If User has sysadmin role then it's expected to set SystemNameSpace
* along with the expected NameSpace. Otherwise role's expectedNameSpace
* to be set for the NameSpacedRole.
*
* Collection<NameSpacedRole> results = new HashSet<NameSpacedRole>();
*
* NameSpacedRole sysNameSpace = new NameSpacedRole("sysadmin",
* SystemNamespace.get());
*
* String orgName =
* ((OrganizationNamespace) expectedNameSpace).getOrganization();
*
* NameSpacedRole orgNameSpace = new NameSpacedRole ("orgadmin",
* expectedNameSpace);
*
* results.add(sysNameSpace);
*
* results.add(orgNameSpace);
*
*
* @param username UserA's username
* @param password UserA's password
* @param requestedUsername UserB's username. Allow UserA to request UserB's userroles with
* UserA's credentials when requesting UserB as X-Apigee-Current-User
* @param expectedNamespace
* @return
* @throws ExternalRoleMappingException
*/
@Override
public Collection<NameSpacedRole> getUserRoles(String username, String password, String requestedUsername, NameSpace expectedNamespace) throws ExternalRoleMappingException {
/************************************************************/
/******************** Authenticate UserA ********************/
/************************************************************/
// Customer Specific Implementation will override the
// ImplementDnameLookupLogic method implementation.
// obtain dnName for given username.
String dnName = ImplementDnNameLookupLogic(username);
// Obtain dnName for given requestedUsername.
String requestedDnName = ImplementDnNameLookupLogic(requestedUsername);
if (dnName == null || requestedDnName == null) {
System.out.println("Error ");
}
DirContext dirContext = null;
try {
// Customer Specific Implementation will override the
// ImplementDirectoryContextCreationLogic method implementation
// Create a directory context with dnName or requestedDnName and password
dirContext = ImplementDirectoryContextCreationLogic();
/************************************************/
/*** Map internal groups to apigee-edge roles ***/
/************************************************/
return apigeeEdgeRoleMapper(dirContext, requestedDnName, expectedNamespace);
} catch (Exception ex) {
ex.printStackTrace();
System.out.println("Error in authenticating User: {}" + new Object[] { username });
} finally {
// Customer implementation to close
// ActiveDirectory/LDAP context.
}
return null;
}
/**
*
* This method would be implemented by the customer and would be invoked
* wihle using username and password for authentication and without the
* X-Apigee-Current-User header
*
* The customer can reuse implementations in
* getUserRoles(String username, String password, String requestedUsername, NameSpace expectedNamespace)
* by
* return getUserRoles(username, password, username, expectedNamespace)
* in implementations.
*
* or the customer can provide new implementations as shown below.
*/
@Override
public Collection<NameSpacedRole> getUserRoles(String username, String password, NameSpace expectedNamespace) throws ExternalRoleMappingException {
/*************************************************************/
/****************** Authenticate Given User ******************/
/*************************************************************/
// Customer Specific Implementation will override the
// ImplementDnameLookupLogic implementation.
// Obtain dnName for given username or email address.
String dnName = ImplementDnNameLookupLogic(username);
if (dnName == null) {
System.out.println("Error ");
}
DirContext dirContext = null;
try {
// Create a directory context with username or dnName and password
dirContext = ImplementDirectoryContextCreationLogic();
/************************************************/
/*** Map internal groups to apigee-edge roles ***/
/************************************************/
return apigeeEdgeRoleMapper(dirContext, dnName, expectedNamespace);
} catch (Exception ex) {
ex.printStackTrace();
System.out.println("Error in authenticating User: {}" + new Object[] { username });
} finally {
// Customer implementation to close
// ActiveDirectory/LDAP context.
}
return null;
}
/**
*
* This method would be implemented by the customer and would be invoked
* while using security token or access token as authentication credentials.
*
*/
@Override
public Collection<NameSpacedRole> getUserRoles(String username, NameSpace expectedNamespace) throws ExternalRoleMappingException {
/*************************************************************/
/****************** Authenticate Given User ******************/
/*************************************************************/
// Customer Specific Implementation will override the
// ImplementDnameLookupLogic implementation.
// Obtain dnName for given username or email address.
String dnName = ImplementDnNameLookupLogic(username);
if (dnName == null) {
System.out.println("Error ");
}
DirContext dirContext = null;
try {
// Create a directory context with username or dnName and password
dirContext = ImplementDirectoryContextCreationLogic();
/************************************************/
/*** Map internal groups to apigee-edge roles ***/
/************************************************/
return apigeeEdgeRoleMapper(dirContext, dnName, expectedNamespace);
} catch (Exception ex) {
ex.printStackTrace();
System.out.println("Error in authenticating User: {}" + new Object[] { username });
} finally {
// Customer implementation to close
// ActiveDirectory/LDAP context.
}
return null;
}
/**
* This method should be replaced with Customer Specific Implementations
*
* Provided as a sample Implementation of mapping user groups to apigee-edge roles
*/
private Collection<NameSpacedRole> apigeeEdgeRoleMapper(DirContext dirContext, String dnName, NameSpace expectedNamespace) throws Exception {
Collection<NameSpacedRole> results = new HashSet<NameSpacedRole>();
/****************************************************/
/************ Fetch internal groups *****************/
/****************************************************/
String groupDN = "OU=Groups,DC=corp,DC=wacapps,DC=net";
String userFilter = "(user=userDnName)";
SearchControls controls = new SearchControls();
controls.setSearchScope(SearchControls.ONELEVEL_SCOPE);
// Looking for all groups the user belongs to in customer's LDAP
NamingEnumeration<SearchResult> groups = dirContext.search(groupDN,userFilter.replace("userDnName", dnName), new Object[] { "", "" }, controls);
if (groups.hasMoreElements()) {
while (groups.hasMoreElements()) {
SearchResult searchResult = groups.nextElement();
Attributes attributes = searchResult.getAttributes();
String groupName = attributes.get("name").get().toString();
/************************************************/
/*** Map internal groups to apigee-edge roles ***/
/************************************************/
if (groupName.equals("BusDev")) {
results.add(new NameSpacedRole("businessAdmin",SystemNamespace.get()));
} else if (groupName.equals("Engineering")) {
if (expectedNamespace instanceof OrganizationNamespace) {
String orgName = ((OrganizationNamespace) expectedNamespace).getOrganization();
results.add(new NameSpacedRole("orgadmin", new OrganizationNamespace(orgName)));
}
} else if (groupName.equals("Marketing")) {
results.add(new NameSpacedRole("marketAdmin",SystemNamespace.get()));
} else {
results.add(new NameSpacedRole("readOnly",SystemNamespace.get()));
}
}
} else {
// In case of no group found or exception found we throw empty roles.
System.out.println(" !!!!! NO GROUPS FOUND !!!!!");
}
return results;
}
/**
* The customer need to replace with own implementations for getting dnName for given user
*/
private String ImplementDnNameLookupLogic(String username) {
// Connect to the customer's own LDAP to fetch user dnName
return customerLDAP.getDnName(username);
}
/**
* The customer need to replace with own implementations for creating DirContext
*/
private DirContext ImplementDirectoryContextCreationLogic() {
// Connect to the customer's own LDAP to create DirContext for given user
return customerLDAP.createLdapContextUsingCredentials();
}
}