shibsp/handler/impl/SAML2ArtifactResolution.cpp

   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  * SAML2ArtifactResolution.cpp
  19  *
  20  * Handler for resolving SAML 2.0 artifacts.
  21  */
  22
  23 #include "internal.h"
  24 #include "Application.h"
  25 #include "exceptions.h"
  26 #include "ServiceProvider.h"
  27 #include "handler/AbstractHandler.h"
  28 #include "handler/RemotedHandler.h"
  29 #include "util/SPConstants.h"
  30
  31 #ifndef SHIBSP_LITE
  32 # include "security/SecurityPolicy.h"
  33 # include <saml/SAMLConfig.h>
  34 # include <saml/binding/ArtifactMap.h>
  35 # include <saml/binding/MessageEncoder.h>
  36 # include <saml/binding/MessageDecoder.h>
  37 # include <saml/binding/SAMLArtifact.h>
  38 # include <saml/saml2/core/Assertions.h>
  39 # include <saml/saml2/core/Protocols.h>
  40 # include <saml/saml2/metadata/Metadata.h>
  41 # include <saml/saml2/metadata/MetadataCredentialCriteria.h>
  42 using namespace opensaml::saml2md;
  43 using namespace opensaml::saml2p;
  44 using namespace opensaml::saml2;
  45 using namespace samlconstants;
  46 #endif
  47
  48 #include <xmltooling/soap/SOAP.h>
  49
  50 using namespace shibspconstants;
  51 using namespace shibsp;
  52 using namespace opensaml;
  53 using namespace soap11;
  54 using namespace xmltooling;
  55 using namespace log4cpp;
  56 using namespace std;
  57
  58 namespace shibsp {
  59
  60 #if defined (_MSC_VER)
  61     #pragma warning( push )
  62     #pragma warning( disable : 4250 )
  63 #endif
  64
  65     class SHIBSP_API SAML2ArtifactResolution : public AbstractHandler, public RemotedHandler
  66     {
  67     public:
  68         SAML2ArtifactResolution(const DOMElement* e, const char* appId);
  69         virtual ~SAML2ArtifactResolution();
  70
  71         pair<bool,long> run(SPRequest& request, bool isHandler=true) const;
  72         void receive(DDF& in, ostream& out);
  73
  74     private:
  75         pair<bool,long> processMessage(const Application& application, HTTPRequest& httpRequest, HTTPResponse& httpResponse) const;
  76 #ifndef SHIBSP_LITE
  77         pair<bool,long> samlError(
  78             const Application& app,
  79             const ArtifactResolve& request,
  80             HTTPResponse& httpResponse,
  81             const XMLCh* code,
  82             const XMLCh* subcode=NULL,
  83             const char* msg=NULL
  84             ) const;
  85
  86         MessageEncoder* m_encoder;
  87         MessageDecoder* m_decoder;
  88         QName m_role;
  89 #endif
  90     };
  91
  92 #if defined (_MSC_VER)
  93     #pragma warning( pop )
  94 #endif
  95
  96     Handler* SHIBSP_DLLLOCAL SAML2ArtifactResolutionFactory(const pair<const DOMElement*,const char*>& p)
  97     {
  98         return new SAML2ArtifactResolution(p.first, p.second);
  99     }
 100
 101 };
 102
 103 SAML2ArtifactResolution::SAML2ArtifactResolution(const DOMElement* e, const char* appId)
 104     : AbstractHandler(e, Category::getInstance(SHIBSP_LOGCAT".SAML2ArtifactResolution"))
 105 #ifndef SHIBSP_LITE
 106         ,m_encoder(NULL), m_decoder(NULL), m_role(samlconstants::SAML20MD_NS, opensaml::saml2md::IDPSSODescriptor::LOCAL_NAME)
 107 #endif
 108 {
 109 #ifndef SHIBSP_LITE
 110     if (SPConfig::getConfig().isEnabled(SPConfig::OutOfProcess)) {
 111         try {
 112             m_encoder = SAMLConfig::getConfig().MessageEncoderManager.newPlugin(getString("Binding").second,e);
 113             m_decoder = SAMLConfig::getConfig().MessageDecoderManager.newPlugin(getString("Binding").second,e);
 114         }
 115         catch (exception& ex) {
 116             m_log.error("error building MessageEncoder/Decoder pair for binding (%s)", getString("Binding").second);
 117             delete m_encoder;
 118             delete m_decoder;
 119             throw;
 120         }
 121     }
 122 #endif
 123     string address(appId);
 124     address += getString("Location").second;
 125     address += "::run::SAML2Artifact";
 126     setAddress(address.c_str());
 127 }
 128
 129 SAML2ArtifactResolution::~SAML2ArtifactResolution()
 130 {
 131 #ifndef SHIBSP_LITE
 132     delete m_encoder;
 133     delete m_decoder;
 134 #endif
 135 }
 136
 137 pair<bool,long> SAML2ArtifactResolution::run(SPRequest& request, bool isHandler) const
 138 {
 139     string relayState;
 140     SPConfig& conf = SPConfig::getConfig();
 141
 142     try {
 143         if (conf.isEnabled(SPConfig::OutOfProcess)) {
 144             // When out of process, we run natively and directly process the message.
 145             return processMessage(request.getApplication(), request, request);
 146         }
 147         else {
 148             // When not out of process, we remote all the message processing.
 149             DDF out,in = wrap(request, NULL, true);
 150             DDFJanitor jin(in), jout(out);
 151
 152             out=request.getServiceProvider().getListenerService()->send(in);
 153             return unwrap(request, out);
 154         }
 155     }
 156     catch (exception& ex) {
 157         m_log.error("error while processing request: %s", ex.what());
 158
 159         // Build a SOAP fault around the error.
 160         auto_ptr<Fault> fault(FaultBuilder::buildFault());
 161         Faultcode* code = FaultcodeBuilder::buildFaultcode();
 162         fault->setFaultcode(code);
 163         code->setCode(&Faultcode::SERVER);
 164         Faultstring* fs = FaultstringBuilder::buildFaultstring();
 165         fault->setFaultstring(fs);
 166         pair<bool,bool> flag = getBool("detailedErrors", m_configNS.get());
 167         auto_ptr_XMLCh msg((flag.first && flag.second) ? ex.what() : "Error processing request.");
 168         fs->setString(msg.get());
 169 #ifndef SHIBSP_LITE
 170         // Use MessageEncoder to send back the fault.
 171         long ret = m_encoder->encode(request, fault.get(), NULL);
 172         fault.release();
 173         return make_pair(true, ret);
 174 #else
 175         // Brute force the fault to avoid library dependency.
 176         auto_ptr<Envelope> env(EnvelopeBuilder::buildEnvelope());
 177         Body* body = BodyBuilder::buildBody();
 178         env->setBody(body);
 179         body->getUnknownXMLObjects().push_back(fault.release());
 180         string xmlbuf;
 181         XMLHelper::serialize(env->marshall(), xmlbuf);
 182         istringstream s(xmlbuf);
 183         request.setContentType("text/xml");
 184         return make_pair(true, request.sendError(s));
 185 #endif
 186     }
 187 }
 188
 189 void SAML2ArtifactResolution::receive(DDF& in, ostream& out)
 190 {
 191     // Find application.
 192     const char* aid=in["application_id"].string();
 193     const Application* app=aid ? SPConfig::getConfig().getServiceProvider()->getApplication(aid) : NULL;
 194     if (!app) {
 195         // Something's horribly wrong.
 196         m_log.error("couldn't find application (%s) for artifact resolution", aid ? aid : "(missing)");
 197         throw ConfigurationException("Unable to locate application for artifact resolution, deleted?");
 198     }
 199
 200     // Unpack the request.
 201     auto_ptr<HTTPRequest> req(getRequest(in));
 202     //m_log.debug("found %d client certificates", req->getClientCertificates().size());
 203
 204     // Wrap a response shim.
 205     DDF ret(NULL);
 206     DDFJanitor jout(ret);
 207     auto_ptr<HTTPResponse> resp(getResponse(ret));
 208
 209     try {
 210         // Since we're remoted, the result should either be a throw, a false/0 return,
 211         // which we just return as an empty structure, or a response/redirect,
 212         // which we capture in the facade and send back.
 213         processMessage(*app, *req.get(), *resp.get());
 214         out << ret;
 215     }
 216     catch (exception& ex) {
 217 #ifndef SHIBSP_LITE
 218         m_log.error("error while processing request: %s", ex.what());
 219
 220         // Use MessageEncoder to send back a SOAP fault.
 221         auto_ptr<Fault> fault(FaultBuilder::buildFault());
 222         Faultcode* code = FaultcodeBuilder::buildFaultcode();
 223         fault->setFaultcode(code);
 224         code->setCode(&Faultcode::SERVER);
 225         Faultstring* fs = FaultstringBuilder::buildFaultstring();
 226         fault->setFaultstring(fs);
 227         pair<bool,bool> flag = getBool("detailedErrors", m_configNS.get());
 228         auto_ptr_XMLCh msg((flag.first && flag.second) ? ex.what() : "Error processing request.");
 229         fs->setString(msg.get());
 230         m_encoder->encode(*resp.get(), fault.get(), NULL);
 231         fault.release();
 232         out << ret;
 233 #else
 234         throw;  // should never happen anyway
 235 #endif
 236     }
 237 }
 238
 239 pair<bool,long> SAML2ArtifactResolution::processMessage(const Application& application, HTTPRequest& httpRequest, HTTPResponse& httpResponse) const
 240 {
 241 #ifndef SHIBSP_LITE
 242     m_log.debug("processing SAML 2.0 ArtifactResolve request");
 243
 244     ArtifactMap* artmap = SAMLConfig::getConfig().getArtifactMap();
 245     if (!artmap)
 246         throw ConfigurationException("No ArtifactMap instance installed.");
 247
 248     // Locate policy key.
 249     pair<bool,const char*> policyId = getString("policyId", m_configNS.get());  // namespace-qualified if inside handler element
 250     if (!policyId.first)
 251         policyId = application.getString("policyId");   // unqualified in Application(s) element
 252
 253     // Access policy properties.
 254     const PropertySet* settings = application.getServiceProvider().getPolicySettings(policyId.second);
 255     pair<bool,bool> validate = settings->getBool("validate");
 256
 257     // Lock metadata for use by policy.
 258     Locker metadataLocker(application.getMetadataProvider());
 259
 260     // Create the policy.
 261     shibsp::SecurityPolicy policy(application, &m_role, validate.first && validate.second);
 262
 263     // Decode the message and verify that it's a secured ArtifactResolve request.
 264     string relayState;
 265     auto_ptr<XMLObject> msg(m_decoder->decode(relayState, httpRequest, policy));
 266     if (!msg.get())
 267         throw BindingException("Failed to decode a SAML request.");
 268     const ArtifactResolve* req = dynamic_cast<const ArtifactResolve*>(msg.get());
 269     if (!req)
 270         throw FatalProfileException("Decoded message was not a samlp::ArtifactResolve request.");
 271
 272     try {
 273         auto_ptr_char artifact(req->getArtifact() ? req->getArtifact()->getArtifact() : NULL);
 274         if (!artifact.get() || !*artifact.get())
 275             return samlError(application, *req, httpResponse, StatusCode::REQUESTER, NULL, "Request did not contain an artifact to resolve.");
 276         auto_ptr_char issuer(policy.getIssuer() ? policy.getIssuer()->getName() : NULL);
 277
 278         m_log.info("resolving artifact (%s) for (%s)", artifact.get(), issuer.get() ? issuer.get() : "unknown");
 279
 280         // Parse the artifact and retrieve the object.
 281         auto_ptr<SAMLArtifact> artobj(SAMLArtifact::parse(artifact.get()));
 282         auto_ptr<XMLObject> payload(artmap->retrieveContent(artobj.get(), issuer.get()));
 283
 284         if (!policy.isSecure()) {
 285             m_log.error("request for artifact was unauthenticated, purging the artifact mapping");
 286             return samlError(application, *req, httpResponse, StatusCode::REQUESTER, StatusCode::AUTHN_FAILED, "Unable to authenticate request.");
 287         }
 288
 289         m_log.debug("artifact resolved, preparing response");
 290
 291         // Wrap it in a response.
 292         auto_ptr<ArtifactResponse> resp(ArtifactResponseBuilder::buildArtifactResponse());
 293         resp->setInResponseTo(req->getID());
 294         Issuer* me = IssuerBuilder::buildIssuer();
 295         me->setName(application.getXMLString("entityID").second);
 296         resp->setPayload(payload.release());
 297
 298         const EntityDescriptor* entity =
 299             policy.getIssuerMetadata() ? dynamic_cast<EntityDescriptor*>(policy.getIssuerMetadata()->getParent()) : NULL;
 300         const PropertySet* relyingParty = application.getRelyingParty(entity);
 301         pair<bool,bool> flag = relyingParty->getBool("signResponses");
 302         if (flag.first && flag.second && policy.getIssuerMetadata()) {
 303             CredentialResolver* credResolver=application.getCredentialResolver();
 304             if (credResolver) {
 305                 Locker credLocker(credResolver);
 306                 // Fill in criteria to use.
 307                 MetadataCredentialCriteria mcc(*policy.getIssuerMetadata());
 308                 mcc.setUsage(CredentialCriteria::SIGNING_CREDENTIAL);
 309                 pair<bool,const char*> keyName = relyingParty->getString("keyName");
 310                 if (keyName.first)
 311                     mcc.getKeyNames().insert(keyName.second);
 312                 pair<bool,const XMLCh*> sigalg = relyingParty->getXMLString("signatureAlg");
 313                 if (sigalg.first)
 314                     mcc.setXMLAlgorithm(sigalg.second);
 315                 const Credential* cred = credResolver->resolve(&mcc);
 316                 if (cred) {
 317                     // Signed request.
 318                     long ret = m_encoder->encode(
 319                         httpResponse,
 320                         resp.get(),
 321                         NULL,
 322                         entity,
 323                         relayState.c_str(),
 324                         NULL,
 325                         cred,
 326                         sigalg.second,
 327                         relyingParty->getXMLString("digestAlg").second
 328                         );
 329                     resp.release();  // freed by encoder
 330                     return make_pair(true,ret);
 331                 }
 332                 else {
 333                     m_log.warn("no signing credential resolved, leaving response unsigned");
 334                 }
 335             }
 336         }
 337
 338         long ret = m_encoder->encode(httpResponse, resp.get(), NULL, entity, relayState.c_str());
 339         resp.release();  // freed by encoder
 340         return make_pair(true,ret);
 341     }
 342     catch (exception& ex) {
 343         // Trap localized errors in a SAML Response.
 344         m_log.error("error processing artifact request, returning SAML error: %s", ex.what());
 345         return samlError(application, *req, httpResponse, StatusCode::RESPONDER, NULL, ex.what());
 346     }
 347 #else
 348     return make_pair(false,0);
 349 #endif
 350 }
 351
 352 #ifndef SHIBSP_LITE
 353 pair<bool,long> SAML2ArtifactResolution::samlError(
 354     const Application& app, const ArtifactResolve& request, HTTPResponse& httpResponse, const XMLCh* code, const XMLCh* subcode, const char* msg
 355     ) const
 356 {
 357     auto_ptr<ArtifactResponse> resp(ArtifactResponseBuilder::buildArtifactResponse());
 358     resp->setInResponseTo(request.getID());
 359     Issuer* me = IssuerBuilder::buildIssuer();
 360     me->setName(app.getXMLString("entityID").second);
 361     prepareResponse(*resp.get(), code, subcode, msg);
 362     long ret = m_encoder->encode(httpResponse, resp.get(), NULL);
 363     resp.release();  // freed by encoder
 364     return make_pair(true,ret);
 365 }
 366 #endif