XrdTls.hh

Go to the documentation of this file.

#ifndef __XRDTLS_H__
#define __XRDTLS_H__
/******************************************************************************/
/*                                                                            */
/*                             X r d T l s . 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 <string>
 
class XrdSysLogger;
 
class XrdTls
{
public:
 
enum RC {TLS_AOK = 0,          
         TLS_CON_Closed,       
         TLS_CRT_Missing,      
         TLS_CTX_Missing,      
         TLS_HNV_Error,        
         TLS_SSL_Error,        
         TLS_SYS_Error,        
         TLS_UNK_Error,        
         TLS_VER_Error,        
         TLS_WantAccept,       
         TLS_WantConnect,      
         TLS_WantRead,         
         TLS_WantWrite         
        };
 
//------------------------------------------------------------------------
//------------------------------------------------------------------------
 
static void Emsg(const char *tid, const char *msg=0, bool flush=true);
 
//------------------------------------------------------------------------
//------------------------------------------------------------------------
 
static std::string RC2Text(XrdTls::RC rc, bool dbg=false);
 
//------------------------------------------------------------------------
//------------------------------------------------------------------------
 
typedef void (*msgCB_t)(const char *tid, const char *msg, bool sslmsg);
 
static void     SetMsgCB(msgCB_t cbP);
 
//------------------------------------------------------------------------
//------------------------------------------------------------------------
 
static const int dbgOFF = 0; 
static const int dbgCTX = 1; 
static const int dbgSOK = 2; 
static const int dbgSIO = 4; 
static const int dbgALL = 7; 
static const int dbgOUT = 8; 
 
static void SetDebug(int opts, XrdSysLogger *logP=0);
 
static void SetDebug(int opts, msgCB_t logP);
 
//------------------------------------------------------------------------
//------------------------------------------------------------------------
 
static RC ssl2RC(int sslrc);
 
//------------------------------------------------------------------------
//------------------------------------------------------------------------
 
static const char *ssl2Text(int sslrc, const char *dflt="unknown_error");
 
//------------------------------------------------------------------------
//------------------------------------------------------------------------
 
static void ClearErrorQueue();
};
#endif