1 /* SPDX-License-Identifier: BSD-3-Clause 2 * Copyright 2017 NXP. 3 * Copyright(c) 2017 Intel Corporation. 4 * Copyright (c) 2020 Samsung Electronics Co., Ltd All Rights Reserved 5 */ 6 7 #include <ctype.h> 8 #include <stdlib.h> 9 10 #include <rte_cryptodev.h> 11 #include <dev_driver.h> 12 #include <rte_telemetry.h> 13 #include "rte_security.h" 14 #include "rte_security_driver.h" 15 16 /* Macro to check for invalid pointers */ 17 #define RTE_PTR_OR_ERR_RET(ptr, retval) do { \ 18 if ((ptr) == NULL) \ 19 return retval; \ 20 } while (0) 21 22 /* Macro to check for invalid pointers chains */ 23 #define RTE_PTR_CHAIN3_OR_ERR_RET(p1, p2, p3, retval, last_retval) do { \ 24 RTE_PTR_OR_ERR_RET(p1, retval); \ 25 RTE_PTR_OR_ERR_RET(p1->p2, retval); \ 26 RTE_PTR_OR_ERR_RET(p1->p2->p3, last_retval); \ 27 } while (0) 28 29 #define RTE_SECURITY_DYNFIELD_NAME "rte_security_dynfield_metadata" 30 int rte_security_dynfield_offset = -1; 31 32 int 33 rte_security_dynfield_register(void) 34 { 35 static const struct rte_mbuf_dynfield dynfield_desc = { 36 .name = RTE_SECURITY_DYNFIELD_NAME, 37 .size = sizeof(rte_security_dynfield_t), 38 .align = __alignof__(rte_security_dynfield_t), 39 }; 40 rte_security_dynfield_offset = 41 rte_mbuf_dynfield_register(&dynfield_desc); 42 return rte_security_dynfield_offset; 43 } 44 45 struct rte_security_session * 46 rte_security_session_create(struct rte_security_ctx *instance, 47 struct rte_security_session_conf *conf, 48 struct rte_mempool *mp, 49 struct rte_mempool *priv_mp) 50 { 51 struct rte_security_session *sess = NULL; 52 53 RTE_PTR_CHAIN3_OR_ERR_RET(instance, ops, session_create, NULL, NULL); 54 RTE_PTR_OR_ERR_RET(conf, NULL); 55 RTE_PTR_OR_ERR_RET(mp, NULL); 56 RTE_PTR_OR_ERR_RET(priv_mp, NULL); 57 58 if (rte_mempool_get(mp, (void **)&sess)) 59 return NULL; 60 61 if (instance->ops->session_create(instance->device, conf, 62 sess, priv_mp)) { 63 rte_mempool_put(mp, (void *)sess); 64 return NULL; 65 } 66 instance->sess_cnt++; 67 68 return sess; 69 } 70 71 int 72 rte_security_session_update(struct rte_security_ctx *instance, 73 struct rte_security_session *sess, 74 struct rte_security_session_conf *conf) 75 { 76 RTE_PTR_CHAIN3_OR_ERR_RET(instance, ops, session_update, -EINVAL, 77 -ENOTSUP); 78 RTE_PTR_OR_ERR_RET(sess, -EINVAL); 79 RTE_PTR_OR_ERR_RET(conf, -EINVAL); 80 81 return instance->ops->session_update(instance->device, sess, conf); 82 } 83 84 unsigned int 85 rte_security_session_get_size(struct rte_security_ctx *instance) 86 { 87 RTE_PTR_CHAIN3_OR_ERR_RET(instance, ops, session_get_size, 0, 0); 88 89 return instance->ops->session_get_size(instance->device); 90 } 91 92 int 93 rte_security_session_stats_get(struct rte_security_ctx *instance, 94 struct rte_security_session *sess, 95 struct rte_security_stats *stats) 96 { 97 RTE_PTR_CHAIN3_OR_ERR_RET(instance, ops, session_stats_get, -EINVAL, 98 -ENOTSUP); 99 /* Parameter sess can be NULL in case of getting global statistics. */ 100 RTE_PTR_OR_ERR_RET(stats, -EINVAL); 101 102 return instance->ops->session_stats_get(instance->device, sess, stats); 103 } 104 105 int 106 rte_security_session_destroy(struct rte_security_ctx *instance, 107 struct rte_security_session *sess) 108 { 109 int ret; 110 111 RTE_PTR_CHAIN3_OR_ERR_RET(instance, ops, session_destroy, -EINVAL, 112 -ENOTSUP); 113 RTE_PTR_OR_ERR_RET(sess, -EINVAL); 114 115 ret = instance->ops->session_destroy(instance->device, sess); 116 if (ret != 0) 117 return ret; 118 119 rte_mempool_put(rte_mempool_from_obj(sess), (void *)sess); 120 121 if (instance->sess_cnt) 122 instance->sess_cnt--; 123 124 return 0; 125 } 126 127 int 128 __rte_security_set_pkt_metadata(struct rte_security_ctx *instance, 129 struct rte_security_session *sess, 130 struct rte_mbuf *m, void *params) 131 { 132 #ifdef RTE_DEBUG 133 RTE_PTR_OR_ERR_RET(sess, -EINVAL); 134 RTE_PTR_OR_ERR_RET(instance, -EINVAL); 135 RTE_PTR_OR_ERR_RET(instance->ops, -EINVAL); 136 #endif 137 if (*instance->ops->set_pkt_metadata == NULL) 138 return -ENOTSUP; 139 return instance->ops->set_pkt_metadata(instance->device, 140 sess, m, params); 141 } 142 143 void * 144 __rte_security_get_userdata(struct rte_security_ctx *instance, uint64_t md) 145 { 146 void *userdata = NULL; 147 148 #ifdef RTE_DEBUG 149 RTE_PTR_OR_ERR_RET(instance, NULL); 150 RTE_PTR_OR_ERR_RET(instance->ops, NULL); 151 #endif 152 if (*instance->ops->get_userdata == NULL) 153 return NULL; 154 if (instance->ops->get_userdata(instance->device, md, &userdata)) 155 return NULL; 156 157 return userdata; 158 } 159 160 const struct rte_security_capability * 161 rte_security_capabilities_get(struct rte_security_ctx *instance) 162 { 163 RTE_PTR_CHAIN3_OR_ERR_RET(instance, ops, capabilities_get, NULL, NULL); 164 165 return instance->ops->capabilities_get(instance->device); 166 } 167 168 const struct rte_security_capability * 169 rte_security_capability_get(struct rte_security_ctx *instance, 170 struct rte_security_capability_idx *idx) 171 { 172 const struct rte_security_capability *capabilities; 173 const struct rte_security_capability *capability; 174 uint16_t i = 0; 175 176 RTE_PTR_CHAIN3_OR_ERR_RET(instance, ops, capabilities_get, NULL, NULL); 177 RTE_PTR_OR_ERR_RET(idx, NULL); 178 179 capabilities = instance->ops->capabilities_get(instance->device); 180 181 if (capabilities == NULL) 182 return NULL; 183 184 while ((capability = &capabilities[i++])->action 185 != RTE_SECURITY_ACTION_TYPE_NONE) { 186 if (capability->action == idx->action && 187 capability->protocol == idx->protocol) { 188 if (idx->protocol == RTE_SECURITY_PROTOCOL_IPSEC) { 189 if (capability->ipsec.proto == 190 idx->ipsec.proto && 191 capability->ipsec.mode == 192 idx->ipsec.mode && 193 capability->ipsec.direction == 194 idx->ipsec.direction) 195 return capability; 196 } else if (idx->protocol == RTE_SECURITY_PROTOCOL_PDCP) { 197 if (capability->pdcp.domain == 198 idx->pdcp.domain) 199 return capability; 200 } else if (idx->protocol == 201 RTE_SECURITY_PROTOCOL_DOCSIS) { 202 if (capability->docsis.direction == 203 idx->docsis.direction) 204 return capability; 205 } 206 } 207 } 208 209 return NULL; 210 } 211 212 static int 213 security_handle_cryptodev_list(const char *cmd __rte_unused, 214 const char *params __rte_unused, 215 struct rte_tel_data *d) 216 { 217 int dev_id; 218 219 if (rte_cryptodev_count() < 1) 220 return -1; 221 222 rte_tel_data_start_array(d, RTE_TEL_INT_VAL); 223 for (dev_id = 0; dev_id < RTE_CRYPTO_MAX_DEVS; dev_id++) 224 if (rte_cryptodev_is_valid_dev(dev_id) && 225 rte_cryptodev_get_sec_ctx(dev_id)) 226 rte_tel_data_add_array_int(d, dev_id); 227 228 return 0; 229 } 230 231 #define CRYPTO_CAPS_SZ \ 232 (RTE_ALIGN_CEIL(sizeof(struct rte_cryptodev_capabilities), \ 233 sizeof(uint64_t)) / sizeof(uint64_t)) 234 235 static int 236 crypto_caps_array(struct rte_tel_data *d, 237 const struct rte_cryptodev_capabilities *capabilities) 238 { 239 const struct rte_cryptodev_capabilities *dev_caps; 240 uint64_t caps_val[CRYPTO_CAPS_SZ]; 241 unsigned int i = 0, j; 242 243 rte_tel_data_start_array(d, RTE_TEL_U64_VAL); 244 245 while ((dev_caps = &capabilities[i++])->op != 246 RTE_CRYPTO_OP_TYPE_UNDEFINED) { 247 memset(&caps_val, 0, CRYPTO_CAPS_SZ * sizeof(caps_val[0])); 248 rte_memcpy(caps_val, dev_caps, sizeof(capabilities[0])); 249 for (j = 0; j < CRYPTO_CAPS_SZ; j++) 250 rte_tel_data_add_array_u64(d, caps_val[j]); 251 } 252 253 return (i - 1); 254 } 255 256 #define SEC_CAPS_SZ \ 257 (RTE_ALIGN_CEIL(sizeof(struct rte_security_capability), \ 258 sizeof(uint64_t)) / sizeof(uint64_t)) 259 260 static int 261 sec_caps_array(struct rte_tel_data *d, 262 const struct rte_security_capability *capabilities) 263 { 264 const struct rte_security_capability *dev_caps; 265 uint64_t caps_val[SEC_CAPS_SZ]; 266 unsigned int i = 0, j; 267 268 rte_tel_data_start_array(d, RTE_TEL_U64_VAL); 269 270 while ((dev_caps = &capabilities[i++])->action != 271 RTE_SECURITY_ACTION_TYPE_NONE) { 272 memset(&caps_val, 0, SEC_CAPS_SZ * sizeof(caps_val[0])); 273 rte_memcpy(caps_val, dev_caps, sizeof(capabilities[0])); 274 for (j = 0; j < SEC_CAPS_SZ; j++) 275 rte_tel_data_add_array_u64(d, caps_val[j]); 276 } 277 278 return i - 1; 279 } 280 281 static const struct rte_security_capability * 282 security_capability_by_index(const struct rte_security_capability *capabilities, 283 int index) 284 { 285 const struct rte_security_capability *dev_caps = NULL; 286 int i = 0; 287 288 while ((dev_caps = &capabilities[i])->action != 289 RTE_SECURITY_ACTION_TYPE_NONE) { 290 if (i == index) 291 return dev_caps; 292 293 ++i; 294 } 295 296 return NULL; 297 } 298 299 static int 300 security_capabilities_from_dev_id(int dev_id, const void **caps) 301 { 302 const struct rte_security_capability *capabilities; 303 struct rte_security_ctx *sec_ctx; 304 305 if (rte_cryptodev_is_valid_dev(dev_id) == 0) 306 return -EINVAL; 307 308 sec_ctx = (struct rte_security_ctx *)rte_cryptodev_get_sec_ctx(dev_id); 309 RTE_PTR_OR_ERR_RET(sec_ctx, -EINVAL); 310 311 capabilities = rte_security_capabilities_get(sec_ctx); 312 RTE_PTR_OR_ERR_RET(capabilities, -EINVAL); 313 314 *caps = capabilities; 315 return 0; 316 } 317 318 static int 319 security_handle_cryptodev_sec_caps(const char *cmd __rte_unused, const char *params, 320 struct rte_tel_data *d) 321 { 322 const struct rte_security_capability *capabilities; 323 struct rte_tel_data *sec_caps; 324 char *end_param; 325 int sec_caps_n; 326 int dev_id; 327 int rc; 328 329 if (!params || strlen(params) == 0 || !isdigit(*params)) 330 return -EINVAL; 331 332 dev_id = strtoul(params, &end_param, 0); 333 if (*end_param != '\0') 334 CDEV_LOG_ERR("Extra parameters passed to command, ignoring"); 335 336 rc = security_capabilities_from_dev_id(dev_id, (void *)&capabilities); 337 if (rc < 0) 338 return rc; 339 340 sec_caps = rte_tel_data_alloc(); 341 RTE_PTR_OR_ERR_RET(sec_caps, -ENOMEM); 342 343 rte_tel_data_start_dict(d); 344 sec_caps_n = sec_caps_array(sec_caps, capabilities); 345 rte_tel_data_add_dict_container(d, "sec_caps", sec_caps, 0); 346 rte_tel_data_add_dict_int(d, "sec_caps_n", sec_caps_n); 347 348 return 0; 349 } 350 351 static int 352 security_handle_cryptodev_crypto_caps(const char *cmd __rte_unused, const char *params, 353 struct rte_tel_data *d) 354 { 355 const struct rte_security_capability *capabilities; 356 struct rte_tel_data *crypto_caps; 357 const char *capa_param; 358 int dev_id, capa_id; 359 int crypto_caps_n; 360 char *end_param; 361 int rc; 362 363 if (!params || strlen(params) == 0 || !isdigit(*params)) 364 return -EINVAL; 365 366 dev_id = strtoul(params, &end_param, 0); 367 capa_param = strtok(end_param, ","); 368 if (!capa_param || strlen(capa_param) == 0 || !isdigit(*capa_param)) 369 return -EINVAL; 370 371 capa_id = strtoul(capa_param, &end_param, 0); 372 if (*end_param != '\0') 373 CDEV_LOG_ERR("Extra parameters passed to command, ignoring"); 374 375 rc = security_capabilities_from_dev_id(dev_id, (void *)&capabilities); 376 if (rc < 0) 377 return rc; 378 379 capabilities = security_capability_by_index(capabilities, capa_id); 380 RTE_PTR_OR_ERR_RET(capabilities, -EINVAL); 381 382 crypto_caps = rte_tel_data_alloc(); 383 RTE_PTR_OR_ERR_RET(crypto_caps, -ENOMEM); 384 385 rte_tel_data_start_dict(d); 386 crypto_caps_n = crypto_caps_array(crypto_caps, capabilities->crypto_capabilities); 387 388 rte_tel_data_add_dict_container(d, "crypto_caps", crypto_caps, 0); 389 rte_tel_data_add_dict_int(d, "crypto_caps_n", crypto_caps_n); 390 391 return 0; 392 } 393 394 RTE_INIT(security_init_telemetry) 395 { 396 rte_telemetry_register_cmd("/security/cryptodev/list", 397 security_handle_cryptodev_list, 398 "Returns list of available crypto devices by IDs. No parameters."); 399 400 rte_telemetry_register_cmd("/security/cryptodev/sec_caps", 401 security_handle_cryptodev_sec_caps, 402 "Returns security capabilities for a cryptodev. Parameters: int dev_id"); 403 404 rte_telemetry_register_cmd("/security/cryptodev/crypto_caps", 405 security_handle_cryptodev_crypto_caps, 406 "Returns crypto capabilities for a security capability. Parameters: int dev_id, sec_cap_id"); 407 } 408