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