عیب‌یابی خطای استقرار خط‌مشی «اظهارات SAML»

درحال مشاهده اسناد Apigee Edge هستید.
به اسناد Apigee X بروید.
اطلاعات

SourceNotConfigured

پیام خطا

استقرار پراکسی API ازطریق «واسط کاربر 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.

نماگرفت خطای نمونه

علت

اگر یک یا چند عنصر زیر از خط‌مشی «تأیید ادعای SAML» تعریف نشده یا خالی باشد، استقرار «پراکسی API» با این خطا ناموفق خواهد بود: <Source>، <XPath>، <Namespaces>، <Namespace>.

برای مثال، اگر عنصر <XPath> را ازدست بدهید یا عنصر <Source> یا نهادهای آن را خالی بگذارید، استقرار پراکسی API با شکست مواجه می‌شود.

تشخیص

  1. نام خط‌مشی «ادعای SAML اعتبارسنجی» ناموفق را از پیام خطا شناسایی کنید. برای مثال، در خطای زیر، نام خط‌مشی «ادعای SAML را درستی‌سنجی کنید» Validate-SAML-Assertion-1 است.

    ValidateSAMLAssertion[Validate-SAML-Assertion-1]: Source is not correctly configured.
    
  2. «زبان نشانه‌گذاری توسعه‌پذیر» خط‌مشی «ادعای SAML» ناموفق را بررسی کنید. بررسی کنید که یک یا چند عنصر زیر از خط‌مشی ازدست رفته یا خالی است: <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 ازطریق «واسط کاربر 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 مشخص نشده باشد، استقرار میانای برنامه‌سازی کاربردی با شکست مواجه می‌شود. ‫Trust Store معتبر الزامی است.

تشخیص

  1. همه خط‌مشی‌های «تأیید ادعای SAML» را در «پراکسی API» خاصی که خطا در آن رخ داده است بررسی کنید. اگر خط‌مشی «ادعای SAML را درستی‌سنجی کنید» وجود دارد که عنصر <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> را با مقدار معتبر مشخص کنید.

<?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>

برای کسب اطلاعات بیشتر درباره نحوه استفاده از «مخزن مطمئن»، به مخازن مطمئن و مخازن کلید مراجعه کنید.

NullKeyStore

پیام خطا

استقرار پراکسی «میانای برنامه‌سازی کاربردی» ازطریق «واسط کاربر Edge» یا «میانای برنامه‌سازی کاربردی مدیریت Edge» با این پیام خطا ناموفق است:

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» خاصی که خطا در آن رخ داده است بررسی کنید. اگر خط‌مشی «اظهارنامه SAML تولید» وجود داشته باشد که در آن عنصر فرزند <Name> خالی باشد یا در عنصر <Keystore> مشخص نشده باشد، در این صورت این خط‌مشی دلیل بروز خطا است.

    خط‌مشی «تولید ادعای SAML» زیر عنصر فرزند خالی <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 ازطریق «واسط کاربر 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. همه خط‌مشی‌های «تولید ادعای SAML» را در «پراکسی API» خاصی که خطا در آن رخ داده است بررسی کنید. اگر خط‌مشی «اظهارنامه SAML تولید» وجود داشته باشد که در آن عنصر فرزند <Alias> خالی باشد یا در عنصر <Keystore> مشخص نشده باشد، در این صورت این خط‌مشی دلیل بروز خطا است.

    خط‌مشی «تولید ادعای SAML» زیر عنصر فرزند خالی <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 ازطریق «واسط کاربر 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. همه خط‌مشی‌های «تولید ادعای SAML» را در «پراکسی API» خاصی که خطا در آن رخ داده است بررسی کنید. اگر خط‌مشی «اظهارنامه SAML تولید» وجود داشته باشد که عنصر <Issuer> در آن خالی باشد یا مشخص نشده باشد، این خط‌مشی دلیل خطا است.

    خط‌مشی «تولید ادعای SAML» زیر عنصر <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 مراجعه کنید.