Règles SAMLAssertion

Vous consultez la documentation d'Apigee X.
Consultez la documentation d'Apigee Edge.

icône de la règle

Événement

  • Authentification et autorisation entrantes : valider la règle SAMLAssertion
    Le type de règle SAML permet aux proxys d'API de valider les assertions SAML associées aux requêtes SOAP entrantes. La règle SAML valide les messages entrants contenant une assertion SAML signée numériquement, les rejette s'ils ne sont pas valides et définit des variables autorisant des règles supplémentaires, ou les services de backend, à valider davantage les informations dans l'assertion.
  • Génération de jetons sortants : générer une règle SAMLAssertion
    Le type de règle SAML permet aux proxys d'API d'associer des assertions SAML aux requêtes XML sortantes. Ces assertions sont ensuite mises à disposition pour permettre aux services de backend d'appliquer un traitement de sécurité supplémentaire pour l'authentification et l'autorisation.

Exemples

Générer une assertion SAML

<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="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>
      </Namespaces>
      <XPath>/soap:Envelope/soap:Header/wsse:Security</XPath>
    </Message>
  </OutputVariable>
  <SignatureAlgorithm />
  <Subject ref="reference">Subject name</Subject>
  <Template ignoreUnresolvedVariables="false">
    <!-- A lot of XML goes here, within CDATA, with {} around
         each variable -->
  </Template>
</GenerateSAMLAssertion>

Générer une assertion SAML

Valider une assertion SAML

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

Valider une assertion SAML


Documentation de référence des éléments

Générer une assertion SAML

Nom du champ Description
Attribut name Nom de l'instance de règle. Le nom doit être unique au sein de l'organisation. Les caractères que vous pouvez utiliser dans le nom se limitent à : A-Z0-9._\-$ %. L'UI Apigee applique cependant des restrictions supplémentaires, telles que la suppression automatique des caractères non alphanumériques.
Attribut ignoreContentType Valeur booléenne pouvant être définie sur true ou false. Par défaut, l'assertion n'est pas générée si le type de contenu du message n'est pas un type de contenu XML. Si cet attribut est défini sur true, le message est traité au format XML indépendamment du type de contenu.
Issuer
Identifiant unique du fournisseur d'identité. Si l'attribut facultatif ref est présent, la valeur de l'émetteur est attribuée au moment de l'exécution en fonction de la variable spécifiée. Si l'attribut facultatif ref n'est pas présent, la valeur de l'émetteur est utilisée.
KeyStore
Nom du keystore contenant la clé privée et l'alias de la clé privée utilisée pour signer numériquement les assertions SAML.
OutputVariable
FlowVariable
Message Cible de la règle. Les valeurs valides sont message, request et response. Lorsque ce champ est défini sur message, la règle récupère l'objet du message de manière conditionnelle en fonction de son point de rattachement. Lorsqu'elle est associée au flux de requête, la règle résout message pour la requête et, lorsqu'elle est associée au flux de réponse, la stratégie résout message en réponse.
XPath Expression XPath qui indique l'élément du document XML sortant auquel la règle va associer l'assertion SAML.
SignatureAlgorithm SHA1 ou SHA256
Subject
Identifiant unique de l'objet de l'assertion SAML. Si l'attribut facultatif ref est présent, la valeur du champ "Subject" est attribuée au moment de l'exécution en fonction de la variable spécifiée. Si l'attribut facultatif ref est présent, la valeur de "Subject" est utilisée.
Template
Si elle est présente, l'assertion sera générée en exécutant ce modèle, en remplaçant tout ce qui désigne {} par la variable correspondante, puis en signant numériquement le résultat. Le modèle est traité conformément au contenu de la règle AssignMessage. Consultez la section sur la règle AssignMessage.

Valider une assertion SAML

Nom du champ Description
Attribut name
Nom de l'instance de règle. Le nom doit être unique au sein de l'organisation. Les caractères que vous pouvez utiliser dans le nom se limitent à : A-Z0-9._\-$ %. L'UI Apigee applique cependant des restrictions supplémentaires, telles que la suppression automatique des caractères non alphanumériques.
Attribut ignoreContentType Valeur booléenne pouvant être définie sur true ou false. Par défaut, l'assertion n'est pas générée si le type de contenu du message n'est pas un type de contenu XML. Si cet attribut est défini sur true, le message est traité au format XML indépendamment du type de contenu.
Source Cible de la règle. Les valeurs valides sont message, request et response. Lorsque ce champ est défini sur message, la règle récupère l'objet du message de manière conditionnelle en fonction de son point de rattachement. Lorsqu'elle est associée au flux de requête, la règle résout message pour la requête et, lorsqu'elle est associée au flux de réponse, la stratégie résout message en réponse.
XPath
Enfant de Source. Expression XPath indiquant l'élément du document XML entrant à partir duquel la règle peut extraire l'assertion SAML.
TrustStore
Nom du truststore contenant les certificats X.509 approuvés pour valider les signatures numériques sur les assertions SAML.
RemoveAssertion
Valeur booléenne pouvant être définie sur true ou false. Si elle définie sur true, l'assertion SAML est supprimée du message de la requête avant que le message soit transféré au service de backend.

Remarques sur l'utilisation

La spécification SAML (Security Assertion Markup Language) définit les formats et les protocoles permettant aux applications d'échanger des informations au format XML pour l'authentification et l'autorisation.

Une "assertion de sécurité" est un jeton de confiance qui décrit un attribut d'une application, d'un utilisateur de l'application ou d'un autre participant à une transaction. Les assertions de sécurité sont gérées et utilisées par deux types d'entités :

  • Fournisseurs d'identité : générer des assertions de sécurité pour le compte des participants
  • Fournisseurs de services : valider les assertions de sécurité via des relations de confiance avec les fournisseurs d'identité

La plate-forme d'API peut agir en tant que fournisseur d'identité et en tant que fournisseur de services. Elle agit comme fournisseur d'identité en générant des assertions et en les associant aux messages de requête, ce qui les rend disponibles pour traitement par les services de backend. Elle agit en tant que fournisseur de services en validant les assertions sur les messages de requête entrants.

La règle de type SAML accepte les assertions SAML correspondant à la version 2.0 de la spécification SAML Core et à la version 1.0 de la spécification de profil de jeton SAML WS-Security.

Générer une assertion SAML

Traitement des règles :

  1. Si le message n'est pas au format XML et que le paramètre IgnoreContentType n'est pas défini sur true, une erreur est générée.
  2. Si le champ "Template" est défini, le modèle est traité comme décrit dans la règle AssignMessage. Si des variables sont manquantes et que IgnoreUnresolvedVariables n'est pas défini, une erreur est générée.
  3. Si le champ "Template" (Modèle) n'est pas défini, créez une assertion qui inclut les valeurs des paramètres "Subject" et "Issuer", ou leurs références.
  4. Signez l'assertion à l'aide de la clé spécifiée.
  5. Ajoutez l'assertion au message sur le chemin XPath spécifié.

Valider une assertion SAML

Traitement des règles :

  1. La règle vérifie le message entrant pour vérifier que le média de la requête est de type XML, en vérifiant si le type de contenu correspond aux formats text/(.*+)?xml ou application/(.*+)?xml. Si le contenu n'est pas de type XML ou si "IgnoreContentType" n'est pas défini, la règle génère une erreur.
  2. La règle analyse le fichier XML. Si l'analyse échoue, une erreur est générée.
  3. La règle valide la signature numérique XML à l'aide des valeurs de "TrustStore" et "ValidateSigner", comme décrit ci-dessus. Si la validation échoue, une erreur est générée.
  4. Si celles-ci sont présentes, la règle vérifie l'horodatage actuel par rapport aux éléments "NotBefore" et "NotOnOrAfter" de l'assertion, comme décrit dans la section SAML Core 2.5.1.
  5. Toute règle supplémentaire pour le traitement des "Conditions", comme décrit dans la section 2.5.1.1 de SAML Core.

Une fois la règle appliquée sans générer d'erreur, le développeur du proxy peut s'assurer des points suivants :

  • La signature numérique de la déclaration est valide et a été signée par une autorité de certification de confiance.
  • L'assertion est valide pour la période en cours.
  • L'objet et l'émetteur de l'assertion sont extraits et définis dans des variables de flux. Il est de la responsabilité des autres règles d'utiliser ces valeurs pour une authentification supplémentaire, par exemple pour vérifier que le nom de l'objet est valide ou qu'il est transmis à un système cible pour validation.

D'autres règles, telles que ExtractVariables, peuvent être utilisées pour analyser le code XML brut de l'assertion pour une validation plus complexe.


Variables de flux

De nombreuses informations peuvent être spécifiées dans une assertion SAML. L'assertion SAML elle-même est un fichier XML pouvant être analysé à l'aide de la règle ExtractVariables et d'autres mécanismes afin de mettre en œuvre des validations plus complexes.

Variable Description
saml.id ID d'assertion SAML
saml.issuer Émetteur de l'assertion, converti de son type XML natif en chaîne
saml.subject Objet de l'assertion, converti de son type XML natif en chaîne
saml.valid Renvoie "true" ou "false" en fonction du résultat de la vérification de validité
saml.issueInstant IssueInstant
saml.subjectFormat Format de l'objet
saml.scmethod Méthode de confirmation de l'objet
saml.scdaddress Adresse de données de confirmation de l'objet
saml.scdinresponse Données de confirmation de l'objet en réponse
saml.scdrcpt Destinataire des données de confirmation de l'objet
saml.authnSnooa Authentification SessionNotOnOrAfter
saml.authnContextClassRef AuthnStatement AuthnContextClassRef
saml.authnInstant AuthnStatement AuthInstant
saml.authnSessionIndex Index de session AuthnStatement

Informations de référence sur les erreurs

Cette section décrit les codes d'erreur et les messages d'erreur renvoyés et les variables d'erreur définies par Apigee lorsque cette règle déclenche une erreur. Ces informations sont importantes si vous développez des règles de défaillance afin de gérer les pannes. Pour en savoir plus, consultez les pages Ce que vous devez savoir à propos des erreurs liées aux règles et Gérer les pannes.

Erreurs de déploiement

Ces erreurs peuvent se produire lorsque vous déployez un proxy contenant cette règle.

Nom de l'erreur Cause Corriger
SourceNotConfigured Un ou plusieurs des éléments suivants de la règle ValidateSAMLAssertion ne sont pas définis ou sont vides : <Source>, <XPath>, <Namespaces>, <Namespace>.
TrustStoreNotConfigured Si l'élément <TrustStore> est vide ou non spécifié dans la règle ValidateSAMLAssertion, le déploiement du proxy d'API échoue. Vous devez indiquer un truststore valide.
NullKeyStoreAlias Si l'élément enfant <Alias> est vide ou non spécifié dans l'élément <Keystore> de la règle GenerateSAMLAssertion, le déploiement du proxy d'API échoue. Vous devez saisir un alias de keystore valide.
NullKeyStore Si l'élément enfant <Name> est vide ou non spécifié dans l'élément <Keystore> de la règle GenerateSAMLAssertion, le déploiement du proxy d'API échoue. Veuillez indiquer un nom de keystore valide.
NullIssuer Si l'élément <Issuer> est vide ou non spécifié dans la règle GenerateSAMLAssertion, le déploiement du proxy d'API échoue. Vous devez saisir une valeur <Issuer> valide.

Variables de panne

Ces variables sont définies lorsqu'une erreur d'exécution se produit. Pour en savoir plus, consultez la section Ce que vous devez savoir sur les erreurs liées aux règles.

Variables Où : Exemple
fault.name="fault_name" fault_name est le nom de l'erreur . Le nom d'erreur est la dernière partie du code d'erreur. fault.name = "SourceUnavailable"
xmltojson.policy_name.failed policy_name est le nom spécifié par l'utilisateur de la règle qui a provoqué l'erreur. xmltojson.XMLtoJSON-1.failed = true

Exemple de réponse d'erreur

{
  "fault": {
    "faultstring": "XMLToJSON[XMLtoJSON-1]: Source xyz is not available",
    "detail": {
      "errorcode": "steps.xml2json.SourceUnavailable"
    }
  }
}

Exemple de règle de défaillance

<faultrule name="VariableOfNonMsgType"></faultrule><FaultRule name="XML to JSON Faults">
    <Step>
        <Name>AM-SourceUnavailableMessage</Name>
        <Condition>(fault.name Matches "SourceUnavailable") </Condition>
    </Step>
    <Step>
        <Name>AM-BadXML</Name>
        <Condition>(fault.name = "ExecutionFailed")</Condition>
    </Step>
    <Condition>(xmltojson.XMLtoJSON-1.failed = true) </Condition>
</FaultRule>

Articles associés

Extraction de variables : règle d'extraction de variables