Acls.h

Go to the documentation of this file.

/* Copyright 2013-2019 Homegear GmbH
 *
 * libhomegear-base is free software: you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * libhomegear-base is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with libhomegear-base.  If not, see
 * <http://www.gnu.org/licenses/>.
 *
 * In addition, as a special exception, the copyright holders give
 * permission to link the code of portions of this program with the
 * OpenSSL library under certain conditions as described in each
 * individual source file, and distribute linked combinations
 * including the two.
 * You must obey the GNU Lesser General Public License in all respects
 * for all of the code used other than OpenSSL.  If you modify
 * file(s) with this exception, you may extend this exception to your
 * version of the file(s), but you are not obligated to do so.  If you
 * do not wish to do so, delete this exception statement from your
 * version.  If you delete this exception statement from all source
 * files in the program, then also delete it here.
*/

#ifndef LIBHOMEGEAR_BASE_ACLS_H
#define LIBHOMEGEAR_BASE_ACLS_H

#include "Acl.h"
#include "../Output/Output.h"

#include <mutex>

namespace BaseLib {

class SharedObjects;

namespace Systems {
class Peer;
}

namespace Security {

class Acls {
 private:
  BaseLib::SharedObjects *_bl = nullptr;
  int32_t _clientId = -1;
  BaseLib::Output _out;
  std::mutex _aclsMutex;
  std::vector<PAcl> _acls;
 public:
  Acls(BaseLib::SharedObjects *bl, int32_t clientId);
  ~Acls();

  bool categoriesReadSet();
  bool categoriesWriteSet();
  bool rolesReadSet();
  bool rolesWriteSet();
  bool devicesReadSet();
  bool devicesWriteSet();
  bool roomsReadSet();
  bool roomsWriteSet();
  bool buildingPartsReadSet();
  bool buildingPartsWriteSet();
  bool buildingPartsRoomsCategoriesRolesDevicesReadSet();
  bool buildingPartsRoomsCategoriesRolesDevicesWriteSet();
  bool variablesReadSet();
  bool variablesWriteSet();
  bool variablesBuildingPartsRoomsCategoriesRolesDevicesReadSet();
  bool variablesBuildingPartsRoomsCategoriesRolesDevicesWriteSet();
  bool variablesBuildingPartsRoomsCategoriesRolesReadSet();
  bool variablesBuildingPartsRoomsCategoriesRolesWriteSet();

  void clear();
  bool fromUser(std::string &userName);
  bool fromGroups(std::vector<uint64_t> &groupIds);

  PVariable toVariable();
  void fromVariable(PVariable serializedData);

  bool checkServiceAccess(std::string serviceName);

  bool checkCategoriesReadAccess(std::set<uint64_t> &categories);

  bool checkCategoriesWriteAccess(std::set<uint64_t> &categories);

  bool checkCategoryReadAccess(uint64_t categoryId);

  bool checkCategoryWriteAccess(uint64_t categoryId);

  bool checkRolesReadAccess(std::set<uint64_t> &roles);

  bool checkRolesWriteAccess(std::set<uint64_t> &roles);

  bool checkRoleReadAccess(uint64_t roleId);

  bool checkRoleWriteAccess(uint64_t roleId);

  bool checkDeviceReadAccess(std::shared_ptr<Systems::Peer> peer);

  bool checkDeviceWriteAccess(std::shared_ptr<Systems::Peer> peer);

  bool checkEventServerMethodAccess(std::string methodName);

  bool checkMethodAccess(std::string methodName);

  bool checkMethodAndCategoryReadAccess(std::string methodName, uint64_t categoryId);

  bool checkMethodAndCategoryWriteAccess(std::string methodName, uint64_t categoryId);

  bool checkMethodAndRoleReadAccess(std::string methodName, uint64_t roleId);

  bool checkMethodAndRoleWriteAccess(std::string methodName, uint64_t roleId);

  bool checkMethodAndRoomReadAccess(std::string methodName, uint64_t roomId);

  bool checkMethodAndRoomWriteAccess(std::string methodName, uint64_t roomId);

  bool checkMethodAndBuildingPartReadAccess(std::string methodName, uint64_t buildingPartId);

  bool checkMethodAndBuildingPartWriteAccess(std::string methodName, uint64_t buildingPartId);

  bool checkMethodAndDeviceWriteAccess(std::string methodName, uint64_t peerId);

  bool checkNodeBlueVariableReadAccess(const std::string &nodeId, int32_t input);

  bool checkNodeBlueVariableWriteAccess(const std::string &nodeId, int32_t input);

  bool checkRoomReadAccess(uint64_t roomId);

  bool checkRoomWriteAccess(uint64_t roomId);

  bool checkBuildingPartReadAccess(uint64_t buildingPartId);

  bool checkBuildingPartWriteAccess(uint64_t buildingPartId);

  bool checkSystemVariableReadAccess(Database::PSystemVariable systemVariable);

  bool checkSystemVariableWriteAccess(Database::PSystemVariable systemVariable);

  bool checkVariableReadAccess(std::shared_ptr<Systems::Peer> peer, int32_t channel, const std::string &variableName);

  bool checkVariableWriteAccess(std::shared_ptr<Systems::Peer> peer, int32_t channel, const std::string &variableName);
};
typedef std::shared_ptr<Acls> PAcls;

}
}

#endif