8000 docs: add security-by-design docs by grouville · Pull Request #9770 · dagger/dagger · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

docs: add security-by-design docs #9770

8000
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.

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

Merged
merged 6 commits into from
Apr 8, 2025

Conversation

grouville
Copy link
Member

Closes #9723

Users have been confused by https://docs.dagger.io/cookbook/#clone-a-remote-git-repository-into-a-container-by-branch-tag-or-commit. The source of the confusion seems to be deeper than just the reproduction of the cookbook.

Basically, we lack an understanding of the security-by-design model in our docs.

This PR updates the cookbook example to differentiate the HTTP(S) and SSH based refs and also introduces a security-model page. This page is currently not linked to any other page in our docs as I don't really know where it would fit @vikram-dagger

@grouville grouville requested a review from a team as a code owner March 4, 2025 19:39
@grouville grouville force-pushed the update-cookbook-ssh-ref branch from 248e516 to c8f5a71 Compare March 4, 2025 21:35
@jshbrntt
Copy link
jshbrntt commented Mar 5, 2025

Nice summary, thank you for the coherent explanation!

@jedevc jedevc changed the title docs : add security-by-design docs docs: add security-by-design docs Mar 5, 2025
@vikram-dagger vikram-dagger force-pushed the update-cookbook-ssh-ref branch from b47d833 to 3d14618 Compare March 11, 2025 06:17
@@ -0,0 +1,77 @@
---
slug: /features/security
Copy link
Contributor

Choose a reason for hiding this comment

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

I have replaced the current Features/Secrets page with a revised Features/Security page that discusses the sandboxing feature + the original Secrets page content. A redirection is also in place for the old URL.

@jpadams @kpenfound please review

Dagger supports the use of HTTP and SSH protocols for accessing directories, files, and Dagger modules in remote repositories. This feature is compatible with all major Git hosting platforms such as GitHub, GitLab, BitBucket, Azure DevOps, Codeberg, and Sourcehut. Dagger supports authentication via both HTTPS (using Git credential managers) and SSH (using a unified authentication approach).

<Tabs>
<TabItem value="Remote directories and files">
Copy link
Contributor

Choose a reason for hiding this comment

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

@grouville note these two tabs are because the formats are not the same for modules vs files/directories. Maybe they can be unified?

Copy link
Member Author

Choose a reason for hiding this comment

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

It will be yes, I'll converge those on the PR that unifies the logic

@vikram-dagger
Copy link
Contributor

Closes #9723

Users have been confused by https://docs.dagger.io/cookbook/#clone-a-remote-git-repository-into-a-container-by-branch-tag-or-commit. The source of the confusion seems to be deeper than just the reproduction of the cookbook.

This PR updates the cookbook example to differentiate the HTTP(S) and SSH based refs and also introduces a security-model page. This page is currently not linked to any other page in our docs as I don't really know where it would fit @vikram-dagger

I made some changes to accomodate this:

  • Dropped the current features/secrets page
  • Replaced it with a new features/security page including your new content above + the previous secrets examples
  • Added a new api/remote-repositories page for all remote repository access information
  • Linked to the above from relevant places ie. remote file/dir args, remote modules, etc
  • Also added links to the relevant cookbook examples

@vikram-dagger vikram-dagger added the area/documentation Improvements or additions to documentation label Mar 20, 2025
Copy link
Contributor
github-actions bot commented Apr 4, 2025

This PR is stale because it has been open 14 days with no activity. Remove stale label or comment or this will be closed in 7 days.

@grouville grouville force-pushed the update-cookbook-ssh-ref branch from 30a4dbf to 039abaf Compare April 7, 2025 21:16
@grouville grouville force-pushed the update-cookbook-ssh-ref branch 2 times, most recently from c349cea to b733452 Compare April 7, 2025 22:29
grouville and others added 6 commits April 8, 2025 00:41
The current example with `dag.Git()` does not take into account the fact that SSH refs trigger the security-by-design model of Dagger.

This commit adds alternative examples

Signed-off-by: Guillaume de Rouville <guillaume@dagger.io>
Add a security-by-design docs to explain the best practices / patterns with Dagger

Signed-off-by: Guillaume de Rouville <guillaume@dagger.io>
Signed-off-by: Guillaume de Rouville <guillaume@dagger.io>
Signed-off-by: Vikram Vaswani <vikram@dagger.io>
Signed-off-by: Vikram Vaswani <vikram@dagger.io>
Signed-off-by: Guillaume de Rouville <guillaume@dagger.io>
@grouville grouville force-pushed the update-cookbook-ssh-ref branch from b733452 to 760ae84 Compare April 8, 2025 01:15
@grouville grouville merged commit 34ce488 into dagger:main Apr 8, 2025
53 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

🐞 Git clone over SSH is broken
3 participants
0