cpp/src/qpid/acl/Acl.cpp

/*
 *
 * Copyright (c) 2006 The Apache Software Foundation
 *
 * 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
 *
 *    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.
 *
 */

#include "qpid/acl/Acl.h"
#include "qpid/acl/AclData.h"
#include "qpid/acl/AclValidator.h"
#include "qpid/sys/Mutex.h"

#include "qpid/broker/Broker.h"
#include "qpid/Plugin.h"
#include "qpid/Options.h"
#include "qpid/log/Logger.h"
#include "qpid/types/Variant.h"
#include "qmf/org/apache/qpid/acl/Package.h"
#include "qmf/org/apache/qpid/acl/EventAllow.h"
#include "qmf/org/apache/qpid/acl/EventDeny.h"
#include "qmf/org/apache/qpid/acl/EventFileLoaded.h"
#include "qmf/org/apache/qpid/acl/EventFileLoadFailed.h"

#include <map>

#include <boost/shared_ptr.hpp>
#include <boost/utility/in_place_factory.hpp>

using namespace std;
using namespace qpid::acl;
using qpid::broker::Broker;
using namespace qpid::sys;
using qpid::management::ManagementAgent;
using qpid::management::ManagementObject;
using qpid::management::Manageable;
using qpid::management::Args;
namespace _qmf = qmf::org::apache::qpid::acl;

Acl::Acl (AclValues& av, Broker& b): aclValues(av), broker(&b), transferAcl(false), mgmtObject(0)
{
	   
    agent = broker->getManagementAgent();

    if (agent != 0){
        _qmf::Package  packageInit(agent);
        mgmtObject = new _qmf::Acl (agent, this, broker);
        agent->addObject (mgmtObject);
    }
    std::string errorString;
    if (!readAclFile(errorString)){
        throw Exception("Could not read ACL file " + errorString);
        if (mgmtObject!=0) mgmtObject->set_enforcingAcl(0);
    }
    QPID_LOG(info, "ACL Plugin loaded");
	if (mgmtObject!=0) mgmtObject->set_enforcingAcl(1);
}

   bool Acl::authorise(const std::string& id, const Action& action, const ObjectType& objType, const std::string& name, std::map<Property, std::string>* params)
   {
      boost::shared_ptr<AclData> dataLocal;
      { 
        Mutex::ScopedLock locker(dataLock);
        dataLocal = data;  //rcu copy
      }

      // add real ACL check here...
      AclResult aclreslt = dataLocal->lookup(id,action,objType,name,params);


	  return result(aclreslt, id, action, objType, name);
   }

   bool Acl::authorise(const std::string& id, const Action& action, const ObjectType& objType, const std::string& ExchangeName, const std::string& RoutingKey)
   {
      boost::shared_ptr<AclData> dataLocal;
      {
        Mutex::ScopedLock locker(dataLock);
        dataLocal = data;  //rcu copy
      }

      // only use dataLocal here...
      AclResult aclreslt = dataLocal->lookup(id,action,objType,ExchangeName,RoutingKey);

	  return result(aclreslt, id, action, objType, ExchangeName);
   }


   bool Acl::result(const AclResult& aclreslt, const std::string& id, const Action& action, const ObjectType& objType, const std::string& name)
   {
	  switch (aclreslt)
	  {
	  case ALLOWLOG:
          QPID_LOG(info, "ACL Allow id:" << id <<" action:" << AclHelper::getActionStr(action) <<
                   " ObjectType:" << AclHelper::getObjectTypeStr(objType) << " Name:" << name );
          agent->raiseEvent(_qmf::EventAllow(id,  AclHelper::getActionStr(action),
                                             AclHelper::getObjectTypeStr(objType),
                                             name, types::Variant::Map()));
	  case ALLOW:
	      return true;
	  case DENY:
	      if (mgmtObject!=0) mgmtObject->inc_aclDenyCount();
	      return false;
	  case DENYLOG:
	      if (mgmtObject!=0) mgmtObject->inc_aclDenyCount();
      default:
          QPID_LOG(info, "ACL Deny id:" << id << " action:" << AclHelper::getActionStr(action) << " ObjectType:" << AclHelper::getObjectTypeStr(objType) << " Name:" << name);
          agent->raiseEvent(_qmf::EventDeny(id, AclHelper::getActionStr(action),
                                            AclHelper::getObjectTypeStr(objType),
                                            name, types::Variant::Map()));
          return false;
	  }
      return false;
   }

   bool Acl::readAclFile(std::string& errorText)
   {
      // only set transferAcl = true if a rule implies the use of ACL on transfer, else keep false for performance reasons.
      return readAclFile(aclValues.aclFile, errorText);
   }

   bool Acl::readAclFile(std::string& aclFile, std::string& errorText) {      
      boost::shared_ptr<AclData> d(new AclData);
      AclReader ar;
      if (ar.read(aclFile, d)){
          agent->raiseEvent(_qmf::EventFileLoadFailed("", ar.getError()));
          errorText = ar.getError();
          QPID_LOG(error,ar.getError());
          return false;
      }

      AclValidator validator;
      validator.validate(d);

      {  
        Mutex::ScopedLock locker(dataLock);
        data = d;
      }
	  transferAcl = data->transferAcl; // any transfer ACL

      if (data->transferAcl){
        QPID_LOG(debug,"Transfer ACL is Enabled!");
      }

      data->aclSource = aclFile; 
	  if (mgmtObject!=0){
	      mgmtObject->set_transferAcl(transferAcl?1:0);
		  mgmtObject->set_policyFile(aclFile);
		  sys::AbsTime now = sys::AbsTime::now();
          int64_t ns = sys::Duration(sys::EPOCH, now);
		  mgmtObject->set_lastAclLoad(ns);
          agent->raiseEvent(_qmf::EventFileLoaded(""));
	  }
      return true;
   }

   Acl::~Acl(){}

   ManagementObject* Acl::GetManagementObject(void) const
   {
       return (ManagementObject*) mgmtObject;
   }

   Manageable::status_t Acl::ManagementMethod (uint32_t methodId, Args& /*args*/, string& text)
   {
      Manageable::status_t status = Manageable::STATUS_UNKNOWN_METHOD;
      QPID_LOG (debug, "Queue::ManagementMethod [id=" << methodId << "]");

      switch (methodId)
      {
      case _qmf::Acl::METHOD_RELOADACLFILE :
          readAclFile(text);
          if (text.empty())
              status = Manageable::STATUS_OK;
          else
              status = Manageable::STATUS_USER;
          break;
      }

    return status;
}