| ︙ | | |
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
|
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
|
+
+
+
|
* You should have received a copy of the GNU Lesser General Public License
* version 3.0 along with this program. If not, see
* <https://www.gnu.org/licenses/>.
*/
#import "OFStream.h"
#import "OFRunLoop.h"
#import "OFX509Certificate.h"
#import "OFX509CertificatePrivateKey.h"
OF_ASSUME_NONNULL_BEGIN
/** @file */
@class OFArray OF_GENERIC(ObjectType);
@class OFTLSStream;
/**
* @brief An enum representing an error of an OFTLSStream.
*/
typedef enum {
/** @brief An unknown error. */
|
| ︙ | | |
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
|
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
|
+
+
+
+
+
+
+
+
+
+
+
+
|
/**
* @protocol OFTLSStreamDelegate OFTLSStream.h ObjFW/ObjFW.h
*
* A delegate for OFTLSStream.
*/
@protocol OFTLSStreamDelegate <OFStreamDelegate>
@optional
/**
* @brief A method which is called when a TLS stream performed the client
* handshake.
*
* @param stream The TLS stream which performed the handshake
* @param host The host for which the handshake was performed
* @param exception An exception that occurred during the handshake, or nil on
* success
*/
- (void)stream: (OFTLSStream *)stream
didPerformClientHandshakeWithHost: (OFString *)host
exception: (nullable id)exception;
/**
* @brief A method which is called when a TLS stream performed the server
* handshake.
*
* @param stream The TLS stream which performed the handshake
* @param exception An exception that occurred during the handshake, or nil on
* success
*/
- (void)streamDidPerformServerHandshake: (OFTLSStream *)stream
exception: (nullable id)exception;
@end
/**
* @class OFTLSStream OFTLSStream.h ObjFW/ObjFW.h
*
* @brief A class that provides Transport Layer Security on top of a stream.
*
|
| ︙ | | |
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
|
+
+
+
-
+
|
*/
@interface OFTLSStream: OFStream <OFReadyForReadingObserving,
OFReadyForWritingObserving>
{
OFStream <OFReadyForReadingObserving, OFReadyForWritingObserving>
*_underlyingStream;
bool _verifiesCertificates;
OFArray OF_GENERIC(OF_KINDOF(OFX509Certificate *)) *_Nullable
_certificateChain;
OF_KINDOF(OFX509CertificatePrivateKey *) _Nullable _privateKey;
OF_RESERVE_IVARS(OFTLSStream, 4)
OF_RESERVE_IVARS(OFTLSStream, 2)
}
/**
* @brief The underlying stream.
*/
@property (readonly, nonatomic) OFStream <OFReadyForReadingObserving,
OFReadyForWritingObserving> *underlyingStream;
|
| ︙ | | |
107
108
109
110
111
112
113
114
115
116
117
118
119
120
|
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
|
+
+
+
+
+
+
+
+
+
+
+
+
|
id <OFTLSStreamDelegate> delegate;
/**
* @brief Whether certificates are verified. Default is true.
*/
@property (nonatomic) bool verifiesCertificates;
/**
* @brief The certificate chain to use.
*/
@property OF_NULLABLE_PROPERTY (copy, nonatomic)
OFArray OF_GENERIC(OFX509Certificate *) *certificateChain;
/**
* @brief The private key to use.
*/
@property OF_NULLABLE_PROPERTY (retain, nonatomic)
OFX509CertificatePrivateKey *privateKey;
- (instancetype)init OF_UNAVAILABLE;
/**
* @brief Creates a new TLS stream with the specified stream as its underlying
* stream.
*
* @param stream The stream to use as underlying stream. Must not be closed
|
| ︙ | | |
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
|
195
196
197
198
199
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
239
240
241
242
243
244
245
246
247
|
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-
+
+
|
* @brief Performs the TLS client handshake for the specified host.
*
* @param host The host to perform the handshake with
* @throw OFTLSHandshakeFailedException The TLS handshake failed
* @throw OFAlreadyOpenException The handshake was already performed
*/
- (void)performClientHandshakeWithHost: (OFString *)host;
/**
* @brief Asynchronously performs the TLS server handshake and calls the
* delegate afterwards.
*
* @throw OFTLSHandshakeFailedException The TLS handshake failed
* @throw OFAlreadyOpenException The handshake was already performed
*/
- (void)asyncPerformServerHandshake;
/**
* @brief Asynchronously performs the TLS server handshake and calls the
* delegate afterwards.
*
* @param runLoopMode The run loop mode in which to perform the async handshake
*
* @throw OFTLSHandshakeFailedException The TLS handshake failed
* @throw OFAlreadyOpenException The handshake was already performed
*/
- (void)asyncPerformServerHandshakeWithRunLoopMode: (OFRunLoopMode)runLoopMode;
/**
* @brief Performs the TLS server handshake.
*
* @throw OFTLSHandshakeFailedException The TLS handshake failed
* @throw OFAlreadyOpenException The handshake was already performed
*/
- (void)performServerHandshake;
@end
#ifdef __cplusplus
extern "C" {
#endif
/**
* @brief The implementation for OFTLSStream to use.
*
* This can be set to a class that is always used for OFTLSStream. This is
* useful to either force a specific implementation or use one that ObjFW does
* not know about.
* useful to either force a specific implementation or to use one that ObjFW
* does not know about.
*/
extern Class OFTLSStreamImplementation;
/**
* @brief Returns a string description for the TLS stream error code.
*
* @param errorCode The error code to return the description for
|
| ︙ | | |