1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
|
/*
* Copyright 2001-2007 Internet2
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* @file saml/binding/SecurityPolicyRule.h
*
* Policy rules that secure and authenticate bindings.
*/
#ifndef __saml_secrule_h__
#define __saml_secrule_h__
#include <saml/binding/SecurityPolicy.h>
namespace opensaml {
/**
* A rule that a protocol request and message must meet in order to be valid and secure.
*
* <p>Rules must be stateless and thread-safe across evaluations. Evaluation should not
* result in an exception if the request/message properties do not apply to the rule
* (e.g. particular security mechanisms that are not present).
*/
class SAML_API SecurityPolicyRule
{
MAKE_NONCOPYABLE(SecurityPolicyRule);
protected:
SecurityPolicyRule() {}
public:
virtual ~SecurityPolicyRule() {}
/**
* Returns the rule's class/type.
*
* @return the class/type of the object
*/
virtual const char* getType() const=0;
/**
* Evaluates the rule against the given request and message.
*
* <p>An exception will be raised if the message is invalid according to
* a policy rule.
*
* @param message the incoming message
* @param request the protocol request
* @param policy SecurityPolicy to provide various components and track message data
*/
virtual void evaluate(
const xmltooling::XMLObject& message,
const xmltooling::GenericRequest* request,
SecurityPolicy& policy
) const=0;
};
/**
* Registers SecurityPolicyRule plugins into the runtime.
*/
void SAML_API registerSecurityPolicyRules();
/**
* SecurityPolicyRule for TLS client certificate authentication.
*
* Evaluates client certificates against the issuer's metadata.
*/
#define CLIENTCERTAUTH_POLICY_RULE "ClientCertAuth"
/**
* SecurityPolicyRule for replay detection and freshness checking.
*
* <p>A ReplayCache instance must be available from the runtime, unless
* a "checkReplay" XML attribute is set to "0" or "false" when instantiating
* the policy rule.
*
* <p>Messages must have been issued in the past, but no more than 60 seconds ago,
* or up to a number of seconds set by an "expires" XML attribute when
* instantiating the policy rule.
*/
#define MESSAGEFLOW_POLICY_RULE "MessageFlow"
/**
* SecurityPolicyRule for disabling security.
*
* Allows the message issuer to be authenticated regardless of the message or
* transport. Used mainly for debugging or in situations that I wouldn't care to
* comment on.
*/
#define NULLSECURITY_POLICY_RULE "NullSecurity"
/**
* SecurityPolicyRule for protocol message "blob" signing.
*
* Allows the message issuer to be authenticated using a non-XML digital signature
* over the message body. The transport layer is not considered.
*/
#define SIMPLESIGNING_POLICY_RULE "SimpleSigning"
/**
* SecurityPolicyRule for protocol message XML signing.
*
* Allows the message issuer to be authenticated using an XML digital signature
* over the message. The transport layer is not considered.
*/
#define XMLSIGNING_POLICY_RULE "XMLSigning"
};
#endif /* __saml_secrule_h__ */
|
