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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
|
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package javax.net.ssl;
import java.nio.ByteBuffer;
/**
* The abstract implementation of secure communications using SSL, TLS, or other
* protocols. It includes the setup, handshake, and encrypt/decrypt
* functionality needed to create a secure connection.
*
* <h3>Default configuration</h3>
* <p>{@code SSLEngine} instances obtained from default {@link SSLContext} are configured as
* follows:
*
* <style type="text/css">
* tr.deprecated {
* background-color: #ccc;
* color: #999;
* font-style: italic;
* }
* </style>
*
* <h4>Protocols</h4>
* <table>
* <thead>
* <tr>
* <th>Protocol</th>
* <th>Supported (API Levels)</th>
* <th>Enabled by default (API Levels)</th>
* </tr>
* </thead>
* <tbody>
* <tr>
* <td>SSLv3</td>
* <td>1+</td>
* <td>1+</td>
* </tr>
* <tr>
* <td>TLSv1</td>
* <td>1+</td>
* <td>1+</td>
* </tr>
* <tr>
* <td>TLSv1.1</td>
* <td>20+</td>
* <td>20+</td>
* </tr>
* <tr>
* <td>TLSv1.2</td>
* <td>20+</td>
* <td>20+</td>
* </tr>
* </tbody>
* </table>
*
* <h4>Cipher suites</h4>
* <table>
* <thead>
* <tr>
* <th>Cipher suite</th>
* <th>Supported (API Levels)</th>
* <th>Enabled by default (API Levels)</th>
* </tr>
* </thead>
* <tbody>
* <tr class="deprecated">
* <td>SSL_DHE_DSS_EXPORT_WITH_DES40_CBC_SHA</td>
* <td>9–22</td>
* <td>9–19</td>
* </tr>
* <tr class="deprecated">
* <td>SSL_DHE_DSS_WITH_3DES_EDE_CBC_SHA</td>
* <td>9–22</td>
* <td>9–19</td>
* </tr>
* <tr class="deprecated">
* <td>SSL_DHE_DSS_WITH_DES_CBC_SHA</td>
* <td>9–22</td>
* <td>9–19</td>
* </tr>
* <tr class="deprecated">
* <td>SSL_DHE_RSA_EXPORT_WITH_DES40_CBC_SHA</td>
* <td>9–22</td>
* <td>9–19</td>
* </tr>
* <tr class="deprecated">
* <td>SSL_DHE_RSA_WITH_3DES_EDE_CBC_SHA</td>
* <td>9–22</td>
* <td>9–19</td>
* </tr>
* <tr class="deprecated">
* <td>SSL_DHE_RSA_WITH_DES_CBC_SHA</td>
* <td>9–22</td>
* <td>9–19</td>
* </tr>
* <tr class="deprecated">
* <td>SSL_DH_anon_EXPORT_WITH_DES40_CBC_SHA</td>
* <td>9–22</td>
* <td></td>
* </tr>
* <tr class="deprecated">
* <td>SSL_DH_anon_EXPORT_WITH_RC4_40_MD5</td>
* <td>9–22</td>
* <td></td>
* </tr>
* <tr class="deprecated">
* <td>SSL_DH_anon_WITH_3DES_EDE_CBC_SHA</td>
* <td>9–22</td>
* <td></td>
* </tr>
* <tr class="deprecated">
* <td>SSL_DH_anon_WITH_DES_CBC_SHA</td>
* <td>9–22</td>
* <td></td>
* </tr>
* <tr class="deprecated">
* <td>SSL_DH_anon_WITH_RC4_128_MD5</td>
* <td>9–22</td>
* <td></td>
* </tr>
* <tr class="deprecated">
* <td>SSL_RSA_EXPORT_WITH_DES40_CBC_SHA</td>
* <td>9–22</td>
* <td>9–19</td>
* </tr>
* <tr class="deprecated">
* <td>SSL_RSA_EXPORT_WITH_RC4_40_MD5</td>
* <td>9–22</td>
* <td>9–19</td>
* </tr>
* <tr>
* <td>SSL_RSA_WITH_3DES_EDE_CBC_SHA</td>
* <td>9+</td>
* <td>9–19</td>
* </tr>
* <tr class="deprecated">
* <td>SSL_RSA_WITH_DES_CBC_SHA</td>
* <td>9–22</td>
* <td>9–19</td>
* </tr>
* <tr class="deprecated">
* <td>SSL_RSA_WITH_NULL_MD5</td>
* <td>9–22</td>
* <td></td>
* </tr>
* <tr class="deprecated">
* <td>SSL_RSA_WITH_NULL_SHA</td>
* <td>9–22</td>
* <td></td>
* </tr>
* <tr>
* <td>SSL_RSA_WITH_RC4_128_MD5</td>
* <td>9+</td>
* <td>9–19</td>
* </tr>
* <tr>
* <td>SSL_RSA_WITH_RC4_128_SHA</td>
* <td>9+</td>
* <td>9+</td>
* </tr>
* <tr class="deprecated">
* <td>TLS_DHE_DSS_EXPORT_WITH_DES40_CBC_SHA</td>
* <td>1–8</td>
* <td>1–8</td>
* </tr>
* <tr class="deprecated">
* <td>TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA</td>
* <td>1–8</td>
* <td>1–8</td>
* </tr>
* <tr class="deprecated">
* <td>TLS_DHE_DSS_WITH_AES_128_CBC_SHA</td>
* <td>9–22</td>
* <td>9–22</td>
* </tr>
* <tr class="deprecated">
* <td>TLS_DHE_DSS_WITH_AES_128_CBC_SHA256</td>
* <td>20–22</td>
* <td></td>
* </tr>
* <tr class="deprecated">
* <td>TLS_DHE_DSS_WITH_AES_128_GCM_SHA256</td>
* <td>20–22</td>
* <td></td>
* </tr>
* <tr class="deprecated">
* <td>TLS_DHE_DSS_WITH_AES_256_CBC_SHA</td>
* <td>9–22</td>
* <td>20–22</td>
* </tr>
* <tr class="deprecated">
* <td>TLS_DHE_DSS_WITH_AES_256_CBC_SHA256</td>
* <td>20–22</td>
* <td></td>
* </tr>
* <tr class="deprecated">
* <td>TLS_DHE_DSS_WITH_AES_256_GCM_SHA384</td>
* <td>20–22</td>
* <td></td>
* </tr>
* <tr class="deprecated">
* <td>TLS_DHE_DSS_WITH_DES_CBC_SHA</td>
* <td>1–8</td>
* <td>1–8</td>
* </tr>
* <tr class="deprecated">
* <td>TLS_DHE_RSA_EXPORT_WITH_DES40_CBC_SHA</td>
* <td>1–8</td>
* <td>1–8</td>
* </tr>
* <tr class="deprecated">
* <td>TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA</td>
* <td>1–8</td>
* <td>1–8</td>
* </tr>
* <tr>
* <td>TLS_DHE_RSA_WITH_AES_128_CBC_SHA</td>
* <td>9+</td>
* <td>9+</td>
* </tr>
* <tr>
* <td>TLS_DHE_RSA_WITH_AES_128_CBC_SHA256</td>
* <td>20+</td>
* <td></td>
* </tr>
* <tr>
* <td>TLS_DHE_RSA_WITH_AES_128_GCM_SHA256</td>
* <td>20+</td>
* <td>20+</td>
* </tr>
* <tr>
* <td>TLS_DHE_RSA_WITH_AES_256_CBC_SHA</td>
* <td>9+</td>
* <td>20+</td>
* </tr>
* <tr>
* <td>TLS_DHE_RSA_WITH_AES_256_CBC_SHA256</td>
* <td>20+</td>
* <td></td>
* </tr>
* <tr>
* <td>TLS_DHE_RSA_WITH_AES_256_GCM_SHA384</td>
* <td>20+</td>
* <td>20+</td>
* </tr>
* <tr class="deprecated">
* <td>TLS_DHE_RSA_WITH_DES_CBC_SHA</td>
* <td>1–8</td>
* <td>1–8</td>
* </tr>
* <tr class="deprecated">
* <td>TLS_DH_DSS_EXPORT_WITH_DES40_CBC_SHA</td>
* <td>1–8</td>
* <td></td>
* </tr>
* <tr class="deprecated">
* <td>TLS_DH_DSS_WITH_3DES_EDE_CBC_SHA</td>
* <td>1–8</td>
* <td></td>
* </tr>
* <tr class="deprecated">
* <td>TLS_DH_DSS_WITH_DES_CBC_SHA</td>
* <td>1–8</td>
* <td></td>
* </tr>
* <tr class="deprecated">
* <td>TLS_DH_RSA_EXPORT_WITH_DES40_CBC_SHA</td>
* <td>1–8</td>
* <td></td>
* </tr>
* <tr class="deprecated">
* <td>TLS_DH_RSA_WITH_3DES_EDE_CBC_SHA</td>
* <td>1–8</td>
* <td></td>
* </tr>
* <tr class="deprecated">
* <td>TLS_DH_RSA_WITH_DES_CBC_SHA</td>
* <td>1–8</td>
* <td></td>
* </tr>
* <tr class="deprecated">
* <td>TLS_DH_anon_EXPORT_WITH_DES40_CBC_SHA</td>
* <td>1–8</td>
* <td></td>
* </tr>
* <tr class="deprecated">
* <td>TLS_DH_anon_WITH_3DES_EDE_CBC_SHA</td>
* <td>1–8</td>
* <td></td>
* </tr>
* <tr class="deprecated">
* <td>TLS_DH_anon_WITH_AES_128_CBC_SHA</td>
* <td>9–22</td>
* <td></td>
* </tr>
* <tr class="deprecated">
* <td>TLS_DH_anon_WITH_AES_128_CBC_SHA256</td>
* <td>20–22</td>
* <td></td>
* </tr>
* <tr class="deprecated">
* <td>TLS_DH_anon_WITH_AES_128_GCM_SHA256</td>
* <td>20–22</td>
* <td></td>
* </tr>
* <tr class="deprecated">
* <td>TLS_DH_anon_WITH_AES_256_CBC_SHA</td>
* <td>9–22</td>
* <td></td>
* </tr>
* <tr class="deprecated">
* <td>TLS_DH_anon_WITH_AES_256_CBC_SHA256</td>
* <td>20–22</td>
* <td></td>
* </tr>
* <tr class="deprecated">
* <td>TLS_DH_anon_WITH_AES_256_GCM_SHA384</td>
* <td>20–22</td>
* <td></td>
* </tr>
* <tr class="deprecated">
* <td>TLS_DH_anon_WITH_DES_CBC_SHA</td>
* <td>1–8</td>
* <td></td>
* </tr>
* <tr class="deprecated">
* <td>TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA</td>
* <td>20–22</td>
* <td></td>
* </tr>
* <tr>
* <td>TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA</td>
* <td>20+</td>
* <td>20+</td>
* </tr>
* <tr>
* <td>TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256</td>
* <td>20+</td>
* <td></td>
* </tr>
* <tr>
* <td>TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256</td>
* <td>20+</td>
* <td>20+</td>
* </tr>
* <tr>
* <td>TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA</td>
* <td>20+</td>
* <td>20+</td>
* </tr>
* <tr>
* <td>TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384</td>
* <td>20+</td>
* <td></td>
* </tr>
* <tr>
* <td>TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384</td>
* <td>20+</td>
* <td>20+</td>
* </tr>
* <tr class="deprecated">
* <td>TLS_ECDHE_ECDSA_WITH_NULL_SHA</td>
* <td>20–22</td>
* <td></td>
* </tr>
* <tr>
* <td>TLS_ECDHE_ECDSA_WITH_RC4_128_SHA</td>
* <td>20+</td>
* <td>20+</td>
* </tr>
* <tr class="deprecated">
* <td>TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA</td>
* <td>20–22</td>
* <td></td>
* </tr>
* <tr>
* <td>TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA</td>
* <td>20+</td>
* <td>20+</td>
* </tr>
* <tr>
* <td>TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256</td>
* <td>20+</td>
* <td></td>
* </tr>
* <tr>
* <td>TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256</td>
* <td>20+</td>
* <td>20+</td>
* </tr>
* <tr>
* <td>TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA</td>
* <td>20+</td>
* <td>20+</td>
* </tr>
* <tr>
* <td>TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384</td>
* <td>20+</td>
* <td></td>
* </tr>
* <tr>
* <td>TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384</td>
* <td>20+</td>
* <td>20+</td>
* </tr>
* <tr class="deprecated">
* <td>TLS_ECDHE_RSA_WITH_NULL_SHA</td>
* <td>20–22</td>
* <td></td>
* </tr>
* <tr>
* <td>TLS_ECDHE_RSA_WITH_RC4_128_SHA</td>
* <td>20+</td>
* <td>20+</td>
* </tr>
* <tr class="deprecated">
* <td>TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA</td>
* <td>20–22</td>
* <td></td>
* </tr>
* <tr class="deprecated">
* <td>TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA</td>
* <td>20–22</td>
* <td></td>
* </tr>
* <tr class="deprecated">
* <td>TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256</td>
* <td>20–22</td>
* <td></td>
* </tr>
* <tr class="deprecated">
* <td>TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256</td>
* <td>20–22</td>
* <td></td>
* </tr>
* <tr class="deprecated">
* <td>TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA</td>
* <td>20–22</td>
* <td></td>
* </tr>
* <tr class="deprecated">
* <td>TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384</td>
* <td>20–22</td>
* <td></td>
* </tr>
* <tr class="deprecated">
* <td>TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384</td>
* <td>20–22</td>
* <td></td>
* </tr>
* <tr class="deprecated">
* <td>TLS_ECDH_ECDSA_WITH_NULL_SHA</td>
* <td>20–22</td>
* <td></td>
* </tr>
* <tr class="deprecated">
* <td>TLS_ECDH_ECDSA_WITH_RC4_128_SHA</td>
* <td>20–22</td>
* <td></td>
* </tr>
* <tr class="deprecated">
* <td>TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA</td>
* <td>20–22</td>
* <td></td>
* </tr>
* <tr class="deprecated">
* <td>TLS_ECDH_RSA_WITH_AES_128_CBC_SHA</td>
* <td>20–22</td>
* <td></td>
* </tr>
* <tr class="deprecated">
* <td>TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256</td>
* <td>20–22</td>
* <td></td>
* </tr>
* <tr class="deprecated">
* <td>TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256</td>
* <td>20–22</td>
* <td></td>
* </tr>
* <tr class="deprecated">
* <td>TLS_ECDH_RSA_WITH_AES_256_CBC_SHA</td>
* <td>20–22</td>
* <td></td>
* </tr>
* <tr class="deprecated">
* <td>TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384</td>
* <td>20–22</td>
* <td></td>
* </tr>
* <tr class="deprecated">
* <td>TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384</td>
* <td>20–22</td>
* <td></td>
* </tr>
* <tr class="deprecated">
* <td>TLS_ECDH_RSA_WITH_NULL_SHA</td>
* <td>20–22</td>
* <td></td>
* </tr>
* <tr class="deprecated">
* <td>TLS_ECDH_RSA_WITH_RC4_128_SHA</td>
* <td>20–22</td>
* <td></td>
* </tr>
* <tr class="deprecated">
* <td>TLS_ECDH_anon_WITH_3DES_EDE_CBC_SHA</td>
* <td>20–22</td>
* <td></td>
* </tr>
* <tr class="deprecated">
* <td>TLS_ECDH_anon_WITH_AES_128_CBC_SHA</td>
* <td>20–22</td>
* <td></td>
* </tr>
* <tr class="deprecated">
* <td>TLS_ECDH_anon_WITH_AES_256_CBC_SHA</td>
* <td>20–22</td>
* <td></td>
* </tr>
* <tr class="deprecated">
* <td>TLS_ECDH_anon_WITH_NULL_SHA</td>
* <td>20–22</td>
* <td></td>
* </tr>
* <tr class="deprecated">
* <td>TLS_ECDH_anon_WITH_RC4_128_SHA</td>
* <td>20–22</td>
* <td></td>
* </tr>
* <tr>
* <td>TLS_EMPTY_RENEGOTIATION_INFO_SCSV</td>
* <td>20+</td>
* <td>20+</td>
* </tr>
* <tr>
* <td>TLS_FALLBACK_SCSV</td>
* <td>21+</td>
* <td></td>
* </tr>
* <tr>
* <td>TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA</td>
* <td>21+</td>
* <td>21+</td>
* </tr>
* <tr>
* <td>TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA</td>
* <td>21+</td>
* <td>21+</td>
* </tr>
* <tr class="deprecated">
* <td>TLS_NULL_WITH_NULL_NULL</td>
* <td>1–8</td>
* <td></td>
* </tr>
* <tr class="deprecated">
* <td>TLS_PSK_WITH_3DES_EDE_CBC_SHA</td>
* <td>21–22</td>
* <td></td>
* </tr>
* <tr>
* <td>TLS_PSK_WITH_AES_128_CBC_SHA</td>
* <td>21+</td>
* <td>21+</td>
* </tr>
* <tr>
* <td>TLS_PSK_WITH_AES_256_CBC_SHA</td>
* <td>21+</td>
* <td>21+</td>
* </tr>
* <tr>
* <td>TLS_PSK_WITH_RC4_128_SHA</td>
* <td>21+</td>
* <td></td>
* </tr>
* <tr class="deprecated">
* <td>TLS_RSA_EXPORT_WITH_DES40_CBC_SHA</td>
* <td>1–8</td>
* <td>1–8</td>
* </tr>
* <tr class="deprecated">
* <td>TLS_RSA_WITH_3DES_EDE_CBC_SHA</td>
* <td>1–8</td>
* <td>1–8</td>
* </tr>
* <tr>
* <td>TLS_RSA_WITH_AES_128_CBC_SHA</td>
* <td>9+</td>
* <td>9+</td>
* </tr>
* <tr>
* <td>TLS_RSA_WITH_AES_128_CBC_SHA256</td>
* <td>20+</td>
* <td></td>
* </tr>
* <tr>
* <td>TLS_RSA_WITH_AES_128_GCM_SHA256</td>
* <td>20+</td>
* <td>20+</td>
* </tr>
* <tr>
* <td>TLS_RSA_WITH_AES_256_CBC_SHA</td>
* <td>9+</td>
* <td>20+</td>
* </tr>
* <tr>
* <td>TLS_RSA_WITH_AES_256_CBC_SHA256</td>
* <td>20+</td>
* <td></td>
* </tr>
* <tr>
* <td>TLS_RSA_WITH_AES_256_GCM_SHA384</td>
* <td>20+</td>
* <td>20+</td>
* </tr>
* <tr class="deprecated">
* <td>TLS_RSA_WITH_DES_CBC_SHA</td>
* <td>1–8</td>
* <td>1–8</td>
* </tr>
* <tr class="deprecated">
* <td>TLS_RSA_WITH_NULL_MD5</td>
* <td>1–8</td>
* <td></td>
* </tr>
* <tr class="deprecated">
* <td>TLS_RSA_WITH_NULL_SHA</td>
* <td>1–8</td>
* <td></td>
* </tr>
* <tr class="deprecated">
* <td>TLS_RSA_WITH_NULL_SHA256</td>
* <td>20–22</td>
* <td></td>
* </tr>
* </tbody>
* </table>
*
* <p><em>NOTE</em>: PSK cipher suites are enabled by default only if the {@code SSLContext} through
* which the engine was created has been initialized with a {@code PSKKeyManager}.
*
* @since 1.5
*/
public abstract class SSLEngine {
private final String peerHost;
private final int peerPort;
/**
* Creates a new {@code SSLEngine} instance.
*/
protected SSLEngine() {
peerHost = null;
peerPort = -1;
}
/**
* Creates a new {@code SSLEngine} instance with the specified host and
* port.
*
* @param host
* the name of the host.
* @param port
* the port of the host.
*/
protected SSLEngine(String host, int port) {
this.peerHost = host;
this.peerPort = port;
}
/**
* Returns the name of the peer host.
*
* @return the name of the peer host, or {@code null} if none is available.
*/
public String getPeerHost() {
return peerHost;
}
/**
* Returns the port number of the peer host.
*
* @return the port number of the peer host, or {@code -1} is none is
* available.
*/
public int getPeerPort() {
return peerPort;
}
/**
* Initiates a handshake on this engine.
* <p>
* Calling this method is not needed for the initial handshake: it will be
* called by {@code wrap} or {@code unwrap} if the initial handshake has not
* been started yet.
*
* @throws SSLException
* if starting the handshake fails.
* @throws IllegalStateException
* if the engine does not have all the needed settings (e.g.
* client/server mode not set).
*/
public abstract void beginHandshake() throws SSLException;
/**
* Notifies this engine instance that no more inbound network data will be
* sent to this engine.
*
* @throws SSLException
* if this engine did not receive a needed protocol specific
* close notification message from the peer.
*/
public abstract void closeInbound() throws SSLException;
/**
* Notifies this engine instance that no more outbound application data will
* be sent to this engine.
*/
public abstract void closeOutbound();
/**
* Returns a delegate task for this engine instance. Some engine operations
* may require the results of blocking or long running operations, and the
* {@code SSLEngineResult} instances returned by this engine may indicate
* that a delegated task result is needed. In this case the
* {@link Runnable#run() run} method of the returned {@code Runnable}
* delegated task must be called.
*
* @return a delegate task, or {@code null} if none are available.
*/
public abstract Runnable getDelegatedTask();
/**
* Returns the SSL cipher suite names that are enabled in this engine
* instance.
*
* @return the SSL cipher suite names that are enabled in this engine
* instance.
*/
public abstract String[] getEnabledCipherSuites();
/**
* Returns the protocol version names that are enabled in this engine
* instance.
*
* @return the protocol version names that are enabled in this engine
* instance.
*/
public abstract String[] getEnabledProtocols();
/**
* Returns whether new SSL sessions may be established by this engine.
*
* @return {@code true} if new session may be established, {@code false} if
* existing sessions must be reused.
*/
public abstract boolean getEnableSessionCreation();
/**
* Returns the status of the handshake of this engine instance.
*
* @return the status of the handshake of this engine instance.
*/
public abstract SSLEngineResult.HandshakeStatus getHandshakeStatus();
/**
* Returns whether this engine instance will require client authentication.
*
* @return {@code true} if this engine will require client authentication,
* {@code false} if no client authentication is needed.
*/
public abstract boolean getNeedClientAuth();
/**
* Returns the SSL session for this engine instance.
*
* @return the SSL session for this engine instance.
*/
public abstract SSLSession getSession();
/**
* Returns the SSL cipher suite names that are supported by this engine.
* These cipher suites can be enabled using
* {@link #setEnabledCipherSuites(String[])}.
*
* @return the SSL cipher suite names that are supported by this engine.
*/
public abstract String[] getSupportedCipherSuites();
/**
* Returns the protocol names that are supported by this engine. These
* protocols can be enables using {@link #setEnabledProtocols(String[])}.
*
* @return the protocol names that are supported by this engine.
*/
public abstract String[] getSupportedProtocols();
/**
* Returns whether this engine is set to act in client mode when
* handshaking.
*
* @return {@code true} if the engine is set to do handshaking in client
* mode.
*/
public abstract boolean getUseClientMode();
/**
* Returns whether this engine will request client authentication.
*
* @return {@code true} if client authentication will be requested,
* {@code false} otherwise.
*/
public abstract boolean getWantClientAuth();
/**
* Returns whether no more inbound data will be accepted by this engine.
*
* @return {@code true} if no more inbound data will be accepted by this
* engine, {@code false} otherwise.
*/
public abstract boolean isInboundDone();
/**
* Returns whether no more outbound data will be produced by this engine.
*
* @return {@code true} if no more outbound data will be producted by this
* engine, {@code otherwise} false.
*/
public abstract boolean isOutboundDone();
/**
* Sets the SSL cipher suite names that should be enabled in this engine
* instance. Only cipher suites listed by {@code getSupportedCipherSuites()}
* are allowed.
*
* @param suites
* the SSL cipher suite names to be enabled.
* @throws IllegalArgumentException
* if one of the specified cipher suites is not supported, or if
* {@code suites} is {@code null}.
*/
public abstract void setEnabledCipherSuites(String[] suites);
/**
* Sets the protocol version names that should be enabled in this engine
* instance. Only protocols listed by {@code getSupportedProtocols()} are
* allowed.
*
* @param protocols
* the protocol version names to be enabled.
* @throws IllegalArgumentException
* if one of the protocol version names is not supported, or if
* {@code protocols} is {@code null}.
*/
public abstract void setEnabledProtocols(String[] protocols);
/**
* Sets whether new SSL sessions may be established by this engine instance.
*
* @param flag
* {@code true} if new SSL sessions may be established,
* {@code false} if existing SSL sessions must be reused.
*/
public abstract void setEnableSessionCreation(boolean flag);
/**
* Sets whether this engine must require client authentication. The client
* authentication is one of:
* <ul>
* <li>authentication required</li>
* <li>authentication requested</li>
* <li>no authentication needed</li>
* </ul>
* This method overrides the setting of {@link #setWantClientAuth(boolean)}.
*
* @param need
* {@code true} if client authentication is required,
* {@code false} if no authentication is needed.
*/
public abstract void setNeedClientAuth(boolean need);
/**
* Sets whether this engine should act in client (or server) mode when
* handshaking.
*
* @param mode
* {@code true} if this engine should act in client mode,
* {@code false} if not.
* @throws IllegalArgumentException
* if this method is called after starting the initial
* handshake.
*/
public abstract void setUseClientMode(boolean mode);
/**
* Sets whether this engine should request client authentication. The client
* authentication is one of the following:
* <ul>
* <li>authentication required</li>
* <li>authentication requested</li>
* <li>no authentication needed</li>
* </ul>
* This method overrides the setting of {@link #setNeedClientAuth(boolean)}.
*
* @param want
* {@code true} if client authentication should be requested,
* {@code false} if no authentication is needed.
*/
public abstract void setWantClientAuth(boolean want);
/**
* Decodes the incoming network data buffer into application data buffers.
* If a handshake has not been started yet, it will automatically be
* started.
*
* @param src
* the buffer with incoming network data
* @param dsts
* the array of destination buffers for incoming application
* data.
* @param offset
* the offset in the array of destination buffers to which data
* is to be transferred.
* @param length
* the maximum number of destination buffers to be used.
* @return the result object of this operation.
* @throws SSLException
* if a problem occurred while processing the data.
* @throws IndexOutOfBoundsException
* if {@code length} is greater than
* {@code dsts.length - offset}.
* @throws java.nio.ReadOnlyBufferException
* if one of the destination buffers is read-only.
* @throws IllegalArgumentException
* if {@code src}, {@code dsts}, or one of the entries in
* {@code dsts} is {@code null}.
* @throws IllegalStateException
* if the engine does not have all the needed settings (e.g.
* client/server mode not set).
*/
public abstract SSLEngineResult unwrap(ByteBuffer src,
ByteBuffer[] dsts,
int offset,
int length) throws SSLException;
/**
* Encodes the outgoing application data buffers into the network data
* buffer. If a handshake has not been started yet, it will automatically be
* started.
*
* @param srcs
* the array of source buffers of outgoing application data.
* @param offset
* the offset in the array of source buffers from which data is
* to be retrieved.
* @param length
* the maximum number of source buffers to be used.
* @param dst
* the destination buffer for network data.
* @return the result object of this operation.
* @throws SSLException
* if a problem occurred while processing the data.
* @throws IndexOutOfBoundsException
* if {@code length} is greater than
* {@code srcs.length - offset}.
* @throws java.nio.ReadOnlyBufferException
* if the destination buffer is readonly.
* @throws IllegalArgumentException
* if {@code srcs}, {@code dst}, or one the entries in
* {@code srcs} is {@code null}.
* @throws IllegalStateException
* if the engine does not have all the needed settings (e.g.
* client/server mode not set).
*/
public abstract SSLEngineResult wrap(ByteBuffer[] srcs, int offset, int length, ByteBuffer dst)
throws SSLException;
/**
* Decodes the incoming network data buffer into the application data
* buffer. If a handshake has not been started yet, it will automatically be
* started.
*
* @param src
* the buffer with incoming network data
* @param dst
* the destination buffer for incoming application data.
* @return the result object of this operation.
* @throws SSLException
* if a problem occurred while processing the data.
* @throws java.nio.ReadOnlyBufferException
* if one of the destination buffers is read-only.
* @throws IllegalArgumentException
* if {@code src} or {@code dst} is {@code null}.
* @throws IllegalStateException
* if the engine does not have all the needed settings (e.g.
* client/server mode not set).
*/
public SSLEngineResult unwrap(ByteBuffer src, ByteBuffer dst) throws SSLException {
return unwrap(src, new ByteBuffer[] { dst }, 0, 1);
}
/**
* Decodes the incoming network data buffer into the application data
* buffers. If a handshake has not been started yet, it will automatically
* be started.
*
* @param src
* the buffer with incoming network data
* @param dsts
* the array of destination buffers for incoming application
* data.
* @return the result object of this operation.
* @throws SSLException
* if a problem occurred while processing the data.
* @throws java.nio.ReadOnlyBufferException
* if one of the destination buffers is read-only.
* @throws IllegalArgumentException
* if {@code src} or {@code dsts} is {@code null}.
* @throws IllegalStateException
* if the engine does not have all the needed settings (e.g.
* client/server mode not set).
*/
public SSLEngineResult unwrap(ByteBuffer src, ByteBuffer[] dsts) throws SSLException {
if (dsts == null) {
throw new IllegalArgumentException("Byte buffer array dsts is null");
}
return unwrap(src, dsts, 0, dsts.length);
}
/**
* Encodes the outgoing application data buffers into the network data
* buffer. If a handshake has not been started yet, it will automatically be
* started.
*
* @param srcs
* the array of source buffers of outgoing application data.
* @param dst
* the destination buffer for network data.
* @return the result object of this operation.
* @throws SSLException
* if a problem occurred while processing the data.
* @throws java.nio.ReadOnlyBufferException
* if the destination buffer is readonly.
* @throws IllegalArgumentException
* if {@code srcs} or {@code dst} is {@code null}.
* @throws IllegalStateException
* if the engine does not have all the needed settings (e.g.
* client/server mode not set).
*/
public SSLEngineResult wrap(ByteBuffer[] srcs, ByteBuffer dst) throws SSLException {
if (srcs == null) {
throw new IllegalArgumentException("Byte buffer array srcs is null");
}
return wrap(srcs, 0, srcs.length, dst);
}
/**
* Encodes the outgoing application data buffer into the network data
* buffer. If a handshake has not been started yet, it will automatically be
* started.
*
* @param src
* the source buffers of outgoing application data.
* @param dst
* the destination buffer for network data.
* @return the result object of this operation.
* @throws SSLException
* if a problem occurred while processing the data.
* @throws java.nio.ReadOnlyBufferException
* if the destination buffer is readonly.
* @throws IllegalArgumentException
* if {@code src} or {@code dst} is {@code null}.
* @throws IllegalStateException
* if the engine does not have all the needed settings (e.g.
* client/server mode not set).
*/
public SSLEngineResult wrap(ByteBuffer src, ByteBuffer dst) throws SSLException {
return wrap(new ByteBuffer[] { src }, 0, 1, dst);
}
/**
* Returns a new SSLParameters based on this SSLSocket's current
* cipher suites, protocols, and client authentication settings.
*
* @since 1.6
*/
public SSLParameters getSSLParameters() {
SSLParameters p = new SSLParameters();
p.setCipherSuites(getEnabledCipherSuites());
p.setProtocols(getEnabledProtocols());
p.setNeedClientAuth(getNeedClientAuth());
p.setWantClientAuth(getWantClientAuth());
return p;
}
/**
* Sets various SSL handshake parameters based on the SSLParameter
* argument. Specifically, sets the SSLEngine's enabled cipher
* suites if the parameter's cipher suites are non-null. Similarly
* sets the enabled protocols. If the parameters specify the want
* or need for client authentication, those requirements are set
* on the SSLEngine, otherwise both are set to false.
* @since 1.6
*/
public void setSSLParameters(SSLParameters p) {
String[] cipherSuites = p.getCipherSuites();
if (cipherSuites != null) {
setEnabledCipherSuites(cipherSuites);
}
String[] protocols = p.getProtocols();
if (protocols != null) {
setEnabledProtocols(protocols);
}
if (p.getNeedClientAuth()) {
setNeedClientAuth(true);
} else if (p.getWantClientAuth()) {
setWantClientAuth(true);
} else {
setWantClientAuth(false);
}
}
}
|
