Skip to content

Commit 1691fd0

Browse files
norajnoraj
committed
update doc for 3.1.0
1 parent 0474942 commit 1691fd0

21 files changed

+110
-110
lines changed

‎Gemfile.lock

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ GIT
99
PATH
1010
remote: .
1111
specs:
12-
tls-map (3.0.0)
12+
tls-map (3.1.0)
1313
csv (~> 3.3)
1414
docopt (~> 0.6)
1515
paint (~> 2.2)

‎docs/CHANGELOG.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Changelog
22

3-
## [Unreleased]
3+
## [3.1.0]
44

55
Additions:
66

‎docs/yard/TLSmap.html

+3-3
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ <h2>
119119
<dt id="VERSION-constant" class="">VERSION =
120120

121121
</dt>
122-
<dd><pre class="code"><span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#710">'</span><span style="color:#D20">3.0.0</span><span style="color:#710">'</span></span></pre></dd>
122+
<dd><pre class="code"><span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#710">'</span><span style="color:#D20">3.1.0</span><span style="color:#710">'</span></span></pre></dd>
123123

124124
</dl>
125125

@@ -135,9 +135,9 @@ <h2>
135135
</div>
136136

137137
<div id="footer">
138-
Generated on Sun Jun 23 20:28:54 2024 by
138+
Generated on Sat Feb 1 22:43:04 2025 by
139139
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
140-
0.9.36 (ruby-3.3.0).
140+
0.9.36 (ruby-3.4.1).
141141
</div>
142142

143143
</div>

‎docs/yard/TLSmap/App.html

+12-12
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ <h2>
137137
<dt id="NSS_URL-constant" class="">NSS_URL =
138138
<div class="docstring">
139139
<div class="discussion">
140-
<p>Timeout <a href="https://hg.mozilla.org/projects/nss/raw-file/tip/lib/ssl/sslproto.h">https://hg.mozilla.org/projects/nss/raw-file/tip/lib/ssl/sslproto.h</a>
140+
<p>Timeout <a href="https://hg.mozilla.org/projects/nss/raw-file/tip/lib/ssl/sslproto.h">https://hg.mozilla.org/projects/nss/raw-file/tip/lib/ssl/sslproto.h</a><br />
141141
so use github RO mirror instead.</p>
142142

143143

@@ -654,7 +654,7 @@ <h3 class="signature first" id="bulk_search-instance_method">
654654

655655

656656
&mdash;
657-
<div class='inline'><p>The type of <code>term</code>.
657+
<div class='inline'><p>The type of <code>term</code>.<br />
658658
Accepted values: <code>:codepoint</code>, <code>:iana</code>, <code>:openssl</code>, <code>:gnutls</code>, <code>:nss</code>.</p>
659659
</div>
660660

@@ -687,8 +687,8 @@ <h3 class="signature first" id="bulk_search-instance_method">
687687

688688

689689
&mdash;
690-
<div class='inline'><p>The corresponding type to be included in the return value.
691-
Accepted values: <code>:all</code> (default), <code>:codepoint</code>, <code>:iana</code>, <code>:openssl</code>,
690+
<div class='inline'><p>The corresponding type to be included in the return value.<br />
691+
Accepted values: <code>:all</code> (default), <code>:codepoint</code>, <code>:iana</code>, <code>:openssl</code>,<br />
692692
<code>:gnutls</code>, <code>:nss</code>.</p>
693693
</div>
694694

@@ -707,7 +707,7 @@ <h3 class="signature first" id="bulk_search-instance_method">
707707

708708

709709
&mdash;
710-
<div class='inline'><p>The corresponding type, same as <span class='object_link'><a href="#search-class_method" title="TLSmap::App.search (method)">search</a></span> return value
710+
<div class='inline'><p>The corresponding type, same as <span class='object_link'><a href="#search-class_method" title="TLSmap::App.search (method)">search</a></span> return value<br />
711711
but one per line stored in an array.</p>
712712
</div>
713713

@@ -789,8 +789,8 @@ <h3 class="signature " id="export-instance_method">
789789

790790

791791
&mdash;
792-
<div class='inline'><p>Supported formats: <code>:markdown</code> (a markdown table),
793-
<code>:json_pretty</code> (expanded JSON), <code>:json_compact</code> (minified JSON),
792+
<div class='inline'><p>Supported formats: <code>:markdown</code> (a markdown table),<br />
793+
<code>:json_pretty</code> (expanded JSON), <code>:json_compact</code> (minified JSON),<br />
794794
<code>:marshal</code> (Ruby marshalized hash).</p>
795795
</div>
796796

@@ -862,7 +862,7 @@ <h3 class="signature " id="search-instance_method">
862862

863863

864864
&mdash;
865-
<div class='inline'><p>The type of <code>term</code>.
865+
<div class='inline'><p>The type of <code>term</code>.<br />
866866
Accepted values: <code>:codepoint</code>, <code>:iana</code>, <code>:openssl</code>, <code>:gnutls</code>, <code>:nss</code>.</p>
867867
</div>
868868

@@ -895,8 +895,8 @@ <h3 class="signature " id="search-instance_method">
895895

896896

897897
&mdash;
898-
<div class='inline'><p>The corresponding type to be included in the return value.
899-
Accepted values: <code>:all</code> (default), <code>:codepoint</code>, <code>:iana</code>, <code>:openssl</code>,
898+
<div class='inline'><p>The corresponding type to be included in the return value.<br />
899+
Accepted values: <code>:all</code> (default), <code>:codepoint</code>, <code>:iana</code>, <code>:openssl</code>,<br />
900900
<code>:gnutls</code>, <code>:nss</code>.</p>
901901
</div>
902902

@@ -962,9 +962,9 @@ <h3 class="signature " id="search-instance_method">
962962
</div>
963963

964964
<div id="footer">
965-
Generated on Sun Jun 23 20:28:54 2024 by
965+
Generated on Sat Feb 1 22:43:04 2025 by
966966
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
967-
0.9.36 (ruby-3.3.0).
967+
0.9.36 (ruby-3.4.1).
968968
</div>
969969

970970
</div>

‎docs/yard/TLSmap/App/Cipher.html

+5-5
Original file line numberDiff line numberDiff line change
@@ -571,7 +571,7 @@ <h3 class="signature first" id="initialize-instance_method">
571571

572572
</span>
573573

574-
&mdash; <div class='inline'><p>mapping of all TLS cipher suites returned by <span class='object_link'><a href="../App.html#tls_map-instance_method" title="TLSmap::App#tls_map (method)">TLSmap::App#tls_map</a></span>.
574+
&mdash; <div class='inline'><p>mapping of all TLS cipher suites returned by <span class='object_link'><a href="../App.html#tls_map-instance_method" title="TLSmap::App#tls_map (method)">TLSmap::App#tls_map</a></span>.<br />
575575
(better performance for batch usage)</p>
576576
</div>
577577

@@ -584,7 +584,7 @@ <h3 class="signature first" id="initialize-instance_method">
584584

585585
</span>
586586

587-
&mdash; <div class='inline'><p>enhanced information of all cipher suites returned by
587+
&mdash; <div class='inline'><p>enhanced information of all cipher suites returned by<br />
588588
<span class='object_link'><a href="Extended.html#enhanced_data-instance_method" title="TLSmap::App::Extended#enhanced_data (method)">Extended#enhanced_data</a></span>. (better performance for batch usage)</p>
589589
</div>
590590

@@ -1205,7 +1205,7 @@ <h3 class="signature " id="should_i_use?-instance_method">
12051205

12061206
</h3><div class="docstring">
12071207
<div class="discussion">
1208-
<p>Is the security level defined to <code>secure</code> or <code>recommended</code>?
1208+
<p>Is the security level defined to <code>secure</code> or <code>recommended</code>?<br />
12091209
It will return <code>false</code> for <code>weak</code> and <code>insecure</code> cipher suites.</p>
12101210

12111211

@@ -1367,9 +1367,9 @@ <h3 class="signature " id="weak?-instance_method">
13671367
</div>
13681368

13691369
<div id="footer">
1370-
Generated on Sun Jun 23 20:28:54 2024 by
1370+
Generated on Sat Feb 1 22:43:04 2025 by
13711371
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1372-
0.9.36 (ruby-3.3.0).
1372+
0.9.36 (ruby-3.4.1).
13731373
</div>
13741374

13751375
</div>

‎docs/yard/TLSmap/App/Extended.html

+8-8
Original file line numberDiff line numberDiff line change
@@ -558,8 +558,8 @@ <h3 class="signature first" id="enhance_all-instance_method">
558558

559559
</h3><div class="docstring">
560560
<div class="discussion">
561-
<p>Enhance data from ciphersuite.info for all cipher suites and store it
562-
for batch usage.
561+
<p>Enhance data from ciphersuite.info for all cipher suites and store it<br />
562+
for batch usage.<br />
563563
The data will be available through <span class='object_link'><a href="#enhanced_data-instance_method" title="TLSmap::App::Extended#enhanced_data (method)">#enhanced_data</a></span>.</p>
564564

565565

@@ -610,7 +610,7 @@ <h3 class="signature " id="extend-instance_method">
610610

611611
</h3><div class="docstring">
612612
<div class="discussion">
613-
<p>Retrieve advanced information about a cipher on Cipher Suite Info API and enhanced it.
613+
<p>Retrieve advanced information about a cipher on Cipher Suite Info API and enhanced it.<br />
614614
Fetch only the requested cipher suite, small network footprint, ideal for low bandwidth or punctual use.</p>
615615

616616

@@ -647,7 +647,7 @@ <h3 class="signature " id="extend-instance_method">
647647

648648

649649
&mdash;
650-
<div class='inline'><p>if true will fetch info for all cipher suites the 1st time and used the cached value
650+
<div class='inline'><p>if true will fetch info for all cipher suites the 1st time and used the cached value<br />
651651
for further requests</p>
652652
</div>
653653

@@ -666,8 +666,8 @@ <h3 class="signature " id="extend-instance_method">
666666

667667

668668
&mdash;
669-
<div class='inline'><p>Hash containing advanced information. The keys are the same as <span class='object_link'><a href="#DICO-constant" title="TLSmap::App::Extended::DICO (constant)">DICO</a></span>. All values are string
670-
except <code>vulns</code> which is an array of hashes containing two keys: <code>:severity</code> (integer) and <code>:description</code>
669+
<div class='inline'><p>Hash containing advanced information. The keys are the same as <span class='object_link'><a href="#DICO-constant" title="TLSmap::App::Extended::DICO (constant)">DICO</a></span>. All values are string<br />
670+
except <code>vulns</code> which is an array of hashes containing two keys: <code>:severity</code> (integer) and <code>:description</code><br />
671671
(string). Each hash in <code>vulns</code> correspond to a vulnerability.</p>
672672
</div>
673673

@@ -899,9 +899,9 @@ <h3 class="signature " id="translate_acronym-instance_method">
899899
</div>
900900

901901
<div id="footer">
902-
Generated on Sun Jun 23 20:28:54 2024 by
902+
Generated on Sat Feb 1 22:43:05 2025 by
903903
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
904-
0.9.36 (ruby-3.3.0).
904+
0.9.36 (ruby-3.4.1).
905905
</div>
906906

907907
</div>

‎docs/yard/TLSmap/App/Extractor.html

+3-3
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@
102102
<h2>Overview</h2><div class="docstring">
103103
<div class="discussion">
104104
<p>External tools output data extractor</p>
105-
<p>Output files from <a href="https://github.com/nabla-c0d3/sslyze">SSLyze</a> (JSON), <a href="https://github.com/rbsec/sslscan">sslscan2</a> (XML), <a href="https://github.com/drwetter/testssl.sh">testssl.sh</a> (JSON), <a href="https://github.com/ssllabs/ssllabs-scan">ssllabs-scan</a> (JSON)
105+
<p>Output files from <a href="https://github.com/nabla-c0d3/sslyze">SSLyze</a> (JSON), <a href="https://github.com/rbsec/sslscan">sslscan2</a> (XML), <a href="https://github.com/drwetter/testssl.sh">testssl.sh</a> (JSON), <a href="https://github.com/ssllabs/ssllabs-scan">ssllabs-scan</a> (JSON)<br />
106106
, <a href="https://github.com/projectdiscovery/tlsx">tlsx</a> (JSON)</p>
107107
<p>Example of commands:</p>
108108
<ul>
@@ -936,9 +936,9 @@ <h3 class="signature " id="tls13-instance_method">
936936
</div>
937937

938938
<div id="footer">
939-
Generated on Sun Jun 23 20:28:54 2024 by
939+
Generated on Sat Feb 1 22:43:04 2025 by
940940
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
941-
0.9.36 (ruby-3.3.0).
941+
0.9.36 (ruby-3.4.1).
942942
</div>
943943

944944
</div>

‎docs/yard/TLSmap/App/Extractor/SsllabsScan.html

+3-3
Original file line numberDiff line numberDiff line change
@@ -414,7 +414,7 @@ <h3 class="signature " id="parse-class_method">
414414

415415

416416
&mdash;
417-
<div class='inline'><p>Path of the ssllabs-scan output file, beware of the format expected.
417+
<div class='inline'><p>Path of the ssllabs-scan output file, beware of the format expected.<br />
418418
See <span class='object_link'><a href="../Extractor.html" title="TLSmap::App::Extractor (class)">TLSmap::App::Extractor</a></span></p>
419419
</div>
420420

@@ -468,9 +468,9 @@ <h3 class="signature " id="parse-class_method">
468468
</div>
469469

470470
<div id="footer">
471-
Generated on Sun Jun 23 20:28:54 2024 by
471+
Generated on Sat Feb 1 22:43:05 2025 by
472472
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
473-
0.9.36 (ruby-3.3.0).
473+
0.9.36 (ruby-3.4.1).
474474
</div>
475475

476476
</div>

‎docs/yard/TLSmap/App/Extractor/Sslscan2.html

+4-4
Original file line numberDiff line numberDiff line change
@@ -226,7 +226,7 @@ <h3 class="signature first" id="extract_cipher-class_method">
226226

227227

228228
&mdash;
229-
<div class='inline'><p>By default use the offline mode with <span class='object_link'><a href="../../CLI.html" title="TLSmap::CLI (class)">CLI</a></span> for better performance.
229+
<div class='inline'><p>By default use the offline mode with <span class='object_link'><a href="../../CLI.html" title="TLSmap::CLI (class)">CLI</a></span> for better performance.<br />
230230
Online mode will use <span class='object_link'><a href="../../App.html" title="TLSmap::App (class)">TLSmap::App</a></span> and fetch upstream resources to get latest updates but is a lot slower.</p>
231231
</div>
232232

@@ -323,7 +323,7 @@ <h3 class="signature " id="parse-class_method">
323323

324324

325325
&mdash;
326-
<div class='inline'><p>Path of the sslscan2 output file, beware of the format expected.
326+
<div class='inline'><p>Path of the sslscan2 output file, beware of the format expected.<br />
327327
See <span class='object_link'><a href="../Extractor.html" title="TLSmap::App::Extractor (class)">TLSmap::App::Extractor</a></span></p>
328328
</div>
329329

@@ -377,9 +377,9 @@ <h3 class="signature " id="parse-class_method">
377377
</div>
378378

379379
<div id="footer">
380-
Generated on Sun Jun 23 20:28:54 2024 by
380+
Generated on Sat Feb 1 22:43:04 2025 by
381381
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
382-
0.9.36 (ruby-3.3.0).
382+
0.9.36 (ruby-3.4.1).
383383
</div>
384384

385385
</div>

‎docs/yard/TLSmap/App/Extractor/Sslyze.html

+3-3
Original file line numberDiff line numberDiff line change
@@ -303,7 +303,7 @@ <h3 class="signature " id="parse-class_method">
303303

304304

305305
&mdash;
306-
<div class='inline'><p>Path of the sslyze output file, beware of the format expected.
306+
<div class='inline'><p>Path of the sslyze output file, beware of the format expected.<br />
307307
See <span class='object_link'><a href="../Extractor.html" title="TLSmap::App::Extractor (class)">TLSmap::App::Extractor</a></span></p>
308308
</div>
309309

@@ -357,9 +357,9 @@ <h3 class="signature " id="parse-class_method">
357357
</div>
358358

359359
<div id="footer">
360-
Generated on Sun Jun 23 20:28:54 2024 by
360+
Generated on Sat Feb 1 22:43:04 2025 by
361361
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
362-
0.9.36 (ruby-3.3.0).
362+
0.9.36 (ruby-3.4.1).
363363
</div>
364364

365365
</div>

‎docs/yard/TLSmap/App/Extractor/Testssl.html

+3-3
Original file line numberDiff line numberDiff line change
@@ -509,7 +509,7 @@ <h3 class="signature " id="parse-class_method">
509509

510510

511511
&mdash;
512-
<div class='inline'><p>Path of the testssl output file, beware of the format expected.
512+
<div class='inline'><p>Path of the testssl output file, beware of the format expected.<br />
513513
See <span class='object_link'><a href="../Extractor.html" title="TLSmap::App::Extractor (class)">TLSmap::App::Extractor</a></span></p>
514514
</div>
515515

@@ -563,9 +563,9 @@ <h3 class="signature " id="parse-class_method">
563563
</div>
564564

565565
<div id="footer">
566-
Generated on Sun Jun 23 20:28:54 2024 by
566+
Generated on Sat Feb 1 22:43:05 2025 by
567567
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
568-
0.9.36 (ruby-3.3.0).
568+
0.9.36 (ruby-3.4.1).
569569
</div>
570570

571571
</div>

‎docs/yard/TLSmap/App/Extractor/Tlsx.html

+3-3
Original file line numberDiff line numberDiff line change
@@ -414,7 +414,7 @@ <h3 class="signature " id="parse-class_method">
414414

415415

416416
&mdash;
417-
<div class='inline'><p>Path of the tlsx output file, beware of the format expected.
417+
<div class='inline'><p>Path of the tlsx output file, beware of the format expected.<br />
418418
See <span class='object_link'><a href="../Extractor.html" title="TLSmap::App::Extractor (class)">TLSmap::App::Extractor</a></span></p>
419419
</div>
420420

@@ -468,9 +468,9 @@ <h3 class="signature " id="parse-class_method">
468468
</div>
469469

470470
<div id="footer">
471-
Generated on Sun Jun 23 20:28:54 2024 by
471+
Generated on Sat Feb 1 22:43:05 2025 by
472472
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
473-
0.9.36 (ruby-3.3.0).
473+
0.9.36 (ruby-3.4.1).
474474
</div>
475475

476476
</div>

‎docs/yard/TLSmap/CLI.html

+4-4
Original file line numberDiff line numberDiff line change
@@ -248,7 +248,7 @@ <h3 class="signature first" id="initialize-instance_method">
248248

249249
</h3><div class="docstring">
250250
<div class="discussion">
251-
<p>Load and parse data from marshalized hash (<code>data/mapping.marshal</code>).
251+
<p>Load and parse data from marshalized hash (<code>data/mapping.marshal</code>).<br />
252252
It must match the integrity check for security purpose.</p>
253253

254254

@@ -270,7 +270,7 @@ <h3 class="signature first" id="initialize-instance_method">
270270

271271

272272
&mdash;
273-
<div class='inline'><p>Force parsing even if integrity check failed (DANGEROUS,
273+
<div class='inline'><p>Force parsing even if integrity check failed (DANGEROUS,<br />
274274
may result in command execution vulnerability)</p>
275275
</div>
276276

@@ -352,9 +352,9 @@ <h3 class="signature first" id="update-instance_method">
352352
</div>
353353

354354
<div id="footer">
355-
Generated on Sun Jun 23 20:28:54 2024 by
355+
Generated on Sat Feb 1 22:43:04 2025 by
356356
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
357-
0.9.36 (ruby-3.3.0).
357+
0.9.36 (ruby-3.4.1).
358358
</div>
359359

360360
</div>

0 commit comments

Comments
 (0)