Edge per Private Cloud v4.18.01
La mappatura dei ruoli esterni ti consente di mappare i tuoi gruppi o ruoli al controllo dell'accesso basato sui ruoli (RBAC) di ruoli e gruppi creati su Apigee Edge. Questa funzionalità è disponibile solo con Edge Private Google Cloud.
Novità
Il servizio di mappatura dei ruoli esterni per le versioni di Edge per il cloud privato precedenti alla 4.18.01 ha sono state ritirate. La release 4.18.01 di Mappatura dei ruoli esterni è una versione aggiornata con alcuni bug corretti e nuove funzionalità aggiunte:
- È stato risolto il problema per cui ricevi risposte vietate di autenticazione 403 quando l'autenticazione con gli utenti che dovrebbero avere accesso.
- X-Apigee-Current-User è ora supportata nella mappatura dei ruoli esterni. Ora gli utenti con l'accesso corretto (sysadmin) possono i ruoli assegnati a un altro utente.
Prerequisiti
- Devi essere un amministratore di sistema Apigee Private Cloud con amministratore di sistema globale credenziali per eseguire questa configurazione.
-
Devi conoscere la directory root dell'installazione del cloud privato Apigee Edge. La La directory radice predefinita è /opt.
Esempio di configurazione passo passo
Vedi questo articolo sui forum della community Apigee per un esempio dettagliato della configurazione di la mappatura dei ruoli.
Configurazione predefinita
La mappatura dei ruoli esterni è disattivata per impostazione predefinita.
Abilitazione della mappatura dei ruoli esterni
- Prima di poter completare la configurazione seguente, devi creare una classe Java che
implementa l'interfaccia ExternalRoleMapperServiceV2 e include la tua implementazione nella
Percorso della classe del server di gestione:
/opt/apigee/edge-management-server/lib/thirdparty/
Per maggiori dettagli su questa implementazione, consulta la sezione Informazioni su ExternalRoleMapperImpl un'implementazione di esempio più avanti in questo documento. - Accedi al server di gestione Apigee Edge e arresta il server di gestione
processo:
> /opt/apigee/apigee-service/bin/apigee-service arresto di edge-management-server - Apri /opt/apigee/customer/application/management-server.properties in un editor di testo. Se il file non esiste, crealo.
- Modifica il file delle proprietà in modo da applicare le seguenti impostazioni:
# Lo store utente da utilizzare per autenticazione.
# Utilizza "externalized.authentication" per l'archivio utenti LDAP.
# Tieni presente che per l'autorizzazione continuiamo a utilizzare LDAP.
# Consulta l'articolo sull'attivazione dell'autenticazione esterna sull'abilitazione dell'autenticazione esterna.
conf_security_authentication.user.store=externalized.authentication
#Abilita il mapping dei ruoli delle autorizzazioni esterne.
conf_security_externalized.authentication.role.mapper.enabled=true conf_security_externalized.authentication.role.mapper.implementation.class=com.customer.authorization.impl.ExternalRoleMapperImpl
Importante: il la classe di implementazione e il nome del pacchetto a cui viene fatto riferimento nella configurazione precedente (ExternalRoleMapperImpl) sono solo esempi: è una classe che deve essere implementata e che puoi assegnare un nome alla classe e pacchettizzare come preferisci. Per i dettagli sull'implementazione consulta Informazioni su Classe di implementazione di esempio ExternalRoleMapperImpl riportata di seguito. Questo è un corso che che devi implementare per riflettere i tuoi gruppi. - Salva il file management-server.properties.
- Assicurati che management-server.properties sia di proprietà di
the apigee user:?
> chown apigee:apigee /opt/apigee/customer/application/management-server.properties - Avvia il server di gestione:
> /opt/apigee/apigee-service/bin/apigee-service avvio edge-management-server
Disabilitazione dell'autorizzazione esterna
Per disabilitare l'autorizzazione esterna:
- Apri /opt/apigee/customer/application/management-server.properties in un editor di testo. Se il file non esiste, crealo.
- Cambia l'archivio utenti di autenticazione in ldap:
conf_security_authentication.user.store=ldap - Imposta questa proprietà su false:
conf_security_externalized.authentication.role.mapper.enabled=false - Riavvia il server di gestione:
> /opt/apigee/apigee-service/bin/apigee-service avvio edge-management-server
Informazioni su ExternalRoleMapperImpl implementazione di esempio
Nel file di configurazione security.properties descritto in precedenza in Abilitare la mappatura dei ruoli esterni, tieni presente quanto segue:
externalized.authentication.role.mapper.implementation.class=com.customer.authorization.impl.ExternalRoleMapperImpl
Questa classe implementa l'interfaccia ExternalRoleMapperServiceV2 ed è obbligatoria. Devi creare una propria implementazione di questa classe che rifletta i rispettivi gruppi. Al termine, inserisci la classe compilata in un JAR e inserisci quel JAR nel classpath del server di gestione in:
/opt/apigee/edge-management-server/lib/thirdparty/
Puoi assegnare il nome che preferisci alla classe e al pacchetto, purché implementi ExternalRoleMapperServiceV2 è accessibile nel classpath e vi viene fatto riferimento correttamente in nel file di configurazione management-server.properties.
Di seguito è riportato un esempio ben commentato di implementazione di una classe 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();
}
}