API¶
OpenSSF integrations for pyrig.
rig ¶
pyrig configuration for OpenSSF integrations.
configs ¶
Configuration for OpenSSF integrations.
security ¶
Security-related config files contributed by this plugin.
best_practices ¶
Configuration for OpenSSF Best Practices assessment answers.
BestPracticesConfigFile ¶
Bases: JSONDictConfigFile
Generate proposed OpenSSF Best Practices and Baseline answers.
Build status and justification fields from a criterion method.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Return the criterion identifier from a justification_* method.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Propose accessibility based on the project site and documentation.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Show that each check-in on a shared branch runs tests with results.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Provide an automated build from source.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Show that the project uses common build tools.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Show that the project can be built with FLOSS tools.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Avoid recursive builds across dependent subdirectories.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Preserve requested debugging information when building.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Assess build repeatability.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Assess build reproducibility.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Assess support for standard compiler and linker variables.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Show that the project adopts and publishes a code of conduct.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Assess documented code review standards.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Show that contributions must follow defined coding standards.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Show that coding style is enforced automatically.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Show that the contribution process is documented.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Show that acceptable contribution requirements are documented.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Assess per-file copyright notices.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Assess delegation of cryptographic operations to libraries.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Assess default TLS certificate verification.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Assess whether cryptographic functionality is implementable using FLOSS.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Assess cryptographic key lengths.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Assess password storage security.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Assume no key-agreement protocols; review applicability per project.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Assess use of published, reviewed cryptography.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Assess cryptographic randomness.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Assess supported TLS versions.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Assess secure network defaults.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Assess certificate verification before sending private data.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Assess avoidance of known cryptographic weaknesses.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Assess cryptographic algorithm and mode suitability.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Show that software delivery counters man-in-the-middle attacks.
Do not trust unsigned cryptographic hashes retrieved over HTTP.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Monitor dependencies and address exploitable vulnerabilities.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Show that the project explains what its software does.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Provide searchable, addressable, open discussion channels.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Assess accuracy of published project achievements.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Document installation, startup, usage, and safe operation.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Keep documentation consistent with the software.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Document the software's external inputs and outputs.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Provide a quick introduction to useful software behavior.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Run qualifying dynamic analysis before major releases.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Assess runtime assertions during dynamic analysis.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Assess remediation of dynamic-analysis findings.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Assess dynamic analysis of memory-unsafe code.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Show that documentation and bug reporting support English.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Assess responsiveness to enhancement requests.
Show that dependencies are listed in a machine-readable format.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Show that the software is released under a FLOSS license.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Show that the software uses an OSI-approved license.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Propose governance based on the contribution guide.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Show that standard installation and uninstallation are supported.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Show that developers can quickly set up the development environment.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Assess support for standard installation variables.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Explain how to obtain, give feedback on, and contribute to the software.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Avoid deprecated interfaces in supported environments.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Assess developer knowledge of common security errors.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Assess developer knowledge of secure design.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Show that the license is published in a standard repository location.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Assess per-file license notices.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Keep the project maintained.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Keep valid credentials out of the public repository.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Assess multi-factor authentication for sensitive repository access.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Assign new collaborators' repository permissions manually.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Assess protection against direct commits.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Protect primary-branch deletion as a sensitive operation.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Show that CI tasks default to the lowest permissions.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Grant each CI task only the permissions it needs.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Assess handling of untrusted CI input.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Assess isolation of CI credentials from untrusted code.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Assess handling of collaborator-supplied CI input.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Show that every release receives a unique version identifier.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Associate every release asset with a unique identifier.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Deliver official project channels exclusively over encryption.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Show that distribution uses cryptographically authenticated channels.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Describe functional and security modifications in every release.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Show that pipelines use standard dependency management tools.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Assess release artifact signing.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Show that mechanisms prevent accidental credential commits.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Provide guides for all basic functionality.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Show that defect reporting is documented.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Assess release-author verification instructions.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Document the scope and duration of release support.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Show that the end of security support is documented.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Document how dependencies are selected, obtained, and tracked.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Document build instructions and required dependencies.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Assess the inventory of members with sensitive-resource access.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Describe project members' roles and responsibilities.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Provide public discussions of proposed changes and usage issues.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Show that the contribution process is documented.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Show that acceptable contribution requirements are documented.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Require legal authorization for code contributions.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Show that the source license meets the open-source definition.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Distribute release assets under open-source licenses.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Show that source licensing is kept in a standard repository file.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Include licenses with released assets.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Make the source repository publicly readable.
Assess access to source history and authorship.
Show that direct language dependencies are listed.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Require automated status checks before merging.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Assess documentation of project code repositories.
Assess security requirements across release repositories.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Keep generated executables out of version control.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Keep unreviewable binary artifacts out of version control.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Require automated tests before accepting commits.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Document when and how tests run.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Document a policy to add or update tests for major changes.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Assess independent human approval of changes.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Document every released external interface and its inputs and outputs.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Assess coordinated vulnerability disclosure.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Show that security reporting contacts are documented.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Provide a private channel for vulnerability reporting.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Assess dependency and license remediation policy.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Document a policy to resolve dependency violations before release.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Block changes that violate dependency-security policy.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Assess static-analysis remediation policy.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Block changes that violate documented security-weakness policy.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Assess regression tests for bug fixes.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Explain major changes and upgrade impacts in release notes.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Default to no publicly known project vulnerabilities; review per project.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Show that the project uses distributed version control.
Share interim source changes for collaborative review.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Provide a publicly readable source repository.
Show that version control records what changed, who changed it, and when.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Provide a public archive of reports and responses.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Show that users have a documented way to report bugs.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Assess responsiveness to bug reports.
Show that individual issues are tracked in an issue tracker.
Document project roles and responsibilities.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Show that project sites support HTTPS.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Assess password security of project sites.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Show that static analysis runs before releases.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Show that static analysis checks for common vulnerabilities.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Assess remediation of static-analysis findings.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Show that static analysis runs often.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Show that an automated test suite is used with a documented command.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Assess the 80 percent branch coverage criterion.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Show that automated tests run as changes are integrated.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Show that tests use a standard invocation for Python.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Test most functionality and inputs.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Have a policy to add tests for major new functionality.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Assess the written requirement to add tests.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Assess the 80 percent statement coverage criterion.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Assess the 90 percent statement coverage criterion.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Add meaningful tests for the most recent major functionality changes.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Assess test requirements in contribution instructions.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Assess two-person review of proposed changes.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Show that reused components can be identified and updated.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Assess use of Semantic Versioning or Calendar Versioning.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Show that releases have unique version identifiers.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Assess remediation of critical vulnerabilities.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Assess the 60-day vulnerability remediation criterion.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Support private reports over encrypted channels.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Show that the vulnerability reporting process is published.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Assess the 14-day initial vulnerability response criterion.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Show that the vulnerability response process is documented.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Show that tools are enabled to detect code quality problems.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Address warnings reported by configured checks.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Show that warning checks are configured strictly.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
Return the registered status-and-justification methods.
Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 | |
security_insights ¶
Configuration for OpenSSF Security Insights metadata.
SecurityInsightsConfigFile ¶
Bases: YMLDictConfigFile
Generate Security Insights metadata using overridable project defaults.
Build the primary administrator contact.
Source code in src/pyrig_openssf/rig/configs/security/security_insights.py
Build the core team contact list.
Source code in src/pyrig_openssf/rig/configs/security/security_insights.py
Generate the header metadata section.
Source code in src/pyrig_openssf/rig/configs/security/security_insights.py
Declare the repository license.
Source code in src/pyrig_openssf/rig/configs/security/security_insights.py
Build the project metadata section.
Source code in src/pyrig_openssf/rig/configs/security/security_insights.py
Declare links to generated project documentation.
Source code in src/pyrig_openssf/rig/configs/security/security_insights.py
Describe releases and distribution channels.
Source code in src/pyrig_openssf/rig/configs/security/security_insights.py
Build the repository metadata section.
Source code in src/pyrig_openssf/rig/configs/security/security_insights.py
Declare links to generated repository policies.
Source code in src/pyrig_openssf/rig/configs/security/security_insights.py
Build the repository security section.
Source code in src/pyrig_openssf/rig/configs/security/security_insights.py
Describe security tools and their integrations.
Source code in src/pyrig_openssf/rig/configs/security/security_insights.py
Describe vulnerability reporting.
Source code in src/pyrig_openssf/rig/configs/security/security_insights.py
version_control ¶
Version-control configuration for OpenSSF integrations.
remote ¶
Remote version-control configuration.
workflows ¶
GitHub Actions workflow configuration.
Health check workflow extended with reusable security-practices analysis.
Bases: HealthCheckWorkflowConfigFile
Include security-practices checks in the required health-check result.
Call the reusable security-practices workflow.
Source code in src/pyrig_openssf/rig/configs/version_control/remote/workflows/health_check.py
Return base health-check jobs followed by security-practices analysis.
Source code in src/pyrig_openssf/rig/configs/version_control/remote/workflows/health_check.py
Reusable security-practices analysis and code-scanning alert gate.
Bases: WorkflowConfigFile
Analyze repository practices and fail on open Scorecard alerts.
Return the Scorecard action name, pinned SHA, and release tag.
Return the SARIF uploader name, pinned SHA, and release tag.
Source code in src/pyrig_openssf/rig/configs/version_control/remote/workflows/security_practices.py
Build the isolated analysis and upload job.
Source code in src/pyrig_openssf/rig/configs/version_control/remote/workflows/security_practices.py
Check alerts after the uploaded analysis has been processed.
Source code in src/pyrig_openssf/rig/configs/version_control/remote/workflows/security_practices.py
Return the analysis and alert-gate job builders.
Grant repository reads, SARIF upload, and publication signing.
Source code in src/pyrig_openssf/rig/configs/version_control/remote/workflows/security_practices.py
Grant read access to code-scanning alerts without OIDC.
Run Scorecard with public publication enabled.
Source code in src/pyrig_openssf/rig/configs/version_control/remote/workflows/security_practices.py
Fail on open Scorecard alerts for the analyzed ref or API errors.
Source code in src/pyrig_openssf/rig/configs/version_control/remote/workflows/security_practices.py
Upload Scorecard results and wait for code-scanning processing.
Source code in src/pyrig_openssf/rig/configs/version_control/remote/workflows/security_practices.py
Return checkout, analysis, and code-scanning upload steps.
Source code in src/pyrig_openssf/rig/configs/version_control/remote/workflows/security_practices.py
Allow invocation only through a reusable-workflow call.
resources ¶
Pinned GitHub Actions metadata.
tools ¶
OpenSSF tool metadata.
security ¶
Security assessment tools.
practices ¶
OpenSSF Scorecard identity and repository security assessment badges.
SecurityPracticesChecker ¶
Bases: Tool
Represent Scorecard and display related OpenSSF assessment badges.
Return the repository's Baseline badge and assessment link.
Return the repository's Best Practices badge and assessment link.
Source code in src/pyrig_openssf/rig/tools/security/practices.py
Return Scorecard, Best Practices, and Baseline badge metadata.
image_url() -> str
Return the repository's published Scorecard badge URL.
Source code in src/pyrig_openssf/rig/tools/security/practices.py
Return an OpenSSF project lookup URL without requiring a project ID.
Source code in src/pyrig_openssf/rig/tools/security/practices.py
secrets ¶
Secrets scanner command construction and badge metadata.
SecretsChecker ¶
Bases: SecretsChecker
Customize detect-secrets for generated Best Practices criteria.
Exclude only the generated Best Practices assessment file.