saml/binding/MessageDecoder.h

   1 /*
   2  *  Copyright 2001-2007 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/MessageDecoder.h
  19  *
  20  * Interface to SAML protocol binding message decoders.
  21  */
  22
  23 #ifndef __saml_decoder_h__
  24 #define __saml_decoder_h__
  25
  26 #include <saml/binding/GenericRequest.h>
  27 #include <saml/binding/SecurityPolicy.h>
  28 #include <xmltooling/XMLObject.h>
  29
  30 namespace opensaml {
  31
  32     class SAML_API SAMLArtifact;
  33     namespace saml1p {
  34         class SAML_API Response;
  35     };
  36     namespace saml2p {
  37         class SAML_API SAML2Artifact;
  38         class SAML_API ArtifactResponse;
  39     };
  40     namespace saml2md {
  41         class SAML_API MetadataProvider;
  42         class SAML_API IDPSSODescriptor;
  43         class SAML_API RoleDescriptor;
  44         class SAML_API SSODescriptorType;
  45     };
  46
  47     /**
  48      * Interface to SAML protocol binding message decoders.
  49      */
  50     class SAML_API MessageDecoder
  51     {
  52         MAKE_NONCOPYABLE(MessageDecoder);
  53     public:
  54         virtual ~MessageDecoder() {}
  55
  56         /**
  57          * Interface to caller-supplied artifact resolution mechanism.
  58          *
  59          * Resolving artifacts requires internally performing a SOAP-based
  60          * call to the artifact source, usually in a mutually authenticated fashion.
  61          * The potential options vary widely, so the work is encapsulated by this
  62          * interface, though of course other library facilities may be used.
  63          *
  64          * <p>A MessageDecoder implementation will invoke the supplied interface
  65          * when it requires an artifact be resolved.
  66          */
  67         class SAML_API ArtifactResolver {
  68             MAKE_NONCOPYABLE(ArtifactResolver);
  69         protected:
  70             ArtifactResolver() {}
  71
  72         public:
  73             virtual ~ArtifactResolver() {}
  74
  75             /**
  76              * Resolves one or more SAML 1.x artifacts into a response containing a set of
  77              * resolved Assertions. The caller is responsible for the resulting Response.
  78              * The supplied SecurityPolicy is used to access caller-supplied infrastructure
  79              * and to pass back the result of authenticating the resolution process.
  80              *
  81              * @param artifacts         one or more SAML 1.x artifacts
  82              * @param idpDescriptor     reference to IdP role of artifact issuer
  83              * @param policy            reference to policy containing rules, MetadataProvider, TrustEngine, etc.
  84              * @return the corresponding SAML Assertions wrapped in a Response.
  85              */
  86             virtual saml1p::Response* resolve(
  87                 const std::vector<SAMLArtifact*>& artifacts,
  88                 const saml2md::IDPSSODescriptor& idpDescriptor,
  89                 SecurityPolicy& policy
  90                 ) const=0;
  91
  92             /**
  93              * Resolves a SAML 2.0 artifact into the corresponding SAML protocol message.
  94              * The caller is responsible for the resulting ArtifactResponse message.
  95              * The supplied SecurityPolicy is used to access caller-supplied infrastructure
  96              * and to pass back the result of authenticating the resolution process.
  97              *
  98              * @param artifact          reference to a SAML 2.0 artifact
  99              * @param ssoDescriptor     reference to SSO role of artifact issuer (may be SP or IdP)
 100              * @param policy            reference to policy containing rules, MetadataProvider, TrustEngine, etc.
 101              * @return the corresponding SAML protocol message or NULL
 102              */
 103             virtual saml2p::ArtifactResponse* resolve(
 104                 const saml2p::SAML2Artifact& artifact,
 105                 const saml2md::SSODescriptorType& ssoDescriptor,
 106                 SecurityPolicy& policy
 107                 ) const=0;
 108         };
 109
 110         /**
 111          * Provides an ArtifactResolver implementation for the MessageDecoder to use.
 112          * The implementation's lifetime must be longer than the lifetime of this object.
 113          * This method must be externally synchronized.
 114          *
 115          * @param artifactResolver   an ArtifactResolver implementation to use
 116          */
 117         void setArtifactResolver(const ArtifactResolver* artifactResolver) {
 118             m_artifactResolver = artifactResolver;
 119         }
 120
 121         /**
 122          * Decodes a transport request into a SAML protocol message, and evaluates it
 123          * against a supplied SecurityPolicy. If the transport request does not contain
 124          * the information necessary to decode the request, NULL will be returned.
 125          * Errors during the decoding process will be raised as exceptions.
 126          *
 127          * <p>Artifact-based bindings require an ArtifactResolver be set to
 128          * turn an artifact into the corresponding message.
 129          *
 130          * @param relayState        will be set to RelayState/TARGET value accompanying message
 131          * @param genericRequest    reference to interface for accessing transport request to decode
 132          * @param policy            reference to policy containing rules, MetadataProvider, TrustEngine, etc.
 133          * @return  the decoded message, or NULL if the decoder did not recognize the request content
 134          */
 135         virtual xmltooling::XMLObject* decode(
 136             std::string& relayState,
 137             const GenericRequest& genericRequest,
 138             SecurityPolicy& policy
 139             ) const=0;
 140
 141     protected:
 142         MessageDecoder() : m_artifactResolver(NULL) {}
 143
 144         /** Pointer to an ArtifactResolver implementation. */
 145         const ArtifactResolver* m_artifactResolver;
 146     };
 147
 148     /**
 149      * Registers MessageDecoder plugins into the runtime.
 150      */
 151     void SAML_API registerMessageDecoders();
 152 };
 153
 154 #endif /* __saml_decoder_h__ */