-
-
Notifications
You must be signed in to change notification settings - Fork 143
Add OpenSSF-facing repository hygiene documents #271
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
Open
SamErde
wants to merge
2
commits into
main
Choose a base branch
from
samerde/repo-audit-plan
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| ## Summary | ||
|
|
||
| <!-- Describe the change and why it is needed. --> | ||
|
|
||
| ## Type of change | ||
|
|
||
| <!-- Check all that apply. --> | ||
|
|
||
| - [ ] Bug fix | ||
| - [ ] New feature | ||
| - [ ] Documentation | ||
| - [ ] Security hardening | ||
| - [ ] Refactoring | ||
| - [ ] Build, CI, or repository maintenance | ||
|
|
||
| ## Validation | ||
|
|
||
| <!-- Describe the checks you ran. If a check is not applicable, explain why. --> | ||
|
|
||
| - [ ] PSScriptAnalyzer | ||
| - [ ] Pester tests | ||
| - [ ] Manual validation | ||
| - [ ] Documentation-only change | ||
|
|
||
| ## Security impact | ||
|
|
||
| <!-- Describe any effect on AD CS discovery, remediation, credentials, generated scripts, network requests, or repository supply chain. --> | ||
|
|
||
| ## Documentation impact | ||
|
|
||
| <!-- Note README, Docs, external help, or support/security policy updates. --> | ||
|
|
||
| ## PowerShell compatibility | ||
|
|
||
| <!-- Note affected versions or platforms, such as Windows PowerShell 5.1, PowerShell 7, Windows Server, or RSAT requirements. --> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| # Security Policy | ||
|
|
||
| ## Supported versions | ||
|
|
||
| Security fixes are prioritized for the latest published Locksmith release and | ||
| the current `main` branch. If you are using an older release, upgrade to the | ||
| latest release before reporting unless the issue is specific to the upgrade | ||
| path. | ||
|
|
||
| ## Reporting a vulnerability | ||
|
|
||
| Do not report security vulnerabilities in public GitHub issues, discussions, or | ||
| pull requests. | ||
|
|
||
| Email vulnerability reports to <security@dotdot.horse>. Include as much of the | ||
| following information as you can safely share: | ||
|
|
||
| - The Locksmith version or commit SHA. | ||
| - The affected command, mode, scan, or remediation path. | ||
| - The Windows and PowerShell versions used. | ||
| - A clear description of the security impact. | ||
| - Minimal reproduction steps, sample output, or logs with secrets and sensitive | ||
| environment details removed. | ||
| - Whether the issue is already being exploited or publicly discussed. | ||
|
|
||
| The maintainers will review the report, coordinate follow-up privately, and | ||
| publish public details after a fix or mitigation is available when disclosure is | ||
| appropriate. | ||
|
|
||
| ## Handling sensitive AD CS data | ||
|
|
||
| Locksmith output can include names, distinguished names, SIDs, certificate | ||
| authority details, and remediation commands from an Active Directory | ||
| environment. Remove organization-specific or sensitive values before sharing | ||
| logs, screenshots, generated scripts, CSV files, or command output publicly. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| # Support | ||
|
|
||
| ## Questions and usage help | ||
|
|
||
| Start with the project documentation: | ||
|
|
||
| - [README](README.md) | ||
| - [Published documentation](https://jakehildreth.github.io/Locksmith/) | ||
|
|
||
| If the documentation does not answer your question, search existing | ||
| [GitHub issues](https://github.com/jakehildreth/Locksmith/issues). If there is | ||
| no related issue, open a new issue and include: | ||
|
|
||
| - Locksmith version. | ||
| - Windows version. | ||
| - PowerShell version and host. | ||
| - Whether the forest is single-domain or multi-domain. | ||
| - The command you ran, with sensitive values removed. | ||
| - The behavior you expected and what happened instead. | ||
|
|
||
| ## Bug reports | ||
|
|
||
| Use the | ||
| [bug report template](https://github.com/jakehildreth/Locksmith/issues/new/choose) | ||
| for reproducible bugs. Include enough detail for maintainers to reproduce the | ||
| issue without access to your environment. | ||
|
|
||
| ## Security reports | ||
|
|
||
| Do not report vulnerabilities or sensitive environment details in public issues. | ||
| Follow the [security policy](SECURITY.md) instead. |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.