2 * Copyright 2001-2007 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>
29 #include <xmltooling/XMLObject.h>
30 #include <xmltooling/io/GenericResponse.h>
31 #include <xmltooling/security/Credential.h>
35 class SAML_API SAMLArtifact;
37 class SAML_API SAML2Artifact;
40 class SAML_API EntityDescriptor;
44 * Interface to SAML protocol binding message encoders.
46 class SAML_API MessageEncoder
48 MAKE_NONCOPYABLE(MessageEncoder);
50 virtual ~MessageEncoder() {}
53 * Indicates whether the encoding format requires that messages be as compact as possible.
55 * @return true iff the encoding has size constraints
57 virtual bool isCompact() const {
62 * Indicates whether a web browser or similar user agent will receive the message.
64 * @return true iff the message will be handled by a user agent
66 virtual bool isUserAgentPresent() const {
71 * Interface to caller-supplied artifact generation mechanism.
73 * Generating an artifact for storage and retrieval requires knowledge of
74 * the sender's SourceID (or sometimes SourceLocation), and the relying party's
75 * preferred artifact type. This information can be supplied using whatever
76 * configuration or defaults are appropriate for the SAML application.
77 * A MessageEncoder implementation will invoke the supplied generator interface
78 * when it requires an artifact be created.
80 class SAML_API ArtifactGenerator {
81 MAKE_NONCOPYABLE(ArtifactGenerator);
83 ArtifactGenerator() {}
85 virtual ~ArtifactGenerator() {}
88 * Generate a SAML 1.x artifact suitable for consumption by the relying party.
90 * @param relyingParty the party that will recieve the artifact
91 * @return a SAML 1.x artifact with a random assertion handle
93 virtual SAMLArtifact* generateSAML1Artifact(const saml2md::EntityDescriptor* relyingParty) const=0;
96 * Generate a SAML 2.0 artifact suitable for consumption by the relying party.
98 * @param relyingParty the party that will recieve the artifact
99 * @return a SAML 2.0 artifact with a random message handle
101 virtual saml2p::SAML2Artifact* generateSAML2Artifact(const saml2md::EntityDescriptor* relyingParty) const=0;
105 * Encodes an XML object/message into a binding- and transport-specific response.
106 * The XML content cannot have a parent object, and any existing references to
107 * the content will be invalidated if the encode method returns successfully.
109 * If a CredentialResolver is supplied, the message is also signed in a
110 * binding-specific manner. The CredentialResolver <strong>MUST</strong>
111 * be locked by the caller.
113 * <p>Artifact-based bindings require an ArtifactGenerator be set to
114 * produce an artifact suitable for the intended recipient.
116 * @param genericResponse reference to interface for sending transport response
117 * @param xmlObject XML message to encode
118 * @param destination destination URL for message
119 * @param recipient optional message recipient
120 * @param relayState optional RelayState value to accompany message
121 * @param artifactGenerator optional interface for generation of artifacts
122 * @param credential optional Credential to supply signing key
123 * @param signatureAlg optional signature algorithm identifier
124 * @param digestAlg optional reference digest algorithm identifier
127 xmltooling::GenericResponse& genericResponse,
128 xmltooling::XMLObject* xmlObject,
129 const char* destination,
130 const saml2md::EntityDescriptor* recipient=NULL,
131 const char* relayState=NULL,
132 const ArtifactGenerator* artifactGenerator=NULL,
133 const xmltooling::Credential* credential=NULL,
134 const XMLCh* signatureAlg=NULL,
135 const XMLCh* digestAlg=NULL
143 * Registers MessageEncoder plugins into the runtime.
145 void SAML_API registerMessageEncoders();
148 #endif /* __saml_encoder_h__ */