nvpkcs11_public_defs.h

Go to the documentation of this file.

/* ***************************************************************************** *
 * SPDX-FileCopyrightText: Copyright (c) 2020-2025, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
 * SPDX-License-Identifier: LicenseRef-NvidiaProprietary
 *
 * NVIDIA CORPORATION and its licensors retain all intellectual property
 * and proprietary rights in and to this software, related documentation
 * and any modifications thereto.  Any use, reproduction, disclosure or
 * distribution of this software and related documentation without an express
 * license agreement from NVIDIA CORPORATION is strictly prohibited.
 ******************************************************************************* */
#ifndef NVPKCS11_PUBLIC_DEFS_H_
#define NVPKCS11_PUBLIC_DEFS_H_
 
#define NVPKCS11_AES_CBC_BLOCK_SIZE 16UL
 
#define NVPKCS11_AES_CBC_IV_LEN 16UL
 
#define NVPKCS11_AES_CTR_COUNTER_SIZE 32U
 
#define NVPKCS11_MAX_KEY_ID_SIZE 32U
 
#define NVPKCS11_MAX_CKA_LABEL_SIZE 32U
 
#define NVPKCS11_MAX_GDO_CKA_APPLICATION_SIZE 32U
 
#define NVPKCS11_MAX_GDO_CKA_OBJECT_ID_SIZE 64U
 
#define NVPKCS11_MAX_GDO_CKA_VALUE_SIZE 3616U
 
#define NVPKCS11_RANDOM_DATA_MAXLENGTH 1024U
 
#define NVPKCS11_RANDOM_DATA_MINLENGTH 1U
 
#define NVPKCS11_AES_CMAC_SIGNATURE_SIZE 16U
/* Defines the minimum and maximum Modulus and Exponent sizes for Public Key Objects */
#define NVPKCS11_MAX_KEY_MODULUS 512U
 
#define NVPKCS11_MIN_KEY_MODULUS 384U
 
#define NVPKCS11_RSA_2K_KEY_MODULUS 256U
 
#define NVPKCS11_MAX_KEY_EXPONENT 4U
 
#define NVPKCS11_MIN_KEY_EXPONENT 4U
/* Size of digest of each SHA mechanism */
#define NVPKCS11_SHA256_DIGEST_SIZE        32U
 
#define NVPKCS11_SHA384_DIGEST_SIZE        48U
 
#define NVPKCS11_SHA512_DIGEST_SIZE        64U
 
#define NVPKCS11_MAX_SHA_DIGEST_SIZE NVPKCS11_SHA512_DIGEST_SIZE
 
#define NVPKCS11_ECDSA_SECP256R1_STRING "secp256r1"
 
#define NVPKCS11_EDDSA_ED25519_STRING "edwards25519"
 
#define NVPKCS11_EC_MONTGOMERY_25519_STRING "curve25519"
 
#define NVPKCS11_ECDSA_X962_UNCOMP_ID 0x04U
 
#define NVPKCS11_DER_PRINTABLE_IDENTIFIER 0x13U
 
#define NVPKCS11_DER_OCTET_IDENTIFIER 0x04U
 
#define NVPKCS11_DER_MAX_SIZE 127U
 
#define NVPKCS11_MAX_EC_STRING_SIZE NVPKCS11_DER_MAX_SIZE
 
#define NVPKCS11_EC_256_POINT_SIZE 32U
 
#define NVPKCS11_ECC_PRIVATE_KEY_SIZE 32U
 
#define NVPKCS11_EDDSA_SIGNATURE_SIZE 64U
 
#define NVPKCS11_MAX_ECDSA_SECP256R1_SIGNATURE_SIZE 72U
 
#define NVPKCS11_SECRET_KEY_LENGTH_IN_BYTES 16U
 
#define NVPKCS11_LONG_SECRET_KEY_LENGTH_IN_BYTES 32U
 
#define NVPKCS11_TLS_MASTER_SECRET_KEY_LENGTH_IN_BYTES 48U
 
#define NVPKCS11_TLS_HANDSHAKE_RANDOM_LENGTH_IN_BYTES 32U
 
#define NVPKCS11_TLS12_MASTER_KEY_DERIVE_LABEL_LENGTH_IN_BYTES 13U
 
#define NVPKCS11_TLS12_KEY_AND_MAC_DERIVE_LABEL_LENGTH_IN_BYTES 13U
 
#define NVPKCS11_AES_CBC_KEY_DATA_WRAP_MAX_DATA_LENGTH_IN_BYTES 32U
 
#define NVPKCS11_SP800_56A_ONE_STEP_KDF_MAX_INFO_LENGTH_IN_BYTES 96U
 
#define NVPKCS11_AES_KEY_WRAP_IV_LENGTH 8U
 
#define NVPKCS11_MAX_PSC_CMAC_DATA_LEN 1500U
 
#define NVPKCS11_NVIDIA_OX5B_SHA256_UID_LENGTH 6U
 
#define NVPKCS11_NVIDIA_OX5B_SHA256_NONCE_LENGTH 16U
 
#define NVPKCS11_MAX_ENTRIES_PER_CMAC_SIGN_VERIFY_BATCH 32U
 
#define NVPKCS11_GETINFO_CRYPTOKIVERSION_MAJOR 0x03U
 
#define NVPKCS11_GETINFO_CRYPTOKIVERSION_MINOR 0x00U
 
#define NVPKCS11_GETINFO_MANF_ID "NVIDIA"
 
#define NVPKCS11_GETINFO_FLAGS 0x00U
 
#define NVPKCS11_GETINFO_LIBRARY_DESC "HPSE_Library"
 
#define NVPKCS11_GETINFO_LIBRARYVERSION_MAJOR 0x46U
 
#define NVPKCS11_GETINFO_LIBRARYVERSION_MINOR 0x02U
 
#define NVPKCS11_FSI_DYNAMIC_1_MODEL_NAME     "FSI_DYN_1       "
 
#define NVPKCS11_CCPLEX_SAFETY_2_MODEL_NAME   "CCPLEX_SAFE_2   "
 
#define NVPKCS11_CCPLEX_DYNAMIC_2_MODEL_NAME  "CCPLEX_DYN_2    "
 
#define NVPKCS11_TSEC_SAFETY_3_MODEL_NAME     "TSEC_SAFE_3     "
 
#define NVPKCS11_TSEC_DYNAMIC_3_MODEL_NAME    "TSEC_DYN_3      "
 
#define NVPKCS11_CCPLEX_SAFETY_4_MODEL_NAME   "CCPLEX_SAFE_4   "
 
#define NVPKCS11_CCPLEX_DYNAMIC_4_MODEL_NAME  "CCPLEX_DYN_4    "
 
#define NVPKCS11_CCPLEX_SAFETY_5_MODEL_NAME   "CCPLEX_SAFE_5   "
 
#define NVPKCS11_CCPLEX_DYNAMIC_5_MODEL_NAME  "CCPLEX_DYN_5    "
 
#define NVPKCS11_CCPLEX_SAFETY_6_MODEL_NAME   "CCPLEX_SAFE_6   "
 
#define NVPKCS11_CCPLEX_DYNAMIC_6_MODEL_NAME  "CCPLEX_DYN_6    "
 
#define NVPKCS11_CCPLEX_SAFETY_7_MODEL_NAME   "CCPLEX_SAFE_7   "
 
#define NVPKCS11_CCPLEX_DYNAMIC_7_MODEL_NAME  "CCPLEX_DYN_7    "
 
#define NVPKCS11_CCPLEX_SAFETY_8_MODEL_NAME   "CCPLEX_SAFE_8   "
 
#define NVPKCS11_CCPLEX_DYNAMIC_8_MODEL_NAME  "CCPLEX_DYN_8    "
 
#define NVPKCS11_CCPLEX_SAFETY_9_MODEL_NAME   "CCPLEX_SAFE_9   "
 
#define NVPKCS11_CCPLEX_DYNAMIC_9_MODEL_NAME  "CCPLEX_DYN_9    "
 
#define NVPKCS11_CCPLEX_SAFETY_10_MODEL_NAME  "CCPLEX_SAFE_10  "
 
#define NVPKCS11_CCPLEX_DYNAMIC_10_MODEL_NAME "CCPLEX_DYN_10   "
 
#define NVPKCS11_CCPLEX_SAFETY_11_MODEL_NAME  "CCPLEX_SAFE_11  "
 
#define NVPKCS11_CCPLEX_DYNAMIC_11_MODEL_NAME "CCPLEX_DYN_11   "
 
#define NVPKCS11_CCPLEX_SAFETY_12_MODEL_NAME  "CCPLEX_SAFE_12  "
 
#define NVPKCS11_CCPLEX_DYNAMIC_12_MODEL_NAME "CCPLEX_DYN_12   "
 
#define NVPKCS11_CCPLEX_SAFETY_13_MODEL_NAME  "CCPLEX_SAFE_13  "
 
#define NVPKCS11_CCPLEX_DYNAMIC_13_MODEL_NAME "CCPLEX_DYN_13   "
 
#define NVPKCS11_CCPLEX_SAFETY_14_MODEL_NAME  "CCPLEX_SAFE_14  "
 
#define NVPKCS11_CCPLEX_DYNAMIC_14_MODEL_NAME "CCPLEX_DYN_14   "
 
#define NVPKCS11_TSECRADAR_SAFETY_15_MODEL_NAME    "TSECRADAR_SAFE15"
 
#define NVPKCS11_TSECRADAR_DYNAMIC_15_MODEL_NAME   "TSECRADAR_DYN15 "
 
#ifdef NV_HYPERVISOR
#define NVPKCS11_TOKEN_COUNT 2U
#else
#define NVPKCS11_TOKEN_COUNT 29U
#endif
 
#ifdef NV_HYPERVISOR
#define NVPKCS11_MAX_SESSIONS 4U
#else
#define NVPKCS11_MAX_SESSIONS 256U
#endif
 
#define NVPKCS11_ECDSA_256_KEY_SIZE NVPKCS11_EC_256_POINT_SIZE
 
#define NVPKCS11_EDDSA_256_KEY_SIZE NVPKCS11_EC_256_POINT_SIZE
 
#define NVPKCS11_SHA_MAX_DATA_SIZE (256UL * 0x100000UL)
 
#define NVPKCS11_AES_BUFFER_LIMIT (1U * 0x100000UL)
 
typedef struct __attribute__((__packed__)) ecParameters_t
{
    CK_BYTE identifier; 
    CK_BYTE size; 
    CK_UTF8CHAR printableString[NVPKCS11_MAX_EC_STRING_SIZE]; 
} ecParameters_t;
 
typedef struct __attribute__((__packed__)) uncompressed32BytePoint_t
{
    CK_BYTE identifier; 
    CK_BYTE size; 
    CK_BYTE x962_id; 
    CK_BYTE qX[NVPKCS11_EC_256_POINT_SIZE]; 
    CK_BYTE qY[NVPKCS11_EC_256_POINT_SIZE]; 
} uncompressed32BytePoint_t;
 
typedef struct __attribute__((__packed__)) compressed32BytePoint_t
{
    CK_BYTE identifier; 
    CK_BYTE size; 
    CK_BYTE point[NVPKCS11_EC_256_POINT_SIZE]; 
} compressed32BytePoint_t;
 
typedef compressed32BytePoint_t eddsaPoint_t;
 
typedef uncompressed32BytePoint_t ecdsaPoint_t;
 
/*
 * NVIDIA PKCS11 library supports 3 interfaces:
 * "PKCS 11": this interface name represents 2 interfaces, one which is associated
 * with the Oasis standards version 3.0 CK_FUNCTION_LIST_3_0 structure and the other,
 * with the Oasis standards version 2.40 CK_FUNCTION_LIST structure.
 * "Vendor NVIDIA", this interface name is associated with NV_CK_FUNCTION_LIST
 * structure that contains NVIDIA extension APIs.
 */
 
#define PKCS11_INTERFACE_NAME "PKCS 11"
 
#define NVIDIA_INTERFACE_NAME "Vendor NVIDIA"
 
#endif /* NVPKCS11_PUBLIC_DEFS_H_ */