summary refs log tree commit diff
path: root/crypto/src/tls/DtlsTransport.cs
blob: 2e928e761b8b7d3cae6b864f2b650bdc9df100e5 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
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
74
75
76
77
78
79
80
81
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
191
192
193
194
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
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
using System;
using System.IO;
using System.Net.Sockets;

namespace Org.BouncyCastle.Tls
{
    [Flags]
    public enum DtlsRecordFlags
    {
        None = 0,

        /// <summary>The record is newer (by epoch and sequence number) than any record received previously.</summary>
        IsNewest = 1,

        /// <summary>The record includes the (valid) connection ID (RFC 9146) for this connection.</summary>
        UsesConnectionID = 2,
    }

    public delegate void DtlsRecordCallback(DtlsRecordFlags flags);

    public class DtlsTransport
        : DatagramTransport
    {
        private readonly DtlsRecordLayer m_recordLayer;
        private readonly bool m_ignoreCorruptRecords;

        internal DtlsTransport(DtlsRecordLayer recordLayer, bool ignoreCorruptRecords)
        {
            m_recordLayer = recordLayer;
            m_ignoreCorruptRecords = ignoreCorruptRecords;
        }

        /// <exception cref="IOException"/>
        public virtual int GetReceiveLimit()
        {
            return m_recordLayer.GetReceiveLimit();
        }

        /// <exception cref="IOException"/>
        public virtual int GetSendLimit()
        {
            return m_recordLayer.GetSendLimit();
        }

        /// <exception cref="IOException"/>
        public virtual int Receive(byte[] buf, int off, int len, int waitMillis)
        {
            return Receive(buf, off, len, waitMillis, null);
        }

        // TODO[api] Add to DatagramTransport (with a default null parameter)
        /// <exception cref="IOException"/>
        public virtual int Receive(byte[] buf, int off, int len, int waitMillis, DtlsRecordCallback recordCallback)
        {
            if (null == buf)
                throw new ArgumentNullException("buf");
            if (off < 0 || off >= buf.Length)
                throw new ArgumentException("invalid offset: " + off, "off");
            if (len < 0 || len > buf.Length - off)
                throw new ArgumentException("invalid length: " + len, "len");

#if NETCOREAPP2_1_OR_GREATER || NETSTANDARD2_1_OR_GREATER
            return Receive(buf.AsSpan(off, len), waitMillis, recordCallback);
#else
            if (waitMillis < 0)
                throw new ArgumentException("cannot be negative", "waitMillis");

            try
            {
                return m_recordLayer.Receive(buf, off, len, waitMillis, recordCallback);
            }
            catch (TlsFatalAlert fatalAlert)
            {
                if (m_ignoreCorruptRecords && AlertDescription.bad_record_mac == fatalAlert.AlertDescription)
                    return -1;

                m_recordLayer.Fail(fatalAlert.AlertDescription);
                throw;
            }
            catch (TlsTimeoutException)
            {
                throw;
            }
            catch (SocketException e)
            {
                if (TlsUtilities.IsTimeout(e))
                    throw;

                m_recordLayer.Fail(AlertDescription.internal_error);
                throw new TlsFatalAlert(AlertDescription.internal_error, e);
            }
            // TODO[tls-port] Can we support interrupted IO on .NET?
            //catch (InterruptedIOException)
            //{
            //    throw;
            //}
            catch (IOException)
            {
                m_recordLayer.Fail(AlertDescription.internal_error);
                throw;
            }
            catch (Exception e)
            {
                m_recordLayer.Fail(AlertDescription.internal_error);
                throw new TlsFatalAlert(AlertDescription.internal_error, e);
            }
#endif
        }

        // TODO[api] Add to DatagramTransport
        /// <exception cref="IOException"/>
        public virtual int ReceivePending(byte[] buf, int off, int len, DtlsRecordCallback recordCallback = null)
        {
            if (null == buf)
                throw new ArgumentNullException("buf");
            if (off < 0 || off >= buf.Length)
                throw new ArgumentException("invalid offset: " + off, "off");
            if (len < 0 || len > buf.Length - off)
                throw new ArgumentException("invalid length: " + len, "len");

#if NETCOREAPP2_1_OR_GREATER || NETSTANDARD2_1_OR_GREATER
            return ReceivePending(buf.AsSpan(off, len), recordCallback);
#else
            try
            {
                return m_recordLayer.ReceivePending(buf, off, len, recordCallback);
            }
            catch (TlsFatalAlert fatalAlert)
            {
                if (m_ignoreCorruptRecords && AlertDescription.bad_record_mac == fatalAlert.AlertDescription)
                    return -1;

                m_recordLayer.Fail(fatalAlert.AlertDescription);
                throw;
            }
            catch (TlsTimeoutException)
            {
                throw;
            }
            catch (SocketException e)
            {
                if (TlsUtilities.IsTimeout(e))
                    throw;

                m_recordLayer.Fail(AlertDescription.internal_error);
                throw new TlsFatalAlert(AlertDescription.internal_error, e);
            }
            // TODO[tls-port] Can we support interrupted IO on .NET?
            //catch (InterruptedIOException)
            //{
            //    throw;
            //}
            catch (IOException)
            {
                m_recordLayer.Fail(AlertDescription.internal_error);
                throw;
            }
            catch (Exception e)
            {
                m_recordLayer.Fail(AlertDescription.internal_error);
                throw new TlsFatalAlert(AlertDescription.internal_error, e);
            }
#endif
        }

#if NETCOREAPP2_1_OR_GREATER || NETSTANDARD2_1_OR_GREATER
        /// <exception cref="IOException"/>
        public virtual int Receive(Span<byte> buffer, int waitMillis)
        {
            return Receive(buffer, waitMillis, null);
        }

        // TODO[api] Add to DatagramTransport (with a default null parameter)
        /// <exception cref="IOException"/>
        public virtual int Receive(Span<byte> buffer, int waitMillis, DtlsRecordCallback recordCallback)
        {
            if (waitMillis < 0)
                throw new ArgumentException("cannot be negative", nameof(waitMillis));

            try
            {
                return m_recordLayer.Receive(buffer, waitMillis, recordCallback);
            }
            catch (TlsFatalAlert fatalAlert)
            {
                if (m_ignoreCorruptRecords && AlertDescription.bad_record_mac == fatalAlert.AlertDescription)
                    return -1;

                m_recordLayer.Fail(fatalAlert.AlertDescription);
                throw;
            }
            catch (TlsTimeoutException)
            {
                throw;
            }
            catch (SocketException e)
            {
                if (TlsUtilities.IsTimeout(e))
                    throw;

                m_recordLayer.Fail(AlertDescription.internal_error);
                throw new TlsFatalAlert(AlertDescription.internal_error, e);
            }
            // TODO[tls-port] Can we support interrupted IO on .NET?
            //catch (InterruptedIOException)
            //{
            //    throw;
            //}
            catch (IOException)
            {
                m_recordLayer.Fail(AlertDescription.internal_error);
                throw;
            }
            catch (Exception e)
            {
                m_recordLayer.Fail(AlertDescription.internal_error);
                throw new TlsFatalAlert(AlertDescription.internal_error, e);
            }
        }

        // TODO[api] Add to DatagramTransport
        /// <exception cref="IOException"/>
        public virtual int ReceivePending(Span<byte> buffer, DtlsRecordCallback recordCallback = null)
        {
            try
            {
                return m_recordLayer.ReceivePending(buffer, recordCallback);
            }
            catch (TlsFatalAlert fatalAlert)
            {
                if (m_ignoreCorruptRecords && AlertDescription.bad_record_mac == fatalAlert.AlertDescription)
                    return -1;

                m_recordLayer.Fail(fatalAlert.AlertDescription);
                throw;
            }
            catch (TlsTimeoutException)
            {
                throw;
            }
            catch (SocketException e)
            {
                if (TlsUtilities.IsTimeout(e))
                    throw;

                m_recordLayer.Fail(AlertDescription.internal_error);
                throw new TlsFatalAlert(AlertDescription.internal_error, e);
            }
            // TODO[tls-port] Can we support interrupted IO on .NET?
            //catch (InterruptedIOException)
            //{
            //    throw;
            //}
            catch (IOException)
            {
                m_recordLayer.Fail(AlertDescription.internal_error);
                throw;
            }
            catch (Exception e)
            {
                m_recordLayer.Fail(AlertDescription.internal_error);
                throw new TlsFatalAlert(AlertDescription.internal_error, e);
            }
        }
#endif

        /// <exception cref="IOException"/>
        public virtual void Send(byte[] buf, int off, int len)
        {
            if (null == buf)
                throw new ArgumentNullException("buf");
            if (off < 0 || off >= buf.Length)
                throw new ArgumentException("invalid offset: " + off, "off");
            if (len < 0 || len > buf.Length - off)
                throw new ArgumentException("invalid length: " + len, "len");

#if NETCOREAPP2_1_OR_GREATER || NETSTANDARD2_1_OR_GREATER
            Send(buf.AsSpan(off, len));
#else
            try
            {
                m_recordLayer.Send(buf, off, len);
            }
            catch (TlsFatalAlert fatalAlert)
            {
                m_recordLayer.Fail(fatalAlert.AlertDescription);
                throw;
            }
            catch (TlsTimeoutException)
            {
                throw;
            }
            catch (SocketException e)
            {
                if (TlsUtilities.IsTimeout(e))
                    throw;

                m_recordLayer.Fail(AlertDescription.internal_error);
                throw new TlsFatalAlert(AlertDescription.internal_error, e);
            }
            // TODO[tls-port] Can we support interrupted IO on .NET?
            //catch (InterruptedIOException)
            //{
            //    throw;
            //}
            catch (IOException)
            {
                m_recordLayer.Fail(AlertDescription.internal_error);
                throw;
            }
            catch (Exception e)
            {
                m_recordLayer.Fail(AlertDescription.internal_error);
                throw new TlsFatalAlert(AlertDescription.internal_error, e);
            }
#endif
        }

#if NETCOREAPP2_1_OR_GREATER || NETSTANDARD2_1_OR_GREATER
        public virtual void Send(ReadOnlySpan<byte> buffer)
        {
            try
            {
                m_recordLayer.Send(buffer);
            }
            catch (TlsFatalAlert fatalAlert)
            {
                m_recordLayer.Fail(fatalAlert.AlertDescription);
                throw;
            }
            catch (TlsTimeoutException)
            {
                throw;
            }
            catch (SocketException e)
            {
                if (TlsUtilities.IsTimeout(e))
                    throw;

                m_recordLayer.Fail(AlertDescription.internal_error);
                throw new TlsFatalAlert(AlertDescription.internal_error, e);
            }
            // TODO[tls-port] Can we support interrupted IO on .NET?
            //catch (InterruptedIOException)
            //{
            //    throw;
            //}
            catch (IOException)
            {
                m_recordLayer.Fail(AlertDescription.internal_error);
                throw;
            }
            catch (Exception e)
            {
                m_recordLayer.Fail(AlertDescription.internal_error);
                throw new TlsFatalAlert(AlertDescription.internal_error, e);
            }
        }
#endif

        /// <exception cref="IOException"/>
        public virtual void Close()
        {
            m_recordLayer.Close();
        }
    }
}