การแก้ปัญหาข้อผิดพลาดในการทำให้นโยบายการยืนยัน SAML ใช้งานได้

คุณกำลังดูเอกสารประกอบของ Apigee Edge
ไปที่เอกสารประกอบของ Apigee X info

SourceNotConfigured

ข้อความแสดงข้อผิดพลาด

การติดตั้งใช้งานพร็อกซี API ผ่าน UI ของ Edge หรือการจัดการ Edge API จะล้มเหลวพร้อมข้อความแสดงข้อผิดพลาดนี้

Error Deploying Revision revision_number to environment
ValidateSAMLAssertion[policy_name]: Source is not correctly configured.

ตัวอย่างข้อความแสดงข้อผิดพลาด

Error Deploying Revision 2 to test
ValidateSAMLAssertion[Validate-SAML-Assertion-1]: Source is not correctly configured.

ตัวอย่างภาพหน้าจอแสดงข้อผิดพลาด

สาเหตุ

การติดตั้งใช้งานพร็อกซี API จะล้มเหลวพร้อมข้อผิดพลาดนี้หากไม่ได้กำหนดหรือไม่มีองค์ประกอบต่อไปนี้อย่างน้อย 1 รายการในนโยบายตรวจสอบการยืนยัน SAML: <Source>, <XPath>, <Namespaces>, <Namespace>

เช่น หากคุณพลาดองค์ประกอบ <XPath> หรือปล่อยองค์ประกอบ <Source> หรือเอนทิตีขององค์ประกอบนั้นว่างไว้ การติดตั้งใช้งานพร็อกซี API จะล้มเหลว

การวินิจฉัย

1. ระบุชื่อนโยบาย "ตรวจสอบการยืนยัน SAML" ที่ไม่สำเร็จจาก ข้อความแสดงข้อผิดพลาด เช่น ในข้อผิดพลาดต่อไปนี้ ชื่อนโยบาย Validate SAML Assertion คือ Validate-SAML-Assertion-1

   ValidateSAMLAssertion[Validate-SAML-Assertion-1]: Source is not correctly configured.
   

2. ตรวจสอบ XML ของนโยบายการยืนยัน SAML ที่ไม่สำเร็จ ตรวจสอบว่าองค์ประกอบต่อไปนี้อย่างน้อย 1 รายการในนโยบายขาดหายไปหรือว่างเปล่าหรือไม่ <Source>, <XPath>, <Namespaces>, <Namespace> หากเป็นเช่นนั้น นั่นอาจเป็นสาเหตุของข้อผิดพลาด

   ตัวอย่างเช่น นโยบายต่อไปนี้มีองค์ประกอบ <Namespaces> ที่ว่างเปล่า ภายใต้องค์ประกอบ <Source>

   <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
   <ValidateSAMLAssertion name="SAML" ignoreContentType="false">
     <Source name="request">
       <Namespaces></Namespaces>
      </Source>
      <Description/>
    <TrustStore>ref://TrustStoreName</Truststore>
    <RemoveAssertion>false</RemoveAssertion>
   </ValidateSAMLAssertion>
   

3. ในตัวอย่างด้านบน องค์ประกอบ <Namespaces> ว่างเปล่า ดังนั้น คุณจะได้รับข้อผิดพลาดต่อไปนี้

   ValidateSAMLAssertion[Validate-SAML-Assertion-1]: Source is not correctly configured.
   

ความละเอียด

ตรวจสอบว่าได้กำหนดค่าขององค์ประกอบ <Source> อย่างถูกต้อง ด้วยองค์ประกอบ <Namespaces> และองค์ประกอบย่อย <Namespace> นอกจากนี้ คุณต้องตรวจสอบว่าได้กำหนดองค์ประกอบ <XPath> และองค์ประกอบดังกล่าวไม่ว่างเปล่า

หากต้องการแก้ไขตัวอย่างนโยบาย "ตรวจสอบการยืนยัน SAML" ที่แสดงด้านบน คุณ สามารถเพิ่มองค์ประกอบ <Namespace> รวมถึง <XPath> ได้ดังนี้

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ValidateSAMLAssertion name="SAML" ignoreContentType="false">
  <Source name="request">
    <Namespaces>
      <Namespace prefix='soap'>http://schemas.xmlsoap.org/soap/envelope/</Namespace>
      <Namespace prefix='wsse'>http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd</Namespace>
      <Namespace prefix='saml'>urn:oasis:names:tc:SAML:2.0:assertion</Namespace>
    </Namespaces>
    <XPath>/soap:Envelope/soap:Header/wsse:Security/saml:Assertion</XPath>
  </Source>
   <Description/>
<TrustStore>ref://TrustStoreName</Truststore>
<RemoveAssertion>false</RemoveAssertion>
</ValidateSAMLAssertion>

TrustStoreNotConfigured

ข้อความแสดงข้อผิดพลาด

การติดตั้งใช้งานพร็อกซี API ผ่าน UI ของ Edge หรือการจัดการ Edge API จะล้มเหลวพร้อมข้อความแสดงข้อผิดพลาดนี้

Error Deploying Revision revision_number to environment
ValidateSAMLAssertion[[Ljava.lang.Object;@object]: Trust store is not correctly configured.

ตัวอย่างข้อความแสดงข้อผิดพลาด

Error Deploying Revision 2 to test
ValidateSAMLAssertion[[Ljava.lang.Object;@39537262]: Trust store is not correctly configured.

ตัวอย่างภาพหน้าจอแสดงข้อผิดพลาด

สาเหตุ

หากองค์ประกอบ <TrustStore> ว่างเปล่าหรือไม่ได้ระบุไว้ในนโยบาย ValidateSAMLAssertion การติดตั้งใช้งาน API พร็อกซีจะล้มเหลว ต้องระบุ Trust Store ที่ถูกต้อง

การวินิจฉัย

1. ตรวจสอบนโยบายการยืนยัน SAML ทั้งหมดใน API Proxy ที่เฉพาะเจาะจงซึ่งเกิดข้อผิดพลาด หากมีนโยบาย Validate SAML Assertion ที่มีองค์ประกอบ <TrustStore> ว่างเปล่า หรือไม่ได้ระบุ นั่นคือสาเหตุของข้อผิดพลาด

   <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
   <ValidateSAMLAssertion name="SAML" ignoreContentType="false">
    <Source name="request">
       <Namespaces>
         <Namespace prefix='soap'>http://schemas.xmlsoap.org/soap/envelope/</Namespace>
         <Namespace prefix='wsse'>http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd</Namespace>
         <Namespace prefix='saml'>urn:oasis:names:tc:SAML:2.0:assertion</Namespace>
       </Namespaces>
       <XPath>/soap:Envelope/soap:Header/wsse:Security/saml:Assertion</XPath>
     </Source>
       <Description/>
       <TrustStore/>
     <RemoveAssertion>false</RemoveAssertion>
   </ValidateSAMLAssertion>
   

ความละเอียด

ตรวจสอบว่าได้ระบุองค์ประกอบ <TrustStore> เสมอและ ไม่ว่างเปล่าภายในนโยบาย "ตรวจสอบการยืนยัน SAML" <TrustStore> ชื่อควรตรงกับชื่อของ TrustStore ที่ถูกต้อง ซึ่งมีอยู่ในสภาพแวดล้อมทั้งหมดที่คุณพยายามจะติดตั้งใช้งาน พร็อกซี

หากต้องการแก้ไขตัวอย่างข้างต้น คุณสามารถระบุ<TrustStore> องค์ประกอบที่มีค่าที่ถูกต้องได้

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ValidateSAMLAssertion name="SAML" ignoreContentType="false">
  <Source name="request">
    <Namespaces>
      <Namespace prefix='soap'>http://schemas.xmlsoap.org/soap/envelope/</Namespace>
      <Namespace prefix='wsse'>http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd</Namespace>
      <Namespace prefix='saml'>urn:oasis:names:tc:SAML:2.0:assertion</Namespace>
    </Namespaces>
    <XPath>/soap:Envelope/soap:Header/wsse:Security/saml:Assertion</XPath>
  </Source>
  <TrustStore>TrustStoreName</TrustStore>
  <RemoveAssertion>false</RemoveAssertion>
</ValidateSAMLAssertion>

ดูข้อมูลเพิ่มเติมเกี่ยวกับวิธีใช้ Truststore ได้ที่ที่เก็บใบรับรองที่เชื่อถือได้และที่เก็บคีย์

NullKeyStore

ข้อความแสดงข้อผิดพลาด

การติดตั้งใช้งานพร็อกซี API ผ่าน UI ของ Edge หรือ Edge management API จะล้มเหลวพร้อมข้อความแสดงข้อผิดพลาดนี้

Error Deploying Revision revision_number to environment
Assertion KeyStore name cannot be null.

ตัวอย่างข้อความแสดงข้อผิดพลาด

Error Deploying Revision 4 to test
Assertion KeyStore name cannot be null.

ตัวอย่างภาพหน้าจอแสดงข้อผิดพลาด

สาเหตุ

หากองค์ประกอบย่อย <Name> ว่างเปล่าหรือไม่ได้ระบุไว้ในองค์ประกอบ <Keystore> ของนโยบาย GenerateSAMLAssertion การ ทําให้ใช้งานพร็อกซี API จะล้มเหลว ต้องระบุชื่อ Keystore ที่ถูกต้อง

การวินิจฉัย

1. ตรวจสอบนโยบายการสร้างการยืนยัน SAML ทั้งหมดในพร็อกซี API ที่เฉพาะเจาะจง ซึ่งเกิดข้อผิดพลาด หากมีนโยบาย Generate SAML Assertion ที่องค์ประกอบย่อย <Name> ว่างเปล่าหรือไม่ได้ระบุไว้ในองค์ประกอบ <Keystore> นั่นคือสาเหตุของข้อผิดพลาด

   นโยบาย Generate SAML Assertion ต่อไปนี้มีองค์ประกอบย่อย <Name> ที่ว่างเปล่าในองค์ประกอบ <Keystore>

   <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
   <GenerateSAMLAssertion name="SAML" ignoreContentType="false">`
     <CanonicalizationAlgorithm />
     <Issuer ref="reference">Issuer name</Issuer>
     <KeyStore>
       <Name></Name>
       <Alias ref="reference">alias</Alias>
     </KeyStore>
     <OutputVariable>
       <FlowVariable>assertion.content</FlowVariable>
       <Message name="request">
         <Namespaces>
           <Namespace prefix="test">http://www.example.com/test</Namespace>
         </Namespaces>
         <XPath>/envelope/header</XPath>
       </Message>
     </OutputVariable>
     <SignatureAlgorithm />
     <Subject ref="reference">Subject name</Subject>
     <Template ignoreUnresolvedVariables="false">
       <!-- A lot of XML goes here, in CDATA, with {} around
            each variable -->
     </Template>
   </GenerateSAMLAssertion>
   

ความละเอียด

ตรวจสอบว่าได้ระบุองค์ประกอบย่อย <Name> เสมอและ ไม่ว่างภายในองค์ประกอบ <Keystore> ของนโยบายสร้างการยืนยัน SAML

หากต้องการแก้ไขตัวอย่างข้างต้น คุณสามารถระบุองค์ประกอบ <Name> ให้ถูกต้อง รวมถึงตรวจสอบว่าได้ระบุค่าที่ถูกต้องให้กับองค์ประกอบ <Alias> แล้ว

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<GenerateSAMLAssertion name="SAML" ignoreContentType="false">
  <CanonicalizationAlgorithm />
  <Issuer ref="reference">Issuer name</Issuer>
  <KeyStore>
    <Name ref="reference">keystorename</Name>
    <Alias ref="reference">alias</Alias>
  </KeyStore>
  <OutputVariable>
    <FlowVariable>assertion.content</FlowVariable>
    <Message name="request">
      <Namespaces>
        <Namespace prefix="test">http://www.example.com/test</Namespace>
      </Namespaces>
      <XPath>/envelope/header</XPath>
    </Message>
  </OutputVariable>
  <SignatureAlgorithm />
  <Subject ref="reference">Subject name</Subject>
  <Template ignoreUnresolvedVariables="false">
    <!-- A lot of XML goes here, in CDATA, with {} around
         each variable -->
  </Template>
</GenerateSAMLAssertion>

ดูตัวอย่างจากตัวอย่างโค้ดในบทความอ้างอิงนโยบาย SAMLAssertion

NullKeyStoreAlias

ข้อความแสดงข้อผิดพลาด

การติดตั้งใช้งานพร็อกซี API ผ่าน UI ของ Edge หรือการจัดการ Edge API จะล้มเหลวพร้อมข้อความแสดงข้อผิดพลาดนี้

Error Deploying Revision revision_number to environment
Assertion KeyStore alias cannot be null.

ตัวอย่างข้อความแสดงข้อผิดพลาด

Error Deploying Revision 4 to test
Assertion KeyStore alias cannot be null.

ตัวอย่างภาพหน้าจอแสดงข้อผิดพลาด

สาเหตุ

หากองค์ประกอบย่อย <Alias> ว่างเปล่าหรือไม่ได้ระบุไว้ในองค์ประกอบ <Keystore> ของนโยบายสร้างการยืนยัน SAML การ ติดตั้งใช้งานพร็อกซี API จะล้มเหลว ต้องระบุนามแฝง Keystore ที่ถูกต้อง

การวินิจฉัย

1. ตรวจสอบนโยบาย Generate SAML Assertion ทั้งหมดใน API Proxy ที่เฉพาะเจาะจงซึ่งเกิดข้อผิดพลาด หากมีนโยบาย Generate SAML Assertion ที่องค์ประกอบย่อย <Alias> ว่างเปล่าหรือไม่ได้ระบุไว้ในองค์ประกอบ <Keystore> นั่นคือสาเหตุของข้อผิดพลาด

   นโยบาย Generate SAML Assertion ต่อไปนี้มีองค์ประกอบย่อย <Alias> ที่ว่างเปล่าในองค์ประกอบ <Keystore>

   <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
   <GenerateSAMLAssertion name="SAML" ignoreContentType="false">`
     <CanonicalizationAlgorithm />
     <Issuer ref="reference">Issuer name</Issuer>
     <KeyStore>
       <Name ref="reference">keystorename</Name>
       <Alias></Alias>
     </KeyStore>
     <OutputVariable>
       <FlowVariable>assertion.content</FlowVariable>
       <Message name="request">
         <Namespaces>
           <Namespace prefix="test">http://www.example.com/test</Namespace>
         </Namespaces>
         <XPath>/envelope/header</XPath>
       </Message>
     </OutputVariable>
     <SignatureAlgorithm />
     <Subject ref="reference">Subject name</Subject>
     <Template ignoreUnresolvedVariables="false">
       <!-- A lot of XML goes here, in CDATA, with {} around
            each variable -->
     </Template>
   </GenerateSAMLAssertion>
   

ความละเอียด

ตรวจสอบว่าได้ระบุองค์ประกอบย่อย <Name> และองค์ประกอบย่อยดังกล่าวต้องไม่ว่างเปล่า ภายในองค์ประกอบ <Keystore> ของนโยบายการสร้างการยืนยัน SAML เสมอ

หากต้องการแก้ไขตัวอย่างข้างต้น คุณสามารถระบุองค์ประกอบ <Alias> อย่างถูกต้อง รวมถึงตรวจสอบว่าได้ระบุค่าที่ถูกต้องให้กับองค์ประกอบ <Name>

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<GenerateSAMLAssertion name="SAML" ignoreContentType="false">
  <CanonicalizationAlgorithm />
  <Issuer ref="reference">Issuer name</Issuer>
  <KeyStore>
    <Name ref="reference">keystorename</Name>
    <Alias ref="reference">alias</Alias>
  </KeyStore>
  <OutputVariable>
    <FlowVariable>assertion.content</FlowVariable>
    <Message name="request">
      <Namespaces>
        <Namespace prefix="test">http://www.example.com/test</Namespace>
      </Namespaces>
      <XPath>/envelope/header</XPath>
    </Message>
  </OutputVariable>
  <SignatureAlgorithm />
  <Subject ref="reference">Subject name</Subject>
  <Template ignoreUnresolvedVariables="false">
    <!-- A lot of XML goes here, in CDATA, with {} around
         each variable -->
  </Template>
</GenerateSAMLAssertion>

ดูตัวอย่างจากตัวอย่างโค้ดในบทความอ้างอิงนโยบาย SAMLAssertion

NullIssuer

ข้อความแสดงข้อผิดพลาด

การติดตั้งใช้งานพร็อกซี API ผ่าน UI ของ Edge หรือการจัดการ Edge API จะล้มเหลวพร้อมข้อความแสดงข้อผิดพลาดนี้

Error Deploying Revision revision_number to environment
Assertion Issuer cannot be null.

ตัวอย่างข้อความแสดงข้อผิดพลาด

Error Deploying Revision 4 to test
Assertion Issuer cannot be null.

ตัวอย่างภาพหน้าจอแสดงข้อผิดพลาด

สาเหตุ

หากองค์ประกอบ <Issuer> ว่างเปล่าหรือไม่ได้ระบุไว้ในนโยบายสร้างการยืนยัน SAML การติดตั้งใช้งานพร็อกซี API จะล้มเหลว ต้องระบุค่า <Issuer>ที่ถูกต้อง

การวินิจฉัย

1. ตรวจสอบนโยบาย Generate SAML Assertion ทั้งหมดใน API Proxy ที่เฉพาะเจาะจงซึ่งเกิดข้อผิดพลาด หากมีนโยบายสร้างการยืนยัน SAML ซึ่งองค์ประกอบ <Issuer> ว่างเปล่าหรือไม่ได้ ระบุ นั่นคือสาเหตุของข้อผิดพลาด

   นโยบาย Generate SAML Assertion ต่อไปนี้มีองค์ประกอบ <Issuer> ที่ว่างเปล่า

   <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
   <GenerateSAMLAssertion name="SAML" ignoreContentType="false">`
     <CanonicalizationAlgorithm />
     <Issuer></Issuer>
     <KeyStore>
       <Name ref="reference">keystorename</Name>
       <Alias ref="reference">alias</Alias>
     </KeyStore>
     <OutputVariable>
       <FlowVariable>assertion.content</FlowVariable>
       <Message name="request">
         <Namespaces>
           <Namespace prefix="test">http://www.example.com/test</Namespace>
         </Namespaces>
         <XPath>/envelope/header</XPath>
       </Message>
     </OutputVariable>
     <SignatureAlgorithm />
     <Subject ref="reference">Subject name</Subject>
     <Template ignoreUnresolvedVariables="false">
       <!-- A lot of XML goes here, in CDATA, with {} around
            each variable -->
     </Template>
   </GenerateSAMLAssertion>
   

ความละเอียด

ตรวจสอบว่าได้ระบุองค์ประกอบ <Issuer> เสมอและองค์ประกอบดังกล่าวต้องไม่ว่างเปล่าในนโยบายการสร้างการยืนยัน SAML

หากต้องการแก้ไขตัวอย่างข้างต้น ให้ระบุองค์ประกอบ <Issuer> อย่างถูกต้อง

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<GenerateSAMLAssertion name="SAML" ignoreContentType="false">
  <CanonicalizationAlgorithm />
  <Issuer ref="reference">Issuer name</Issuer>
  <KeyStore>
    <Name ref="reference">keystorename</Name>
    <Alias ref="reference">alias</Alias>
  </KeyStore>
  <OutputVariable>
    <FlowVariable>assertion.content</FlowVariable>
    <Message name="request">
      <Namespaces>
        <Namespace prefix="test">http://www.example.com/test</Namespace>
      </Namespaces>
      <XPath>/envelope/header</XPath>
    </Message>
  </OutputVariable>
  <SignatureAlgorithm />
  <Subject ref="reference">Subject name</Subject>
  <Template ignoreUnresolvedVariables="false">
    <!-- A lot of XML goes here, in CDATA, with {} around
         each variable -->
  </Template>
</GenerateSAMLAssertion>

ดูตัวอย่างจากตัวอย่างโค้ดในบทความอ้างอิงนโยบาย SAMLAssertion