One Logo Pool Ball
AccessoryTransportExtension · IOS API REFERENCE

SecurityMessage

struct · iOS 26.5+ · SDK 27.1

struct SecurityMessage

A message carrying key material used to negotiate a secure channel between a host and an accessory.

Members (8)

get · iOS 26.5+

identifier

TypeScript
get identifier(): (string) | null
Swift declaration
let identifier: String?

An identifier used to derive HPKE keys.

get · iOS 26.5+

cipherSuite

TypeScript
get cipherSuite(): SecurityMessage_CipherSuite
Swift declaration
let cipherSuite: SecurityMessage.CipherSuite

The cipher suite used for key exchange.

get · iOS 26.5+

description

TypeScript
get description(): string
Swift declaration
var description: String { get }

A textual representation of this instance. Calling this property directly is discouraged. Instead, convert an instance of any type to a string by using the `String(describing:)` initializer. This initializer works with any type, and uses the custom `description` property for types that conform to `CustomStringConvertible`: struct Point: CustomStringConvertible { let x: Int, y: Int var description: String { return "(\(x), \(y))" } } let p = Point(x: 21, y: 30) let s = String(describing: p) print(s) // Prints "(21, 30)" The conversion of `p` to a string in the assignment to `s` uses the `Point` type's `description` property.

get · iOS 26.5+

supportedTransports

TypeScript
get supportedTransports(): Array<AccessoryTransport>
Swift declaration
let supportedTransports: [AccessoryTransport]

The supported transports to send sensitive information. Default is `Bluetooth`.

get · iOS 26.5+

key

TypeScript
get key(): ArrayBuffer
Swift declaration
let key: Data

The key data carried by this message.

init · iOS 26.5+

init

TypeScript
static init(keyType: SecurityMessage_KeyType, cipherSuite: SecurityMessage_CipherSuite, version: SecurityMessage_CipherSuite_Version, key: ArrayBuffer, supportedTransports?: Array<AccessoryTransport>, identifier?: (string) | null): SecurityMessage
Swift declaration
init(keyType: SecurityMessage.KeyType, cipherSuite: SecurityMessage.CipherSuite, version: SecurityMessage.CipherSuite.Version, key: Data, supportedTransports: [AccessoryTransport] = [.bluetooth], identifier: String? = nil)

Creates a security message. - Parameters: - keyType: The type of key carried by this message. - cipherSuite: The cipher suite used for key exchange. - version: The cipher suite version. - key: The key data. - supportedTransports: The supported transports by accessory for sending sensitive information. Default is Bluetooth. - identifier: An optional identifier for HPKE key derivation (Bluetooth identifier).

get · iOS 26.5+

keyType

TypeScript
get keyType(): SecurityMessage_KeyType
Swift declaration
let keyType: SecurityMessage.KeyType

The type of key carried by this message.

get · iOS 26.5+

version

TypeScript
get version(): SecurityMessage_CipherSuite_Version
Swift declaration
let version: SecurityMessage.CipherSuite.Version

The cipher suite version.

Skipped declarations

No declarations were skipped in this snapshot.

All AccessoryTransportExtension types →