saml/binding/MessageEncoder.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/MessageEncoder.h
  19  *
  20  * Interface to SAML protocol binding message encoders.
  21  */
  22
  23 #ifndef __saml_encoder_h__
  24 #define __saml_encoder_h__
  25
  26 #include <saml/base.h>
  27
  28 namespace xmltooling {
  29     class XMLTOOL_API Credential;
  30     class XMLTOOL_API GenericResponse;
  31     class XMLTOOL_API XMLObject;
  32 };
  33
  34 namespace opensaml {
  35
  36     class SAML_API SAMLArtifact;
  37     namespace saml2p {
  38         class SAML_API SAML2Artifact;
  39     };
  40     namespace saml2md {
  41         class SAML_API EntityDescriptor;
  42     };
  43
  44     /**
  45      * Interface to SAML protocol binding message encoders.
  46      */
  47     class SAML_API MessageEncoder
  48     {
  49         MAKE_NONCOPYABLE(MessageEncoder);
  50     public:
  51         virtual ~MessageEncoder();
  52
  53         /**
  54          * Indicates whether the encoding format requires that messages be as compact as possible.
  55          *
  56          * @return  true iff the encoding has size constraints
  57          */
  58         virtual bool isCompact() const;
  59
  60         /**
  61          * Indicates whether a web browser or similar user agent will receive the message.
  62          *
  63          * @return true iff the message will be handled by a user agent
  64          */
  65         virtual bool isUserAgentPresent() const;
  66
  67         /**
  68          * Interface to caller-supplied artifact generation mechanism.
  69          *
  70          * Generating an artifact for storage and retrieval requires knowledge of
  71          * the sender's SourceID (or sometimes SourceLocation), and the relying party's
  72          * preferred artifact type. This information can be supplied using whatever
  73          * configuration or defaults are appropriate for the SAML application.
  74          * A MessageEncoder implementation will invoke the supplied generator interface
  75          * when it requires an artifact be created.
  76          */
  77         class SAML_API ArtifactGenerator {
  78             MAKE_NONCOPYABLE(ArtifactGenerator);
  79         protected:
  80             ArtifactGenerator();
  81         public:
  82             virtual ~ArtifactGenerator();
  83
  84             /**
  85              * Generate a SAML 1.x artifact suitable for consumption by the relying party.
  86              *
  87              * @param relyingParty  the party that will recieve the artifact
  88              * @return a SAML 1.x artifact with a random assertion handle
  89              */
  90             virtual SAMLArtifact* generateSAML1Artifact(const saml2md::EntityDescriptor* relyingParty) const=0;
  91
  92             /**
  93              * Generate a SAML 2.0 artifact suitable for consumption by the relying party.
  94              *
  95              * @param relyingParty  the party that will recieve the artifact
  96              * @return a SAML 2.0 artifact with a random message handle
  97              */
  98             virtual saml2p::SAML2Artifact* generateSAML2Artifact(const saml2md::EntityDescriptor* relyingParty) const=0;
  99         };
 100
 101         /**
 102          * Encodes an XML object/message into a binding- and transport-specific response.
 103          * The XML content cannot have a parent object, and any existing references to
 104          * the content will be invalidated if the encode method returns successfully.
 105          *
 106          * If a CredentialResolver is supplied, the message is also signed in a
 107          * binding-specific manner. The CredentialResolver <strong>MUST</strong>
 108          * be locked by the caller.
 109          *
 110          * <p>Artifact-based bindings require an ArtifactGenerator be set to
 111          * produce an artifact suitable for the intended recipient.
 112          *
 113          * @param genericResponse   reference to interface for sending transport response
 114          * @param xmlObject         XML message to encode
 115          * @param destination       destination URL for message
 116          * @param recipient         optional message recipient
 117          * @param relayState        optional RelayState value to accompany message
 118          * @param artifactGenerator optional interface for generation of artifacts
 119          * @param credential        optional Credential to supply signing key
 120          * @param signatureAlg      optional signature algorithm identifier
 121          * @param digestAlg         optional reference digest algorithm identifier
 122          */
 123         virtual long encode(
 124             xmltooling::GenericResponse& genericResponse,
 125             xmltooling::XMLObject* xmlObject,
 126             const char* destination,
 127             const saml2md::EntityDescriptor* recipient=NULL,
 128             const char* relayState=NULL,
 129             const ArtifactGenerator* artifactGenerator=NULL,
 130             const xmltooling::Credential* credential=NULL,
 131             const XMLCh* signatureAlg=NULL,
 132             const XMLCh* digestAlg=NULL
 133             ) const=0;
 134
 135     protected:
 136         MessageEncoder();
 137     };
 138
 139     /**
 140      * Registers MessageEncoder plugins into the runtime.
 141      */
 142     void SAML_API registerMessageEncoders();
 143 };
 144
 145 #endif /* __saml_encoder_h__ */