-/*
- * Copyright 2001-2006 Internet2
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
+/**
+ * Licensed to the University Corporation for Advanced Internet
+ * Development, Inc. (UCAID) under one or more contributor license
+ * agreements. See the NOTICE file distributed with this work for
+ * additional information regarding copyright ownership.
+ *
+ * UCAID licenses this file to you under the Apache License,
+ * Version 2.0 (the "License"); you may not use this file except
+ * in compliance with the License. You may obtain a copy of the
+ * License at
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * http://www.apache.org/licenses/LICENSE-2.0
*
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
+ * either express or implied. See the License for the specific
+ * language governing permissions and limitations under the License.
*/
/**
#ifndef __saml_soap11client_h__
#define __saml_soap11client_h__
-#include <saml/binding/SecurityPolicy.h>
+#include <saml/base.h>
+
#include <xmltooling/soap/SOAPClient.h>
namespace opensaml {
+ class SAML_API SecurityPolicy;
+ namespace saml2md {
+ class SAML_API MetadataCredentialCriteria;
+ };
+
/**
* Specialized SOAPClient for SAML SOAP bindings.
*/
- class SAML_API SOAPClient : soap11::SOAPClient
+ class SAML_API SOAPClient : public soap11::SOAPClient
{
public:
/**
* Creates a SOAP client instance with a particular SecurityPolicy.
*
- * @param policy reference to SecurityPolicy to apply
+ * @param policy reference to SecurityPolicy to apply
*/
- SOAPClient(SecurityPolicy& policy) : m_policy(policy), m_force(true) {}
+ SOAPClient(SecurityPolicy& policy);
- virtual ~SOAPClient() {}
+ virtual ~SOAPClient();
/**
* Controls whether to force transport/peer authentication via an X509TrustEngine.
*
* @param force true iff the client should refuse to communicate without this protection
*/
- void forceTransportAuthentication(bool force=true) {
- m_force = force;
- }
+ void forceTransportAuthentication(bool force=true);
+ using soap11::SOAPClient::send;
+
/**
- * Override prepares the SecurityPolicy by clearing Issuer identity, in case the policy
- * is reused.
+ * SAML-specific method uses metadata to determine the peer name and prepare the
+ * transport layer with peer credential information. The SecurityPolicy is also reset,
+ * in case the policy is reused.
*
* @param env SOAP envelope to send
- * @param peer peer to send message to, expressed in TrustEngine terms
+ * @param from identity of sending application
+ * @param to peer to send message to, expressed in metadata criteria terms
* @param endpoint URL of endpoint to recieve message
*/
- void send(const soap11::Envelope* env, const xmltooling::KeyInfoSource& peer, const char* endpoint);
+ virtual void send(const soap11::Envelope& env, const char* from, saml2md::MetadataCredentialCriteria& to, const char* endpoint);
/**
* Override applies SecurityPolicy to envelope before returning it.
* @return response envelope after SecurityPolicy has been applied
*/
soap11::Envelope* receive();
+
+ void reset();
+
+ /**
+ * Returns the SecurityPolicy supplied to the client.
+ *
+ * @return the associated SecurityPolicy
+ */
+ SecurityPolicy& getPolicy() const;
protected:
/**
*
* @param transport reference to transport layer
*/
- void prepareTransport(const xmltooling::SOAPTransport& transport);
+ void prepareTransport(xmltooling::SOAPTransport& transport);
/** Reference to security policy to apply. */
SecurityPolicy& m_policy;
/** Flag controlling whether transport/peer authn is mandatory. */
bool m_force;
- private:
+ /** Metadata-based peer identity. */
const saml2md::RoleDescriptor* m_peer;
+
+ /** Metadata-based CredentialCriteria for supplying credentials to TrustEngine. */
+ saml2md::MetadataCredentialCriteria* m_criteria;
};
};