XrdOucUtils.cc File Reference

#include <cctype>
#include <grp.h>
#include <cstdio>
#include <list>
#include <vector>
#include <unordered_set>
#include <algorithm>
#include <regex.h>
#include <fcntl.h>
#include <math.h>
#include <pwd.h>
#include <sys/stat.h>
#include <sys/types.h>
#include <map>
#include "XrdNet/XrdNetUtils.hh"
#include "XrdOuc/XrdOucCRC.hh"
#include "XrdOuc/XrdOucEnv.hh"
#include "XrdOuc/XrdOucSHA3.hh"
#include "XrdOuc/XrdOucStream.hh"
#include "XrdOuc/XrdOucString.hh"
#include "XrdOuc/XrdOucUtils.hh"
#include "XrdOuc/XrdOucPrivateUtils.hh"
#include "XrdSys/XrdSysE2T.hh"
#include "XrdSys/XrdSysError.hh"
#include "XrdSys/XrdSysPlatform.hh"
#include "XrdSys/XrdSysPthread.hh"

Include dependency graph for XrdOucUtils.cc:

Go to the source code of this file.

Macros
#define	ENODATA   ENOATTR
#define	SHFT(k)   if (n >= (1ULL << k)) { i += k; n >>= k; }
#define	SHFT(k, m)   if (n >= m) { i += k; n /= m; }

Functions
static bool	is_token_character (int c)
std::string	obfuscateAuth (const std::string &input)

Macro Definition Documentation

ENODATA

#define ENODATA   ENOATTR

Definition at line 66 of file XrdOucUtils.cc.

SHFT [1/2]

#define SHFT

(

k

)

if (n >= (1ULL << k)) { i += k; n >>= k; }

SHFT [2/2]

#define SHFT	(		k,
			m
	)		if (n >= m) { i += k; n /= m; }

Function Documentation

is_token_character()

static bool is_token_character ( int  c )

static

Returns a boolean indicating whether 'c' is a valid token character or not. See https://datatracker.ietf.org/doc/html/rfc6750#section-2.1 for details.

Definition at line 1512 of file XrdOucUtils.cc.

{
  if (isalnum(c))
    return true;
 
  static constexpr char token_chars[] = "-._~+/=:%";
 
  for (char ch : token_chars)
    if (c == ch)
      return true;
 
  return false;
}

Referenced by obfuscateAuth().

Here is the caller graph for this function:

obfuscateAuth()

std::string obfuscateAuth

(

const std::string &

input

)

This function obfuscates away authz= cgi elements and/or HTTP authorization headers from URL or other log line strings which might contain them.

Parameters

input

the string to obfuscate

Returns

the string with token values obfuscated

Definition at line 1534 of file XrdOucUtils.cc.

{
  static const regex_t auth_regex = []() {
    constexpr char re[] =
      "(authz=|(transferheader)?(www-|proxy-)?auth(orization|enticate)[[:space:]]*:[[:space:]]*)"
      "(Bearer([[:space:]]|%20)?(token([[:space:]]|%20)?)?)?";
 
    regex_t regex;
 
    if (regcomp(&regex, re, REG_EXTENDED | REG_ICASE) != 0)
      throw std::runtime_error("Failed to compile regular expression");
 
    return regex;
  }();
 
  regmatch_t match;
  size_t offset = 0;
  std::string redacted;
  const char *const text = input.c_str();
 
  while (regexec(&auth_regex, text + offset, 1, &match, 0) == 0) {
    redacted.append(text + offset, match.rm_eo).append("REDACTED");
 
    offset += match.rm_eo;
 
    while (offset < input.size() && is_token_character(input[offset]))
      ++offset;
  }
 
  return redacted.append(text + offset);
}

References is_token_character().

Referenced by XrdPfc::Cache::Attach(), XrdPosixXrootd::Close(), XrdPosixFile::DelayedDestroy(), XrdPosixPrepIO::Disable(), XrdCl::URL::FromString(), XrdPssCks::Get(), XrdCl::URL::GetObfuscatedURL(), XrdCl::Utils::LogPropertyList(), main(), XrdPssSys::Mkdir(), XrdPssFile::Open(), XrdPssDir::Opendir(), XrdHttpProtocol::Process(), XrdHttpReq::ProcessHTTPReq(), XrdHttpReq::Redir(), XrdPssSys::Remdir(), XrdPssSys::Rename(), XrdCl::Message::SetDescription(), XrdPssSys::Stat(), XrdPssSys::Truncate(), and XrdPssSys::Unlink().

Here is the call graph for this function:

Here is the caller graph for this function: