-
Notifications
You must be signed in to change notification settings - Fork 0
/
Sample Async SslStream Client_Server.txt
1323 lines (573 loc) · 29.2 KB
/
Sample Async SslStream Client_Server.txt
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
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
Microsoft logo |
Sign in
Jon Cole
Sample Asynchronous SslStream Client/Server Implementation
?????
????
???
??
?
avatar of joncoleJonColeJune 13, 200713
0
0
I was recently asked about sample code for the System.Net.Security.SslStream using the asynchronous APIs. I searched the web and couldn’t find anything significant, so I decided to write some that included the asynchronous usage of the TcpListenter and TcpClient objects (both in the System.Net.Sockets namespace). In this post, I will show both the client and server side of the picture.
The person that was requesting this sample code seemed pretty anxious to get it, so I pumped this out pretty quickly, and as such, there are probably some bugs in it – please let me know of any you find and I will fix them. My goal here is to introduce the concepts and is not to provide production ready code. There are some things that I plan on changing about this code, but this should be a good starting place for anyone unfamiliar with the usage. Watch for “To Do Items” sections where I try to call out some of the things that I would like to add at some point, but you may need to add to your own code in the mean time…
To start, here is some helper code that is shared between client and server code.
Common Code:
The delegate function definition is used to notify you that a secure connection attempt is either ready for use or that an asynchronous error occurred. The SecureConnectionResults class is merely a holder for the results. You will need to provide an implementation of this delegate function.
When you delegate function is called, you will need to check for any asynchronous exception that may have occurred by looking at the SecureConnectionResults.AsyncException property. If it is null, then the SslStream object should be ready for use. Also, you will want to note that the SecureConnectionResultsCallback will be invoked on a Threadpool thread, so you won’t want to hold onto that thread permanently as it is a limited resource.
To Do Items:
· May also want to expose the underlying socket through the SecureConnectionResults object. This would allow you to change socket options or switch back to an unencrypted network connection if you so desire.
using System;
using System.Net.Security;
public delegate void SecureConnectionResultsCallback(object sender, SecureConnectionResults args);
public class SecureConnectionResults
{
private SslStream secureStream;
private Exception asyncException;
internal SecureConnectionResults(SslStream sslStream)
{
this.secureStream = sslStream;
}
internal SecureConnectionResults(Exception exception)
{
this.asyncException = exception;
}
public Exception AsyncException{get{return asyncException;}}
public SslStream SecureStream{get{return secureStream;}}
}
Server Code:
Here is my implementation of a TcpListener that accepts a connection and then initiates the SSL handshake immediately (by calling SslStream.BeginAuthenticateAsServer from within the OnAcceptConnection callback). This code automatically handles both IPv6 and IPv4 for you – make sure to read the “To Do Items”. If you aren’t interested in reading all of the code, the bulk of the work is done inside the StartConnecting, OnAcceptConnection and OnAuthenticateAsServer functions.
To Do Items:
· I haven’t added any substantial error handling to this code.
o For example, you might be able to bind the IPv4 socket to the port but an error could occur when trying to bind the IPv6 socket to that same port (i.e. – it is taken by another application on IPv6 but not on IPv4).
· When on Windows Vista or later, use a single socket to listen for both IPv4 and IPv6 – this avoids the binding problem previously discussed.
· Another example would be that a fatal socket error could happen in OnAcceptConnection or OnAuthenticateAsServer that should result in the entire object being invalidated. I will leave it up to you to add these details for now, but will try to update the code when I have time.
· Thread safety. I am not doing any locking inside the object and so you could see funny results.
o For example, you shutdown the object while a callback is in progress.
using System;
using System.Net;
using System.Net.Sockets;
using System.Net.Security;
using System.Security.Cryptography.X509Certificates;
using System.Security.Authentication;
public class SecureTcpServer : IDisposable
{
X509Certificate serverCert;
RemoteCertificateValidationCallback certValidationCallback;
SecureConnectionResultsCallback connectionCallback;
AsyncCallback onAcceptConnection;
AsyncCallback onAuthenticateAsServer;
bool started;
int listenPort;
TcpListener listenerV4;
TcpListener listenerV6;
int disposed;
bool clientCertificateRequired;
bool checkCertifcateRevocation;
SslProtocols sslProtocols;
public SecureTcpServer(int listenPort, X509Certificate serverCertificate,
SecureConnectionResultsCallback callback)
:this(listenPort,serverCertificate,callback,null)
{
}
public SecureTcpServer(int listenPort, X509Certificate serverCertificate,
SecureConnectionResultsCallback callback,
RemoteCertificateValidationCallback certValidationCallback)
{
if (listenPort < 0 || listenPort > UInt16.MaxValue)
throw new ArgumentOutOfRangeException(“listenPort”);
if (serverCertificate == null)
throw new ArgumentNullException(“serverCertificate”);
if (callback == null)
throw new ArgumentNullException(“callback”);
onAcceptConnection = new AsyncCallback(OnAcceptConnection);
onAuthenticateAsServer = new AsyncCallback(OnAuthenticateAsServer);
this.serverCert = serverCertificate;
this.certValidationCallback = certValidationCallback;
this.connectionCallback = callback;
this.listenPort = listenPort;
this.disposed = 0;
this.checkCertifcateRevocation = false;
this.clientCertificateRequired = false;
this.sslProtocols = SslProtocols.Default;
}
~SecureTcpServer()
{
Dispose();
}
public SslProtocols SslProtocols
{
get { return sslProtocols; }
set { sslProtocols = value; }
}
public bool CheckCertifcateRevocation
{
get { return checkCertifcateRevocation; }
set { checkCertifcateRevocation = value; }
}
public bool ClientCertificateRequired
{
get { return clientCertificateRequired; }
set { clientCertificateRequired = value; }
}
public void StartListening()
{
if(started)
throw new InvalidOperationException(“Already started…”);
IPEndPoint localIP;
if (Socket.SupportsIPv4 && listenerV4 == null)
{
localIP = new IPEndPoint(IPAddress.Any, listenPort);
Console.WriteLine(“SecureTcpServer: Started listening on {0}”, localIP);
listenerV4 = new TcpListener(localIP);
}
if(Socket.OSSupportsIPv6 && listenerV6 == null)
{
localIP = new IPEndPoint(IPAddress.IPv6Any, listenPort);
Console.WriteLine(“SecureTcpServer: Started listening on {0}”, localIP);
listenerV6 = new TcpListener(localIP);
}
if(listenerV4 != null)
{
listenerV4.Start();
listenerV4.BeginAcceptTcpClient(onAcceptConnection,listenerV4);
}
if(listenerV6 != null)
{
listenerV6.Start();
listenerV6.BeginAcceptTcpClient(onAcceptConnection,listenerV6);
}
started = true;
}
public void StopListening()
{
if (!started)
return;
started = false;
if (listenerV4 != null)
listenerV4.Stop();
if (listenerV6 != null)
listenerV6.Stop();
}
void OnAcceptConnection(IAsyncResult result)
{
TcpListener listener = result.AsyncState as TcpListener;
TcpClient client = null;
SslStream sslStream = null;
try
{
if (this.started)
{
//start accepting the next connection…
listener.BeginAcceptTcpClient(this.onAcceptConnection, listener);
}
else
{
//someone called Stop() – don’t call EndAcceptTcpClient because
//it will throw an ObjectDisposedException
return;
}
//complete the last operation…
client = listener.EndAcceptTcpClient(result);
bool leaveStreamOpen = false;//close the socket when done
if (this.certValidationCallback != null)
sslStream = new SslStream(client.GetStream(), leaveStreamOpen, this.certValidationCallback);
else
sslStream = new SslStream(client.GetStream(), leaveStreamOpen);
sslStream.BeginAuthenticateAsServer(this.serverCert,
this.clientCertificateRequired,
this.sslProtocols,
this.checkCertifcateRevocation,//checkCertifcateRevocation
this.onAuthenticateAsServer,
sslStream);
}
catch (Exception ex)
{
if (sslStream != null)
{
sslStream.Dispose();
sslStream = null;
}
this.connectionCallback(this, new SecureConnectionResults(ex));
}
}
void OnAuthenticateAsServer(IAsyncResult result)
{
SslStream sslStream = null;
try
{
sslStream = result.AsyncState as SslStream;
sslStream.EndAuthenticateAsServer(result);
this.connectionCallback(this, new SecureConnectionResults(sslStream));
}
catch (Exception ex)
{
if (sslStream != null)
{
sslStream.Dispose();
sslStream = null;
}
this.connectionCallback(this, new SecureConnectionResults(ex));
}
}
public void Dispose()
{
if (System.Threading.Interlocked.Increment(ref disposed) == 1)
{
if (this.listenerV4 != null)
listenerV4.Stop();
if (this.listenerV6 != null)
listenerV6.Stop();
listenerV4 = null;
listenerV6 = null;
GC.SuppressFinalize(this);
}
}
}
Client Code:
The client code is similar to the server code in that it tries to abstract you from handling the connecting and SSL negotiation. The remoteHostName parameter is used when validating the server’s certificate. If the name you pass in doesn’t match the name on the server’s certificate, you will get certificate errors (i.e. System.Net.Security.SslPolicyErrors.RemoteCertificateNameMismatch). Again, if you really only want to look at the most important parts of the code, focus on the StartConnecting, OnConnected and OnAuthenticateAsClient functions.
To Do Items:
· Change StartConnecting so that it doesn’t require a single IPEndpoint. It would be nice if the code just did an asynchronous DNS lookup for you based on the host name and then automatically connected to any of the resolved addresses (regardless of IPv4 or IPv6)
· I haven’t added any substantial error handling to this code.
o An example would be that a fatal error could happen that should result in the entire object being invalidated. I will leave it up to you to add these details for now, but will try to update the code when I have time.
· Thread safety. I am not doing any locking inside the object and so you could see funny results.
using System;
using System.Net;
using System.Net.Sockets;
using System.Net.Security;
using System.Security.Cryptography.X509Certificates;
using System.Security.Authentication;
public class SecureTcpClient : IDisposable
{
X509CertificateCollection clientCertificates;
RemoteCertificateValidationCallback certValidationCallback;
SecureConnectionResultsCallback connectionCallback;
bool checkCertificateRevocation;
AsyncCallback onConnected;
AsyncCallback onAuthenticateAsClient;
TcpClient client;
IPEndPoint remoteEndPoint;
string remoteHostName;
SslProtocols protocols;
int disposed;
public SecureTcpClient(SecureConnectionResultsCallback callback)
: this(callback,null,SslProtocols.Default)
{
}
public SecureTcpClient(SecureConnectionResultsCallback callback,
RemoteCertificateValidationCallback certValidationCallback)
: this(callback, certValidationCallback, SslProtocols.Default)
{
}
public SecureTcpClient(SecureConnectionResultsCallback callback,
RemoteCertificateValidationCallback certValidationCallback,
SslProtocols sslProtocols)
{
if (callback == null)
throw new ArgumentNullException(“callback”);
onConnected = new AsyncCallback(OnConnected);
onAuthenticateAsClient = new AsyncCallback(OnAuthenticateAsClient);
this.certValidationCallback = certValidationCallback;
this.connectionCallback = callback;
protocols = sslProtocols;
this.disposed = 0;
}
~SecureTcpClient()
{
Dispose();
}
public bool CheckCertificateRevocation
{
get { return checkCertificateRevocation; }
set {checkCertificateRevocation = value;}
}
public void StartConnecting(string remoteHostName, IPEndPoint remoteEndPoint)
{
StartConnecting(remoteHostName,remoteEndPoint,null);
}
public void StartConnecting(string remoteHostName, IPEndPoint remoteEndPoint,
X509CertificateCollection clientCertificates)
{
if (string.IsNullOrEmpty(remoteHostName))
throw new ArgumentException(“Value cannot be null or empty”,“remoteHostName”);
if (remoteEndPoint == null)
throw new ArgumentNullException(“remoteEndPoint”);
Console.WriteLine(“Client connecting to: {0}”, remoteEndPoint);
this.clientCertificates = clientCertificates;
this.remoteHostName = remoteHostName;
this.remoteEndPoint = remoteEndPoint;
if (client != null)
client.Close();
client = new TcpClient(remoteEndPoint.AddressFamily);
client.BeginConnect(remoteEndPoint.Address,
remoteEndPoint.Port,
this.onConnected,null);
}
public void Close()
{
Dispose();
}
void OnConnected(IAsyncResult result)
{
SslStream sslStream = null;
try
{
bool leaveStreamOpen = false;//close the socket when done
if (this.certValidationCallback != null)
sslStream = new SslStream(client.GetStream(), leaveStreamOpen, this.certValidationCallback);
else
sslStream = new SslStream(client.GetStream(), leaveStreamOpen);
sslStream.BeginAuthenticateAsClient(this.remoteHostName,
this.clientCertificates,
this.protocols,
this.checkCertificateRevocation,
this.onAuthenticateAsClient,
sslStream);
}
catch (Exception ex)
{
if (sslStream != null)
{
sslStream.Dispose();
sslStream = null;
}
this.connectionCallback(this,new SecureConnectionResults(ex));
}
}
void OnAuthenticateAsClient(IAsyncResult result)
{
SslStream sslStream = null;
try
{
sslStream = result.AsyncState as SslStream;
sslStream.EndAuthenticateAsClient(result);
this.connectionCallback(this,new SecureConnectionResults( sslStream));
}
catch (Exception ex)
{
if (sslStream != null)
{
sslStream.Dispose();
sslStream = null;
}
this.connectionCallback(this, new SecureConnectionResults(ex));
}
}
public void Dispose()
{
if (System.Threading.Interlocked.Increment(ref disposed) == 1)
{
if (client != null)
{
client.Close();
client = null;
}
GC.SuppressFinalize(this);
}
}
}
Sample Program:
Here is a very simple program that demonstrates the use of these objects.
using System;
using System.IO;
using System.Net;
using System.Threading;
using System.Net.Sockets;
using System.Security.Cryptography;
using System.Security.Cryptography.X509Certificates;
using System.Net.Security;
class Program
{
static void Main(string[] args)
{
SecureTcpServer server = null;
SecureTcpClient client = null;
try
{
int port = 8889;
RemoteCertificateValidationCallback certValidationCallback = null;
certValidationCallback = new RemoteCertificateValidationCallback(IgnoreCertificateErrorsCallback);
string certPath = System.Reflection.Assembly.GetEntryAssembly().Location;
certPath = Path.GetDirectoryName(certPath);
certPath = Path.Combine(certPath, “serverCert.cer”);
Console.WriteLine(“Loading Server Cert From: “ + certPath);
X509Certificate serverCert = X509Certificate.CreateFromCertFile(certPath);
server = new SecureTcpServer(port, serverCert,
new SecureConnectionResultsCallback(OnServerConnectionAvailable));
server.StartListening();
client = new SecureTcpClient(new SecureConnectionResultsCallback(OnClientConnectionAvailable),
certValidationCallback);
client.StartConnecting(“localhost”, new IPEndPoint(IPAddress.Loopback, port));
}
catch (Exception ex)
{
Console.WriteLine(ex);
}