LDAP नीति

यह Apigee Edge के दस्तावेज़ हैं.
पर जाएं Apigee X दस्तावेज़. info

क्या

एलडीएपी नीति से ये सुविधाएं मिलती हैं:

• पुष्टि करना: अनुरोध में दिए गए उपयोगकर्ता क्रेडेंशियल की पुष्टि, एलडीएपी सेवा देने वाली कंपनी के क्रेडेंशियल के आधार पर की जाती है. एलडीएपी नीति की मदद से, पुष्टि करने की प्रोसेस को अपनी ज़रूरत के हिसाब से सेट किया जा सकता है. इसमें पासवर्ड के साथ-साथ, किसी भी डीएन वैल्यू का इस्तेमाल किया जा सकता है. भले ही, अनुरोध में वह डीएन वैल्यू शामिल न हो. उदाहरण के लिए, मान लें कि आपको पुष्टि करने के लिए ईमेल / पासवर्ड का इस्तेमाल करना है. इसके लिए, ये विकल्प उपलब्ध हैं:
  • अगर अनुरोध में ईमेल शामिल है, तो एलडीएपी से पुष्टि करने के लिए, पासवर्ड के साथ उस ईमेल का इस्तेमाल किया जा सकता है.
  • अगर अनुरोध में ईमेल शामिल नहीं है, लेकिन कोई दूसरा डीएन एट्रिब्यूट (जैसे, फ़ोन नंबर) शामिल है, एलडीएपी से उससे जुड़ा ईमेल पाने के लिए, फ़ोन नंबर का इस्तेमाल किया जा सकता है. इसके बाद, पुष्टि करने के लिए ईमेल / पासवर्ड का इस्तेमाल किया जा सकता है.
• डिस्टिंग्विश्ड नेम (डीएन) की खोज: पुष्टि करने के अलावा, एलडीएपी नीति का इस्तेमाल करके, अनुरोध में मौजूद किसी उपयोगकर्ता एट्रिब्यूट की पहचान भी की जा सकती है. जैसे, ईमेल. इसके बाद, एक क्वेरी की जा सकती है, जो उस उपयोगकर्ता के लिए एलडीएपी से अन्य डीएन एट्रिब्यूट को वापस लाती है. वापस लाया गया डीएन, किसी वैरिएबल में सेव किया जाता है.

एलडीएपी नीति का इस्तेमाल तब करें, जब सुरक्षित किए गए संसाधनों का ऐक्सेस, एलडीएपी सेवा देने वाली कंपनी के उपयोगकर्ताओं तक सीमित रखना हो. जैसे, एडमिन उपयोगकर्ता, संगठन के उपयोगकर्ता, और डेवलपर. खास तौर पर, तब जब OAuth टोकन ऐक्सेस की ज़रूरत न हो या वह बहुत ज़्यादा मुश्किल हो. इस नीति को, एपीआई प्रॉक्सी फ़्लो में इस्तेमाल करने के लिए, डोमेन नेम के मेटाडेटा को वापस लाने के लिए भी डिज़ाइन किया गया है.

उदाहरण के लिए, एपीआई कॉल को सिर्फ़ तब एक्ज़ीक्यूट किया जा सकता है, जब एलडीएपी के आधार पर किसी उपयोगकर्ता की पुष्टि हो जाए . इसके बाद, पुष्टि होने पर, उपयोगकर्ता के लिए डीएन (डोमेन नेम) एट्रिब्यूट को वापस लाया जा सकता है .

ज़्यादा जानकारी के लिए, ये लेख पढ़ें:

• एपीआई मैनेजमेंट के लिए, डिफ़ॉल्ट एलडीएपी पासवर्ड नीति को मैनेज करना
• Apigee कम्यूनिटी में "आपकी पासवर्ड नीति के बारे में अहम जानकारी"

सैंपल

<Ldap name="4GLdapPolicy">
   <LdapResource>ldap1</LdapResource>
   <Authentication>
       <UserName ref="request.header.username"/>
       <Password ref="request.header.password"/>
       <Scope>subtree</Scope>
       <BaseDN ref="apigee.baseDN"></BaseDN> <!-- default is dc=apigee,dc=com -->
    </Authentication>
 </Ldap>

<Ldap name="LdapPolicy">
   <LdapResource>ldap1</LdapResource>
   <Authentication>
       <Password ref="request.header.password"/>
       <SearchQuery>mail={request.header.mail}</SearchQuery>
       <Scope>subtree</Scope>
       <BaseDN ref="apigee.baseDN"></BaseDN> <!-- default is dc=apigee,dc=com -->
    </Authentication>
 </Ldap>

<Ldap name="LdapPolicy">
    <!-- using a custom LDAP provider -->
    <LdapConnectorClass>com.custom.ldap.MyProvider</LdapConnectorClass>
    <LdapResource>MyLdap</LdapResource>
    <Search>
        <BaseDN ref="apigee.baseDN"></BaseDN> <!-- default is dc=apigee,dc=com -->
        <SearchQuery>mail={request.header.mail}</SearchQuery>
        <Attributes>
            <Attribute>address</Attribute>
            <Attribute>phone</Attribute>
            <Attribute>title</Attribute>
        </Attributes>
        <Scope></Scope> <!-- default is ‘subtree’ -->
    </Search>
</Ldap>

एलिमेंट रेफ़रंस

यहां एलडीएपी नीति के एलिमेंट और एट्रिब्यूट के बारे में बताया गया है.

<Attributes>
  <Attribute>address</Attribute>
  <Attribute>phone</Attribute>
  <Attribute>title</Attribute>
</Attributes>

इस्तेमाल की जानकारी

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

एलडीएपी संसाधन बनाना

एलडीएपी नीति, Apigee Edge में बनाए गए एलडीएपी संसाधन का इस्तेमाल करती है. एलडीएपी संसाधन आपके एलडीएपी डेटाबेस के लिए कनेक्शन की जानकारी देता है.

एलडीएपी संसाधन बनाने और उन्हें मैनेज करने के लिए, यह एपीआई और पेलोड इस्तेमाल करें:

एपीआई

एलडीएपी संसाधन बनाना (POST) या सभी एलडीएपी संसाधनों की सूची (GET) पाना:

/v1/organizations/org_name/environments/environment/ldapresources

किसी एलडीएपी संसाधन की जानकारी (GET) पाना, उसे अपडेट (POST) करना, और मिटाना (DELETE):

/v1/organizations/org_name/environments/environment/ldapresources/ldap_resource_name

पेलोड

यहां इस्तेमाल के लिए टिप्पणियों के साथ, एक्सएमएल पेलोड का एक सैंपल दिया गया है.

<LdapResource name="ldap1">
  <Connection>
    <Hosts>
      <!-- port is optional: defaults to 389 for ldap:// and 636 for ldaps:// -->
      <Host port="636">foo.com</Host>
    </Hosts>
    <SSLEnabled>false</SSLEnabled> <!-- optional, defaults to false -->
    <Version>3</Version> <!-- optional, defaults to 3-->
    <Authentication>simple</Authentication> <!-- optional, only simple supported -->
    <ConnectionProvider>jndi|unboundid</ConnectionProvider> <!-- required -->
    <ServerSetType>single|round robin|failover</ServerSetType> <!-- not applicable for jndi -->
    <!-- If using a custom LDAP provider, the fully qualified class: -->
    <LdapConnectorClass>com.custom.ldap.MyProvider</LdapConnectorClass>
  </Connection>
  <ConnectPool enabled="true"> <!-- enabled is optional, defaults to true -->
    <Timeout>30000</Timeout> <!-- optional, in milliseconds; if not set, no timeout -->
    <Maxsize>50</Maxsize> <!-- optional; if not set, no max connections -->
    <Prefsize>30</Prefsize> <!-- optional; if not set, no pref size -->
    <Initsize></Initsize> <!-- optional; if not set, defaults to 1 -->
    <Protocol></Protocol> <!-- optional; if not set, defaults to 'ssl plain' -->
  </ConnectPool>
  <Admin>
    <DN>cn=manager,dc=apigee,dc=com</DN>
    <Password>secret</Password>
  </Admin>
</LdapResource>

curl का उदाहरण: एलडीएपी संसाधन बनाना

यहां दिए गए उदाहरण में, ldap1 नाम का एलडीएपी संसाधन बनाया गया है.

curl -X POST -H "Content-Type: application/xml" \
  https://api.enterprise.apigee.com/v1/organizations/myorg/environments/test/ldapresources \
  -u apigee_email:password -d \
  '<LdapResource name="ldap1">
    <Connection>
      <Hosts>
      <Host>foo.com</Host>
      </Hosts>
      <SSLEnabled>false</SSLEnabled>
      <Version>3</Version>
      <Authentication>simple</Authentication>
      <ConnectionProvider>unboundid</ConnectionProvider>
      <ServerSetType>round robin</ServerSetType>
    </Connection>
    <ConnectPool enabled="true">
      <Timeout>30000</Timeout>
      <Maxsize>50</Maxsize>
      <Prefsize>30</Prefsize>
      <Initsize></Initsize>
      <Protocol></Protocol>
    </ConnectPool>
    <Admin>
      <DN>cn=manager,dc=apigee,dc=com</DN>
      <Password>secret</Password>
    </Admin>
  </LdapResource>'

रिस्पॉन्स कोड

यहां एचटीएमएल रिस्पॉन्स कोड दिए गए हैं. नीति के सफल होने या फ़ेल होने पर, ये कोड दिखते हैं:

• सफल: 200
• फ़ेल: 401

Edge for Private Cloud में, एलडीएपी सेवा देने वाली कंपनी के कस्टम रेफ़रंस का इस्तेमाल करना

एलडीएपी सेवा देने वाली कंपनी के कस्टम रेफ़रंस का इस्तेमाल करना

Apigee Edge for Private Cloud में, एलडीएपी सेवा देने वाली कंपनी का रेफ़रंस पहले से कॉन्फ़िगर किया गया होता है. इसलिए, यह एलडीएपी नीति के साथ काम करता है. हालांकि, अगर एलडीएपी सेवा देने वाली कंपनी के कस्टम रेफ़रंस का इस्तेमाल किया जा रहा है, तो आपको उसे एलडीएपी नीति के साथ काम करने के लिए, चालू करना होगा. इसके लिए:

1. एलडीएपी सेवा देने वाली कंपनी की क्लास में, ExternalLdapConProvider इंटरफ़ेस लागू करें.

   public interface ExternalLdapConProvider {
     void doAuthentication(LdapBean LlapBean, String userDN, String password, String baseDN);
   
     void doSearchAndAuthentication(LdapBean LlapBean, String password, String baseDN, String query, int scope);
   
     Collection<Map<String, String[]>> doSearch(LdapBean LlapBean, String query,
       String baseDN, Collection<String> requiredAttributes, int scope);
   
     void closeConnections();
   }

2. नीति के कॉन्फ़िगरेशन (अगले सेक्शन) के <LdapConnectorClass> में, एलडीएपी सेवा देने वाली कंपनी के कस्टम रेफ़रंस की क्लास का पूरा नाम जोड़ें.
3. यह फ़ाइल डाउनलोड करें: custom-ldap.jar_.zip. (आपको राइट क्लिक करके, इस नाम से सेव करें चुनना पड़ सकता है.)
4. इसे अनज़िप करें.
5. custom-ldap.jar फ़ाइल को अपने एनवायरमेंट में जोड़ें और पक्का करें कि यह आपके क्लासपाथ में मौजूद हो.
6. एलडीएपी सेवा देने वाली कंपनी के रेफ़रंस के लिए, एनवायरमेंट रिसॉर्स बनाएं. एलडीएपी नीति के <LdapResource> एलिमेंट में, एनवायरमेंट रिसॉर्स के नाम का इस्तेमाल किया जाएगा.

Java के लिए, UnboundID LDAP SDK का इस्तेमाल करना

एलडीएपी नीति के साथ, UnboundID LDAP SDK का इस्तेमाल किया जा सकता है. हालांकि, इसके लिए आपको पहले वर्शन 2.3.1 डाउनलोड करना होगा. इसके बाद, इसे अपने हर मैसेज प्रोसेसर के क्लासपाथ में जोड़ना होगा.

एलडीएपी नीति के साथ, UnboundID LDAP SDK का इस्तेमाल करने के लिए:

1. कोई ब्राउज़र खोलें और UnboundID LDAP SDK के लिए, Sourceforge की फ़ाइल रिपॉज़िटरी पर जाएं:

   https://sourceforge.net/projects/ldap-sdk/files/

2. एसडीके का वर्शन 2.3.1 (SE या Standard Edition) ढूंढें और उस वर्शन के लिए ZIP फ़ाइल डाउनलोड करें. उदाहरण के लिए, "unboundid-ldapsdk-2.3.1-se.zip" डाउनलोड करें.
3. एसडीके की ZIP फ़ाइल से, JAR फ़ाइल एक्सट्रैक्ट करें. जैसा कि यहां दिए गए उदाहरण में दिखाया गया है:

   unzip -j -d ~/tmp ~/Downloads/unboundid-ldapsdk-2.3.1-se.zip unboundid-ldapsdk-2.3.1-se/unboundid-ldapsdk-se.jar

   इस कमांड से, JAR फ़ाइल को सिर्फ़ ~/tmp डायरेक्ट्री में एक्सट्रैक्ट किया जाता है. इसमें डायरेक्ट्री स्ट्रक्चर को -j के साथ ड्रॉप किया जाता है. हालांकि, यह ज़रूरी नहीं है.

4. हर मैसेज प्रोसेसर नोड पर:
   1. JAR फ़ाइल को मैसेज प्रोसेसर की /opt/apigee/edge-gateway/lib/thirdparty डायरेक्ट्री में कॉपी करें.
   2. अगर ज़रूरी हो, तो JAR फ़ाइल पर Apigee उपयोगकर्ता को अनुमति दें, ताकि मैसेज प्रोसेसर इसे ऐक्सेस कर सके.

   Edge, /opt/apigee/edge-gateway/lib/thirdparty डायरेक्ट्री में मौजूद सभी थर्ड पार्टी लाइब्रेरी को क्लासपाथ में जोड़ता है.

   3. मैसेज प्रोसेसर को रीस्टार्ट करें:

      /opt/apigee/apigee-service/bin/apigee-service edge-message-processor restart

फ़्लो वैरिएबल

SearchQuery से, एलडीएपी नीति के ये वैरिएबल भरते हैं.

ldap.policyName.execution.success

ldap.policyName.search.result[index].
  attribute.attrName[index]=value

ldap.policyName.search.result.attribute.address
ldap.policyName.search.result.attribute.phone
ldap.policyName.search.result.attribute.email

ldap.policyName.search.result[3].attribute.address

ldap.policyName.search.result.attribute.mail[2]

गड़बड़ी के कोड

Edge की नीतियों से मिलने वाली गड़बड़ियां, गड़बड़ी के कोड के रेफ़रंस में बताए गए फ़ॉर्मैट के मुताबिक होती हैं.

इस नीति में इन गड़बड़ी कोड का इस्तेमाल किया जाता है: