tls: handle read write ssl errors
[vpp.git] / src / plugins / tlsopenssl / tls_openssl.c
1 /*
2  * Copyright (c) 2018 Cisco and/or its affiliates.
3  * Licensed under the Apache License, Version 2.0 (the "License");
4  * you may not use this file except in compliance with the License.
5  * You may obtain a copy of the License at:
6  *
7  *     http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software
10  * distributed under the License is distributed on an "AS IS" BASIS,
11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  * See the License for the specific language governing permissions and
13  * limitations under the License.
14  */
15
16 #include <openssl/ssl.h>
17 #include <openssl/conf.h>
18 #include <openssl/err.h>
19
20 #ifdef HAVE_OPENSSL_ASYNC
21 #include <openssl/async.h>
22 #endif
23 #include <dlfcn.h>
24 #include <vnet/plugin/plugin.h>
25 #include <vpp/app/version.h>
26 #include <vnet/tls/tls.h>
27 #include <ctype.h>
28 #include <tlsopenssl/tls_openssl.h>
29 #include <tlsopenssl/tls_bios.h>
30
31 #define MAX_CRYPTO_LEN 64
32
33 openssl_main_t openssl_main;
34
35 static u32
36 openssl_ctx_alloc_w_thread (u32 thread_index)
37 {
38   openssl_main_t *om = &openssl_main;
39   openssl_ctx_t **ctx;
40
41   pool_get (om->ctx_pool[thread_index], ctx);
42   if (!(*ctx))
43     *ctx = clib_mem_alloc (sizeof (openssl_ctx_t));
44
45   clib_memset (*ctx, 0, sizeof (openssl_ctx_t));
46   (*ctx)->ctx.c_thread_index = thread_index;
47   (*ctx)->ctx.tls_ctx_engine = CRYPTO_ENGINE_OPENSSL;
48   (*ctx)->ctx.app_session_handle = SESSION_INVALID_HANDLE;
49   (*ctx)->openssl_ctx_index = ctx - om->ctx_pool[thread_index];
50   return ((*ctx)->openssl_ctx_index);
51 }
52
53 static u32
54 openssl_ctx_alloc (void)
55 {
56   return openssl_ctx_alloc_w_thread (vlib_get_thread_index ());
57 }
58
59 static void
60 openssl_ctx_free (tls_ctx_t * ctx)
61 {
62   openssl_ctx_t *oc = (openssl_ctx_t *) ctx;
63
64   /* Cleanup ssl ctx unless migrated */
65   if (!ctx->is_migrated)
66     {
67       if (SSL_is_init_finished (oc->ssl) && !ctx->is_passive_close)
68         SSL_shutdown (oc->ssl);
69
70       SSL_free (oc->ssl);
71       vec_free (ctx->srv_hostname);
72
73 #ifdef HAVE_OPENSSL_ASYNC
74   openssl_evt_free (ctx->evt_index, ctx->c_thread_index);
75 #endif
76     }
77
78   pool_put_index (openssl_main.ctx_pool[ctx->c_thread_index],
79                   oc->openssl_ctx_index);
80 }
81
82 static void *
83 openssl_ctx_detach (tls_ctx_t *ctx)
84 {
85   openssl_ctx_t *oc = (openssl_ctx_t *) ctx, *oc_copy;
86
87   oc_copy = clib_mem_alloc (sizeof (*oc_copy));
88   clib_memcpy (oc_copy, oc, sizeof (*oc));
89
90   return oc_copy;
91 }
92
93 static u32
94 openssl_ctx_attach (u32 thread_index, void *ctx_ptr)
95 {
96   openssl_main_t *om = &openssl_main;
97   session_handle_t sh;
98   openssl_ctx_t **oc;
99
100   pool_get (om->ctx_pool[thread_index], oc);
101   /* Free the old instance instead of looking for an empty spot */
102   if (*oc)
103     clib_mem_free (*oc);
104
105   *oc = ctx_ptr;
106   (*oc)->openssl_ctx_index = oc - om->ctx_pool[thread_index];
107   (*oc)->ctx.c_thread_index = thread_index;
108
109   sh = (*oc)->ctx.tls_session_handle;
110   BIO_set_data ((*oc)->rbio, uword_to_pointer (sh, void *));
111   BIO_set_data ((*oc)->wbio, uword_to_pointer (sh, void *));
112
113   return ((*oc)->openssl_ctx_index);
114 }
115
116 tls_ctx_t *
117 openssl_ctx_get (u32 ctx_index)
118 {
119   openssl_ctx_t **ctx;
120   ctx = pool_elt_at_index (openssl_main.ctx_pool[vlib_get_thread_index ()],
121                            ctx_index);
122   return &(*ctx)->ctx;
123 }
124
125 tls_ctx_t *
126 openssl_ctx_get_w_thread (u32 ctx_index, u8 thread_index)
127 {
128   openssl_ctx_t **ctx;
129   ctx = pool_elt_at_index (openssl_main.ctx_pool[thread_index], ctx_index);
130   return &(*ctx)->ctx;
131 }
132
133 static u32
134 openssl_listen_ctx_alloc (void)
135 {
136   openssl_main_t *om = &openssl_main;
137   openssl_listen_ctx_t *lctx;
138
139   pool_get (om->lctx_pool, lctx);
140
141   clib_memset (lctx, 0, sizeof (openssl_listen_ctx_t));
142   lctx->openssl_lctx_index = lctx - om->lctx_pool;
143   return lctx->openssl_lctx_index;
144 }
145
146 static void
147 openssl_listen_ctx_free (openssl_listen_ctx_t * lctx)
148 {
149   pool_put_index (openssl_main.lctx_pool, lctx->openssl_lctx_index);
150 }
151
152 openssl_listen_ctx_t *
153 openssl_lctx_get (u32 lctx_index)
154 {
155   return pool_elt_at_index (openssl_main.lctx_pool, lctx_index);
156 }
157
158 #define ossl_check_err_is_fatal(_ssl, _rv)                                    \
159   if (PREDICT_FALSE (_rv < 0 && SSL_get_error (_ssl, _rv) == SSL_ERROR_SSL))  \
160     return -1;
161
162 static int
163 openssl_read_from_ssl_into_fifo (svm_fifo_t * f, SSL * ssl)
164 {
165   int read, rv, n_fs, i;
166   const int n_segs = 2;
167   svm_fifo_seg_t fs[n_segs];
168   u32 max_enq;
169
170   max_enq = svm_fifo_max_enqueue_prod (f);
171   if (!max_enq)
172     return 0;
173
174   n_fs = svm_fifo_provision_chunks (f, fs, n_segs, max_enq);
175   if (n_fs < 0)
176     return 0;
177
178   /* Return early if we can't read anything */
179   read = SSL_read (ssl, fs[0].data, fs[0].len);
180   if (read <= 0)
181     {
182       ossl_check_err_is_fatal (ssl, read);
183       return 0;
184     }
185
186   for (i = 1; i < n_fs; i++)
187     {
188       rv = SSL_read (ssl, fs[i].data, fs[i].len);
189       read += rv > 0 ? rv : 0;
190
191       if (rv < (int) fs[i].len)
192         {
193           ossl_check_err_is_fatal (ssl, rv);
194           break;
195         }
196     }
197
198   svm_fifo_enqueue_nocopy (f, read);
199
200   return read;
201 }
202
203 static int
204 openssl_write_from_fifo_into_ssl (svm_fifo_t *f, SSL *ssl, u32 max_len)
205 {
206   int wrote = 0, rv, i = 0, len;
207   u32 n_segs = 2;
208   svm_fifo_seg_t fs[n_segs];
209
210   len = svm_fifo_segments (f, 0, fs, &n_segs, max_len);
211   if (len <= 0)
212     return 0;
213
214   while (wrote < len && i < n_segs)
215     {
216       rv = SSL_write (ssl, fs[i].data, fs[i].len);
217       wrote += (rv > 0) ? rv : 0;
218       if (rv < (int) fs[i].len)
219         {
220           ossl_check_err_is_fatal (ssl, rv);
221           break;
222         }
223       i++;
224     }
225
226   if (wrote)
227     svm_fifo_dequeue_drop (f, wrote);
228
229   return wrote;
230 }
231
232 #ifdef HAVE_OPENSSL_ASYNC
233 static int
234 openssl_check_async_status (tls_ctx_t * ctx, openssl_resume_handler * handler,
235                             session_t * session)
236 {
237   openssl_ctx_t *oc = (openssl_ctx_t *) ctx;
238   int estatus;
239
240   SSL_get_async_status (oc->ssl, &estatus);
241   if (estatus == ASYNC_STATUS_EAGAIN)
242     {
243       vpp_tls_async_update_event (ctx, 1);
244     }
245   else
246     {
247       vpp_tls_async_update_event (ctx, 0);
248     }
249
250   return 1;
251
252 }
253
254 #endif
255
256 static void
257 openssl_handle_handshake_failure (tls_ctx_t * ctx)
258 {
259   session_t *app_session;
260
261   if (SSL_is_server (((openssl_ctx_t *) ctx)->ssl))
262     {
263       /*
264        * Cleanup pre-allocated app session and close transport
265        */
266       app_session =
267         session_get_if_valid (ctx->c_s_index, ctx->c_thread_index);
268       if (app_session)
269         {
270           session_free (app_session);
271           ctx->no_app_session = 1;
272           ctx->c_s_index = SESSION_INVALID_INDEX;
273           tls_disconnect_transport (ctx);
274         }
275     }
276   else
277     {
278       /*
279        * Also handles cleanup of the pre-allocated session
280        */
281       tls_notify_app_connected (ctx, SESSION_E_TLS_HANDSHAKE);
282       tls_disconnect_transport (ctx);
283     }
284 }
285
286 int
287 openssl_ctx_handshake_rx (tls_ctx_t * ctx, session_t * tls_session)
288 {
289   openssl_ctx_t *oc = (openssl_ctx_t *) ctx;
290   int rv = 0, err;
291
292   while (SSL_in_init (oc->ssl))
293     {
294       if (ctx->resume)
295         {
296           ctx->resume = 0;
297         }
298       else if (!svm_fifo_max_dequeue_cons (tls_session->rx_fifo))
299         break;
300
301       rv = SSL_do_handshake (oc->ssl);
302       err = SSL_get_error (oc->ssl, rv);
303
304 #ifdef HAVE_OPENSSL_ASYNC
305       if (err == SSL_ERROR_WANT_ASYNC)
306         {
307           openssl_check_async_status (ctx, openssl_ctx_handshake_rx,
308                                       tls_session);
309         }
310 #endif
311       if (err == SSL_ERROR_SSL)
312         {
313           char buf[512];
314           ERR_error_string (ERR_get_error (), buf);
315           clib_warning ("Err: %s", buf);
316
317           openssl_handle_handshake_failure (ctx);
318           return -1;
319         }
320
321       if (err != SSL_ERROR_WANT_WRITE && err != SSL_ERROR_WANT_READ)
322         break;
323     }
324   TLS_DBG (2, "tls state for %u is %s", oc->openssl_ctx_index,
325            SSL_state_string_long (oc->ssl));
326
327   if (SSL_in_init (oc->ssl))
328     return -1;
329
330   /*
331    * Handshake complete
332    */
333   if (!SSL_is_server (oc->ssl))
334     {
335       /*
336        * Verify server certificate
337        */
338       if ((rv = SSL_get_verify_result (oc->ssl)) != X509_V_OK)
339         {
340           TLS_DBG (1, " failed verify: %s\n",
341                    X509_verify_cert_error_string (rv));
342
343           /*
344            * Presence of hostname enforces strict certificate verification
345            */
346           if (ctx->srv_hostname)
347             {
348               openssl_handle_handshake_failure (ctx);
349               return -1;
350             }
351         }
352       tls_notify_app_connected (ctx, SESSION_E_NONE);
353     }
354   else
355     {
356       /* Need to check transport status */
357       if (ctx->is_passive_close)
358         {
359           openssl_handle_handshake_failure (ctx);
360           return -1;
361         }
362
363       /* Accept failed, cleanup */
364       if (tls_notify_app_accept (ctx))
365         {
366           ctx->c_s_index = SESSION_INVALID_INDEX;
367           tls_disconnect_transport (ctx);
368           return -1;
369         }
370     }
371
372   TLS_DBG (1, "Handshake for %u complete. TLS cipher is %s",
373            oc->openssl_ctx_index, SSL_get_cipher (oc->ssl));
374   return rv;
375 }
376
377 static void
378 openssl_confirm_app_close (tls_ctx_t * ctx)
379 {
380   openssl_ctx_t *oc = (openssl_ctx_t *) ctx;
381   SSL_shutdown (oc->ssl);
382   tls_disconnect_transport (ctx);
383   session_transport_closed_notify (&ctx->connection);
384 }
385
386 static int
387 openssl_ctx_write_tls (tls_ctx_t *ctx, session_t *app_session,
388                        transport_send_params_t *sp)
389 {
390   openssl_ctx_t *oc = (openssl_ctx_t *) ctx;
391   u32 deq_max, space, enq_buf;
392   session_t *ts;
393   int wrote = 0;
394   svm_fifo_t *f;
395
396   ts = session_get_from_handle (ctx->tls_session_handle);
397   space = svm_fifo_max_enqueue_prod (ts->tx_fifo);
398   /* Leave a bit of extra space for tls ctrl data, if any needed */
399   space = clib_max ((int) space - TLSO_CTRL_BYTES, 0);
400
401   f = app_session->tx_fifo;
402
403   deq_max = svm_fifo_max_dequeue_cons (f);
404   deq_max = clib_min (deq_max, space);
405   if (!deq_max)
406     goto check_tls_fifo;
407
408   deq_max = clib_min (deq_max, sp->max_burst_size);
409
410   /* Make sure tcp's tx fifo can actually buffer all bytes to be dequeued.
411    * If under memory pressure, tls's fifo segment might not be able to
412    * allocate the chunks needed. This also avoids errors from the underlying
413    * custom bio to the ssl infra which at times can get stuck. */
414   if (svm_fifo_provision_chunks (ts->tx_fifo, 0, 0, deq_max + TLSO_CTRL_BYTES))
415     goto check_tls_fifo;
416
417   wrote = openssl_write_from_fifo_into_ssl (f, oc->ssl, deq_max);
418
419   /* Unrecoverable protocol error. Reset connection */
420   if (PREDICT_FALSE (wrote < 0))
421     {
422       tls_notify_app_io_error (ctx);
423       return 0;
424     }
425
426   if (!wrote)
427     goto check_tls_fifo;
428
429   if (svm_fifo_needs_deq_ntf (f, wrote))
430     session_dequeue_notify (app_session);
431
432 check_tls_fifo:
433
434   if (PREDICT_FALSE (ctx->app_closed && BIO_ctrl_pending (oc->rbio) <= 0))
435     openssl_confirm_app_close (ctx);
436
437   /* Deschedule and wait for deq notification if fifo is almost full */
438   enq_buf = clib_min (svm_fifo_size (ts->tx_fifo) / 2, TLSO_MIN_ENQ_SPACE);
439   if (space < wrote + enq_buf)
440     {
441       svm_fifo_add_want_deq_ntf (ts->tx_fifo, SVM_FIFO_WANT_DEQ_NOTIF);
442       transport_connection_deschedule (&ctx->connection);
443       sp->flags |= TRANSPORT_SND_F_DESCHED;
444     }
445   else
446     /* Request tx reschedule of the app session */
447     app_session->flags |= SESSION_F_CUSTOM_TX;
448
449   return wrote;
450 }
451
452 static int
453 openssl_ctx_write_dtls (tls_ctx_t *ctx, session_t *app_session,
454                         transport_send_params_t *sp)
455 {
456   openssl_main_t *om = &openssl_main;
457   openssl_ctx_t *oc = (openssl_ctx_t *) ctx;
458   u32 read = 0, to_deq, dgram_sz, enq_max;
459   session_dgram_pre_hdr_t hdr;
460   session_t *us;
461   int wrote, rv;
462   u8 *buf;
463
464   us = session_get_from_handle (ctx->tls_session_handle);
465   to_deq = svm_fifo_max_dequeue_cons (app_session->tx_fifo);
466   buf = om->tx_bufs[ctx->c_thread_index];
467
468   while (to_deq > 0)
469     {
470       /* Peeking only pre-header dgram because the session is connected */
471       rv = svm_fifo_peek (app_session->tx_fifo, 0, sizeof (hdr), (u8 *) &hdr);
472       ASSERT (rv == sizeof (hdr) && hdr.data_length < vec_len (buf));
473       ASSERT (to_deq >= hdr.data_length + SESSION_CONN_HDR_LEN);
474
475       dgram_sz = hdr.data_length + SESSION_CONN_HDR_LEN;
476       enq_max = dgram_sz + TLSO_CTRL_BYTES;
477       if (svm_fifo_max_enqueue_prod (us->tx_fifo) < enq_max ||
478           svm_fifo_provision_chunks (us->tx_fifo, 0, 0, enq_max))
479         {
480           svm_fifo_add_want_deq_ntf (us->tx_fifo, SVM_FIFO_WANT_DEQ_NOTIF);
481           transport_connection_deschedule (&ctx->connection);
482           sp->flags |= TRANSPORT_SND_F_DESCHED;
483           goto done;
484         }
485
486       rv = svm_fifo_peek (app_session->tx_fifo, SESSION_CONN_HDR_LEN,
487                           hdr.data_length, buf);
488       ASSERT (rv == hdr.data_length);
489       svm_fifo_dequeue_drop (app_session->tx_fifo, dgram_sz);
490
491       wrote = SSL_write (oc->ssl, buf, rv);
492       ASSERT (wrote > 0);
493
494       read += rv;
495       to_deq -= dgram_sz;
496     }
497
498 done:
499
500   if (svm_fifo_needs_deq_ntf (app_session->tx_fifo, read))
501     session_dequeue_notify (app_session);
502
503   if (read)
504     tls_add_vpp_q_tx_evt (us);
505
506   if (PREDICT_FALSE (ctx->app_closed &&
507                      !svm_fifo_max_enqueue_prod (us->rx_fifo)))
508     openssl_confirm_app_close (ctx);
509
510   return read;
511 }
512
513 static inline int
514 openssl_ctx_write (tls_ctx_t *ctx, session_t *app_session,
515                    transport_send_params_t *sp)
516 {
517   if (ctx->tls_type == TRANSPORT_PROTO_TLS)
518     return openssl_ctx_write_tls (ctx, app_session, sp);
519   else
520     return openssl_ctx_write_dtls (ctx, app_session, sp);
521 }
522
523 static inline int
524 openssl_ctx_read_tls (tls_ctx_t *ctx, session_t *tls_session)
525 {
526   openssl_ctx_t *oc = (openssl_ctx_t *) ctx;
527   session_t *app_session;
528   int read;
529   svm_fifo_t *f;
530
531   if (PREDICT_FALSE (SSL_in_init (oc->ssl)))
532     {
533       if (openssl_ctx_handshake_rx (ctx, tls_session) < 0)
534         return 0;
535     }
536
537   app_session = session_get_from_handle (ctx->app_session_handle);
538   f = app_session->rx_fifo;
539
540   read = openssl_read_from_ssl_into_fifo (f, oc->ssl);
541
542   /* Unrecoverable protocol error. Reset connection */
543   if (PREDICT_FALSE (read < 0))
544     {
545       tls_notify_app_io_error (ctx);
546       return 0;
547     }
548
549   /* If handshake just completed, session may still be in accepting state */
550   if (read && app_session->session_state >= SESSION_STATE_READY)
551     tls_notify_app_enqueue (ctx, app_session);
552
553   if ((SSL_pending (oc->ssl) > 0) ||
554       svm_fifo_max_dequeue_cons (tls_session->rx_fifo))
555     tls_add_vpp_q_builtin_rx_evt (tls_session);
556
557   return read;
558 }
559
560 static inline int
561 openssl_ctx_read_dtls (tls_ctx_t *ctx, session_t *us)
562 {
563   openssl_main_t *om = &openssl_main;
564   openssl_ctx_t *oc = (openssl_ctx_t *) ctx;
565   session_dgram_hdr_t hdr;
566   session_t *app_session;
567   u32 wrote = 0;
568   int read, rv;
569   u8 *buf;
570
571   if (PREDICT_FALSE (SSL_in_init (oc->ssl)))
572     {
573       u32 us_index = us->session_index;
574       if (openssl_ctx_handshake_rx (ctx, us) < 0)
575         return 0;
576       /* Session pool might grow when allocating the app's session */
577       us = session_get (us_index, ctx->c_thread_index);
578     }
579
580   buf = om->rx_bufs[ctx->c_thread_index];
581   app_session = session_get_from_handle (ctx->app_session_handle);
582   svm_fifo_fill_chunk_list (app_session->rx_fifo);
583
584   while (svm_fifo_max_dequeue_cons (us->rx_fifo) > 0)
585     {
586       if (svm_fifo_max_enqueue_prod (app_session->rx_fifo) < DTLSO_MAX_DGRAM)
587         {
588           tls_add_vpp_q_builtin_rx_evt (us);
589           goto done;
590         }
591
592       read = SSL_read (oc->ssl, buf, vec_len (buf));
593       if (PREDICT_FALSE (read <= 0))
594         {
595           if (read < 0)
596             tls_add_vpp_q_builtin_rx_evt (us);
597           goto done;
598         }
599       wrote += read;
600
601       hdr.data_length = read;
602       hdr.data_offset = 0;
603
604       svm_fifo_seg_t segs[2] = { { (u8 *) &hdr, sizeof (hdr) },
605                                  { buf, read } };
606
607       rv = svm_fifo_enqueue_segments (app_session->rx_fifo, segs, 2,
608                                       0 /* allow partial */);
609       ASSERT (rv > 0);
610     }
611
612 done:
613
614   /* If handshake just completed, session may still be in accepting state */
615   if (app_session->session_state >= SESSION_STATE_READY)
616     tls_notify_app_enqueue (ctx, app_session);
617
618   return wrote;
619 }
620
621 static inline int
622 openssl_ctx_read (tls_ctx_t *ctx, session_t *ts)
623 {
624   if (ctx->tls_type == TRANSPORT_PROTO_TLS)
625     return openssl_ctx_read_tls (ctx, ts);
626   else
627     return openssl_ctx_read_dtls (ctx, ts);
628 }
629
630 static int
631 openssl_ctx_init_client (tls_ctx_t * ctx)
632 {
633   long flags = SSL_OP_NO_SSLv2 | SSL_OP_NO_SSLv3 | SSL_OP_NO_COMPRESSION;
634   openssl_ctx_t *oc = (openssl_ctx_t *) ctx;
635   openssl_main_t *om = &openssl_main;
636   const SSL_METHOD *method;
637   int rv, err;
638
639   method = ctx->tls_type == TRANSPORT_PROTO_TLS ? SSLv23_client_method () :
640                                                   DTLS_client_method ();
641   if (method == NULL)
642     {
643       TLS_DBG (1, "(D)TLS_method returned null");
644       return -1;
645     }
646
647   oc->ssl_ctx = SSL_CTX_new (method);
648   if (oc->ssl_ctx == NULL)
649     {
650       TLS_DBG (1, "SSL_CTX_new returned null");
651       return -1;
652     }
653
654   SSL_CTX_set_ecdh_auto (oc->ssl_ctx, 1);
655   SSL_CTX_set_mode (oc->ssl_ctx, SSL_MODE_ENABLE_PARTIAL_WRITE);
656 #ifdef HAVE_OPENSSL_ASYNC
657   if (om->async)
658     SSL_CTX_set_mode (oc->ssl_ctx, SSL_MODE_ASYNC);
659 #endif
660   rv = SSL_CTX_set_cipher_list (oc->ssl_ctx, (const char *) om->ciphers);
661   if (rv != 1)
662     {
663       TLS_DBG (1, "Couldn't set cipher");
664       return -1;
665     }
666
667   SSL_CTX_set_options (oc->ssl_ctx, flags);
668   SSL_CTX_set_cert_store (oc->ssl_ctx, om->cert_store);
669
670   oc->ssl = SSL_new (oc->ssl_ctx);
671   if (oc->ssl == NULL)
672     {
673       TLS_DBG (1, "Couldn't initialize ssl struct");
674       return -1;
675     }
676
677   if (ctx->tls_type == TRANSPORT_PROTO_TLS)
678     {
679       oc->rbio = BIO_new_tls (ctx->tls_session_handle);
680       oc->wbio = BIO_new_tls (ctx->tls_session_handle);
681     }
682   else
683     {
684       oc->rbio = BIO_new_dtls (ctx->tls_session_handle);
685       oc->wbio = BIO_new_dtls (ctx->tls_session_handle);
686     }
687
688   SSL_set_bio (oc->ssl, oc->wbio, oc->rbio);
689   SSL_set_connect_state (oc->ssl);
690
691   rv = SSL_set_tlsext_host_name (oc->ssl, ctx->srv_hostname);
692   if (rv != 1)
693     {
694       TLS_DBG (1, "Couldn't set hostname");
695       return -1;
696     }
697
698   /*
699    * 2. Do the first steps in the handshake.
700    */
701   TLS_DBG (1, "Initiating handshake for [%u]%u", ctx->c_thread_index,
702            oc->openssl_ctx_index);
703
704 #ifdef HAVE_OPENSSL_ASYNC
705   session_t *tls_session = session_get_from_handle (ctx->tls_session_handle);
706   vpp_tls_async_init_event (ctx, openssl_ctx_handshake_rx, tls_session);
707 #endif
708   while (1)
709     {
710       rv = SSL_do_handshake (oc->ssl);
711       err = SSL_get_error (oc->ssl, rv);
712 #ifdef HAVE_OPENSSL_ASYNC
713       if (err == SSL_ERROR_WANT_ASYNC)
714         {
715           openssl_check_async_status (ctx, openssl_ctx_handshake_rx,
716                                       tls_session);
717           break;
718         }
719 #endif
720       if (err != SSL_ERROR_WANT_WRITE)
721         break;
722     }
723
724   TLS_DBG (2, "tls state for [%u]%u is su", ctx->c_thread_index,
725            oc->openssl_ctx_index, SSL_state_string_long (oc->ssl));
726   return 0;
727 }
728
729 static int
730 openssl_start_listen (tls_ctx_t * lctx)
731 {
732   const SSL_METHOD *method;
733   SSL_CTX *ssl_ctx;
734   int rv;
735   BIO *cert_bio;
736   X509 *srvcert;
737   EVP_PKEY *pkey;
738   u32 olc_index;
739   openssl_listen_ctx_t *olc;
740   app_cert_key_pair_t *ckpair;
741
742   long flags = SSL_OP_NO_SSLv2 | SSL_OP_NO_SSLv3 | SSL_OP_NO_COMPRESSION;
743   openssl_main_t *om = &openssl_main;
744
745   ckpair = app_cert_key_pair_get_if_valid (lctx->ckpair_index);
746   if (!ckpair)
747     return -1;
748
749   if (!ckpair->cert || !ckpair->key)
750     {
751       TLS_DBG (1, "tls cert and/or key not configured %d",
752                lctx->parent_app_wrk_index);
753       return -1;
754     }
755
756   method = lctx->tls_type == TRANSPORT_PROTO_TLS ? SSLv23_server_method () :
757                                                    DTLS_server_method ();
758   ssl_ctx = SSL_CTX_new (method);
759   if (!ssl_ctx)
760     {
761       clib_warning ("Unable to create SSL context");
762       return -1;
763     }
764
765   SSL_CTX_set_mode (ssl_ctx, SSL_MODE_ENABLE_PARTIAL_WRITE);
766 #ifdef HAVE_OPENSSL_ASYNC
767   if (om->async)
768     {
769       SSL_CTX_set_mode (ssl_ctx, SSL_MODE_ASYNC);
770       SSL_CTX_set_async_callback (ssl_ctx, tls_async_openssl_callback);
771     }
772 #endif
773   SSL_CTX_set_options (ssl_ctx, flags);
774   SSL_CTX_set_ecdh_auto (ssl_ctx, 1);
775
776   rv = SSL_CTX_set_cipher_list (ssl_ctx, (const char *) om->ciphers);
777   if (rv != 1)
778     {
779       TLS_DBG (1, "Couldn't set cipher");
780       return -1;
781     }
782
783   /* use the default OpenSSL built-in DH parameters */
784   rv = SSL_CTX_set_dh_auto (ssl_ctx, 1);
785   if (rv != 1)
786     {
787       TLS_DBG (1, "Couldn't set temp DH parameters");
788       return -1;
789     }
790
791   /*
792    * Set the key and cert
793    */
794   cert_bio = BIO_new (BIO_s_mem ());
795   if (!cert_bio)
796     {
797       clib_warning ("unable to allocate memory");
798       return -1;
799     }
800   BIO_write (cert_bio, ckpair->cert, vec_len (ckpair->cert));
801   srvcert = PEM_read_bio_X509 (cert_bio, NULL, NULL, NULL);
802   if (!srvcert)
803     {
804       clib_warning ("unable to parse certificate");
805       goto err;
806     }
807   rv = SSL_CTX_use_certificate (ssl_ctx, srvcert);
808   if (rv != 1)
809     {
810       clib_warning ("unable to use SSL certificate");
811       goto err;
812     }
813
814   BIO_free (cert_bio);
815
816   cert_bio = BIO_new (BIO_s_mem ());
817   if (!cert_bio)
818     {
819       clib_warning ("unable to allocate memory");
820       return -1;
821     }
822   BIO_write (cert_bio, ckpair->key, vec_len (ckpair->key));
823   pkey = PEM_read_bio_PrivateKey (cert_bio, NULL, NULL, NULL);
824   if (!pkey)
825     {
826       clib_warning ("unable to parse pkey");
827       goto err;
828     }
829   rv = SSL_CTX_use_PrivateKey (ssl_ctx, pkey);
830   if (rv != 1)
831     {
832       clib_warning ("unable to use SSL PrivateKey");
833       goto err;
834     }
835
836   BIO_free (cert_bio);
837
838   olc_index = openssl_listen_ctx_alloc ();
839   olc = openssl_lctx_get (olc_index);
840   olc->ssl_ctx = ssl_ctx;
841   olc->srvcert = srvcert;
842   olc->pkey = pkey;
843
844   /* store SSL_CTX into TLS level structure */
845   lctx->tls_ssl_ctx = olc_index;
846
847   return 0;
848
849 err:
850   if (cert_bio)
851     BIO_free (cert_bio);
852   return -1;
853 }
854
855 static int
856 openssl_stop_listen (tls_ctx_t * lctx)
857 {
858   u32 olc_index;
859   openssl_listen_ctx_t *olc;
860
861   olc_index = lctx->tls_ssl_ctx;
862   olc = openssl_lctx_get (olc_index);
863
864   X509_free (olc->srvcert);
865   EVP_PKEY_free (olc->pkey);
866
867   SSL_CTX_free (olc->ssl_ctx);
868   openssl_listen_ctx_free (olc);
869
870   return 0;
871 }
872
873 static int
874 openssl_ctx_init_server (tls_ctx_t * ctx)
875 {
876   openssl_ctx_t *oc = (openssl_ctx_t *) ctx;
877   u32 olc_index = ctx->tls_ssl_ctx;
878   openssl_listen_ctx_t *olc;
879   int rv, err;
880
881   /* Start a new connection */
882
883   olc = openssl_lctx_get (olc_index);
884   oc->ssl = SSL_new (olc->ssl_ctx);
885   if (oc->ssl == NULL)
886     {
887       TLS_DBG (1, "Couldn't initialize ssl struct");
888       return -1;
889     }
890
891   if (ctx->tls_type == TRANSPORT_PROTO_TLS)
892     {
893       oc->rbio = BIO_new_tls (ctx->tls_session_handle);
894       oc->wbio = BIO_new_tls (ctx->tls_session_handle);
895     }
896   else
897     {
898       oc->rbio = BIO_new_dtls (ctx->tls_session_handle);
899       oc->wbio = BIO_new_dtls (ctx->tls_session_handle);
900     }
901
902   SSL_set_bio (oc->ssl, oc->wbio, oc->rbio);
903   SSL_set_accept_state (oc->ssl);
904
905   TLS_DBG (1, "Initiating handshake for [%u]%u", ctx->c_thread_index,
906            oc->openssl_ctx_index);
907
908 #ifdef HAVE_OPENSSL_ASYNC
909   session_t *tls_session = session_get_from_handle (ctx->tls_session_handle);
910   vpp_tls_async_init_event (ctx, openssl_ctx_handshake_rx, tls_session);
911 #endif
912   while (1)
913     {
914       rv = SSL_do_handshake (oc->ssl);
915       err = SSL_get_error (oc->ssl, rv);
916 #ifdef HAVE_OPENSSL_ASYNC
917       if (err == SSL_ERROR_WANT_ASYNC)
918         {
919           openssl_check_async_status (ctx, openssl_ctx_handshake_rx,
920                                       tls_session);
921           break;
922         }
923 #endif
924       if (err != SSL_ERROR_WANT_WRITE)
925         break;
926     }
927
928   TLS_DBG (2, "tls state for [%u]%u is su", ctx->c_thread_index,
929            oc->openssl_ctx_index, SSL_state_string_long (oc->ssl));
930   return 0;
931 }
932
933 static u8
934 openssl_handshake_is_over (tls_ctx_t * ctx)
935 {
936   openssl_ctx_t *mc = (openssl_ctx_t *) ctx;
937   if (!mc->ssl)
938     return 0;
939   return SSL_is_init_finished (mc->ssl);
940 }
941
942 static int
943 openssl_transport_close (tls_ctx_t * ctx)
944 {
945 #ifdef HAVE_OPENSSL_ASYNC
946   if (vpp_openssl_is_inflight (ctx))
947     return 0;
948 #endif
949
950   if (!openssl_handshake_is_over (ctx))
951     {
952       openssl_handle_handshake_failure (ctx);
953       return 0;
954     }
955   session_transport_closing_notify (&ctx->connection);
956   return 0;
957 }
958
959 static int
960 openssl_app_close (tls_ctx_t * ctx)
961 {
962   openssl_ctx_t *oc = (openssl_ctx_t *) ctx;
963   session_t *app_session;
964
965   /* Wait for all data to be written to tcp */
966   app_session = session_get_from_handle (ctx->app_session_handle);
967   if (BIO_ctrl_pending (oc->rbio) <= 0
968       && !svm_fifo_max_dequeue_cons (app_session->tx_fifo))
969     openssl_confirm_app_close (ctx);
970   else
971     ctx->app_closed = 1;
972   return 0;
973 }
974
975 const static tls_engine_vft_t openssl_engine = {
976   .ctx_alloc = openssl_ctx_alloc,
977   .ctx_alloc_w_thread = openssl_ctx_alloc_w_thread,
978   .ctx_free = openssl_ctx_free,
979   .ctx_attach = openssl_ctx_attach,
980   .ctx_detach = openssl_ctx_detach,
981   .ctx_get = openssl_ctx_get,
982   .ctx_get_w_thread = openssl_ctx_get_w_thread,
983   .ctx_init_server = openssl_ctx_init_server,
984   .ctx_init_client = openssl_ctx_init_client,
985   .ctx_write = openssl_ctx_write,
986   .ctx_read = openssl_ctx_read,
987   .ctx_handshake_is_over = openssl_handshake_is_over,
988   .ctx_start_listen = openssl_start_listen,
989   .ctx_stop_listen = openssl_stop_listen,
990   .ctx_transport_close = openssl_transport_close,
991   .ctx_app_close = openssl_app_close,
992 };
993
994 int
995 tls_init_ca_chain (void)
996 {
997   openssl_main_t *om = &openssl_main;
998   tls_main_t *tm = vnet_tls_get_main ();
999   BIO *cert_bio;
1000   X509 *testcert;
1001   int rv;
1002
1003   if (access (tm->ca_cert_path, F_OK | R_OK) == -1)
1004     {
1005       clib_warning ("Could not initialize TLS CA certificates");
1006       return -1;
1007     }
1008
1009   if (!(om->cert_store = X509_STORE_new ()))
1010     {
1011       clib_warning ("failed to create cert store");
1012       return -1;
1013     }
1014
1015 #if OPENSSL_VERSION_NUMBER >= 0x30000000L
1016   rv = X509_STORE_load_file (om->cert_store, tm->ca_cert_path);
1017 #else
1018   rv = X509_STORE_load_locations (om->cert_store, tm->ca_cert_path, 0);
1019 #endif
1020
1021   if (rv < 0)
1022     {
1023       clib_warning ("failed to load ca certificate");
1024     }
1025
1026   if (tm->use_test_cert_in_ca)
1027     {
1028       cert_bio = BIO_new (BIO_s_mem ());
1029       BIO_write (cert_bio, test_srv_crt_rsa, test_srv_crt_rsa_len);
1030       testcert = PEM_read_bio_X509 (cert_bio, NULL, NULL, NULL);
1031       if (!testcert)
1032         {
1033           clib_warning ("unable to parse certificate");
1034           return -1;
1035         }
1036       X509_STORE_add_cert (om->cert_store, testcert);
1037       rv = 0;
1038     }
1039   return (rv < 0 ? -1 : 0);
1040 }
1041
1042 int
1043 tls_openssl_set_ciphers (char *ciphers)
1044 {
1045   openssl_main_t *om = &openssl_main;
1046   int i;
1047
1048   if (!ciphers)
1049     {
1050       return -1;
1051     }
1052
1053   vec_validate (om->ciphers, strlen (ciphers) - 1);
1054   for (i = 0; i < vec_len (om->ciphers); i++)
1055     {
1056       om->ciphers[i] = toupper (ciphers[i]);
1057     }
1058
1059   return 0;
1060
1061 }
1062
1063 static clib_error_t *
1064 tls_openssl_init (vlib_main_t * vm)
1065 {
1066   vlib_thread_main_t *vtm = vlib_get_thread_main ();
1067   openssl_main_t *om = &openssl_main;
1068   clib_error_t *error = 0;
1069   u32 num_threads, i;
1070
1071   error = tls_openssl_api_init (vm);
1072   num_threads = 1 /* main thread */  + vtm->n_threads;
1073
1074   SSL_library_init ();
1075   SSL_load_error_strings ();
1076
1077   if (tls_init_ca_chain ())
1078     {
1079       clib_warning ("failed to initialize TLS CA chain");
1080       return 0;
1081     }
1082
1083   vec_validate (om->ctx_pool, num_threads - 1);
1084   vec_validate (om->rx_bufs, num_threads - 1);
1085   vec_validate (om->tx_bufs, num_threads - 1);
1086   for (i = 0; i < num_threads; i++)
1087     {
1088       vec_validate (om->rx_bufs[i], DTLSO_MAX_DGRAM);
1089       vec_validate (om->tx_bufs[i], DTLSO_MAX_DGRAM);
1090     }
1091   tls_register_engine (&openssl_engine, CRYPTO_ENGINE_OPENSSL);
1092
1093   om->engine_init = 0;
1094
1095   /* default ciphers */
1096   tls_openssl_set_ciphers
1097     ("ALL:!ADH:!LOW:!EXP:!MD5:!RC4-SHA:!DES-CBC3-SHA:@STRENGTH");
1098
1099   return error;
1100 }
1101 /* *INDENT-OFF* */
1102 VLIB_INIT_FUNCTION (tls_openssl_init) =
1103 {
1104   .runs_after = VLIB_INITS("tls_init"),
1105 };
1106 /* *INDENT-ON* */
1107
1108 #ifdef HAVE_OPENSSL_ASYNC
1109 static clib_error_t *
1110 tls_openssl_set_command_fn (vlib_main_t * vm, unformat_input_t * input,
1111                             vlib_cli_command_t * cmd)
1112 {
1113   openssl_main_t *om = &openssl_main;
1114   char *engine_name = NULL;
1115   char *engine_alg = NULL;
1116   char *ciphers = NULL;
1117   u8 engine_name_set = 0;
1118   int i, async = 0;
1119
1120   /* By present, it is not allowed to configure engine again after running */
1121   if (om->engine_init)
1122     {
1123       clib_warning ("engine has started!\n");
1124       return clib_error_return
1125         (0, "engine has started, and no config is accepted");
1126     }
1127
1128   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1129     {
1130       if (unformat (input, "engine %s", &engine_name))
1131         {
1132           engine_name_set = 1;
1133         }
1134       else if (unformat (input, "async"))
1135         {
1136           async = 1;
1137         }
1138       else if (unformat (input, "alg %s", &engine_alg))
1139         {
1140           for (i = 0; i < strnlen (engine_alg, MAX_CRYPTO_LEN); i++)
1141             engine_alg[i] = toupper (engine_alg[i]);
1142         }
1143       else if (unformat (input, "ciphers %s", &ciphers))
1144         {
1145           tls_openssl_set_ciphers (ciphers);
1146         }
1147       else
1148         return clib_error_return (0, "failed: unknown input `%U'",
1149                                   format_unformat_error, input);
1150     }
1151
1152   /* reset parameters if engine is not configured */
1153   if (!engine_name_set)
1154     {
1155       clib_warning ("No engine provided! \n");
1156       async = 0;
1157     }
1158   else
1159     {
1160       vnet_session_enable_disable (vm, 1);
1161       if (openssl_engine_register (engine_name, engine_alg, async) < 0)
1162         {
1163           return clib_error_return (0, "Failed to register %s polling",
1164                                     engine_name);
1165         }
1166       else
1167         {
1168           vlib_cli_output (vm, "Successfully register engine %s\n",
1169                            engine_name);
1170         }
1171     }
1172   om->async = async;
1173
1174   return 0;
1175 }
1176
1177 /* *INDENT-OFF* */
1178 VLIB_CLI_COMMAND (tls_openssl_set_command, static) =
1179 {
1180   .path = "tls openssl set",
1181   .short_help = "tls openssl set [engine <engine name>] [alg [algorithm] [async]",
1182   .function = tls_openssl_set_command_fn,
1183 };
1184 /* *INDENT-ON* */
1185 #endif
1186
1187 /* *INDENT-OFF* */
1188 VLIB_PLUGIN_REGISTER () = {
1189     .version = VPP_BUILD_VER,
1190     .description = "Transport Layer Security (TLS) Engine, OpenSSL Based",
1191 };
1192 /* *INDENT-ON* */
1193
1194 /*
1195  * fd.io coding-style-patch-verification: ON
1196  *
1197  * Local Variables:
1198  * eval: (c-set-style "gnu")
1199  * End:
1200  */