[Home]	[About]
[Screenshots]	[Download]
[News]	[Community]
[Documentation]	[Manual]
[Bugs & Requests]	[Wiki]

/home/tetron/hack/vos/libs/vos/vos/accesscontrol.hh

Go to the documentation of this file.

/*
    This file is part of the Virtual Object System of
    the Interreality project (http://interreality.org).

    Copyright (C) 2001-2003 Peter Amstutz

    This library 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 2 of the License, or (at your option) any later version.

    This library 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 this library; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307  USA

    Peter Amstutz <http://www.interreality.org>
*/
#ifndef _ACCESSCONTROL_HH_
#define _ACCESSCONTROL_HH_

#include <vos/vos/vosdefs.hh>

#include <string>
#include <map>
#include <deque>

#ifndef VOS_EXPORTS
IMPORT_METAOBJECT_FACTORIES(DefaultACs)
#endif

namespace VOS
{
    class LocalVobject;
    class Vobject;
    class VobjectEvent;
    class Site;

/** @class VobjectAccessControl accesscontrol.hh vos/vos/accesscontrol.hh
    @ingroup libvos
    This is the base class for Vobject access control policies.  A
    policy decides whether a particular read or change action on the
    types, parents or children of Vobject is permitted.
 */
class VOS_API VobjectAccessControl
{
public:
    virtual ~VobjectAccessControl() { }

    /** Called when a child read is requested by a remote object.
        @param e The event to validate
        @param message you may optionally set this to explain why access was denied
        @returns true if allowed, false if denied
    */
    virtual bool checkReadChildPermission(VobjectEvent& e, std::string& message) = 0;

    /** Called when a type read is requested by a remote object.
        @param e The event to validate
        @param message you may optionally set this to explain why access was denied
        @returns true if allowed, false if denied
    */
    virtual bool checkReadTypePermission(VobjectEvent& e, std::string& message) = 0;

    /** Called when a type add is requested by a remote object.
        @param e The event to validate
        @param message you may optionally set this to explain why access was denied
        @returns true if allowed, false if denied
    */
    virtual bool checkAddTypePermission(VobjectEvent& e, std::string& message) = 0;

    /** Called when a type remove is requested by a remote object.
        @param e The event to validate
        @param message you may optionally set this to explain why access was denied
        @returns true if allowed, false if denied
    */
    virtual bool checkRemoveTypePermission(VobjectEvent& e, std::string& message) = 0;

    /** Called when a parent read is requested by a remote object
        @param e The event to validate
        @param message you may optionally set this to explain why access was denied
        @returns true if allowed, false if denied
    */
    virtual bool checkReadParentPermission(VobjectEvent& e, std::string& message) = 0;

    /** Called when a child replace is requested by a remote object.
        @param e The event to validate
        @param message you may optionally set this to explain why access was denied
        @returns true if allowed, false if denied
    */
    virtual bool checkSetChildPermission(VobjectEvent& e, std::string& message) = 0;

    /** Called when a child insert is requested by a remote object.
        @param e The event to validate
        @param message you may optionally set this to explain why access was denied
        @returns true if allowed, false if denied
    */
    virtual bool checkInsertChildPermission(VobjectEvent& e, std::string& message) = 0;

    /** Called when a child remove is requested by a remote object.
        @param e The event to validate
        @param message you may optionally set this to explain why access was denied
        @returns true if allowed, false if denied
    */
    virtual bool checkRemoveChildPermission(VobjectEvent& e, std::string& message) = 0;

    /** Called when a remote object wants to listen to the child list of some
        object.
        @param e The event to validate
        @param message you may optionally set this to explain why access was denied
        @returns true if allowed, false if denied
    */
    virtual bool checkChildListenPermission(VobjectEvent& e, std::string& message) = 0;

    /** Called when a remote object wants to listen to the parent set of some
        object.
        @param e The event to validate
        @param message you may optionally set this to explain why access was denied
        @returns true if allowed, false if denied
    */
    virtual bool checkParentListenPermission(VobjectEvent& e, std::string& message) = 0;

    /** Called when a remote object wants to listen to the parent set of some
        object.
        @param e The event to validate
        @param message you may optionally set this to explain why access was denied
        @returns true if allowed, false if denied
    */
    virtual bool checkTypeListenPermission(VobjectEvent& e, std::string& message) = 0;


    /** Called when a remote object wants to read access control lists.
        @param e The event to validate
        @param message you may optionally set this to explain why access was denied
        @returns true if allowed, false if denied
    */
    virtual bool checkPolicyReadPermission(VobjectEvent& e, std::string& message) = 0;

    /** Called when a remote object wants to change the access control lists.
        @param e The event to validate
        @param message you may optionally set this to explain why access was denied
        @returns true if allowed, false if denied
    */
    virtual bool checkPolicyChangePermission(VobjectEvent& e, std::string& message) = 0;

    /** @return this is overidden by the concrete implementation of
        your policy and returns the policy name that will be used by
        the access control list.  Form should be "domain:policy", for
        example ReadOnlyAccessControl returns "core:read-only".
    */
    virtual const std::string getPolicyName() = 0;
};

/** @class AcceptAllAccessControl accesscontrol.hh vos/vos/accesscontrol.hh
    @ingroup libvos
    Access control policy that always says yes. */
class VOS_API AcceptAllAccessControl : public VobjectAccessControl
{
public:
    static AcceptAllAccessControl static_;

    virtual ~AcceptAllAccessControl() { }

    /** @returns true always */
    virtual bool checkReadChildPermission(VobjectEvent& e, std::string& message);
    /** @returns true always */
    virtual bool checkReadTypePermission(VobjectEvent& e, std::string& message);
    /** @returns true always */
    virtual bool checkReadParentPermission(VobjectEvent& e, std::string& message);
    /** @returns true always */
    virtual bool checkAddTypePermission(VobjectEvent& e, std::string& message);
    /** @returns true always */
    virtual bool checkRemoveTypePermission(VobjectEvent& e, std::string& message);
    /** @returns true always */
    virtual bool checkSetChildPermission(VobjectEvent& e, std::string& message);
    /** @returns true always */
    virtual bool checkInsertChildPermission(VobjectEvent& e, std::string& message);
    /** @returns true always */
    virtual bool checkRemoveChildPermission(VobjectEvent& e, std::string& message);
    /** @returns true always */
    virtual bool checkChildListenPermission(VobjectEvent& e, std::string& message);
    /** @returns true always */
    virtual bool checkTypeListenPermission(VobjectEvent& e, std::string& message);
    /** @returns true always */
    virtual bool checkParentListenPermission(VobjectEvent& e, std::string& message);
    /** @returns true always */
    virtual bool checkPolicyReadPermission(VobjectEvent& e, std::string& message);
    /** @returns true always */
    virtual bool checkPolicyChangePermission(VobjectEvent& e, std::string& message);
    virtual const std::string getPolicyName();
};

/** @class ReadOnlyAccessControl accesscontrol.hh vos/vos/accesscontrol.hh
    @ingroup libvos
     Access control policy that allows requests for information (reads) but denies all
     changes. */
class VOS_API ReadOnlyAccessControl : public VobjectAccessControl
{
public:
    static ReadOnlyAccessControl static_;

    virtual ~ReadOnlyAccessControl() { }

    /** @returns true always */
    virtual bool checkReadChildPermission(VobjectEvent& e, std::string& message);
    /** @returns true always */
    virtual bool checkReadTypePermission(VobjectEvent& e, std::string& message);
    /** @returns true always */
    virtual bool checkReadParentPermission(VobjectEvent& e, std::string& message);
    /** @returns false always */
    virtual bool checkAddTypePermission(VobjectEvent& e, std::string& message);
    /** @returns false always */
    virtual bool checkRemoveTypePermission(VobjectEvent& e, std::string& message);
    /** @returns false always */
    virtual bool checkSetChildPermission(VobjectEvent& e, std::string& message);
    /** @returns false always */
    virtual bool checkInsertChildPermission(VobjectEvent& e, std::string& message);
    /** @returns false always */
    virtual bool checkRemoveChildPermission(VobjectEvent& e, std::string& message);
    /** @returns true always */
    virtual bool checkChildListenPermission(VobjectEvent& e, std::string& message);
    /** @returns true always */
    virtual bool checkTypeListenPermission(VobjectEvent& e, std::string& message);
    /** @returns true always */
    virtual bool checkParentListenPermission(VobjectEvent& e, std::string& message);
    /** @returns true always */
    virtual bool checkPolicyReadPermission(VobjectEvent& e, std::string& message);
    /** @returns false always */
    virtual bool checkPolicyChangePermission(VobjectEvent& e, std::string& message);
    virtual const std::string getPolicyName();
};

/** @class DenyAllAccessControl accesscontrol.hh vos/vos/accesscontrol.hh
    @ingroup libvos
    Access control policy that always says no.
*/
class VOS_API DenyAllAccessControl : public VobjectAccessControl
{
public:
    static DenyAllAccessControl static_;

    virtual ~DenyAllAccessControl() { }

    /** @returns false always */
    virtual bool checkReadChildPermission(VobjectEvent& e, std::string& message);
    /** @returns false always */
    virtual bool checkReadTypePermission(VobjectEvent& e, std::string& message);
    /** @returns false always */
    virtual bool checkReadParentPermission(VobjectEvent& e, std::string& message);
    /** @returns false always */
    virtual bool checkAddTypePermission(VobjectEvent& e, std::string& message);
    /** @returns false always */
    virtual bool checkRemoveTypePermission(VobjectEvent& e, std::string& message);
    /** @returns false always */
    virtual bool checkSetChildPermission(VobjectEvent& e, std::string& message);
    /** @returns false always */
    virtual bool checkInsertChildPermission(VobjectEvent& e, std::string& message);
    /** @returns false always */
    virtual bool checkRemoveChildPermission(VobjectEvent& e, std::string& message);
    /** @returns false always */
    virtual bool checkChildListenPermission(VobjectEvent& e, std::string& message);
    /** @returns false always */
    virtual bool checkTypeListenPermission(VobjectEvent& e, std::string& message);
    /** @returns false always */
    virtual bool checkParentListenPermission(VobjectEvent& e, std::string& message);
    /** @returns false always */
    virtual bool checkPolicyReadPermission(VobjectEvent& e, std::string& message);
    /** @returns false always */
    virtual bool checkPolicyChangePermission(VobjectEvent& e, std::string& message);

    virtual const std::string getPolicyName();
};

/** @class SiteAccessControl accesscontrol.hh vos/vos/accesscontrol.hh
    @ingroup libvos
    Access control checks specific to operations on Site objects.
*/
class VOS_API SiteAccessControl
{
public:
    virtual ~SiteAccessControl() { }

    /** Called when a remote site wishes to create an object on our local site.
        @param requester the remote requesting object
        @param site our site the object will be created on
        @param name the requested site name for this vobject
        @param types the requested type set for this vobject
        @param message you may optionally set this to explain why access was denied
        @returns true if allowed, false if denied
    */
    virtual bool checkCreateVobjectPermission(Vobject& requester, Site& site,
                                              const std::string name,
                                              const std::deque<std::string> types,
                                              std::string& message) = 0;

    /** Called when a remote site wishes to rename an object on our local site.
        @param requester the remote requesting object
        @param site our site that owns the object
        @param oldname the current name
        @param newname the name the requester wants to change it to
        @param message you may optionally set this to explain why access was denied
        @returns true if allowed, false if denied
    */
    virtual bool checkRenameVobjectPermission(Vobject& requester, Site& site,
                                              const std::string oldname,
                                              const std::string newname,
                                              std::string& message) = 0;
    virtual const std::string getPolicyName() = 0;
};

/** @class AcceptAllSiteAccessControl accesscontrol.hh vos/vos/accesscontrol.hh
    @ingroup libvos
    Access control that always says yes.
*/
class VOS_API AcceptAllSiteAccessControl : public SiteAccessControl
{
public:
    static AcceptAllSiteAccessControl static_;

    virtual ~AcceptAllSiteAccessControl() { }

    /**  @returns true always */
    virtual bool checkCreateVobjectPermission(Vobject& requester, Site& site, const std::string name,
                                              const std::deque<std::string> types, std::string& message);

    /**  @returns true always */
    virtual bool checkRenameVobjectPermission(Vobject& requester, Site& site, const std::string oldname,
                                              const std::string newname, std::string& message);
    virtual const std::string getPolicyName();
};

/** @class DenyAllSiteAccessControl accesscontrol.hh vos/vos/accesscontrol.hh
    @ingroup libvos
    Access control that always says no.
*/
class VOS_API DenyAllSiteAccessControl : public SiteAccessControl
{
public:
    static DenyAllSiteAccessControl static_;

    virtual ~DenyAllSiteAccessControl() { }

    /**  @returns false always */
    virtual bool checkCreateVobjectPermission(Vobject& requester, Site& site, const std::string name,
                                              const std::deque<std::string> types, std::string& message);

    /**  @returns false always */
    virtual bool checkRenameVobjectPermission(Vobject& requester, Site& site, const std::string oldname,
                                              const std::string newname, std::string& message);
    virtual const std::string getPolicyName();
};

}

#endif