-
Notifications
You must be signed in to change notification settings - Fork 436
/
available-scan-commands.html
1459 lines (1294 loc) · 110 KB
/
available-scan-commands.html
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
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<title>Appendix: Scan Commands — SSLyze 5.0.3 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="prev" title="Exporting and processing scan results in JSON" href="json-output.html" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
</head><body>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="appendix-scan-commands">
<h1><a class="toc-backref" href="#id19">Appendix: Scan Commands</a><a class="headerlink" href="#appendix-scan-commands" title="Permalink to this headline">¶</a></h1>
<p>Every type of TLS check that SSLyze can run against a server (supported cipher suites, session renegotiation, etc.) is
represented by a <code class="docutils literal notranslate"><span class="pre">ScanCommand</span></code>, which, when run against a server, will return a specific result.</p>
<p>This page lists all the <code class="docutils literal notranslate"><span class="pre">ScanCommand</span></code> and their corresponding results available in the current release of SSLyze.</p>
<p>For an example on how to run a scan via the Python API, see <a class="reference internal" href="running-a-scan-in-python.html"><span class="doc">Running a Scan in Python</span></a>.</p>
<div class="contents topic" id="contents">
<p class="topic-title">Contents</p>
<ul class="simple">
<li><p><a class="reference internal" href="#appendix-scan-commands" id="id19">Appendix: Scan Commands</a></p>
<ul>
<li><p><a class="reference internal" href="#certificate-information" id="id20">Certificate Information</a></p></li>
<li><p><a class="reference internal" href="#cipher-suites" id="id21">Cipher Suites</a></p></li>
<li><p><a class="reference internal" href="#supported-elliptic-curves" id="id22">Supported Elliptic Curves</a></p></li>
<li><p><a class="reference internal" href="#robot" id="id23">ROBOT</a></p></li>
<li><p><a class="reference internal" href="#session-resumption-support" id="id24">Session Resumption Support</a></p></li>
<li><p><a class="reference internal" href="#crime" id="id25">CRIME</a></p></li>
<li><p><a class="reference internal" href="#tls-1-3-early-data" id="id26">TLS 1.3 Early Data</a></p></li>
<li><p><a class="reference internal" href="#downgrade-prevention" id="id27">Downgrade Prevention</a></p></li>
<li><p><a class="reference internal" href="#heartbleed" id="id28">Heartbleed</a></p></li>
<li><p><a class="reference internal" href="#http-security-headers" id="id29">HTTP Security Headers</a></p></li>
<li><p><a class="reference internal" href="#openssl-ccs-injection" id="id30">OpenSSL CCS Injection</a></p></li>
<li><p><a class="reference internal" href="#insecure-renegotiation" id="id31">Insecure Renegotiation</a></p></li>
</ul>
</li>
</ul>
</div>
<p>The following scan commands are available in the current version of SSLyze:</p>
<span class="target" id="module-sslyze"></span><dl class="py class">
<dt class="sig sig-object py" id="sslyze.ScanCommand">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">sslyze.</span></span><span class="sig-name descname"><span class="pre">ScanCommand</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#sslyze.ScanCommand" title="Permalink to this definition">¶</a></dt>
<dd><p>An enumeration.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="sslyze.ScanCommand.CERTIFICATE_INFO">
<span class="sig-name descname"><span class="pre">CERTIFICATE_INFO</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'certificate_info'</span></em><a class="headerlink" href="#sslyze.ScanCommand.CERTIFICATE_INFO" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="sslyze.ScanCommand.SESSION_RESUMPTION">
<span class="sig-name descname"><span class="pre">SESSION_RESUMPTION</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'session_resumption'</span></em><a class="headerlink" href="#sslyze.ScanCommand.SESSION_RESUMPTION" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="sslyze.ScanCommand.SSL_2_0_CIPHER_SUITES">
<span class="sig-name descname"><span class="pre">SSL_2_0_CIPHER_SUITES</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'ssl_2_0_cipher_suites'</span></em><a class="headerlink" href="#sslyze.ScanCommand.SSL_2_0_CIPHER_SUITES" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="sslyze.ScanCommand.SSL_3_0_CIPHER_SUITES">
<span class="sig-name descname"><span class="pre">SSL_3_0_CIPHER_SUITES</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'ssl_3_0_cipher_suites'</span></em><a class="headerlink" href="#sslyze.ScanCommand.SSL_3_0_CIPHER_SUITES" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="sslyze.ScanCommand.TLS_1_0_CIPHER_SUITES">
<span class="sig-name descname"><span class="pre">TLS_1_0_CIPHER_SUITES</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'tls_1_0_cipher_suites'</span></em><a class="headerlink" href="#sslyze.ScanCommand.TLS_1_0_CIPHER_SUITES" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="sslyze.ScanCommand.TLS_1_1_CIPHER_SUITES">
<span class="sig-name descname"><span class="pre">TLS_1_1_CIPHER_SUITES</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'tls_1_1_cipher_suites'</span></em><a class="headerlink" href="#sslyze.ScanCommand.TLS_1_1_CIPHER_SUITES" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="sslyze.ScanCommand.TLS_1_2_CIPHER_SUITES">
<span class="sig-name descname"><span class="pre">TLS_1_2_CIPHER_SUITES</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'tls_1_2_cipher_suites'</span></em><a class="headerlink" href="#sslyze.ScanCommand.TLS_1_2_CIPHER_SUITES" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="sslyze.ScanCommand.TLS_1_3_CIPHER_SUITES">
<span class="sig-name descname"><span class="pre">TLS_1_3_CIPHER_SUITES</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'tls_1_3_cipher_suites'</span></em><a class="headerlink" href="#sslyze.ScanCommand.TLS_1_3_CIPHER_SUITES" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="sslyze.ScanCommand.TLS_COMPRESSION">
<span class="sig-name descname"><span class="pre">TLS_COMPRESSION</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'tls_compression'</span></em><a class="headerlink" href="#sslyze.ScanCommand.TLS_COMPRESSION" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="sslyze.ScanCommand.TLS_1_3_EARLY_DATA">
<span class="sig-name descname"><span class="pre">TLS_1_3_EARLY_DATA</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'tls_1_3_early_data'</span></em><a class="headerlink" href="#sslyze.ScanCommand.TLS_1_3_EARLY_DATA" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="sslyze.ScanCommand.OPENSSL_CCS_INJECTION">
<span class="sig-name descname"><span class="pre">OPENSSL_CCS_INJECTION</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'openssl_ccs_injection'</span></em><a class="headerlink" href="#sslyze.ScanCommand.OPENSSL_CCS_INJECTION" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="sslyze.ScanCommand.TLS_FALLBACK_SCSV">
<span class="sig-name descname"><span class="pre">TLS_FALLBACK_SCSV</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'tls_fallback_scsv'</span></em><a class="headerlink" href="#sslyze.ScanCommand.TLS_FALLBACK_SCSV" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="sslyze.ScanCommand.HEARTBLEED">
<span class="sig-name descname"><span class="pre">HEARTBLEED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'heartbleed'</span></em><a class="headerlink" href="#sslyze.ScanCommand.HEARTBLEED" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="sslyze.ScanCommand.ROBOT">
<span class="sig-name descname"><span class="pre">ROBOT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'robot'</span></em><a class="headerlink" href="#sslyze.ScanCommand.ROBOT" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="sslyze.ScanCommand.SESSION_RENEGOTIATION">
<span class="sig-name descname"><span class="pre">SESSION_RENEGOTIATION</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'session_renegotiation'</span></em><a class="headerlink" href="#sslyze.ScanCommand.SESSION_RENEGOTIATION" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="sslyze.ScanCommand.HTTP_HEADERS">
<span class="sig-name descname"><span class="pre">HTTP_HEADERS</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'http_headers'</span></em><a class="headerlink" href="#sslyze.ScanCommand.HTTP_HEADERS" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="sslyze.ScanCommand.ELLIPTIC_CURVES">
<span class="sig-name descname"><span class="pre">ELLIPTIC_CURVES</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'elliptic_curves'</span></em><a class="headerlink" href="#sslyze.ScanCommand.ELLIPTIC_CURVES" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<p>The next sections describe the result class that corresponds to each scan command.</p>
<section id="certificate-information">
<h2><a class="toc-backref" href="#id20">Certificate Information</a><a class="headerlink" href="#certificate-information" title="Permalink to this headline">¶</a></h2>
<p><strong>ScanCommand.CERTIFICATE_INFO</strong>: Retrieve and analyze a server’s certificate(s) to verify its validity.</p>
<section id="optional-arguments">
<h3>Optional arguments<a class="headerlink" href="#optional-arguments" title="Permalink to this headline">¶</a></h3>
<dl class="py class">
<dt class="sig sig-object py" id="sslyze.CertificateInfoExtraArgument">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">sslyze.</span></span><span class="sig-name descname"><span class="pre">CertificateInfoExtraArgument</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">custom_ca_file</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#sslyze.CertificateInfoExtraArgument" title="Permalink to this definition">¶</a></dt>
<dd><p>Additional configuration for running the certificate_info scan command.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="sslyze.CertificateInfoExtraArgument.custom_ca_file">
<span class="sig-name descname"><span class="pre">custom_ca_file</span></span><a class="headerlink" href="#sslyze.CertificateInfoExtraArgument.custom_ca_file" title="Permalink to this definition">¶</a></dt>
<dd><p>The path to a custom trust store file to use for certificate validation. The file should contain
PEM-formatted root certificates.</p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p>pathlib.Path</p>
</dd>
</dl>
</dd></dl>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>custom_ca_file</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">Path</span></code>) – </p>
</dd>
</dl>
</dd></dl>
</section>
<section id="result-class">
<h3>Result class<a class="headerlink" href="#result-class" title="Permalink to this headline">¶</a></h3>
<dl class="py class">
<dt class="sig sig-object py" id="sslyze.CertificateInfoScanResult">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">sslyze.</span></span><span class="sig-name descname"><span class="pre">CertificateInfoScanResult</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">hostname_used_for_server_name_indication</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">certificate_deployments</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#sslyze.CertificateInfoScanResult" title="Permalink to this definition">¶</a></dt>
<dd><p>The result of retrieving and analyzing a server’s certificates to verify their validity.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="sslyze.CertificateInfoScanResult.hostname_used_for_server_name_indication">
<span class="sig-name descname"><span class="pre">hostname_used_for_server_name_indication</span></span><a class="headerlink" href="#sslyze.CertificateInfoScanResult.hostname_used_for_server_name_indication" title="Permalink to this definition">¶</a></dt>
<dd><p>The hostname sent by SSLyze as the Server Name Indication extension.</p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p>str</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="sslyze.CertificateInfoScanResult.certificate_deployments">
<span class="sig-name descname"><span class="pre">certificate_deployments</span></span><a class="headerlink" href="#sslyze.CertificateInfoScanResult.certificate_deployments" title="Permalink to this definition">¶</a></dt>
<dd><p>A list of leaf certificates detected by SSLyze and the corresponding analysis. Most
servers only deploy one leaf certificate, but some websites (such as Facebook) return different leaf
certificates depending on the client, as a way to maximize compatibility with older clients/devices.</p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p>List[<a class="reference internal" href="#sslyze.CertificateDeploymentAnalysisResult" title="sslyze.plugins.certificate_info._cert_chain_analyzer.CertificateDeploymentAnalysisResult">sslyze.plugins.certificate_info._cert_chain_analyzer.CertificateDeploymentAnalysisResult</a>]</p>
</dd>
</dl>
</dd></dl>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>hostname_used_for_server_name_indication</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
<li><p><strong>certificate_deployments</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<a class="reference internal" href="#sslyze.CertificateDeploymentAnalysisResult" title="sslyze.plugins.certificate_info._cert_chain_analyzer.CertificateDeploymentAnalysisResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">CertificateDeploymentAnalysisResult</span></code></a>]) – </p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="sslyze.CertificateDeploymentAnalysisResult">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">sslyze.</span></span><span class="sig-name descname"><span class="pre">CertificateDeploymentAnalysisResult</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">received_certificate_chain</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">leaf_certificate_subject_matches_hostname</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">leaf_certificate_has_must_staple_extension</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">leaf_certificate_is_ev</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">leaf_certificate_signed_certificate_timestamps_count</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">received_chain_contains_anchor_certificate</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">received_chain_has_valid_order</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">path_validation_results</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">verified_chain_has_sha1_signature</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">verified_chain_has_legacy_symantec_anchor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ocsp_response</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ocsp_response_is_trusted</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#sslyze.CertificateDeploymentAnalysisResult" title="Permalink to this definition">¶</a></dt>
<dd><p>The result of analyzing a server’s certificate to verify its validity.</p>
<p>Any certificate available within the fields that follow is parsed as a <code class="docutils literal notranslate"><span class="pre">Certificate</span></code> object using the cryptography
module; documentation is available at
<a class="reference external" href="https://cryptography.io/en/latest/x509/reference.html?highlight=Certificate#cryptography.x509.Certificate">https://cryptography.io/en/latest/x509/reference.html?highlight=Certificate#cryptography.x509.Certificate</a></p>
<dl class="py attribute">
<dt class="sig sig-object py" id="sslyze.CertificateDeploymentAnalysisResult.received_certificate_chain">
<span class="sig-name descname"><span class="pre">received_certificate_chain</span></span><a class="headerlink" href="#sslyze.CertificateDeploymentAnalysisResult.received_certificate_chain" title="Permalink to this definition">¶</a></dt>
<dd><p>The certificate chain sent by the server; index 0 is the leaf certificate.</p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p>List[cryptography.x509.base.Certificate]</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="sslyze.CertificateDeploymentAnalysisResult.verified_certificate_chain">
<span class="sig-name descname"><span class="pre">verified_certificate_chain</span></span><a class="headerlink" href="#sslyze.CertificateDeploymentAnalysisResult.verified_certificate_chain" title="Permalink to this definition">¶</a></dt>
<dd><p>The verified certificate chain returned by OpenSSL for one of the trust stores
packaged within SSLyze. Will be <code class="docutils literal notranslate"><span class="pre">None</span></code> if the validation failed with all of the available trust stores
(Apple, Mozilla, etc.). This is essentially a shortcut to
<code class="docutils literal notranslate"><span class="pre">path_validation_result_list[0].verified_certificate_chain</span></code>.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="sslyze.CertificateDeploymentAnalysisResult.path_validation_results">
<span class="sig-name descname"><span class="pre">path_validation_results</span></span><a class="headerlink" href="#sslyze.CertificateDeploymentAnalysisResult.path_validation_results" title="Permalink to this definition">¶</a></dt>
<dd><p>The result of validating the server’s
certificate chain using each trust store that is packaged with SSLyze (Mozilla, Apple, etc.).
If for a given trust store, the validation was successful, the verified certificate chain built by OpenSSL
can be retrieved from the <code class="docutils literal notranslate"><span class="pre">PathValidationResult</span></code>.</p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p>List[<a class="reference internal" href="#sslyze.PathValidationResult" title="sslyze.plugins.certificate_info._cert_chain_analyzer.PathValidationResult">sslyze.plugins.certificate_info._cert_chain_analyzer.PathValidationResult</a>]</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="sslyze.CertificateDeploymentAnalysisResult.leaf_certificate_subject_matches_hostname">
<span class="sig-name descname"><span class="pre">leaf_certificate_subject_matches_hostname</span></span><a class="headerlink" href="#sslyze.CertificateDeploymentAnalysisResult.leaf_certificate_subject_matches_hostname" title="Permalink to this definition">¶</a></dt>
<dd><p><code class="docutils literal notranslate"><span class="pre">True</span></code> if the leaf certificate’s Common Name or Subject Alternative
Names match the server’s hostname.</p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p>bool</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="sslyze.CertificateDeploymentAnalysisResult.leaf_certificate_is_ev">
<span class="sig-name descname"><span class="pre">leaf_certificate_is_ev</span></span><a class="headerlink" href="#sslyze.CertificateDeploymentAnalysisResult.leaf_certificate_is_ev" title="Permalink to this definition">¶</a></dt>
<dd><p><code class="docutils literal notranslate"><span class="pre">True</span></code> if the leaf certificate is Extended Validation, according to Mozilla.</p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p>bool</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="sslyze.CertificateDeploymentAnalysisResult.leaf_certificate_has_must_staple_extension">
<span class="sig-name descname"><span class="pre">leaf_certificate_has_must_staple_extension</span></span><a class="headerlink" href="#sslyze.CertificateDeploymentAnalysisResult.leaf_certificate_has_must_staple_extension" title="Permalink to this definition">¶</a></dt>
<dd><p><code class="docutils literal notranslate"><span class="pre">True</span></code> if the OCSP must-staple extension is present in the leaf
certificate.</p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p>bool</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="sslyze.CertificateDeploymentAnalysisResult.leaf_certificate_signed_certificate_timestamps_count">
<span class="sig-name descname"><span class="pre">leaf_certificate_signed_certificate_timestamps_count</span></span><a class="headerlink" href="#sslyze.CertificateDeploymentAnalysisResult.leaf_certificate_signed_certificate_timestamps_count" title="Permalink to this definition">¶</a></dt>
<dd><p>The number of Signed Certificate
Timestamps (SCTs) for Certificate Transparency embedded in the leaf certificate. <code class="docutils literal notranslate"><span class="pre">None</span></code> if the version of
OpenSSL installed on the system is too old to be able to parse the SCT extension.</p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p>Optional[int]</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="sslyze.CertificateDeploymentAnalysisResult.received_chain_has_valid_order">
<span class="sig-name descname"><span class="pre">received_chain_has_valid_order</span></span><a class="headerlink" href="#sslyze.CertificateDeploymentAnalysisResult.received_chain_has_valid_order" title="Permalink to this definition">¶</a></dt>
<dd><p><code class="docutils literal notranslate"><span class="pre">True</span></code> if the certificate chain returned by the server was sent in the right
order. <cite>None`</cite> if any of the certificates in the chain could not be parsed.</p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p>Optional[bool]</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="sslyze.CertificateDeploymentAnalysisResult.received_chain_contains_anchor_certificate">
<span class="sig-name descname"><span class="pre">received_chain_contains_anchor_certificate</span></span><a class="headerlink" href="#sslyze.CertificateDeploymentAnalysisResult.received_chain_contains_anchor_certificate" title="Permalink to this definition">¶</a></dt>
<dd><p><code class="docutils literal notranslate"><span class="pre">True</span></code> if the server included the anchor/root
certificate in the chain it sends back to clients. <code class="docutils literal notranslate"><span class="pre">None</span></code> if the verified chain could not be built.</p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p>Optional[bool]</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="sslyze.CertificateDeploymentAnalysisResult.verified_chain_has_sha1_signature">
<span class="sig-name descname"><span class="pre">verified_chain_has_sha1_signature</span></span><a class="headerlink" href="#sslyze.CertificateDeploymentAnalysisResult.verified_chain_has_sha1_signature" title="Permalink to this definition">¶</a></dt>
<dd><p><code class="docutils literal notranslate"><span class="pre">True</span></code> if any of the leaf or intermediate certificates are
signed using the SHA-1 algorithm. <code class="docutils literal notranslate"><span class="pre">None</span></code> if the verified chain could not be built.</p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p>Optional[bool]</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="sslyze.CertificateDeploymentAnalysisResult.verified_chain_has_legacy_symantec_anchor">
<span class="sig-name descname"><span class="pre">verified_chain_has_legacy_symantec_anchor</span></span><a class="headerlink" href="#sslyze.CertificateDeploymentAnalysisResult.verified_chain_has_legacy_symantec_anchor" title="Permalink to this definition">¶</a></dt>
<dd><p><code class="docutils literal notranslate"><span class="pre">True</span></code> if the certificate chain contains a distrusted Symantec
anchor
(<a class="reference external" href="https://blog.qualys.com/ssllabs/2017/09/26/google-and-mozilla-deprecating-existing-symantec-certificates">https://blog.qualys.com/ssllabs/2017/09/26/google-and-mozilla-deprecating-existing-symantec-certificates</a>).
<code class="docutils literal notranslate"><span class="pre">None</span></code> if the verified chain could not be built.</p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p>Optional[bool]</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="sslyze.CertificateDeploymentAnalysisResult.ocsp_response">
<span class="sig-name descname"><span class="pre">ocsp_response</span></span><a class="headerlink" href="#sslyze.CertificateDeploymentAnalysisResult.ocsp_response" title="Permalink to this definition">¶</a></dt>
<dd><p>The OCSP response returned by the server. <code class="docutils literal notranslate"><span class="pre">None</span></code> if no response was sent by the server or if
the scan was run through an HTTP proxy (the proxy will not forward the server’s OCSP response). If present,
the OCSP response is an <code class="docutils literal notranslate"><span class="pre">OCSPResponse</span></code> object parsed using the cryptography module; documentation is
available at
<a class="reference external" href="https://cryptography.io/en/latest/x509/ocsp.html?highlight=OCSPResponse#cryptography.x509.ocsp.OCSPResponse">https://cryptography.io/en/latest/x509/ocsp.html?highlight=OCSPResponse#cryptography.x509.ocsp.OCSPResponse</a></p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p>Optional[cryptography.x509.ocsp.OCSPResponse]</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="sslyze.CertificateDeploymentAnalysisResult.ocsp_response_is_trusted">
<span class="sig-name descname"><span class="pre">ocsp_response_is_trusted</span></span><a class="headerlink" href="#sslyze.CertificateDeploymentAnalysisResult.ocsp_response_is_trusted" title="Permalink to this definition">¶</a></dt>
<dd><p><code class="docutils literal notranslate"><span class="pre">True</span></code> if the OCSP response is trusted using the Mozilla trust store.
<code class="docutils literal notranslate"><span class="pre">None</span></code> if no OCSP response was sent by the server.</p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p>Optional[bool]</p>
</dd>
</dl>
</dd></dl>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>received_certificate_chain</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">Certificate</span></code>]) – </p></li>
<li><p><strong>leaf_certificate_subject_matches_hostname</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – </p></li>
<li><p><strong>leaf_certificate_has_must_staple_extension</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – </p></li>
<li><p><strong>leaf_certificate_is_ev</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – </p></li>
<li><p><strong>leaf_certificate_signed_certificate_timestamps_count</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>]) – </p></li>
<li><p><strong>received_chain_contains_anchor_certificate</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>]) – </p></li>
<li><p><strong>received_chain_has_valid_order</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>]) – </p></li>
<li><p><strong>path_validation_results</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<a class="reference internal" href="#sslyze.PathValidationResult" title="sslyze.plugins.certificate_info._cert_chain_analyzer.PathValidationResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">PathValidationResult</span></code></a>]) – </p></li>
<li><p><strong>verified_chain_has_sha1_signature</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>]) – </p></li>
<li><p><strong>verified_chain_has_legacy_symantec_anchor</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>]) – </p></li>
<li><p><strong>ocsp_response</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">OCSPResponse</span></code>]) – </p></li>
<li><p><strong>ocsp_response_is_trusted</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>]) – </p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="sslyze.PathValidationResult">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">sslyze.</span></span><span class="sig-name descname"><span class="pre">PathValidationResult</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">trust_store</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">verified_certificate_chain</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">openssl_error_string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#sslyze.PathValidationResult" title="Permalink to this definition">¶</a></dt>
<dd><p>The result of trying to validate a server’s certificate chain using a specific trust store.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="sslyze.PathValidationResult.trust_stores">
<span class="sig-name descname"><span class="pre">trust_stores</span></span><a class="headerlink" href="#sslyze.PathValidationResult.trust_stores" title="Permalink to this definition">¶</a></dt>
<dd><p>The trust store used for validation.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="sslyze.PathValidationResult.verified_certificate_chain">
<span class="sig-name descname"><span class="pre">verified_certificate_chain</span></span><a class="headerlink" href="#sslyze.PathValidationResult.verified_certificate_chain" title="Permalink to this definition">¶</a></dt>
<dd><p>The verified certificate chain returned by OpenSSL.
Index 0 is the leaf certificate and the last element is the anchor/CA certificate from the trust store.
Will be None if the validation failed or the verified chain could not be built.
Each certificate is parsed using the cryptography module; documentation is available at
<a class="reference external" href="https://cryptography.io/en/latest/x509/reference/#x-509-certificate-object">https://cryptography.io/en/latest/x509/reference/#x-509-certificate-object</a>.</p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p>Optional[List[cryptography.x509.base.Certificate]]</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="sslyze.PathValidationResult.openssl_error_string">
<span class="sig-name descname"><span class="pre">openssl_error_string</span></span><a class="headerlink" href="#sslyze.PathValidationResult.openssl_error_string" title="Permalink to this definition">¶</a></dt>
<dd><p>The result string returned by OpenSSL’s validation function; None if validation was
successful.</p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p>Optional[str]</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="sslyze.PathValidationResult.was_validation_successful">
<span class="sig-name descname"><span class="pre">was_validation_successful</span></span><a class="headerlink" href="#sslyze.PathValidationResult.was_validation_successful" title="Permalink to this definition">¶</a></dt>
<dd><p>Whether the certificate chain is trusted when using supplied the trust_stores.</p>
</dd></dl>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>trust_store</strong> (<a class="reference internal" href="#sslyze.TrustStore" title="sslyze.plugins.certificate_info.trust_stores.trust_store.TrustStore"><code class="xref py py-class docutils literal notranslate"><span class="pre">TrustStore</span></code></a>) – </p></li>
<li><p><strong>verified_certificate_chain</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">Certificate</span></code>]]) – </p></li>
<li><p><strong>openssl_error_string</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]) – </p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="sslyze.TrustStore">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">sslyze.</span></span><span class="sig-name descname"><span class="pre">TrustStore</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">path</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">version</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ev_oids</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#sslyze.TrustStore" title="Permalink to this definition">¶</a></dt>
<dd><p>A set of root certificates to be used for certificate validation.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="sslyze.TrustStore.path">
<span class="sig-name descname"><span class="pre">path</span></span><a class="headerlink" href="#sslyze.TrustStore.path" title="Permalink to this definition">¶</a></dt>
<dd><p>The path on the local system to the PEM-formatted file containing the root certificates.</p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p>pathlib.Path</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="sslyze.TrustStore.name">
<span class="sig-name descname"><span class="pre">name</span></span><a class="headerlink" href="#sslyze.TrustStore.name" title="Permalink to this definition">¶</a></dt>
<dd><p>The human-readable name of the trust store (such as “Mozilla”).</p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p>str</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="sslyze.TrustStore.version">
<span class="sig-name descname"><span class="pre">version</span></span><a class="headerlink" href="#sslyze.TrustStore.version" title="Permalink to this definition">¶</a></dt>
<dd><p>The human-readable version or date of the trust store (such as “09/2016”).</p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p>str</p>
</dd>
</dl>
</dd></dl>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>path</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">Path</span></code>) – </p></li>
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
<li><p><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
<li><p><strong>ev_oids</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">ObjectIdentifier</span></code>]]) – </p></li>
</ul>
</dd>
</dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="id0">
<span class="sig-name descname"><span class="pre">path</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">pathlib.Path</span></em><a class="headerlink" href="#id0" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="id1">
<span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#id1" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="id2">
<span class="sig-name descname"><span class="pre">version</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#id2" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="sslyze.TrustStore.ev_oids">
<span class="sig-name descname"><span class="pre">ev_oids</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">cryptography.hazmat._oid.ObjectIdentifier</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#sslyze.TrustStore.ev_oids" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="sslyze.TrustStore.is_certificate_extended_validation">
<span class="sig-name descname"><span class="pre">is_certificate_extended_validation</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">certificate</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#sslyze.TrustStore.is_certificate_extended_validation" title="Permalink to this definition">¶</a></dt>
<dd><p>Is the supplied server certificate EV?</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>certificate</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">Certificate</span></code>) – </p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></p>
</dd>
</dl>
</dd></dl>
</dd></dl>
</section>
</section>
<section id="cipher-suites">
<h2><a class="toc-backref" href="#id21">Cipher Suites</a><a class="headerlink" href="#cipher-suites" title="Permalink to this headline">¶</a></h2>
<p><strong>ScanCommand.SSL_2_0_CIPHER_SUITES</strong>: Test a server for SSL 2.0 support.
<strong>ScanCommand.SSL_3_0_CIPHER_SUITES</strong>: Test a server for SSL 3.0 support.
<strong>ScanCommand.TLS_1_0_CIPHER_SUITES</strong>: Test a server for TLS 1.0 support.
<strong>ScanCommand.TLS_1_1_CIPHER_SUITES</strong>: Test a server for TLS 1.1 support.
<strong>ScanCommand.TLS_1_2_CIPHER_SUITES</strong>: Test a server for TLS 1.2 support.
<strong>ScanCommand.TLS_1_3_CIPHER_SUITES</strong>: Test a server for TLS 1.3 support.</p>
<section id="id3">
<h3>Result class<a class="headerlink" href="#id3" title="Permalink to this headline">¶</a></h3>
<dl class="py class">
<dt class="sig sig-object py" id="sslyze.CipherSuitesScanResult">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">sslyze.</span></span><span class="sig-name descname"><span class="pre">CipherSuitesScanResult</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">tls_version_used</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">accepted_cipher_suites</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">rejected_cipher_suites</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#sslyze.CipherSuitesScanResult" title="Permalink to this definition">¶</a></dt>
<dd><p>The result of testing a server for cipher suites with a specific version of SSL/TLS.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="sslyze.CipherSuitesScanResult.tls_version_used">
<span class="sig-name descname"><span class="pre">tls_version_used</span></span><a class="headerlink" href="#sslyze.CipherSuitesScanResult.tls_version_used" title="Permalink to this definition">¶</a></dt>
<dd><p>The SSL/TLS version used to connect to the server.</p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#sslyze.TlsVersionEnum" title="sslyze.server_connectivity.TlsVersionEnum">sslyze.server_connectivity.TlsVersionEnum</a></p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="sslyze.CipherSuitesScanResult.accepted_ciphers">
<span class="sig-name descname"><span class="pre">accepted_ciphers</span></span><a class="headerlink" href="#sslyze.CipherSuitesScanResult.accepted_ciphers" title="Permalink to this definition">¶</a></dt>
<dd><p>The list of cipher suites supported supported by both SSLyze and the server.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="sslyze.CipherSuitesScanResult.rejected_ciphers">
<span class="sig-name descname"><span class="pre">rejected_ciphers</span></span><a class="headerlink" href="#sslyze.CipherSuitesScanResult.rejected_ciphers" title="Permalink to this definition">¶</a></dt>
<dd><p>The list of cipher suites supported by SSLyze that were rejected by the server.</p>
</dd></dl>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>tls_version_used</strong> (<a class="reference internal" href="#sslyze.TlsVersionEnum" title="sslyze.server_connectivity.TlsVersionEnum"><code class="xref py py-class docutils literal notranslate"><span class="pre">TlsVersionEnum</span></code></a>) – </p></li>
<li><p><strong>accepted_cipher_suites</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<a class="reference internal" href="#sslyze.CipherSuiteAcceptedByServer" title="sslyze.plugins.openssl_cipher_suites._test_cipher_suite.CipherSuiteAcceptedByServer"><code class="xref py py-class docutils literal notranslate"><span class="pre">CipherSuiteAcceptedByServer</span></code></a>]) – </p></li>
<li><p><strong>rejected_cipher_suites</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<a class="reference internal" href="#sslyze.CipherSuiteRejectedByServer" title="sslyze.plugins.openssl_cipher_suites._test_cipher_suite.CipherSuiteRejectedByServer"><code class="xref py py-class docutils literal notranslate"><span class="pre">CipherSuiteRejectedByServer</span></code></a>]) – </p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="sslyze.CipherSuiteRejectedByServer">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">sslyze.</span></span><span class="sig-name descname"><span class="pre">CipherSuiteRejectedByServer</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cipher_suite</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">error_message</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#sslyze.CipherSuiteRejectedByServer" title="Permalink to this definition">¶</a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cipher_suite</strong> (<a class="reference internal" href="#sslyze.CipherSuite" title="sslyze.plugins.openssl_cipher_suites.cipher_suites.CipherSuite"><code class="xref py py-class docutils literal notranslate"><span class="pre">CipherSuite</span></code></a>) – </p></li>
<li><p><strong>error_message</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="sslyze.CipherSuiteAcceptedByServer">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">sslyze.</span></span><span class="sig-name descname"><span class="pre">CipherSuiteAcceptedByServer</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cipher_suite</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ephemeral_key</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#sslyze.CipherSuiteAcceptedByServer" title="Permalink to this definition">¶</a></dt>
<dd><dl class="simple">
<dt>ephemeral_key: The ephemeral key negotiated with the server when using (EC) DH cipher suites. None if the cipher</dt><dd><p>suite does not use ephemeral keys or if the ephemeral key could not be retrieved.</p>
</dd>
</dl>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cipher_suite</strong> (<a class="reference internal" href="#sslyze.CipherSuite" title="sslyze.plugins.openssl_cipher_suites.cipher_suites.CipherSuite"><code class="xref py py-class docutils literal notranslate"><span class="pre">CipherSuite</span></code></a>) – </p></li>
<li><p><strong>ephemeral_key</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="#sslyze.EphemeralKeyInfo" title="nassl.ephemeral_key_info.EphemeralKeyInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">EphemeralKeyInfo</span></code></a>]) – </p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="sslyze.EphemeralKeyInfo">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">sslyze.</span></span><span class="sig-name descname"><span class="pre">EphemeralKeyInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">size</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">public_bytes</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#sslyze.EphemeralKeyInfo" title="Permalink to this definition">¶</a></dt>
<dd><p>Common fields shared by all kinds of TLS key exchanges.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">OpenSslEvpPkeyEnum</span></code>) – </p></li>
<li><p><strong>size</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>) – </p></li>
<li><p><strong>public_bytes</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bytearray</span></code>) – </p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="sslyze.CipherSuite">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">sslyze.</span></span><span class="sig-name descname"><span class="pre">CipherSuite</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">is_anonymous</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">key_size</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">openssl_name</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#sslyze.CipherSuite" title="Permalink to this definition">¶</a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
<li><p><strong>is_anonymous</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – </p></li>
<li><p><strong>key_size</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>) – </p></li>
<li><p><strong>openssl_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="sslyze.TlsVersionEnum">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">sslyze.</span></span><span class="sig-name descname"><span class="pre">TlsVersionEnum</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#sslyze.TlsVersionEnum" title="Permalink to this definition">¶</a></dt>
<dd><p>An enumeration.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="sslyze.TlsVersionEnum.SSL_2_0">
<span class="sig-name descname"><span class="pre">SSL_2_0</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">1</span></em><a class="headerlink" href="#sslyze.TlsVersionEnum.SSL_2_0" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="sslyze.TlsVersionEnum.SSL_3_0">
<span class="sig-name descname"><span class="pre">SSL_3_0</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">2</span></em><a class="headerlink" href="#sslyze.TlsVersionEnum.SSL_3_0" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="sslyze.TlsVersionEnum.TLS_1_0">
<span class="sig-name descname"><span class="pre">TLS_1_0</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">3</span></em><a class="headerlink" href="#sslyze.TlsVersionEnum.TLS_1_0" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="sslyze.TlsVersionEnum.TLS_1_1">
<span class="sig-name descname"><span class="pre">TLS_1_1</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">4</span></em><a class="headerlink" href="#sslyze.TlsVersionEnum.TLS_1_1" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="sslyze.TlsVersionEnum.TLS_1_2">
<span class="sig-name descname"><span class="pre">TLS_1_2</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">5</span></em><a class="headerlink" href="#sslyze.TlsVersionEnum.TLS_1_2" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="sslyze.TlsVersionEnum.TLS_1_3">
<span class="sig-name descname"><span class="pre">TLS_1_3</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">6</span></em><a class="headerlink" href="#sslyze.TlsVersionEnum.TLS_1_3" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
</section>
</section>
<section id="supported-elliptic-curves">
<h2><a class="toc-backref" href="#id22">Supported Elliptic Curves</a><a class="headerlink" href="#supported-elliptic-curves" title="Permalink to this headline">¶</a></h2>
<p><strong>ScanCommand.ELLIPTIC_CURVES</strong>: Test a server for supported elliptic curves.</p>
<section id="id4">
<h3>Result class<a class="headerlink" href="#id4" title="Permalink to this headline">¶</a></h3>
<dl class="py class">
<dt class="sig sig-object py" id="sslyze.SupportedEllipticCurvesScanResult">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">sslyze.</span></span><span class="sig-name descname"><span class="pre">SupportedEllipticCurvesScanResult</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">supports_ecdh_key_exchange</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">supported_curves</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">rejected_curves</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#sslyze.SupportedEllipticCurvesScanResult" title="Permalink to this definition">¶</a></dt>
<dd><p>The result of testing a server for supported elliptic curves.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="sslyze.SupportedEllipticCurvesScanResult.supports_ecdh_key_exchange">
<span class="sig-name descname"><span class="pre">supports_ecdh_key_exchange</span></span><a class="headerlink" href="#sslyze.SupportedEllipticCurvesScanResult.supports_ecdh_key_exchange" title="Permalink to this definition">¶</a></dt>
<dd><p>True if the server supports at least one cipher suite with an ECDH key exchange.</p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p>bool</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="sslyze.SupportedEllipticCurvesScanResult.supported_curves">
<span class="sig-name descname"><span class="pre">supported_curves</span></span><a class="headerlink" href="#sslyze.SupportedEllipticCurvesScanResult.supported_curves" title="Permalink to this definition">¶</a></dt>
<dd><p>A list of <cite>EllipticCurve</cite> that were accepted by the server or <cite>None</cite> if the server does not
support ECDH cipher suites.</p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p>Optional[List[<a class="reference internal" href="#sslyze.EllipticCurve" title="sslyze.plugins.elliptic_curves_plugin.EllipticCurve">sslyze.plugins.elliptic_curves_plugin.EllipticCurve</a>]]</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="sslyze.SupportedEllipticCurvesScanResult.rejected_curves">
<span class="sig-name descname"><span class="pre">rejected_curves</span></span><a class="headerlink" href="#sslyze.SupportedEllipticCurvesScanResult.rejected_curves" title="Permalink to this definition">¶</a></dt>
<dd><p>A list of <cite>EllipticCurve</cite> that were rejected by the server or <cite>None</cite> if the server does not
support ECDH cipher suites.</p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p>Optional[List[<a class="reference internal" href="#sslyze.EllipticCurve" title="sslyze.plugins.elliptic_curves_plugin.EllipticCurve">sslyze.plugins.elliptic_curves_plugin.EllipticCurve</a>]]</p>
</dd>
</dl>
</dd></dl>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>supports_ecdh_key_exchange</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – </p></li>
<li><p><strong>supported_curves</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<a class="reference internal" href="#sslyze.EllipticCurve" title="sslyze.plugins.elliptic_curves_plugin.EllipticCurve"><code class="xref py py-class docutils literal notranslate"><span class="pre">EllipticCurve</span></code></a>]]) – </p></li>
<li><p><strong>rejected_curves</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<a class="reference internal" href="#sslyze.EllipticCurve" title="sslyze.plugins.elliptic_curves_plugin.EllipticCurve"><code class="xref py py-class docutils literal notranslate"><span class="pre">EllipticCurve</span></code></a>]]) – </p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="sslyze.EllipticCurve">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">sslyze.</span></span><span class="sig-name descname"><span class="pre">EllipticCurve</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">openssl_nid</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#sslyze.EllipticCurve" title="Permalink to this definition">¶</a></dt>
<dd><p>A specific elliptic curve.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="sslyze.EllipticCurve.name">
<span class="sig-name descname"><span class="pre">name</span></span><a class="headerlink" href="#sslyze.EllipticCurve.name" title="Permalink to this definition">¶</a></dt>
<dd><p>The ANSI X9.62 name if available, otherwise the SECG name.</p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p>str</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="sslyze.EllipticCurve.openssl_nid">
<span class="sig-name descname"><span class="pre">openssl_nid</span></span><a class="headerlink" href="#sslyze.EllipticCurve.openssl_nid" title="Permalink to this definition">¶</a></dt>
<dd><p>The OpenSSL NID_XXX value valid for OpenSslEvpPkeyEnum.EC (obj_mac.h).</p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p>int</p>
</dd>
</dl>
</dd></dl>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
<li><p><strong>openssl_nid</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>) – </p></li>
</ul>
</dd>
</dl>
</dd></dl>
</section>
</section>
<section id="robot">
<h2><a class="toc-backref" href="#id23">ROBOT</a><a class="headerlink" href="#robot" title="Permalink to this headline">¶</a></h2>
<p><strong>ScanCommand.ROBOT</strong>: Test a server for the ROBOT vulnerability.</p>
<section id="id5">
<h3>Result class<a class="headerlink" href="#id5" title="Permalink to this headline">¶</a></h3>
<dl class="py class">
<dt class="sig sig-object py" id="sslyze.RobotScanResult">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">sslyze.</span></span><span class="sig-name descname"><span class="pre">RobotScanResult</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">robot_result</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#sslyze.RobotScanResult" title="Permalink to this definition">¶</a></dt>
<dd><p>The result of testing a server for the ROBOT vulnerability.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="sslyze.RobotScanResult.result">
<span class="sig-name descname"><span class="pre">result</span></span><a class="headerlink" href="#sslyze.RobotScanResult.result" title="Permalink to this definition">¶</a></dt>
<dd><p>An Enum providing the result of the ROBOT scan.</p>
</dd></dl>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>robot_result</strong> (<a class="reference internal" href="#sslyze.RobotScanResultEnum" title="sslyze.plugins.robot._robot_tester.RobotScanResultEnum"><code class="xref py py-class docutils literal notranslate"><span class="pre">RobotScanResultEnum</span></code></a>) – </p>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="sslyze.RobotScanResultEnum">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">sslyze.</span></span><span class="sig-name descname"><span class="pre">RobotScanResultEnum</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#sslyze.RobotScanResultEnum" title="Permalink to this definition">¶</a></dt>
<dd><p>The result of attempting exploit the ROBOT issue on the server.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="sslyze.RobotScanResultEnum.VULNERABLE_WEAK_ORACLE">
<span class="sig-name descname"><span class="pre">VULNERABLE_WEAK_ORACLE</span></span><a class="headerlink" href="#sslyze.RobotScanResultEnum.VULNERABLE_WEAK_ORACLE" title="Permalink to this definition">¶</a></dt>
<dd><p>The server is vulnerable but the attack would take too long.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="sslyze.RobotScanResultEnum.VULNERABLE_STRONG_ORACLE">
<span class="sig-name descname"><span class="pre">VULNERABLE_STRONG_ORACLE</span></span><a class="headerlink" href="#sslyze.RobotScanResultEnum.VULNERABLE_STRONG_ORACLE" title="Permalink to this definition">¶</a></dt>
<dd><p>The server is vulnerable and real attacks are feasible.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="sslyze.RobotScanResultEnum.NOT_VULNERABLE_NO_ORACLE">
<span class="sig-name descname"><span class="pre">NOT_VULNERABLE_NO_ORACLE</span></span><a class="headerlink" href="#sslyze.RobotScanResultEnum.NOT_VULNERABLE_NO_ORACLE" title="Permalink to this definition">¶</a></dt>
<dd><p>The server supports RSA cipher suites but does not act as an oracle.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="sslyze.RobotScanResultEnum.NOT_VULNERABLE_RSA_NOT_SUPPORTED">
<span class="sig-name descname"><span class="pre">NOT_VULNERABLE_RSA_NOT_SUPPORTED</span></span><a class="headerlink" href="#sslyze.RobotScanResultEnum.NOT_VULNERABLE_RSA_NOT_SUPPORTED" title="Permalink to this definition">¶</a></dt>
<dd><p>The server does not supports RSA cipher suites.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="sslyze.RobotScanResultEnum.UNKNOWN_INCONSISTENT_RESULTS">
<span class="sig-name descname"><span class="pre">UNKNOWN_INCONSISTENT_RESULTS</span></span><a class="headerlink" href="#sslyze.RobotScanResultEnum.UNKNOWN_INCONSISTENT_RESULTS" title="Permalink to this definition">¶</a></dt>
<dd><p>Could not determine whether the server is vulnerable or not.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="id6">
<span class="sig-name descname"><span class="pre">VULNERABLE_WEAK_ORACLE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'VULNERABLE_WEAK_ORACLE'</span></em><a class="headerlink" href="#id6" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="id7">
<span class="sig-name descname"><span class="pre">VULNERABLE_STRONG_ORACLE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'VULNERABLE_STRONG_ORACLE'</span></em><a class="headerlink" href="#id7" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="id8">
<span class="sig-name descname"><span class="pre">NOT_VULNERABLE_NO_ORACLE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'NOT_VULNERABLE_NO_ORACLE'</span></em><a class="headerlink" href="#id8" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="id9">
<span class="sig-name descname"><span class="pre">NOT_VULNERABLE_RSA_NOT_SUPPORTED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'NOT_VULNERABLE_RSA_NOT_SUPPORTED'</span></em><a class="headerlink" href="#id9" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="id10">
<span class="sig-name descname"><span class="pre">UNKNOWN_INCONSISTENT_RESULTS</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'UNKNOWN_INCONSISTENT_RESULTS'</span></em><a class="headerlink" href="#id10" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
</section>
</section>
<section id="session-resumption-support">
<h2><a class="toc-backref" href="#id24">Session Resumption Support</a><a class="headerlink" href="#session-resumption-support" title="Permalink to this headline">¶</a></h2>
<p><strong>ScanCommand.SESSION_RESUMPTION</strong>: Test a server for TLS 1.2 session resumption support using session IDs and TLS tickets.</p>
<section id="id11">
<h3>Result class<a class="headerlink" href="#id11" title="Permalink to this headline">¶</a></h3>
<dl class="py class">
<dt class="sig sig-object py" id="sslyze.TlsResumptionSupportEnum">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">sslyze.</span></span><span class="sig-name descname"><span class="pre">TlsResumptionSupportEnum</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#sslyze.TlsResumptionSupportEnum" title="Permalink to this definition">¶</a></dt>
<dd><p>The result of attempting to resume TLS sessions with the server.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="sslyze.TlsResumptionSupportEnum.FULLY_SUPPORTED">
<span class="sig-name descname"><span class="pre">FULLY_SUPPORTED</span></span><a class="headerlink" href="#sslyze.TlsResumptionSupportEnum.FULLY_SUPPORTED" title="Permalink to this definition">¶</a></dt>
<dd><p>All the session resumption attempts were successful.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="sslyze.TlsResumptionSupportEnum.PARTIALLY_SUPPORTED">
<span class="sig-name descname"><span class="pre">PARTIALLY_SUPPORTED</span></span><a class="headerlink" href="#sslyze.TlsResumptionSupportEnum.PARTIALLY_SUPPORTED" title="Permalink to this definition">¶</a></dt>
<dd><p>Only some of the session resumption attempts were successful.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="sslyze.TlsResumptionSupportEnum.NOT_SUPPORTED">
<span class="sig-name descname"><span class="pre">NOT_SUPPORTED</span></span><a class="headerlink" href="#sslyze.TlsResumptionSupportEnum.NOT_SUPPORTED" title="Permalink to this definition">¶</a></dt>
<dd><p>None of the session resumption attempts were successful.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="sslyze.TlsResumptionSupportEnum.SERVER_IS_TLS_1_3_ONLY">
<span class="sig-name descname"><span class="pre">SERVER_IS_TLS_1_3_ONLY</span></span><a class="headerlink" href="#sslyze.TlsResumptionSupportEnum.SERVER_IS_TLS_1_3_ONLY" title="Permalink to this definition">¶</a></dt>
<dd><p>The server only supports TLS 1.3, which does not support Session ID nor TLS Tickets
resumption.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="sslyze.SessionResumptionSupportExtraArgument">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">sslyze.</span></span><span class="sig-name descname"><span class="pre">SessionResumptionSupportExtraArgument</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">number_of_resumptions_to_attempt</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#sslyze.SessionResumptionSupportExtraArgument" title="Permalink to this definition">¶</a></dt>
<dd><p>Additional configuration for running the SESSION_RESUMPTION scan command.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="sslyze.SessionResumptionSupportExtraArgument.number_of_resumptions_to_attempt">
<span class="sig-name descname"><span class="pre">number_of_resumptions_to_attempt</span></span><a class="headerlink" href="#sslyze.SessionResumptionSupportExtraArgument.number_of_resumptions_to_attempt" title="Permalink to this definition">¶</a></dt>
<dd><p>The number of session resumptions (both with Session IDs and TLS
Tickets) that SSLyze should attempt. The default value is 5, but a higher value such as 100 can be used to
get a more accurate measure of how often session resumption succeeds or fails with the server.</p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p>int</p>
</dd>
</dl>
</dd></dl>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>number_of_resumptions_to_attempt</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>) – </p>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="sslyze.SessionResumptionSupportScanResult">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">sslyze.</span></span><span class="sig-name descname"><span class="pre">SessionResumptionSupportScanResult</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">session_id_resumption_result</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session_id_attempted_resumptions_count</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session_id_successful_resumptions_count</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tls_ticket_resumption_result</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tls_ticket_attempted_resumptions_count</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tls_ticket_successful_resumptions_count</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#sslyze.SessionResumptionSupportScanResult" title="Permalink to this definition">¶</a></dt>
<dd><p>The result of testing a server for TLS 1.2 session resumption support, using Session IDs and TLS tickets.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="sslyze.SessionResumptionSupportScanResult.session_id_resumption_result">
<span class="sig-name descname"><span class="pre">session_id_resumption_result</span></span><a class="headerlink" href="#sslyze.SessionResumptionSupportScanResult.session_id_resumption_result" title="Permalink to this definition">¶</a></dt>
<dd><p>The overall result of session ID resumption testing.</p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#sslyze.TlsResumptionSupportEnum" title="sslyze.plugins.session_resumption._resumption_with_id.TlsResumptionSupportEnum">sslyze.plugins.session_resumption._resumption_with_id.TlsResumptionSupportEnum</a></p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="sslyze.SessionResumptionSupportScanResult.session_id_attempted_resumptions_count">
<span class="sig-name descname"><span class="pre">session_id_attempted_resumptions_count</span></span><a class="headerlink" href="#sslyze.SessionResumptionSupportScanResult.session_id_attempted_resumptions_count" title="Permalink to this definition">¶</a></dt>
<dd><p>The total number of session ID resumptions that were attempted.</p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p>int</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="sslyze.SessionResumptionSupportScanResult.session_id_successful_resumptions_count">
<span class="sig-name descname"><span class="pre">session_id_successful_resumptions_count</span></span><a class="headerlink" href="#sslyze.SessionResumptionSupportScanResult.session_id_successful_resumptions_count" title="Permalink to this definition">¶</a></dt>
<dd><p>The number of session ID resumptions that were successful.</p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p>int</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="sslyze.SessionResumptionSupportScanResult.tls_ticket_resumption_result">
<span class="sig-name descname"><span class="pre">tls_ticket_resumption_result</span></span><a class="headerlink" href="#sslyze.SessionResumptionSupportScanResult.tls_ticket_resumption_result" title="Permalink to this definition">¶</a></dt>
<dd><p>The overall result of TLS ticket resumption testing.</p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#sslyze.TlsResumptionSupportEnum" title="sslyze.plugins.session_resumption._resumption_with_id.TlsResumptionSupportEnum">sslyze.plugins.session_resumption._resumption_with_id.TlsResumptionSupportEnum</a></p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="sslyze.SessionResumptionSupportScanResult.tls_ticket_attempted_resumptions_count">
<span class="sig-name descname"><span class="pre">tls_ticket_attempted_resumptions_count</span></span><a class="headerlink" href="#sslyze.SessionResumptionSupportScanResult.tls_ticket_attempted_resumptions_count" title="Permalink to this definition">¶</a></dt>
<dd><p>The total number of TLS ticket resumptions that were attempted.</p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p>int</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="sslyze.SessionResumptionSupportScanResult.tls_ticket_successful_resumptions_count">
<span class="sig-name descname"><span class="pre">tls_ticket_successful_resumptions_count</span></span><a class="headerlink" href="#sslyze.SessionResumptionSupportScanResult.tls_ticket_successful_resumptions_count" title="Permalink to this definition">¶</a></dt>
<dd><p>The number of TLS ticket resumptions that were successful.</p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p>int</p>
</dd>
</dl>