Skip to content

Commit

Permalink
MD Linter changes
Browse files Browse the repository at this point in the history
  • Loading branch information
abhinav-nain committed Sep 26, 2024
1 parent 6ed39eb commit 5aa4fd3
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 7 deletions.
3 changes: 1 addition & 2 deletions .markdownlint.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,5 @@
"line_length": false,
"fenced-code-language": false,
"no-emphasis-as-heading": false,
"MD041": false,
"blanks-around-headings": false
"first-line-heading": false
}
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -149,20 +149,20 @@ Incorrect:

Incorrect:

> Throughout the course of the engagement, a critical severity SQL injection was discovered in the web application (www.example.com) which could be used by an attacker to exfiltrate personally identifiable information from the backend database.
> Throughout the course of the engagement, a critical severity SQL injection was discovered in the web application (<www.example.com>) which could be used by an attacker to exfiltrate personally identifiable information from the backend database.
Correct:

> An SQL injection was discovered in www.example.com allowing a malicious attacker to exfiltrate personally identifiable information.
> An SQL injection was discovered in <www.example.com> allowing a malicious attacker to exfiltrate personally identifiable information.
### Split Up Long Sentences

Incorrect:

> An SQL injection was discovered in www.example.com allowing a malicious attacker to exfiltrate personally identifiable information including email addresses which would be considered a GDPR violation and poses a considerable business risk.
> An SQL injection was discovered in <www.example.com> allowing a malicious attacker to exfiltrate personally identifiable information including email addresses which would be considered a GDPR violation and poses a considerable business risk.
Correct:
> An SQL injection was discovered in www.example.com allowing a malicious attacker to exfiltrate personally identifiable information. The retrievable data includes passwords, email addresses and full names. This poses a GDPR violation and considerable business risk.
> An SQL injection was discovered in <www.example.com> allowing a malicious attacker to exfiltrate personally identifiable information. The retrievable data includes passwords, email addresses and full names. This poses a GDPR violation and considerable business risk.
## Acronyms

Expand All @@ -184,7 +184,7 @@ Incorrect: pen test, PenTest, Pen Test

## A vs. An

"An" should be used when the next word starts with a consonant _sound_. Otherwise, "A" should be used.
"An" should be used when the next word starts with a consonant *sound*. Otherwise, "A" should be used.

Correct:

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# Recommendation(s)

It is recommended to implement exploit mitigation controls within the application that prevent an attacker from analyzing, reverse engineering, or performing unauthorized code modifications. This can include leveraging jailbreak detection frameworks and libraries specifically designed to identify jailbroken (or rooted Android) devices. A good framework will monitor the runtime environment and check for the presence of known jailbreak files and directories.

For further information, please refer to:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@

#### Business Impact

LDAP injection vulnerabilities can lead to reputational damage through the impact to customers’ trust, or to regulatory fines due to an attacker’s unauthorized access to data. The severity of the impact to the business is dependent on the sensitivity of the data being stored in, and transmitted by the application.

#### Steps to Reproduce
Expand Down

0 comments on commit 5aa4fd3

Please sign in to comment.