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