XrdTlsContext.hh

Go to the documentation of this file.

#ifndef __XRD_TLSCONTEXT_HH__
#define __XRD_TLSCONTEXT_HH__
//------------------------------------------------------------------------------
// Copyright (c) 2011-2018 by European Organization for Nuclear Research (CERN)
// Author: Michal Simon <simonm@cern.ch>
//------------------------------------------------------------------------------
// 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 General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with XRootD.  If not, see <http://www.gnu.org/licenses/>.
//------------------------------------------------------------------------------
 
#include <cstdint>
#include <string>
  
//----------------------------------------------------------------------------
// Forward declarations
//----------------------------------------------------------------------------
 
class  XrdSysLogger;
struct XrdTlsContextImpl;
struct XrdTlsSocket;
 
/******************************************************************************/
/*                         X r d T l s C o n t e x t                          */
/******************************************************************************/
 
class XrdTlsContext
{
public:
 
//------------------------------------------------------------------------
//------------------------------------------------------------------------
 
XrdTlsContext *Clone(bool full=true, bool startCRLRefresh = false);
 
//------------------------------------------------------------------------
//------------------------------------------------------------------------
 
void          *Context();
 
static const int DEFAULT_CRL_REF_INT_SEC = 8 * 60 * 60;
 
//------------------------------------------------------------------------
//------------------------------------------------------------------------
 
struct CTX_Params
      {std::string cert;   
       std::string pkey;   
       std::string cadir;  
       std::string cafile; 
       uint64_t    opts;   
       int         crlRT;  
       int         rsvd;
 
       CTX_Params() : opts(0), crlRT(DEFAULT_CRL_REF_INT_SEC), rsvd(0) {}
      ~CTX_Params() {}
      };
 
const
CTX_Params     *GetParams();
 
//------------------------------------------------------------------------
//------------------------------------------------------------------------
static
const char     *Init();
 
//------------------------------------------------------------------------
//------------------------------------------------------------------------
 
bool            isOK();
 
//------------------------------------------------------------------------
//------------------------------------------------------------------------
 
void           *Session();
 
//------------------------------------------------------------------------
//------------------------------------------------------------------------
 
static const int scNone = 0x00000000; 
static const int scOff  = 0x00010000; 
static const int scSrvr = 0x00020000; 
static const int scClnt = 0x00040000; 
static const int scKeep = 0x40000000; 
static const int scIdErr= 0x80000000; 
static const int scFMax = 0x00007fff; 
 
      int       SessionCache(int opts=scNone, const char *id=0, int idlen=0);
 
//------------------------------------------------------------------------
//------------------------------------------------------------------------
 
bool            SetContextCiphers(const char *ciphers);
 
//------------------------------------------------------------------------
//------------------------------------------------------------------------
static
void            SetDefaultCiphers(const char *ciphers);
 
//------------------------------------------------------------------------
//------------------------------------------------------------------------
 
      bool      SetCrlRefresh(int refsec=-1);
 
//------------------------------------------------------------------------
//------------------------------------------------------------------------
 
       bool     x509Verify();
 
       bool newHostCertificateDetected();
 
//------------------------------------------------------------------------
//------------------------------------------------------------------------
 
static const uint64_t hsto  = 0x00000000000000ff; 
static const uint64_t vdept = 0x000000000000ff00; 
static const int      vdepS = 8;                  
static const uint64_t logVF = 0x0000000800000000; 
static const uint64_t servr = 0x0000000400000000; 
static const uint64_t dnsok = 0x0000000200000000; 
static const uint64_t nopxy = 0x0000000100000000; 
static const uint64_t rfCRL = 0x0000004000000000; 
static const uint64_t crlON = 0x0000008000000000; 
static const uint64_t crlFC = 0x000000C000000000; 
static const uint64_t crlRF = 0x00000000ffff0000; 
static const int      crlRS = 16;                 
static const uint64_t artON = 0x0000002000000000; 
 
       XrdTlsContext(const char *cert=0,  const char *key=0,
                     const char *cadir=0, const char *cafile=0,
                     uint64_t opts=0, std::string *eMsg=0);
 
//------------------------------------------------------------------------
//------------------------------------------------------------------------
 
      ~XrdTlsContext();
 
//------------------------------------------------------------------------
//------------------------------------------------------------------------
 
      XrdTlsContext( const XrdTlsContext  &ctx ) = delete;
      XrdTlsContext(       XrdTlsContext &&ctx ) = delete;
 
      XrdTlsContext& operator=( const XrdTlsContext  &ctx ) = delete;
      XrdTlsContext& operator=(       XrdTlsContext &&ctx ) = delete;
 
private:
   XrdTlsContextImpl *pImpl;
};
 
/******************************************************************************/
/*            O p t i o n   M a n i p u l a t i o n   M a c r o s             */
/******************************************************************************/
  
//------------------------------------------------------------------------
//------------------------------------------------------------------------
 
#define TLS_SET_HSTO(cOpts,hstv) \
        ((cOpts & ~XrdTlsContext::hsto) | (hstv & XrdTlsContext::hsto))
  
//------------------------------------------------------------------------
//------------------------------------------------------------------------
 
#define TLS_SET_REFINT(cOpts,refi) ((cOpts & ~XrdTlsContext::crlRF) |\
        (XrdTlsContext::crlRF & (refi <<XrdTlsContext::crlRS)))
 
//------------------------------------------------------------------------
//------------------------------------------------------------------------
 
#define TLS_SET_VDEPTH(cOpts,vdv) ((cOpts & ~XrdTlsContext::vdept) |\
        (XrdTlsContext::vdept & (vdv <<XrdTlsContext::vdepS)))
 
#endif // __XRD_TLSCONTEXT_HH__