बाहरी भूमिका की मैपिंग

Edge for Private Cloud v4.18.01

एक्सटर्नल रोल मैपिंग की मदद से, अपने ग्रुप या भूमिकाओं को भूमिका के हिसाब से ऐक्सेस करने के कंट्रोल पर मैप किया जा सकता है Apigee Edge पर बनाई गई, (आरबीएसी) भूमिकाएं और ग्रुप. यह सुविधा सिर्फ़ Edge Private के साथ उपलब्ध है क्लाउड.

नया क्या है

प्राइवेट क्लाउड के लिए Edge रिलीज़ के लिए बाहरी भूमिका मैपिंग सेवा, जो 4.18.01 से पहले की है अब सेवा में नहीं है. बाहरी भूमिका मैपिंग का रिलीज़ 4.18.01 एक अपडेट किया गया वर्शन है, जिसमें गड़बड़ियां ठीक कर दी गई हैं हमने इसमें नई सुविधाएं जोड़ी हैं:

  • उस समस्या को ठीक किया गया जहां आपको उन उपयोगकर्ताओं की पुष्टि की जा रही है जिनके पास इसका ऐक्सेस होना चाहिए.
  • X-Apigee-Current-User हेडर, अब बाहरी भूमिका मैपिंग में काम करता है. सही ऐक्सेस वाले उपयोगकर्ता (sysadmin) के पास अब ये काम करने की अनुमति है किसी अन्य उपयोगकर्ता को असाइन की गई भूमिकाएं देखें.

ज़रूरी शर्तें

  • आपको ग्लोबल सिस्टम एडमिन के साथ-साथ, Apigee निजी क्लाउड सिस्टम का एडमिन होना चाहिए यह कॉन्फ़िगरेशन करने के लिए क्रेडेंशियल.
  • आपके पास Apigee Edge के निजी क्लाउड इंस्टॉलेशन की रूट डायरेक्ट्री की जानकारी होनी चाहिए. कॉन्टेंट बनाने डिफ़ॉल्ट रूट डायरेक्ट्री /opt है.

सिलसिलेवार तरीके से सेटअप करने का उदाहरण

देखें यह लेख: Apigee के कम्यूनिटी फ़ोरम पर जाकर, बाहरी खाता सेट अप करने के सिलसिलेवार निर्देशों के बारे में जानकारी भूमिका मैपिंग.

डिफ़ॉल्ट कॉन्फ़िगरेशन

बाहरी भूमिका की मैपिंग डिफ़ॉल्ट रूप से बंद होती है.

बाहरी भूमिका की मैपिंग चालू करना

  1. नीचे दिए गए कॉन्फ़िगरेशन को पूरा करने से पहले, आपको एक ऐसी Java क्लास बनानी होगी जो ExternalRoleMapperServiceV2 इंटरफ़ेस को लागू करता है और मैनेजमेंट सर्वर क्लासपाथ:

    अभी तक किसी भी व्यक्ति ने चेक इन नहीं किया है /opt/apigee/edge-management-server/lib/thirdparty/

    अभी तक किसी भी व्यक्ति ने चेक इन नहीं किया है इसके बारे में जानकारी पाने के लिए, ExternalRoleMapperImpl के बारे में जानकारी वाला सेक्शन देखें बाद में इस दस्तावेज़ में लागू करने का नमूना देखें.
  2. अपने Apigee Edge मैनेजमेंट सर्वर में लॉग इन करें और फिर मैनेजमेंट सर्वर को बंद करें प्रोसेस:
    > /opt/apigee/apigee-service/bin/apigee-service एज-मैनेजमेंट-सर्वर स्टॉप
  3. /opt/apigee/customer/application/management-server.properties खोलें टेक्स्ट एडिटर में मिलता है. अगर यह फ़ाइल मौजूद नहीं है, तो इसे बनाएं.
  4. प्रॉपर्टी फ़ाइल में बदलाव करके, ये सेटिंग करें:
    # उपयोगकर्ता स्टोर, जिसका इस्तेमाल किया जाना है पुष्टि करने के लिए.
    अभी तक किसी भी व्यक्ति ने चेक इन नहीं किया है # "externalized.authentication" का इस्तेमाल करें LDAP उपयोगकर्ता स्टोर के लिए.
    अभी तक किसी भी व्यक्ति ने चेक इन नहीं किया है # ध्यान दें कि अनुमति देने के लिए, हम LDAP का इस्तेमाल जारी रखते हैं.
    अभी तक किसी भी व्यक्ति ने चेक इन नहीं किया है # बाहरी ऑथेंटिकेशन चालू करने के बारे में और जानकारी देखें बाहरी प्राधिकरण को सक्षम करने पर.
    अभी तक किसी भी व्यक्ति ने चेक इन नहीं किया है conf_security_authentication.user.store=externalized.authentication

    अभी तक किसी भी व्यक्ति ने चेक इन नहीं किया है #बाहरी प्राधिकरण भूमिका मैपर सक्षम करें.
    अभी तक किसी भी व्यक्ति ने चेक इन नहीं किया है conf_security_externalized.authentication.role.mapper.enabled=true conf_security_externalized.authentication.role.mapper.implementation.class=
    com.customer.authorization.impl.ExternalRoleMapperImpl

    अभी तक किसी भी व्यक्ति ने चेक इन नहीं किया है अहम जानकारी:
    ऊपर दिए गए कॉन्फ़िगरेशन में, लागू करने की क्लास और पैकेज के नाम की जानकारी (ExternalRoleMapperImpl) केवल उदाहरण हैं -- यह एक ऐसी क्लास है जिसे आपको लागू करना होगा और वह क्लास और पैकेज को जो चाहें नाम दिया जा सकता है. इसे लागू करने से संबंधित विवरण के लिए क्लास के बारे में जानने के लिए, इस बारे में ExternalRoleMapperImpl नमूना लागू करना क्लास नीचे दी गई है. इस क्लास में आपको को अपने ग्रुप दिखाने के लिए लागू करना चाहिए.
  5. management-server.properties फ़ाइल को सेव करें.
  6. पक्का करें कि management-server.properties का मालिकाना हक किसके पास है apigee उपयोगकर्ता:?
    अभी तक किसी भी व्यक्ति ने चेक इन नहीं किया है > चॉन एपीआईजी:पिजी /opt/apigee/customer/application/management-server.properties
  7. मैनेजमेंट सर्वर शुरू करें:
    > /opt/apigee/apigee-service/bin/apigee-service एज-मैनेजमेंट-सर्वर स्टार्ट

संगठन से बाहर के लोगों को अनुमति देने की सुविधा बंद की जा रही है

बाहरी प्राधिकरण को अक्षम करने के लिए:

  1. /opt/apigee/customer/application/management-server.properties खोलें टेक्स्ट एडिटर में मिलता है. अगर फ़ाइल मौजूद नहीं है, तो उसे बनाएं.
  2. पुष्टि करने वाले उपयोगकर्ता स्टोर को ldap में बदलें:
    conf_security_authentication.user.store=ldap
  3. इस प्रॉपर्टी को गलत पर सेट करें:
    conf_security_externalized.authentication.role.mapper.enabled=false
  4. मैनेजमेंट सर्वर को रीस्टार्ट करें:
    > /opt/apigee/apigee-service/bin/apigee-service एज-मैनेजमेंट-सर्वर स्टार्ट

ExternalRoleMapperImpl के बारे में जानकारी लागू करने का सैंपल

बाहरी भूमिका की मैपिंग को चालू करना में, सुरक्षा के तौर पर प्रॉपर्टी की जिस कॉन्फ़िगरेशन फ़ाइल के बारे में पहले बताया गया है उसमें यह लाइन देखें:

externalized.authentication.role.mapper.implementation.class=com.customer.authorization.impl.ExternalRoleMapperImpl

यह क्लास ExternalRoleMapperServiceV2 इंटरफ़ेस को लागू करती है और इसकी ज़रूरत होती है. आपको ये काम करने होंगे इस क्लास को अपने हिसाब से लागू करें, जो आपके ग्रुप को दिखाता हो. काम पूरा हो जाने पर, कंपाइल की गई क्लास को JAR में रखें और उस JAR को मैनेजमेंट सर्वर के क्लासपाथ में रखें:

/opt/apigee/edge-management-server/lib/thirdparty/
अभी तक किसी भी व्यक्ति ने चेक इन नहीं किया है

क्लास और पैकेज को कोई भी नाम दिया जा सकता है, बशर्ते यह लागू हो ExternalRoleMapperServiceV2, आपके क्लासपाथ में ऐक्सेस किया जा सकता है और management-server.property कॉन्फ़िगरेशन फ़ाइल.

नीचे हमने एक 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();
   }

}