XrdSecProtector.hh

Go to the documentation of this file.

#ifndef __XRDSECPROTECTOR_H__
#define __XRDSECPROTECTOR_H__
/******************************************************************************/
/*                                                                            */
/*                    X r d S e c P r o t e c t o r . h h                     */
/*                                                                            */
/* (c) 2016 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 "XProtocol/XPtypes.hh"
  
/******************************************************************************/
/*                    X r d S e c P r o t e c t P a r m s                     */
/******************************************************************************/
 
class XrdSecProtectParms
{
public:
 
enum    secLevel {secNone = 0,
                  secCompatible, secStandard, secIntense, secPedantic,
                  secFence
                 };
 
secLevel   level;   
int        opts;    
 
static const int   doData = 0x0000001; 
static const int   relax  = 0x0000002; 
static const int   force  = 0x0000004; 
 
            XrdSecProtectParms() : level(secNone), opts(0) {}
           ~XrdSecProtectParms() {}
};
  
/******************************************************************************/
/*                       X r d S e c P r o t e c t o r                        */
/******************************************************************************/
  
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
struct ServerResponseReqs_Protocol;
class  XrdNetAddrInfo;
class  XrdSecProtect;
class  XrdSecProtocol;
class  XrdSysLogger;
 
class XrdSecProtector
{
public:
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
virtual bool         Config(const XrdSecProtectParms &lclParms,
                            const XrdSecProtectParms &rmtParms,
                            XrdSysLogger &logr);
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
virtual const char  *LName(XrdSecProtectParms::secLevel level);
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
virtual XrdSecProtect *New4Client(      XrdSecProtocol              &aprot,
                                  const ServerResponseReqs_Protocol &inReqs,
                                        unsigned int                 reqLen);
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
virtual XrdSecProtect *New4Server(XrdSecProtocol &aprot, int plvl);
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
virtual int            ProtResp(ServerResponseReqs_Protocol &resp,
                                XrdNetAddrInfo &nai, int pver);
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
virtual ~XrdSecProtector() {}
 
enum lrType     {isLcl=0, isRmt=1, isLR=2};
 
protected:
 
                XrdSecProtector() {}
 
private:
void  Config(const XrdSecProtectParms    &parms,
             ServerResponseReqs_Protocol &reqs);
};
#endif