nvpkcs11.h

Go to the documentation of this file.

/*
 * Copyright (c) 2020-2024, NVIDIA CORPORATION.  All rights reserved.
 *
 * 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_H_
#include <stddef.h>
#include <stdint.h>
#define NVPKCS11_H_
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define CK_PTR *
 
#define CK_DECLARE_FUNCTION(returnType, name) \
   returnType name
 
#define CK_DECLARE_FUNCTION_POINTER(returnType, name) \
   returnType (* name)
 
#define CK_CALLBACK_FUNCTION(returnType, name) \
   returnType (* name)
 
#ifndef NULL_PTR
#define NULL_PTR NULL
#endif
 
 
/* Defines PKCS11 standard interface constants, data structures and function
 * prototype definitions for HPSE NVIDIA Tegra products.
 */
#include "pkcs11.h"
#include "nvpkcs11_future.h"
 
 
typedef CK_ULONG CK_NVIDIA_CHANNEL_HANDLE;
typedef CK_NVIDIA_CHANNEL_HANDLE CK_PTR CK_NVIDIA_CHANNEL_HANDLE_PTR;
 
typedef CK_FLAGS CK_NVIDIA_FLAGS;
typedef CK_NVIDIA_FLAGS CK_PTR CK_NVIDIA_FLAGS_PTR;
 
typedef struct NV_CK_FUNCTION_LIST NV_CK_FUNCTION_LIST;
typedef NV_CK_FUNCTION_LIST CK_PTR NV_CK_FUNCTION_LIST_PTR;
typedef NV_CK_FUNCTION_LIST_PTR CK_PTR NV_CK_FUNCTION_LIST_PTR_PTR;
 
 
#define CKF_NVIDIA_ZERO_COPY            (0x00000001UL)  
#define CKF_NVIDIA_GCM_DECRYPT_UNAVAILABLE  (0x00000002UL)  
#define CKF_NVIDIA_HMAC_SIGN            (0x0100000000UL) 
#define CKF_NVIDIA_HMAC_VERIFY          (0x0200000000UL) 
#define CKF_NVIDIA_HMAC_MESSAGE_SIGN        (0x0400000000UL) 
#define CKF_NVIDIA_HMAC_MESSAGE_VERIFY      (0x0800000000UL) 
#define CKF_NVIDIA_TOKEN_OK         (0x02000000UL)  
#define CKF_NVIDIA_SECURE_STORAGE_FAILED    (0x04000000UL)  
#define CKF_NVIDIA_SECURE_STORAGE_TAMPERED  (0x08000000UL)  
#define CKF_NVIDIA_KEYLOAD_TIMEOUT      (0x10000000UL)  
#define CKF_NVIDIA_KEYLOAD_FAILED       (0x20000000UL)  
#define CKF_NVIDIA_TOKEN_ERROR          (0x40000000UL)  
#define CKF_NVIDIA_SECURE_STORAGE_NOT_PROVISIONED (0x80000000UL)  
#define CKF_NVIDIA_SECURE_STORAGE_NOT_PRESENT   (0x100000000UL)  
#define CKF_NVIDIA_KAT_TEST_NONE        (0x00000001UL)  
#define CKF_NVIDIA_KAT_TEST_START       (0x00000002UL)  
#define CKF_NVIDIA_KAT_TEST_PASS        (0x00000004UL)  
#define CKF_NVIDIA_KAT_TEST_FAIL        (0x00000008UL)  
#define CKF_NVIDIA_KAT_TEST_BYPASS      (0x00000010UL)  
#define CKF_NVIDIA_KAT_TEST_LIMIT_INIT      (0x00000020UL)  
#define CKR_NVIDIA_CHANNEL_NOT_FOUND        (CKR_VENDOR_DEFINED | 0x000000007UL)  
#define CKR_NVIDIA_CHANNEL_CANNOT_OPEN      (CKR_VENDOR_DEFINED | 0x000000008UL)  
#define CKR_NVIDIA_SECURE_STORAGE_FAILED    (CKR_VENDOR_DEFINED | 0x000000009UL)  
#define CKR_NVIDIA_SECURE_STORAGE_TAMPERED  (CKR_VENDOR_DEFINED | 0x000000010UL)  
#define CKR_NVIDIA_OBJECTS_CHANGED      (CKR_VENDOR_DEFINED | 0x000000011UL)  
#define CKR_NVIDIA_FUNCTION_NOT_ALLOWED_IN_SYSTEM_STATE (CKR_VENDOR_DEFINED | 0x000000012UL)  
#define CKR_NVIDIA_CRYPTOKI_UNAVAILABLE     (CKR_VENDOR_DEFINED | 0x000000013UL)  
#define CKA_NVIDIA_CALLER_NONCE (CKA_VENDOR_DEFINED | 0x00000001UL)  
extern CK_RV C_NVIDIA_EncryptGetIV
(
    CK_SESSION_HANDLE hSession,
    CK_BYTE_PTR pIV,
    CK_BYTE_PTR pIVLen
);
 
#define C_EncryptGetIV C_NVIDIA_EncryptGetIV
 
typedef CK_RV (* CK_C_NVIDIA_EncryptGetIV)
(
    CK_SESSION_HANDLE hSession,
    CK_BYTE_PTR pIV,
    CK_BYTE_PTR pIVLen
);
 
extern CK_RV C_NVIDIA_CommitTokenObjects
(
    CK_SESSION_HANDLE hSession,
    CK_FLAGS flags
);
 
typedef CK_RV (* CK_C_NVIDIA_CommitTokenObjects)
(
    CK_SESSION_HANDLE hSession,
    CK_FLAGS flags
);
 
 
extern CK_RV C_NVIDIA_InitializeChannel
(
    CK_ULONG ulChannelId,
    CK_NVIDIA_CHANNEL_HANDLE_PTR phChannel,
    CK_NVIDIA_FLAGS_PTR pFlags
);
 
typedef CK_RV (* CK_C_NVIDIA_InitializeChannel)
(
    CK_ULONG ulChannelId,
    CK_NVIDIA_CHANNEL_HANDLE_PTR phChannel,
    CK_NVIDIA_FLAGS_PTR pFlags
);
 
 
typedef struct CK_NVIDIA_CHANNEL_ATTRIBUTE {
    CK_FLAGS operations;                       
    CK_NVIDIA_CHANNEL_HANDLE hChannel;         
} CK_NVIDIA_CHANNEL_ATTRIBUTE;
 
typedef CK_NVIDIA_CHANNEL_ATTRIBUTE CK_PTR CK_NVIDIA_CHANNEL_ATTRIBUTE_PTR; 
extern CK_RV C_NVIDIA_OpenSession
(
    CK_SLOT_ID slotID,
    CK_FLAGS flags,
    CK_VOID_PTR pApplication,
    CK_NOTIFY Notify,
    CK_SESSION_HANDLE_PTR phSession,
    CK_NVIDIA_CHANNEL_ATTRIBUTE_PTR pChannelSettings,
    CK_ULONG ulChannelSettingsCount,
    CK_NVIDIA_FLAGS additionalFlags
);
 
typedef CK_RV (* CK_C_NVIDIA_OpenSession)
(
    CK_SLOT_ID slotID,
    CK_FLAGS flags,
    CK_VOID_PTR pApplication,
    CK_NOTIFY Notify,
    CK_SESSION_HANDLE_PTR phSession,
    CK_NVIDIA_CHANNEL_ATTRIBUTE_PTR pChannelSettings,
    CK_ULONG ulChannelSettingsCount,
    CK_NVIDIA_FLAGS additionalFlags
);
 
 
extern CK_RV C_NVIDIA_FinalizeChannel
(
    CK_NVIDIA_CHANNEL_HANDLE hChannel
);
 
typedef CK_RV (* CK_C_NVIDIA_FinalizeChannel)
(
    CK_NVIDIA_CHANNEL_HANDLE hChannel
);
 
extern CK_RV C_NVIDIA_SetKATParameters
(
    CK_FLAGS flags
);
 
typedef CK_RV (* CK_C_NVIDIA_SetKATParameters)
(
    CK_FLAGS flags
);
 
extern CK_RV C_NVIDIA_BatchMessageSignInit(CK_SESSION_HANDLE hSession,
                       CK_MECHANISM_PTR pMechanism,
                       CK_OBJECT_HANDLE_PTR phKeys,
                       CK_ULONG ulKeysCount);
 
typedef CK_RV (* CK_C_NVIDIA_BatchMessageSignInit)
(
    CK_SESSION_HANDLE hSession,
    CK_MECHANISM_PTR pMechanism,
    CK_OBJECT_HANDLE_PTR phKeys,
    CK_ULONG ulKeysCount
);
 
typedef struct CK_NVIDIA_BATCH_SIGN_ENTRY {
    CK_VOID_PTR pParameter;               
    CK_ULONG ulParameterLen;              
    CK_BYTE_PTR pData;                    
    CK_ULONG ulDataLen;                   
    CK_BYTE_PTR pSignature;               
    CK_ULONG_PTR pulSignatureLen;         
    CK_NVIDIA_FLAGS additionalFlags;      
        CK_RV rv;                             
} CK_NVIDIA_BATCH_SIGN_ENTRY;
 
typedef CK_NVIDIA_BATCH_SIGN_ENTRY CK_PTR CK_NVIDIA_BATCH_SIGN_ENTRY_PTR;
 
extern CK_RV C_NVIDIA_BatchSignMessage(CK_SESSION_HANDLE hSession,
                       CK_NVIDIA_BATCH_SIGN_ENTRY_PTR pBatchEntry,
                       CK_ULONG ulBatchEntryCount);
 
typedef CK_RV (* CK_C_NVIDIA_BatchSignMessage)
(
    CK_SESSION_HANDLE hSession,
    CK_NVIDIA_BATCH_SIGN_ENTRY_PTR pBatchEntry,
    CK_ULONG ulBatchEntryCount
);
 
extern CK_RV C_NVIDIA_BatchMessageSignFinal(CK_SESSION_HANDLE hSession);
 
typedef CK_RV (* CK_C_NVIDIA_BatchMessageSignFinal)
(
    CK_SESSION_HANDLE hSession
);
 
extern CK_RV C_NVIDIA_BatchMessageVerifyInit(CK_SESSION_HANDLE hSession,
                         CK_MECHANISM_PTR pMechanism,
                         CK_OBJECT_HANDLE_PTR phKeys,
                         CK_ULONG ulKeysCount);
 
typedef CK_RV (* CK_C_NVIDIA_BatchMessageVerifyInit)
(
    CK_SESSION_HANDLE hSession,
    CK_MECHANISM_PTR pMechanism,
    CK_OBJECT_HANDLE_PTR phKeys,
    CK_ULONG ulKeysCount
);
 
typedef struct CK_NVIDIA_BATCH_VERIFY_ENTRY {
    CK_VOID_PTR pParameter;               
    CK_ULONG ulParameterLen;              
    CK_BYTE_PTR pData;                    
    CK_ULONG ulDataLen;                   
    CK_BYTE_PTR pSignature;               
    CK_ULONG ulSignatureLen;              
    CK_NVIDIA_FLAGS additionalFlags;      
        CK_RV rv;                             
} CK_NVIDIA_BATCH_VERIFY_ENTRY;
 
typedef CK_NVIDIA_BATCH_VERIFY_ENTRY CK_PTR CK_NVIDIA_BATCH_VERIFY_ENTRY_PTR;
 
extern CK_RV C_NVIDIA_BatchVerifyMessage(CK_SESSION_HANDLE hSession,
                       CK_NVIDIA_BATCH_VERIFY_ENTRY_PTR pBatchEntry,
                       CK_ULONG ulBatchEntryCount);
 
typedef CK_RV (* CK_C_NVIDIA_BatchVerifyMessage)
(
    CK_SESSION_HANDLE hSession,
    CK_NVIDIA_BATCH_VERIFY_ENTRY_PTR pBatchEntry,
    CK_ULONG ulBatchEntryCount
);
 
extern CK_RV C_NVIDIA_BatchMessageVerifyFinal(CK_SESSION_HANDLE hSession);
 
typedef CK_RV (* CK_C_NVIDIA_BatchMessageVerifyFinal)
(
    CK_SESSION_HANDLE hSession
);
 
struct NV_CK_FUNCTION_LIST {
    CK_VERSION NV_version; 
    CK_C_NVIDIA_EncryptGetIV C_NVIDIA_EncryptGetIV; 
    CK_C_NVIDIA_CommitTokenObjects C_NVIDIA_CommitTokenObjects; 
    CK_C_NVIDIA_InitializeChannel C_NVIDIA_InitializeChannel; 
    CK_C_NVIDIA_OpenSession C_NVIDIA_OpenSession; 
    CK_C_NVIDIA_FinalizeChannel C_NVIDIA_FinalizeChannel; 
    CK_C_NVIDIA_SetKATParameters C_NVIDIA_SetKATParameters; 
    CK_C_NVIDIA_BatchMessageSignInit C_NVIDIA_BatchMessageSignInit; 
    CK_C_NVIDIA_BatchSignMessage C_NVIDIA_BatchSignMessage; 
    CK_C_NVIDIA_BatchMessageSignFinal C_NVIDIA_BatchMessageSignFinal; 
    CK_C_NVIDIA_BatchMessageVerifyInit C_NVIDIA_BatchMessageVerifyInit; 
    CK_C_NVIDIA_BatchVerifyMessage C_NVIDIA_BatchVerifyMessage; 
    CK_C_NVIDIA_BatchMessageVerifyFinal C_NVIDIA_BatchMessageVerifyFinal; 
};
 
#define CKM_NVIDIA_AES_CBC_KEY_DATA_WRAP (CKM_VENDOR_DEFINED | 0x00000001UL)
 
typedef struct CK_NVIDIA_AES_CBC_KEY_DATA_WRAP_PARAMS {
    CK_BYTE_PTR      pData;         
    CK_ULONG         ulLen;         
    CK_OBJECT_HANDLE hTrailingKey;  
    CK_BYTE          iv[16];        
} CK_NVIDIA_AES_CBC_KEY_DATA_WRAP_PARAMS;
 
typedef CK_NVIDIA_AES_CBC_KEY_DATA_WRAP_PARAMS CK_PTR CK_NVIDIA_AES_CBC_KEY_DATA_WRAP_PARAMS_PTR;
 
#define CKM_NVIDIA_SP800_56C_TWO_STEPS_KDF (CKM_VENDOR_DEFINED | 0x00000002UL)
 
typedef struct CK_NVIDIA_SP800_56C_TWO_STEPS_KDF_PARAMS {
    CK_MECHANISM_TYPE prfType;   
    CK_BYTE_PTR       pSalt;     
    CK_ULONG          ulSaltLen; 
    CK_BYTE_PTR       pInfo;     
    CK_ULONG          ulInfoLen; 
    CK_BYTE           ctr;       
} CK_NVIDIA_SP800_56C_TWO_STEPS_KDF_PARAMS;
 
typedef CK_NVIDIA_SP800_56C_TWO_STEPS_KDF_PARAMS CK_PTR CK_NVIDIA_SP800_56C_TWO_STEPS_KDF_PARAMS_PTR;
 
#define CKM_NVIDIA_MACSEC_AES_KEY_WRAP (CKM_VENDOR_DEFINED | 0x00000003UL)
 
typedef struct CK_NVIDIA_MACSEC_AES_KEY_WRAP_PARAMS {
   CK_BYTE_PTR      pIv;                    
   CK_ULONG         ulIvLen;                
   CK_BYTE_PTR      pMACsecMetadata;        
   CK_ULONG         ulMACsecMetadataLen;    
}  CK_NVIDIA_MACSEC_AES_KEY_WRAP_PARAMS;
 
typedef CK_NVIDIA_MACSEC_AES_KEY_WRAP_PARAMS CK_PTR CK_NVIDIA_MACSEC_AES_KEY_WRAP_PARAMS_PTR;
 
typedef struct CK_NVIDIA_ZERO_COPY_ENTRY {
    uint64_t iova;                    
    CK_BYTE_PTR pVa;                  
    CK_ULONG ulDataLen;               
    CK_NVIDIA_FLAGS pFlags;           
} CK_NVIDIA_ZERO_COPY_ENTRY;
 
typedef CK_NVIDIA_ZERO_COPY_ENTRY CK_PTR CK_NVIDIA_ZERO_COPY_ENTRY_PTR;
 
typedef struct CK_NVIDIA_ZERO_COPY_LIST
{
    CK_ULONG  ulDataArrayCount;                  
    CK_NVIDIA_ZERO_COPY_ENTRY_PTR pZeroCopyData;  
} CK_NVIDIA_ZERO_COPY_LIST;
 
typedef CK_NVIDIA_ZERO_COPY_LIST CK_PTR CK_NVIDIA_ZERO_COPY_LIST_PTR;
 
#define CKM_NVIDIA_PSC_AES_CMAC (CKM_VENDOR_DEFINED | 0x00000004UL)
 
#define CKM_NVIDIA_AES_GCM_KEY_UNWRAP (CKM_VENDOR_DEFINED | 0x00000005UL)
 
#define CKM_NVIDIA_OX5B_SHA256_KEY_DERIVATION (CKM_VENDOR_DEFINED | 0x00000006UL)
 
typedef struct CK_NVIDIA_OX5B_SHA256_KEY_DERIVATION_PARAMS {
    CK_BYTE_PTR    pUid;              
    CK_ULONG       ulUidLen;          
    CK_BYTE_PTR    pNonce;            
    CK_ULONG       ulNonceLen;        
    CK_BYTE        signature[32];     
}  CK_NVIDIA_OX5B_SHA256_KEY_DERIVATION_PARAMS;
 
typedef CK_NVIDIA_OX5B_SHA256_KEY_DERIVATION_PARAMS CK_PTR CK_NVIDIA_OX5B_SHA256_KEY_DERIVATION_PARAMS_PTR;
 
#define CKM_NVIDIA_SP800_56A_ONE_STEP_KDF (CKM_VENDOR_DEFINED | 0x00000007UL)
 
typedef struct CK_NVIDIA_SP800_56A_ONE_STEP_KDF_PARAMS {
    CK_OBJECT_HANDLE  hExtraKey;   
    CK_MECHANISM_TYPE prfType;     
    CK_BYTE_PTR       pInfo;       
    CK_ULONG          ulInfoLen;   
    CK_ULONG          ulKeyOffset; 
} CK_NVIDIA_SP800_56A_ONE_STEP_KDF_PARAMS;
 
typedef CK_NVIDIA_SP800_56A_ONE_STEP_KDF_PARAMS CK_PTR CK_NVIDIA_SP800_56A_ONE_STEP_KDF_PARAMS_PTR;
 
#define CKM_NVIDIA_TSECRADAR_AES_CMAC (CKM_VENDOR_DEFINED | 0x00000008UL)
 
#ifdef __cplusplus
}
#endif
 
#endif /* NVPKCS11_H_ */