SSPCPP-616 - clean up concatenated string literals
[shibboleth/cpp-opensaml.git] / saml / binding / impl / MessageFlowRule.cpp
index ef70bd0..8b117cf 100644 (file)
@@ -1,40 +1,62 @@
-/*
- *  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.
  */
 
 /**
  * MessageFlowRule.cpp
- * 
- * SAML replay and freshness checking SecurityPolicyRule
+ *
+ * SAML replay and freshness checking SecurityPolicyRule.
  */
 
 #include "internal.h"
 #include "exceptions.h"
-#include "RootObject.h"
-#include "binding/MessageFlowRule.h"
+#include "binding/SecurityPolicy.h"
+#include "binding/SecurityPolicyRule.h"
 
-#include <xmltooling/util/NDC.h>
+#include <xmltooling/logging.h>
+#include <xmltooling/XMLToolingConfig.h>
 #include <xmltooling/util/ReplayCache.h>
-#include <log4cpp/Category.hh>
+#include <xmltooling/util/XMLHelper.h>
+#include <xercesc/util/XMLUniDefs.hpp>
 
 using namespace opensaml;
+using namespace xmltooling::logging;
 using namespace xmltooling;
-using namespace log4cpp;
 using namespace std;
 
 namespace opensaml {
+    class SAML_DLLLOCAL MessageFlowRule : public SecurityPolicyRule
+    {
+    public:
+        MessageFlowRule(const DOMElement* e);
+        virtual ~MessageFlowRule() {}
+
+        const char* getType() const {
+            return MESSAGEFLOW_POLICY_RULE;
+        }
+        bool evaluate(const XMLObject& message, const GenericRequest* request, SecurityPolicy& policy) const;
+
+    private:
+        bool m_checkReplay;
+        time_t m_expires;
+    };
+
     SecurityPolicyRule* SAML_DLLLOCAL MessageFlowRuleFactory(const DOMElement* const & e)
     {
         return new MessageFlowRule(e);
@@ -45,63 +67,53 @@ static const XMLCh checkReplay[] = UNICODE_LITERAL_11(c,h,e,c,k,R,e,p,l,a,y);
 static const XMLCh expires[] = UNICODE_LITERAL_7(e,x,p,i,r,e,s);
 
 MessageFlowRule::MessageFlowRule(const DOMElement* e)
-    : m_checkReplay(true), m_expires(XMLToolingConfig::getConfig().clock_skew_secs)
+    : m_checkReplay(XMLHelper::getAttrBool(e, true, checkReplay)),
+        m_expires(XMLHelper::getAttrInt(e, XMLToolingConfig::getConfig().clock_skew_secs, expires))
 {
-    if (e) {
-        const XMLCh* attr = e->getAttributeNS(NULL, checkReplay);
-        if (attr && (*attr==chLatin_f || *attr==chDigit_0))
-            m_checkReplay = false;
-        attr = e->getAttributeNS(NULL, expires);
-        if (attr)
-            m_expires = XMLString::parseInt(attr);
-    }
 }
 
-pair<saml2::Issuer*,const saml2md::RoleDescriptor*> MessageFlowRule::evaluate(
-    const GenericRequest& request,
-    const XMLObject& message,
-    const saml2md::MetadataProvider* metadataProvider,
-    const QName* role,
-    const opensaml::TrustEngine* trustEngine
-    ) const
+bool MessageFlowRule::evaluate(const XMLObject& message, const GenericRequest* request, SecurityPolicy& policy) const
 {
-    try {
-        const RootObject& obj = dynamic_cast<const RootObject&>(message);
-        check(obj.getID(), obj.getIssueInstantEpoch());
-    }
-    catch (bad_cast&) {
-        throw BindingException("Message was not of a recognized type.");
-    }
-    return pair<saml2::Issuer*,const saml2md::RoleDescriptor*>(NULL,NULL);
-}
-
-void MessageFlowRule::check(const XMLCh* id, time_t issueInstant) const
-{
-    Category& log=Category::getInstance(SAML_LOGCAT".SecurityPolicyRule.MessageFlow");
+    Category& log=Category::getInstance(SAML_LOGCAT ".SecurityPolicyRule.MessageFlow");
     log.debug("evaluating message flow policy (replay checking %s, expiration %lu)", m_checkReplay ? "on" : "off", m_expires);
-    
+
+    time_t now = policy.getTime();
     time_t skew = XMLToolingConfig::getConfig().clock_skew_secs;
-    time_t now = time(NULL);
-    if (issueInstant > now + skew) {
-        log.error("rejected not-yet-valid message, timestamp (%lu), now (%lu)", issueInstant, now + skew);
-        throw BindingException("Message rejected, was issued in the future.");
+    time_t issueInstant = policy.getIssueInstant();
+    if (issueInstant == 0) {
+        issueInstant = now;
     }
-    else if (issueInstant < now - skew - m_expires) {
-        log.error("rejected expired message, timestamp (%lu), oldest allowed (%lu)", issueInstant, now - skew - m_expires);
-        throw BindingException("Message expired, was issued too long ago.");
+    else {
+        if (issueInstant > now + skew) {
+            log.errorStream() << "rejected not-yet-valid message, timestamp (" << issueInstant <<
+                "), newest allowed (" << now + skew << ")" << logging::eol;
+            throw SecurityPolicyException("Message rejected, was issued in the future.");
+        }
+        else if (issueInstant < now - skew - m_expires) {
+            log.errorStream() << "rejected expired message, timestamp (" << issueInstant <<
+                "), oldest allowed (" << (now - skew - m_expires) << ")" << logging::eol;
+            throw SecurityPolicyException("Message expired, was issued too long ago.");
+        }
     }
-    
+
     // Check replay.
     if (m_checkReplay) {
+        const XMLCh* id = policy.getMessageID();
+        if (!id || !*id)
+            return false;
+
         ReplayCache* replayCache = XMLToolingConfig::getConfig().getReplayCache();
-        if (!replayCache)
-            throw BindingException("No ReplayCache instance available.");
-        else if (!id)
-            throw BindingException("Message did not contain an identifier.");
-        auto_ptr_char temp(id);  
-        if (!replayCache->check("SAML", temp.get(), issueInstant + skew + m_expires)) {
+        if (!replayCache) {
+            log.warn("no ReplayCache available, skipping requested replay check");
+            return false;
+        }
+
+        auto_ptr_char temp(id);
+        if (!replayCache->check("MessageFlow", temp.get(), issueInstant + skew + m_expires)) {
             log.error("replay detected of message ID (%s)", temp.get());
-            throw BindingException("Rejecting replayed message ID ($1).", params(1,temp.get()));
+            throw SecurityPolicyException("Rejecting replayed message ID ($1).", params(1,temp.get()));
         }
+        return true;
     }
+    return false;
 }