xrootd
XrdClTls.hh
Go to the documentation of this file.
1 //------------------------------------------------------------------------------
2 // Copyright (c) 2011-2012 by European Organization for Nuclear Research (CERN)
3 // Author: Michal Simon <simonm@cern.ch>
4 //------------------------------------------------------------------------------
5 // XRootD is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU Lesser General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // XRootD is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU Lesser General Public License
16 // along with XRootD. If not, see <http://www.gnu.org/licenses/>.
17 //------------------------------------------------------------------------------
18 
19 #ifndef __XRD_CL_TLS_HH__
20 #define __XRD_CL_TLS_HH__
21 
22 #include <memory>
23 
24 #include "XrdTls/XrdTlsSocket.hh"
25 
28 
29 namespace XrdCl
30 {
31  class Socket;
32 
33  //----------------------------------------------------------------------------
35  //----------------------------------------------------------------------------
36  class Tls
37  {
38  public:
39 
40  //------------------------------------------------------------------------
42  //------------------------------------------------------------------------
43  Tls( Socket *socket, AsyncSocketHandler *socketHandler );
44 
45  //------------------------------------------------------------------------
47  //------------------------------------------------------------------------
48  ~Tls()
49  {
50  }
51 
52  //------------------------------------------------------------------------
54  //------------------------------------------------------------------------
55  XRootDStatus Connect( const std::string &thehost, XrdNetAddrInfo *netInfo );
56 
57  //------------------------------------------------------------------------
60  //------------------------------------------------------------------------
61  XRootDStatus Read( char *buffer, size_t size, int &bytesRead );
62 
63  //------------------------------------------------------------------------
66  //------------------------------------------------------------------------
67  XRootDStatus Send( const char *buffer, size_t size, int &bytesWritten );
68 
69  //------------------------------------------------------------------------
71  //------------------------------------------------------------------------
72  void Shutdown();
73 
74  //------------------------------------------------------------------------
80  //------------------------------------------------------------------------
81  uint8_t MapEvent( uint8_t event );
82 
83  //------------------------------------------------------------------------
85  //------------------------------------------------------------------------
86  static void ClearErrorQueue();
87 
88  private:
89 
90  //------------------------------------------------------------------------
98  //------------------------------------------------------------------------
100 
101  //------------------------------------------------------------------------
103  //------------------------------------------------------------------------
105 
106  //------------------------------------------------------------------------
108  //------------------------------------------------------------------------
110 
111  //------------------------------------------------------------------------
113  //------------------------------------------------------------------------
114  std::unique_ptr<XrdTlsSocket> pTls;
115 
116  //------------------------------------------------------------------------
117  // In case during TLS hand-shake WantRead has been returned on write or
118  // WantWrite has been returned on read we need to flip the following events.
119  //
120  // None : all events should be processed normally
121  // ReadOnWrite : on write event the OnRead routines should be called
122  // WriteOnRead : on read event the OnWrite routines should be called
123  //------------------------------------------------------------------------
125 
126  //------------------------------------------------------------------------
128  //------------------------------------------------------------------------
130  };
131 }
132 
133 #endif // __XRD_CL_TLS_HH__
134 
Definition: XrdClTls.hh:99
AsyncSocketHandler * pSocketHandler
Socket handler (for enabling/disabling write notification)
Definition: XrdClTls.hh:129
TlsHSRevert
Definition: XrdClTls.hh:99
TlsHSRevert pTlsHSRevert
Definition: XrdClTls.hh:124
XRootDStatus Connect(const std::string &thehost, XrdNetAddrInfo *netInfo)
Establish a TLS/SSL session and perform host verification.
~Tls()
Destructor.
Definition: XrdClTls.hh:48
TLS layer for socket connection.
Definition: XrdClTls.hh:36
Tls(Socket *socket, AsyncSocketHandler *socketHandler)
Constructor - creates async TLS layer for given socker file descriptor.
RC
Definition: XrdTls.hh:40
Definition: XrdClTls.hh:99
Request status.
Definition: XrdClXRootDResponses.hh:218
Definition: XrdClAnyObject.hh:25
static void ClearErrorQueue()
Clear the error queue for the calling thread.
XRootDStatus Send(const char *buffer, size_t size, int &bytesWritten)
XRootDStatus ToStatus(XrdTls::RC rc)
Translate OPEN SSL error code into XRootD Status.
Definition: XrdNetAddrInfo.hh:53
Socket * pSocket
The underlying vanilla socket.
Definition: XrdClTls.hh:109
Definition: XrdClTls.hh:99
void Shutdown()
Shutdown the TLS/SSL connection.
std::unique_ptr< XrdTlsSocket > pTls
The TSL I/O wrapper over socket.
Definition: XrdClTls.hh:114
XRootDStatus Read(char *buffer, size_t size, int &bytesRead)
A network socket.
Definition: XrdClSocket.hh:41
Definition: XrdClAsyncSocketHandler.hh:39
uint8_t MapEvent(uint8_t event)