XRootD
XrdSciTokensAccess.cc File Reference
#include "XrdAcc/XrdAccAuthorize.hh"
#include "XrdOuc/XrdOucEnv.hh"
#include "XrdOuc/XrdOucGatherConf.hh"
#include "XrdOuc/XrdOucPrivateUtils.hh"
#include "XrdSec/XrdSecEntity.hh"
#include "XrdSec/XrdSecEntityAttr.hh"
#include "XrdSys/XrdSysLogger.hh"
#include "XrdTls/XrdTlsContext.hh"
#include "XrdVersion.hh"
#include <cctype>
#include <ctime>
#include <map>
#include <memory>
#include <mutex>
#include <string>
#include <vector>
#include <sstream>
#include <fstream>
#include <unordered_map>
#include <tuple>
#include "fcntl.h"
#include "INIReader.h"
#include "picojson.h"
#include "scitokens/scitokens.h"
#include "XrdSciTokens/XrdSciTokensAccess.hh"
#include "XrdSciTokens/XrdSciTokensHelper.hh"
#include "XrdSciTokens/XrdSciTokensMon.hh"
+ Include dependency graph for XrdSciTokensAccess.cc:

Go to the source code of this file.

Classes

class  XrdAccSciTokens
 

Functions

bool AuthorizesRequiredIssuers (Access_Operation client_oper, const std::string_view &path, const std::vector< std::pair< std::unique_ptr< SubpathMatch >, std::string >> &required_issuers, const std::vector< std::shared_ptr< XrdAccRules >> &access_rules_list)
 
void InitAccSciTokens (XrdSysLogger *lp, const char *cfn, const char *parm, XrdAccAuthorize *accP, XrdOucEnv *envP)
 
XrdAccAuthorizeXrdAccAuthorizeObjAdd (XrdSysLogger *lp, const char *cfn, const char *parm, XrdOucEnv *envP, XrdAccAuthorize *accP)
 
XrdAccAuthorizeXrdAccAuthorizeObject (XrdSysLogger *lp, const char *cfn, const char *parm)
 
XrdAccAuthorizeXrdAccAuthorizeObject2 (XrdSysLogger *lp, const char *cfn, const char *parm, XrdOucEnv *envP)
 
 XrdVERSIONINFO (XrdAccAuthorizeObjAdd, XrdAccSciTokens)
 
 XrdVERSIONINFO (XrdAccAuthorizeObject, XrdAccSciTokens)
 

Variables

XrdAccSciTokensaccSciTokens = nullptr
 
XrdSciTokensHelperSciTokensHelper = nullptr
 

Function Documentation

◆ AuthorizesRequiredIssuers()

bool AuthorizesRequiredIssuers ( Access_Operation  client_oper,
const std::string_view &  path,
const std::vector< std::pair< std::unique_ptr< SubpathMatch >, std::string >> &  required_issuers,
const std::vector< std::shared_ptr< XrdAccRules >> &  access_rules_list 
)

Definition at line 385 of file XrdSciTokensAccess.cc.

388 {
389 
390  // Translate the client-attempted operation to one of the simpler operations we've defined.
391  Access_Operation oper;
392  switch (client_oper) {
393  case AOP_Any:
394  return false; // Invalid request
395  break;
396  case AOP_Chmod: [[fallthrough]];
397  case AOP_Chown: [[fallthrough]];
398  case AOP_Create: [[fallthrough]];
399  case AOP_Excl_Create: [[fallthrough]];
400  case AOP_Delete: [[fallthrough]];
401  case AOP_Excl_Insert: [[fallthrough]];
402  case AOP_Insert: [[fallthrough]];
403  case AOP_Lock:
404  oper = AOP_Create;
405  break;
406  case AOP_Mkdir:
407  oper = AOP_Mkdir;
408  break;
409  case AOP_Read:
410  oper = AOP_Read;
411  break;
412  case AOP_Readdir:
413  oper = AOP_Readdir;
414  break;
415  case AOP_Rename:
416  oper = AOP_Create;
417  break;
418  case AOP_Stat:
419  oper = AOP_Stat;
420  break;
421  case AOP_Update:
422  oper = AOP_Update;
423  break;
424  default:
425  return false; // Invalid request
426  };
427 
428  // Iterate through all the required issuers
429  for (const auto &info : required_issuers) {
430  // See if this issuer is required for this path/operation.
431  if (info.first->apply(oper, path)) {
432  bool has_authz = false;
433  // If so, see if one of the tokens (a) is from this issuer and (b) authorizes the request.
434  for (const auto &rules : access_rules_list) {
435  if (rules->get_issuer() == info.second && rules->apply(oper, path)) {
436  has_authz = true;
437  break;
438  }
439  }
440  if (!has_authz) {
441  return false;
442  }
443  }
444  }
445  return true;
446 }
Access_Operation
The following are supported operations.
@ AOP_Delete
rm() or rmdir()
@ AOP_Mkdir
mkdir()
@ AOP_Update
open() r/w or append
@ AOP_Create
open() with create
@ AOP_Readdir
opendir()
@ AOP_Chmod
chmod()
@ AOP_Any
Special for getting privs.
@ AOP_Stat
exists(), stat()
@ AOP_Rename
mv() for source
@ AOP_Read
open() r/o, prepare()
@ AOP_Excl_Create
open() with O_EXCL|O_CREAT
@ AOP_Insert
mv() for target
@ AOP_Lock
n/a
@ AOP_Chown
chown()
@ AOP_Excl_Insert
mv() where destination doesn't exist.

References AOP_Any, AOP_Chmod, AOP_Chown, AOP_Create, AOP_Delete, AOP_Excl_Create, AOP_Excl_Insert, AOP_Insert, AOP_Lock, AOP_Mkdir, AOP_Read, AOP_Readdir, AOP_Rename, AOP_Stat, and AOP_Update.

Referenced by XrdAccSciTokens::Access().

+ Here is the caller graph for this function:

◆ InitAccSciTokens()

void InitAccSciTokens ( XrdSysLogger lp,
const char *  cfn,
const char *  parm,
XrdAccAuthorize accP,
XrdOucEnv envP 
)

Definition at line 1487 of file XrdSciTokensAccess.cc.

1489 {
1490  try {
1491  accSciTokens = new XrdAccSciTokens(lp, parm, accP, envP);
1493  } catch (std::exception &) {
1494  }
1495 }
XrdAccSciTokens * accSciTokens
XrdSciTokensHelper * SciTokensHelper
XrdOucEnv * envP
Definition: XrdPss.cc:109

References accSciTokens, XrdProxy::envP, and SciTokensHelper.

Referenced by XrdAccAuthorizeObjAdd(), XrdAccAuthorizeObject(), and XrdAccAuthorizeObject2().

+ Here is the caller graph for this function:

◆ XrdAccAuthorizeObjAdd()

XrdAccAuthorize* XrdAccAuthorizeObjAdd ( XrdSysLogger lp,
const char *  cfn,
const char *  parm,
XrdOucEnv envP,
XrdAccAuthorize accP 
)

Definition at line 1499 of file XrdSciTokensAccess.cc.

1504 {
1505  // Record the parent authorization plugin. There is no need to use
1506  // unique_ptr as all of this happens once in the main and only thread.
1507  //
1508 
1509  // If we have been initialized by a previous load, them return that result.
1510  // Otherwise, it's the first time through, get a new SciTokens authorizer.
1511  //
1512  if (!accSciTokens) InitAccSciTokens(lp, cfn, parm, accP, envP);
1513  return accSciTokens;
1514 }
void InitAccSciTokens(XrdSysLogger *lp, const char *cfn, const char *parm, XrdAccAuthorize *accP, XrdOucEnv *envP)

References accSciTokens, XrdProxy::envP, and InitAccSciTokens().

+ Here is the call graph for this function:

◆ XrdAccAuthorizeObject()

XrdAccAuthorize* XrdAccAuthorizeObject ( XrdSysLogger lp,
const char *  cfn,
const char *  parm 
)

Definition at line 1516 of file XrdSciTokensAccess.cc.

1519 {
1520  InitAccSciTokens(lp, cfn, parm, nullptr, nullptr);
1521  return accSciTokens;
1522 }

References accSciTokens, and InitAccSciTokens().

+ Here is the call graph for this function:

◆ XrdAccAuthorizeObject2()

XrdAccAuthorize* XrdAccAuthorizeObject2 ( XrdSysLogger lp,
const char *  cfn,
const char *  parm,
XrdOucEnv envP 
)

Definition at line 1524 of file XrdSciTokensAccess.cc.

1528 {
1529  InitAccSciTokens(lp, cfn, parm, nullptr, envP);
1530  return accSciTokens;
1531 }

References accSciTokens, XrdProxy::envP, and InitAccSciTokens().

+ Here is the call graph for this function:

◆ XrdVERSIONINFO() [1/2]

XrdVERSIONINFO ( XrdAccAuthorizeObjAdd  ,
XrdAccSciTokens   
)

◆ XrdVERSIONINFO() [2/2]

XrdVERSIONINFO ( XrdAccAuthorizeObject  ,
XrdAccSciTokens   
)

Variable Documentation

◆ accSciTokens

◆ SciTokensHelper

XrdSciTokensHelper* SciTokensHelper = nullptr

Definition at line 39 of file XrdSciTokensAccess.cc.

Referenced by InitAccSciTokens().