keychain/ckks/CKKSLockStateTracker.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 #import <Foundation/Foundation.h>
  27
  28 @protocol CKKSLockStateNotification <NSObject>
  29 - (void)lockStateChangeNotification:(bool)unlocked;
  30 @end
  31
  32 NS_ASSUME_NONNULL_BEGIN
  33
  34 @interface CKKSLockStateTracker : NSObject
  35 @property (nullable) NSOperation* unlockDependency;
  36 @property (readonly) bool isLocked;
  37
  38 @property (readonly,nullable) NSDate* lastUnlockTime;
  39
  40 - (instancetype)init;
  41
  42 // Force a recheck of the keybag lock state
  43 - (void)recheck;
  44
  45 // Check if this error code is related to keybag is locked and we should retry later
  46 - (bool)isLockedError:(NSError*)error;
  47
  48 -(void)addLockStateObserver:(id<CKKSLockStateNotification>)object;
  49
  50 // Ask AKS if the user's keybag is locked
  51 + (bool)queryAKSLocked;
  52
  53 // Call this to get a CKKSLockStateTracker to use. This tracker will likely be tracking real AKS.
  54 + (CKKSLockStateTracker*)globalTracker;
  55 @end
  56
  57 NS_ASSUME_NONNULL_END
  58 #endif  // OCTAGON