Mapowanie ról zewnętrznych

Edge dla chmury prywatnej w wersji 4.18.01

Mapowanie ról zewnętrznych umożliwia mapowanie własnych grup lub ról na role i grupy kontroli dostępu opartej na rolach (RBAC) utworzone w Apigee Edge. Ta funkcja jest dostępna tylko w Edge Private Cloud.

Co nowego

Usługa mapowania ról zewnętrznych w Edge dla chmury prywatnej w wersjach starszych niż 4.18.01 została wycofana. Wersja 4.18.01 mapowania ról zewnętrznych to zaktualizowana wersja z poprawionymi błędami i nowymi funkcjami:

  • Rozwiązaliśmy problem, który powodował, że podczas uwierzytelniania użytkowników, którzy powinni mieć dostęp, pojawiała się odpowiedź 403 Forbidden.
  • 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 przeprowadzić tę konfigurację, musisz być administratorem systemu Apigee Private Cloud z danymi logowania globalnego administratora systemu.
  • Musisz znać katalog główny instalacji Apigee Edge chmury prywatnej. Domyślny katalog główny to /opt.

Przykład konfiguracji krok po kroku

Aby zobaczyć szczegółowy przykład konfigurowania mapowania ról zewnętrznych, zapoznaj się z tym artykułem 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

  1. Zanim będzie można dokończyć konfigurację, musisz utworzyć klasę Java, która implementuje interfejs ExternalRoleMapperServiceV2, i uwzględnić tę implementację w ścieżce klasy serwera zarządzania:

    /opt/apigee/edge-management-server/lib/thirdparty/

    Szczegółowe informacje o tej implementacji znajdziesz w sekcji Przykładowa implementacja ExternalRoleMapperImpl w dalszej części tego dokumentu.
  2. Zaloguj się na serwerze zarządzania Apigee Edge, a następnie zatrzymaj proces serwera zarządzania:
    > /opt/apigee/apigee-service/bin/apigee-service edge-management-server stop
  3. Otwórz plik /opt/apigee/customer/application/management-server.properties w edytorze tekstu. Jeśli ten plik nie istnieje, utwórz go.
  4. Zmodyfikuj plik właściwości, aby wprowadzić te ustawienia:
    # Magazyn użytkowników, który ma być używany do uwierzytelniania.
    # Use "externalized.authentication" for LDAP user store.
    # Note that for authorization, we continue to use LDAP.
    # Więcej informacji o włączaniu uwierzytelniania zewnętrznego znajdziesz w artykule Włączanie uwierzytelniania zewnętrznego.
    conf_security_authentication.user.store=externalized.authentication

    #Enable the external authorizations role mapper.
    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 (ExternalRoleMapperImpl), to tylko przykłady. Jest to klasa, którą musisz zaimplementować i którą możesz nazwać, jak chcesz. To samo dotyczy pakietu. Szczegółowe informacje o implementacji tej klasy znajdziesz poniżej w sekcji Przykładowa implementacja klasy ExternalRoleMapperImpl. Jest to klasa, którą musisz wdrożyć, aby odzwierciedlić własne grupy.
  5. Zapisz plik management-server.properties.
  6. Upewnij się, że plik management-server.properties należy do użytkownika apigee:?
    > chown apigee:apigee /opt/apigee/customer/application/management-server.properties
  7. 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ą:

  1. Otwórz plik /opt/apigee/customer/application/management-server.properties w edytorze tekstu. Jeśli plik nie istnieje, utwórz go.
  2. Zmień magazyn użytkowników uwierzytelniania na ldap:
    conf_security_authentication.user.store=ldap
  3. Ustaw tę właściwość na wartość „false”:
    conf_security_externalized.authentication.role.mapper.enabled=false
  4. Uruchom ponownie serwer zarządzania:
    > /opt/apigee/apigee-service/bin/apigee-service edge-management-server start

Przykładowa implementacja 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 wdraża interfejs ExternalRoleMapperServiceV2 i jest wymagana. Musisz utworzyć własną implementację tej klasy, która odzwierciedla odpowiednie grupy. Po zakończeniu umieść skompilowaną klasę w pliku JAR i umieść ten plik JAR w ścieżce klasy serwera zarządzania w:

/opt/apigee/edge-management-server/lib/thirdparty/

Możesz nazwać klasę i pakiet, jak chcesz, o ile implementuje on interfejs ExternalRoleMapperServiceV2, jest dostępny w ścieżce klasy i jest prawidłowo przywoływany w pliku konfiguracji management-server.properties.

Poniżej znajdziesz przykładową implementację klasy ExternalRoleMapperImpl z komentarzami.

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();
   }

}