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.

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

feat: remote auditing #230

Merged
merged 13 commits into from
Dec 5, 2024
Merged

feat: remote auditing #230

merged 13 commits into from
Dec 5, 2024

Conversation

woodruffw
Copy link
Owner

@woodruffw woodruffw commented Dec 4, 2024

WIP.

Once finished, this will enable zizmor foo/bar, where foo/bar is a GitHub repo that zizmor will extract workflows to audit from.

(The @-prefix is not a firm design choice -- I might remove that.)

Closes #50

Closes #177

CC @miketheman as an interested party 🙂

@woodruffw woodruffw added enhancement New feature or request cli labels Dec 4, 2024
@woodruffw woodruffw self-assigned this Dec 4, 2024
@miketheman
Copy link
Collaborator

Woohoo, thanks for taking this on!

(The @-prefix is not a firm design choice -- I might remove that.)

I agree - especially considering that we cannot predict the future of Naming Things.

In my head, it's absolutely fine and fair to use the entire repo URL as the input - and this don't have to "teach" a new thing.

@miketheman
Copy link
Collaborator

miketheman commented Dec 4, 2024

For completeness, an example:

zizmor https://github.com/foo/bar

@woodruffw
Copy link
Owner Author

woodruffw commented Dec 4, 2024

In my head, it's absolutely fine and fair to use the entire repo URL as the input - and this don't have to "teach" a new thing.

True -- the only reason why I'm shying away from this is because I don't want to have to teach zizmor how to validate URLs, versus being given a slug that it can make correct-by-construction into a GitHub URL.

For example, I don't want to get bug reports for ssh:// URLs, or GHE deployments, or for http://random-filehost.example.com/why-is-there-a-workflow-here.yml 🙂

As a middle ground, I think I'll drop the @ prefix but go with a convention that's already universal on GitHub, namely org/repo(@ref)?. That can be disambiguated easily from a local file by testing for presence, and leaves open changing to a full URL input in the future if/when that becomes pressing. That way no new syntax is invented here, at least.

Signed-off-by: William Woodruff <[email protected]>
Signed-off-by: William Woodruff <[email protected]>
Signed-off-by: William Woodruff <[email protected]>
Signed-off-by: William Woodruff <[email protected]>
Signed-off-by: William Woodruff <[email protected]>
Signed-off-by: William Woodruff <[email protected]>
Signed-off-by: William Woodruff <[email protected]>
Signed-off-by: William Woodruff <[email protected]>
Signed-off-by: William Woodruff <[email protected]>
@woodruffw woodruffw changed the title feat: fetch workflows from GitHub feat: remote auditing Dec 5, 2024
@woodruffw woodruffw merged commit 3a3a5c8 into main Dec 5, 2024
4 checks passed
@woodruffw woodruffw deleted the ww/fetch-repo branch December 5, 2024 00:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cli enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Refactor: switch to camino for path handling Support remote auditing?
2 participants