1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
|
/* <!-- copyright */
/*
* aria2 - The high speed download utility
*
* Copyright (C) 2013 Tatsuhiro Tsujikawa
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program 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 General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*
* In addition, as a special exception, the copyright holders give
* permission to link the code of portions of this program with the
* OpenSSL library under certain conditions as described in each
* individual source file, and distribute linked combinations
* including the two.
* You must obey the GNU General Public License in all respects
* for all of the code used other than OpenSSL. If you modify
* file(s) with this exception, you may extend this exception to your
* version of the file(s), but you are not obligated to do so. If you
* do not wish to do so, delete this exception statement from your
* version. If you delete this exception statement from all source
* files in the program, then also delete it here.
*/
/* copyright --> */
#ifndef TLS_SESSION_H
#define TLS_SESSION_H
#include "common.h"
#include "a2netcompat.h"
#include "TLSContext.h"
namespace aria2 {
enum TLSDirection { TLS_WANT_READ = 1, TLS_WANT_WRITE };
enum TLSErrorCode {
TLS_ERR_OK = 0,
TLS_ERR_ERROR = -1,
TLS_ERR_WOULDBLOCK = -2
};
// To create another SSL/TLS backend, implement TLSSession class below.
//
class TLSSession {
public:
static TLSSession* make(TLSContext* ctx);
// MUST deallocate all resources
virtual ~TLSSession() = default;
// Initializes SSL/TLS session. The |sockfd| is the underlying
// transport socket. This function returns TLS_ERR_OK if it
// succeeds, or TLS_ERR_ERROR.
virtual int init(sock_t sockfd) = 0;
// Sets |hostname| for TLS SNI extension. This is only meaningful for
// client side session. This function returns TLS_ERR_OK if it
// succeeds, or TLS_ERR_ERROR.
virtual int setSNIHostname(const std::string& hostname) = 0;
// Closes the SSL/TLS session. Don't close underlying transport
// socket. This function returns TLS_ERR_OK if it succeeds, or
// TLS_ERR_ERROR.
virtual int closeConnection() = 0;
// Returns TLS_WANT_READ if SSL/TLS session needs more data from
// remote endpoint to proceed, or TLS_WANT_WRITE if SSL/TLS session
// needs to write more data to proceed. If SSL/TLS session needs
// neither read nor write data at the moment, TLS_WANT_READ must be
// returned.
virtual int checkDirection() = 0;
// Sends |data| with length |len|. This function returns the number
// of bytes sent if it succeeds, or TLS_ERR_WOULDBLOCK if the
// underlying transport blocks, or TLS_ERR_ERROR.
virtual ssize_t writeData(const void* data, size_t len) = 0;
// Receives data into |data| with length |len|. This function returns
// the number of bytes received if it succeeds, or TLS_ERR_WOULDBLOCK
// if the underlying transport blocks, or TLS_ERR_ERROR.
virtual ssize_t readData(void* data, size_t len) = 0;
// Performs client side handshake. The |hostname| is the hostname of
// the remote endpoint and is used to verify its certificate. This
// function returns TLS_ERR_OK if it succeeds, or TLS_ERR_WOULDBLOCK
// if the underlying transport blocks, or TLS_ERR_ERROR.
// When returning TLS_ERR_ERROR, provide certificate validation error
// in |handshakeErr|.
virtual int tlsConnect(const std::string& hostname, TLSVersion& version,
std::string& handshakeErr) = 0;
// Performs server side handshake. This function returns TLS_ERR_OK
// if it succeeds, or TLS_ERR_WOULDBLOCK if the underlying transport
// blocks, or TLS_ERR_ERROR.
virtual int tlsAccept(TLSVersion& version) = 0;
// Returns last error string
virtual std::string getLastErrorString() = 0;
// Returns buffered length, which can be read immediately without
// contacting network.
virtual size_t getRecvBufferedLength() = 0;
protected:
TLSSession() = default;
private:
TLSSession(const TLSSession&);
TLSSession& operator=(const TLSSession&);
};
} // namespace aria2
#endif // TLS_SESSION_H
|
