keychain/ot/OTBottledPeerState.h

   1 /*
   2  * Copyright (c) 2017 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 #if OCTAGON
  25
  26 #ifndef OTBottledPeerState_h
  27 #define OTBottledPeerState_h
  28
  29 #import <Foundation/Foundation.h>
  30
  31 NS_ASSUME_NONNULL_BEGIN
  32
  33 /* Bottled Peer States */
  34 @protocol SecOTBottledPeerState <NSObject>
  35 @end
  36 typedef NSString<SecOTBottledPeerState> OTBottledPeerState;
  37
  38 // Octagon Trust currently logged out
  39 extern OTBottledPeerState* const SecOTBottledPeerStateLoggedOut;
  40
  41 // Octagon Trust currently signed in
  42 extern OTBottledPeerState* const SecOTBottledPeerStateSignedIn;
  43
  44 // Octagon Trust: check bottle states
  45 extern OTBottledPeerState* const SecOTBottledPeerStateInventoryCheck;
  46
  47 // Octagon Trust: update bottles for current peerid with current octagon keys
  48 extern OTBottledPeerState* const SecOTBottledPeerStateUpdateBottles;
  49
  50 // Octagon Trust: bottles exist for the current octagon key set and have been writte to cloudkit
  51 extern OTBottledPeerState* const SecOTBottledPeerStateCleanBottles;
  52
  53 // Octagon Trust: bottles for current peerid have been updated and persited locally, but not commited to cloudkit
  54 extern OTBottledPeerState* const SecOTBottledPeerStateDirtyBottles;
  55
  56 NS_ASSUME_NONNULL_END
  57
  58 #endif /* OTBottledPeerState_h */
  59 #endif