XRootD
XrdSciTokensHelper Class Referenceabstract

#include <XrdSciTokensHelper.hh>

+ Inheritance diagram for XrdSciTokensHelper:
+ Collaboration diagram for XrdSciTokensHelper:

Classes

struct  ValidIssuer
 

Public Types

typedef std::vector< ValidIssuerIssuers
 

Public Member Functions

 XrdSciTokensHelper ()
 Constructor and Destructor. More...
 
virtual ~XrdSciTokensHelper ()
 
virtual Issuers IssuerList ()=0
 
virtual bool Validate (const char *token, std::string &emsg, long long *expT=0, XrdSecEntity *entP=0)=0
 

Detailed Description

Definition at line 22 of file XrdSciTokensHelper.hh.


Class Documentation

◆ XrdSciTokensHelper::ValidIssuer

struct XrdSciTokensHelper::ValidIssuer

Get the list of valid issuers.

Returns
A vector of valid issuers. The list of issuers never changes. Only a reconfig of the scitokens plugin could cause the issuer list to change, which right now only happens in plugin initialization.

Definition at line 35 of file XrdSciTokensHelper.hh.

+ Collaboration diagram for XrdSciTokensHelper::ValidIssuer:
Class Members
string issuer_name
string issuer_url

Member Typedef Documentation

◆ Issuers

Definition at line 39 of file XrdSciTokensHelper.hh.

Constructor & Destructor Documentation

◆ XrdSciTokensHelper()

XrdSciTokensHelper::XrdSciTokensHelper ( )
inline

Constructor and Destructor.

Definition at line 67 of file XrdSciTokensHelper.hh.

67 {}

◆ ~XrdSciTokensHelper()

virtual XrdSciTokensHelper::~XrdSciTokensHelper ( )
inlinevirtual

Definition at line 68 of file XrdSciTokensHelper.hh.

68 {}

Member Function Documentation

◆ IssuerList()

virtual Issuers XrdSciTokensHelper::IssuerList ( )
pure virtual

Implemented in XrdAccSciTokens, and Macaroons::Authz.

◆ Validate()

virtual bool XrdSciTokensHelper::Validate ( const char *  token,
std::string &  emsg,
long long *  expT = 0,
XrdSecEntity entP = 0 
)
pure virtual

Validate a scitoken.

Parameters
token- Pointer to the token to validate.
emsg- Reference to a string to hold the reason for rejection
expT- Pointer to where the expiry value is to be placed. If nill, the value is not returned.
entP- Pointer to the SecEntity object and when not nil requests that it be filled with any identifying information in the token. The caller assumes that all supplied fields may be released by calling free().
Returns
Return true if the token is valid; false otherwise with emsg set.

Implemented in Macaroons::Authz, and XrdAccSciTokens.

Referenced by XrdSecProtocolztn::Authenticate().

+ Here is the caller graph for this function:

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