1 /**
2  * Licensed to the University Corporation for Advanced Internet
3  * Development, Inc. (UCAID) under one or more contributor license
4  * agreements. See the NOTICE file distributed with this work for
5  * additional information regarding copyright ownership.
6  *
7  * UCAID licenses this file to you under the Apache License,
8  * Version 2.0 (the "License"); you may not use this file except
9  * in compliance with the License. You may obtain a copy of the
10  * License at
11  *
12  * http://www.apache.org/licenses/LICENSE-2.0
13  *
14  * Unless required by applicable law or agreed to in writing,
15  * software distributed under the License is distributed on an
16  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
17  * either express or implied. See the License for the specific
18  * language governing permissions and limitations under the License.
19  */
20 
21 /**
22  * @file saml/saml2/binding/SAML2MessageDecoder.h
23  *
24  * Base class for SAML 2.0 MessageDecoders.
25  */
26 
27 #ifndef __saml2_msgdecoder_h__
28 #define __saml2_msgdecoder_h__
29 
30 #include <saml/binding/MessageDecoder.h>
31 
32 namespace xmltooling {
33     class HTTPRequest;
34     class HTTPResponse;
35 }
36 
37 namespace opensaml {
38     namespace saml2p {
39 
40         /**
41          *  Base class for SAML 2.0 MessageDecoders.
42          */
43         class SAML_API SAML2MessageDecoder : public MessageDecoder
44         {
45         protected:
46             SAML2MessageDecoder();
47             virtual ~SAML2MessageDecoder();
48 
49             /**
50             * If relay state is provided, the previous request ID is extracted from a correlation cookie
51             * and supplied to the policy.
52             *
53             * @param request HTTP request
54             * @param response optional HTTP response
55             * @param relayState the RelayState token
56             * @param policy the SecurityPolicy to attach the ID to
57             */
58             void extractCorrelationID(
59                 const xmltooling::HTTPRequest& request,
60                 xmltooling::HTTPResponse* response,
61                 const std::string& relayState,
62                 SecurityPolicy& policy
63                 ) const;
64 
65         public:
66             const XMLCh* getProtocolFamily() const;
67             void extractMessageDetails (
68                 const xmltooling::XMLObject& message,
69                 const xmltooling::GenericRequest& genericRequest,
70                 const XMLCh* protocol,
71                 SecurityPolicy& policy
72                 ) const;
73         };
74     };
75 };
76 
77 #endif /* __saml2_msgdecoder_h__ */
78