xilasu
Vitis Drivers API Documentation
XAsu_KeyWrapParams Struct Reference

This structure contains Key wrap unwrap params info. More...

Data Fields

u64 InputDataAddr
 Address of the input data buffer which holds: Plain key for key wrap or wrapped key for key unwrap. More...
 
u64 OutputDataAddr
 Address of the output buffer to store: the wrapped key for key wrap or unwrapped key for key unwrap. More...
 
u64 ExpoCompAddr
 Address of the RSA exponent data. More...
 
u64 KeyCompAddr
 RSA key component address of type: XAsu_RsaPubKeyComp for key wrap and XAsu_RsaPvtKeyComp for key unwrap. More...
 
u64 OptionalLabelAddr
 RSA optional label address for OAEP padding. More...
 
u64 ActualOutuputDataLenAddr
 Actual output data length which is returned from key wrap/unwrap operation. More...
 
u32 InputDataLen
 Input data Len. More...
 
u32 RsaKeySize
 RSA Key Size. More...
 
u32 OptionalLabelSize
 RSA optional label size for OAEP padding. More...
 
u32 OutuputDataLen
 Output Data Len is an input from user which specifies the output wrapped key length in wrap operation and in unwrap operation it is the size of output buffer which should be equal or greater than the size of the unwrapped input. More...
 
u8 AesKeySize
 AES Key Size - 128 Bit: XASU_AES_KEY_SIZE_128_BITS or 256 Bit : XASU_AES_KEY_SIZE_256_BITS. More...
 
u8 ShaType
 Hash family type (XASU_SHA2_TYPE / XASU_SHA3_TYPE) More...
 
u8 ShaMode
 
       SHA Mode, where XASU_SHA_MODE_SHAKE256 is valid only for SHA3 Type

(XASU_SHA_MODE_SHA256 / XASU_SHA_MODE_SHA384 / XASU_SHA_MODE_SHA512 / XASU_SHA_MODE_SHAKE256) More...

 
u8 Reserved
 Reserved. More...
 

Detailed Description

This structure contains Key wrap unwrap params info.

Field Documentation

u64 XAsu_KeyWrapParams::ActualOutuputDataLenAddr

Actual output data length which is returned from key wrap/unwrap operation.

Referenced by XAsu_KeyUnwrap(), XAsu_KeyWrap(), and XAsu_KeyWrapUnwrapValidateInputParams().

u8 XAsu_KeyWrapParams::AesKeySize

AES Key Size - 128 Bit: XASU_AES_KEY_SIZE_128_BITS or 256 Bit : XASU_AES_KEY_SIZE_256_BITS.

Referenced by XAsu_KeyWrapUnwrapValidateInputParams().

u64 XAsu_KeyWrapParams::ExpoCompAddr

Address of the RSA exponent data.

u64 XAsu_KeyWrapParams::InputDataAddr

Address of the input data buffer which holds: Plain key for key wrap or wrapped key for key unwrap.

Referenced by XAsu_KeyWrapUnwrapValidateInputParams().

u32 XAsu_KeyWrapParams::InputDataLen

Input data Len.

Referenced by XAsu_KeyWrapUnwrapValidateInputParams().

u64 XAsu_KeyWrapParams::KeyCompAddr

RSA key component address of type: XAsu_RsaPubKeyComp for key wrap and XAsu_RsaPvtKeyComp for key unwrap.

Referenced by XAsu_KeyWrapUnwrapValidateInputParams().

u64 XAsu_KeyWrapParams::OptionalLabelAddr

RSA optional label address for OAEP padding.

Referenced by XAsu_KeyWrapUnwrapValidateInputParams().

u32 XAsu_KeyWrapParams::OptionalLabelSize

RSA optional label size for OAEP padding.

Referenced by XAsu_KeyWrapUnwrapValidateInputParams().

u64 XAsu_KeyWrapParams::OutputDataAddr

Address of the output buffer to store: the wrapped key for key wrap or unwrapped key for key unwrap.

Referenced by XAsu_KeyWrapUnwrapValidateInputParams().

u32 XAsu_KeyWrapParams::OutuputDataLen

Output Data Len is an input from user which specifies the output wrapped key length in wrap operation and in unwrap operation it is the size of output buffer which should be equal or greater than the size of the unwrapped input.

Referenced by XAsu_KeyWrapUnwrapValidateInputParams().

u8 XAsu_KeyWrapParams::Reserved

Reserved.

u32 XAsu_KeyWrapParams::RsaKeySize

RSA Key Size.

Referenced by XAsu_KeyWrapUnwrapValidateInputParams().

u8 XAsu_KeyWrapParams::ShaMode

       SHA Mode, where XASU_SHA_MODE_SHAKE256 is valid only for SHA3 Type

(XASU_SHA_MODE_SHA256 / XASU_SHA_MODE_SHA384 / XASU_SHA_MODE_SHA512 / XASU_SHA_MODE_SHAKE256)

Referenced by XAsu_KeyWrapUnwrapValidateInputParams().

u8 XAsu_KeyWrapParams::ShaType

Hash family type (XASU_SHA2_TYPE / XASU_SHA3_TYPE)

Referenced by XAsu_KeyUnwrap(), XAsu_KeyWrap(), and XAsu_KeyWrapUnwrapValidateInputParams().