Skip to content

docs/explanation/security: modified snapd security documentation to be SEC30 V1.3 compliant#193

Merged
ernestl merged 1 commit intocanonical:mainfrom
ernestl:ernestl/ssdlc-security-policy-update-2
Apr 2, 2026
Merged

docs/explanation/security: modified snapd security documentation to be SEC30 V1.3 compliant#193
ernestl merged 1 commit intocanonical:mainfrom
ernestl:ernestl/ssdlc-security-policy-update-2

Conversation

@ernestl
Copy link
Copy Markdown
Member

@ernestl ernestl commented Mar 16, 2026

Follow up of WIP #179 that was accidentally merged early.

Please also look at provide feedback on #179.

Spec: SEC30

Jira: https://warthogs.atlassian.net/browse/SNAPDENG-35755

Copy link
Copy Markdown

@pedronis pedronis left a comment

Choose a reason for hiding this comment

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

did a first pass

@ernestl ernestl requested a review from bboozzoo March 17, 2026 10:54
@ernestl ernestl requested review from bboozzoo, Copilot and pedronis and removed request for degville March 23, 2026 11:12
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR extends the Sphinx/MyST security documentation by adding new pages/sections covering snapd API authentication/authorization and snapd decommissioning, and by expanding existing security policy documentation (including cryptography provenance and security maintenance lifecycle details). The PR description references a follow-up to PR #179, but this review is limited to the diffs included here.

Changes:

  • Add new “API authentication and authorization” and “Decommissioning” explanation pages and link them from the security index.
  • Expand security-policies.md with cryptography provenance notes and a new “Security maintenance” section; fix a few formatting issues in refresh awareness text.
  • Add a dedicated anchor in data-locations.md for “Persisted data on Ubuntu Core” and update cross-references to point to it.

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 11 comments.

Show a summary per file
File Description
docs/reference/administration/data-locations.md Adds an anchor label for the Ubuntu Core persisted data section to support more specific cross-references.
docs/explanation/security/snap-confinement.md Adjusts the Classic confinement link (currently in a way that likely breaks the reference).
docs/explanation/security/security-policies.md Adds cryptography provenance + security maintenance content; updates cross-references and refresh awareness formatting.
docs/explanation/security/index.md Adds nav links/toctree entries for the new security pages (currently with a toctree filename mismatch).
docs/explanation/security/decomissioning.md Introduces decommissioning guidance (currently has label whitespace + typos + structure issues, and filename spelling mismatch).
docs/explanation/security/api-authentication-and-authorization.md Introduces API auth/authz overview content, including auth data location and authorization mechanisms.

Copy link
Copy Markdown

@bboozzoo bboozzoo left a comment

Choose a reason for hiding this comment

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

LGTM, assuming comments from copilot are addressed

@ernestl ernestl requested a review from degville March 23, 2026 15:16
@ernestl ernestl force-pushed the ernestl/ssdlc-security-policy-update-2 branch from ca47c6e to db51ce4 Compare March 23, 2026 15:26
@ernestl ernestl changed the title docs/explanation/security: add authentication and authorization section docs/explanation/security: modified snapd security documentation to be SEC0030 V1.3 compliant Mar 23, 2026
@ernestl ernestl changed the title docs/explanation/security: modified snapd security documentation to be SEC0030 V1.3 compliant docs/explanation/security: modified snapd security documentation to be SEC30 V1.3 compliant Mar 23, 2026
Copy link
Copy Markdown

@pedronis pedronis left a comment

Choose a reason for hiding this comment

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

one comment, need to do a pass still on api-auth-authz

@ernestl ernestl requested a review from pedronis March 25, 2026 19:19
Copy link
Copy Markdown

@pedronis pedronis left a comment

Choose a reason for hiding this comment

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

comment, let me know how you want to proceed on this, picking different examples, pointing to other docs?

@ernestl ernestl requested a review from pedronis March 31, 2026 09:10
For details of which authorization mechanism applies to each API, refer to the [snapd API documentation].

[snapd API documentation]: https://snapcraft.io/docs/reference/development/snapd-rest-api/

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

This is actually very good. We'll start covering diagrams (architecture) and more detailed explanation in 26.10/27.04, so this is definitely going to be useful.

Copy link
Copy Markdown

@pedronis pedronis left a comment

Choose a reason for hiding this comment

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

I'm not against the diagrams but the 2nd one needs a tweak

@ernestl
Copy link
Copy Markdown
Member Author

ernestl commented Apr 1, 2026

I did fairly heavy modification to authentication and authorization to try and have it more accurate.
Also the diagrams was modified.

@ernestl
Copy link
Copy Markdown
Member Author

ernestl commented Apr 1, 2026

Authentication:

image

@ernestl
Copy link
Copy Markdown
Member Author

ernestl commented Apr 1, 2026

Authorization:

Note - zooming is enabled in grahams official version of mermaid support, and scale and style can be tweaked in the future.

image image image

@ernestl ernestl requested review from bboozzoo and pedronis April 1, 2026 14:13
Copy link
Copy Markdown

@pedronis pedronis left a comment

Choose a reason for hiding this comment

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

generally +1, please get Maciej to re-review if there are major changes

…e SEC0030 V1.3 compliant

‎#docs/explanation/security: review corrections

docs/explanation/security: remove diagrams

docs/explanation/security: improved authentication table
@ernestl ernestl force-pushed the ernestl/ssdlc-security-policy-update-2 branch from f0f6692 to 76c30ae Compare April 2, 2026 13:08
@ernestl
Copy link
Copy Markdown
Member Author

ernestl commented Apr 2, 2026

Maciek did complete another pass.

@ernestl ernestl merged commit 78dada3 into canonical:main Apr 2, 2026
1 of 2 checks passed
@lopezmiguel9500-commits lopezmiguel9500-commits mentioned this pull request Apr 2, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants