Skip to content

doc: Add initial 'Cryptography' section#517

Merged
slyon merged 2 commits intocanonical:mainfrom
slyon:security-docs-fr-7556
Sep 16, 2024
Merged

doc: Add initial 'Cryptography' section#517
slyon merged 2 commits intocanonical:mainfrom
slyon:security-docs-fr-7556

Conversation

@slyon
Copy link
Contributor

@slyon slyon commented Sep 11, 2024 •
edited
Loading

Description

Add initial 'Cryptography' section do our "Security" documentation.

Also include some new tooling in tools/grep_cryptography.sh, to identify cryptography related terminology in our codebase.

FR-7556

Checklist

  • Runs make check successfully.
  • Retains code coverage (make check-coverage).
  • New/changed keys in YAML format are documented.
  • (Optional) Adds example YAML for new feature.
  • (Optional) Closes an open bug in Launchpad.

@slyon slyon force-pushed the security-docs-fr-7556 branch from 95d4df4 to 7ecfdd9 Compare September 12, 2024 07:50
@slyon slyon marked this pull request as ready for review September 12, 2024 07:52
@slyon slyon requested review from daniloegea and rkratky September 12, 2024 07:52
@slyon
Copy link
Contributor Author

slyon commented Sep 12, 2024 •
edited
Loading

@CodiumAI-Agent /review
--pr_reviewer.inline_code_comments=true
--pr_reviewer.require_score_review=true
--pr_reviewer.require_can_be_split_review=true
--pr_reviewer.require_soc2_ticket=true
--pr_reviewer.num_code_suggestions="2"

@QodoAI-Agent
Copy link

QodoAI-Agent commented Sep 12, 2024 •
edited
Loading

PR Reviewer Guide 🔍

(Review updated until commit 4e21d25)

⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪
🏅 Score: 85
🧪 No relevant tests
🔒 No security concerns identified
🔀 Multiple PR themes

Sub-PR theme: Add tooling for identifying cryptographic terms

Relevant files:

  • tools/grep_cryptography.sh
Sub-PR theme: Document cryptographic technologies and configurations

Relevant files:

  • doc/security.md
⚡ Key issues to review

Possible Bug
The comment correction from '265bit' to '256 bit' is good, but the actual regex pattern and logic for validating a WireGuard key might not be robust enough to ensure it's a valid key. Consider adding more rigorous checks or using a dedicated library for validation.

QodoAI-Agent
QodoAI-Agent reviewed Sep 12, 2024
View reviewed changes
@slyon slyon added the documentation Documentation improvements. label Sep 12, 2024
daniloegea
daniloegea reviewed Sep 12, 2024
View reviewed changes
Copy link
Contributor

@daniloegea daniloegea left a comment

Choose a reason for hiding this comment

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

I left 2 comments in the text that we might want to address

@slyon slyon force-pushed the security-docs-fr-7556 branch from 7ecfdd9 to 0b5c2d3 Compare September 12, 2024 14:29
@slyon
doc: Add initial 'Cryptography' section
4e21d25 
Also include some new tooling in tools/grep_cryptography.sh, to indentify
cryptography related terminiology in our codebase.
@slyon slyon force-pushed the security-docs-fr-7556 branch from 0b5c2d3 to 4e21d25 Compare September 12, 2024 14:31
@slyon slyon requested a review from daniloegea September 16, 2024 07:23
daniloegea
daniloegea approved these changes Sep 16, 2024
View reviewed changes
Copy link
Contributor

@daniloegea daniloegea left a comment

Choose a reason for hiding this comment

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

Thanks, it looks good to me.

@slyon slyon merged commit e0e8711 into canonical:main Sep 16, 2024
@QodoAI-Agent
Copy link

QodoAI-Agent commented Sep 16, 2024

Persistent review updated to latest commit 4e21d25

QodoAI-Agent
QodoAI-Agent reviewed Sep 16, 2024
View reviewed changes
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@rkratky rkratky Awaiting requested review from rkratky

2 more reviewers

@QodoAI-Agent QodoAI-Agent QodoAI-Agent left review comments

@daniloegea daniloegea daniloegea approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

documentation Documentation improvements.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@slyon @QodoAI-Agent @daniloegea