description
TypeScriptget description(): stringvar description: String { get }A human-readable description of the code.
System · IOS API REFERENCE
CryptoKit
Perform cryptographic operations securely and efficiently.
184 types
418 callable entries
75 skipped
85% entry coverage
Generated from iOS SDK 27.1. Availability is shown on each declaration; permissions and entitlements still apply.
Types
AES
enum · iOS 13.0+
AES.GCM
enum · iOS 13.0+
AES.GCM.Nonce
struct · iOS 13.0+
AES.GCM.Nonce.Element
typealias · iOS 13.0+
AES.GCM.Nonce.Iterator
typealias · iOS 13.0+
AES.GCM.SealedBox
struct · iOS 13.0+
AES.KeyWrap
enum · iOS 15.0+
ChaChaPoly
enum · iOS 13.0+
ChaChaPoly.Nonce
struct · iOS 13.0+
ChaChaPoly.Nonce.Element
typealias · iOS 13.0+
ChaChaPoly.Nonce.Iterator
typealias · iOS 13.0+
ChaChaPoly.SealedBox
struct · iOS 13.0+
CorecryptoCurveType
struct · iOS 18.0+
CryptoKitASN1Error
enum · iOS 14.0+
CryptoKitError
enum · iOS 13.0+
CryptoKitMetaError
typealias
Curve25519
enum · iOS 13.0+
Curve25519.KeyAgreement
enum · iOS 13.0+
Curve25519.KeyAgreement.PrivateKey
struct · iOS 13.0+
Curve25519.KeyAgreement.PrivateKey.PublicKey
typealias · iOS 13.0+
Curve25519.KeyAgreement.PublicKey
struct · iOS 13.0+
Curve25519.KeyAgreement.PublicKey.EphemeralPrivateKey
typealias · iOS 17.0+
Curve25519.KeyAgreement.PublicKey.HPKEEphemeralPrivateKey
typealias · iOS 17.0+
Curve25519.Signing
enum · iOS 13.0+
Curve25519.Signing.PrivateKey
struct · iOS 13.0+
Curve25519.Signing.PublicKey
struct · iOS 13.0+
DiffieHellmanKeyAgreement
protocol · iOS 17.0+
Digest
protocol · iOS 13.0+
HashedAuthenticationCode
struct · iOS 13.0+
HashedAuthenticationCode.Element
typealias · iOS 13.0+
HashedAuthenticationCode.Iterator
typealias · iOS 13.0+
HashFunction
protocol · iOS 13.0+
HKDF
struct · iOS 14.0+
HMAC
struct · iOS 13.0+
HMAC.Key
typealias · iOS 13.0+
HMAC.MAC
typealias · iOS 13.0+
HPKE
enum · iOS 17.0+
HPKE.AEAD
enum · iOS 17.0+
HPKE.AEAD.AllCases
typealias · iOS 17.0+
HPKE.Ciphersuite
struct · iOS 17.0+
HPKE.DHKEM
enum · iOS 17.0+
HPKE.Errors
enum · iOS 17.0+
HPKE.KDF
enum · iOS 17.0+
HPKE.KDF.AllCases
typealias · iOS 17.0+
HPKE.KEM
enum · iOS 17.0+
HPKE.KEM.AllCases
typealias · iOS 17.0+
HPKE.Recipient
struct · iOS 17.0+
HPKE.Sender
struct · iOS 17.0+
HPKEDiffieHellmanPrivateKey
protocol · iOS 17.0+
HPKEDiffieHellmanPrivateKeyGeneration
protocol · iOS 17.0+
HPKEDiffieHellmanPublicKey
protocol · iOS 17.0+
HPKEKEMPrivateKey
protocol · iOS 26.0+
HPKEKEMPrivateKeyGeneration
protocol · iOS 26.0+
HPKEKEMPublicKey
protocol · iOS 26.0+
HPKEPublicKeySerialization
protocol · iOS 17.0+
Insecure
enum · iOS 13.0+
Insecure.MD5
struct · iOS 13.0+
Insecure.MD5.Digest
typealias · iOS 13.0+
Insecure.MD5Digest
struct · iOS 13.0+
Insecure.MD5Digest.Element
typealias · iOS 13.0+
Insecure.MD5Digest.Iterator
typealias · iOS 13.0+
Insecure.SHA1
struct · iOS 13.0+
Insecure.SHA1.Digest
typealias · iOS 13.0+
Insecure.SHA1Digest
struct · iOS 13.0+
Insecure.SHA1Digest.Element
typealias · iOS 13.0+
Insecure.SHA1Digest.Iterator
typealias · iOS 13.0+
KEM
enum · iOS 17.0+
KEM.EncapsulationResult
struct · iOS 17.0+
KEM.Errors
enum · iOS 26.0+
KEMOneTimePrivateKey
protocol · iOS 27.0+
KEMPrivateKey
protocol · iOS 17.0+
KEMPublicKey
protocol · iOS 17.0+
MessageAuthenticationCode
protocol · iOS 13.0+
MLDSA65
enum · iOS 26.0+
MLDSA65.PrivateKey
struct · iOS 26.0+
MLDSA65.PublicKey
struct · iOS 26.0+
MLDSA87
enum · iOS 26.0+
MLDSA87.PrivateKey
struct · iOS 26.0+
MLDSA87.PublicKey
struct · iOS 26.0+
MLKEM1024
enum · iOS 26.0+
MLKEM1024.OneTimePrivateKey
struct · iOS 27.0+
MLKEM1024.OneTimePrivateKey.PublicKey
typealias · iOS 27.0+
MLKEM1024.PrivateKey
struct · iOS 26.0+
MLKEM1024.PrivateKey.PublicKey
typealias · iOS 26.0+
MLKEM1024.PublicKey
struct · iOS 26.0+
MLKEM768
enum · iOS 26.0+
MLKEM768.OneTimePrivateKey
struct · iOS 27.0+
MLKEM768.OneTimePrivateKey.PublicKey
typealias · iOS 27.0+
MLKEM768.PrivateKey
struct · iOS 26.0+
MLKEM768.PrivateKey.PublicKey
typealias · iOS 26.0+
MLKEM768.PublicKey
struct · iOS 26.0+
P256
enum · iOS 13.0+
P256.KeyAgreement
enum · iOS 13.0+
P256.KeyAgreement.PrivateKey
struct · iOS 13.0+
P256.KeyAgreement.PrivateKey.PublicKey
typealias · iOS 13.0+
P256.KeyAgreement.PublicKey
struct · iOS 13.0+
P256.KeyAgreement.PublicKey.EphemeralPrivateKey
typealias · iOS 17.0+
P256.KeyAgreement.PublicKey.HPKEEphemeralPrivateKey
typealias · iOS 17.0+
P256.Signing
enum · iOS 13.0+
P256.Signing.ECDSASignature
struct · iOS 13.0+
P256.Signing.PrivateKey
struct · iOS 13.0+
P256.Signing.PublicKey
struct · iOS 13.0+
P384
enum · iOS 13.0+
P384.KeyAgreement
enum · iOS 13.0+
P384.KeyAgreement.PrivateKey
struct · iOS 13.0+
P384.KeyAgreement.PrivateKey.PublicKey
typealias · iOS 13.0+
P384.KeyAgreement.PublicKey
struct · iOS 13.0+
P384.KeyAgreement.PublicKey.EphemeralPrivateKey
typealias · iOS 17.0+
P384.Signing
enum · iOS 13.0+
P384.Signing.ECDSASignature
struct · iOS 13.0+
P384.Signing.PrivateKey
struct · iOS 13.0+
P384.Signing.PublicKey
struct · iOS 13.0+
P521
enum · iOS 13.0+
P521.KeyAgreement
enum · iOS 13.0+
P521.KeyAgreement.PrivateKey
struct · iOS 13.0+
P521.KeyAgreement.PrivateKey.PublicKey
typealias · iOS 13.0+
P521.KeyAgreement.PublicKey
struct · iOS 13.0+
P521.KeyAgreement.PublicKey.EphemeralPrivateKey
typealias · iOS 17.0+
P521.KeyAgreement.PublicKey.HPKEEphemeralPrivateKey
typealias · iOS 17.0+
P521.Signing
enum · iOS 13.0+
P521.Signing.ECDSASignature
struct · iOS 13.0+
P521.Signing.PrivateKey
struct · iOS 13.0+
P521.Signing.PublicKey
struct · iOS 13.0+
SecureEnclave
enum · iOS 13.0+
SecureEnclave.MLDSA65
enum · iOS 26.0+
SecureEnclave.MLDSA65.PrivateKey
struct · iOS 26.0+
SecureEnclave.MLDSA87
enum · iOS 26.0+
SecureEnclave.MLDSA87.PrivateKey
struct · iOS 26.0+
SecureEnclave.MLKEM1024
enum · iOS 26.0+
SecureEnclave.MLKEM1024.PrivateKey
struct · iOS 26.0+
SecureEnclave.MLKEM1024.PrivateKey.PublicKey
typealias · iOS 26.0+
SecureEnclave.MLKEM768
enum · iOS 26.0+
SecureEnclave.MLKEM768.PrivateKey
struct · iOS 26.0+
SecureEnclave.MLKEM768.PrivateKey.PublicKey
typealias · iOS 26.0+
SecureEnclave.P256
enum · iOS 13.0+
SecureEnclave.P256.KeyAgreement
enum · iOS 13.0+
SecureEnclave.P256.KeyAgreement.PrivateKey
struct · iOS 13.0+
SecureEnclave.P256.KeyAgreement.PrivateKey.PublicKey
typealias · iOS 13.0+
SecureEnclave.P256.Signing
enum · iOS 13.0+
SecureEnclave.P256.Signing.PrivateKey
struct · iOS 13.0+
SHA2_256
typealias · iOS 26.0+
SHA2_384
typealias · iOS 26.0+
SHA2_512
typealias · iOS 26.0+
SHA256
struct · iOS 13.0+
SHA256.Digest
typealias · iOS 13.0+
SHA256Digest
struct · iOS 13.0+
SHA256Digest.Element
typealias · iOS 13.0+
SHA256Digest.Iterator
typealias · iOS 13.0+
SHA3_256
struct · iOS 26.0+
SHA3_256.Digest
typealias · iOS 26.0+
SHA3_256Digest
struct · iOS 26.0+
SHA3_256Digest.Element
typealias · iOS 26.0+
SHA3_256Digest.Iterator
typealias · iOS 26.0+
SHA3_384
struct · iOS 26.0+
SHA3_384.Digest
typealias · iOS 26.0+
SHA3_384Digest
struct · iOS 26.0+
SHA3_384Digest.Element
typealias · iOS 26.0+
SHA3_384Digest.Iterator
typealias · iOS 26.0+
SHA3_512
struct · iOS 26.0+
SHA3_512.Digest
typealias · iOS 26.0+
SHA3_512Digest
struct · iOS 26.0+
SHA3_512Digest.Element
typealias · iOS 26.0+
SHA3_512Digest.Iterator
typealias · iOS 26.0+
SHA384
struct · iOS 13.0+
SHA384.Digest
typealias · iOS 13.0+
SHA384Digest
struct · iOS 13.0+
SHA384Digest.Element
typealias · iOS 13.0+
SHA384Digest.Iterator
typealias · iOS 13.0+
SHA512
struct · iOS 13.0+
SHA512.Digest
typealias · iOS 13.0+
SHA512Digest
struct · iOS 13.0+
SHA512Digest.Element
typealias · iOS 13.0+
SHA512Digest.Iterator
typealias · iOS 13.0+
SharedSecret
struct · iOS 13.0+
SymmetricKey
struct · iOS 13.0+
SymmetricKeySize
struct · iOS 13.0+
XWingMLKEM768X25519
enum · iOS 26.0+
XWingMLKEM768X25519.OneTimePrivateKey
struct · iOS 27.0+
XWingMLKEM768X25519.OneTimePrivateKey.PublicKey
typealias · iOS 27.0+
XWingMLKEM768X25519.PrivateKey
struct · iOS 26.0+
XWingMLKEM768X25519.PrivateKey.PublicKey
typealias · iOS 26.0+
XWingMLKEM768X25519.PublicKey
struct · iOS 26.0+
XWingMLKEM768X25519.PublicKey.EphemeralPrivateKey
typealias · iOS 26.0+
XWingMLKEM768X25519.PublicKey.HPKEEphemeralPrivateKey
typealias · iOS 26.0+
Functions and constants
byteCount
TypeScriptget byteCount(): numbervar byteCount: Int { get }The number of bytes in the message authentication code.
finalize
TypeScriptfinalize(): HashedAuthenticationCode<SDKHandle>func finalize() -> HMAC<H>.MACFinalizes the message authentication computation and returns the computed code. - Returns: The message authentication code.
Skipped declarations
75 declarations were excluded from these bindings. Each reason comes from the generator or the iOS SDK compiler.
HMAC.isValidAuthenticationCode(_:authenticating:using:)
The containing type needs Swift generic type arguments. (no canonical witness for H)
HMAC.init(key:)
The containing type needs Swift generic type arguments. (no canonical witness for H)
HMAC.authenticationCode(for:using:)
The containing type needs Swift generic type arguments. (no canonical witness for H)
HMAC.authenticationCode(for:using:)
The containing type needs Swift generic type arguments. (no canonical witness for H)
HMAC.isValidAuthenticationCode(_:authenticating:using:)
The containing type needs Swift generic type arguments. (no canonical witness for H)
HMAC.isValidAuthenticationCode(_:authenticating:using:)
The containing type needs Swift generic type arguments. (no canonical witness for H)
HMAC.update(data:)
The containing type needs Swift generic type arguments. (no canonical witness for H)
HMAC.update(bytes:)
The iOS SDK compiler rejected this binding: instance method 'arg' requires that 'RawSpan' conform to 'Escapable'
HashedAuthenticationCode.withUnsafeBytes(_:)
The containing type needs Swift generic type arguments. (no canonical witness for H)
SecureEnclave.P256.Signing.PrivateKey.signature(for:)
This declaration needs Swift generic type arguments. (no canonical witness for D)
HKDF.deriveKey(inputKeyMaterial:salt:info:output:)
The containing type needs Swift generic type arguments. (no canonical witness for H)
HKDF.deriveKey(inputKeyMaterial:salt:info:outputByteCount:)
The containing type needs Swift generic type arguments. (no canonical witness for H)
HKDF.deriveKey(inputKeyMaterial:info:outputByteCount:)
The containing type needs Swift generic type arguments. (no canonical witness for H)
HKDF.deriveKey(inputKeyMaterial:salt:outputByteCount:)
The containing type needs Swift generic type arguments. (no canonical witness for H)
HKDF.deriveKey(inputKeyMaterial:outputByteCount:)
The containing type needs Swift generic type arguments. (no canonical witness for H)
HKDF.extract(inputKeyMaterial:salt:)
The containing type needs Swift generic type arguments. (no canonical witness for H)
HKDF.extract(inputKeyMaterial:salt:)
The containing type needs Swift generic type arguments. (no canonical witness for H)
HKDF.expand(pseudoRandomKey:info:outputByteCount:)
The containing type needs Swift generic type arguments. (no canonical witness for H)
HKDF.expand(pseudoRandomKey:info:into:)
The containing type needs Swift generic type arguments. (no canonical witness for H)
ChaChaPoly.seal(inPlace:using:nonce:authenticating:tag:)
The iOS SDK compiler rejected this binding: instance method 'arg' requires that 'MutableRawSpan' conform to 'Escapable'
ChaChaPoly.open(inPlace:using:nonce:authenticating:tag:)
The iOS SDK compiler rejected this binding: instance method 'arg' requires that 'MutableRawSpan' conform to 'Escapable'
SymmetricKey.bytes
The iOS SDK compiler rejected this binding: argument type 'RawSpan' does not conform to expected type 'Escapable'
SymmetricKey.init(copying:)
The iOS SDK compiler rejected this binding: instance method 'arg' requires that 'RawSpan' conform to 'Escapable'
SymmetricKey.init(copyingWithZeroing:)
The iOS SDK compiler rejected this binding: instance method 'arg' requires that 'MutableRawSpan' conform to 'Escapable'
SymmetricKey.init(size:initializingWith:)
The iOS SDK compiler rejected this binding: expected 'copy', 'borrow', or '&' followed by an identifier or 'self' in lifetime dependence specifier
HashFunction.update(bytes:)
The iOS SDK compiler rejected this binding: instance method 'arg' requires that 'RawSpan' conform to 'Escapable'
HashFunction.hash(bytes:)
Static protocol requirements cannot be called through an instance.
HashFunction.hash(data:)
Static protocol requirements cannot be called through an instance.
AES.GCM.seal(inPlace:using:nonce:authenticating:tag:)
The iOS SDK compiler rejected this binding: instance method 'arg' requires that 'MutableRawSpan' conform to 'Escapable'
AES.GCM.open(inPlace:using:nonce:authenticating:tag:)
The iOS SDK compiler rejected this binding: instance method 'arg' requires that 'MutableRawSpan' conform to 'Escapable'