2 * Copyright 2001-2006 Internet2
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
18 * @file saml/binding/MessageEncoder.h
20 * Interface to SAML protocol binding message encoders.
23 #ifndef __saml_encoder_h__
24 #define __saml_encoder_h__
26 #include <saml/base.h>
30 #include <xmltooling/XMLObject.h>
31 #include <xmltooling/signature/CredentialResolver.h>
35 class SAML_API SAMLArtifact;
37 class SAML_API SAML2Artifact;
41 * Interface to SAML protocol binding message encoders.
43 class SAML_API MessageEncoder
45 MAKE_NONCOPYABLE(MessageEncoder);
47 virtual ~MessageEncoder() {}
50 * Interface to caller-supplied artifact generation mechanism.
52 * Generating an artifact for storage and retrieval requires knowledge of
53 * the sender's SourceID (or sometimes SourceLocation), and the relying party's
54 * preferred artifact type. This information can be supplied using whatever
55 * configuration or defaults are appropriate for the SAML application.
56 * A MessageEncoder implementation will invoke the supplied generator interface
57 * when it requires an artifact be created.
59 class SAML_API ArtifactGenerator {
60 MAKE_NONCOPYABLE(ArtifactGenerator);
62 ArtifactGenerator() {}
64 virtual ~ArtifactGenerator() {}
67 * Generate a SAML 1.x artifact suitable for consumption by the relying party.
69 * @param relyingParty the party that will recieve the artifact
70 * @return a SAML 1.x artifact with a random assertion handle
72 virtual SAMLArtifact* generateSAML1Artifact(const char* relyingParty) const=0;
75 * Generate a SAML 2.0 artifact suitable for consumption by the relying party.
77 * @param relyingParty the party that will recieve the artifact
78 * @return a SAML 2.0 artifact with a random message handle
80 virtual saml2p::SAML2Artifact* generateSAML2Artifact(const char* relyingParty) const=0;
84 * Provides an ArtifactGenerator implementation for the MessageEncoder to use.
85 * The implementation's lifetime must be longer than the lifetime of this object.
86 * This method must be externally synchronized.
88 * @param artifactGenerator an ArtifactGenerator implementation to use
90 void setArtifactGenerator(ArtifactGenerator* artifactGenerator) {
91 m_artifactGenerator = artifactGenerator;
95 * Encodes an XML object/message into a set of binding-specific data "fields".
96 * The XML content cannot have a parent object, and any existing references to
97 * the content will be invalidated if the encode method returns successfully.
99 * If a CredentialResolver is supplied, the message is also signed in a
100 * binding-specific manner. The CredentialResolver <strong>MUST</strong>
101 * be locked by the caller.
103 * <p>An embedded URLEncoder instance may be required by some bindings
104 * in order to produce predictable signature input.
106 * <p>Artifact-based bindings require an ArtifactGenerator be set to
107 * produce an artifact suitable for the intended recipient.
109 * <p>Note that the name/value pairs resulting from the encoding operation are
110 * <strong>NOT</strong> URL-encoded or otherwise transformed. It is the caller's
111 * responsibility to apply any necessary encoding when preparing the data for
114 * @param outputFields name/value pairs containing the results of encoding the message
115 * @param xmlObject XML object/message to encode
116 * @param recipientID optional entityID of message recipient
117 * @param relayState optional RelayState value to accompany message
118 * @param credResolver optional CredentialResolver instance to supply signing material
119 * @param sigAlgorithm optional signature algorithm identifier
122 std::map<std::string,std::string>& outputFields,
123 xmltooling::XMLObject* xmlObject,
124 const char* recipientID=NULL,
125 const char* relayState=NULL,
126 const xmlsignature::CredentialResolver* credResolver=NULL,
127 const XMLCh* sigAlgorithm=NULL
131 MessageEncoder() : m_artifactGenerator(NULL) {}
134 * Helper function to build a new XML Signature with KeyInfo, based
135 * on the supplied CredentialResolver.
137 * @param credResolver CredentialResolver instance to supply signing material
138 * @param sigAlgorithm optional signature algorithm identifier
139 * @return a new Signature object
141 xmlsignature::Signature* buildSignature(
142 const xmlsignature::CredentialResolver* credResolver,
143 const XMLCh* sigAlgorithm=NULL
146 /** Pointer to an ArtifactGenerator implementation. */
147 const ArtifactGenerator* m_artifactGenerator;
151 * Registers MessageEncoder plugins into the runtime.
153 void SAML_API registerMessageEncoders();
156 #endif /* __saml_encoder_h__ */