XrdAccAuthorize.hh

Go to the documentation of this file.

#ifndef __ACC_AUTHORIZE__
#define __ACC_AUTHORIZE__
/******************************************************************************/
/*                                                                            */
/*                    X r d A c c A u t h o r i z e . h h                     */
/*                                                                            */
/* (c) 2000 by the Board of Trustees of the Leland Stanford, Jr., University  */
/*                            All Rights Reserved                             */
/*   Produced by Andrew Hanushevsky for Stanford University under contract    */
/*              DE-AC02-76-SFO0515 with the Department of Energy              */
/*                                                                            */
/* This file is part of the XRootD software suite.                            */
/*                                                                            */
/* XRootD 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.                                                 */
/*                                                                            */
/* XRootD 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 XRootD in a file called COPYING.LESSER (LGPL license) and file  */
/* COPYING (GPL license).  If not, see <http://www.gnu.org/licenses/>.        */
/*                                                                            */
/* The copyright holder's institutional names and contributor's names may not */
/* be used to endorse or promote products derived from this software without  */
/* specific prior written permission of the institution or contributor.       */
/******************************************************************************/
 
#include "XrdAcc/XrdAccPrivs.hh"
 
/******************************************************************************/
/*                      A c c e s s _ O p e r a t i o n                       */
/******************************************************************************/
 
 
enum Access_Operation  {AOP_Any         = 0,  
                        AOP_Chmod       = 1,  
                        AOP_Chown       = 2,  
                        AOP_Create      = 3,  
                        AOP_Delete      = 4,  
                        AOP_Insert      = 5,  
                        AOP_Lock        = 6,  
                        AOP_Mkdir       = 7,  
                        AOP_Read        = 8,  
                        AOP_Readdir     = 9,  
                        AOP_Rename      = 10, 
                        AOP_Stat        = 11, 
                        AOP_Update      = 12, 
                        AOP_Excl_Create = 13, 
                        AOP_Excl_Insert = 14, 
                        AOP_Stage       = 15, 
                        AOP_Poll        = 16, 
                        AOP_LastOp      = 16  //   For limits testing
                       };
 
/******************************************************************************/
/*                       X r d A c c A u t h o r i z e                        */
/******************************************************************************/
 
#include <string>
 
class XrdOucEnv;
class XrdSecEntity;
class XrdSysLogger;
 
class XrdAccAuthorize
{
public:
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
virtual XrdAccPrivs Access(const XrdSecEntity    *Entity,
                           const char            *path,
                           const Access_Operation oper,
                                 XrdOucEnv       *Env=0) = 0;
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
virtual XrdAccPrivs Access(const XrdSecEntity    *Entity,
                           const char            *path,
                           const Access_Operation oper,
                                 std::string     &eInfo,
                                 XrdOucEnv       *Env=0)
                    {return Access(Entity, path, oper, Env);}
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
virtual int         Audit(const int              accok,
                          const XrdSecEntity    *Entity,
                          const char            *path,
                          const Access_Operation oper,
                                XrdOucEnv       *Env=0) = 0;
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
virtual int         Test(const XrdAccPrivs priv,
                         const Access_Operation oper) = 0;
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
                          XrdAccAuthorize() {}
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
virtual                  ~XrdAccAuthorize() {}
};
 
/******************************************************************************/
/*                 X r d A c c A u t h o r i z e O b j e c t                  */
/******************************************************************************/
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
typedef XrdAccAuthorize *(*XrdAccAuthorizeObject_t)(XrdSysLogger *lp,
                                                    const char   *cfn,
                                                    const char   *parm);
 
 
// Alternatively:
 
typedef XrdAccAuthorize *(*XrdAccAuthorizeObject2_t)(XrdSysLogger *lp,
                                                     const char   *cfn,
                                                     const char   *parm,
                                                     XrdOucEnv    *envP);
 
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
typedef XrdAccAuthorize *(*XrdAccAuthorizeObjAdd_t)(XrdSysLogger *lp,
                                                    const char   *cfn,
                                                    const char   *parm,
                                                    XrdOucEnv    *envP,
                                                 XrdAccAuthorize *accP);
 
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
#endif