XRootD
Loading...
Searching...
No Matches
XrdOucUtils.hh
Go to the documentation of this file.
1#ifndef __XRDOUCUTILS_HH__
2#define __XRDOUCUTILS_HH__
3/******************************************************************************/
4/* */
5/* X r d O u c U t i l s . h h */
6/* */
7/* (c) 2005 by the Board of Trustees of the Leland Stanford, Jr., University */
8/* All Rights Reserved */
9/* Produced by Andrew Hanushevsky for Stanford University under contract */
10/* DE-AC02-76-SFO0515 with the Department of Energy */
11/* */
12/* This file is part of the XRootD software suite. */
13/* */
14/* XRootD is free software: you can redistribute it and/or modify it under */
15/* the terms of the GNU Lesser General Public License as published by the */
16/* Free Software Foundation, either version 3 of the License, or (at your */
17/* option) any later version. */
18/* */
19/* XRootD is distributed in the hope that it will be useful, but WITHOUT */
20/* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or */
21/* FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public */
22/* License for more details. */
23/* */
24/* You should have received a copy of the GNU Lesser General Public License */
25/* along with XRootD in a file called COPYING.LESSER (LGPL license) and file */
26/* COPYING (GPL license). If not, see <http://www.gnu.org/licenses/>. */
27/* */
28/* The copyright holder's institutional names and contributor's names may not */
29/* be used to endorse or promote products derived from this software without */
30/* specific prior written permission of the institution or contributor. */
31/******************************************************************************/
32
33#include <sys/types.h>
34#include <sys/stat.h>
35#include <string>
36#include <unordered_set>
37
38class XrdSysError;
39class XrdOucString;
40class XrdOucStream;
41
43{
44public:
45
46static inline std::string OBFUSCATION_STR = "REDACTED";
47
48static const mode_t pathMode = S_IRWXU|S_IRGRP|S_IXGRP|S_IROTH|S_IXOTH;
49
50static int argList(char *args, char **argV, int argC);
51
52static char *bin2hex(char *inbuff, int dlen, char *buff, int blen, bool sep=true);
53
54static bool endsWith(const char *text, const char *ending, int endlen);
55
56static char *eText(int rc, char *eBuff, int eBlen);
57
58static int doIf(XrdSysError *eDest, XrdOucStream &Config,
59 const char *what, const char *hname,
60 const char *nname, const char *pname);
61
62static bool findPgm(const char *pgm, XrdOucString& path);
63
64static int fmtBytes(long long val, char *buff, int bsz);
65
66static char *genPath(const char *path, const char *inst, const char *psfx=0);
67
68static int genPath(char *buff, int blen, const char *path, const char *psfx=0);
69
70static char *getFile(const char *path, int &rc, int maxsz=10240,
71 bool notempty=true);
72
73static bool getGID(const char *gName, gid_t &gID);
74
75static bool getUID(const char *uName, uid_t &uID, gid_t *gID=0);
76
77static int GidName(gid_t gID, char *gName, int gNsz, time_t keepT=0);
78
79static int GroupName(gid_t gID, char *gName, int gNsz);
80
81static const char *i2bstr(char *buff, int blen, int val, bool pad=false);
82
83static char *Ident(long long &mySID, char *iBuff, int iBlen,
84 const char *iHost, const char *iProg, const char *iName,
85 int Port);
86
87static const char *InstName(int TranOpt=0);
88
89static const char *InstName(const char *name, int Fillit=1);
90
91static int is1of(char *val, const char **clist);
92
93static int isFWD(const char *path, int *port=0, char *hBuff=0, int hBLen=0,
94 bool pTrim=false);
95
96static int Log2(unsigned long long n);
97
98static int Log10(unsigned long long n);
99
100static void makeHome(XrdSysError &eDest, const char *inst);
101
102static bool makeHome(XrdSysError &eDest, const char *inst,
103 const char *path, mode_t mode);
104
105static int makePath(char *path, mode_t mode, bool reset=false);
106
107static bool mode2mask(const char *mode, mode_t &mask);
108
109static bool parseLib(XrdSysError &eDest, XrdOucStream &Config,
110 const char *libName, char *&path, char **libparm);
111
112static char *parseHome(XrdSysError &eDest, XrdOucStream &Config, int &mode);
113
114static int ReLink(const char *path, const char *target, mode_t mode=0);
115
116static void Sanitize(char *instr, char subc='_');
117
118static char *subLogfn(XrdSysError &eDest, const char *inst, char *logfn);
119
120static void toLower(char *str);
121
122static int Token(const char **str, char delim, char *buff, int bsz);
123
124static void Undercover(XrdSysError &eDest, int noLog, int *pipeFD = 0);
125
126static int UidName(uid_t uID, char *uName, int uNsz, time_t keepT=0);
127
128static int UserName(uid_t uID, char *uName, int uNsz);
129
130static
131const char *ValPath(const char *path, mode_t allow, bool isdir);
132
133static bool PidFile(XrdSysError &eDest, const char *path);
134
135static int getModificationTime(const char * path, time_t & modificationTime);
136
137static void trim(std::string & str);
138
139static std::string obfuscate(const std::string & input, const std::unordered_set<std::string> & keysToObfuscate,const char keyValueDelimiter, const char listDelimiter);
140
143};
144#endif
static XrdSysError eDest(0,"crypto_")
static char * parseHome(XrdSysError &eDest, XrdOucStream &Config, int &mode)
static void Sanitize(char *instr, char subc='_')
static bool getGID(const char *gName, gid_t &gID)
static const mode_t pathMode
static int isFWD(const char *path, int *port=0, char *hBuff=0, int hBLen=0, bool pTrim=false)
static int UserName(uid_t uID, char *uName, int uNsz)
static char * Ident(long long &mySID, char *iBuff, int iBlen, const char *iHost, const char *iProg, const char *iName, int Port)
static bool getUID(const char *uName, uid_t &uID, gid_t *gID=0)
static int getModificationTime(const char *path, time_t &modificationTime)
static const char * ValPath(const char *path, mode_t allow, bool isdir)
static char * genPath(const char *path, const char *inst, const char *psfx=0)
static int Token(const char **str, char delim, char *buff, int bsz)
static std::string OBFUSCATION_STR
static int ReLink(const char *path, const char *target, mode_t mode=0)
static bool parseLib(XrdSysError &eDest, XrdOucStream &Config, const char *libName, char *&path, char **libparm)
static int is1of(char *val, const char **clist)
static std::string obfuscate(const std::string &input, const std::unordered_set< std::string > &keysToObfuscate, const char keyValueDelimiter, const char listDelimiter)
static const char * InstName(int TranOpt=0)
static char * eText(int rc, char *eBuff, int eBlen)
static int argList(char *args, char **argV, int argC)
static bool mode2mask(const char *mode, mode_t &mask)
static int GidName(gid_t gID, char *gName, int gNsz, time_t keepT=0)
static int UidName(uid_t uID, char *uName, int uNsz, time_t keepT=0)
static char * bin2hex(char *inbuff, int dlen, char *buff, int blen, bool sep=true)
static int Log10(unsigned long long n)
static int doIf(XrdSysError *eDest, XrdOucStream &Config, const char *what, const char *hname, const char *nname, const char *pname)
static int makePath(char *path, mode_t mode, bool reset=false)
static int GroupName(gid_t gID, char *gName, int gNsz)
static void trim(std::string &str)
static bool findPgm(const char *pgm, XrdOucString &path)
static bool PidFile(XrdSysError &eDest, const char *path)
static const char * i2bstr(char *buff, int blen, int val, bool pad=false)
static void toLower(char *str)
static int fmtBytes(long long val, char *buff, int bsz)
static int Log2(unsigned long long n)
static void makeHome(XrdSysError &eDest, const char *inst)
static bool endsWith(const char *text, const char *ending, int endlen)
static void Undercover(XrdSysError &eDest, int noLog, int *pipeFD=0)
static char * getFile(const char *path, int &rc, int maxsz=10240, bool notempty=true)
static char * subLogfn(XrdSysError &eDest, const char *inst, char *logfn)