Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Full documentation about extending the plugin #27

Merged
merged 48 commits into from
Jul 2, 2024
Merged

Full documentation about extending the plugin #27

merged 48 commits into from
Jul 2, 2024

Conversation

hugoqnc
Copy link
Contributor

@hugoqnc hugoqnc commented Jun 26, 2024

Adds two complementary guides:

  • Extending the Sonar Cryptography Plugin to add support for another language or cryptography library
  • Writing new detection rules for the Sonar Cryptography Plugin

@hugoqnc hugoqnc added the documentation Improvements or additions to documentation label Jun 26, 2024
@hugoqnc hugoqnc self-assigned this Jun 26, 2024
@n1ckl0sk0rtge n1ckl0sk0rtge self-assigned this Jun 27, 2024
@hugoqnc
add docs
4d9c865 
Signed-off-by: Hugo Queinnec <[email protected]>
@hugoqnc
full intro
dbb72cc 
Signed-off-by: Hugo Queinnec <[email protected]>
@hugoqnc
update
a17c1e6 
Signed-off-by: Hugo Queinnec <[email protected]>
@hugoqnc
four classes to use in generics
ffed985 
Signed-off-by: Hugo Queinnec <[email protected]>
@hugoqnc
engine
8c82756 
Signed-off-by: Hugo Queinnec <[email protected]>
@hugoqnc
check registrar
2ca2970 
Signed-off-by: Hugo Queinnec <[email protected]>
@hugoqnc
finish 1st part
105790c 
Signed-off-by: Hugo Queinnec <[email protected]>
@hugoqnc
update
f2c7a78 
Signed-off-by: Hugo Queinnec <[email protected]>
@hugoqnc
edit tree link
7e23372 
Signed-off-by: Hugo Queinnec <[email protected]>
@hugoqnc
update
672087f 
Signed-off-by: Hugo Queinnec <[email protected]>
@hugoqnc
Detailed explanations
3c531c4 
Signed-off-by: Hugo Queinnec <[email protected]>
@hugoqnc
finish Detailed explanations
3fd7047 
Signed-off-by: Hugo Queinnec <[email protected]>
@hugoqnc
example
41ef55b 
Signed-off-by: Hugo Queinnec <[email protected]>
@hugoqnc
special cases
104e565 
Signed-off-by: Hugo Queinnec <[email protected]>
@hugoqnc
update
ae5796a 
Signed-off-by: Hugo Queinnec <[email protected]>
@hugoqnc
update
4c33834 
Signed-off-by: Hugo Queinnec <[email protected]>
@hugoqnc
translation
a3cb2f5 
Signed-off-by: Hugo Queinnec <[email protected]>
@hugoqnc
reorganization rules
0987f6c 
Signed-off-by: Hugo Queinnec <[email protected]>
@hugoqnc
translation
f78a82d 
Signed-off-by: Hugo Queinnec <[email protected]>
@hugoqnc
asserts and graphs
80ab95a 
Signed-off-by: Hugo Queinnec <[email protected]>
@hugoqnc
update main readme
e7cdf83 
Signed-off-by: Hugo Queinnec <[email protected]>
@hugoqnc
mistakes
0012437 
Signed-off-by: Hugo Queinnec <[email protected]>
@hugoqnc
proofread language support
8c5a7e5 
Signed-off-by: Hugo Queinnec <[email protected]>
@hugoqnc
proofread detection rules
946a7c4 
Signed-off-by: Hugo Queinnec <[email protected]>
@hugoqnc
diagrams
ead0905 
Signed-off-by: Hugo Queinnec <[email protected]>
@hugoqnc
disclaimer
3e98ad0 
Signed-off-by: Hugo Queinnec <[email protected]>
@hugoqnc
architecture diagram
1b1b005 
Signed-off-by: Hugo Queinnec <[email protected]>
@hugoqnc hugoqnc force-pushed the doc/adding-language-support branch from 56ad454 to 1b1b005 Compare June 27, 2024 07:19
@hugoqnc
fix
9e1243a 
Signed-off-by: Hugo Queinnec <[email protected]>
n1ckl0sk0rtge
n1ckl0sk0rtge requested changes Jul 1, 2024
View reviewed changes
Copy link
Member

@n1ckl0sk0rtge n1ckl0sk0rtge left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Really good work!!! Have just some small changes 🥳

docs/DETECTION_RULE_STRUCTURE.md Outdated Show resolved Hide resolved
docs/DETECTION_RULE_STRUCTURE.md Outdated Show resolved Hide resolved
docs/DETECTION_RULE_STRUCTURE.md Outdated Show resolved Hide resolved
docs/DETECTION_RULE_STRUCTURE.md Outdated Show resolved Hide resolved
docs/DETECTION_RULE_STRUCTURE.md Outdated Show resolved Hide resolved
docs/LANGUAGE_SUPPORT.md Outdated Show resolved Hide resolved
docs/LANGUAGE_SUPPORT.md Outdated Show resolved Hide resolved
docs/LANGUAGE_SUPPORT.md Outdated Show resolved Hide resolved
docs/LANGUAGE_SUPPORT.md Outdated Show resolved Hide resolved
docs/LANGUAGE_SUPPORT.md Outdated Show resolved Hide resolved
hugoqnc and others added 20 commits July 2, 2024 12:48
@hugoqnc @n1ckl0sk0rtge
Update docs/DETECTION_RULE_STRUCTURE.md
198556b 
Co-authored-by: Nicklas Körtge <[email protected]>
Signed-off-by: Hugo Queinnec <[email protected]>
@hugoqnc @n1ckl0sk0rtge
Update docs/DETECTION_RULE_STRUCTURE.md
00c92b2 
Co-authored-by: Nicklas Körtge <[email protected]>
Signed-off-by: Hugo Queinnec <[email protected]>
@hugoqnc @n1ckl0sk0rtge
Update docs/DETECTION_RULE_STRUCTURE.md
7e51bf1 
Co-authored-by: Nicklas Körtge <[email protected]>
Signed-off-by: Hugo Queinnec <[email protected]>
@hugoqnc @n1ckl0sk0rtge
Apply suggestions from code review
12c3b6e 
Co-authored-by: Nicklas Körtge <[email protected]>
Signed-off-by: Hugo Queinnec <[email protected]>
@hugoqnc
coherence
1c54269 
Signed-off-by: Hugo Queinnec <[email protected]>
@hugoqnc
Function3 footnote
70f5869 
Signed-off-by: Hugo Queinnec <[email protected]>
@hugoqnc
fix
d6d5f2e 
Signed-off-by: Hugo Queinnec <[email protected]>
@hugoqnc
clarifications
ba8d35e 
Signed-off-by: Hugo Queinnec <[email protected]>
@hugoqnc @n1ckl0sk0rtge
Apply suggestions from code review
916ffb1 
Co-authored-by: Nicklas Körtge <[email protected]>
Signed-off-by: Hugo Queinnec <[email protected]>
@hugoqnc
fix
2c29f63 
Signed-off-by: Hugo Queinnec <[email protected]>
@hugoqnc @n1ckl0sk0rtge
Apply suggestions from code review
026b262 
Co-authored-by: Nicklas Körtge <[email protected]>
Signed-off-by: Hugo Queinnec <[email protected]>
@hugoqnc
fix
73aee67 
Signed-off-by: Hugo Queinnec <[email protected]>
@hugoqnc @n1ckl0sk0rtge
Apply suggestions from code review
c42f447 
Co-authored-by: Nicklas Körtge <[email protected]>
Signed-off-by: Hugo Queinnec <[email protected]>
@hugoqnc
fix
71766fd 
Signed-off-by: Hugo Queinnec <[email protected]>
@hugoqnc @n1ckl0sk0rtge
Apply suggestions from code review
00617d5 
Co-authored-by: Nicklas Körtge <[email protected]>
Signed-off-by: Hugo Queinnec <[email protected]>
@hugoqnc
fix
96d2fd3 
Signed-off-by: Hugo Queinnec <[email protected]>
@hugoqnc
fix a rule
71e4760 
Signed-off-by: Hugo Queinnec <[email protected]>
@hugoqnc
fix
47e57b0 
Signed-off-by: Hugo Queinnec <[email protected]>
@hugoqnc
final fix of detection_rule_structure
c4b5858 
Signed-off-by: Hugo Queinnec <[email protected]>
@hugoqnc @n1ckl0sk0rtge
Apply suggestions from code review
4b4bd6a 
Co-authored-by: Nicklas Körtge <[email protected]>
Signed-off-by: Hugo Queinnec <[email protected]>
@hugoqnc hugoqnc force-pushed the doc/adding-language-support branch from 48952dd to 4b4bd6a Compare July 2, 2024 10:49
n1ckl0sk0rtge
n1ckl0sk0rtge approved these changes Jul 2, 2024
View reviewed changes
Copy link
Member

@n1ckl0sk0rtge n1ckl0sk0rtge left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@n1ckl0sk0rtge n1ckl0sk0rtge merged commit 89181e1 into main Jul 2, 2024
2 checks passed
@n1ckl0sk0rtge n1ckl0sk0rtge deleted the doc/adding-language-support branch July 2, 2024 12:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@n1ckl0sk0rtge n1ckl0sk0rtge n1ckl0sk0rtge approved these changes

Assignees

@n1ckl0sk0rtge n1ckl0sk0rtge

@hugoqnc hugoqnc

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@hugoqnc @n1ckl0sk0rtge