]>
Commit | Line | Data |
---|---|---|
9467fe62 | 1 | /* |
e731d71b | 2 | * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014 Nicira, Inc. |
9467fe62 BP |
3 | * |
4 | * Licensed under the Apache License, Version 2.0 (the "License"); | |
5 | * you may not use this file except in compliance with the License. | |
6 | * You may obtain a copy of the License at: | |
7 | * | |
8 | * http://www.apache.org/licenses/LICENSE-2.0 | |
9 | * | |
10 | * Unless required by applicable law or agreed to in writing, software | |
11 | * distributed under the License is distributed on an "AS IS" BASIS, | |
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |
13 | * See the License for the specific language governing permissions and | |
14 | * limitations under the License. | |
15 | */ | |
16 | ||
17 | #include <config.h> | |
18 | #include "stream-ssl.h" | |
19 | #include "dhparams.h" | |
9467fe62 BP |
20 | #include <ctype.h> |
21 | #include <errno.h> | |
22 | #include <inttypes.h> | |
23 | #include <string.h> | |
bd6b7545 GC |
24 | #include <sys/types.h> |
25 | #include <sys/socket.h> | |
9467fe62 BP |
26 | #include <netinet/tcp.h> |
27 | #include <openssl/err.h> | |
47ebcf25 | 28 | #include <openssl/rand.h> |
9467fe62 BP |
29 | #include <openssl/ssl.h> |
30 | #include <openssl/x509v3.h> | |
31 | #include <poll.h> | |
5ea1366b | 32 | #include <fcntl.h> |
9467fe62 BP |
33 | #include <sys/stat.h> |
34 | #include <unistd.h> | |
f2f7be86 | 35 | #include "coverage.h" |
9467fe62 | 36 | #include "dynamic-string.h" |
47ebcf25 | 37 | #include "entropy.h" |
9467fe62 BP |
38 | #include "ofpbuf.h" |
39 | #include "openflow/openflow.h" | |
40 | #include "packets.h" | |
41 | #include "poll-loop.h" | |
f2f7be86 | 42 | #include "shash.h" |
9467fe62 | 43 | #include "socket-util.h" |
9467fe62 BP |
44 | #include "util.h" |
45 | #include "stream-provider.h" | |
46 | #include "stream.h" | |
415f6c0b | 47 | #include "timeval.h" |
9467fe62 | 48 | #include "vlog.h" |
5136ce49 | 49 | |
5ea1366b GS |
50 | #ifdef _WIN32 |
51 | /* Ref: https://www.openssl.org/support/faq.html#PROG2 | |
52 | * Your application must link against the same version of the Win32 C-Runtime | |
53 | * against which your openssl libraries were linked. The default version for | |
54 | * OpenSSL is /MD - "Multithreaded DLL". If we compile Open vSwitch with | |
55 | * something other than /MD, instead of re-compiling OpenSSL | |
56 | * toolkit, openssl/applink.c can be #included. Also, it is important | |
57 | * to add CRYPTO_malloc_init prior first call to OpenSSL. | |
58 | * | |
59 | * XXX: The behavior of the following #include when Open vSwitch is | |
60 | * compiled with /MD is not tested. */ | |
61 | #include <openssl/applink.c> | |
62 | #define SHUT_RDWR SD_BOTH | |
5ea1366b GS |
63 | #endif |
64 | ||
d98e6007 | 65 | VLOG_DEFINE_THIS_MODULE(stream_ssl); |
9467fe62 BP |
66 | |
67 | /* Active SSL. */ | |
68 | ||
69 | enum ssl_state { | |
70 | STATE_TCP_CONNECTING, | |
71 | STATE_SSL_CONNECTING | |
72 | }; | |
73 | ||
74 | enum session_type { | |
75 | CLIENT, | |
76 | SERVER | |
77 | }; | |
78 | ||
79 | struct ssl_stream | |
80 | { | |
81 | struct stream stream; | |
82 | enum ssl_state state; | |
9467fe62 BP |
83 | enum session_type type; |
84 | int fd; | |
85 | SSL *ssl; | |
86 | struct ofpbuf *txbuf; | |
ff1760f1 | 87 | unsigned int session_nr; |
9467fe62 BP |
88 | |
89 | /* rx_want and tx_want record the result of the last call to SSL_read() | |
90 | * and SSL_write(), respectively: | |
91 | * | |
92 | * - If the call reported that data needed to be read from the file | |
93 | * descriptor, the corresponding member is set to SSL_READING. | |
94 | * | |
95 | * - If the call reported that data needed to be written to the file | |
96 | * descriptor, the corresponding member is set to SSL_WRITING. | |
97 | * | |
98 | * - Otherwise, the member is set to SSL_NOTHING, indicating that the | |
99 | * call completed successfully (or with an error) and that there is no | |
100 | * need to block. | |
101 | * | |
102 | * These are needed because there is no way to ask OpenSSL what a data read | |
103 | * or write would require without giving it a buffer to receive into or | |
104 | * data to send, respectively. (Note that the SSL_want() status is | |
105 | * overwritten by each SSL_read() or SSL_write() call, so we can't rely on | |
106 | * its value.) | |
107 | * | |
108 | * A single call to SSL_read() or SSL_write() can perform both reading | |
109 | * and writing and thus invalidate not one of these values but actually | |
110 | * both. Consider this situation, for example: | |
111 | * | |
112 | * - SSL_write() blocks on a read, so tx_want gets SSL_READING. | |
113 | * | |
114 | * - SSL_read() laters succeeds reading from 'fd' and clears out the | |
115 | * whole receive buffer, so rx_want gets SSL_READING. | |
116 | * | |
117 | * - Client calls stream_wait(STREAM_RECV) and stream_wait(STREAM_SEND) | |
118 | * and blocks. | |
119 | * | |
120 | * - Now we're stuck blocking until the peer sends us data, even though | |
121 | * SSL_write() could now succeed, which could easily be a deadlock | |
122 | * condition. | |
123 | * | |
124 | * On the other hand, we can't reset both tx_want and rx_want on every call | |
125 | * to SSL_read() or SSL_write(), because that would produce livelock, | |
126 | * e.g. in this situation: | |
127 | * | |
128 | * - SSL_write() blocks, so tx_want gets SSL_READING or SSL_WRITING. | |
129 | * | |
130 | * - SSL_read() blocks, so rx_want gets SSL_READING or SSL_WRITING, | |
131 | * but tx_want gets reset to SSL_NOTHING. | |
132 | * | |
133 | * - Client calls stream_wait(STREAM_RECV) and stream_wait(STREAM_SEND) | |
134 | * and blocks. | |
135 | * | |
136 | * - Client wakes up immediately since SSL_NOTHING in tx_want indicates | |
137 | * that no blocking is necessary. | |
138 | * | |
139 | * The solution we adopt here is to set tx_want to SSL_NOTHING after | |
140 | * calling SSL_read() only if the SSL state of the connection changed, | |
141 | * which indicates that an SSL-level renegotiation made some progress, and | |
142 | * similarly for rx_want and SSL_write(). This prevents both the | |
143 | * deadlock and livelock situations above. | |
144 | */ | |
145 | int rx_want, tx_want; | |
1e3c0047 | 146 | |
ff1760f1 | 147 | /* A few bytes of header data in case SSL negotiation fails. */ |
1e3c0047 BP |
148 | uint8_t head[2]; |
149 | short int n_head; | |
9467fe62 BP |
150 | }; |
151 | ||
152 | /* SSL context created by ssl_init(). */ | |
153 | static SSL_CTX *ctx; | |
154 | ||
415f6c0b BP |
155 | struct ssl_config_file { |
156 | bool read; /* Whether the file was successfully read. */ | |
157 | char *file_name; /* Configured file name, if any. */ | |
9cb07887 | 158 | struct timespec mtime; /* File mtime as of last time we read it. */ |
415f6c0b BP |
159 | }; |
160 | ||
161 | /* SSL configuration files. */ | |
162 | static struct ssl_config_file private_key; | |
163 | static struct ssl_config_file certificate; | |
164 | static struct ssl_config_file ca_cert; | |
9467fe62 | 165 | |
ba104a1e BP |
166 | /* Ordinarily, the SSL client and server verify each other's certificates using |
167 | * a CA certificate. Setting this to false disables this behavior. (This is a | |
168 | * security risk.) */ | |
169 | static bool verify_peer_cert = true; | |
170 | ||
9467fe62 | 171 | /* Ordinarily, we require a CA certificate for the peer to be locally |
415f6c0b BP |
172 | * available. We can, however, bootstrap the CA certificate from the peer at |
173 | * the beginning of our first connection then use that certificate on all | |
174 | * subsequent connections, saving it to a file for use in future runs also. In | |
175 | * this case, 'bootstrap_ca_cert' is true. */ | |
9467fe62 | 176 | static bool bootstrap_ca_cert; |
9467fe62 | 177 | |
ff1760f1 BP |
178 | /* Session number. Used in debug logging messages to uniquely identify a |
179 | * session. */ | |
180 | static unsigned int next_session_nr; | |
181 | ||
9467fe62 BP |
182 | /* Who knows what can trigger various SSL errors, so let's throttle them down |
183 | * quite a bit. */ | |
184 | static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(10, 25); | |
185 | ||
186 | static int ssl_init(void); | |
187 | static int do_ssl_init(void); | |
188 | static bool ssl_wants_io(int ssl_error); | |
189 | static void ssl_close(struct stream *); | |
190 | static void ssl_clear_txbuf(struct ssl_stream *); | |
246f5b5e | 191 | static void interpret_queued_ssl_error(const char *function); |
9467fe62 BP |
192 | static int interpret_ssl_error(const char *function, int ret, int error, |
193 | int *want); | |
67a4917b | 194 | static DH *tmp_dh_callback(SSL *ssl, int is_export OVS_UNUSED, int keylength); |
9467fe62 | 195 | static void log_ca_cert(const char *file_name, X509 *cert); |
415f6c0b | 196 | static void stream_ssl_set_ca_cert_file__(const char *file_name, |
f1484874 | 197 | bool bootstrap, bool force); |
ff1760f1 BP |
198 | static void ssl_protocol_cb(int write_p, int version, int content_type, |
199 | const void *, size_t, SSL *, void *sslv_); | |
f1484874 | 200 | static bool update_ssl_config(struct ssl_config_file *, const char *file_name); |
5ea1366b | 201 | static int sock_errno(void); |
9467fe62 BP |
202 | |
203 | static short int | |
204 | want_to_poll_events(int want) | |
205 | { | |
206 | switch (want) { | |
207 | case SSL_NOTHING: | |
428b2edd | 208 | OVS_NOT_REACHED(); |
9467fe62 BP |
209 | |
210 | case SSL_READING: | |
211 | return POLLIN; | |
212 | ||
213 | case SSL_WRITING: | |
214 | return POLLOUT; | |
215 | ||
216 | default: | |
428b2edd | 217 | OVS_NOT_REACHED(); |
9467fe62 BP |
218 | } |
219 | } | |
220 | ||
221 | static int | |
222 | new_ssl_stream(const char *name, int fd, enum session_type type, | |
a8d81967 | 223 | enum ssl_state state, struct stream **streamp) |
9467fe62 | 224 | { |
9467fe62 BP |
225 | struct ssl_stream *sslv; |
226 | SSL *ssl = NULL; | |
9467fe62 BP |
227 | int retval; |
228 | ||
229 | /* Check for all the needful configuration. */ | |
230 | retval = 0; | |
415f6c0b | 231 | if (!private_key.read) { |
9467fe62 BP |
232 | VLOG_ERR("Private key must be configured to use SSL"); |
233 | retval = ENOPROTOOPT; | |
234 | } | |
415f6c0b | 235 | if (!certificate.read) { |
9467fe62 BP |
236 | VLOG_ERR("Certificate must be configured to use SSL"); |
237 | retval = ENOPROTOOPT; | |
238 | } | |
ba104a1e | 239 | if (!ca_cert.read && verify_peer_cert && !bootstrap_ca_cert) { |
9467fe62 BP |
240 | VLOG_ERR("CA certificate must be configured to use SSL"); |
241 | retval = ENOPROTOOPT; | |
242 | } | |
b6d729ad | 243 | if (!retval && !SSL_CTX_check_private_key(ctx)) { |
9467fe62 BP |
244 | VLOG_ERR("Private key does not match certificate public key: %s", |
245 | ERR_error_string(ERR_get_error(), NULL)); | |
246 | retval = ENOPROTOOPT; | |
247 | } | |
248 | if (retval) { | |
249 | goto error; | |
250 | } | |
251 | ||
8b768391 LS |
252 | /* Disable Nagle. |
253 | * On windows platforms, this can only be called upon TCP connected. | |
254 | */ | |
255 | if (state == STATE_SSL_CONNECTING) { | |
b7cefbf7 | 256 | setsockopt_tcp_nodelay(fd); |
9467fe62 BP |
257 | } |
258 | ||
259 | /* Create and configure OpenSSL stream. */ | |
260 | ssl = SSL_new(ctx); | |
261 | if (ssl == NULL) { | |
262 | VLOG_ERR("SSL_new: %s", ERR_error_string(ERR_get_error(), NULL)); | |
263 | retval = ENOPROTOOPT; | |
264 | goto error; | |
265 | } | |
266 | if (SSL_set_fd(ssl, fd) == 0) { | |
267 | VLOG_ERR("SSL_set_fd: %s", ERR_error_string(ERR_get_error(), NULL)); | |
268 | retval = ENOPROTOOPT; | |
269 | goto error; | |
270 | } | |
ba104a1e | 271 | if (!verify_peer_cert || (bootstrap_ca_cert && type == CLIENT)) { |
9467fe62 BP |
272 | SSL_set_verify(ssl, SSL_VERIFY_NONE, NULL); |
273 | } | |
274 | ||
275 | /* Create and return the ssl_stream. */ | |
276 | sslv = xmalloc(sizeof *sslv); | |
277 | stream_init(&sslv->stream, &ssl_stream_class, EAGAIN, name); | |
9467fe62 BP |
278 | sslv->state = state; |
279 | sslv->type = type; | |
280 | sslv->fd = fd; | |
281 | sslv->ssl = ssl; | |
282 | sslv->txbuf = NULL; | |
283 | sslv->rx_want = sslv->tx_want = SSL_NOTHING; | |
ff1760f1 | 284 | sslv->session_nr = next_session_nr++; |
1e3c0047 | 285 | sslv->n_head = 0; |
ff1760f1 BP |
286 | |
287 | if (VLOG_IS_DBG_ENABLED()) { | |
288 | SSL_set_msg_callback(ssl, ssl_protocol_cb); | |
289 | SSL_set_msg_callback_arg(ssl, sslv); | |
290 | } | |
291 | ||
9467fe62 BP |
292 | *streamp = &sslv->stream; |
293 | return 0; | |
294 | ||
295 | error: | |
296 | if (ssl) { | |
297 | SSL_free(ssl); | |
298 | } | |
5ea1366b | 299 | closesocket(fd); |
9467fe62 BP |
300 | return retval; |
301 | } | |
302 | ||
303 | static struct ssl_stream * | |
304 | ssl_stream_cast(struct stream *stream) | |
305 | { | |
306 | stream_assert_class(stream, &ssl_stream_class); | |
307 | return CONTAINER_OF(stream, struct ssl_stream, stream); | |
308 | } | |
309 | ||
310 | static int | |
f125905c | 311 | ssl_open(const char *name, char *suffix, struct stream **streamp, uint8_t dscp) |
9467fe62 | 312 | { |
9467fe62 BP |
313 | int error, fd; |
314 | ||
315 | error = ssl_init(); | |
316 | if (error) { | |
317 | return error; | |
318 | } | |
319 | ||
a8d81967 | 320 | error = inet_open_active(SOCK_STREAM, suffix, OFP_OLD_PORT, NULL, &fd, |
f125905c | 321 | dscp); |
9467fe62 BP |
322 | if (fd >= 0) { |
323 | int state = error ? STATE_TCP_CONNECTING : STATE_SSL_CONNECTING; | |
a8d81967 | 324 | return new_ssl_stream(name, fd, CLIENT, state, streamp); |
9467fe62 | 325 | } else { |
10a89ef0 | 326 | VLOG_ERR("%s: connect: %s", name, ovs_strerror(error)); |
9467fe62 BP |
327 | return error; |
328 | } | |
329 | } | |
330 | ||
331 | static int | |
332 | do_ca_cert_bootstrap(struct stream *stream) | |
333 | { | |
334 | struct ssl_stream *sslv = ssl_stream_cast(stream); | |
335 | STACK_OF(X509) *chain; | |
415f6c0b | 336 | X509 *cert; |
9467fe62 BP |
337 | FILE *file; |
338 | int error; | |
339 | int fd; | |
340 | ||
341 | chain = SSL_get_peer_cert_chain(sslv->ssl); | |
342 | if (!chain || !sk_X509_num(chain)) { | |
343 | VLOG_ERR("could not bootstrap CA cert: no certificate presented by " | |
344 | "peer"); | |
345 | return EPROTO; | |
346 | } | |
415f6c0b | 347 | cert = sk_X509_value(chain, sk_X509_num(chain) - 1); |
9467fe62 | 348 | |
415f6c0b | 349 | /* Check that 'cert' is self-signed. Otherwise it is not a CA |
9467fe62 | 350 | * certificate and we should not attempt to use it as one. */ |
415f6c0b | 351 | error = X509_check_issued(cert, cert); |
9467fe62 BP |
352 | if (error) { |
353 | VLOG_ERR("could not bootstrap CA cert: obtained certificate is " | |
354 | "not self-signed (%s)", | |
355 | X509_verify_cert_error_string(error)); | |
356 | if (sk_X509_num(chain) < 2) { | |
357 | VLOG_ERR("only one certificate was received, so probably the peer " | |
358 | "is not configured to send its CA certificate"); | |
359 | } | |
360 | return EPROTO; | |
361 | } | |
362 | ||
415f6c0b | 363 | fd = open(ca_cert.file_name, O_CREAT | O_EXCL | O_WRONLY, 0444); |
9467fe62 | 364 | if (fd < 0) { |
deb1f433 | 365 | if (errno == EEXIST) { |
f1484874 BP |
366 | VLOG_INFO_RL(&rl, "reading CA cert %s created by another process", |
367 | ca_cert.file_name); | |
368 | stream_ssl_set_ca_cert_file__(ca_cert.file_name, true, true); | |
deb1f433 BP |
369 | return EPROTO; |
370 | } else { | |
371 | VLOG_ERR("could not bootstrap CA cert: creating %s failed: %s", | |
10a89ef0 | 372 | ca_cert.file_name, ovs_strerror(errno)); |
deb1f433 BP |
373 | return errno; |
374 | } | |
9467fe62 BP |
375 | } |
376 | ||
377 | file = fdopen(fd, "w"); | |
378 | if (!file) { | |
2a022368 | 379 | error = errno; |
9467fe62 | 380 | VLOG_ERR("could not bootstrap CA cert: fdopen failed: %s", |
10a89ef0 | 381 | ovs_strerror(error)); |
415f6c0b | 382 | unlink(ca_cert.file_name); |
9467fe62 BP |
383 | return error; |
384 | } | |
385 | ||
415f6c0b | 386 | if (!PEM_write_X509(file, cert)) { |
9467fe62 | 387 | VLOG_ERR("could not bootstrap CA cert: PEM_write_X509 to %s failed: " |
415f6c0b BP |
388 | "%s", ca_cert.file_name, |
389 | ERR_error_string(ERR_get_error(), NULL)); | |
9467fe62 | 390 | fclose(file); |
415f6c0b | 391 | unlink(ca_cert.file_name); |
9467fe62 BP |
392 | return EIO; |
393 | } | |
394 | ||
395 | if (fclose(file)) { | |
2a022368 | 396 | error = errno; |
9467fe62 | 397 | VLOG_ERR("could not bootstrap CA cert: writing %s failed: %s", |
10a89ef0 | 398 | ca_cert.file_name, ovs_strerror(error)); |
415f6c0b | 399 | unlink(ca_cert.file_name); |
9467fe62 BP |
400 | return error; |
401 | } | |
402 | ||
415f6c0b BP |
403 | VLOG_INFO("successfully bootstrapped CA cert to %s", ca_cert.file_name); |
404 | log_ca_cert(ca_cert.file_name, cert); | |
9467fe62 | 405 | bootstrap_ca_cert = false; |
415f6c0b | 406 | ca_cert.read = true; |
9467fe62 | 407 | |
415f6c0b BP |
408 | /* SSL_CTX_add_client_CA makes a copy of cert's relevant data. */ |
409 | SSL_CTX_add_client_CA(ctx, cert); | |
9467fe62 BP |
410 | |
411 | /* SSL_CTX_use_certificate() takes ownership of the certificate passed in. | |
415f6c0b BP |
412 | * 'cert' is owned by sslv->ssl, so we need to duplicate it. */ |
413 | cert = X509_dup(cert); | |
414 | if (!cert) { | |
9467fe62 BP |
415 | out_of_memory(); |
416 | } | |
e6a8ca62 | 417 | SSL_CTX_set_cert_store(ctx, X509_STORE_new()); |
415f6c0b | 418 | if (SSL_CTX_load_verify_locations(ctx, ca_cert.file_name, NULL) != 1) { |
9467fe62 BP |
419 | VLOG_ERR("SSL_CTX_load_verify_locations: %s", |
420 | ERR_error_string(ERR_get_error(), NULL)); | |
421 | return EPROTO; | |
422 | } | |
423 | VLOG_INFO("killing successful connection to retry using CA cert"); | |
424 | return EPROTO; | |
425 | } | |
426 | ||
427 | static int | |
428 | ssl_connect(struct stream *stream) | |
429 | { | |
430 | struct ssl_stream *sslv = ssl_stream_cast(stream); | |
431 | int retval; | |
432 | ||
433 | switch (sslv->state) { | |
434 | case STATE_TCP_CONNECTING: | |
435 | retval = check_connection_completion(sslv->fd); | |
436 | if (retval) { | |
437 | return retval; | |
438 | } | |
439 | sslv->state = STATE_SSL_CONNECTING; | |
b7cefbf7 | 440 | setsockopt_tcp_nodelay(sslv->fd); |
9467fe62 BP |
441 | /* Fall through. */ |
442 | ||
443 | case STATE_SSL_CONNECTING: | |
1e3c0047 | 444 | /* Capture the first few bytes of received data so that we can guess |
ec9f40dc | 445 | * what kind of funny data we've been sent if SSL negotiation fails. */ |
1e3c0047 BP |
446 | if (sslv->n_head <= 0) { |
447 | sslv->n_head = recv(sslv->fd, sslv->head, sizeof sslv->head, | |
448 | MSG_PEEK); | |
449 | } | |
450 | ||
9467fe62 BP |
451 | retval = (sslv->type == CLIENT |
452 | ? SSL_connect(sslv->ssl) : SSL_accept(sslv->ssl)); | |
453 | if (retval != 1) { | |
454 | int error = SSL_get_error(sslv->ssl, retval); | |
455 | if (retval < 0 && ssl_wants_io(error)) { | |
456 | return EAGAIN; | |
457 | } else { | |
458 | int unused; | |
f2f7be86 | 459 | |
9467fe62 BP |
460 | interpret_ssl_error((sslv->type == CLIENT ? "SSL_connect" |
461 | : "SSL_accept"), retval, error, &unused); | |
462 | shutdown(sslv->fd, SHUT_RDWR); | |
1e3c0047 BP |
463 | stream_report_content(sslv->head, sslv->n_head, STREAM_SSL, |
464 | THIS_MODULE, stream_get_name(stream)); | |
9467fe62 BP |
465 | return EPROTO; |
466 | } | |
467 | } else if (bootstrap_ca_cert) { | |
468 | return do_ca_cert_bootstrap(stream); | |
ba104a1e BP |
469 | } else if (verify_peer_cert |
470 | && ((SSL_get_verify_mode(sslv->ssl) | |
471 | & (SSL_VERIFY_NONE | SSL_VERIFY_PEER)) | |
472 | != SSL_VERIFY_PEER)) { | |
9467fe62 BP |
473 | /* Two or more SSL connections completed at the same time while we |
474 | * were in bootstrap mode. Only one of these can finish the | |
475 | * bootstrap successfully. The other one(s) must be rejected | |
476 | * because they were not verified against the bootstrapped CA | |
477 | * certificate. (Alternatively we could verify them against the CA | |
478 | * certificate, but that's more trouble than it's worth. These | |
479 | * connections will succeed the next time they retry, assuming that | |
480 | * they have a certificate against the correct CA.) */ | |
1ee62357 | 481 | VLOG_INFO("rejecting SSL connection during bootstrap race window"); |
9467fe62 BP |
482 | return EPROTO; |
483 | } else { | |
484 | return 0; | |
485 | } | |
486 | } | |
487 | ||
428b2edd | 488 | OVS_NOT_REACHED(); |
9467fe62 BP |
489 | } |
490 | ||
491 | static void | |
492 | ssl_close(struct stream *stream) | |
493 | { | |
494 | struct ssl_stream *sslv = ssl_stream_cast(stream); | |
495 | ssl_clear_txbuf(sslv); | |
5e4641a1 BP |
496 | |
497 | /* Attempt clean shutdown of the SSL connection. This will work most of | |
498 | * the time, as long as the kernel send buffer has some free space and the | |
499 | * SSL connection isn't renegotiating, etc. That has to be good enough, | |
500 | * since we don't have any way to continue the close operation in the | |
501 | * background. */ | |
502 | SSL_shutdown(sslv->ssl); | |
503 | ||
3d47699c BP |
504 | /* SSL_shutdown() might have signaled an error, in which case we need to |
505 | * flush it out of the OpenSSL error queue or the next OpenSSL operation | |
506 | * will falsely signal an error. */ | |
507 | ERR_clear_error(); | |
508 | ||
9467fe62 | 509 | SSL_free(sslv->ssl); |
5ea1366b | 510 | closesocket(sslv->fd); |
9467fe62 BP |
511 | free(sslv); |
512 | } | |
513 | ||
246f5b5e BP |
514 | static void |
515 | interpret_queued_ssl_error(const char *function) | |
516 | { | |
517 | int queued_error = ERR_get_error(); | |
518 | if (queued_error != 0) { | |
519 | VLOG_WARN_RL(&rl, "%s: %s", | |
520 | function, ERR_error_string(queued_error, NULL)); | |
521 | } else { | |
522 | VLOG_ERR_RL(&rl, "%s: SSL_ERROR_SSL without queued error", function); | |
523 | } | |
524 | } | |
525 | ||
9467fe62 BP |
526 | static int |
527 | interpret_ssl_error(const char *function, int ret, int error, | |
528 | int *want) | |
529 | { | |
530 | *want = SSL_NOTHING; | |
531 | ||
532 | switch (error) { | |
533 | case SSL_ERROR_NONE: | |
534 | VLOG_ERR_RL(&rl, "%s: unexpected SSL_ERROR_NONE", function); | |
535 | break; | |
536 | ||
537 | case SSL_ERROR_ZERO_RETURN: | |
538 | VLOG_ERR_RL(&rl, "%s: unexpected SSL_ERROR_ZERO_RETURN", function); | |
539 | break; | |
540 | ||
541 | case SSL_ERROR_WANT_READ: | |
542 | *want = SSL_READING; | |
543 | return EAGAIN; | |
544 | ||
545 | case SSL_ERROR_WANT_WRITE: | |
546 | *want = SSL_WRITING; | |
547 | return EAGAIN; | |
548 | ||
549 | case SSL_ERROR_WANT_CONNECT: | |
550 | VLOG_ERR_RL(&rl, "%s: unexpected SSL_ERROR_WANT_CONNECT", function); | |
551 | break; | |
552 | ||
553 | case SSL_ERROR_WANT_ACCEPT: | |
554 | VLOG_ERR_RL(&rl, "%s: unexpected SSL_ERROR_WANT_ACCEPT", function); | |
555 | break; | |
556 | ||
557 | case SSL_ERROR_WANT_X509_LOOKUP: | |
558 | VLOG_ERR_RL(&rl, "%s: unexpected SSL_ERROR_WANT_X509_LOOKUP", | |
559 | function); | |
560 | break; | |
561 | ||
562 | case SSL_ERROR_SYSCALL: { | |
563 | int queued_error = ERR_get_error(); | |
564 | if (queued_error == 0) { | |
565 | if (ret < 0) { | |
566 | int status = errno; | |
567 | VLOG_WARN_RL(&rl, "%s: system error (%s)", | |
10a89ef0 | 568 | function, ovs_strerror(status)); |
9467fe62 BP |
569 | return status; |
570 | } else { | |
571 | VLOG_WARN_RL(&rl, "%s: unexpected SSL connection close", | |
572 | function); | |
573 | return EPROTO; | |
574 | } | |
575 | } else { | |
576 | VLOG_WARN_RL(&rl, "%s: %s", | |
577 | function, ERR_error_string(queued_error, NULL)); | |
578 | break; | |
579 | } | |
580 | } | |
581 | ||
246f5b5e BP |
582 | case SSL_ERROR_SSL: |
583 | interpret_queued_ssl_error(function); | |
9467fe62 | 584 | break; |
9467fe62 BP |
585 | |
586 | default: | |
587 | VLOG_ERR_RL(&rl, "%s: bad SSL error code %d", function, error); | |
588 | break; | |
589 | } | |
590 | return EIO; | |
591 | } | |
592 | ||
593 | static ssize_t | |
594 | ssl_recv(struct stream *stream, void *buffer, size_t n) | |
595 | { | |
596 | struct ssl_stream *sslv = ssl_stream_cast(stream); | |
597 | int old_state; | |
598 | ssize_t ret; | |
599 | ||
600 | /* Behavior of zero-byte SSL_read is poorly defined. */ | |
cb22974d | 601 | ovs_assert(n > 0); |
9467fe62 BP |
602 | |
603 | old_state = SSL_get_state(sslv->ssl); | |
604 | ret = SSL_read(sslv->ssl, buffer, n); | |
605 | if (old_state != SSL_get_state(sslv->ssl)) { | |
606 | sslv->tx_want = SSL_NOTHING; | |
607 | } | |
608 | sslv->rx_want = SSL_NOTHING; | |
609 | ||
610 | if (ret > 0) { | |
611 | return ret; | |
612 | } else { | |
613 | int error = SSL_get_error(sslv->ssl, ret); | |
614 | if (error == SSL_ERROR_ZERO_RETURN) { | |
615 | return 0; | |
616 | } else { | |
2b494771 BP |
617 | return -interpret_ssl_error("SSL_read", ret, error, |
618 | &sslv->rx_want); | |
9467fe62 BP |
619 | } |
620 | } | |
621 | } | |
622 | ||
623 | static void | |
624 | ssl_clear_txbuf(struct ssl_stream *sslv) | |
625 | { | |
626 | ofpbuf_delete(sslv->txbuf); | |
627 | sslv->txbuf = NULL; | |
628 | } | |
629 | ||
630 | static int | |
631 | ssl_do_tx(struct stream *stream) | |
632 | { | |
633 | struct ssl_stream *sslv = ssl_stream_cast(stream); | |
634 | ||
635 | for (;;) { | |
636 | int old_state = SSL_get_state(sslv->ssl); | |
1f317cb5 PS |
637 | int ret = SSL_write(sslv->ssl, |
638 | ofpbuf_data(sslv->txbuf), ofpbuf_size(sslv->txbuf)); | |
9467fe62 BP |
639 | if (old_state != SSL_get_state(sslv->ssl)) { |
640 | sslv->rx_want = SSL_NOTHING; | |
641 | } | |
642 | sslv->tx_want = SSL_NOTHING; | |
643 | if (ret > 0) { | |
644 | ofpbuf_pull(sslv->txbuf, ret); | |
1f317cb5 | 645 | if (ofpbuf_size(sslv->txbuf) == 0) { |
9467fe62 BP |
646 | return 0; |
647 | } | |
648 | } else { | |
649 | int ssl_error = SSL_get_error(sslv->ssl, ret); | |
650 | if (ssl_error == SSL_ERROR_ZERO_RETURN) { | |
651 | VLOG_WARN_RL(&rl, "SSL_write: connection closed"); | |
652 | return EPIPE; | |
653 | } else { | |
654 | return interpret_ssl_error("SSL_write", ret, ssl_error, | |
655 | &sslv->tx_want); | |
656 | } | |
657 | } | |
658 | } | |
659 | } | |
660 | ||
661 | static ssize_t | |
662 | ssl_send(struct stream *stream, const void *buffer, size_t n) | |
663 | { | |
664 | struct ssl_stream *sslv = ssl_stream_cast(stream); | |
665 | ||
666 | if (sslv->txbuf) { | |
2b494771 | 667 | return -EAGAIN; |
9467fe62 BP |
668 | } else { |
669 | int error; | |
670 | ||
671 | sslv->txbuf = ofpbuf_clone_data(buffer, n); | |
672 | error = ssl_do_tx(stream); | |
673 | switch (error) { | |
674 | case 0: | |
675 | ssl_clear_txbuf(sslv); | |
2b494771 | 676 | return n; |
9467fe62 | 677 | case EAGAIN: |
2b494771 | 678 | return n; |
9467fe62 BP |
679 | default: |
680 | sslv->txbuf = NULL; | |
2b494771 | 681 | return -error; |
9467fe62 BP |
682 | } |
683 | } | |
684 | } | |
685 | ||
686 | static void | |
687 | ssl_run(struct stream *stream) | |
688 | { | |
689 | struct ssl_stream *sslv = ssl_stream_cast(stream); | |
690 | ||
691 | if (sslv->txbuf && ssl_do_tx(stream) != EAGAIN) { | |
692 | ssl_clear_txbuf(sslv); | |
693 | } | |
694 | } | |
695 | ||
696 | static void | |
697 | ssl_run_wait(struct stream *stream) | |
698 | { | |
699 | struct ssl_stream *sslv = ssl_stream_cast(stream); | |
700 | ||
701 | if (sslv->tx_want != SSL_NOTHING) { | |
1ca3348e | 702 | poll_fd_wait(sslv->fd, want_to_poll_events(sslv->tx_want)); |
9467fe62 BP |
703 | } |
704 | } | |
705 | ||
706 | static void | |
707 | ssl_wait(struct stream *stream, enum stream_wait_type wait) | |
708 | { | |
709 | struct ssl_stream *sslv = ssl_stream_cast(stream); | |
710 | ||
711 | switch (wait) { | |
712 | case STREAM_CONNECT: | |
713 | if (stream_connect(stream) != EAGAIN) { | |
714 | poll_immediate_wake(); | |
715 | } else { | |
716 | switch (sslv->state) { | |
717 | case STATE_TCP_CONNECTING: | |
1ca3348e | 718 | poll_fd_wait(sslv->fd, POLLOUT); |
9467fe62 BP |
719 | break; |
720 | ||
721 | case STATE_SSL_CONNECTING: | |
722 | /* ssl_connect() called SSL_accept() or SSL_connect(), which | |
723 | * set up the status that we test here. */ | |
1ca3348e GS |
724 | poll_fd_wait(sslv->fd, |
725 | want_to_poll_events(SSL_want(sslv->ssl))); | |
9467fe62 BP |
726 | break; |
727 | ||
728 | default: | |
428b2edd | 729 | OVS_NOT_REACHED(); |
9467fe62 BP |
730 | } |
731 | } | |
732 | break; | |
733 | ||
734 | case STREAM_RECV: | |
735 | if (sslv->rx_want != SSL_NOTHING) { | |
1ca3348e | 736 | poll_fd_wait(sslv->fd, want_to_poll_events(sslv->rx_want)); |
9467fe62 BP |
737 | } else { |
738 | poll_immediate_wake(); | |
739 | } | |
740 | break; | |
741 | ||
742 | case STREAM_SEND: | |
743 | if (!sslv->txbuf) { | |
744 | /* We have room in our tx queue. */ | |
745 | poll_immediate_wake(); | |
746 | } else { | |
747 | /* stream_run_wait() will do the right thing; don't bother with | |
748 | * redundancy. */ | |
749 | } | |
750 | break; | |
751 | ||
752 | default: | |
428b2edd | 753 | OVS_NOT_REACHED(); |
9467fe62 BP |
754 | } |
755 | } | |
756 | ||
da327b18 | 757 | const struct stream_class ssl_stream_class = { |
9467fe62 | 758 | "ssl", /* name */ |
f1936eb6 | 759 | true, /* needs_probes */ |
9467fe62 BP |
760 | ssl_open, /* open */ |
761 | ssl_close, /* close */ | |
762 | ssl_connect, /* connect */ | |
763 | ssl_recv, /* recv */ | |
764 | ssl_send, /* send */ | |
765 | ssl_run, /* run */ | |
766 | ssl_run_wait, /* run_wait */ | |
767 | ssl_wait, /* wait */ | |
768 | }; | |
769 | \f | |
770 | /* Passive SSL. */ | |
771 | ||
772 | struct pssl_pstream | |
773 | { | |
774 | struct pstream pstream; | |
775 | int fd; | |
776 | }; | |
777 | ||
da327b18 | 778 | const struct pstream_class pssl_pstream_class; |
9467fe62 BP |
779 | |
780 | static struct pssl_pstream * | |
781 | pssl_pstream_cast(struct pstream *pstream) | |
782 | { | |
783 | pstream_assert_class(pstream, &pssl_pstream_class); | |
784 | return CONTAINER_OF(pstream, struct pssl_pstream, pstream); | |
785 | } | |
786 | ||
787 | static int | |
f125905c MM |
788 | pssl_open(const char *name OVS_UNUSED, char *suffix, struct pstream **pstreamp, |
789 | uint8_t dscp) | |
9467fe62 | 790 | { |
e731d71b AS |
791 | char bound_name[SS_NTOP_BUFSIZE + 16]; |
792 | char addrbuf[SS_NTOP_BUFSIZE]; | |
793 | struct sockaddr_storage ss; | |
9467fe62 | 794 | struct pssl_pstream *pssl; |
e731d71b | 795 | uint16_t port; |
9467fe62 BP |
796 | int retval; |
797 | int fd; | |
798 | ||
799 | retval = ssl_init(); | |
800 | if (retval) { | |
801 | return retval; | |
802 | } | |
803 | ||
b52ecd96 | 804 | fd = inet_open_passive(SOCK_STREAM, suffix, OFP_OLD_PORT, &ss, dscp, true); |
9467fe62 BP |
805 | if (fd < 0) { |
806 | return -fd; | |
807 | } | |
e731d71b AS |
808 | |
809 | port = ss_get_port(&ss); | |
810 | snprintf(bound_name, sizeof bound_name, "ptcp:%"PRIu16":%s", | |
811 | port, ss_format_address(&ss, addrbuf, sizeof addrbuf)); | |
9467fe62 BP |
812 | |
813 | pssl = xmalloc(sizeof *pssl); | |
42967038 | 814 | pstream_init(&pssl->pstream, &pssl_pstream_class, bound_name); |
e731d71b | 815 | pstream_set_bound_port(&pssl->pstream, htons(port)); |
9467fe62 BP |
816 | pssl->fd = fd; |
817 | *pstreamp = &pssl->pstream; | |
818 | return 0; | |
819 | } | |
820 | ||
821 | static void | |
822 | pssl_close(struct pstream *pstream) | |
823 | { | |
824 | struct pssl_pstream *pssl = pssl_pstream_cast(pstream); | |
5ea1366b | 825 | closesocket(pssl->fd); |
9467fe62 BP |
826 | free(pssl); |
827 | } | |
828 | ||
829 | static int | |
830 | pssl_accept(struct pstream *pstream, struct stream **new_streamp) | |
831 | { | |
832 | struct pssl_pstream *pssl = pssl_pstream_cast(pstream); | |
e731d71b AS |
833 | char name[SS_NTOP_BUFSIZE + 16]; |
834 | char addrbuf[SS_NTOP_BUFSIZE]; | |
835 | struct sockaddr_storage ss; | |
836 | socklen_t ss_len = sizeof ss; | |
9467fe62 BP |
837 | int new_fd; |
838 | int error; | |
839 | ||
e731d71b | 840 | new_fd = accept(pssl->fd, (struct sockaddr *) &ss, &ss_len); |
9467fe62 | 841 | if (new_fd < 0) { |
5ea1366b GS |
842 | error = sock_errno(); |
843 | #ifdef _WIN32 | |
844 | if (error == WSAEWOULDBLOCK) { | |
845 | error = EAGAIN; | |
846 | } | |
847 | #endif | |
9467fe62 | 848 | if (error != EAGAIN) { |
5ea1366b | 849 | VLOG_DBG_RL(&rl, "accept: %s", sock_strerror(error)); |
9467fe62 BP |
850 | } |
851 | return error; | |
852 | } | |
853 | ||
854 | error = set_nonblocking(new_fd); | |
855 | if (error) { | |
5ea1366b | 856 | closesocket(new_fd); |
9467fe62 BP |
857 | return error; |
858 | } | |
859 | ||
e731d71b AS |
860 | snprintf(name, sizeof name, "tcp:%s:%"PRIu16, |
861 | ss_format_address(&ss, addrbuf, sizeof addrbuf), | |
862 | ss_get_port(&ss)); | |
a8d81967 | 863 | return new_ssl_stream(name, new_fd, SERVER, STATE_SSL_CONNECTING, |
f125905c | 864 | new_streamp); |
9467fe62 BP |
865 | } |
866 | ||
867 | static void | |
868 | pssl_wait(struct pstream *pstream) | |
869 | { | |
870 | struct pssl_pstream *pssl = pssl_pstream_cast(pstream); | |
1ca3348e | 871 | poll_fd_wait(pssl->fd, POLLIN); |
9467fe62 BP |
872 | } |
873 | ||
f89b7ce5 IY |
874 | static int |
875 | pssl_set_dscp(struct pstream *pstream, uint8_t dscp) | |
876 | { | |
877 | struct pssl_pstream *pssl = pssl_pstream_cast(pstream); | |
878 | return set_dscp(pssl->fd, dscp); | |
879 | } | |
880 | ||
da327b18 | 881 | const struct pstream_class pssl_pstream_class = { |
9467fe62 | 882 | "pssl", |
f1936eb6 | 883 | true, |
9467fe62 BP |
884 | pssl_open, |
885 | pssl_close, | |
886 | pssl_accept, | |
887 | pssl_wait, | |
f89b7ce5 | 888 | pssl_set_dscp, |
9467fe62 BP |
889 | }; |
890 | \f | |
891 | /* | |
892 | * Returns true if OpenSSL error is WANT_READ or WANT_WRITE, indicating that | |
893 | * OpenSSL is requesting that we call it back when the socket is ready for read | |
894 | * or writing, respectively. | |
895 | */ | |
896 | static bool | |
897 | ssl_wants_io(int ssl_error) | |
898 | { | |
899 | return (ssl_error == SSL_ERROR_WANT_WRITE | |
900 | || ssl_error == SSL_ERROR_WANT_READ); | |
901 | } | |
902 | ||
903 | static int | |
904 | ssl_init(void) | |
905 | { | |
906 | static int init_status = -1; | |
907 | if (init_status < 0) { | |
908 | init_status = do_ssl_init(); | |
cb22974d | 909 | ovs_assert(init_status >= 0); |
9467fe62 BP |
910 | } |
911 | return init_status; | |
912 | } | |
913 | ||
914 | static int | |
915 | do_ssl_init(void) | |
916 | { | |
917 | SSL_METHOD *method; | |
918 | ||
5ea1366b GS |
919 | #ifdef _WIN32 |
920 | /* The following call is needed if we "#include <openssl/applink.c>". */ | |
921 | CRYPTO_malloc_init(); | |
922 | #endif | |
9467fe62 BP |
923 | SSL_library_init(); |
924 | SSL_load_error_strings(); | |
925 | ||
47ebcf25 BP |
926 | if (!RAND_status()) { |
927 | /* We occasionally see OpenSSL fail to seed its random number generator | |
928 | * in heavily loaded hypervisors. I suspect the following scenario: | |
929 | * | |
930 | * 1. OpenSSL calls read() to get 32 bytes from /dev/urandom. | |
931 | * 2. The kernel generates 10 bytes of randomness and copies it out. | |
932 | * 3. A signal arrives (perhaps SIGALRM). | |
933 | * 4. The kernel interrupts the system call to service the signal. | |
934 | * 5. Userspace gets 10 bytes of entropy. | |
935 | * 6. OpenSSL doesn't read again to get the final 22 bytes. Therefore | |
936 | * OpenSSL doesn't have enough entropy to consider itself | |
937 | * initialized. | |
938 | * | |
939 | * The only part I'm not entirely sure about is #6, because the OpenSSL | |
940 | * code is so hard to read. */ | |
941 | uint8_t seed[32]; | |
942 | int retval; | |
943 | ||
944 | VLOG_WARN("OpenSSL random seeding failed, reseeding ourselves"); | |
945 | ||
946 | retval = get_entropy(seed, sizeof seed); | |
947 | if (retval) { | |
948 | VLOG_ERR("failed to obtain entropy (%s)", | |
949 | ovs_retval_to_string(retval)); | |
950 | return retval > 0 ? retval : ENOPROTOOPT; | |
951 | } | |
952 | ||
953 | RAND_seed(seed, sizeof seed); | |
954 | } | |
955 | ||
b56ea5d5 BP |
956 | /* OpenSSL has a bunch of "connection methods": SSLv2_method(), |
957 | * SSLv3_method(), TLSv1_method(), SSLv23_method(), ... Most of these | |
958 | * support exactly one version of SSL, e.g. TLSv1_method() supports TLSv1 | |
959 | * only, not any earlier *or later* version. The only exception is | |
960 | * SSLv23_method(), which in fact supports *any* version of SSL and TLS. | |
961 | * We don't want SSLv2 or SSLv3 support, so we turn it off below with | |
962 | * SSL_CTX_set_options(). | |
963 | * | |
964 | * The cast is needed to avoid a warning with newer versions of OpenSSL in | |
965 | * which SSLv23_method() returns a "const" pointer. */ | |
966 | method = CONST_CAST(SSL_METHOD *, SSLv23_method()); | |
9467fe62 BP |
967 | if (method == NULL) { |
968 | VLOG_ERR("TLSv1_method: %s", ERR_error_string(ERR_get_error(), NULL)); | |
969 | return ENOPROTOOPT; | |
970 | } | |
971 | ||
972 | ctx = SSL_CTX_new(method); | |
973 | if (ctx == NULL) { | |
974 | VLOG_ERR("SSL_CTX_new: %s", ERR_error_string(ERR_get_error(), NULL)); | |
975 | return ENOPROTOOPT; | |
976 | } | |
977 | SSL_CTX_set_options(ctx, SSL_OP_NO_SSLv2 | SSL_OP_NO_SSLv3); | |
978 | SSL_CTX_set_tmp_dh_callback(ctx, tmp_dh_callback); | |
979 | SSL_CTX_set_mode(ctx, SSL_MODE_ENABLE_PARTIAL_WRITE); | |
980 | SSL_CTX_set_mode(ctx, SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER); | |
981 | SSL_CTX_set_verify(ctx, SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT, | |
982 | NULL); | |
983 | ||
984 | return 0; | |
985 | } | |
986 | ||
987 | static DH * | |
67a4917b | 988 | tmp_dh_callback(SSL *ssl OVS_UNUSED, int is_export OVS_UNUSED, int keylength) |
9467fe62 BP |
989 | { |
990 | struct dh { | |
991 | int keylength; | |
992 | DH *dh; | |
993 | DH *(*constructor)(void); | |
994 | }; | |
995 | ||
996 | static struct dh dh_table[] = { | |
997 | {1024, NULL, get_dh1024}, | |
998 | {2048, NULL, get_dh2048}, | |
999 | {4096, NULL, get_dh4096}, | |
1000 | }; | |
1001 | ||
1002 | struct dh *dh; | |
1003 | ||
1004 | for (dh = dh_table; dh < &dh_table[ARRAY_SIZE(dh_table)]; dh++) { | |
1005 | if (dh->keylength == keylength) { | |
1006 | if (!dh->dh) { | |
1007 | dh->dh = dh->constructor(); | |
1008 | if (!dh->dh) { | |
1d2c568d | 1009 | out_of_memory(); |
9467fe62 BP |
1010 | } |
1011 | } | |
1012 | return dh->dh; | |
1013 | } | |
1014 | } | |
1015 | VLOG_ERR_RL(&rl, "no Diffie-Hellman parameters for key length %d", | |
1016 | keylength); | |
1017 | return NULL; | |
1018 | } | |
1019 | ||
1020 | /* Returns true if SSL is at least partially configured. */ | |
1021 | bool | |
d295e8e9 | 1022 | stream_ssl_is_configured(void) |
9467fe62 | 1023 | { |
415f6c0b BP |
1024 | return private_key.file_name || certificate.file_name || ca_cert.file_name; |
1025 | } | |
1026 | ||
1027 | static bool | |
1028 | update_ssl_config(struct ssl_config_file *config, const char *file_name) | |
1029 | { | |
9cb07887 | 1030 | struct timespec mtime; |
e68f6dea | 1031 | int error; |
9cb07887 BP |
1032 | |
1033 | if (ssl_init() || !file_name) { | |
1034 | return false; | |
1035 | } | |
1036 | ||
1037 | /* If the file name hasn't changed and neither has the file contents, stop | |
1038 | * here. */ | |
e68f6dea BP |
1039 | error = get_mtime(file_name, &mtime); |
1040 | if (error && error != ENOENT) { | |
10a89ef0 BP |
1041 | VLOG_ERR_RL(&rl, "%s: stat failed (%s)", |
1042 | file_name, ovs_strerror(error)); | |
e68f6dea | 1043 | } |
9cb07887 BP |
1044 | if (config->file_name |
1045 | && !strcmp(config->file_name, file_name) | |
1046 | && mtime.tv_sec == config->mtime.tv_sec | |
1047 | && mtime.tv_nsec == config->mtime.tv_nsec) { | |
415f6c0b BP |
1048 | return false; |
1049 | } | |
1050 | ||
2b1a27a1 | 1051 | /* Update 'config'. */ |
9cb07887 | 1052 | config->mtime = mtime; |
2b1a27a1 BP |
1053 | if (file_name != config->file_name) { |
1054 | free(config->file_name); | |
1055 | config->file_name = xstrdup(file_name); | |
1056 | } | |
415f6c0b | 1057 | return true; |
9467fe62 BP |
1058 | } |
1059 | ||
6f1e91b1 BP |
1060 | static void |
1061 | stream_ssl_set_private_key_file__(const char *file_name) | |
1062 | { | |
1063 | if (SSL_CTX_use_PrivateKey_file(ctx, file_name, SSL_FILETYPE_PEM) == 1) { | |
1064 | private_key.read = true; | |
1065 | } else { | |
1066 | VLOG_ERR("SSL_use_PrivateKey_file: %s", | |
1067 | ERR_error_string(ERR_get_error(), NULL)); | |
1068 | } | |
1069 | } | |
1070 | ||
9467fe62 BP |
1071 | void |
1072 | stream_ssl_set_private_key_file(const char *file_name) | |
1073 | { | |
6f1e91b1 BP |
1074 | if (update_ssl_config(&private_key, file_name)) { |
1075 | stream_ssl_set_private_key_file__(file_name); | |
9467fe62 | 1076 | } |
6f1e91b1 BP |
1077 | } |
1078 | ||
1079 | static void | |
1080 | stream_ssl_set_certificate_file__(const char *file_name) | |
1081 | { | |
1082 | if (SSL_CTX_use_certificate_chain_file(ctx, file_name) == 1) { | |
1083 | certificate.read = true; | |
1084 | } else { | |
1085 | VLOG_ERR("SSL_use_certificate_file: %s", | |
9467fe62 | 1086 | ERR_error_string(ERR_get_error(), NULL)); |
9467fe62 | 1087 | } |
9467fe62 BP |
1088 | } |
1089 | ||
1090 | void | |
1091 | stream_ssl_set_certificate_file(const char *file_name) | |
1092 | { | |
6f1e91b1 BP |
1093 | if (update_ssl_config(&certificate, file_name)) { |
1094 | stream_ssl_set_certificate_file__(file_name); | |
9467fe62 | 1095 | } |
6f1e91b1 BP |
1096 | } |
1097 | ||
1098 | /* Sets the private key and certificate files in one operation. Use this | |
1099 | * interface, instead of calling stream_ssl_set_private_key_file() and | |
1100 | * stream_ssl_set_certificate_file() individually, in the main loop of a | |
1101 | * long-running program whose key and certificate might change at runtime. | |
1102 | * | |
1103 | * This is important because of OpenSSL's behavior. If an OpenSSL context | |
1104 | * already has a certificate, and stream_ssl_set_private_key_file() is called | |
1105 | * to install a new private key, OpenSSL will report an error because the new | |
1106 | * private key does not match the old certificate. The other order, of setting | |
1107 | * a new certificate, then setting a new private key, does work. | |
1108 | * | |
1109 | * If this were the only problem, calling stream_ssl_set_certificate_file() | |
1110 | * before stream_ssl_set_private_key_file() would fix it. But, if the private | |
1111 | * key is changed before the certificate (e.g. someone "scp"s or "mv"s the new | |
1112 | * private key in place before the certificate), then OpenSSL would reject that | |
1113 | * change, and then the change of certificate would succeed, but there would be | |
1114 | * no associated private key (because it had only changed once and therefore | |
1115 | * there was no point in re-reading it). | |
1116 | * | |
1117 | * This function avoids both problems by, whenever either the certificate or | |
1118 | * the private key file changes, re-reading both of them, in the correct order. | |
1119 | */ | |
1120 | void | |
1121 | stream_ssl_set_key_and_cert(const char *private_key_file, | |
1122 | const char *certificate_file) | |
1123 | { | |
1124 | if (update_ssl_config(&private_key, private_key_file) | |
1125 | || update_ssl_config(&certificate, certificate_file)) { | |
1126 | stream_ssl_set_certificate_file__(certificate_file); | |
1127 | stream_ssl_set_private_key_file__(private_key_file); | |
9467fe62 | 1128 | } |
9467fe62 BP |
1129 | } |
1130 | ||
1131 | /* Reads the X509 certificate or certificates in file 'file_name'. On success, | |
1132 | * stores the address of the first element in an array of pointers to | |
1133 | * certificates in '*certs' and the number of certificates in the array in | |
1134 | * '*n_certs', and returns 0. On failure, stores a null pointer in '*certs', 0 | |
1135 | * in '*n_certs', and returns a positive errno value. | |
1136 | * | |
1137 | * The caller is responsible for freeing '*certs'. */ | |
1138 | static int | |
1139 | read_cert_file(const char *file_name, X509 ***certs, size_t *n_certs) | |
1140 | { | |
1141 | FILE *file; | |
1142 | size_t allocated_certs = 0; | |
1143 | ||
1144 | *certs = NULL; | |
1145 | *n_certs = 0; | |
1146 | ||
1147 | file = fopen(file_name, "r"); | |
1148 | if (!file) { | |
1149 | VLOG_ERR("failed to open %s for reading: %s", | |
10a89ef0 | 1150 | file_name, ovs_strerror(errno)); |
9467fe62 BP |
1151 | return errno; |
1152 | } | |
1153 | ||
1154 | for (;;) { | |
1155 | X509 *certificate; | |
1156 | int c; | |
1157 | ||
1158 | /* Read certificate from file. */ | |
1159 | certificate = PEM_read_X509(file, NULL, NULL, NULL); | |
1160 | if (!certificate) { | |
1161 | size_t i; | |
1162 | ||
1163 | VLOG_ERR("PEM_read_X509 failed reading %s: %s", | |
1164 | file_name, ERR_error_string(ERR_get_error(), NULL)); | |
1165 | for (i = 0; i < *n_certs; i++) { | |
1166 | X509_free((*certs)[i]); | |
1167 | } | |
1168 | free(*certs); | |
1169 | *certs = NULL; | |
1170 | *n_certs = 0; | |
0ded15d4 | 1171 | fclose(file); |
9467fe62 BP |
1172 | return EIO; |
1173 | } | |
1174 | ||
1175 | /* Add certificate to array. */ | |
1176 | if (*n_certs >= allocated_certs) { | |
1177 | *certs = x2nrealloc(*certs, &allocated_certs, sizeof **certs); | |
1178 | } | |
1179 | (*certs)[(*n_certs)++] = certificate; | |
1180 | ||
1181 | /* Are there additional certificates in the file? */ | |
1182 | do { | |
1183 | c = getc(file); | |
1184 | } while (isspace(c)); | |
1185 | if (c == EOF) { | |
1186 | break; | |
1187 | } | |
1188 | ungetc(c, file); | |
1189 | } | |
1190 | fclose(file); | |
1191 | return 0; | |
1192 | } | |
1193 | ||
1194 | ||
1195 | /* Sets 'file_name' as the name of a file containing one or more X509 | |
1196 | * certificates to send to the peer. Typical use in OpenFlow is to send the CA | |
1197 | * certificate to the peer, which enables a switch to pick up the controller's | |
1198 | * CA certificate on its first connection. */ | |
1199 | void | |
1200 | stream_ssl_set_peer_ca_cert_file(const char *file_name) | |
1201 | { | |
1202 | X509 **certs; | |
1203 | size_t n_certs; | |
1204 | size_t i; | |
1205 | ||
1206 | if (ssl_init()) { | |
1207 | return; | |
1208 | } | |
1209 | ||
1210 | if (!read_cert_file(file_name, &certs, &n_certs)) { | |
1211 | for (i = 0; i < n_certs; i++) { | |
1212 | if (SSL_CTX_add_extra_chain_cert(ctx, certs[i]) != 1) { | |
1213 | VLOG_ERR("SSL_CTX_add_extra_chain_cert: %s", | |
1214 | ERR_error_string(ERR_get_error(), NULL)); | |
1215 | } | |
1216 | } | |
1217 | free(certs); | |
1218 | } | |
1219 | } | |
1220 | ||
1221 | /* Logs fingerprint of CA certificate 'cert' obtained from 'file_name'. */ | |
1222 | static void | |
1223 | log_ca_cert(const char *file_name, X509 *cert) | |
1224 | { | |
1225 | unsigned char digest[EVP_MAX_MD_SIZE]; | |
1226 | unsigned int n_bytes; | |
1227 | struct ds fp; | |
1228 | char *subject; | |
1229 | ||
1230 | ds_init(&fp); | |
1231 | if (!X509_digest(cert, EVP_sha1(), digest, &n_bytes)) { | |
1232 | ds_put_cstr(&fp, "<out of memory>"); | |
1233 | } else { | |
1234 | unsigned int i; | |
1235 | for (i = 0; i < n_bytes; i++) { | |
1236 | if (i) { | |
1237 | ds_put_char(&fp, ':'); | |
1238 | } | |
34582733 | 1239 | ds_put_format(&fp, "%02x", digest[i]); |
9467fe62 BP |
1240 | } |
1241 | } | |
1242 | subject = X509_NAME_oneline(X509_get_subject_name(cert), NULL, 0); | |
1243 | VLOG_INFO("Trusting CA cert from %s (%s) (fingerprint %s)", file_name, | |
1244 | subject ? subject : "<out of memory>", ds_cstr(&fp)); | |
3c7b5c2d | 1245 | OPENSSL_free(subject); |
9467fe62 BP |
1246 | ds_destroy(&fp); |
1247 | } | |
1248 | ||
415f6c0b | 1249 | static void |
f1484874 BP |
1250 | stream_ssl_set_ca_cert_file__(const char *file_name, |
1251 | bool bootstrap, bool force) | |
9467fe62 BP |
1252 | { |
1253 | X509 **certs; | |
1254 | size_t n_certs; | |
1255 | struct stat s; | |
1256 | ||
f1484874 BP |
1257 | if (!update_ssl_config(&ca_cert, file_name) && !force) { |
1258 | return; | |
1259 | } | |
1260 | ||
ba104a1e BP |
1261 | if (!strcmp(file_name, "none")) { |
1262 | verify_peer_cert = false; | |
1263 | VLOG_WARN("Peer certificate validation disabled " | |
1264 | "(this is a security risk)"); | |
1265 | } else if (bootstrap && stat(file_name, &s) && errno == ENOENT) { | |
9467fe62 | 1266 | bootstrap_ca_cert = true; |
9467fe62 BP |
1267 | } else if (!read_cert_file(file_name, &certs, &n_certs)) { |
1268 | size_t i; | |
1269 | ||
1270 | /* Set up list of CAs that the server will accept from the client. */ | |
1271 | for (i = 0; i < n_certs; i++) { | |
1272 | /* SSL_CTX_add_client_CA makes a copy of the relevant data. */ | |
1273 | if (SSL_CTX_add_client_CA(ctx, certs[i]) != 1) { | |
34582733 | 1274 | VLOG_ERR("failed to add client certificate %"PRIuSIZE" from %s: %s", |
9467fe62 BP |
1275 | i, file_name, |
1276 | ERR_error_string(ERR_get_error(), NULL)); | |
1277 | } else { | |
1278 | log_ca_cert(file_name, certs[i]); | |
1279 | } | |
1280 | X509_free(certs[i]); | |
1281 | } | |
f6b60e02 | 1282 | free(certs); |
9467fe62 BP |
1283 | |
1284 | /* Set up CAs for OpenSSL to trust in verifying the peer's | |
1285 | * certificate. */ | |
e6a8ca62 | 1286 | SSL_CTX_set_cert_store(ctx, X509_STORE_new()); |
9467fe62 BP |
1287 | if (SSL_CTX_load_verify_locations(ctx, file_name, NULL) != 1) { |
1288 | VLOG_ERR("SSL_CTX_load_verify_locations: %s", | |
1289 | ERR_error_string(ERR_get_error(), NULL)); | |
1290 | return; | |
1291 | } | |
1292 | ||
415f6c0b | 1293 | bootstrap_ca_cert = false; |
9467fe62 | 1294 | } |
415f6c0b | 1295 | ca_cert.read = true; |
9467fe62 | 1296 | } |
415f6c0b BP |
1297 | |
1298 | /* Sets 'file_name' as the name of the file from which to read the CA | |
1299 | * certificate used to verify the peer within SSL connections. If 'bootstrap' | |
1300 | * is false, the file must exist. If 'bootstrap' is false, then the file is | |
1301 | * read if it is exists; if it does not, then it will be created from the CA | |
1302 | * certificate received from the peer on the first SSL connection. */ | |
1303 | void | |
1304 | stream_ssl_set_ca_cert_file(const char *file_name, bool bootstrap) | |
1305 | { | |
f1484874 | 1306 | stream_ssl_set_ca_cert_file__(file_name, bootstrap, false); |
415f6c0b | 1307 | } |
ff1760f1 BP |
1308 | \f |
1309 | /* SSL protocol logging. */ | |
1310 | ||
1311 | static const char * | |
1312 | ssl_alert_level_to_string(uint8_t type) | |
1313 | { | |
1314 | switch (type) { | |
1315 | case 1: return "warning"; | |
1316 | case 2: return "fatal"; | |
1317 | default: return "<unknown>"; | |
1318 | } | |
1319 | } | |
415f6c0b | 1320 | |
ff1760f1 BP |
1321 | static const char * |
1322 | ssl_alert_description_to_string(uint8_t type) | |
1323 | { | |
1324 | switch (type) { | |
1325 | case 0: return "close_notify"; | |
1326 | case 10: return "unexpected_message"; | |
1327 | case 20: return "bad_record_mac"; | |
1328 | case 21: return "decryption_failed"; | |
1329 | case 22: return "record_overflow"; | |
1330 | case 30: return "decompression_failure"; | |
1331 | case 40: return "handshake_failure"; | |
1332 | case 42: return "bad_certificate"; | |
1333 | case 43: return "unsupported_certificate"; | |
1334 | case 44: return "certificate_revoked"; | |
1335 | case 45: return "certificate_expired"; | |
1336 | case 46: return "certificate_unknown"; | |
1337 | case 47: return "illegal_parameter"; | |
1338 | case 48: return "unknown_ca"; | |
1339 | case 49: return "access_denied"; | |
1340 | case 50: return "decode_error"; | |
1341 | case 51: return "decrypt_error"; | |
1342 | case 60: return "export_restriction"; | |
1343 | case 70: return "protocol_version"; | |
1344 | case 71: return "insufficient_security"; | |
1345 | case 80: return "internal_error"; | |
1346 | case 90: return "user_canceled"; | |
1347 | case 100: return "no_renegotiation"; | |
1348 | default: return "<unknown>"; | |
1349 | } | |
1350 | } | |
415f6c0b | 1351 | |
ff1760f1 BP |
1352 | static const char * |
1353 | ssl_handshake_type_to_string(uint8_t type) | |
1354 | { | |
1355 | switch (type) { | |
1356 | case 0: return "hello_request"; | |
1357 | case 1: return "client_hello"; | |
1358 | case 2: return "server_hello"; | |
1359 | case 11: return "certificate"; | |
1360 | case 12: return "server_key_exchange"; | |
1361 | case 13: return "certificate_request"; | |
1362 | case 14: return "server_hello_done"; | |
1363 | case 15: return "certificate_verify"; | |
1364 | case 16: return "client_key_exchange"; | |
1365 | case 20: return "finished"; | |
1366 | default: return "<unknown>"; | |
1367 | } | |
1368 | } | |
1369 | ||
1370 | static void | |
1371 | ssl_protocol_cb(int write_p, int version OVS_UNUSED, int content_type, | |
1372 | const void *buf_, size_t len, SSL *ssl OVS_UNUSED, void *sslv_) | |
1373 | { | |
1374 | const struct ssl_stream *sslv = sslv_; | |
1375 | const uint8_t *buf = buf_; | |
1376 | struct ds details; | |
1377 | ||
1378 | if (!VLOG_IS_DBG_ENABLED()) { | |
1379 | return; | |
1380 | } | |
1381 | ||
1382 | ds_init(&details); | |
1383 | if (content_type == 20) { | |
1384 | ds_put_cstr(&details, "change_cipher_spec"); | |
1385 | } else if (content_type == 21) { | |
1386 | ds_put_format(&details, "alert: %s, %s", | |
1387 | ssl_alert_level_to_string(buf[0]), | |
1388 | ssl_alert_description_to_string(buf[1])); | |
1389 | } else if (content_type == 22) { | |
1390 | ds_put_format(&details, "handshake: %s", | |
1391 | ssl_handshake_type_to_string(buf[0])); | |
1392 | } else { | |
1393 | ds_put_format(&details, "type %d", content_type); | |
1394 | } | |
1395 | ||
34582733 | 1396 | VLOG_DBG("%s%u%s%s %s (%"PRIuSIZE" bytes)", |
ff1760f1 BP |
1397 | sslv->type == CLIENT ? "client" : "server", |
1398 | sslv->session_nr, write_p ? "-->" : "<--", | |
1399 | stream_get_name(&sslv->stream), ds_cstr(&details), len); | |
1400 | ||
1401 | ds_destroy(&details); | |
1402 | } |