XrdSecEntity.hh

Go to the documentation of this file.

#ifndef __SEC_ENTITY_H__
#define __SEC_ENTITY_H__
/******************************************************************************/
/*                                                                            */
/*                       X r d S e c E n t i t y . h h                        */
/*                                                                            */
/* (c) 2019 by the Board of Trustees of the Leland Stanford, Jr., University  */
/*   Produced by Andrew Hanushevsky for Stanford University under contract    */
/*              DE-AC02-76-SFO0515 with the Department of Energy              */
/*                                                                            */
/* This file is part of the XRootD software suite.                            */
/*                                                                            */
/* XRootD is free software: you can redistribute it and/or modify it under    */
/* the terms of the GNU Lesser General Public License as published by the     */
/* Free Software Foundation, either version 3 of the License, or (at your     */
/* option) any later version.                                                 */
/*                                                                            */
/* XRootD is distributed in the hope that it will be useful, but WITHOUT      */
/* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or      */
/* FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public       */
/* License for more details.                                                  */
/*                                                                            */
/* You should have received a copy of the GNU Lesser General Public License   */
/* along with XRootD in a file called COPYING.LESSER (LGPL license) and file  */
/* COPYING (GPL license).  If not, see <http://www.gnu.org/licenses/>.        */
/*                                                                            */
/* The copyright holder's institutional names and contributor's names may not */
/* be used to endorse or promote products derived from this software without  */
/* specific prior written permission of the institution or contributor.       */
/******************************************************************************/
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
#include <sys/types.h>
 
#define XrdSecPROTOIDSIZE 8
 
class XrdNetAddrInfo;
class XrdSecEntityAttr;
class XrdSecMonitor;
class XrdSysError;
  
/******************************************************************************/
/*                          X r d S e c E n t i t y                           */
/******************************************************************************/
 
// The XrdSecEntity describes the client associated with a connection. One
// such object is allocated for each clent connection and it persists until
// the connection is closed. Note that when an entity has more than one
// role or vorg, the fields <vorg, role, grps> form a columnar tuple. This
// tuple must be repeated whenever any one of the values differs.
//
class XrdSecEntity
{
public:
         char    prot[XrdSecPROTOIDSIZE]; 
         char    prox[XrdSecPROTOIDSIZE]; 
         char   *name;                    
         char   *host;                    
         char   *vorg;                    
         char   *role;                    
         char   *grps;                    
         char   *caps;                    
         char   *endorsements;            
         char   *moninfo;                 
         char   *creds;                   
         int     credslen;                
unsigned int     ueid;                    
XrdNetAddrInfo  *addrInfo;                
const    char   *tident;                  
const    char   *pident;                  
         void   *sessvar;                 
         uid_t   uid;                     
         gid_t   gid;                     
 
XrdSecMonitor   *secMon;                  
         void   *future[2];               
 
XrdSecEntityAttr *eaAPI;                  
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
         void    Display(XrdSysError &mDest);
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
         void    Reset(const char *spV=0);
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
         XrdSecEntity(const char *spName=0);
 
        ~XrdSecEntity();
 
private:
void     Init(const char *spV);
};
 
#define XrdSecClientName XrdSecEntity
#define XrdSecServerName XrdSecEntity
 
#endif