| ︙ | | | ︙ | |
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
|
*
* Alternatively, it may be distributed under the terms of the GNU General
* Public License, either version 2 or 3, which can be found in the file
* LICENSE.GPLv2 or LICENSE.GPLv3 respectively included in the packaging of this
* file.
*/
#import "objfw-defs.h"
@class OFString;
@class OFDictionary OF_GENERIC(KeyType, ObjectType);
@protocol OFTLSSocket;
/*!
* @protocol OFTLSSocketDelegate OFTLSSocket.h ObjFW/OFTLSSocket.h
|
|
>
>
|
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
|
*
* Alternatively, it may be distributed under the terms of the GNU General
* Public License, either version 2 or 3, which can be found in the file
* LICENSE.GPLv2 or LICENSE.GPLv3 respectively included in the packaging of this
* file.
*/
#import "OFObject.h"
OF_ASSUME_NONNULL_BEGIN
@class OFString;
@class OFDictionary OF_GENERIC(KeyType, ObjectType);
@protocol OFTLSSocket;
/*!
* @protocol OFTLSSocketDelegate OFTLSSocket.h ObjFW/OFTLSSocket.h
|
| ︙ | | | ︙ | |
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
|
* @protocol OFTLSSocket OFTLSSocket.h ObjFW/OFTLSSocket.h
*
* @brief A protocol that should be implemented by 3rd-party libraries
* implementing TLS.
*/
@protocol OFTLSSocket
#ifdef OF_HAVE_PROPERTIES
@property (assign) id <OFTLSSocketDelegate> delegate;
@property (copy) OFString *certificateFile, *privateKeyFile;
@property const char *privateKeyPassphrase;
@property (getter=isCertificateVerificationEnabled)
bool certificateVerificationEnabled;
#endif
/*!
* @brief Initializes the TLS socket with the specified TCP socket as its
* underlying socket.
|
|
|
|
|
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
|
* @protocol OFTLSSocket OFTLSSocket.h ObjFW/OFTLSSocket.h
*
* @brief A protocol that should be implemented by 3rd-party libraries
* implementing TLS.
*/
@protocol OFTLSSocket
#ifdef OF_HAVE_PROPERTIES
@property (assign, nullable) id <OFTLSSocketDelegate> delegate;
@property (copy, nullable) OFString *certificateFile, *privateKeyFile;
@property (assign, nullable) const char *privateKeyPassphrase;
@property (getter=isCertificateVerificationEnabled)
bool certificateVerificationEnabled;
#endif
/*!
* @brief Initializes the TLS socket with the specified TCP socket as its
* underlying socket.
|
| ︙ | | | ︙ | |
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
|
- (void)startTLSWithExpectedHost: (OFString*)host;
/*!
* @brief Sets a delegate for the TLS socket.
*
* @param delegate The delegate to use
*/
- (void)setDelegate: (id <OFTLSSocketDelegate>)delegate;
/*!
* @brief Returns the delegate used by the TLS socket.
*
* @return The delegate used by the TLS socket
*/
- (id <OFTLSSocketDelegate>)delegate;
/*!
* @brief Sets the path to the X.509 certificate file to use.
*
* @param certificateFile The path to the X.509 certificate file
*/
- (void)setCertificateFile: (OFString*)certificateFile;
/*!
* @brief Sets the path to the X.509 certificate file to use for the specified
* SNI host.
*
* @param SNIHost The SNI host for which the path of the X.509 certificate file
* should be set
*
* @param certificateFile The path to the X.509 certificate file
*/
- (void)setCertificateFile: (OFString*)certificateFile
forSNIHost: (OFString*)SNIHost;
/*!
* @brief Returns the path of the X.509 certificate file used by the TLS socket.
*
* @return The path of the X.509 certificate file used by the TLS socket
*/
- (OFString*)certificateFile;
/*!
* @brief Returns the path of the X.509 certificate file used by the TLS socket
* for the specified SNI host.
*
* @param SNIHost The SNI host for which the path of the X.509 certificate file
* should be returned
*
* @return The path of the X.509 certificate file used by the TLS socket for
* the specified SNI host
*/
- (OFString*)certificateFileForSNIHost: (OFString*)SNIHost;
/*!
* @brief Sets the path to the PKCS#8 private key file to use.
*
* @param privateKeyFile The path to the PKCS#8 private key file
*/
- (void)setPrivateKeyFile: (OFString*)privateKeyFile;
/*!
* @brief Sets the path to the PKCS#8 private key file to use for the specified
* SNI host.
*
* @param privateKeyFile The path to the PKCS#8 private key file
* @param SNIHost The SNI host for which the path to the PKCS#8 private key
* file should be set
*/
- (void)setPrivateKeyFile: (OFString*)privateKeyFile
forSNIHost: (OFString*)SNIHost;
/*!
* @brief Returns the path of the PKCS#8 private key file used by the TLS
* socket.
*
* @return The path of the PKCS#8 private key file used by the TLS socket
*/
- (OFString*)privateKeyFile;
/*!
* @brief Returns the path of the PKCS#8 private key file used by the TLS
* socket for the specified SNI host.
*
* @param SNIHost The SNI host for which the path of the PKCS#8 private key
* file should be returned
*
* @return The path of the PKCS#8 private key file used by the TLS socket for
* the specified SNI host
*/
- (OFString*)privateKeyFileForSNIHost: (OFString*)SNIHost;
/*!
* @brief Sets the passphrase to decrypt the PKCS#8 private key file.
*
* @warning You have to ensure that this is in secure memory protected from
* swapping! This is also the reason why this is not an OFString.
*
* @param privateKeyPassphrase The passphrase to decrypt the PKCS#8 private
* key file
*/
- (void)setPrivateKeyPassphrase: (const char*)privateKeyPassphrase;
/*!
* @brief Sets the passphrase to decrypt the PKCS#8 private key file for the
* specified SNI host.
*
* @warning You have to ensure that this is in secure memory protected from
* swapping! This is also the reason why this is not an OFString.
|
|
|
|
|
|
|
|
|
|
|
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
|
- (void)startTLSWithExpectedHost: (OFString*)host;
/*!
* @brief Sets a delegate for the TLS socket.
*
* @param delegate The delegate to use
*/
- (void)setDelegate: (nullable id <OFTLSSocketDelegate>)delegate;
/*!
* @brief Returns the delegate used by the TLS socket.
*
* @return The delegate used by the TLS socket
*/
- (nullable id <OFTLSSocketDelegate>)delegate;
/*!
* @brief Sets the path to the X.509 certificate file to use.
*
* @param certificateFile The path to the X.509 certificate file
*/
- (void)setCertificateFile: (nullable OFString*)certificateFile;
/*!
* @brief Sets the path to the X.509 certificate file to use for the specified
* SNI host.
*
* @param SNIHost The SNI host for which the path of the X.509 certificate file
* should be set
*
* @param certificateFile The path to the X.509 certificate file
*/
- (void)setCertificateFile: (OFString*)certificateFile
forSNIHost: (OFString*)SNIHost;
/*!
* @brief Returns the path of the X.509 certificate file used by the TLS socket.
*
* @return The path of the X.509 certificate file used by the TLS socket
*/
- (nullable OFString*)certificateFile;
/*!
* @brief Returns the path of the X.509 certificate file used by the TLS socket
* for the specified SNI host.
*
* @param SNIHost The SNI host for which the path of the X.509 certificate file
* should be returned
*
* @return The path of the X.509 certificate file used by the TLS socket for
* the specified SNI host
*/
- (nullable OFString*)certificateFileForSNIHost: (OFString*)SNIHost;
/*!
* @brief Sets the path to the PKCS#8 private key file to use.
*
* @param privateKeyFile The path to the PKCS#8 private key file
*/
- (void)setPrivateKeyFile: (nullable OFString*)privateKeyFile;
/*!
* @brief Sets the path to the PKCS#8 private key file to use for the specified
* SNI host.
*
* @param privateKeyFile The path to the PKCS#8 private key file
* @param SNIHost The SNI host for which the path to the PKCS#8 private key
* file should be set
*/
- (void)setPrivateKeyFile: (OFString*)privateKeyFile
forSNIHost: (OFString*)SNIHost;
/*!
* @brief Returns the path of the PKCS#8 private key file used by the TLS
* socket.
*
* @return The path of the PKCS#8 private key file used by the TLS socket
*/
- (nullable OFString*)privateKeyFile;
/*!
* @brief Returns the path of the PKCS#8 private key file used by the TLS
* socket for the specified SNI host.
*
* @param SNIHost The SNI host for which the path of the PKCS#8 private key
* file should be returned
*
* @return The path of the PKCS#8 private key file used by the TLS socket for
* the specified SNI host
*/
- (nullable OFString*)privateKeyFileForSNIHost: (OFString*)SNIHost;
/*!
* @brief Sets the passphrase to decrypt the PKCS#8 private key file.
*
* @warning You have to ensure that this is in secure memory protected from
* swapping! This is also the reason why this is not an OFString.
*
* @param privateKeyPassphrase The passphrase to decrypt the PKCS#8 private
* key file
*/
- (void)setPrivateKeyPassphrase: (nullable const char*)privateKeyPassphrase;
/*!
* @brief Sets the passphrase to decrypt the PKCS#8 private key file for the
* specified SNI host.
*
* @warning You have to ensure that this is in secure memory protected from
* swapping! This is also the reason why this is not an OFString.
|
| ︙ | | | ︙ | |
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
|
/*!
* @brief Returns the passphrase to decrypt the PKCS#8 private key file.
*
* @warning You should not copy this to insecure memory which is swappable!
*
* @return The passphrase to decrypt the PKCS#8 private key file
*/
- (const char*)privateKeyPassphrase;
/*!
* @brief Returns the passphrase to decrypt the PKCS#8 private key file for the
* specified SNI host.
*
* @warning You should not copy this to insecure memory which is swappable!
*
* @param SNIHost The SNI host for which the passphrase to decrypt the PKCS#8
* private key file should be returned
*
* @return The passphrase to decrypt the PKCS#8 private key file for the
* specified SNI host
*/
- (const char*)privateKeyPassphraseForSNIHost: (OFString*)SNIHost;
/**
* @brief Enable or disable certificate verification.
*
* The default is enabled.
*
* @param enabled Whether to enable or disable certificate verification
*/
- (void)setCertificateVerificationEnabled: (bool)enabled;
/**
* @brief Returns whether certificate verification is enabled.
*
* @return Whether certificate verification is enabled
*/
- (bool)isCertificateVerificationEnabled;
@end
|
|
|
>
>
|
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
|
/*!
* @brief Returns the passphrase to decrypt the PKCS#8 private key file.
*
* @warning You should not copy this to insecure memory which is swappable!
*
* @return The passphrase to decrypt the PKCS#8 private key file
*/
- (nullable const char*)privateKeyPassphrase;
/*!
* @brief Returns the passphrase to decrypt the PKCS#8 private key file for the
* specified SNI host.
*
* @warning You should not copy this to insecure memory which is swappable!
*
* @param SNIHost The SNI host for which the passphrase to decrypt the PKCS#8
* private key file should be returned
*
* @return The passphrase to decrypt the PKCS#8 private key file for the
* specified SNI host
*/
- (nullable const char*)privateKeyPassphraseForSNIHost: (OFString*)SNIHost;
/**
* @brief Enable or disable certificate verification.
*
* The default is enabled.
*
* @param enabled Whether to enable or disable certificate verification
*/
- (void)setCertificateVerificationEnabled: (bool)enabled;
/**
* @brief Returns whether certificate verification is enabled.
*
* @return Whether certificate verification is enabled
*/
- (bool)isCertificateVerificationEnabled;
@end
OF_ASSUME_NONNULL_END
|