src/vnet/crypto/crypto.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 <stdbool.h>
  17 #include <vlib/vlib.h>
  18 #include <vnet/crypto/crypto.h>
  19
  20 vnet_crypto_main_t crypto_main;
  21
  22 static_always_inline u32
  23 vnet_crypto_process_ops_call_handler (vlib_main_t * vm,
  24                                       vnet_crypto_main_t * cm,
  25                                       vnet_crypto_op_id_t opt,
  26                                       vnet_crypto_op_t * ops[], u32 n_ops)
  27 {
  28   if (n_ops == 0)
  29     return 0;
  30
  31   if (cm->ops_handlers[opt] == 0)
  32     {
  33       while (n_ops--)
  34         {
  35           ops[0]->status = VNET_CRYPTO_OP_STATUS_FAIL_NO_HANDLER;
  36           ops++;
  37         }
  38       return 0;
  39     }
  40
  41   return (cm->ops_handlers[opt]) (vm, ops, n_ops);
  42 }
  43
  44
  45 u32
  46 vnet_crypto_process_ops (vlib_main_t * vm, vnet_crypto_op_t ops[], u32 n_ops)
  47 {
  48   vnet_crypto_main_t *cm = &crypto_main;
  49   const int op_q_size = VLIB_FRAME_SIZE;
  50   vnet_crypto_op_t *op_queue[op_q_size];
  51   vnet_crypto_op_id_t opt, current_op_type = ~0;
  52   u32 n_op_queue = 0;
  53   u32 rv = 0, i;
  54
  55   ASSERT (n_ops >= 1);
  56
  57   for (i = 0; i < n_ops; i++)
  58     {
  59       opt = ops[i].op;
  60
  61       if (current_op_type != opt || n_op_queue >= op_q_size)
  62         {
  63           rv += vnet_crypto_process_ops_call_handler (vm, cm, current_op_type,
  64                                                       op_queue, n_op_queue);
  65           n_op_queue = 0;
  66           current_op_type = opt;
  67         }
  68
  69       op_queue[n_op_queue++] = &ops[i];
  70     }
  71
  72   rv += vnet_crypto_process_ops_call_handler (vm, cm, current_op_type,
  73                                               op_queue, n_op_queue);
  74   return rv;
  75 }
  76
  77 u32
  78 vnet_crypto_register_engine (vlib_main_t * vm, char *name, int prio,
  79                              char *desc)
  80 {
  81   vnet_crypto_main_t *cm = &crypto_main;
  82   vnet_crypto_engine_t *p;
  83
  84   vec_add2 (cm->engines, p, 1);
  85   p->name = name;
  86   p->desc = desc;
  87   p->priority = prio;
  88
  89   hash_set_mem (cm->engine_index_by_name, p->name, p - cm->engines);
  90
  91   return p - cm->engines;
  92 }
  93
  94 int
  95 vnet_crypto_set_handler (char *alg_name, char *engine)
  96 {
  97   uword *p;
  98   vnet_crypto_main_t *cm = &crypto_main;
  99   vnet_crypto_alg_data_t *ad;
 100   vnet_crypto_engine_t *ce;
 101   int i;
 102
 103   p = hash_get_mem (cm->alg_index_by_name, alg_name);
 104   if (!p)
 105     return -1;
 106
 107   ad = vec_elt_at_index (cm->algs, p[0]);
 108
 109   p = hash_get_mem (cm->engine_index_by_name, engine);
 110   if (!p)
 111     return -1;
 112
 113   ce = vec_elt_at_index (cm->engines, p[0]);
 114
 115   for (i = 0; i < VNET_CRYPTO_OP_N_TYPES; i++)
 116     {
 117       vnet_crypto_op_data_t *od;
 118       vnet_crypto_op_id_t id = ad->op_by_type[i];
 119       if (id == 0)
 120         continue;
 121       od = vec_elt_at_index (cm->opt_data, id);
 122       if (ce->ops_handlers[id])
 123         {
 124           od->active_engine_index = p[0];
 125           cm->ops_handlers[id] = ce->ops_handlers[id];
 126         }
 127     }
 128
 129   return 0;
 130 }
 131
 132 int
 133 vnet_crypto_is_set_handler (vnet_crypto_alg_t alg)
 134 {
 135   vnet_crypto_main_t *cm = &crypto_main;
 136
 137   return (NULL != cm->ops_handlers[alg]);
 138 }
 139
 140 void
 141 vnet_crypto_register_ops_handler (vlib_main_t * vm, u32 engine_index,
 142                                   vnet_crypto_op_id_t opt,
 143                                   vnet_crypto_ops_handler_t * fn)
 144 {
 145   vnet_crypto_main_t *cm = &crypto_main;
 146   vnet_crypto_engine_t *ae, *e = vec_elt_at_index (cm->engines, engine_index);
 147   vnet_crypto_op_data_t *otd = cm->opt_data + opt;
 148   vec_validate_aligned (cm->ops_handlers, VNET_CRYPTO_N_OP_IDS - 1,
 149                         CLIB_CACHE_LINE_BYTES);
 150   e->ops_handlers[opt] = fn;
 151
 152   if (otd->active_engine_index == ~0)
 153     {
 154       otd->active_engine_index = engine_index;
 155       cm->ops_handlers[opt] = fn;
 156       return;
 157     }
 158   ae = vec_elt_at_index (cm->engines, otd->active_engine_index);
 159   if (ae->priority < e->priority)
 160     {
 161       otd->active_engine_index = engine_index;
 162       cm->ops_handlers[opt] = fn;
 163     }
 164
 165   return;
 166 }
 167
 168 void
 169 vnet_crypto_register_key_handler (vlib_main_t * vm, u32 engine_index,
 170                                   vnet_crypto_key_handler_t * key_handler)
 171 {
 172   vnet_crypto_main_t *cm = &crypto_main;
 173   vnet_crypto_engine_t *e = vec_elt_at_index (cm->engines, engine_index);
 174   e->key_op_handler = key_handler;
 175   return;
 176 }
 177
 178 static int
 179 vnet_crypto_key_len_check (vnet_crypto_alg_t alg, u16 length)
 180 {
 181   switch (alg)
 182     {
 183     case VNET_CRYPTO_N_ALGS:
 184       return 0;
 185     case VNET_CRYPTO_ALG_NONE:
 186       return 1;
 187
 188 #define _(n, s, l) \
 189       case VNET_CRYPTO_ALG_##n: \
 190         if ((l) == length) \
 191           return 1;        \
 192         break;
 193       foreach_crypto_cipher_alg foreach_crypto_aead_alg
 194 #undef _
 195         /* HMAC allows any key length */
 196 #define _(n, s) \
 197       case VNET_CRYPTO_ALG_HMAC_##n: \
 198         return 1;
 199         foreach_crypto_hmac_alg
 200 #undef _
 201     }
 202
 203   return 0;
 204 }
 205
 206 u32
 207 vnet_crypto_key_add (vlib_main_t * vm, vnet_crypto_alg_t alg, u8 * data,
 208                      u16 length)
 209 {
 210   u32 index;
 211   vnet_crypto_main_t *cm = &crypto_main;
 212   vnet_crypto_engine_t *engine;
 213   vnet_crypto_key_t *key;
 214
 215   if (!vnet_crypto_key_len_check (alg, length))
 216     return ~0;
 217
 218   pool_get_zero (cm->keys, key);
 219   index = key - cm->keys;
 220   key->alg = alg;
 221   vec_validate_aligned (key->data, length - 1, CLIB_CACHE_LINE_BYTES);
 222   clib_memcpy (key->data, data, length);
 223
 224   /* *INDENT-OFF* */
 225   vec_foreach (engine, cm->engines)
 226     if (engine->key_op_handler)
 227       engine->key_op_handler (vm, VNET_CRYPTO_KEY_OP_ADD, index);
 228   /* *INDENT-ON* */
 229   return index;
 230 }
 231
 232 void
 233 vnet_crypto_key_del (vlib_main_t * vm, vnet_crypto_key_index_t index)
 234 {
 235   vnet_crypto_main_t *cm = &crypto_main;
 236   vnet_crypto_engine_t *engine;
 237   vnet_crypto_key_t *key = pool_elt_at_index (cm->keys, index);
 238
 239   /* *INDENT-OFF* */
 240   vec_foreach (engine, cm->engines)
 241     if (engine->key_op_handler)
 242       engine->key_op_handler (vm, VNET_CRYPTO_KEY_OP_DEL, index);
 243   /* *INDENT-ON* */
 244
 245   clib_memset (key->data, 0, vec_len (key->data));
 246   vec_free (key->data);
 247   pool_put (cm->keys, key);
 248 }
 249
 250 static void
 251 vnet_crypto_init_cipher_data (vnet_crypto_alg_t alg, vnet_crypto_op_id_t eid,
 252                               vnet_crypto_op_id_t did, char *name, u8 is_aead)
 253 {
 254   vnet_crypto_op_type_t eopt, dopt;
 255   vnet_crypto_main_t *cm = &crypto_main;
 256   cm->algs[alg].name = name;
 257   cm->opt_data[eid].alg = cm->opt_data[did].alg = alg;
 258   cm->opt_data[eid].active_engine_index = ~0;
 259   cm->opt_data[did].active_engine_index = ~0;
 260   if (is_aead)
 261     {
 262       eopt = VNET_CRYPTO_OP_TYPE_AEAD_ENCRYPT;
 263       dopt = VNET_CRYPTO_OP_TYPE_AEAD_DECRYPT;
 264     }
 265   else
 266     {
 267       eopt = VNET_CRYPTO_OP_TYPE_ENCRYPT;
 268       dopt = VNET_CRYPTO_OP_TYPE_DECRYPT;
 269     }
 270   cm->opt_data[eid].type = eopt;
 271   cm->opt_data[did].type = dopt;
 272   cm->algs[alg].op_by_type[eopt] = eid;
 273   cm->algs[alg].op_by_type[dopt] = did;
 274   hash_set_mem (cm->alg_index_by_name, name, alg);
 275 }
 276
 277 static void
 278 vnet_crypto_init_hmac_data (vnet_crypto_alg_t alg,
 279                             vnet_crypto_op_id_t id, char *name)
 280 {
 281   vnet_crypto_main_t *cm = &crypto_main;
 282   cm->algs[alg].name = name;
 283   cm->algs[alg].op_by_type[VNET_CRYPTO_OP_TYPE_HMAC] = id;
 284   cm->opt_data[id].alg = alg;
 285   cm->opt_data[id].active_engine_index = ~0;
 286   cm->opt_data[id].type = VNET_CRYPTO_OP_TYPE_HMAC;
 287   hash_set_mem (cm->alg_index_by_name, name, alg);
 288 }
 289
 290 clib_error_t *
 291 vnet_crypto_init (vlib_main_t * vm)
 292 {
 293   vnet_crypto_main_t *cm = &crypto_main;
 294   vlib_thread_main_t *tm = vlib_get_thread_main ();
 295   cm->engine_index_by_name = hash_create_string ( /* size */ 0,
 296                                                  sizeof (uword));
 297   cm->alg_index_by_name = hash_create_string (0, sizeof (uword));
 298   vec_validate_aligned (cm->threads, tm->n_vlib_mains, CLIB_CACHE_LINE_BYTES);
 299   vec_validate (cm->algs, VNET_CRYPTO_N_ALGS);
 300 #define _(n, s, l) \
 301   vnet_crypto_init_cipher_data (VNET_CRYPTO_ALG_##n, \
 302                                 VNET_CRYPTO_OP_##n##_ENC, \
 303                                 VNET_CRYPTO_OP_##n##_DEC, s, 0);
 304   foreach_crypto_cipher_alg;
 305 #undef _
 306 #define _(n, s, l) \
 307   vnet_crypto_init_cipher_data (VNET_CRYPTO_ALG_##n, \
 308                                 VNET_CRYPTO_OP_##n##_ENC, \
 309                                 VNET_CRYPTO_OP_##n##_DEC, s, 1);
 310   foreach_crypto_aead_alg;
 311 #undef _
 312 #define _(n, s) \
 313   vnet_crypto_init_hmac_data (VNET_CRYPTO_ALG_HMAC_##n, \
 314                               VNET_CRYPTO_OP_##n##_HMAC, "hmac-" s);
 315   foreach_crypto_hmac_alg;
 316 #undef _
 317   return 0;
 318 }
 319
 320 VLIB_INIT_FUNCTION (vnet_crypto_init);
 321
 322 /*
 323  * fd.io coding-style-patch-verification: ON
 324  *
 325  * Local Variables:
 326  * eval: (c-set-style "gnu")
 327  * End:
 328  */