ObjFW
OFTLSSocket.h
1 /*
2  * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017
3  * Jonathan Schleifer <js@heap.zone>
4  *
5  * All rights reserved.
6  *
7  * This file is part of ObjFW. It may be distributed under the terms of the
8  * Q Public License 1.0, which can be found in the file LICENSE.QPL included in
9  * the packaging of this file.
10  *
11  * Alternatively, it may be distributed under the terms of the GNU General
12  * Public License, either version 2 or 3, which can be found in the file
13  * LICENSE.GPLv2 or LICENSE.GPLv3 respectively included in the packaging of this
14  * file.
15  */
16 
17 #import "OFObject.h"
18 
19 OF_ASSUME_NONNULL_BEGIN
20 
21 @class OFString;
22 @class OFDictionary OF_GENERIC(KeyType, ObjectType);
23 @protocol OFTLSSocket;
24 
31 @optional
46 - (bool)socket: (id <OFTLSSocket>)socket
47  shouldAcceptCertificate: (OFDictionary *)certificate;
48 @end
49 
56 @protocol OFTLSSocket
60 @property OF_NULLABLE_PROPERTY (nonatomic, assign)
61  id <OFTLSSocketDelegate> delegate;
62 
66 @property OF_NULLABLE_PROPERTY (nonatomic, copy) OFString *certificateFile;
67 
71 @property OF_NULLABLE_PROPERTY (nonatomic, copy) OFString *privateKeyFile;
72 
79 @property OF_NULLABLE_PROPERTY (nonatomic, assign)
80  const char *privateKeyPassphrase;
81 
87 @property (nonatomic, getter=isCertificateVerificationEnabled)
89 
96 - initWithSocket: (OFTCPSocket *)socket;
97 
107 - (void)startTLSWithExpectedHost: (nullable OFString *)host;
108 
118 - (void)setCertificateFile: (OFString *)certificateFile
119  forSNIHost: (OFString *)SNIHost;
120 
131 - (nullable OFString *)certificateFileForSNIHost: (OFString *)SNIHost;
132 
141 - (void)setPrivateKeyFile: (OFString *)privateKeyFile
142  forSNIHost: (OFString *)SNIHost;
143 
154 - (nullable OFString *)privateKeyFileForSNIHost: (OFString *)SNIHost;
155 
168 - (void)setPrivateKeyPassphrase: (const char *)privateKeyPassphrase
169  forSNIHost: (OFString *)SNIHost;
170 
183 - (nullable const char *)privateKeyPassphraseForSNIHost: (OFString *)SNIHost;
184 @end
185 
186 OF_ASSUME_NONNULL_END
A protocol that should be implemented by 3rd-party libraries implementing TLS.
Definition: OFTLSSocket.h:56
A class for handling strings.
Definition: OFString.h:114
A delegate for classes implementing the OFTLSSocket protocol.
Definition: OFTLSSocket.h:30
A class which provides methods to create and use TCP sockets.
Definition: OFTCPSocket.h:61
nonatomic
Definition: OFTLSSocket.h:60
An abstract class for storing objects in a dictionary.
Definition: OFDictionary.h:54
bool certificateVerificationEnabled
Definition: OFTLSSocket.h:88