keychain/ckks/CKKSSIV.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 // For AES-SIV 512.
  27
  28 #define CKKSKeySize (512/8)
  29 #define CKKSWrappedKeySize (CKKSKeySize+16)
  30
  31 @interface CKKSBaseAESSIVKey : NSObject <NSCopying> {
  32     @package
  33     uint8_t key[CKKSWrappedKeySize]; // subclasses can use less than the whole buffer, and set key to be precise
  34     size_t size;
  35 }
  36 - (instancetype)init;
  37 - (instancetype)initWithBytes:(uint8_t *)bytes len:(size_t)len;
  38 - (void)zeroKey;
  39 - (instancetype)copyWithZone:(NSZone *)zone;
  40
  41 // Mostly for testing.
  42 - (instancetype)initWithBase64: (NSString*) base64bytes;
  43 - (BOOL)isEqual: (id) object;
  44 @end
  45
  46 @interface CKKSWrappedAESSIVKey : CKKSBaseAESSIVKey
  47 - (instancetype)initWithData: (NSData*) data;
  48 - (NSData*)wrappedData;
  49 - (NSString*) base64WrappedKey;
  50 @end
  51
  52 @interface CKKSAESSIVKey : CKKSBaseAESSIVKey
  53 + (instancetype)randomKey;
  54
  55 - (CKKSWrappedAESSIVKey*)wrapAESKey: (CKKSAESSIVKey*) keyToWrap error: (NSError * __autoreleasing *) error;
  56 - (CKKSAESSIVKey*)unwrapAESKey: (CKKSWrappedAESSIVKey*) keyToUnwrap error: (NSError * __autoreleasing *) error;
  57
  58 // Encrypt and decrypt data into buffers. Adds a nonce for ciphertext protection.
  59 - (NSData*)encryptData: (NSData*) plaintext authenticatedData: (NSDictionary<NSString*, NSData*>*) ad error: (NSError * __autoreleasing *) error;
  60 - (NSData*)decryptData: (NSData*) ciphertext authenticatedData: (NSDictionary<NSString*, NSData*>*) ad error: (NSError * __autoreleasing *) error;
  61
  62 @end