11.12.3.4.265. Function sss_se05x_key_object_allocate_handle

11.12.3.4.265.1. Function Documentation

sss_status_t sss_se05x_key_object_allocate_handle(sss_se05x_object_t *keyObject, uint32_t keyId, sss_key_part_t keyPart, sss_cipher_type_t cipherType, size_t keyByteLenMax, uint32_t options)

Allocate / pre-provision memory for new key.

           This API allows underlying cryptographic subsystems to perform
           preconditions of before creating any cryptographic key object.

On SE050, the memory get reserved only when the actual object is created and hence there is no memory reservation happening in this API call. but internally it checks if the object already exists or not . if the object is already existing it returns a failure.

Return

Status of object allocation.

Parameters
  • [inout] keyObject: The object If required, update implementation defined values inside the keyObject

  • keyId: External Key ID. Later on this may be used by sss_key_object_get_handle

  • keyPart: See sss_key_part_t

  • cipherType: See sss_cipher_type_t

  • keyByteLenMax: Maximum storage this type of key may need. For systems that have their own internal allocation table this would help

  • options: 0 = Persistant Key (Default) or Transient Key. See sss_key_object_mode_t