src/plugins/crypto_openssl/main.c

   1 /*
   2  *------------------------------------------------------------------
   3  * Copyright (c) 2019 Cisco and/or its affiliates.
   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
  18 #include <openssl/evp.h>
  19 #include <openssl/hmac.h>
  20 #include <openssl/rand.h>
  21
  22 #include <vlib/vlib.h>
  23 #include <vnet/plugin/plugin.h>
  24 #include <vnet/crypto/crypto.h>
  25 #include <vpp/app/version.h>
  26
  27 typedef struct
  28 {
  29   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
  30   EVP_CIPHER_CTX *evp_cipher_ctx;
  31   HMAC_CTX *hmac_ctx;
  32 #if OPENSSL_VERSION_NUMBER < 0x10100000L
  33   HMAC_CTX _hmac_ctx;
  34 #endif
  35 } openssl_per_thread_data_t;
  36
  37 static openssl_per_thread_data_t *per_thread_data = 0;
  38
  39 #define foreach_openssl_evp_op \
  40   _(cbc, DES_CBC, EVP_des_cbc) \
  41   _(cbc, 3DES_CBC, EVP_des_ede3_cbc) \
  42   _(cbc, AES_128_CBC, EVP_aes_128_cbc) \
  43   _(cbc, AES_192_CBC, EVP_aes_192_cbc) \
  44   _(cbc, AES_256_CBC, EVP_aes_256_cbc) \
  45   _(gcm, AES_128_GCM, EVP_aes_128_gcm) \
  46   _(gcm, AES_192_GCM, EVP_aes_192_gcm) \
  47   _(gcm, AES_256_GCM, EVP_aes_256_gcm) \
  48   _(cbc, AES_128_CTR, EVP_aes_128_ctr) \
  49   _(cbc, AES_192_CTR, EVP_aes_192_ctr) \
  50   _(cbc, AES_256_CTR, EVP_aes_256_ctr) \
  51
  52 #define foreach_openssl_hmac_op \
  53   _(MD5, EVP_md5) \
  54   _(SHA1, EVP_sha1) \
  55   _(SHA224, EVP_sha224) \
  56   _(SHA256, EVP_sha256) \
  57   _(SHA384, EVP_sha384) \
  58   _(SHA512, EVP_sha512)
  59
  60 static_always_inline u32
  61 openssl_ops_enc_cbc (vlib_main_t * vm, vnet_crypto_op_t * ops[], u32 n_ops,
  62                      const EVP_CIPHER * cipher)
  63 {
  64   openssl_per_thread_data_t *ptd = vec_elt_at_index (per_thread_data,
  65                                                      vm->thread_index);
  66   EVP_CIPHER_CTX *ctx = ptd->evp_cipher_ctx;
  67   u32 i;
  68   for (i = 0; i < n_ops; i++)
  69     {
  70       vnet_crypto_op_t *op = ops[i];
  71       int out_len;
  72
  73       if (op->flags & VNET_CRYPTO_OP_FLAG_INIT_IV)
  74         RAND_bytes (op->iv, 16);
  75
  76       EVP_EncryptInit_ex (ctx, cipher, NULL, op->key, op->iv);
  77       EVP_EncryptUpdate (ctx, op->dst, &out_len, op->src, op->len);
  78       if (out_len < op->len)
  79         EVP_EncryptFinal_ex (ctx, op->dst + out_len, &out_len);
  80       op->status = VNET_CRYPTO_OP_STATUS_COMPLETED;
  81     }
  82   return n_ops;
  83 }
  84
  85 static_always_inline u32
  86 openssl_ops_dec_cbc (vlib_main_t * vm, vnet_crypto_op_t * ops[], u32 n_ops,
  87                      const EVP_CIPHER * cipher)
  88 {
  89   openssl_per_thread_data_t *ptd = vec_elt_at_index (per_thread_data,
  90                                                      vm->thread_index);
  91   EVP_CIPHER_CTX *ctx = ptd->evp_cipher_ctx;
  92   u32 i;
  93   for (i = 0; i < n_ops; i++)
  94     {
  95       vnet_crypto_op_t *op = ops[i];
  96       int out_len;
  97
  98       EVP_DecryptInit_ex (ctx, cipher, NULL, op->key, op->iv);
  99       EVP_DecryptUpdate (ctx, op->dst, &out_len, op->src, op->len);
 100       if (out_len < op->len)
 101         EVP_DecryptFinal_ex (ctx, op->dst + out_len, &out_len);
 102       op->status = VNET_CRYPTO_OP_STATUS_COMPLETED;
 103     }
 104   return n_ops;
 105 }
 106
 107 static_always_inline u32
 108 openssl_ops_enc_gcm (vlib_main_t * vm, vnet_crypto_op_t * ops[], u32 n_ops,
 109                      const EVP_CIPHER * cipher)
 110 {
 111   openssl_per_thread_data_t *ptd = vec_elt_at_index (per_thread_data,
 112                                                      vm->thread_index);
 113   EVP_CIPHER_CTX *ctx = ptd->evp_cipher_ctx;
 114   u32 i;
 115   for (i = 0; i < n_ops; i++)
 116     {
 117       vnet_crypto_op_t *op = ops[i];
 118       int len;
 119
 120       if (op->flags & VNET_CRYPTO_OP_FLAG_INIT_IV)
 121         RAND_bytes (op->iv, op->iv_len);
 122
 123       EVP_EncryptInit_ex (ctx, cipher, 0, 0, 0);
 124       EVP_CIPHER_CTX_ctrl (ctx, EVP_CTRL_GCM_SET_IVLEN, op->iv_len, NULL);
 125       EVP_EncryptInit_ex (ctx, 0, 0, op->key, op->iv);
 126       if (op->aad_len)
 127         EVP_EncryptUpdate (ctx, NULL, &len, op->aad, op->aad_len);
 128       EVP_EncryptUpdate (ctx, op->dst, &len, op->src, op->len);
 129       EVP_EncryptFinal_ex (ctx, op->dst + len, &len);
 130       EVP_CIPHER_CTX_ctrl (ctx, EVP_CTRL_GCM_GET_TAG, op->tag_len, op->tag);
 131       op->status = VNET_CRYPTO_OP_STATUS_COMPLETED;
 132     }
 133   return n_ops;
 134 }
 135
 136 static_always_inline u32
 137 openssl_ops_dec_gcm (vlib_main_t * vm, vnet_crypto_op_t * ops[], u32 n_ops,
 138                      const EVP_CIPHER * cipher)
 139 {
 140   openssl_per_thread_data_t *ptd = vec_elt_at_index (per_thread_data,
 141                                                      vm->thread_index);
 142   EVP_CIPHER_CTX *ctx = ptd->evp_cipher_ctx;
 143   u32 i;
 144   for (i = 0; i < n_ops; i++)
 145     {
 146       vnet_crypto_op_t *op = ops[i];
 147       int len;
 148
 149       EVP_DecryptInit_ex (ctx, cipher, 0, 0, 0);
 150       EVP_CIPHER_CTX_ctrl (ctx, EVP_CTRL_GCM_SET_IVLEN, op->iv_len, 0);
 151       EVP_DecryptInit_ex (ctx, 0, 0, op->key, op->iv);
 152       if (op->aad_len)
 153         EVP_DecryptUpdate (ctx, 0, &len, op->aad, op->aad_len);
 154       EVP_DecryptUpdate (ctx, op->dst, &len, op->src, op->len);
 155       EVP_CIPHER_CTX_ctrl (ctx, EVP_CTRL_GCM_SET_TAG, op->tag_len, op->tag);
 156
 157       if (EVP_DecryptFinal_ex (ctx, op->dst + len, &len) > 0)
 158         op->status = VNET_CRYPTO_OP_STATUS_COMPLETED;
 159       else
 160         op->status = VNET_CRYPTO_OP_STATUS_FAIL_DECRYPT;
 161     }
 162   return n_ops;
 163 }
 164
 165 static_always_inline u32
 166 openssl_ops_hmac (vlib_main_t * vm, vnet_crypto_op_t * ops[], u32 n_ops,
 167                   const EVP_MD * md)
 168 {
 169   u8 buffer[64];
 170   openssl_per_thread_data_t *ptd = vec_elt_at_index (per_thread_data,
 171                                                      vm->thread_index);
 172   HMAC_CTX *ctx = ptd->hmac_ctx;
 173   u32 i, n_fail = 0;
 174   for (i = 0; i < n_ops; i++)
 175     {
 176       vnet_crypto_op_t *op = ops[i];
 177       unsigned int out_len;
 178       size_t sz = op->digest_len ? op->digest_len : EVP_MD_size (md);
 179
 180       HMAC_Init_ex (ctx, op->key, op->key_len, md, NULL);
 181       HMAC_Update (ctx, op->src, op->len);
 182       HMAC_Final (ctx, buffer, &out_len);
 183
 184       if (op->flags & VNET_CRYPTO_OP_FLAG_HMAC_CHECK)
 185         {
 186           if ((memcmp (op->digest, buffer, sz)))
 187             {
 188               n_fail++;
 189               op->status = VNET_CRYPTO_OP_STATUS_FAIL_BAD_HMAC;
 190               continue;
 191             }
 192         }
 193       else
 194         clib_memcpy_fast (op->digest, buffer, sz);
 195       op->status = VNET_CRYPTO_OP_STATUS_COMPLETED;
 196     }
 197   return n_ops - n_fail;
 198 }
 199
 200 #define _(m, a, b) \
 201 static u32 \
 202 openssl_ops_enc_##a (vlib_main_t * vm, vnet_crypto_op_t * ops[], u32 n_ops) \
 203 { return openssl_ops_enc_##m (vm, ops, n_ops, b ()); } \
 204 \
 205 u32 \
 206 openssl_ops_dec_##a (vlib_main_t * vm, vnet_crypto_op_t * ops[], u32 n_ops) \
 207 { return openssl_ops_dec_##m (vm, ops, n_ops, b ()); }
 208
 209 foreach_openssl_evp_op;
 210 #undef _
 211
 212 #define _(a, b) \
 213 static u32 \
 214 openssl_ops_hmac_##a (vlib_main_t * vm, vnet_crypto_op_t * ops[], u32 n_ops) \
 215 { return openssl_ops_hmac (vm, ops, n_ops, b ()); } \
 216
 217 foreach_openssl_hmac_op;
 218 #undef _
 219
 220
 221 clib_error_t *
 222 crypto_openssl_init (vlib_main_t * vm)
 223 {
 224   vlib_thread_main_t *tm = vlib_get_thread_main ();
 225   openssl_per_thread_data_t *ptd;
 226   u8 *seed_data = 0;
 227   clib_error_t *error;
 228   time_t t;
 229   pid_t pid;
 230
 231   if ((error = vlib_call_init_function (vm, vnet_crypto_init)))
 232     return error;
 233
 234   u32 eidx = vnet_crypto_register_engine (vm, "openssl", 50, "OpenSSL");
 235
 236 #define _(m, a, b) \
 237   vnet_crypto_register_ops_handler (vm, eidx, VNET_CRYPTO_OP_##a##_ENC, \
 238                                     openssl_ops_enc_##a); \
 239   vnet_crypto_register_ops_handler (vm, eidx, VNET_CRYPTO_OP_##a##_DEC, \
 240                                     openssl_ops_dec_##a);
 241
 242   foreach_openssl_evp_op;
 243 #undef _
 244
 245 #define _(a, b) \
 246   vnet_crypto_register_ops_handler (vm, eidx, VNET_CRYPTO_OP_##a##_HMAC, \
 247                                     openssl_ops_hmac_##a); \
 248
 249   foreach_openssl_hmac_op;
 250 #undef _
 251
 252   vec_validate_aligned (per_thread_data, tm->n_vlib_mains - 1,
 253                         CLIB_CACHE_LINE_BYTES);
 254
 255   vec_foreach (ptd, per_thread_data)
 256   {
 257     ptd->evp_cipher_ctx = EVP_CIPHER_CTX_new ();
 258 #if OPENSSL_VERSION_NUMBER >= 0x10100000L
 259     ptd->hmac_ctx = HMAC_CTX_new ();
 260 #else
 261     HMAC_CTX_init (&(ptd->_hmac_ctx));
 262     ptd->hmac_ctx = &ptd->_hmac_ctx;
 263 #endif
 264   }
 265
 266   t = time (NULL);
 267   pid = getpid ();
 268   vec_add (seed_data, &t, sizeof (t));
 269   vec_add (seed_data, &pid, sizeof (pid));
 270   vec_add (seed_data, seed_data, sizeof (seed_data));
 271
 272   RAND_seed ((const void *) seed_data, vec_len (seed_data));
 273
 274   vec_free (seed_data);
 275
 276   return 0;
 277 }
 278
 279 VLIB_INIT_FUNCTION (crypto_openssl_init);
 280
 281 /* *INDENT-OFF* */
 282 VLIB_PLUGIN_REGISTER () = {
 283   .version = VPP_BUILD_VER,
 284   .description = "OpenSSL Crypto Engine Plugin",
 285 };
 286 /* *INDENT-ON* */
 287
 288 /*
 289  * fd.io coding-style-patch-verification: ON
 290  *
 291  * Local Variables:
 292  * eval: (c-set-style "gnu")
 293  * End:
 294  */