saml/binding/XMLSigningRule.h

   1 /*
   2  *  Copyright 2001-2006 Internet2
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 /**
  18  * @file saml/binding/XMLSigningRule.h
  19  *
  20  * XML Signature checking SecurityPolicyRule
  21  */
  22
  23 #include <saml/binding/SecurityPolicyRule.h>
  24
  25
  26 namespace opensaml {
  27     /**
  28      * XML Signature checking SecurityPolicyRule
  29      *
  30      * Subclasses can provide support for additional message types
  31      * by overriding the issuer derivation method.
  32      */
  33     class SAML_API XMLSigningRule : public SecurityPolicyRule
  34     {
  35     public:
  36         XMLSigningRule(const DOMElement* e) {}
  37         virtual ~XMLSigningRule() {}
  38
  39         std::pair<saml2::Issuer*,const saml2md::RoleDescriptor*> evaluate(
  40             const GenericRequest& request,
  41             const xmltooling::XMLObject& message,
  42             const saml2md::MetadataProvider* metadataProvider,
  43             const xmltooling::QName* role,
  44             const xmltooling::TrustEngine* trustEngine
  45             ) const;
  46
  47     protected:
  48         /**
  49          * Examines the message and/or its contents and extracts the issuer's claimed
  50          * identity along with a protocol identifier. The two together can be used to
  51          * locate metadata to use in validating the signature. Conventions may be needed
  52          * to properly encode non-SAML2 issuer information into a compatible form.
  53          *
  54          * <p>The caller is responsible for freeing the Issuer object.
  55          *
  56          * @param message       message to examine
  57          * @return  a pair consisting of a SAML 2.0 Issuer object and a protocol constant.
  58          */
  59         virtual std::pair<saml2::Issuer*,const XMLCh*> getIssuerAndProtocol(const xmltooling::XMLObject& message) const;
  60     };
  61
  62 };