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_macsec_sc_create(struct rte_security_ctx *instance, 129 struct rte_security_macsec_sc *conf) 130 { 131 int sc_id; 132 133 RTE_PTR_CHAIN3_OR_ERR_RET(instance, ops, macsec_sc_create, -EINVAL, -ENOTSUP); 134 RTE_PTR_OR_ERR_RET(conf, -EINVAL); 135 136 sc_id = instance->ops->macsec_sc_create(instance->device, conf); 137 if (sc_id >= 0) 138 instance->macsec_sc_cnt++; 139 140 return sc_id; 141 } 142 143 int 144 rte_security_macsec_sa_create(struct rte_security_ctx *instance, 145 struct rte_security_macsec_sa *conf) 146 { 147 int sa_id; 148 149 RTE_PTR_CHAIN3_OR_ERR_RET(instance, ops, macsec_sa_create, -EINVAL, -ENOTSUP); 150 RTE_PTR_OR_ERR_RET(conf, -EINVAL); 151 152 sa_id = instance->ops->macsec_sa_create(instance->device, conf); 153 if (sa_id >= 0) 154 instance->macsec_sa_cnt++; 155 156 return sa_id; 157 } 158 159 int 160 rte_security_macsec_sc_destroy(struct rte_security_ctx *instance, uint16_t sc_id) 161 { 162 int ret; 163 164 RTE_PTR_CHAIN3_OR_ERR_RET(instance, ops, macsec_sc_destroy, -EINVAL, -ENOTSUP); 165 166 ret = instance->ops->macsec_sc_destroy(instance->device, sc_id); 167 if (ret != 0) 168 return ret; 169 170 if (instance->macsec_sc_cnt) 171 instance->macsec_sc_cnt--; 172 173 return 0; 174 } 175 176 int 177 rte_security_macsec_sa_destroy(struct rte_security_ctx *instance, uint16_t sa_id) 178 { 179 int ret; 180 181 RTE_PTR_CHAIN3_OR_ERR_RET(instance, ops, macsec_sa_destroy, -EINVAL, -ENOTSUP); 182 183 ret = instance->ops->macsec_sa_destroy(instance->device, sa_id); 184 if (ret != 0) 185 return ret; 186 187 if (instance->macsec_sa_cnt) 188 instance->macsec_sa_cnt--; 189 190 return 0; 191 } 192 193 int 194 rte_security_macsec_sc_stats_get(struct rte_security_ctx *instance, uint16_t sc_id, 195 struct rte_security_macsec_sc_stats *stats) 196 { 197 RTE_PTR_CHAIN3_OR_ERR_RET(instance, ops, macsec_sc_stats_get, -EINVAL, -ENOTSUP); 198 RTE_PTR_OR_ERR_RET(stats, -EINVAL); 199 200 return instance->ops->macsec_sc_stats_get(instance->device, sc_id, stats); 201 } 202 203 int 204 rte_security_macsec_sa_stats_get(struct rte_security_ctx *instance, uint16_t sa_id, 205 struct rte_security_macsec_sa_stats *stats) 206 { 207 RTE_PTR_CHAIN3_OR_ERR_RET(instance, ops, macsec_sa_stats_get, -EINVAL, -ENOTSUP); 208 RTE_PTR_OR_ERR_RET(stats, -EINVAL); 209 210 return instance->ops->macsec_sa_stats_get(instance->device, sa_id, stats); 211 } 212 213 int 214 __rte_security_set_pkt_metadata(struct rte_security_ctx *instance, 215 struct rte_security_session *sess, 216 struct rte_mbuf *m, void *params) 217 { 218 #ifdef RTE_DEBUG 219 RTE_PTR_OR_ERR_RET(sess, -EINVAL); 220 RTE_PTR_OR_ERR_RET(instance, -EINVAL); 221 RTE_PTR_OR_ERR_RET(instance->ops, -EINVAL); 222 #endif 223 if (*instance->ops->set_pkt_metadata == NULL) 224 return -ENOTSUP; 225 return instance->ops->set_pkt_metadata(instance->device, 226 sess, m, params); 227 } 228 229 const struct rte_security_capability * 230 rte_security_capabilities_get(struct rte_security_ctx *instance) 231 { 232 RTE_PTR_CHAIN3_OR_ERR_RET(instance, ops, capabilities_get, NULL, NULL); 233 234 return instance->ops->capabilities_get(instance->device); 235 } 236 237 const struct rte_security_capability * 238 rte_security_capability_get(struct rte_security_ctx *instance, 239 struct rte_security_capability_idx *idx) 240 { 241 const struct rte_security_capability *capabilities; 242 const struct rte_security_capability *capability; 243 uint16_t i = 0; 244 245 RTE_PTR_CHAIN3_OR_ERR_RET(instance, ops, capabilities_get, NULL, NULL); 246 RTE_PTR_OR_ERR_RET(idx, NULL); 247 248 capabilities = instance->ops->capabilities_get(instance->device); 249 250 if (capabilities == NULL) 251 return NULL; 252 253 while ((capability = &capabilities[i++])->action 254 != RTE_SECURITY_ACTION_TYPE_NONE) { 255 if (capability->action == idx->action && 256 capability->protocol == idx->protocol) { 257 if (idx->protocol == RTE_SECURITY_PROTOCOL_IPSEC) { 258 if (capability->ipsec.proto == 259 idx->ipsec.proto && 260 capability->ipsec.mode == 261 idx->ipsec.mode && 262 capability->ipsec.direction == 263 idx->ipsec.direction) 264 return capability; 265 } else if (idx->protocol == RTE_SECURITY_PROTOCOL_PDCP) { 266 if (capability->pdcp.domain == 267 idx->pdcp.domain) 268 return capability; 269 } else if (idx->protocol == 270 RTE_SECURITY_PROTOCOL_DOCSIS) { 271 if (capability->docsis.direction == 272 idx->docsis.direction) 273 return capability; 274 } 275 } 276 } 277 278 return NULL; 279 } 280 281 static int 282 security_handle_cryptodev_list(const char *cmd __rte_unused, 283 const char *params __rte_unused, 284 struct rte_tel_data *d) 285 { 286 int dev_id; 287 288 if (rte_cryptodev_count() < 1) 289 return -1; 290 291 rte_tel_data_start_array(d, RTE_TEL_INT_VAL); 292 for (dev_id = 0; dev_id < RTE_CRYPTO_MAX_DEVS; dev_id++) 293 if (rte_cryptodev_is_valid_dev(dev_id) && 294 rte_cryptodev_get_sec_ctx(dev_id)) 295 rte_tel_data_add_array_int(d, dev_id); 296 297 return 0; 298 } 299 300 #define CRYPTO_CAPS_SZ \ 301 (RTE_ALIGN_CEIL(sizeof(struct rte_cryptodev_capabilities), \ 302 sizeof(uint64_t)) / sizeof(uint64_t)) 303 304 static int 305 crypto_caps_array(struct rte_tel_data *d, 306 const struct rte_cryptodev_capabilities *capabilities) 307 { 308 const struct rte_cryptodev_capabilities *dev_caps; 309 uint64_t caps_val[CRYPTO_CAPS_SZ]; 310 unsigned int i = 0, j; 311 312 rte_tel_data_start_array(d, RTE_TEL_U64_VAL); 313 314 while ((dev_caps = &capabilities[i++])->op != 315 RTE_CRYPTO_OP_TYPE_UNDEFINED) { 316 memset(&caps_val, 0, CRYPTO_CAPS_SZ * sizeof(caps_val[0])); 317 rte_memcpy(caps_val, dev_caps, sizeof(capabilities[0])); 318 for (j = 0; j < CRYPTO_CAPS_SZ; j++) 319 rte_tel_data_add_array_u64(d, caps_val[j]); 320 } 321 322 return (i - 1); 323 } 324 325 #define SEC_CAPS_SZ \ 326 (RTE_ALIGN_CEIL(sizeof(struct rte_security_capability), \ 327 sizeof(uint64_t)) / sizeof(uint64_t)) 328 329 static int 330 sec_caps_array(struct rte_tel_data *d, 331 const struct rte_security_capability *capabilities) 332 { 333 const struct rte_security_capability *dev_caps; 334 uint64_t caps_val[SEC_CAPS_SZ]; 335 unsigned int i = 0, j; 336 337 rte_tel_data_start_array(d, RTE_TEL_U64_VAL); 338 339 while ((dev_caps = &capabilities[i++])->action != 340 RTE_SECURITY_ACTION_TYPE_NONE) { 341 memset(&caps_val, 0, SEC_CAPS_SZ * sizeof(caps_val[0])); 342 rte_memcpy(caps_val, dev_caps, sizeof(capabilities[0])); 343 for (j = 0; j < SEC_CAPS_SZ; j++) 344 rte_tel_data_add_array_u64(d, caps_val[j]); 345 } 346 347 return i - 1; 348 } 349 350 static const struct rte_security_capability * 351 security_capability_by_index(const struct rte_security_capability *capabilities, 352 int index) 353 { 354 const struct rte_security_capability *dev_caps = NULL; 355 int i = 0; 356 357 while ((dev_caps = &capabilities[i])->action != 358 RTE_SECURITY_ACTION_TYPE_NONE) { 359 if (i == index) 360 return dev_caps; 361 362 ++i; 363 } 364 365 return NULL; 366 } 367 368 static int 369 security_capabilities_from_dev_id(int dev_id, const void **caps) 370 { 371 const struct rte_security_capability *capabilities; 372 struct rte_security_ctx *sec_ctx; 373 374 if (rte_cryptodev_is_valid_dev(dev_id) == 0) 375 return -EINVAL; 376 377 sec_ctx = (struct rte_security_ctx *)rte_cryptodev_get_sec_ctx(dev_id); 378 RTE_PTR_OR_ERR_RET(sec_ctx, -EINVAL); 379 380 capabilities = rte_security_capabilities_get(sec_ctx); 381 RTE_PTR_OR_ERR_RET(capabilities, -EINVAL); 382 383 *caps = capabilities; 384 return 0; 385 } 386 387 static int 388 security_handle_cryptodev_sec_caps(const char *cmd __rte_unused, const char *params, 389 struct rte_tel_data *d) 390 { 391 const struct rte_security_capability *capabilities; 392 struct rte_tel_data *sec_caps; 393 char *end_param; 394 int sec_caps_n; 395 int dev_id; 396 int rc; 397 398 if (!params || strlen(params) == 0 || !isdigit(*params)) 399 return -EINVAL; 400 401 dev_id = strtoul(params, &end_param, 0); 402 if (*end_param != '\0') 403 CDEV_LOG_ERR("Extra parameters passed to command, ignoring"); 404 405 rc = security_capabilities_from_dev_id(dev_id, (void *)&capabilities); 406 if (rc < 0) 407 return rc; 408 409 sec_caps = rte_tel_data_alloc(); 410 RTE_PTR_OR_ERR_RET(sec_caps, -ENOMEM); 411 412 rte_tel_data_start_dict(d); 413 sec_caps_n = sec_caps_array(sec_caps, capabilities); 414 rte_tel_data_add_dict_container(d, "sec_caps", sec_caps, 0); 415 rte_tel_data_add_dict_int(d, "sec_caps_n", sec_caps_n); 416 417 return 0; 418 } 419 420 static int 421 security_handle_cryptodev_crypto_caps(const char *cmd __rte_unused, const char *params, 422 struct rte_tel_data *d) 423 { 424 const struct rte_security_capability *capabilities; 425 struct rte_tel_data *crypto_caps; 426 const char *capa_param; 427 int dev_id, capa_id; 428 int crypto_caps_n; 429 char *end_param; 430 int rc; 431 432 if (!params || strlen(params) == 0 || !isdigit(*params)) 433 return -EINVAL; 434 435 dev_id = strtoul(params, &end_param, 0); 436 capa_param = strtok(end_param, ","); 437 if (!capa_param || strlen(capa_param) == 0 || !isdigit(*capa_param)) 438 return -EINVAL; 439 440 capa_id = strtoul(capa_param, &end_param, 0); 441 if (*end_param != '\0') 442 CDEV_LOG_ERR("Extra parameters passed to command, ignoring"); 443 444 rc = security_capabilities_from_dev_id(dev_id, (void *)&capabilities); 445 if (rc < 0) 446 return rc; 447 448 capabilities = security_capability_by_index(capabilities, capa_id); 449 RTE_PTR_OR_ERR_RET(capabilities, -EINVAL); 450 451 crypto_caps = rte_tel_data_alloc(); 452 RTE_PTR_OR_ERR_RET(crypto_caps, -ENOMEM); 453 454 rte_tel_data_start_dict(d); 455 crypto_caps_n = crypto_caps_array(crypto_caps, capabilities->crypto_capabilities); 456 457 rte_tel_data_add_dict_container(d, "crypto_caps", crypto_caps, 0); 458 rte_tel_data_add_dict_int(d, "crypto_caps_n", crypto_caps_n); 459 460 return 0; 461 } 462 463 RTE_INIT(security_init_telemetry) 464 { 465 rte_telemetry_register_cmd("/security/cryptodev/list", 466 security_handle_cryptodev_list, 467 "Returns list of available crypto devices by IDs. No parameters."); 468 469 rte_telemetry_register_cmd("/security/cryptodev/sec_caps", 470 security_handle_cryptodev_sec_caps, 471 "Returns security capabilities for a cryptodev. Parameters: int dev_id"); 472 473 rte_telemetry_register_cmd("/security/cryptodev/crypto_caps", 474 security_handle_cryptodev_crypto_caps, 475 "Returns crypto capabilities for a security capability. Parameters: int dev_id, sec_cap_id"); 476 } 477