nl::Weave::Profiles::FabricProvisioning

This namespace includes all interfaces within Weave for the Weave Fabric Provisioning profile, the second of the three Weave provisioning profiles.

Summary

Enumerations

@162{
  kStatusCode_AlreadyMemberOfFabric = 1,
  kStatusCode_NotMemberOfFabric = 2,
  kStatusCode_InvalidFabricConfig = 3
}
enum
Fabric Provisioning Status Codes.
@163 enum
Fabric Provisioning Message Types.
@164{
  kTag_FabricConfig = 1,
  kTag_FabricId = 1,
  kTag_FabricKeys = 2,
  kTag_FabricKeyId = 1,
  kTag_EncryptionType = 2,
  kTag_DataKey = 3,
  kTag_IntegrityKey = 4,
  kTag_KeyScope = 5,
  kTag_RotationScheme = 6,
  kTag_RemainingLifeTime = 7,
  kTag_RemainingReservedTime = 8
}
enum
Fabric Provisioning Data Element Tags.

Classes

nl::Weave::Profiles::FabricProvisioning::FabricProvisioningDelegate

Delegate class for implementing additional actions corresponding to Fabric Provisioning operations.

nl::Weave::Profiles::FabricProvisioning::FabricProvisioningServer

Server class for implementing the Fabric Provisioning profile.

Enumerations

@162

 @162

Fabric Provisioning Status Codes.

Properties
kStatusCode_AlreadyMemberOfFabric

The recipient is already a member of a fabric.

kStatusCode_InvalidFabricConfig

The specified fabric configuration was invalid.

kStatusCode_NotMemberOfFabric

The recipient is not a member of a fabric.

@163

 @163

Fabric Provisioning Message Types.

@164

 @164

Fabric Provisioning Data Element Tags.

Properties
kTag_DataKey

[ byte-string ] Data encryption key.

kTag_EncryptionType

[ uint ] Weave encryption type supported by the key.

kTag_FabricConfig

[ structure ] Contains provisioning information for an existing fabric.

IMPORTANT NOTE: As a convenience to readers, all elements in a FabricConfig must be encoded in numeric tag order, at all levels.

kTag_FabricId

[ uint ] Fabric ID.

kTag_FabricKeyId

[ uint ] Weave key ID for fabric key.

kTag_FabricKeys

[ array ] List of FabricKey structures.

kTag_IntegrityKey

[ byte-string ] Data integrity key.

kTag_KeyScope

[ uint ] Enumerated value identifying the category of devices that can possess the fabric key.

kTag_RemainingLifeTime

[ uint ] Remaining time (in seconds) until key expiration.

Absent if lifetime is indefinite or doesn't apply.

kTag_RemainingReservedTime

[ uint ] Remaining time (in seconds) until key is eligible for use.

Absent if key can be used right away.

kTag_RotationScheme

[ uint ] Enumerated value identifying the rotation scheme for the key.