xrootd
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Protected Member Functions | Private Member Functions | List of all members
XrdSecProtector Class Reference

#include <XrdSecProtector.hh>

Public Types

enum  lrType { isLcl =0 , isRmt =1 , isLR =2 }
 

Public Member Functions

virtual bool Config (const XrdSecProtectParms &lclParms, const XrdSecProtectParms &rmtParms, XrdSysLogger &logr)
 
virtual const char * LName (XrdSecProtectParms::secLevel level)
 
virtual XrdSecProtectNew4Client (XrdSecProtocol &aprot, const ServerResponseReqs_Protocol &inReqs, unsigned int reqLen)
 
virtual XrdSecProtectNew4Server (XrdSecProtocol &aprot, int plvl)
 
virtual int ProtResp (ServerResponseReqs_Protocol &resp, XrdNetAddrInfo &nai, int pver)
 
virtual ~XrdSecProtector ()
 Destructor.
 

Protected Member Functions

 XrdSecProtector ()
 

Private Member Functions

void Config (const XrdSecProtectParms &parms, ServerResponseReqs_Protocol &reqs)
 

Member Enumeration Documentation

◆ lrType

Enumerator
isLcl 
isRmt 
isLR 

Constructor & Destructor Documentation

◆ ~XrdSecProtector()

virtual XrdSecProtector::~XrdSecProtector ( )
inlinevirtual

Destructor.

◆ XrdSecProtector()

XrdSecProtector::XrdSecProtector ( )
inlineprotected

Member Function Documentation

◆ Config() [1/2]

virtual bool XrdSecProtector::Config ( const XrdSecProtectParms lclParms,
const XrdSecProtectParms rmtParms,
XrdSysLogger logr 
)
virtual

Configure protect for server-side use (not need for client)

Parameters
lclParmsReference to local client parameters.
rmtParmsReference to remote client parameters.
logrReference to the message logging object.
Returns
true upon success and false upon failure.

◆ Config() [2/2]

void XrdSecProtector::Config ( const XrdSecProtectParms parms,
ServerResponseReqs_Protocol reqs 
)
private

◆ LName()

virtual const char * XrdSecProtector::LName ( XrdSecProtectParms::secLevel  level)
virtual

Convert protection level to its corresponding name.

Parameters
levelThe level value.
Returns
Pointer to the name of the level.

◆ New4Client()

virtual XrdSecProtect * XrdSecProtector::New4Client ( XrdSecProtocol aprot,
const ServerResponseReqs_Protocol inReqs,
unsigned int  reqLen 
)
virtual

Obtain a new instance of a protection object based on protocol response. This is meant to be used client-side.

Parameters
aprotSets the authentication protocol used and is the protocol used to secure requests. It must be supplied. Security is meaningless unless successful authentication has occurred.
inReqsReference to the security information returned in the kXR_protocol request.
reqLenThe actual length of inReqs (is validated).
Returns
Pointer to a security object upon success and nil if security is not needed.

◆ New4Server()

virtual XrdSecProtect * XrdSecProtector::New4Server ( XrdSecProtocol aprot,
int  plvl 
)
virtual

Obtain a new instance of a security object based on security setting for this object. This is meant to be used severt-side.

Parameters
aprotSets the authentication protocol used and is the protocol used to secure requests. It must be supplied.
plvlThe client's protocol level.
Returns
Pointer to a security object upon success and nil if security is not needed.

◆ ProtResp()

virtual int XrdSecProtector::ProtResp ( ServerResponseReqs_Protocol resp,
XrdNetAddrInfo nai,
int  pver 
)
virtual

Obtain the proper kXR_protocol response (server-side only)

Parameters
respReference to the place where the response is to be placed.
naiReference to the client's network address.
pverClient's protocol version in host byte order.
Returns
The length of the protocol response security information.

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