keychain/ot/OTJoiningConfiguration.h

   1 /*
   2  * Copyright (c) 2018 Apple Inc. All Rights Reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. Please obtain a copy of the License at
  10  * http://www.opensource.apple.com/apsl/ and read it before using this
  11  * file.
  12  *
  13  * The Original Code and all software distributed under the License are
  14  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  15  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  16  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  18  * Please see the License for the specific language governing rights and
  19  * limitations under the License.
  20  *
  21  * @APPLE_LICENSE_HEADER_END@
  22  */
  23
  24 #ifndef SECURITY_OT_OTJOININGCONFIGURATION_H
  25 #define SECURITY_OT_OTJOININGCONFIGURATION_H 1
  26
  27 #if __OBJC2__
  28
  29 #import <Foundation/Foundation.h>
  30
  31 NS_ASSUME_NONNULL_BEGIN
  32
  33 @interface OTJoiningConfiguration : NSObject <NSSecureCoding>
  34
  35 @property (nonatomic, strong) NSString* protocolType;
  36 @property (nonatomic, strong) NSString* uniqueDeviceID;
  37 @property (nonatomic, strong) NSString* uniqueClientID;
  38 @property (nonatomic, strong) NSString* containerName;
  39 @property (nonatomic, strong) NSString* contextID;
  40 @property (nonatomic, strong) NSString* pairingUUID;
  41 @property (nonatomic) uint64_t epoch;
  42 @property (nonatomic) BOOL isInitiator;
  43
  44 // Set this to non-zero if you want to configure your timeouts
  45 @property int64_t timeout;
  46
  47 - (instancetype)initWithProtocolType:(NSString*)protocolType
  48                       uniqueDeviceID:(NSString*)uniqueDeviceID
  49                       uniqueClientID:(NSString*)uniqueClientID
  50                        containerName:(NSString* _Nullable)containerName
  51                            contextID:(NSString*)contextID
  52                                epoch:(uint64_t)epoch
  53                          isInitiator:(BOOL)isInitiator;
  54
  55 - (instancetype)initWithProtocolType:(NSString*)protocolType
  56                       uniqueDeviceID:(NSString*)uniqueDeviceID
  57                       uniqueClientID:(NSString*)uniqueClientID
  58                          pairingUUID:(NSString* _Nullable)pairingUUID
  59                        containerName:(NSString* _Nullable)containerName
  60                            contextID:(NSString*)contextID
  61                                epoch:(uint64_t)epoch
  62                          isInitiator:(BOOL)isInitiator;
  63 -(instancetype)init NS_UNAVAILABLE;
  64
  65 @end
  66 NS_ASSUME_NONNULL_END
  67
  68 #endif /* __OBJC2__ */
  69 #endif /* SECURITY_OT_OTJOININGCONFIGURATION_H */