XrdAccAuthorize Class Reference

#include <XrdAccAuthorize.hh>

Inheritance diagram for XrdAccAuthorize:

Collaboration diagram for XrdAccAuthorize:

Public Member Functions
	XrdAccAuthorize ()
	Constructor.
virtual	~XrdAccAuthorize ()
	Destructor.
virtual XrdAccPrivs	Access (const XrdSecEntity *Entity, const char *path, const Access_Operation oper, std::string &eInfo, XrdOucEnv *Env=0)
virtual XrdAccPrivs	Access (const XrdSecEntity *Entity, const char *path, const Access_Operation oper, XrdOucEnv *Env=0)=0
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

Detailed Description

Definition at line 71 of file XrdAccAuthorize.hh.

Constructor & Destructor Documentation

XrdAccAuthorize()

XrdAccAuthorize::XrdAccAuthorize ( )

inline

Constructor.

Definition at line 165 of file XrdAccAuthorize.hh.

{}

Referenced by Macaroons::Authz::Authz(), and XrdAccSciTokens::XrdAccSciTokens().

Here is the caller graph for this function:

~XrdAccAuthorize()

virtual XrdAccAuthorize::~XrdAccAuthorize ( )

inlinevirtual

Destructor.

Definition at line 171 of file XrdAccAuthorize.hh.

{}

Member Function Documentation

Access() [1/2]

virtual XrdAccPrivs XrdAccAuthorize::Access ( const XrdSecEntity * Entity, const char * path, const Access_Operation oper, std::string & eInfo, XrdOucEnv * Env = 0 )

inlinevirtual

Check whether or not the client is permitted specified access to a path Version 2. This version supports the return of additional error information.

Parameters

Entity	-> Authentication information
path	-> The logical path which is the target of oper
oper	-> The operation being attempted (see the enum above). If the oper is AOP_Any, then the actual privileges are returned and the caller may make subsequent tests using Test().
eInfo	-> Reference to a string to allow for return of extended error infomation to be returned to caller.
Env	-> Environmental information at the time of the operation as supplied by the path CGI string. This is optional and the pointer may be zero.

Returns

Permit: a non-zero value (access is permitted) Deny: zero (access is denied)

Definition at line 117 of file XrdAccAuthorize.hh.

                    {return Access(Entity, path, oper, Env);}

References Access().

Here is the call graph for this function:

Access() [2/2]

virtual XrdAccPrivs XrdAccAuthorize::Access ( const XrdSecEntity * Entity, const char * path, const Access_Operation oper, XrdOucEnv * Env = 0 )

pure virtual

Check whether or not the client is permitted specified access to a path.

Parameters

Entity	-> Authentication information
path	-> The logical path which is the target of oper
oper	-> The operation being attempted (see the enum above). If the oper is AOP_Any, then the actual privileges are returned and the caller may make subsequent tests using Test().
Env	-> Environmental information at the time of the operation as supplied by the path CGI string. This is optional and the pointer may be zero.

Returns

Permit: a non-zero value (access is permitted) Deny: zero (access is denied)

Implemented in Macaroons::Authz, XrdAccAccess, and XrdAccSciTokens.

Referenced by Access().

Here is the caller graph for this function:

Audit()

virtual int XrdAccAuthorize::Audit ( const int accok, const XrdSecEntity * Entity, const char * path, const Access_Operation oper, XrdOucEnv * Env = 0 )

pure virtual

Route an audit message to the appropriate audit exit routine. See XrdAccAudit.h for more information on how the default implementation works. Currently, this method is not called by the ofs but should be used by the implementation to record denials or grants, as warranted.

Parameters

accok	-> True is access was grated; false otherwise.
Entity	-> Authentication information
path	-> The logical path which is the target of oper
oper	-> The operation being attempted (see above)
Env	-> Environmental information at the time of the operation as supplied by the path CGI string. This is optional and the pointer may be zero.

Returns

Success: !0 information recorded. Failure: 0 information could not be recorded.

Implemented in Macaroons::Authz, XrdAccAccess, and XrdAccSciTokens.

Test()

virtual int XrdAccAuthorize::Test ( const XrdAccPrivs priv, const Access_Operation oper )

pure virtual

Check whether the specified operation is permitted.

Parameters

priv	-> the privileges as returned by Access().
oper	-> The operation being attempted (see above)

Returns

Permit: a non-zero value (access is permitted) Deny: zero (access is denied)

Implemented in Macaroons::Authz, XrdAccAccess, and XrdAccSciTokens.

---

The documentation for this class was generated from the following file:

• XrdAccAuthorize.hh