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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244 | // Copyright (C) 2021-2024 Internet Systems Consortium, Inc. ("ISC")
//
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.
// Do not include this header directly: use crypto_tls.h instead.
#ifndef OPENSSL_TLS_H
#define OPENSSL_TLS_H
/// @file openssl_tls.h OpenSSL implementation of the TLS API.
#ifdef WITH_OPENSSL
#include <asiolink/asio_wrapper.h>
#include <asiolink/io_asio_socket.h>
#include <asiolink/io_service.h>
#include <asiolink/common_tls.h>
#include <boost/asio/ssl.hpp><--- Include file: not found. Please note: Cppcheck does not need standard library headers to get proper results.
namespace isc {
namespace asiolink {
/// @brief Translate TLS role into implementation.
inline boost::asio::ssl::stream_base::handshake_type roleToImpl(TlsRole role) {
if (role == TlsRole::SERVER) {
return (boost::asio::ssl::stream_base::server);
} else {
return (boost::asio::ssl::stream_base::client);
}
}
/// @brief OpenSSL TLS context.
class TlsContext : public TlsContextBase {
public:
/// @brief Destructor.
virtual ~TlsContext() { }
/// @brief Create a fresh context.
///
/// @param role The TLS role client or server.
explicit TlsContext(TlsRole role);
/// @brief Return a reference to the underlying context.
boost::asio::ssl::context& getContext();
/// @brief Return the pointer to the SSL_CTX object.
///
/// Currently used only for tests. Please note that since OpenSSL 1.1
/// The SSL_CTX type is not fully publicly defined.
::SSL_CTX* getNativeContext();
/// @brief Get the peer certificate requirement mode.
///
/// @return True if peer certificates are required, false if they
/// are optional.
virtual bool getCertRequired() const;<--- Function in derived class
/// @brief Get the error message.
///
/// @note Wrapper against OpenSSL 3.x not returning error messages
/// from system errors.
///
/// @param ec The Boost error code.
/// @return The error message.
static std::string getErrMsg(boost::system::error_code ec);
protected:
/// @brief Set the peer certificate requirement mode.
///
/// @param cert_required True if peer certificates are required,
/// false if they are optional.
virtual void setCertRequired(bool cert_required);<--- Function in derived class<--- setCertRequired is a virtual function
/// @brief Load the trust anchor aka certification authority.
///
/// @param ca_file The certificate file name.
virtual void loadCaFile(const std::string& ca_file);<--- Function in derived class
/// @brief Load the trust anchor aka certification authority.
///
/// @param ca_path The certificate directory name.
virtual void loadCaPath(const std::string& ca_path);<--- Function in derived class
/// @brief Load the certificate file.
///
/// @param cert_file The certificate file name.
virtual void loadCertFile(const std::string& cert_file);<--- Function in derived class
/// @brief Load the private key from a file.
///
/// @param key_file The private key file name.
virtual void loadKeyFile(const std::string& key_file);<--- Function in derived class
/// @brief Cached cert_required value.
bool cert_required_;
/// @brief Boost ASIO SSL object.
boost::asio::ssl::context context_;
/// @brief Allow access to protected methods by the base class.
friend class TlsContextBase;
};
/// @brief The type of underlying TLS streams.
typedef boost::asio::ssl::stream<boost::asio::ip::tcp::socket> TlsStreamImpl;
/// @brief TlsStreamBase constructor.
///
/// @tparam Callback The type of callbacks.
/// @tparam TlsStreamImpl The type of underlying TLS streams.
/// @param service I/O Service object used to manage the stream.
/// @param context Pointer to the TLS context.
/// @note The caller must not provide a null pointer to the TLS context.
template <typename Callback, typename TlsStreamImpl>
TlsStreamBase<Callback, TlsStreamImpl>::
TlsStreamBase(const IOServicePtr& io_service, TlsContextPtr context)
: StreamService(io_service, context),
TlsStreamImpl(io_service->getInternalIOService(),
context->getContext()), role_(context->getRole()) {
}
/// @brief OpenSSL TLS stream.
///
/// @tparam callback The callback.
template <typename Callback>
class TlsStream : public TlsStreamBase<Callback, TlsStreamImpl> {
public:
/// @brief Type of the base.
typedef TlsStreamBase<Callback, TlsStreamImpl> Base;
/// @brief Constructor.
///
/// @param service I/O Service object used to manage the stream.
/// @param context Pointer to the TLS context.
/// @note The caller must not provide a null pointer to the TLS context.
TlsStream(const IOServicePtr& service, TlsContextPtr context)
: Base(service, context) {
}
/// @brief Destructor.
virtual ~TlsStream() {
}
/// @brief TLS Handshake.
///
/// @param callback Callback object.
virtual void handshake(Callback& callback) {<--- Function in derived class
Base::async_handshake(roleToImpl(Base::getRole()), callback);
}
/// @brief TLS shutdown.
///
/// @param callback Callback object.
virtual void shutdown(Callback& callback) {<--- Function in derived class
Base::async_shutdown(callback);
}
/// @brief Return the commonName part of the subjectName of
/// the peer certificate.
///
/// First commonName when there are more than one, in UTF-8.
/// RFC 3280 provides as a commonName example "Susan Housley",
/// to idea to give access to this come from the Role Based
/// Access Control experiment.
///
///
/// @return The commonName part of the subjectName or the empty string.
virtual std::string getSubject() {<--- Function in derived class
::X509* cert = ::SSL_get_peer_certificate(this->native_handle());
if (!cert) {
return ("");
}
::X509_NAME *name = ::X509_get_subject_name(cert);
int loc = ::X509_NAME_get_index_by_NID(name, NID_commonName, -1);
::X509_NAME_ENTRY* ne = ::X509_NAME_get_entry(name, loc);
if (!ne) {
::X509_free(cert);
return ("");
}
unsigned char* buf = 0;
int len = ::ASN1_STRING_to_UTF8(&buf, ::X509_NAME_ENTRY_get_data(ne));
if (len < 0) {
::X509_free(cert);
return ("");
}
std::string ret(reinterpret_cast<char*>(buf), static_cast<size_t>(len));
::OPENSSL_free(buf);
::X509_free(cert);
return (ret);
}
/// @brief Return the commonName part of the issuerName of
/// the peer certificate.
///
/// First commonName when there are more than one, in UTF-8.
/// The issuerName is the subjectName of the signing certificate
/// (the issue in PKIX terms). The idea is to encode a group as
/// members of an intermediate certification authority.
///
///
/// @return The commonName part of the issuerName or the empty string.
virtual std::string getIssuer() {<--- Function in derived class
::X509* cert = ::SSL_get_peer_certificate(this->native_handle());
if (!cert) {
return ("");
}
::X509_NAME *name = ::X509_get_issuer_name(cert);
int loc = ::X509_NAME_get_index_by_NID(name, NID_commonName, -1);
::X509_NAME_ENTRY* ne = ::X509_NAME_get_entry(name, loc);
if (!ne) {
::X509_free(cert);
return ("");
}
unsigned char* buf = 0;
int len = ::ASN1_STRING_to_UTF8(&buf, ::X509_NAME_ENTRY_get_data(ne));
if (len < 0) {
::X509_free(cert);
return ("");
}
std::string ret(reinterpret_cast<char*>(buf), static_cast<size_t>(len));
::OPENSSL_free(buf);
::X509_free(cert);
return (ret);
}
};
// Stream truncated error code.
#ifdef HAVE_STREAM_TRUNCATED_ERROR
const int STREAM_TRUNCATED = boost::asio::ssl::error::stream_truncated;
#else
const int STREAM_TRUNCATED = ERR_PACK(ERR_LIB_SSL, 0, SSL_R_SHORT_READ);
#endif
} // namespace asiolink
} // namespace isc
#endif // WITH_OPENSSL
#endif // OPENSSL_TLS_H
|