Key Generation Attributes

Use attribute dictionary keys during cryptographic key generation.

Overview

Use these dictionary keys in the parameter dictionary when you create new cryptographic keys with the SecKeyCreateRandomKey(_:_:) function. The type and size attributes are required, while all others are optional.

With the exception of kSecAttrTokenID, you can specify the optional keys in either the top-level parameter dictionary or in one of the key-specific sub-dictionaries specified by the kSecPrivateKeyAttrs and kSecPublicKeyAttrs attributes. In the latter case, the given attribute applies only to the private or public key, respectively.

Use these keys in exactly the same way for the parameter dictionary you supply to the legacy SecKeyGeneratePair(_:_:_:) function.

Topics

Required

let kSecAttrKeyType: CFString

A key whose value indicates the item's algorithm.

let kSecAttrKeySizeInBits: CFString

A key whose value indicates the number of bits in a cryptographic key.

Key Specific

let kSecPrivateKeyAttrs: CFString

A key whose value is a dictionary of cryptographic key attributes specific to a private key.

let kSecPublicKeyAttrs: CFString

A key whose value is a dictionary of cryptographic key attributes specific to a public key.

Optional

let kSecAttrLabel: CFString

A key whose value is a string indicating the item's label.

let kSecAttrTokenID: CFString

A key whose value indicates that a cryptographic key is in an external store.

let kSecAttrIsPermanent: CFString

A key whose value indicates the item's permanence.

let kSecAttrApplicationTag: CFString

A key whose value indicates the item's private tag.

let kSecAttrEffectiveKeySize: CFString

A key whose value indicates the effective number of bits in a cryptographic key.

let kSecAttrCanEncrypt: CFString

A key whose value is a Boolean that indicates whether the cryptographic key can be used for encryption.

let kSecAttrCanDecrypt: CFString

A key whose value is a Boolean that indicates whether the cryptographic key can be used for decryption.

let kSecAttrCanDerive: CFString

A key whose value is a Boolean that indicates whether the cryptographic key can be used for derivation.

let kSecAttrCanSign: CFString

A key whose value is a Boolean that indicates whether the cryptographic key can be used for digital signing.

let kSecAttrCanVerify: CFString

A key whose value is a Boolean that indicates whether the cryptographic key can be used for signature verification.

let kSecAttrCanWrap: CFString

A key whose value is a Boolean that indicates whether the cryptographic key can be used for wrapping.

let kSecAttrCanUnwrap: CFString

A key whose value is a Boolean that indicates whether the cryptographic key can be used for unwrapping.