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:
8 * http://www.apache.org/licenses/LICENSE-2.0
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 *------------------------------------------------------------------
18 #include <openssl/evp.h>
19 #include <openssl/hmac.h>
20 #include <openssl/rand.h>
22 #include <vlib/vlib.h>
23 #include <vnet/plugin/plugin.h>
24 #include <vnet/crypto/crypto.h>
25 #include <vpp/app/version.h>
29 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
30 EVP_CIPHER_CTX *evp_cipher_ctx;
32 #if OPENSSL_VERSION_NUMBER < 0x10100000L
35 } openssl_per_thread_data_t;
37 static openssl_per_thread_data_t *per_thread_data = 0;
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) \
52 #define foreach_openssl_hmac_op \
55 _(SHA224, EVP_sha224) \
56 _(SHA256, EVP_sha256) \
57 _(SHA384, EVP_sha384) \
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)
64 openssl_per_thread_data_t *ptd = vec_elt_at_index (per_thread_data,
66 EVP_CIPHER_CTX *ctx = ptd->evp_cipher_ctx;
68 for (i = 0; i < n_ops; i++)
70 vnet_crypto_op_t *op = ops[i];
73 if (op->flags & VNET_CRYPTO_OP_FLAG_INIT_IV)
74 RAND_bytes (op->iv, 16);
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;
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)
89 openssl_per_thread_data_t *ptd = vec_elt_at_index (per_thread_data,
91 EVP_CIPHER_CTX *ctx = ptd->evp_cipher_ctx;
93 for (i = 0; i < n_ops; i++)
95 vnet_crypto_op_t *op = ops[i];
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;
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)
111 openssl_per_thread_data_t *ptd = vec_elt_at_index (per_thread_data,
113 EVP_CIPHER_CTX *ctx = ptd->evp_cipher_ctx;
115 for (i = 0; i < n_ops; i++)
117 vnet_crypto_op_t *op = ops[i];
121 if (op->flags & VNET_CRYPTO_OP_FLAG_INIT_IV)
122 RAND_bytes (op->iv, 8);
125 clib_memcpy_fast (nonce + 1, op->iv, 8);
127 EVP_EncryptInit_ex (ctx, cipher, 0, 0, 0);
128 EVP_CIPHER_CTX_ctrl (ctx, EVP_CTRL_GCM_SET_IVLEN, 12, NULL);
129 EVP_EncryptInit_ex (ctx, 0, 0, op->key, (u8 *) nonce);
131 EVP_EncryptUpdate (ctx, NULL, &len, op->aad, op->aad_len);
132 EVP_EncryptUpdate (ctx, op->dst, &len, op->src, op->len);
133 EVP_EncryptFinal_ex (ctx, op->dst + len, &len);
134 EVP_CIPHER_CTX_ctrl (ctx, EVP_CTRL_GCM_GET_TAG, op->tag_len, op->tag);
135 op->status = VNET_CRYPTO_OP_STATUS_COMPLETED;
140 static_always_inline u32
141 openssl_ops_dec_gcm (vlib_main_t * vm, vnet_crypto_op_t * ops[], u32 n_ops,
142 const EVP_CIPHER * cipher)
144 openssl_per_thread_data_t *ptd = vec_elt_at_index (per_thread_data,
146 EVP_CIPHER_CTX *ctx = ptd->evp_cipher_ctx;
148 for (i = 0; i < n_ops; i++)
150 vnet_crypto_op_t *op = ops[i];
153 EVP_DecryptInit_ex (ctx, cipher, 0, 0, 0);
154 EVP_CIPHER_CTX_ctrl (ctx, EVP_CTRL_GCM_SET_IVLEN, op->iv_len, 0);
155 EVP_DecryptInit_ex (ctx, 0, 0, op->key, op->iv);
157 EVP_DecryptUpdate (ctx, 0, &len, op->aad, op->aad_len);
158 EVP_DecryptUpdate (ctx, op->dst, &len, op->src, op->len);
159 EVP_CIPHER_CTX_ctrl (ctx, EVP_CTRL_GCM_SET_TAG, op->tag_len, op->tag);
161 if (EVP_DecryptFinal_ex (ctx, op->dst + len, &len) > 0)
162 op->status = VNET_CRYPTO_OP_STATUS_COMPLETED;
166 op->status = VNET_CRYPTO_OP_STATUS_FAIL_DECRYPT;
169 return n_ops - n_fail;
172 static_always_inline u32
173 openssl_ops_hmac (vlib_main_t * vm, vnet_crypto_op_t * ops[], u32 n_ops,
177 openssl_per_thread_data_t *ptd = vec_elt_at_index (per_thread_data,
179 HMAC_CTX *ctx = ptd->hmac_ctx;
181 for (i = 0; i < n_ops; i++)
183 vnet_crypto_op_t *op = ops[i];
184 unsigned int out_len;
185 size_t sz = op->digest_len ? op->digest_len : EVP_MD_size (md);
187 HMAC_Init_ex (ctx, op->key, op->key_len, md, NULL);
188 HMAC_Update (ctx, op->src, op->len);
189 HMAC_Final (ctx, buffer, &out_len);
191 if (op->flags & VNET_CRYPTO_OP_FLAG_HMAC_CHECK)
193 if ((memcmp (op->digest, buffer, sz)))
196 op->status = VNET_CRYPTO_OP_STATUS_FAIL_BAD_HMAC;
201 clib_memcpy_fast (op->digest, buffer, sz);
202 op->status = VNET_CRYPTO_OP_STATUS_COMPLETED;
204 return n_ops - n_fail;
209 openssl_ops_enc_##a (vlib_main_t * vm, vnet_crypto_op_t * ops[], u32 n_ops) \
210 { return openssl_ops_enc_##m (vm, ops, n_ops, b ()); } \
213 openssl_ops_dec_##a (vlib_main_t * vm, vnet_crypto_op_t * ops[], u32 n_ops) \
214 { return openssl_ops_dec_##m (vm, ops, n_ops, b ()); }
216 foreach_openssl_evp_op;
221 openssl_ops_hmac_##a (vlib_main_t * vm, vnet_crypto_op_t * ops[], u32 n_ops) \
222 { return openssl_ops_hmac (vm, ops, n_ops, b ()); } \
224 foreach_openssl_hmac_op;
229 crypto_openssl_init (vlib_main_t * vm)
231 vlib_thread_main_t *tm = vlib_get_thread_main ();
232 openssl_per_thread_data_t *ptd;
238 if ((error = vlib_call_init_function (vm, vnet_crypto_init)))
241 u32 eidx = vnet_crypto_register_engine (vm, "openssl", 50, "OpenSSL");
244 vnet_crypto_register_ops_handler (vm, eidx, VNET_CRYPTO_OP_##a##_ENC, \
245 openssl_ops_enc_##a); \
246 vnet_crypto_register_ops_handler (vm, eidx, VNET_CRYPTO_OP_##a##_DEC, \
247 openssl_ops_dec_##a);
249 foreach_openssl_evp_op;
253 vnet_crypto_register_ops_handler (vm, eidx, VNET_CRYPTO_OP_##a##_HMAC, \
254 openssl_ops_hmac_##a); \
256 foreach_openssl_hmac_op;
259 vec_validate_aligned (per_thread_data, tm->n_vlib_mains - 1,
260 CLIB_CACHE_LINE_BYTES);
262 vec_foreach (ptd, per_thread_data)
264 ptd->evp_cipher_ctx = EVP_CIPHER_CTX_new ();
265 #if OPENSSL_VERSION_NUMBER >= 0x10100000L
266 ptd->hmac_ctx = HMAC_CTX_new ();
268 HMAC_CTX_init (&(ptd->_hmac_ctx));
269 ptd->hmac_ctx = &ptd->_hmac_ctx;
275 vec_add (seed_data, &t, sizeof (t));
276 vec_add (seed_data, &pid, sizeof (pid));
277 vec_add (seed_data, seed_data, sizeof (seed_data));
279 RAND_seed ((const void *) seed_data, vec_len (seed_data));
281 vec_free (seed_data);
286 VLIB_INIT_FUNCTION (crypto_openssl_init);
289 VLIB_PLUGIN_REGISTER () = {
290 .version = VPP_BUILD_VER,
291 .description = "OpenSSL Crypto Engine Plugin",
296 * fd.io coding-style-patch-verification: ON
299 * eval: (c-set-style "gnu")