NXP Reader Library  v17.1.0.2535
Commands_CertificateKeyManagement

Describes about the NTAG X DNA Certificate Management commands. More...

Collaboration diagram for Commands_CertificateKeyManagement:

Modules

 Defines
 Macro Definitions for Certificate Management commands.
 

Functions

phStatus_t phalNtagXDna_ManageCertRepo (void *pDataParams, uint8_t bComOption, uint8_t bAction, uint8_t bRepoID, uint8_t *pData, uint16_t wDataLen)
 Manages Certificate Repositories. More...
 
phStatus_t phalNtagXDna_ReadCertRepo (void *pDataParams, uint8_t bOption, uint8_t bRepoID, uint8_t bDataItem, uint8_t **ppResponse, uint16_t *pRspLen)
 Perform Certificate Repository Read. More...
 

Detailed Description

Describes about the NTAG X DNA Certificate Management commands.

Function Documentation

◆ phalNtagXDna_ManageCertRepo()

phStatus_t phalNtagXDna_ManageCertRepo ( void *  pDataParams,
uint8_t  bComOption,
uint8_t  bAction,
uint8_t  bRepoID,
uint8_t pData,
uint16_t  wDataLen 
)

Manages Certificate Repositories.

Returns
Status code
Return values
PH_ERR_SUCCESSOperation successful.
PH_ERR_INVALID_DATA_PARAMSIf DataParams is null.
PH_ERR_INVALID_PARAMETER
  • If the buffers are null.
  • The values provided in bComOption is not supported.
XXXX
  • Depending on status codes return by tag.
  • Other Depending on implementation and underlying component.
Parameters
[in]pDataParams[In] Pointer to this layer's parameter structure.
[in]bComOption[In] Indicates the mode of communication to be used while exchanging the data to tag.
[in]bAction[In] Target action to perform. Should be one of the below values.
[in]bRepoID[In] ID used to identify certificate repository for algorithm execution and repository modification. Note - the certificate Id shall be used to reference a private key/certificate chain when performing SIGMA-I
[in]pData[In] Data to be exchanged to tag based on bAction information.
[in]wDataLen[In] Length of bytes available in pData buffer.

◆ phalNtagXDna_ReadCertRepo()

phStatus_t phalNtagXDna_ReadCertRepo ( void *  pDataParams,
uint8_t  bOption,
uint8_t  bRepoID,
uint8_t  bDataItem,
uint8_t **  ppResponse,
uint16_t pRspLen 
)

Perform Certificate Repository Read.

Returns information related to certificate repositories

Note
  • Chaining upto the size of below mentioned buffers are handled within this interface. If more data is to be read, the user has to call this function again with bOption = PH_EXCHANGE_RXCHAINING | one of the communication options.
Returns
Status code
Return values
PH_ERR_SUCCESSOperation successful.
PH_ERR_INVALID_DATA_PARAMSIf DataParams is null.
PH_ERR_INVALID_PARAMETER
  • If the buffers are null.
  • The values provided in bOption is not supported.
  • For Invalid Exchange option value (bOption).
XXXX
  • Depending on status codes return by tag.
  • Other Depending on implementation and underlying component.
Parameters
[in]pDataParams[In] Pointer to this layer's parameter structure.
[in]bOption[In] Options for processing of Secure Messaging and reading of data.
[in]bRepoID[In] ID used to identify certificate repository.
[in]bDataItem[In] Data Item to be used for receiving the information. Should be one of the below values.
[out]ppResponse[Out] Response based on bDataItem information .
[out]pRspLen[Out] Length of bytes available in pRspLen buffer.