Major revamp of credential and trust handling code, PKIX engine still needs work.
[shibboleth/cpp-opensaml.git] / saml / binding / SOAPClient.h
index 1c40cdc..ddbe2e1 100644 (file)
@@ -24,6 +24,7 @@
 #define __saml_soap11client_h__
 
 #include <saml/binding/SecurityPolicy.h>
+#include <saml/saml2/metadata/MetadataCredentialCriteria.h>
 #include <xmltooling/soap/SOAPClient.h>
 
 namespace opensaml {
@@ -31,17 +32,21 @@ namespace opensaml {
     /**
      * 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
+         * @param validating    controls schema validation
          */
-        SOAPClient(SecurityPolicy& policy) : m_policy(policy), m_force(true) {}
+        SOAPClient(SecurityPolicy& policy)
+            : soap11::SOAPClient(policy.getValidating()), m_policy(policy), m_force(true), m_peer(NULL), m_criteria(NULL) {
+        }
         
-        virtual ~SOAPClient() {}
+        virtual ~SOAPClient() {
+        }
 
         /**
          * Controls whether to force transport/peer authentication via an X509TrustEngine.
@@ -55,14 +60,15 @@ namespace opensaml {
         }
         
         /**
-         * Override prepares the SecurityPolicy by clearing Issuer identity, in case the policy
-         * is reused.
+         * SAML-specific method uses a RoleDescriptor 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 peer      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);
+        void send(const soap11::Envelope& env, saml2md::MetadataCredentialCriteria& peer, const char* endpoint);
         
         /**
          * Override applies SecurityPolicy to envelope before returning it.
@@ -70,6 +76,17 @@ namespace opensaml {
          * @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 {
+            return m_policy;
+        }
 
     protected:
         /**
@@ -78,7 +95,7 @@ namespace opensaml {
          * 
          * @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;
@@ -86,8 +103,11 @@ namespace opensaml {
         /** 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;
     };
 
 };