---

SecurityPlugin.h

/*
   Copyright (C) 2002 - 2003 the Strongroom project

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

   The definition of the security module.

   @author Denis de Leeuw Duarte
   @author Ewald Snel
*/

#ifndef _SECURITYPLUGIN_H_
#define _SECURITYPLUGIN_H_

#include <Error.h>
#include <Config.h>
#include <Common.h>
#include <Plugin.h>
#include <UserProfile.h>


class Permission {};
class QueryResult;

class SecurityPlugin : public Plugin
{
public:
    SecurityPlugin( const Config &cfg );

    virtual ~SecurityPlugin() = 0;

    virtual void getLoginChallenge( string username, string &challenge ) = 0;

    virtual bool hasReadPermission( NumID userid, NumID docid ) = 0;

    virtual bool hasWritePermission( NumID userid, NumID docid ) = 0;

    virtual bool hasDeletePermission( NumID userid, NumID docid ) = 0;

    virtual CoreError changeUserPermission( NumID userid, Permission permission, NumID adminid ) = 0;

    virtual CoreError changeFilePermission( NumID docid, Permission permission, NumID userid ) = 0;
 
    virtual CoreError filterSearchResults( QueryResult &queryResult ) = 0;

    virtual CoreError login( string username, string challenge, string response, UserProfile &user ) = 0;

    virtual CoreError addUser( const UserProfile &userProfile, string challenge, string password, NumID &userid ) = 0;

    virtual CoreError delUser( NumID userid ) = 0;

    virtual CoreError getUserProfile( NumID userid, UserProfile &userProfile ) = 0;

    virtual CoreError changeUserProfile( NumID userid, const UserProfile &userProfile ) = 0;

    virtual CoreError setPassword( NumID userid, string challenge, string oldPassword, string newPassword ) = 0;

    virtual CoreError clearPassword( NumID userid ) = 0;

    virtual CoreError listUsers( vector<NumID> &users ) = 0;

    virtual CoreError fileCreated(NumID userid, NumID docid, Permission permission) = 0;
};

#endif /*_SECURITYPLUGIN_H_*/

---