]> git.saurik.com Git - apple/security.git/blame - keychain/ot/OTBottledPeer.h
Security-58286.60.28.tar.gz
[apple/security.git] / keychain / ot / OTBottledPeer.h
CommitLineData
ecaf5866
A
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#import <Foundation/Foundation.h>
26#import <SecurityFoundation/SFKey.h>
27
28#import "OTEscrowKeys.h"
29
30NS_ASSUME_NONNULL_BEGIN
31
32@interface OTBottledPeer : NSObject
33
34@property (nonatomic, readonly) NSString* peerID;
35@property (nonatomic, readonly) NSString* spID;
36@property (nonatomic, readonly) SFECKeyPair* peerSigningKey;
37@property (nonatomic, readonly) SFECKeyPair* peerEncryptionKey;
38@property (nonatomic, readonly) NSData* data;
39
40// Given a peer's details including private key material, and
41// the keys generated from the escrow secret, encrypt the peer private keys,
42// make a bottled peer object and serialize it into data.
43- (nullable instancetype) initWithPeerID:(NSString * _Nullable)peerID
44 spID:(NSString * _Nullable)spID
45 peerSigningKey:(SFECKeyPair *)peerSigningKey
46 peerEncryptionKey:(SFECKeyPair *)peerEncryptionKey
47 escrowKeys:(OTEscrowKeys *)escrowKeys
48 error:(NSError**)error;
49
50// Deserialize a bottle and decrypt the contents (peer keys)
51// using the keys generated from the escrow secret.
52- (nullable instancetype) initWithData:(NSData *)data
53 escrowKeys:(OTEscrowKeys *)escrowKeys
54 error:(NSError**)error;
55
56@end
57NS_ASSUME_NONNULL_END
58
59#endif