saml/binding/SimpleSigningRule.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/SimpleSigningRule.h
  19  *
  20  * Blob-oriented signature checking SecurityPolicyRule
  21  */
  22
  23 #include <saml/binding/SecurityPolicyRule.h>
  24
  25
  26 namespace opensaml {
  27     /**
  28      * Blob-oriented signature checking SecurityPolicyRule for
  29      * bindings that support non-XML signature techniques.
  30      *
  31      * Subclasses can provide support for additional message types
  32      * by overriding the issuer derivation method.
  33      */
  34     class SAML_API SimpleSigningRule : public SecurityPolicyRule
  35     {
  36     public:
  37         SimpleSigningRule(const DOMElement* e) {}
  38         virtual ~SimpleSigningRule() {}
  39
  40         std::pair<saml2::Issuer*,const saml2md::RoleDescriptor*> evaluate(
  41             const GenericRequest& request,
  42             const xmltooling::XMLObject& message,
  43             const saml2md::MetadataProvider* metadataProvider,
  44             const xmltooling::QName* role,
  45             const xmltooling::TrustEngine* trustEngine
  46             ) const;
  47
  48     protected:
  49         /**
  50          * Examines the message and/or its contents and extracts the issuer's claimed
  51          * identity along with a protocol identifier. The two together can be used to
  52          * locate metadata to use in validating the signature. Conventions may be needed
  53          * to properly encode non-SAML2 issuer information into a compatible form.
  54          *
  55          * <p>The caller is responsible for freeing the Issuer object.
  56          *
  57          * @param message       message to examine
  58          * @return  a pair consisting of a SAML 2.0 Issuer object and a protocol constant.
  59          */
  60         virtual std::pair<saml2::Issuer*,const XMLCh*> getIssuerAndProtocol(const xmltooling::XMLObject& message) const;
  61     };
  62
  63 };