keychain/trust/TrustedPeers/TPSigningKey.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 #import <Foundation/Foundation.h>
  25
  26 NS_ASSUME_NONNULL_BEGIN
  27
  28 /*!
  29  A protocol for signing blobs and checking signatures.
  30  */
  31 @protocol TPSigningKey <NSObject>
  32 - (NSData *)publicKey;
  33 - (BOOL)checkSignature:(NSData *)sig matchesData:(NSData *)data;
  34
  35 /*!
  36  This method uses the private key to create a signature.
  37  It will return nil with an error if the private key is not available,
  38  e.g. due to the device being locked.
  39  */
  40 - (nullable NSData *)signatureForData:(NSData *)data withError:(NSError **)error;
  41 @end
  42
  43
  44 /*!
  45  A protocol for factories that construct TPSigningKey objects.
  46  */
  47 @protocol TPSigningKeyFactory <NSObject>
  48 // Return nil if data is malformed
  49 - (nullable id <TPSigningKey>)keyWithPublicKeyData:(NSData *)publicKey;
  50 @end
  51
  52 NS_ASSUME_NONNULL_END