XrdTlsSocket.hh

Go to the documentation of this file.

#ifndef __XRD_TLS_SOCKET_HH__
#define __XRD_TLS_SOCKET_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 <string>
 
#include "XrdTls/XrdTls.hh"
 
//----------------------------------------------------------------------------
// Forward declarations
//----------------------------------------------------------------------------
 
class  XrdNetAddrInfo;
class  XrdSysError;
class  XrdTlsContext;
class  XrdTlsPeerCerts;
struct XrdTlsSocketImpl;
 
//----------------------------------------------------------------------------
//----------------------------------------------------------------------------
 
class XrdTlsSocket
{
public:
 
enum RW_Mode
{
  TLS_RNB_WNB,   
  TLS_RNB_WBL,   
  TLS_RBL_WNB,   
  TLS_RBL_WBL    
};
 
enum HS_Mode
{
  TLS_HS_BLOCK = true,  
  TLS_HS_NOBLK = false, 
};
 
//------------------------------------------------------------------------
//------------------------------------------------------------------------
 
  XrdTlsSocket( XrdTlsContext &ctx, int sfd, RW_Mode rwm, HS_Mode hsm,
                bool isClient, bool serial=true );
 
//------------------------------------------------------------------------
//------------------------------------------------------------------------
 
  XrdTlsSocket();
 
//------------------------------------------------------------------------
//------------------------------------------------------------------------
 
  ~XrdTlsSocket();
 
//------------------------------------------------------------------------
//------------------------------------------------------------------------
 
  XrdTls::RC Accept(std::string *eMsg=0);
 
//------------------------------------------------------------------------
//------------------------------------------------------------------------
 
  XrdTls::RC Connect(const char *thehost=0, std::string *eWhy=0);
 
//------------------------------------------------------------------------
//------------------------------------------------------------------------
 
  XrdTlsContext *Context();
 
//------------------------------------------------------------------------
//------------------------------------------------------------------------
 
XrdTlsPeerCerts *getCerts(bool ver=true);
 
//------------------------------------------------------------------------
//------------------------------------------------------------------------
 
  const char *Init( XrdTlsContext &ctx, int sfd, RW_Mode rwm, HS_Mode hsm,
                    bool isClient, bool serial=true, const char *tid="" );
 
//------------------------------------------------------------------------
//------------------------------------------------------------------------
 
  XrdTls::RC Peek( char *buffer, size_t size, int &bytesPeek );
 
//------------------------------------------------------------------------
//------------------------------------------------------------------------
 
  int Pending(bool any=true);
 
//------------------------------------------------------------------------
//
//------------------------------------------------------------------------
 
  XrdTls::RC Read( char *buffer, size_t size, int &bytesRead );
 
//------------------------------------------------------------------------
//------------------------------------------------------------------------
 
  void       SetTraceID(const char *tid);
 
//------------------------------------------------------------------------
//------------------------------------------------------------------------
 
  enum SDType {sdForce = 1, sdImmed = 2, sdWait = 3};
 
  void Shutdown(SDType=sdImmed);
 
//------------------------------------------------------------------------
//------------------------------------------------------------------------
 
  XrdTls::RC Write( const char *buffer, size_t size, int &bytesOut );
 
//------------------------------------------------------------------------
//------------------------------------------------------------------------
 
  bool NeedHandShake();
 
//------------------------------------------------------------------------
//------------------------------------------------------------------------
 
  const char *Version();
 
private:
 
void AcceptEMsg(std::string *eWhy, const char *reason);
int  Diagnose(const char *what, int sslrc, int tcode);
std::string Err2Text(int sslerr);
bool NeedHS();
bool Wait4OK(bool wantRead);
 
XrdTlsSocketImpl *pImpl;
};
#endif // __XRD_TLS_IO_HH__