Skip to content

Commit 8762fa6

Browse files
committed
fix: documentation typos
1 parent 7ca22da commit 8762fa6

File tree

2 files changed

+12
-12
lines changed

2 files changed

+12
-12
lines changed

.github/README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -162,7 +162,7 @@ Cookies can disclose information about how the website tracks and interacts with
162162
- [HTTP Cookie Docs (Mozilla)](https://developer.mozilla.org/en-US/docs/Web/HTTP/Cookies)
163163
- [What are Cookies (via Cloudflare Learning)](https://www.cloudflare.com/learning/privacy/what-are-cookies/)
164164
- [Testing for Cookie Attributes (OWASP)](https://owasp.org/www-project-web-security-testing-guide/v42/4-Web_Application_Security_Testing/06-Session_Management_Testing/02-Testing_for_Cookies_Attributes)
165-
- [RFC-6265 - Coolies](https://tools.ietf.org/html/rfc6265)
165+
- [RFC-6265 - Cookies](https://tools.ietf.org/html/rfc6265)
166166

167167
</details>
168168
<details>
@@ -415,10 +415,10 @@ In an OSINT context, Whois records can provide valuable clues about the entity b
415415
<img width="300" src="https://i.ibb.co/J54zVmQ/wc-dnssec.png" align="right" />
416416

417417
###### Description
418-
Without DNSSEC, it's possible for MITM attackers to spoof records and lead users to phishing sites. This is because the DNS system includes no built-in methods to verify that the response to the request was not forged, or that any other part of the process wasn’t interrupted by an attacker. The DNS Security Extensions (DNSSEC) secures DNS lookups by signing your DNS records using public keys, so browsers can detect if the response has been tampered with. Another solution to this issue is DoH (DNS over HTTPS) and DoT (DNS over TLD).
418+
Without DNSSEC, it's possible for MITM attackers to spoof records and lead users to phishing sites. This is because the DNS system includes no built-in methods to verify that the response to the request was not forged, or that any other part of the process wasn’t interrupted by an attacker. The DNS Security Extensions (DNSSEC) secures DNS lookups by signing your DNS records using public keys, so browsers can detect if the response has been tampered with. Another solution to this issue is DoH (DNS over HTTPS) and DoT (DNS over TLS).
419419

420420
###### Use Cases
421-
DNSSEC information provides insight into an organization's level of cybersecurity maturity and potential vulnerabilities, particularly around DNS spoofing and cache poisoning. If no DNS secururity (DNSSEC, DoH, DoT, etc) is implemented, this may provide an entry point for an attacker.
421+
DNSSEC information provides insight into an organization's level of cybersecurity maturity and potential vulnerabilities, particularly around DNS spoofing and cache poisoning. If no DNS security (DNSSEC, DoH, DoT, etc) is implemented, this may provide an entry point for an attacker.
422422

423423
###### Useful Links
424424
- [undefined](function link() { [native code] })
@@ -473,7 +473,7 @@ There are several reasons why it's important for a site to be HSTS enabled:
473473
<img width="300" src="https://i.ibb.co/tKpL8F9/Screenshot-from-2023-08-12-15-43-12.png" align="right" />
474474

475475
###### Description
476-
This check determines the DNS server(s) that the requested URL / IP resolves to. Also fires off a rudimentary check to see if the DNS server supports DoH, and weather it's vulnerable to DNS cache poisoning.
476+
This check determines the DNS server(s) that the requested URL / IP resolves to. Also fires off a rudimentary check to see if the DNS server supports DoH, and whether it's vulnerable to DNS cache poisoning.
477477

478478
###### Use Cases
479479

@@ -829,7 +829,7 @@ Key | Value
829829
- `CLOUDMERSIVE_API_KEY` - API key for Cloudmersive ([get here](https://account.cloudmersive.com/)). This will show known threats associated with the IP
830830
- `TRANCO_USERNAME` - A Tranco email ([get here](https://tranco-list.eu/)). This will show the rank of a site, based on traffic
831831
- `TRANCO_API_KEY` - A Tranco API key ([get here](https://tranco-list.eu/)). This will show the rank of a site, based on traffic
832-
- `URL_SCAN_API_KEY` - A URLScan API key ([get here](https://urlscan.io/)). This will fetch miscalanious info about a site
832+
- `URL_SCAN_API_KEY` - A URLScan API key ([get here](https://urlscan.io/)). This will fetch miscellaneous info about a site
833833
- `BUILT_WITH_API_KEY` - A BuiltWith API key ([get here](https://api.builtwith.com/)). This will show the main features of a site
834834
- `TORRENT_IP_API_KEY` - A torrent API key ([get here](https://iknowwhatyoudownload.com/en/api/)). This will show torrents downloaded by an IP
835835

@@ -873,7 +873,7 @@ Some checks also require `chromium`, `traceroute` and `dns` to be installed with
873873
### Contributing
874874

875875
Contributions of any kind are very welcome, and would be much appreciated.
876-
For Code of Conduct, see [Contributor Convent](https://www.contributor-covenant.org/version/2/1/code_of_conduct/).
876+
For Code of Conduct, see [Contributor Covenant](https://www.contributor-covenant.org/version/2/1/code_of_conduct/).
877877

878878
To get started, fork the repo, make your changes, add, commit and push the code, then come back here to open a pull request. If you're new to GitHub or open source, [this guide](https://www.freecodecamp.org/news/how-to-make-your-first-pull-request-on-github-3#let-s-make-our-first-pull-request-) or the [git docs](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) may help you get started, but feel free to reach out if you need any support.
879879

@@ -1294,7 +1294,7 @@ to use, copy, modify, merge, publish, distribute, sub-license, and/or sell
12941294
copies of the Software, and to permit persons to whom the Software is furnished
12951295
to do so, subject to the following conditions:
12961296
1297-
The above copyright notice and this permission notice shall be included install
1297+
The above copyright notice and this permission notice shall be included in all
12981298
copies or substantial portions of the Software.
12991299
13001300
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,

src/web-check-live/utils/docs.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ const docs: Doc[] = [
5959
{ title: 'HTTP Cookie Docs (Mozilla)', link: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Cookies' },
6060
{ title: 'What are Cookies (via Cloudflare Learning)', link: 'https://www.cloudflare.com/learning/privacy/what-are-cookies/' },
6161
{ title: 'Testing for Cookie Attributes (OWASP)', link: 'https://owasp.org/www-project-web-security-testing-guide/v42/4-Web_Application_Security_Testing/06-Session_Management_Testing/02-Testing_for_Cookies_Attributes' },
62-
{ title: 'RFC-6265 - Coolies', link: 'https://tools.ietf.org/html/rfc6265' },
62+
{ title: 'RFC-6265 - Cookies', link: 'https://tools.ietf.org/html/rfc6265' },
6363
],
6464
screenshot: 'https://i.ibb.co/TTQ6DtP/wc-cookies.png',
6565
},
@@ -254,8 +254,8 @@ const docs: Doc[] = [
254254
id: "dnssec",
255255
title: "DNS Security Extensions",
256256
description:
257-
"Without DNSSEC, it's possible for MITM attackers to spoof records and lead users to phishing sites. This is because the DNS system includes no built-in methods to verify that the response to the request was not forged, or that any other part of the process wasn’t interrupted by an attacker. The DNS Security Extensions (DNSSEC) secures DNS lookups by signing your DNS records using public keys, so browsers can detect if the response has been tampered with. Another solution to this issue is DoH (DNS over HTTPS) and DoT (DNS over TLD).",
258-
use: "DNSSEC information provides insight into an organization's level of cybersecurity maturity and potential vulnerabilities, particularly around DNS spoofing and cache poisoning. If no DNS secururity (DNSSEC, DoH, DoT, etc) is implemented, this may provide an entry point for an attacker.",
257+
"Without DNSSEC, it's possible for MITM attackers to spoof records and lead users to phishing sites. This is because the DNS system includes no built-in methods to verify that the response to the request was not forged, or that any other part of the process wasn’t interrupted by an attacker. The DNS Security Extensions (DNSSEC) secures DNS lookups by signing your DNS records using public keys, so browsers can detect if the response has been tampered with. Another solution to this issue is DoH (DNS over HTTPS) and DoT (DNS over TLS).",
258+
use: "DNSSEC information provides insight into an organization's level of cybersecurity maturity and potential vulnerabilities, particularly around DNS spoofing and cache poisoning. If no DNS security (DNSSEC, DoH, DoT, etc) is implemented, this may provide an entry point for an attacker.",
259259
resources: [
260260
"https://dnssec-analyzer.verisignlabs.com/",
261261
"https://www.cloudflare.com/dns/dnssec/how-dnssec-works/",
@@ -299,7 +299,7 @@ const docs: Doc[] = [
299299
{
300300
id: 'dns-server',
301301
title: 'DNS Server',
302-
description: 'This check determines the DNS server(s) that the requested URL / IP resolves to. Also fires off a rudimentary check to see if the DNS server supports DoH, and weather it\'s vulnerable to DNS cache poisoning.',
302+
description: 'This check determines the DNS server(s) that the requested URL / IP resolves to. Also fires off a rudimentary check to see if the DNS server supports DoH, and whether it\'s vulnerable to DNS cache poisoning.',
303303
use: '',
304304
resources: [],
305305
screenshot: 'https://i.ibb.co/tKpL8F9/Screenshot-from-2023-08-12-15-43-12.png',
@@ -544,7 +544,7 @@ to use, copy, modify, merge, publish, distribute, sub-license, and/or sell
544544
copies of the Software, and to permit persons to whom the Software is furnished
545545
to do so, subject to the following conditions:
546546
547-
The above copyright notice and this permission notice shall be included install
547+
The above copyright notice and this permission notice shall be included in all
548548
copies or substantial portions of the Software.
549549
550550
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,

0 commit comments

Comments
 (0)