XrdSecsssKT Class Reference

#include <XrdSecsssKT.hh>

Collaboration diagram for XrdSecsssKT:

Classes
class	ktEnt

Public Types
enum	xMode {   isAdmin = 0 ,   isClient ,   isServer }

Public Member Functions
	XrdSecsssKT (XrdOucErrInfo *, const char *, xMode, int refr=60 *60)
	~XrdSecsssKT ()
void	addKey (ktEnt &ktNew)
int	delKey (ktEnt &ktDel)
int	getKey (ktEnt &ktEql, bool andKeyID=false)
ktEnt *	keyList ()
void	Refresh ()
time_t	RefrTime ()
int	Rewrite (int Keep, int &numKeys, int &numTot, int &numExp)
int	Same (const char *path)
void	setPath (const char *Path)

Static Public Member Functions
static char *	genFN ()
static void	genKey (char *Buff, int blen)

Detailed Description

Definition at line 40 of file XrdSecsssKT.hh.

Member Enumeration Documentation

xMode

enum XrdSecsssKT::xMode

Enumerator
isAdmin
isClient
isServer

Definition at line 114 of file XrdSecsssKT.hh.

{isAdmin = 0, isClient, isServer};

Constructor & Destructor Documentation

XrdSecsssKT()

XrdSecsssKT::XrdSecsssKT	(	XrdOucErrInfo *	eInfo,
		const char *	kPath,
		xMode	oMode,
		int	refr = 60*60
	)

Definition at line 78 of file XrdSecsssKT.cc.

{
   static const char *eText = "Unable to start keytab refresh thread";
   const char *devRand = "/dev/urandom";
   struct stat sbuf;
   int retc;
 
// Do some common initialization
//
   ktRefID= 0;
   ktPath = (kPath ? strdup(kPath) : 0);
   ktList = 0; kthiID = 0; ktMode = oMode; ktRefT = (time_t)refrInt;
   if (eInfo) eInfo->setErrCode(0);
 
// Prepare /dev/random if we have it
//
   if (stat(devRand, &sbuf)) devRand = "/dev/random";
   if ((randFD = open(devRand, O_RDONLY)) < 0
   && oMode != isClient && errno != ENOENT)
      eMsg("sssKT",errno,"Unable to generate random key"," opening ",devRand);
 
// First get the stat information for the file
//
   if (!kPath)
      {if (oMode != isAdmin)
          {eMsg("sssKT", -1, "Keytable path not specified.");
           if (eInfo) eInfo->setErrInfo(EINVAL, "Keytable path missing.");
           return;
          }
       sbuf.st_mtime = 0; sbuf.st_mode = S_IRWXU;
      } else if (stat(kPath, &sbuf))
                {if (eInfo) eInfo->setErrInfo(errno, "Keytable not found");
                 if (errno != ENOENT || oMode != isAdmin)
                    eMsg("sssKT",errno,"Unable process keytable ",kPath);
                 return;
                }
 
// Now read in the whole key table and start possible refresh thread
//
   if ((ktList = getKeyTab(eInfo, sbuf.st_mtime, sbuf.st_mode))
   && (oMode != isAdmin) && (!eInfo || eInfo->getErrInfo() == 0))
      {if ((retc = XrdSysThread::Run(&ktRefID,XrdSecsssKTRefresh, (void *)this,
                                     XRDSYSTHREAD_HOLD)))
          {eMsg("sssKT", errno, eText); eInfo->setErrInfo(-1, eText);}
      }
}

References eMsg, XrdOucErrInfo::getErrInfo(), isAdmin, isClient, open, XrdSysThread::Run(), XrdOucErrInfo::setErrCode(), XrdOucErrInfo::setErrInfo(), stat, XrdSecsssKTRefresh(), and XRDSYSTHREAD_HOLD.

Here is the call graph for this function:

~XrdSecsssKT()

XrdSecsssKT::~XrdSecsssKT

(

)

Definition at line 130 of file XrdSecsssKT.cc.

{
   ktEnt *ktP;
   void  *Dummy;
 
// Lock against others
//
   myMutex.Lock();
 
// Kill the refresh thread first
//
   if (ktRefID && !XrdSysThread::Kill(ktRefID))
      XrdSysThread::Join(ktRefID, &Dummy);
   ktRefID= 0;
 
// Now we can safely clean up
//
   if (ktPath) {free(ktPath); ktPath = 0;}
 
   while((ktP = ktList)) {ktList = ktList->Next; delete ktP;}
 
   myMutex.UnLock();
}

References XrdSysThread::Join(), XrdSysThread::Kill(), XrdSysMutex::Lock(), XrdSecsssKT::ktEnt::Next, and XrdSysMutex::UnLock().

Here is the call graph for this function:

Member Function Documentation

addKey()

void XrdSecsssKT::addKey

(

ktEnt &

ktNew

)

Definition at line 158 of file XrdSecsssKT.cc.

{
   ktEnt *ktPP = 0, *ktP;
 
// Generate a key for this entry
//
   genKey(ktNew.Data.Val, ktNew.Data.Len);
   ktNew.Data.Crt = time(0);
   ktNew.Data.ID  = static_cast<long long>(ktNew.Data.Crt & 0x7fffffff) << 32L
                  | static_cast<long long>(++kthiID);
 
// Locate place to insert this key
//
   ktP = ktList;
   while(ktP && !isKey(*ktP, &ktNew, 0)) {ktPP = ktP; ktP = ktP->Next;}
 
// Now chain in the entry
//
   if (ktPP) ktPP->Next = &ktNew;
      else   ktList     = &ktNew;
   ktNew.Next = ktP;
}

References XrdSecsssKT::ktEnt::ktData::Crt, XrdSecsssKT::ktEnt::Data, genKey(), XrdSecsssKT::ktEnt::ktData::ID, XrdSecsssKT::ktEnt::ktData::Len, XrdSecsssKT::ktEnt::Next, and XrdSecsssKT::ktEnt::ktData::Val.

Referenced by XrdSecsssAdmin_addKey().

Here is the call graph for this function:

Here is the caller graph for this function:

delKey()

int XrdSecsssKT::delKey

(

ktEnt &

ktDel

)

Definition at line 185 of file XrdSecsssKT.cc.

{
   ktEnt *ktN, *ktPP = 0, *ktP = ktList;
   int nDel = 0;
 
// Remove all matching keys
//
   while(ktP)
        {if (isKey(ktDel, ktP))
            {if (ktPP) ktPP->Next = ktP->Next;
                else   ktList     = ktP->Next;
             ktN = ktP; ktP = ktP->Next; delete ktN; nDel++;
            } else {ktPP = ktP; ktP = ktP->Next;}
        }
 
   return nDel;
}

References XrdSecsssKT::ktEnt::Next.

Referenced by XrdSecsssAdmin_delKey().

Here is the caller graph for this function:

genFN()

char * XrdSecsssKT::genFN ( )

static

Definition at line 249 of file XrdSecsssKT.cc.

{
   static char fnbuff[1040];
   const char *pfx;
 
// Get the path prefix
//
   if (!(pfx = getenv("HOME")) || !*pfx) pfx = "";
 
// Format the name
//
   snprintf(fnbuff, sizeof(fnbuff), "%s/.xrd/sss.keytab", pfx);
   return fnbuff;
}

Referenced by XrdSecProtocolsss::Load_Client(), XrdSecProtocolsss::Load_Server(), and main().

Here is the caller graph for this function:

genKey()

void XrdSecsssKT::genKey ( char *  Buff, int  blen  )

static

Definition at line 268 of file XrdSecsssKT.cc.

{
   struct timeval tval;
   int kTemp;
 
// See if we can directly service the key. Make sure that we get some entropy
// because some /dev/random devices start out really cold.
//
   if (randFD >= 0) 
      {char *buffP = kBP;
       int i, Got, Want = kLen, zcnt = 0, maxZ = kLen*25/100;
       while(Want)
       do { {do {Got = read(randFD, buffP, Want);}
                while(Got < 0 && errno == EINTR);
             if (Got > 0) {buffP += Got; Want -= Got;}
            }
          } while(Got > 0 && Want);
       if (!Want)
          {for (i = 0; i < kLen; i++) if (!kBP[i]) zcnt++;
           if (zcnt <= maxZ) return;
          }
      }
 
// Generate a seed
//
   gettimeofday(&tval, 0);
   if (tval.tv_usec == 0) tval.tv_usec = tval.tv_sec;
   tval.tv_usec = tval.tv_usec ^ getpid();
   srand48(static_cast<long>(tval.tv_usec));
 
// Now generate the key (we ignore he fact that longs may be 4 or 8 bytes)
//
   while(kLen > 0)
        {kTemp = mrand48();
         memcpy(kBP, &kTemp, (4 > kLen ? kLen : 4));
         kBP += 4; kLen -= 4;
        }
}

References read.

Referenced by addKey().

Here is the caller graph for this function:

getKey()

int XrdSecsssKT::getKey	(	ktEnt &	ktEql,
		bool	andKeyID = false
	)

Definition at line 207 of file XrdSecsssKT.cc.

{
   ktEnt *ktP, *ktN;
 
// Lock the keytab to prevent modification
//
   myMutex.Lock();
   ktP = ktList;
 
// Find first key by key name (used normally by clients), by keyID, or both
//
     if (!*theEnt.Data.Name)
        {if (theEnt.Data.ID >= 0)
            while(ktP && ktP->Data.ID != theEnt.Data.ID)  ktP = ktP->Next;
        }
   else if (andKeyID)
        {while((ktP && ktP->Data.ID != theEnt.Data.ID)
            || strcmp(ktP->Data.Name,theEnt.Data.Name)) ktP=ktP->Next;
        }
   else {while(ktP && strcmp(ktP->Data.Name,theEnt.Data.Name)) ktP=ktP->Next;
         while(ktP && ktP->Data.Exp <= time(0))
              {if (!(ktN=ktP->Next) 
               ||  strcmp(ktN->Data.Name,theEnt.Data.Name)) break;
               ktP = ktN;
              }
        }
 
// If we found a match, export it
//
   if (ktP) theEnt = *ktP;
   myMutex.UnLock();
 
// Indicate if key expired
//
   if (!ktP) return ENOENT;
   return (theEnt.Data.Exp && theEnt.Data.Exp <= time(0) ? -1 : 0);
}

References XrdSecsssKT::ktEnt::Data, XrdSecsssKT::ktEnt::ktData::Exp, XrdSecsssKT::ktEnt::ktData::ID, XrdSysMutex::Lock(), XrdSecsssKT::ktEnt::ktData::Name, XrdSecsssKT::ktEnt::Next, and XrdSysMutex::UnLock().

Referenced by XrdSecProtocolsss::getCredentials().

Here is the call graph for this function:

Here is the caller graph for this function:

keyList()

ktEnt * XrdSecsssKT::keyList ( )

inline

Definition at line 101 of file XrdSecsssKT.hh.

{return ktList;}

Referenced by XrdSecsssAdmin_delKey(), XrdSecsssAdmin_insKey(), and XrdSecsssAdmin_lstKey().

Here is the caller graph for this function:

Refresh()

void XrdSecsssKT::Refresh

(

)

Definition at line 311 of file XrdSecsssKT.cc.

{
   XrdOucErrInfo eInfo;
   ktEnt *ktNew, *ktOld, *ktNext;
   struct stat sbuf;
   int retc = 0;
 
// Get change time of keytable and if changed, update it
//
   if (stat(ktPath, &sbuf) == 0)
      {if (sbuf.st_mtime == ktMtime) return;
       if ((ktNew = getKeyTab(&eInfo, sbuf.st_mtime, sbuf.st_mode))
       && eInfo.getErrInfo() == 0)
          {myMutex.Lock(); ktOld = ktList; ktList = ktNew; myMutex.UnLock();
          } else ktOld = ktNew;
       while(ktOld) {ktNext = ktOld->Next; delete ktOld; ktOld = ktNext;}
       if ((retc == eInfo.getErrInfo()) == 0) return;
      } else retc = errno;
 
// Refresh failed
//
   eMsg("Refresh",retc,"Unable to refresh keytable",ktPath);
}

References eMsg, XrdOucErrInfo::getErrInfo(), XrdSysMutex::Lock(), XrdSecsssKT::ktEnt::Next, stat, and XrdSysMutex::UnLock().

Referenced by XrdSecsssKTRefresh().

Here is the call graph for this function:

Here is the caller graph for this function:

RefrTime()

time_t XrdSecsssKT::RefrTime ( )

inline

Definition at line 105 of file XrdSecsssKT.hh.

{return ktRefT;}

Referenced by XrdSecsssKTRefresh().

Here is the caller graph for this function:

Rewrite()

int XrdSecsssKT::Rewrite	(	int	Keep,
		int &	numKeys,
		int &	numTot,
		int &	numExp
	)

Definition at line 339 of file XrdSecsssKT.cc.

{
   char tmpFN[2048], buff[2048], kbuff[4096], *Slash;
   int ktFD, numID = 0, n, retc = 0;
   ktEnt ktCurr, *ktP, *ktN;
   mode_t theMode = fileMode(ktPath);
 
// Invoke mkpath in case the path is missing
//
   strcpy(tmpFN, ktPath);
   if ((Slash = rindex(tmpFN, '/'))) *Slash = '\0';
   retc = XrdOucUtils::makePath(tmpFN,S_IRWXU|S_IRGRP|S_IXGRP|S_IROTH|S_IXOTH);
   if (retc) return (retc < 0 ? -retc : retc);
   if (Slash) *Slash = '/';
 
// Construct temporary filename
//
   sprintf(buff, ".%d", static_cast<int>(getpid()));
   strcat(tmpFN, buff);
 
// Open the file for output
//
   if ((ktFD = open(tmpFN, O_WRONLY|O_CREAT|O_TRUNC, theMode)) < 0)
      return errno;
 
// Write all of the keytable
//
   ktCurr.Data.Name[0] = ktCurr.Data.User[0] = ktCurr.Data.Grup[0] = 3;
   ktN = ktList; numKeys = numTot = numExp = 0;
   while((ktP = ktN))
        {ktN = ktN->Next; numTot++;
         if (ktP->Data.Name[0] == '\0') continue;
         if (ktP->Data.Exp && ktP->Data.Exp <= time(0)) {numExp++; continue;}
         if (!isKey(ktCurr, ktP, 0)) {ktCurr.NUG(ktP); numID = 0;}
            else if (Keep && numID >= Keep) continue;
         n = sprintf(buff, "%s0 u:%s g:%s n:%s N:%lld c:%lld e:%lld f:%lld k:",
                    (numKeys ? "\n" : ""),
                     ktP->Data.User,ktP->Data.Grup,ktP->Data.Name,ktP->Data.ID,
                     (long long) ktP->Data.Crt, (long long) ktP->Data.Exp,
                     ktP->Data.Flags);
         numID++; numKeys++; keyB2X(ktP, kbuff);
         if (write(ktFD, buff, n) < 0
         ||  write(ktFD, kbuff, ktP->Data.Len*2) < 0) break;
        }
 
// Check for errors
//
   if (ktP) retc = errno;
      else if (!numKeys) retc = ENODATA;
 
// Atomically trounce the original file if we can
//
   close(ktFD);
   if (!retc && rename(tmpFN, ktPath) < 0) retc = errno;
 
// All done
//
   unlink(tmpFN); 
   return retc;
}

References close, XrdSecsssKT::ktEnt::ktData::Crt, XrdSecsssKT::ktEnt::Data, ENODATA, XrdSecsssKT::ktEnt::ktData::Exp, XrdSecsssKT::ktEnt::ktData::Flags, XrdSecsssKT::ktEnt::ktData::Grup, XrdSecsssKT::ktEnt::ktData::ID, XrdSecsssKT::ktEnt::ktData::Len, XrdOucUtils::makePath(), XrdSecsssKT::ktEnt::ktData::Name, XrdSecsssKT::ktEnt::Next, XrdSecsssKT::ktEnt::NUG(), open, rename, unlink, XrdSecsssKT::ktEnt::ktData::User, and write.

Referenced by XrdSecsssAdmin_addKey(), XrdSecsssAdmin_delKey(), and XrdSecsssAdmin_insKey().

Here is the call graph for this function:

Here is the caller graph for this function:

Same()

int XrdSecsssKT::Same ( const char *  path )

inline

Definition at line 109 of file XrdSecsssKT.hh.

{return (ktPath && !strcmp(ktPath, path));}

Referenced by XrdSecProtocolsss::Init_Client().

Here is the caller graph for this function:

setPath()

void XrdSecsssKT::setPath ( const char *  Path )

inline

Definition at line 111 of file XrdSecsssKT.hh.

              {if (ktPath) free(ktPath); ktPath = strdup(Path);}

References Path.

Referenced by XrdSecsssAdmin_insKey().

Here is the caller graph for this function:

---

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

• XrdSecsssKT.hh
• XrdSecsssKT.cc