saml/binding/SecurityPolicyRule.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/SecurityPolicyRule.h
  19  *
  20  * Policy rules that secure and authenticate bindings.
  21  */
  22
  23 #ifndef __saml_secrule_h__
  24 #define __saml_secrule_h__
  25
  26 #include <saml/binding/GenericRequest.h>
  27 #include <xmltooling/XMLObject.h>
  28
  29 namespace opensaml {
  30     class SAML_API TrustEngine;
  31
  32     namespace saml2 {
  33         class SAML_API Issuer;
  34     };
  35     namespace saml2md {
  36         class SAML_API MetadataProvider;
  37         class SAML_API RoleDescriptor;
  38     };
  39
  40     /**
  41      * A rule that a protocol request and message must meet in order to be valid and secure.
  42      *
  43      * <p>Rules must be stateless and thread-safe across evaluations. Evaluation should not
  44      * result in an exception if the request/message properties do not apply to the rule
  45      * (e.g. particular security mechanisms that are not present).
  46      */
  47     class SAML_API SecurityPolicyRule
  48     {
  49         MAKE_NONCOPYABLE(SecurityPolicyRule);
  50     protected:
  51         SecurityPolicyRule() {}
  52     public:
  53         virtual ~SecurityPolicyRule() {}
  54
  55         /**
  56          * Evaluates the rule against the given request and message. If an Issuer is
  57          * returned, the caller is responsible for freeing the Issuer object.
  58          *
  59          * @param request           the protocol request
  60          * @param message           the incoming message
  61          * @param metadataProvider  locked MetadataProvider instance to authenticate the message
  62          * @param role              identifies the role (generally IdP or SP) of the peer who issued the message
  63          * @param trustEngine       TrustEngine to authenticate the message
  64          * @param extractor         MessageExtractor to use in examining message
  65          * @return the identity of the message issuer, in two forms, or NULL
  66          *
  67          * @throws BindingException thrown if the request/message do not meet the requirements of this rule
  68          */
  69         virtual std::pair<saml2::Issuer*,const saml2md::RoleDescriptor*> evaluate(
  70             const GenericRequest& request,
  71             const xmltooling::XMLObject& message,
  72             const saml2md::MetadataProvider* metadataProvider,
  73             const xmltooling::QName* role,
  74             const TrustEngine* trustEngine
  75             ) const=0;
  76     };
  77
  78     /**
  79      * Registers SecurityPolicyRule plugins into the runtime.
  80      */
  81     void SAML_API registerSecurityPolicyRules();
  82
  83     /**
  84      * SecurityPolicyRule for TLS client certificate authentication.
  85      *
  86      * Requires that messages carry information about the issuer, and then
  87      * evaluates the claimed certificates against the issuer's metadata.
  88      */
  89     #define CLIENTCERTAUTH_POLICY_RULE  "org.opensaml.binding.ClientCertAuthRule"
  90
  91     /**
  92      * SecurityPolicyRule for replay detection and freshness checking.
  93      *
  94      * <p>A ReplayCache instance must be available from the runtime, unless
  95      * a "checkReplay" XML attribute is set to "0" or "false" when instantiating
  96      * the policy rule.
  97      *
  98      * <p>Messages must have been issued in the past, but no more than 60 seconds ago,
  99      * or up to a number of seconds set by an "expires" XML attribute when
 100      * instantiating the policy rule.
 101      */
 102     #define MESSAGEFLOW_POLICY_RULE  "org.opensaml.binding.MessageFlowRule"
 103
 104     /**
 105      * SecurityPolicyRule for protocol message "blob" signing.
 106      *
 107      * Allows the message issuer to be authenticated using a non-XML digital signature
 108      * over the message body. The transport layer is not considered.
 109      */
 110     #define SIMPLESIGNING_POLICY_RULE  "org.opensaml.binding.SimpleSigningRule"
 111
 112     /**
 113      * SecurityPolicyRule for protocol message XML signing.
 114      *
 115      * Allows the message issuer to be authenticated using an XML digital signature
 116      * over the message. The transport layer is not considered.
 117      */
 118     #define XMLSIGNING_POLICY_RULE  "org.opensaml.binding.XMLSigningRule"
 119 };
 120
 121 #endif /* __saml_secrule_h__ */