blob: 1359178ec9f5c773c06c45f43f1e6a1253f9b9a2 [file] [log] [blame]
/**
*
* Copyright (c) 2022 Project CHIP Authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#import <Foundation/Foundation.h>
NS_ASSUME_NONNULL_BEGIN
@protocol MTRDeviceAttestationDelegate;
/**
* Information that can be provided to commissionWithNodeID to commision devices.
*/
@interface MTRCommissioningParameters : NSObject
/**
* The nonce to use when requesting a CSR for the node's operational
* certificate.
*
* If nil, a random nonce will be generated automatically.
*
* If not nil, must be 32 bytes of data.
*/
@property (nonatomic, copy, nullable) NSData * csrNonce MTR_NEWLY_AVAILABLE;
/**
* The nonce to use when requesting attestation information from the device.
*
* If nil, a random nonce will be generated automatically.
*
* If not nil, must be 32 bytes of data.
*/
@property (nonatomic, copy, nullable) NSData * attestationNonce;
/**
* The Wi-Fi SSID, if available.
*/
@property (nonatomic, copy, nullable) NSData * wifiSSID;
/**
* The Wi-Fi Credentials. Allowed to be nil or 0-length data for an open
* network, as long as wifiSSID is not nil.
*/
@property (nonatomic, copy, nullable) NSData * wifiCredentials;
/**
* The Thread operational dataset, if available.
*/
@property (nonatomic, copy, nullable) NSData * threadOperationalDataset;
/**
* An optional delegate that can be notified upon completion of device
* attestation. See documentation for MTRDeviceAttestationDelegate for
* details.
*
* The delegate methods will be invoked on an arbitrary thread.
*/
@property (nonatomic, strong, nullable) id<MTRDeviceAttestationDelegate> deviceAttestationDelegate;
/**
* The timeout, in seconds, to set for the fail-safe when calling into the
* deviceAttestationDelegate and waiting for it to respond.
*
* If nil, the fail-safe will not be extended before calling into the
* deviceAttestationDelegate.
*/
@property (nonatomic, copy, nullable) NSNumber * failSafeExpiryTimeout MTR_NEWLY_AVAILABLE;
@end
@interface MTRCommissioningParameters (Deprecated)
@property (nonatomic, copy, nullable) NSData * CSRNonce MTR_NEWLY_DEPRECATED("Please use csrNonce");
@property (nonatomic, copy, nullable) NSNumber * failSafeExpiryTimeoutSecs MTR_NEWLY_DEPRECATED("Plase use failSafeExpiryTimeout");
@end
NS_ASSUME_NONNULL_END