Skip to content

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.

criterion_config
criterion_config(
    method: Callable[[], tuple[str, str]],
) -> dict[str, str]

Build status and justification fields from a criterion method.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def criterion_config(self, method: Callable[[], tuple[str, str]]) -> dict[str, str]:
    """Build status and justification fields from a criterion method."""
    criterion = self.criterion_from_method(method)
    status, justification = method()
    return {
        f"{criterion}_status": status,
        f"{criterion}_justification": justification,
    }
criterion_from_method
criterion_from_method(
    method: Callable[[], tuple[str, str]],
) -> str

Return the criterion identifier from a justification_* method.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def criterion_from_method(self, method: Callable[[], tuple[str, str]]) -> str:
    """Return the criterion identifier from a `justification_*` method."""
    return cast("MethodType", method).__name__.removeprefix("justification_")
justification_accessibility_best_practices
justification_accessibility_best_practices() -> (
    tuple[str, str]
)

Propose accessibility based on the project site and documentation.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_accessibility_best_practices(self) -> tuple[str, str]:
    """Propose accessibility based on the project site and documentation."""
    repo_url = RemoteVersionController.I.repo_url()
    docs_url = DocsBuilder.I.documentation_url()
    return self.STATUS_MET, f"See {repo_url} and {docs_url}."
justification_automated_integration_testing
justification_automated_integration_testing() -> (
    tuple[str, str]
)

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
def justification_automated_integration_testing(self) -> tuple[str, str]:
    """Show that each check-in on a shared branch runs tests with results."""
    health_url = RemoteVersionController.I.file_url(
        HealthCheckWorkflowConfigFile.I.path(),
    )
    release_url = RemoteVersionController.I.file_url(
        ReleaseWorkflowConfigFile.I.path(),
    )
    return self.STATUS_MET, f"See {health_url} and {release_url}."
justification_build
justification_build() -> tuple[str, str]

Provide an automated build from source.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_build(self) -> tuple[str, str]:
    """Provide an automated build from source."""
    config_url = RemoteVersionController.I.file_url(
        PyprojectConfigFile.I.path(),
    )
    deploy_url = RemoteVersionController.I.file_url(
        DeployWorkflowConfigFile.I.path(),
    )
    return self.STATUS_MET, f"See {config_url} and {deploy_url}."
justification_build_common_tools
justification_build_common_tools() -> tuple[str, str]

Show that the project uses common build tools.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_build_common_tools(self) -> tuple[str, str]:
    """Show that the project uses common build tools."""
    url = RemoteVersionController.I.file_url(PyprojectConfigFile.I.path())
    return self.STATUS_MET, f"See {url}."
justification_build_floss_tools
justification_build_floss_tools() -> tuple[str, str]

Show that the project can be built with FLOSS tools.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_build_floss_tools(self) -> tuple[str, str]:
    """Show that the project can be built with FLOSS tools."""
    url = RemoteVersionController.I.file_url(PyprojectConfigFile.I.path())
    return self.STATUS_MET, f"See {url}."
justification_build_non_recursive
justification_build_non_recursive() -> tuple[str, str]

Avoid recursive builds across dependent subdirectories.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_build_non_recursive(self) -> tuple[str, str]:
    """Avoid recursive builds across dependent subdirectories."""
    config_url = RemoteVersionController.I.file_url(
        PyprojectConfigFile.I.path(),
    )
    return self.STATUS_MET, f"See {config_url}."
justification_build_preserve_debug
justification_build_preserve_debug() -> tuple[str, str]

Preserve requested debugging information when building.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_build_preserve_debug(self) -> tuple[str, str]:
    """Preserve requested debugging information when building."""
    config_url = RemoteVersionController.I.file_url(
        PyprojectConfigFile.I.path(),
    )
    return self.STATUS_MET, f"See {config_url}."
justification_build_repeatable
justification_build_repeatable() -> tuple[str, str]

Assess build repeatability.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_build_repeatable(self) -> tuple[str, str]:
    """Assess build repeatability."""
    config_url = RemoteVersionController.I.file_url(
        PyprojectConfigFile.I.path(),
    )
    return self.STATUS_MET, f"See {config_url}."
justification_build_reproducible
justification_build_reproducible() -> tuple[str, str]

Assess build reproducibility.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_build_reproducible(self) -> tuple[str, str]:
    """Assess build reproducibility."""
    config_url = RemoteVersionController.I.file_url(
        PyprojectConfigFile.I.path(),
    )
    return self.STATUS_MET, f"See {config_url}."
justification_build_standard_variables
justification_build_standard_variables() -> tuple[str, str]

Assess support for standard compiler and linker variables.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_build_standard_variables(self) -> tuple[str, str]:
    """Assess support for standard compiler and linker variables."""
    url = RemoteVersionController.I.file_url(PyprojectConfigFile.I.path())
    return self.STATUS_NA, f"See {url}."
justification_code_of_conduct
justification_code_of_conduct() -> tuple[str, str]

Show that the project adopts and publishes a code of conduct.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_code_of_conduct(self) -> tuple[str, str]:
    """Show that the project adopts and publishes a code of conduct."""
    url = RemoteVersionController.I.file_url(CodeOfConductConfigFile.I.path())
    return self.STATUS_MET, f"See {url}."
justification_code_review_standards
justification_code_review_standards() -> tuple[str, str]

Assess documented code review standards.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_code_review_standards(self) -> tuple[str, str]:
    """Assess documented code review standards."""
    contributing_url = RemoteVersionController.I.file_url(
        ContributingConfigFile.I.path(),
    )
    owners_url = RemoteVersionController.I.file_url(
        CodeownersConfigFile.I.path(),
    )
    settings_url = RemoteVersionController.I.file_url(
        RepositorySettingsConfigFile.I.path(),
    )
    configure_url = RemoteVersionController.I.file_url(
        ConfigureRepositoryConfigFile.I.path(),
    )
    health_url = RemoteVersionController.I.file_url(
        HealthCheckWorkflowConfigFile.I.path(),
    )
    return self.STATUS_MET, (
        f"See {contributing_url}, {owners_url}, {settings_url}, "
        f"{configure_url}, and {health_url}."
    )
justification_coding_standards
justification_coding_standards() -> tuple[str, str]

Show that contributions must follow defined coding standards.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_coding_standards(self) -> tuple[str, str]:
    """Show that contributions must follow defined coding standards."""
    config_url = RemoteVersionController.I.file_url(PyprojectConfigFile.I.path())
    hooks_url = RemoteVersionController.I.file_url(
        VersionControlHookManagerConfigFile.I.path(),
    )
    return self.STATUS_MET, f"See {config_url} and {hooks_url}."
justification_coding_standards_enforced
justification_coding_standards_enforced() -> (
    tuple[str, str]
)

Show that coding style is enforced automatically.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_coding_standards_enforced(self) -> tuple[str, str]:
    """Show that coding style is enforced automatically."""
    hooks_url = RemoteVersionController.I.file_url(
        VersionControlHookManagerConfigFile.I.path(),
    )
    health_url = RemoteVersionController.I.file_url(
        HealthCheckWorkflowConfigFile.I.path(),
    )
    return self.STATUS_MET, f"See {hooks_url} and {health_url}."
justification_contribution
justification_contribution() -> tuple[str, str]

Show that the contribution process is documented.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_contribution(self) -> tuple[str, str]:
    """Show that the contribution process is documented."""
    url = RemoteVersionController.I.file_url(ContributingConfigFile.I.path())
    return self.STATUS_MET, f"See {url}."
justification_contribution_requirements
justification_contribution_requirements() -> (
    tuple[str, str]
)

Show that acceptable contribution requirements are documented.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_contribution_requirements(self) -> tuple[str, str]:
    """Show that acceptable contribution requirements are documented."""
    url = RemoteVersionController.I.file_url(ContributingConfigFile.I.path())
    return self.STATUS_MET, f"See {url}."
justification_copyright_per_file
justification_copyright_per_file() -> tuple[str, str]

Assess per-file copyright notices.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_copyright_per_file(self) -> tuple[str, str]:
    """Assess per-file copyright notices."""
    repo_url = RemoteVersionController.I.repo_url()
    license_url = RemoteVersionController.I.file_url(LicenseConfigFile.I.path())
    return self.STATUS_UNMET, f"See {repo_url} and {license_url}."
justification_crypto_call
justification_crypto_call() -> tuple[str, str]

Assess delegation of cryptographic operations to libraries.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_crypto_call(self) -> tuple[str, str]:
    """Assess delegation of cryptographic operations to libraries."""
    hooks_url = RemoteVersionController.I.file_url(
        VersionControlHookManagerConfigFile.I.path(),
    )
    health_url = RemoteVersionController.I.file_url(
        HealthCheckWorkflowConfigFile.I.path(),
    )
    return self.STATUS_MET, f"See {hooks_url} and {health_url}."
justification_crypto_certificate_verification
justification_crypto_certificate_verification() -> (
    tuple[str, str]
)

Assess default TLS certificate verification.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_crypto_certificate_verification(self) -> tuple[str, str]:
    """Assess default TLS certificate verification."""
    hooks_url = RemoteVersionController.I.file_url(
        VersionControlHookManagerConfigFile.I.path(),
    )
    health_url = RemoteVersionController.I.file_url(
        HealthCheckWorkflowConfigFile.I.path(),
    )
    return self.STATUS_MET, f"See {hooks_url} and {health_url}."
justification_crypto_floss
justification_crypto_floss() -> tuple[str, str]

Assess whether cryptographic functionality is implementable using FLOSS.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_crypto_floss(self) -> tuple[str, str]:
    """Assess whether cryptographic functionality is implementable using FLOSS."""
    repo_url = RemoteVersionController.I.repo_url()
    config_url = RemoteVersionController.I.file_url(PyprojectConfigFile.I.path())
    lock_url = RemoteVersionController.I.file_url(PackageManager.I.lock_file())
    return self.STATUS_MET, f"See {repo_url}, {config_url}, and {lock_url}."
justification_crypto_keylength
justification_crypto_keylength() -> tuple[str, str]

Assess cryptographic key lengths.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_crypto_keylength(self) -> tuple[str, str]:
    """Assess cryptographic key lengths."""
    hooks_url = RemoteVersionController.I.file_url(
        VersionControlHookManagerConfigFile.I.path(),
    )
    health_url = RemoteVersionController.I.file_url(
        HealthCheckWorkflowConfigFile.I.path(),
    )
    return self.STATUS_MET, f"See {hooks_url} and {health_url}."
justification_crypto_password_storage
justification_crypto_password_storage() -> tuple[str, str]

Assess password storage security.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_crypto_password_storage(self) -> tuple[str, str]:
    """Assess password storage security."""
    hooks_url = RemoteVersionController.I.file_url(
        VersionControlHookManagerConfigFile.I.path(),
    )
    health_url = RemoteVersionController.I.file_url(
        HealthCheckWorkflowConfigFile.I.path(),
    )
    return self.STATUS_MET, f"See {hooks_url} and {health_url}."
justification_crypto_pfs
justification_crypto_pfs() -> tuple[str, str]

Assume no key-agreement protocols; review applicability per project.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_crypto_pfs(self) -> tuple[str, str]:
    """Assume no key-agreement protocols; review applicability per project."""
    url = RemoteVersionController.I.repo_url()
    return (
        self.STATUS_NA,
        f"The project does not implement key-agreement protocols. See {url}.",
    )
justification_crypto_published
justification_crypto_published() -> tuple[str, str]

Assess use of published, reviewed cryptography.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_crypto_published(self) -> tuple[str, str]:
    """Assess use of published, reviewed cryptography."""
    hooks_url = RemoteVersionController.I.file_url(
        VersionControlHookManagerConfigFile.I.path(),
    )
    health_url = RemoteVersionController.I.file_url(
        HealthCheckWorkflowConfigFile.I.path(),
    )
    return self.STATUS_MET, f"See {hooks_url} and {health_url}."
justification_crypto_random
justification_crypto_random() -> tuple[str, str]

Assess cryptographic randomness.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_crypto_random(self) -> tuple[str, str]:
    """Assess cryptographic randomness."""
    hooks_url = RemoteVersionController.I.file_url(
        VersionControlHookManagerConfigFile.I.path(),
    )
    health_url = RemoteVersionController.I.file_url(
        HealthCheckWorkflowConfigFile.I.path(),
    )
    return self.STATUS_MET, f"See {hooks_url} and {health_url}."
justification_crypto_tls12
justification_crypto_tls12() -> tuple[str, str]

Assess supported TLS versions.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_crypto_tls12(self) -> tuple[str, str]:
    """Assess supported TLS versions."""
    hooks_url = RemoteVersionController.I.file_url(
        VersionControlHookManagerConfigFile.I.path(),
    )
    health_url = RemoteVersionController.I.file_url(
        HealthCheckWorkflowConfigFile.I.path(),
    )
    return self.STATUS_MET, f"See {hooks_url} and {health_url}."
justification_crypto_used_network
justification_crypto_used_network() -> tuple[str, str]

Assess secure network defaults.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_crypto_used_network(self) -> tuple[str, str]:
    """Assess secure network defaults."""
    hooks_url = RemoteVersionController.I.file_url(
        VersionControlHookManagerConfigFile.I.path(),
    )
    health_url = RemoteVersionController.I.file_url(
        HealthCheckWorkflowConfigFile.I.path(),
    )
    return self.STATUS_MET, f"See {hooks_url} and {health_url}."
justification_crypto_verification_private
justification_crypto_verification_private() -> (
    tuple[str, str]
)

Assess certificate verification before sending private data.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_crypto_verification_private(self) -> tuple[str, str]:
    """Assess certificate verification before sending private data."""
    hooks_url = RemoteVersionController.I.file_url(
        VersionControlHookManagerConfigFile.I.path(),
    )
    health_url = RemoteVersionController.I.file_url(
        HealthCheckWorkflowConfigFile.I.path(),
    )
    return self.STATUS_MET, f"See {hooks_url} and {health_url}."
justification_crypto_weaknesses
justification_crypto_weaknesses() -> tuple[str, str]

Assess avoidance of known cryptographic weaknesses.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_crypto_weaknesses(self) -> tuple[str, str]:
    """Assess avoidance of known cryptographic weaknesses."""
    hooks_url = RemoteVersionController.I.file_url(
        VersionControlHookManagerConfigFile.I.path(),
    )
    health_url = RemoteVersionController.I.file_url(
        HealthCheckWorkflowConfigFile.I.path(),
    )
    return self.STATUS_MET, f"See {hooks_url} and {health_url}."
justification_crypto_working
justification_crypto_working() -> tuple[str, str]

Assess cryptographic algorithm and mode suitability.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_crypto_working(self) -> tuple[str, str]:
    """Assess cryptographic algorithm and mode suitability."""
    hooks_url = RemoteVersionController.I.file_url(
        VersionControlHookManagerConfigFile.I.path(),
    )
    health_url = RemoteVersionController.I.file_url(
        HealthCheckWorkflowConfigFile.I.path(),
    )
    return self.STATUS_MET, f"See {hooks_url} and {health_url}."
justification_delivery_mitm
justification_delivery_mitm() -> tuple[str, str]

Show that software delivery counters man-in-the-middle attacks.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_delivery_mitm(self) -> tuple[str, str]:
    """Show that software delivery counters man-in-the-middle attacks."""
    url = RemoteVersionController.I.releases_url()
    return self.STATUS_MET, f"See {url}."
justification_delivery_unsigned
justification_delivery_unsigned() -> tuple[str, str]

Do not trust unsigned cryptographic hashes retrieved over HTTP.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_delivery_unsigned(self) -> tuple[str, str]:
    """Do not trust unsigned cryptographic hashes retrieved over HTTP."""
    url = RemoteVersionController.I.releases_url()
    return self.STATUS_MET, f"See {url}."
justification_dependency_monitoring
justification_dependency_monitoring() -> tuple[str, str]

Monitor dependencies and address exploitable vulnerabilities.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_dependency_monitoring(self) -> tuple[str, str]:
    """Monitor dependencies and address exploitable vulnerabilities."""
    hooks_url = RemoteVersionController.I.file_url(
        VersionControlHookManagerConfigFile.I.path(),
    )
    dependencies_url = RemoteVersionController.I.file_url(
        DependencyBotConfigFile.I.path(),
    )
    configure_url = RemoteVersionController.I.file_url(
        ConfigureRepositoryConfigFile.I.path(),
    )
    health_url = RemoteVersionController.I.file_url(
        HealthCheckWorkflowConfigFile.I.path(),
    )
    return (
        self.STATUS_MET,
        f"See {hooks_url}, {dependencies_url}, {configure_url}, and {health_url}.",
    )
justification_description_good
justification_description_good() -> tuple[str, str]

Show that the project explains what its software does.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_description_good(self) -> tuple[str, str]:
    """Show that the project explains what its software does."""
    readme_url = RemoteVersionController.I.file_url(ReadmeConfigFile.I.path())
    docs_url = DocsBuilder.I.documentation_url()
    return self.STATUS_MET, f"See {readme_url} and {docs_url}."
justification_discussion
justification_discussion() -> tuple[str, str]

Provide searchable, addressable, open discussion channels.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_discussion(self) -> tuple[str, str]:
    """Provide searchable, addressable, open discussion channels."""
    issues_url = RemoteVersionController.I.issues_url()
    return self.STATUS_MET, f"See {issues_url}."
justification_documentation_achievements
justification_documentation_achievements() -> (
    tuple[str, str]
)

Assess accuracy of published project achievements.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_documentation_achievements(self) -> tuple[str, str]:
    """Assess accuracy of published project achievements."""
    readme_url = RemoteVersionController.I.file_url(
        ReadmeConfigFile.I.path(),
    )
    docs_url = DocsBuilder.I.documentation_url()
    return self.STATUS_MET, f"See {readme_url} and {docs_url}."
justification_documentation_basics
justification_documentation_basics() -> tuple[str, str]

Document installation, startup, usage, and safe operation.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_documentation_basics(self) -> tuple[str, str]:
    """Document installation, startup, usage, and safe operation."""
    readme_url = RemoteVersionController.I.file_url(
        ReadmeConfigFile.I.path(),
    )
    docs_url = DocsBuilder.I.documentation_url()
    return self.STATUS_MET, f"See {readme_url} and {docs_url}."
justification_documentation_current
justification_documentation_current() -> tuple[str, str]

Keep documentation consistent with the software.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_documentation_current(self) -> tuple[str, str]:
    """Keep documentation consistent with the software."""
    contributing_url = RemoteVersionController.I.file_url(
        ContributingConfigFile.I.path(),
    )
    documentation_url = RemoteVersionController.I.file_url(
        DocumentationWorkflowConfigFile.I.path(),
    )
    return self.STATUS_MET, f"See {contributing_url} and {documentation_url}."
justification_documentation_interface
justification_documentation_interface() -> tuple[str, str]

Document the software's external inputs and outputs.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_documentation_interface(self) -> tuple[str, str]:
    """Document the software's external inputs and outputs."""
    docs_url = DocsBuilder.I.documentation_url()
    return self.STATUS_MET, f"See {docs_url}."
justification_documentation_quick_start
justification_documentation_quick_start() -> (
    tuple[str, str]
)

Provide a quick introduction to useful software behavior.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_documentation_quick_start(self) -> tuple[str, str]:
    """Provide a quick introduction to useful software behavior."""
    readme_url = RemoteVersionController.I.file_url(
        ReadmeConfigFile.I.path(),
    )
    docs_url = DocsBuilder.I.documentation_url()
    return self.STATUS_MET, f"See {readme_url} and {docs_url}."
justification_dynamic_analysis
justification_dynamic_analysis() -> tuple[str, str]

Run qualifying dynamic analysis before major releases.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_dynamic_analysis(self) -> tuple[str, str]:
    """Run qualifying dynamic analysis before major releases."""
    config_url = RemoteVersionController.I.file_url(
        PyprojectConfigFile.I.path(),
    )
    health_url = RemoteVersionController.I.file_url(
        HealthCheckWorkflowConfigFile.I.path(),
    )
    release_url = RemoteVersionController.I.file_url(
        ReleaseWorkflowConfigFile.I.path(),
    )
    return self.STATUS_MET, f"See {config_url}, {health_url}, and {release_url}."
justification_dynamic_analysis_enable_assertions
justification_dynamic_analysis_enable_assertions() -> (
    tuple[str, str]
)

Assess runtime assertions during dynamic analysis.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_dynamic_analysis_enable_assertions(self) -> tuple[str, str]:
    """Assess runtime assertions during dynamic analysis."""
    config_url = RemoteVersionController.I.file_url(
        PyprojectConfigFile.I.path(),
    )
    health_url = RemoteVersionController.I.file_url(
        HealthCheckWorkflowConfigFile.I.path(),
    )
    return self.STATUS_MET, f"See {config_url} and {health_url}."
justification_dynamic_analysis_fixed
justification_dynamic_analysis_fixed() -> tuple[str, str]

Assess remediation of dynamic-analysis findings.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_dynamic_analysis_fixed(self) -> tuple[str, str]:
    """Assess remediation of dynamic-analysis findings."""
    health_url = RemoteVersionController.I.file_url(
        HealthCheckWorkflowConfigFile.I.path(),
    )
    release_url = RemoteVersionController.I.file_url(
        ReleaseWorkflowConfigFile.I.path(),
    )
    return self.STATUS_MET, f"See {health_url} and {release_url}."
justification_dynamic_analysis_unsafe
justification_dynamic_analysis_unsafe() -> tuple[str, str]

Assess dynamic analysis of memory-unsafe code.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_dynamic_analysis_unsafe(self) -> tuple[str, str]:
    """Assess dynamic analysis of memory-unsafe code."""
    repo_url = RemoteVersionController.I.repo_url()
    pyproject_url = RemoteVersionController.I.file_url(PyprojectConfigFile.I.path())
    return self.STATUS_NA, f"See {repo_url} and {pyproject_url}."
justification_english
justification_english() -> tuple[str, str]

Show that documentation and bug reporting support English.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_english(self) -> tuple[str, str]:
    """Show that documentation and bug reporting support English."""
    contributing_url = RemoteVersionController.I.file_url(
        ContributingConfigFile.I.path(),
    )
    report_url = RemoteVersionController.I.file_url(BugReportConfigFile.I.path())
    return self.STATUS_MET, f"See {contributing_url} and {report_url}."
justification_enhancement_responses
justification_enhancement_responses() -> tuple[str, str]

Assess responsiveness to enhancement requests.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_enhancement_responses(self) -> tuple[str, str]:
    """Assess responsiveness to enhancement requests."""
    url = RemoteVersionController.I.issues_url()
    return self.STATUS_MET, f"See {url}."
justification_external_dependencies
justification_external_dependencies() -> tuple[str, str]

Show that dependencies are listed in a machine-readable format.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_external_dependencies(self) -> tuple[str, str]:
    """Show that dependencies are listed in a machine-readable format."""
    config_url = RemoteVersionController.I.file_url(PyprojectConfigFile.I.path())
    lock_url = RemoteVersionController.I.file_url(PackageManager.I.lock_file())
    return self.STATUS_MET, f"See {config_url} and {lock_url}."
justification_floss_license
justification_floss_license() -> tuple[str, str]

Show that the software is released under a FLOSS license.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_floss_license(self) -> tuple[str, str]:
    """Show that the software is released under a FLOSS license."""
    url = RemoteVersionController.I.file_url(LicenseConfigFile.I.path())
    return self.STATUS_MET, f"See {url}."
justification_floss_license_osi
justification_floss_license_osi() -> tuple[str, str]

Show that the software uses an OSI-approved license.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_floss_license_osi(self) -> tuple[str, str]:
    """Show that the software uses an OSI-approved license."""
    url = RemoteVersionController.I.file_url(LicenseConfigFile.I.path())
    return self.STATUS_MET, f"See {url}."
justification_governance
justification_governance() -> tuple[str, str]

Propose governance based on the contribution guide.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_governance(self) -> tuple[str, str]:
    """Propose governance based on the contribution guide."""
    url = RemoteVersionController.I.file_url(ContributingConfigFile.I.path())
    return self.STATUS_MET, f"See {url}."
justification_installation_common
justification_installation_common() -> tuple[str, str]

Show that standard installation and uninstallation are supported.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_installation_common(self) -> tuple[str, str]:
    """Show that standard installation and uninstallation are supported."""
    url = RemoteVersionController.I.file_url(PyprojectConfigFile.I.path())
    return self.STATUS_MET, f"See {url}."
justification_installation_development_quick
justification_installation_development_quick() -> (
    tuple[str, str]
)

Show that developers can quickly set up the development environment.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_installation_development_quick(self) -> tuple[str, str]:
    """Show that developers can quickly set up the development environment."""
    url = RemoteVersionController.I.file_url(ContributingConfigFile.I.path())
    return self.STATUS_MET, f"See {url}."
justification_installation_standard_variables
justification_installation_standard_variables() -> (
    tuple[str, str]
)

Assess support for standard installation variables.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_installation_standard_variables(self) -> tuple[str, str]:
    """Assess support for standard installation variables."""
    config_url = RemoteVersionController.I.file_url(
        PyprojectConfigFile.I.path(),
    )
    return self.STATUS_MET, f"See {config_url}."
justification_interact
justification_interact() -> tuple[str, str]

Explain how to obtain, give feedback on, and contribute to the software.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_interact(self) -> tuple[str, str]:
    """Explain how to obtain, give feedback on, and contribute to the software."""
    readme_url = RemoteVersionController.I.file_url(
        ReadmeConfigFile.I.path(),
    )
    docs_url = DocsBuilder.I.documentation_url()
    contributing_url = RemoteVersionController.I.file_url(
        ContributingConfigFile.I.path(),
    )
    return self.STATUS_MET, f"See {readme_url}, {docs_url}, and {contributing_url}."
justification_interfaces_current
justification_interfaces_current() -> tuple[str, str]

Avoid deprecated interfaces in supported environments.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_interfaces_current(self) -> tuple[str, str]:
    """Avoid deprecated interfaces in supported environments."""
    config_url = RemoteVersionController.I.file_url(
        PyprojectConfigFile.I.path(),
    )
    health_url = RemoteVersionController.I.file_url(
        HealthCheckWorkflowConfigFile.I.path(),
    )
    return self.STATUS_MET, f"See {config_url} and {health_url}."
justification_know_common_errors
justification_know_common_errors() -> tuple[str, str]

Assess developer knowledge of common security errors.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_know_common_errors(self) -> tuple[str, str]:
    """Assess developer knowledge of common security errors."""
    hooks_url = RemoteVersionController.I.file_url(
        VersionControlHookManagerConfigFile.I.path(),
    )
    health_url = RemoteVersionController.I.file_url(
        HealthCheckWorkflowConfigFile.I.path(),
    )
    return self.STATUS_MET, f"See {hooks_url} and {health_url}."
justification_know_secure_design
justification_know_secure_design() -> tuple[str, str]

Assess developer knowledge of secure design.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_know_secure_design(self) -> tuple[str, str]:
    """Assess developer knowledge of secure design."""
    hooks_url = RemoteVersionController.I.file_url(
        VersionControlHookManagerConfigFile.I.path(),
    )
    health_url = RemoteVersionController.I.file_url(
        HealthCheckWorkflowConfigFile.I.path(),
    )
    release_url = RemoteVersionController.I.file_url(
        ReleaseWorkflowConfigFile.I.path(),
    )
    return self.STATUS_MET, f"See {hooks_url}, {health_url} and {release_url}."
justification_license_location
justification_license_location() -> tuple[str, str]

Show that the license is published in a standard repository location.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_license_location(self) -> tuple[str, str]:
    """Show that the license is published in a standard repository location."""
    url = RemoteVersionController.I.file_url(LicenseConfigFile.I.path())
    return self.STATUS_MET, f"See {url}."
justification_license_per_file
justification_license_per_file() -> tuple[str, str]

Assess per-file license notices.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_license_per_file(self) -> tuple[str, str]:
    """Assess per-file license notices."""
    repo_url = RemoteVersionController.I.repo_url()
    license_url = RemoteVersionController.I.file_url(LicenseConfigFile.I.path())
    return self.STATUS_UNMET, f"See {repo_url} and {license_url}."
justification_maintained
justification_maintained() -> tuple[str, str]

Keep the project maintained.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_maintained(self) -> tuple[str, str]:
    """Keep the project maintained."""
    dependencies_url = RemoteVersionController.I.file_url(
        DependencyBotConfigFile.I.path(),
    )
    health_url = RemoteVersionController.I.file_url(
        HealthCheckWorkflowConfigFile.I.path(),
    )
    repo_url = RemoteVersionController.I.repo_url()
    return self.STATUS_MET, f"See {dependencies_url}, {health_url}, and {repo_url}."
justification_no_leaked_credentials
justification_no_leaked_credentials() -> tuple[str, str]

Keep valid credentials out of the public repository.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_no_leaked_credentials(self) -> tuple[str, str]:
    """Keep valid credentials out of the public repository."""
    hooks_url = RemoteVersionController.I.file_url(
        VersionControlHookManagerConfigFile.I.path(),
    )
    health_url = RemoteVersionController.I.file_url(
        HealthCheckWorkflowConfigFile.I.path(),
    )
    return self.STATUS_MET, f"See {hooks_url} and {health_url}."
justification_osps_ac_01_01
justification_osps_ac_01_01() -> tuple[str, str]

Assess multi-factor authentication for sensitive repository access.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_osps_ac_01_01(self) -> tuple[str, str]:
    """Assess multi-factor authentication for sensitive repository access."""
    repo_url = RemoteVersionController.I.repo_url()
    docs_url = (
        "https://docs.github.com/en/authentication/"
        "securing-your-account-with-two-factor-authentication-2fa/"
        "about-mandatory-two-factor-authentication"
    )
    return self.STATUS_MET, f"See {repo_url} and {docs_url}."
justification_osps_ac_02_01
justification_osps_ac_02_01() -> tuple[str, str]

Assign new collaborators' repository permissions manually.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_osps_ac_02_01(self) -> tuple[str, str]:
    """Assign new collaborators' repository permissions manually."""
    repo_url = RemoteVersionController.I.repo_url()
    return self.STATUS_MET, f"See {repo_url}."
justification_osps_ac_03_01
justification_osps_ac_03_01() -> tuple[str, str]

Assess protection against direct commits.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_osps_ac_03_01(self) -> tuple[str, str]:
    """Assess protection against direct commits."""
    settings_url = RemoteVersionController.I.file_url(
        RepositorySettingsConfigFile.I.path(),
    )
    configure_url = RemoteVersionController.I.file_url(
        ConfigureRepositoryConfigFile.I.path(),
    )
    return self.STATUS_MET, f"See {settings_url} and {configure_url}."
justification_osps_ac_03_02
justification_osps_ac_03_02() -> tuple[str, str]

Protect primary-branch deletion as a sensitive operation.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_osps_ac_03_02(self) -> tuple[str, str]:
    """Protect primary-branch deletion as a sensitive operation."""
    settings_url = RemoteVersionController.I.file_url(
        RepositorySettingsConfigFile.I.path(),
    )
    configure_url = RemoteVersionController.I.file_url(
        ConfigureRepositoryConfigFile.I.path(),
    )
    return self.STATUS_MET, f"See {settings_url} and {configure_url}."
justification_osps_ac_04_01
justification_osps_ac_04_01() -> tuple[str, str]

Show that CI tasks default to the lowest permissions.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_osps_ac_04_01(self) -> tuple[str, str]:
    """Show that CI tasks default to the lowest permissions."""
    health_url = RemoteVersionController.I.file_url(
        HealthCheckWorkflowConfigFile.I.path(),
    )
    release_url = RemoteVersionController.I.file_url(
        ReleaseWorkflowConfigFile.I.path(),
    )
    deploy_url = RemoteVersionController.I.file_url(
        DeployWorkflowConfigFile.I.path(),
    )
    repository_url = RemoteVersionController.I.file_url(
        RepositoryWorkflowConfigFile.I.path(),
    )
    documentation_url = RemoteVersionController.I.file_url(
        DocumentationWorkflowConfigFile.I.path(),
    )
    security_practices_url = RemoteVersionController.I.file_url(
        SecurityPracticesWorkflowConfigFile.I.path(),
    )
    return (
        self.STATUS_MET,
        (
            f"See {health_url}, {release_url}, {deploy_url}, {repository_url}, "
            f"{documentation_url}, and {security_practices_url}."
        ),
    )
justification_osps_ac_04_02
justification_osps_ac_04_02() -> tuple[str, str]

Grant each CI task only the permissions it needs.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_osps_ac_04_02(self) -> tuple[str, str]:
    """Grant each CI task only the permissions it needs."""
    health_url = RemoteVersionController.I.file_url(
        HealthCheckWorkflowConfigFile.I.path(),
    )
    release_url = RemoteVersionController.I.file_url(
        ReleaseWorkflowConfigFile.I.path(),
    )
    deploy_url = RemoteVersionController.I.file_url(
        DeployWorkflowConfigFile.I.path(),
    )
    repository_url = RemoteVersionController.I.file_url(
        RepositoryWorkflowConfigFile.I.path(),
    )
    documentation_url = RemoteVersionController.I.file_url(
        DocumentationWorkflowConfigFile.I.path(),
    )
    security_practices_url = RemoteVersionController.I.file_url(
        SecurityPracticesWorkflowConfigFile.I.path(),
    )
    return (
        self.STATUS_MET,
        (
            f"See {health_url}, {release_url}, {deploy_url}, {repository_url}, "
            f"{documentation_url}, and {security_practices_url}."
        ),
    )
justification_osps_br_01_01
justification_osps_br_01_01() -> tuple[str, str]

Assess handling of untrusted CI input.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_osps_br_01_01(self) -> tuple[str, str]:
    """Assess handling of untrusted CI input."""
    release_url = RemoteVersionController.I.file_url(
        ReleaseWorkflowConfigFile.I.path(),
    )
    hooks_url = RemoteVersionController.I.file_url(
        VersionControlHookManagerConfigFile.I.path(),
    )
    health_url = RemoteVersionController.I.file_url(
        HealthCheckWorkflowConfigFile.I.path(),
    )
    return self.STATUS_MET, f"See {release_url}, {hooks_url}, and {health_url}."
justification_osps_br_01_03
justification_osps_br_01_03() -> tuple[str, str]

Assess isolation of CI credentials from untrusted code.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_osps_br_01_03(self) -> tuple[str, str]:
    """Assess isolation of CI credentials from untrusted code."""
    settings_url = RemoteVersionController.I.file_url(
        RepositorySettingsConfigFile.I.path(),
    )
    configure_url = RemoteVersionController.I.file_url(
        ConfigureRepositoryConfigFile.I.path(),
    )
    health_url = RemoteVersionController.I.file_url(
        HealthCheckWorkflowConfigFile.I.path(),
    )
    repository_url = RemoteVersionController.I.file_url(
        RepositoryWorkflowConfigFile.I.path(),
    )
    documentation_url = RemoteVersionController.I.file_url(
        DocumentationWorkflowConfigFile.I.path(),
    )
    security_practices_url = RemoteVersionController.I.file_url(
        SecurityPracticesWorkflowConfigFile.I.path(),
    )
    return (
        self.STATUS_MET,
        (
            f"See {settings_url}, {configure_url}, {health_url}, "
            f"{repository_url}, {documentation_url}, and {security_practices_url}."
        ),
    )
justification_osps_br_01_04
justification_osps_br_01_04() -> tuple[str, str]

Assess handling of collaborator-supplied CI input.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_osps_br_01_04(self) -> tuple[str, str]:
    """Assess handling of collaborator-supplied CI input."""
    release_url = RemoteVersionController.I.file_url(
        ReleaseWorkflowConfigFile.I.path(),
    )
    hooks_url = RemoteVersionController.I.file_url(
        VersionControlHookManagerConfigFile.I.path(),
    )
    health_url = RemoteVersionController.I.file_url(
        HealthCheckWorkflowConfigFile.I.path(),
    )
    return self.STATUS_MET, f"See {release_url}, {hooks_url}, and {health_url}."
justification_osps_br_02_01
justification_osps_br_02_01() -> tuple[str, str]

Show that every release receives a unique version identifier.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_osps_br_02_01(self) -> tuple[str, str]:
    """Show that every release receives a unique version identifier."""
    url = RemoteVersionController.I.file_url(
        ReleaseWorkflowConfigFile.I.path(),
    )
    return self.STATUS_MET, f"See {url}."
justification_osps_br_02_02
justification_osps_br_02_02() -> tuple[str, str]

Associate every release asset with a unique identifier.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_osps_br_02_02(self) -> tuple[str, str]:
    """Associate every release asset with a unique identifier."""
    config_url = RemoteVersionController.I.file_url(
        PyprojectConfigFile.I.path(),
    )
    release_url = RemoteVersionController.I.file_url(
        ReleaseWorkflowConfigFile.I.path(),
    )
    deploy_url = RemoteVersionController.I.file_url(
        DeployWorkflowConfigFile.I.path(),
    )
    return self.STATUS_MET, f"See {config_url}, {release_url}, and {deploy_url}."
justification_osps_br_03_01
justification_osps_br_03_01() -> tuple[str, str]

Deliver official project channels exclusively over encryption.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_osps_br_03_01(self) -> tuple[str, str]:
    """Deliver official project channels exclusively over encryption."""
    config_url = RemoteVersionController.I.file_url(
        PyprojectConfigFile.I.path(),
    )
    repo_url = RemoteVersionController.I.repo_url()
    docs_url = DocsBuilder.I.documentation_url()
    releases_url = RemoteVersionController.I.releases_url()
    return (
        self.STATUS_MET,
        f"See {config_url}, {repo_url}, {docs_url}, and {releases_url}.",
    )
justification_osps_br_03_02
justification_osps_br_03_02() -> tuple[str, str]

Show that distribution uses cryptographically authenticated channels.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_osps_br_03_02(self) -> tuple[str, str]:
    """Show that distribution uses cryptographically authenticated channels."""
    url = RemoteVersionController.I.releases_url()
    return self.STATUS_MET, f"See {url}."
justification_osps_br_04_01
justification_osps_br_04_01() -> tuple[str, str]

Describe functional and security modifications in every release.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_osps_br_04_01(self) -> tuple[str, str]:
    """Describe functional and security modifications in every release."""
    release_url = RemoteVersionController.I.file_url(
        ReleaseWorkflowConfigFile.I.path(),
    )
    return self.STATUS_MET, f"See {release_url}."
justification_osps_br_05_01
justification_osps_br_05_01() -> tuple[str, str]

Show that pipelines use standard dependency management tools.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_osps_br_05_01(self) -> tuple[str, str]:
    """Show that pipelines use standard dependency management tools."""
    health_url = RemoteVersionController.I.file_url(
        HealthCheckWorkflowConfigFile.I.path(),
    )
    documentation_url = RemoteVersionController.I.file_url(
        DocumentationWorkflowConfigFile.I.path(),
    )
    return self.STATUS_MET, f"See {health_url} and {documentation_url}."
justification_osps_br_06_01
justification_osps_br_06_01() -> tuple[str, str]

Assess release artifact signing.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_osps_br_06_01(self) -> tuple[str, str]:
    """Assess release artifact signing."""
    release_url = RemoteVersionController.I.file_url(
        ReleaseWorkflowConfigFile.I.path(),
    )
    deploy_url = RemoteVersionController.I.file_url(
        DeployWorkflowConfigFile.I.path(),
    )
    return self.STATUS_UNMET, f"See {release_url} and {deploy_url}."
justification_osps_br_07_01
justification_osps_br_07_01() -> tuple[str, str]

Show that mechanisms prevent accidental credential commits.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_osps_br_07_01(self) -> tuple[str, str]:
    """Show that mechanisms prevent accidental credential commits."""
    hooks_url = RemoteVersionController.I.file_url(
        VersionControlHookManagerConfigFile.I.path(),
    )
    health_url = RemoteVersionController.I.file_url(
        HealthCheckWorkflowConfigFile.I.path(),
    )
    return self.STATUS_MET, f"See {hooks_url} and {health_url}."
justification_osps_do_01_01
justification_osps_do_01_01() -> tuple[str, str]

Provide guides for all basic functionality.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_osps_do_01_01(self) -> tuple[str, str]:
    """Provide guides for all basic functionality."""
    readme_url = RemoteVersionController.I.file_url(
        ReadmeConfigFile.I.path(),
    )
    docs_url = DocsBuilder.I.documentation_url()
    return self.STATUS_MET, f"See {readme_url} and {docs_url}."
justification_osps_do_02_01
justification_osps_do_02_01() -> tuple[str, str]

Show that defect reporting is documented.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_osps_do_02_01(self) -> tuple[str, str]:
    """Show that defect reporting is documented."""
    url = RemoteVersionController.I.file_url(ContributingConfigFile.I.path())
    return self.STATUS_MET, f"See {url}."
justification_osps_do_03_02
justification_osps_do_03_02() -> tuple[str, str]

Assess release-author verification instructions.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_osps_do_03_02(self) -> tuple[str, str]:
    """Assess release-author verification instructions."""
    settings_url = RemoteVersionController.I.file_url(
        RepositorySettingsConfigFile.I.path(),
    )
    configure_url = RemoteVersionController.I.file_url(
        ConfigureRepositoryConfigFile.I.path(),
    )
    release_url = RemoteVersionController.I.file_url(
        ReleaseWorkflowConfigFile.I.path(),
    )
    deploy_url = RemoteVersionController.I.file_url(
        DeployWorkflowConfigFile.I.path(),
    )
    return (
        self.STATUS_MET,
        f"See {settings_url}, {configure_url}, {release_url}, and {deploy_url}.",
    )
justification_osps_do_04_01
justification_osps_do_04_01() -> tuple[str, str]

Document the scope and duration of release support.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_osps_do_04_01(self) -> tuple[str, str]:
    """Document the scope and duration of release support."""
    security_url = RemoteVersionController.I.file_url(
        SecurityConfigFile.I.path(),
    )
    return self.STATUS_MET, f"See {security_url}."
justification_osps_do_05_01
justification_osps_do_05_01() -> tuple[str, str]

Show that the end of security support is documented.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_osps_do_05_01(self) -> tuple[str, str]:
    """Show that the end of security support is documented."""
    url = RemoteVersionController.I.file_url(SecurityConfigFile.I.path())
    return self.STATUS_MET, f"See {url}."
justification_osps_do_06_01
justification_osps_do_06_01() -> tuple[str, str]

Document how dependencies are selected, obtained, and tracked.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_osps_do_06_01(self) -> tuple[str, str]:
    """Document how dependencies are selected, obtained, and tracked."""
    config_url = RemoteVersionController.I.file_url(PyprojectConfigFile.I.path())
    lock_url = RemoteVersionController.I.file_url(PackageManager.I.lock_file())
    hooks_url = RemoteVersionController.I.file_url(
        VersionControlHookManagerConfigFile.I.path(),
    )
    return self.STATUS_MET, f"See {config_url}, {lock_url}, and {hooks_url}."
justification_osps_do_07_01
justification_osps_do_07_01() -> tuple[str, str]

Document build instructions and required dependencies.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_osps_do_07_01(self) -> tuple[str, str]:
    """Document build instructions and required dependencies."""
    config_url = RemoteVersionController.I.file_url(
        PyprojectConfigFile.I.path(),
    )
    deploy_url = RemoteVersionController.I.file_url(
        DeployWorkflowConfigFile.I.path(),
    )
    return self.STATUS_MET, f"See {config_url} and {deploy_url}."
justification_osps_gv_01_01
justification_osps_gv_01_01() -> tuple[str, str]

Assess the inventory of members with sensitive-resource access.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_osps_gv_01_01(self) -> tuple[str, str]:
    """Assess the inventory of members with sensitive-resource access."""
    config_url = RemoteVersionController.I.file_url(
        PyprojectConfigFile.I.path(),
    )
    owners_url = RemoteVersionController.I.file_url(
        CodeownersConfigFile.I.path(),
    )
    return self.STATUS_MET, f"See {config_url} and {owners_url}."
justification_osps_gv_01_02
justification_osps_gv_01_02() -> tuple[str, str]

Describe project members' roles and responsibilities.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_osps_gv_01_02(self) -> tuple[str, str]:
    """Describe project members' roles and responsibilities."""
    config_url = RemoteVersionController.I.file_url(
        PyprojectConfigFile.I.path(),
    )
    owners_url = RemoteVersionController.I.file_url(
        CodeownersConfigFile.I.path(),
    )
    return self.STATUS_MET, f"See {config_url} and {owners_url}."
justification_osps_gv_02_01
justification_osps_gv_02_01() -> tuple[str, str]

Provide public discussions of proposed changes and usage issues.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_osps_gv_02_01(self) -> tuple[str, str]:
    """Provide public discussions of proposed changes and usage issues."""
    issues_url = RemoteVersionController.I.issues_url()
    repo_url = RemoteVersionController.I.repo_url()
    return self.STATUS_MET, f"See {issues_url} and {repo_url}."
justification_osps_gv_03_01
justification_osps_gv_03_01() -> tuple[str, str]

Show that the contribution process is documented.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_osps_gv_03_01(self) -> tuple[str, str]:
    """Show that the contribution process is documented."""
    url = RemoteVersionController.I.file_url(ContributingConfigFile.I.path())
    return self.STATUS_MET, f"See {url}."
justification_osps_gv_03_02
justification_osps_gv_03_02() -> tuple[str, str]

Show that acceptable contribution requirements are documented.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_osps_gv_03_02(self) -> tuple[str, str]:
    """Show that acceptable contribution requirements are documented."""
    url = RemoteVersionController.I.file_url(ContributingConfigFile.I.path())
    return self.STATUS_MET, f"See {url}."
justification_osps_le_01_01
justification_osps_le_01_01() -> tuple[str, str]

Require legal authorization for code contributions.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_osps_le_01_01(self) -> tuple[str, str]:
    """Require legal authorization for code contributions."""
    terms_url = (
        "https://docs.github.com/en/site-policy/github-terms/"
        "github-terms-of-service#d-user-generated-content"
    )
    repo_url = RemoteVersionController.I.repo_url()
    return self.STATUS_MET, f"See {terms_url} and {repo_url}."
justification_osps_le_02_01
justification_osps_le_02_01() -> tuple[str, str]

Show that the source license meets the open-source definition.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_osps_le_02_01(self) -> tuple[str, str]:
    """Show that the source license meets the open-source definition."""
    url = RemoteVersionController.I.file_url(LicenseConfigFile.I.path())
    return self.STATUS_MET, f"See {url}."
justification_osps_le_02_02
justification_osps_le_02_02() -> tuple[str, str]

Distribute release assets under open-source licenses.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_osps_le_02_02(self) -> tuple[str, str]:
    """Distribute release assets under open-source licenses."""
    license_url = RemoteVersionController.I.file_url(
        LicenseConfigFile.I.path(),
    )
    config_url = RemoteVersionController.I.file_url(
        PyprojectConfigFile.I.path(),
    )
    release_url = RemoteVersionController.I.file_url(
        ReleaseWorkflowConfigFile.I.path(),
    )
    deploy_url = RemoteVersionController.I.file_url(
        DeployWorkflowConfigFile.I.path(),
    )
    return (
        self.STATUS_MET,
        f"See {license_url}, {config_url}, {release_url}, and {deploy_url}.",
    )
justification_osps_le_03_01
justification_osps_le_03_01() -> tuple[str, str]

Show that source licensing is kept in a standard repository file.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_osps_le_03_01(self) -> tuple[str, str]:
    """Show that source licensing is kept in a standard repository file."""
    url = RemoteVersionController.I.file_url(LicenseConfigFile.I.path())
    return self.STATUS_MET, f"See {url}."
justification_osps_le_03_02
justification_osps_le_03_02() -> tuple[str, str]

Include licenses with released assets.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_osps_le_03_02(self) -> tuple[str, str]:
    """Include licenses with released assets."""
    config_url = RemoteVersionController.I.file_url(
        PyprojectConfigFile.I.path(),
    )
    deploy_url = RemoteVersionController.I.file_url(
        DeployWorkflowConfigFile.I.path(),
    )
    return self.STATUS_MET, f"See {config_url} and {deploy_url}."
justification_osps_qa_01_01
justification_osps_qa_01_01() -> tuple[str, str]

Make the source repository publicly readable.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_osps_qa_01_01(self) -> tuple[str, str]:
    """Make the source repository publicly readable."""
    repo_url = RemoteVersionController.I.repo_url()
    return self.STATUS_MET, f"See {repo_url}."
justification_osps_qa_01_02
justification_osps_qa_01_02() -> tuple[str, str]

Assess access to source history and authorship.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_osps_qa_01_02(self) -> tuple[str, str]:
    """Assess access to source history and authorship."""
    repo_url = RemoteVersionController.I.repo_url()
    return self.STATUS_MET, f"See {repo_url}."
justification_osps_qa_02_01
justification_osps_qa_02_01() -> tuple[str, str]

Show that direct language dependencies are listed.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_osps_qa_02_01(self) -> tuple[str, str]:
    """Show that direct language dependencies are listed."""
    url = RemoteVersionController.I.file_url(PyprojectConfigFile.I.path())
    return self.STATUS_MET, f"See {url}."
justification_osps_qa_03_01
justification_osps_qa_03_01() -> tuple[str, str]

Require automated status checks before merging.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_osps_qa_03_01(self) -> tuple[str, str]:
    """Require automated status checks before merging."""
    settings_url = RemoteVersionController.I.file_url(
        RepositorySettingsConfigFile.I.path(),
    )
    configure_url = RemoteVersionController.I.file_url(
        ConfigureRepositoryConfigFile.I.path(),
    )
    health_url = RemoteVersionController.I.file_url(
        HealthCheckWorkflowConfigFile.I.path(),
    )
    return (
        self.STATUS_MET,
        f"See {settings_url}, {configure_url}, and {health_url}.",
    )
justification_osps_qa_04_01
justification_osps_qa_04_01() -> tuple[str, str]

Assess documentation of project code repositories.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_osps_qa_04_01(self) -> tuple[str, str]:
    """Assess documentation of project code repositories."""
    url = RemoteVersionController.I.repo_url()
    return self.STATUS_NA, f"See {url}."
justification_osps_qa_04_02
justification_osps_qa_04_02() -> tuple[str, str]

Assess security requirements across release repositories.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_osps_qa_04_02(self) -> tuple[str, str]:
    """Assess security requirements across release repositories."""
    repo_url = RemoteVersionController.I.repo_url()
    release_url = RemoteVersionController.I.file_url(
        ReleaseWorkflowConfigFile.I.path(),
    )
    return self.STATUS_NA, f"See {repo_url} and {release_url}."
justification_osps_qa_05_01
justification_osps_qa_05_01() -> tuple[str, str]

Keep generated executables out of version control.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_osps_qa_05_01(self) -> tuple[str, str]:
    """Keep generated executables out of version control."""
    ignore_url = RemoteVersionController.I.file_url(
        VersionControllerIgnoreConfigFile.I.path(),
    )
    return self.STATUS_MET, f"See {ignore_url}."
justification_osps_qa_05_02
justification_osps_qa_05_02() -> tuple[str, str]

Keep unreviewable binary artifacts out of version control.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_osps_qa_05_02(self) -> tuple[str, str]:
    """Keep unreviewable binary artifacts out of version control."""
    ignore_url = RemoteVersionController.I.file_url(
        VersionControllerIgnoreConfigFile.I.path(),
    )
    return self.STATUS_MET, f"See {ignore_url}."
justification_osps_qa_06_01
justification_osps_qa_06_01() -> tuple[str, str]

Require automated tests before accepting commits.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_osps_qa_06_01(self) -> tuple[str, str]:
    """Require automated tests before accepting commits."""
    settings_url = RemoteVersionController.I.file_url(
        RepositorySettingsConfigFile.I.path(),
    )
    configure_url = RemoteVersionController.I.file_url(
        ConfigureRepositoryConfigFile.I.path(),
    )
    health_url = RemoteVersionController.I.file_url(
        HealthCheckWorkflowConfigFile.I.path(),
    )
    return (
        self.STATUS_MET,
        f"See {settings_url}, {configure_url}, and {health_url}.",
    )
justification_osps_qa_06_02
justification_osps_qa_06_02() -> tuple[str, str]

Document when and how tests run.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_osps_qa_06_02(self) -> tuple[str, str]:
    """Document when and how tests run."""
    contributing_url = RemoteVersionController.I.file_url(
        ContributingConfigFile.I.path(),
    )
    health_url = RemoteVersionController.I.file_url(
        HealthCheckWorkflowConfigFile.I.path(),
    )
    return self.STATUS_MET, f"See {contributing_url} and {health_url}."
justification_osps_qa_06_03
justification_osps_qa_06_03() -> tuple[str, str]

Document a policy to add or update tests for major changes.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_osps_qa_06_03(self) -> tuple[str, str]:
    """Document a policy to add or update tests for major changes."""
    contributing_url = RemoteVersionController.I.file_url(
        ContributingConfigFile.I.path(),
    )
    health_url = RemoteVersionController.I.file_url(
        HealthCheckWorkflowConfigFile.I.path(),
    )
    return self.STATUS_MET, f"See {contributing_url} and {health_url}."
justification_osps_qa_07_01
justification_osps_qa_07_01() -> tuple[str, str]

Assess independent human approval of changes.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_osps_qa_07_01(self) -> tuple[str, str]:
    """Assess independent human approval of changes."""
    settings_url = RemoteVersionController.I.file_url(
        RepositorySettingsConfigFile.I.path(),
    )
    configure_url = RemoteVersionController.I.file_url(
        ConfigureRepositoryConfigFile.I.path(),
    )
    return self.STATUS_MET, f"See {settings_url} and {configure_url}."
justification_osps_sa_02_01
justification_osps_sa_02_01() -> tuple[str, str]

Document every released external interface and its inputs and outputs.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_osps_sa_02_01(self) -> tuple[str, str]:
    """Document every released external interface and its inputs and outputs."""
    docs_url = DocsBuilder.I.documentation_url()
    return self.STATUS_MET, f"See {docs_url}."
justification_osps_vm_01_01
justification_osps_vm_01_01() -> tuple[str, str]

Assess coordinated vulnerability disclosure.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_osps_vm_01_01(self) -> tuple[str, str]:
    """Assess coordinated vulnerability disclosure."""
    security_url = RemoteVersionController.I.file_url(
        SecurityConfigFile.I.path(),
    )
    return self.STATUS_MET, f"See {security_url}."
justification_osps_vm_02_01
justification_osps_vm_02_01() -> tuple[str, str]

Show that security reporting contacts are documented.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_osps_vm_02_01(self) -> tuple[str, str]:
    """Show that security reporting contacts are documented."""
    url = RemoteVersionController.I.file_url(SecurityConfigFile.I.path())
    return self.STATUS_MET, f"See {url}."
justification_osps_vm_03_01
justification_osps_vm_03_01() -> tuple[str, str]

Provide a private channel for vulnerability reporting.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_osps_vm_03_01(self) -> tuple[str, str]:
    """Provide a private channel for vulnerability reporting."""
    security_url = RemoteVersionController.I.file_url(
        SecurityConfigFile.I.path(),
    )
    return self.STATUS_MET, f"See {security_url}."
justification_osps_vm_05_01
justification_osps_vm_05_01() -> tuple[str, str]

Assess dependency and license remediation policy.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_osps_vm_05_01(self) -> tuple[str, str]:
    """Assess dependency and license remediation policy."""
    hooks_url = RemoteVersionController.I.file_url(
        VersionControlHookManagerConfigFile.I.path(),
    )
    dependencies_url = RemoteVersionController.I.file_url(
        DependencyBotConfigFile.I.path(),
    )
    configure_url = RemoteVersionController.I.file_url(
        ConfigureRepositoryConfigFile.I.path(),
    )
    health_url = RemoteVersionController.I.file_url(
        HealthCheckWorkflowConfigFile.I.path(),
    )
    return (
        self.STATUS_MET,
        f"See {hooks_url}, {dependencies_url}, {configure_url}, and {health_url}.",
    )
justification_osps_vm_05_02
justification_osps_vm_05_02() -> tuple[str, str]

Document a policy to resolve dependency violations before release.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_osps_vm_05_02(self) -> tuple[str, str]:
    """Document a policy to resolve dependency violations before release."""
    hooks_url = RemoteVersionController.I.file_url(
        VersionControlHookManagerConfigFile.I.path(),
    )
    health_url = RemoteVersionController.I.file_url(
        HealthCheckWorkflowConfigFile.I.path(),
    )
    release_url = RemoteVersionController.I.file_url(
        ReleaseWorkflowConfigFile.I.path(),
    )
    return self.STATUS_MET, f"See {hooks_url}, {health_url}, and {release_url}."
justification_osps_vm_05_03
justification_osps_vm_05_03() -> tuple[str, str]

Block changes that violate dependency-security policy.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_osps_vm_05_03(self) -> tuple[str, str]:
    """Block changes that violate dependency-security policy."""
    hooks_url = RemoteVersionController.I.file_url(
        VersionControlHookManagerConfigFile.I.path(),
    )
    health_url = RemoteVersionController.I.file_url(
        HealthCheckWorkflowConfigFile.I.path(),
    )
    settings_url = RemoteVersionController.I.file_url(
        RepositorySettingsConfigFile.I.path(),
    )
    configure_url = RemoteVersionController.I.file_url(
        ConfigureRepositoryConfigFile.I.path(),
    )
    return (
        self.STATUS_MET,
        f"See {hooks_url}, {health_url}, {settings_url}, and {configure_url}.",
    )
justification_osps_vm_06_01
justification_osps_vm_06_01() -> tuple[str, str]

Assess static-analysis remediation policy.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_osps_vm_06_01(self) -> tuple[str, str]:
    """Assess static-analysis remediation policy."""
    hooks_url = RemoteVersionController.I.file_url(
        VersionControlHookManagerConfigFile.I.path(),
    )
    health_url = RemoteVersionController.I.file_url(
        HealthCheckWorkflowConfigFile.I.path(),
    )
    return self.STATUS_MET, f"See {hooks_url} and {health_url}."
justification_osps_vm_06_02
justification_osps_vm_06_02() -> tuple[str, str]

Block changes that violate documented security-weakness policy.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_osps_vm_06_02(self) -> tuple[str, str]:
    """Block changes that violate documented security-weakness policy."""
    hooks_url = RemoteVersionController.I.file_url(
        VersionControlHookManagerConfigFile.I.path(),
    )
    settings_url = RemoteVersionController.I.file_url(
        RepositorySettingsConfigFile.I.path(),
    )
    configure_url = RemoteVersionController.I.file_url(
        ConfigureRepositoryConfigFile.I.path(),
    )
    health_url = RemoteVersionController.I.file_url(
        HealthCheckWorkflowConfigFile.I.path(),
    )
    return (
        self.STATUS_MET,
        f"See {hooks_url}, {settings_url}, {configure_url}, and {health_url}.",
    )
justification_regression_tests_added50
justification_regression_tests_added50() -> tuple[str, str]

Assess regression tests for bug fixes.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_regression_tests_added50(self) -> tuple[str, str]:
    """Assess regression tests for bug fixes."""
    contributing_url = RemoteVersionController.I.file_url(
        ContributingConfigFile.I.path(),
    )
    report_url = RemoteVersionController.I.file_url(BugReportConfigFile.I.path())
    template_url = RemoteVersionController.I.file_url(
        PullRequestTemplateConfigFile.I.path(),
    )
    config_url = RemoteVersionController.I.file_url(
        PyprojectConfigFile.I.path(),
    )
    health_url = RemoteVersionController.I.file_url(
        HealthCheckWorkflowConfigFile.I.path(),
    )
    repo_url = RemoteVersionController.I.repo_url()
    return self.STATUS_MET, (
        f"See {contributing_url}, {report_url}, {template_url}, "
        f"{config_url}, {health_url}, and {repo_url}."
    )
justification_release_notes
justification_release_notes() -> tuple[str, str]

Explain major changes and upgrade impacts in release notes.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_release_notes(self) -> tuple[str, str]:
    """Explain major changes and upgrade impacts in release notes."""
    release_url = RemoteVersionController.I.file_url(
        ReleaseWorkflowConfigFile.I.path(),
    )
    return self.STATUS_MET, f"See {release_url}."
justification_release_notes_vulns
justification_release_notes_vulns() -> tuple[str, str]

Default to no publicly known project vulnerabilities; review per project.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_release_notes_vulns(self) -> tuple[str, str]:
    """Default to no publicly known project vulnerabilities; review per project."""
    return (
        self.STATUS_NA,
        "No publicly known project vulnerabilities were found",
    )
justification_repo_distributed
justification_repo_distributed() -> tuple[str, str]

Show that the project uses distributed version control.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_repo_distributed(self) -> tuple[str, str]:
    """Show that the project uses distributed version control."""
    url = RemoteVersionController.I.repo_url()
    return self.STATUS_MET, f"See {url}."
justification_repo_interim
justification_repo_interim() -> tuple[str, str]

Share interim source changes for collaborative review.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_repo_interim(self) -> tuple[str, str]:
    """Share interim source changes for collaborative review."""
    contributing_url = RemoteVersionController.I.file_url(
        ContributingConfigFile.I.path(),
    )
    repo_url = RemoteVersionController.I.repo_url()
    health_url = RemoteVersionController.I.file_url(
        HealthCheckWorkflowConfigFile.I.path(),
    )
    return self.STATUS_MET, f"See {contributing_url}, {repo_url}, and {health_url}."
justification_repo_public
justification_repo_public() -> tuple[str, str]

Provide a publicly readable source repository.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_repo_public(self) -> tuple[str, str]:
    """Provide a publicly readable source repository."""
    repo_url = RemoteVersionController.I.repo_url()
    return self.STATUS_MET, f"See {repo_url}."
justification_repo_track
justification_repo_track() -> tuple[str, str]

Show that version control records what changed, who changed it, and when.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_repo_track(self) -> tuple[str, str]:
    """Show that version control records what changed, who changed it, and when."""
    url = RemoteVersionController.I.repo_url()
    return self.STATUS_MET, f"See {url}."
justification_report_archive
justification_report_archive() -> tuple[str, str]

Provide a public archive of reports and responses.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_report_archive(self) -> tuple[str, str]:
    """Provide a public archive of reports and responses."""
    issues_url = RemoteVersionController.I.issues_url()
    return self.STATUS_MET, f"See {issues_url}."
justification_report_process
justification_report_process() -> tuple[str, str]

Show that users have a documented way to report bugs.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_report_process(self) -> tuple[str, str]:
    """Show that users have a documented way to report bugs."""
    url = RemoteVersionController.I.file_url(ContributingConfigFile.I.path())
    return self.STATUS_MET, f"See {url}."
justification_report_responses
justification_report_responses() -> tuple[str, str]

Assess responsiveness to bug reports.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_report_responses(self) -> tuple[str, str]:
    """Assess responsiveness to bug reports."""
    url = RemoteVersionController.I.issues_url()
    return self.STATUS_MET, f"See {url}."
justification_report_tracker
justification_report_tracker() -> tuple[str, str]

Show that individual issues are tracked in an issue tracker.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_report_tracker(self) -> tuple[str, str]:
    """Show that individual issues are tracked in an issue tracker."""
    url = RemoteVersionController.I.issues_url()
    return self.STATUS_MET, f"See {url}."
justification_roles_responsibilities
justification_roles_responsibilities() -> tuple[str, str]

Document project roles and responsibilities.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_roles_responsibilities(self) -> tuple[str, str]:
    """Document project roles and responsibilities."""
    config_url = RemoteVersionController.I.file_url(
        PyprojectConfigFile.I.path(),
    )
    owners_url = RemoteVersionController.I.file_url(
        CodeownersConfigFile.I.path(),
    )
    return self.STATUS_MET, f"See {config_url} and {owners_url}."
justification_sites_https
justification_sites_https() -> tuple[str, str]

Show that project sites support HTTPS.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_sites_https(self) -> tuple[str, str]:
    """Show that project sites support HTTPS."""
    repo_url = RemoteVersionController.I.repo_url()
    docs_url = DocsBuilder.I.documentation_url()
    releases_url = RemoteVersionController.I.releases_url()
    return self.STATUS_MET, f"See {repo_url}, {docs_url}, and {releases_url}."
justification_sites_password_security
justification_sites_password_security() -> tuple[str, str]

Assess password security of project sites.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_sites_password_security(self) -> tuple[str, str]:
    """Assess password security of project sites."""
    repo_url = RemoteVersionController.I.repo_url()
    docs_url = DocsBuilder.I.documentation_url()
    releases_url = RemoteVersionController.I.releases_url()
    return self.STATUS_MET, f"See {repo_url}, {docs_url}, and {releases_url}."
justification_static_analysis
justification_static_analysis() -> tuple[str, str]

Show that static analysis runs before releases.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_static_analysis(self) -> tuple[str, str]:
    """Show that static analysis runs before releases."""
    hooks_url = RemoteVersionController.I.file_url(
        VersionControlHookManagerConfigFile.I.path(),
    )
    health_url = RemoteVersionController.I.file_url(
        HealthCheckWorkflowConfigFile.I.path(),
    )
    release_url = RemoteVersionController.I.file_url(
        ReleaseWorkflowConfigFile.I.path(),
    )
    return self.STATUS_MET, f"See {hooks_url}, {health_url}, and {release_url}."
justification_static_analysis_common_vulnerabilities
justification_static_analysis_common_vulnerabilities() -> (
    tuple[str, str]
)

Show that static analysis checks for common vulnerabilities.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_static_analysis_common_vulnerabilities(self) -> tuple[str, str]:
    """Show that static analysis checks for common vulnerabilities."""
    hooks_url = RemoteVersionController.I.file_url(
        VersionControlHookManagerConfigFile.I.path(),
    )
    health_url = RemoteVersionController.I.file_url(
        HealthCheckWorkflowConfigFile.I.path(),
    )
    return self.STATUS_MET, f"See {hooks_url} and {health_url}."
justification_static_analysis_fixed
justification_static_analysis_fixed() -> tuple[str, str]

Assess remediation of static-analysis findings.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_static_analysis_fixed(self) -> tuple[str, str]:
    """Assess remediation of static-analysis findings."""
    hooks_url = RemoteVersionController.I.file_url(
        VersionControlHookManagerConfigFile.I.path(),
    )
    health_url = RemoteVersionController.I.file_url(
        HealthCheckWorkflowConfigFile.I.path(),
    )
    release_url = RemoteVersionController.I.file_url(
        ReleaseWorkflowConfigFile.I.path(),
    )
    return self.STATUS_MET, f"See {hooks_url}, {health_url}, and {release_url}."
justification_static_analysis_often
justification_static_analysis_often() -> tuple[str, str]

Show that static analysis runs often.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_static_analysis_often(self) -> tuple[str, str]:
    """Show that static analysis runs often."""
    hooks_url = RemoteVersionController.I.file_url(
        VersionControlHookManagerConfigFile.I.path(),
    )
    health_url = RemoteVersionController.I.file_url(
        HealthCheckWorkflowConfigFile.I.path(),
    )
    return self.STATUS_MET, f"See {hooks_url} and {health_url}."
justification_test
justification_test() -> tuple[str, str]

Show that an automated test suite is used with a documented command.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_test(self) -> tuple[str, str]:
    """Show that an automated test suite is used with a documented command."""
    health_url = RemoteVersionController.I.file_url(
        HealthCheckWorkflowConfigFile.I.path(),
    )
    license_url = RemoteVersionController.I.file_url(LicenseConfigFile.I.path())
    return self.STATUS_MET, f"See {health_url} and {license_url}."
justification_test_branch_coverage80
justification_test_branch_coverage80() -> tuple[str, str]

Assess the 80 percent branch coverage criterion.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_test_branch_coverage80(self) -> tuple[str, str]:
    """Assess the 80 percent branch coverage criterion."""
    config_url = RemoteVersionController.I.file_url(
        PyprojectConfigFile.I.path(),
    )
    health_url = RemoteVersionController.I.file_url(
        HealthCheckWorkflowConfigFile.I.path(),
    )
    return self.STATUS_MET, f"See {config_url} and {health_url}."
justification_test_continuous_integration
justification_test_continuous_integration() -> (
    tuple[str, str]
)

Show that automated tests run as changes are integrated.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_test_continuous_integration(self) -> tuple[str, str]:
    """Show that automated tests run as changes are integrated."""
    url = RemoteVersionController.I.file_url(
        HealthCheckWorkflowConfigFile.I.path(),
    )
    return self.STATUS_MET, f"See {url}."
justification_test_invocation
justification_test_invocation() -> tuple[str, str]

Show that tests use a standard invocation for Python.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_test_invocation(self) -> tuple[str, str]:
    """Show that tests use a standard invocation for Python."""
    url = RemoteVersionController.I.file_url(
        HealthCheckWorkflowConfigFile.I.path(),
    )
    return self.STATUS_MET, f"See {url}."
justification_test_most
justification_test_most() -> tuple[str, str]

Test most functionality and inputs.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_test_most(self) -> tuple[str, str]:
    """Test most functionality and inputs."""
    config_url = RemoteVersionController.I.file_url(
        PyprojectConfigFile.I.path(),
    )
    health_url = RemoteVersionController.I.file_url(
        HealthCheckWorkflowConfigFile.I.path(),
    )
    return self.STATUS_MET, f"See {config_url} and {health_url}."
justification_test_policy
justification_test_policy() -> tuple[str, str]

Have a policy to add tests for major new functionality.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_test_policy(self) -> tuple[str, str]:
    """Have a policy to add tests for major new functionality."""
    contributing_url = RemoteVersionController.I.file_url(
        ContributingConfigFile.I.path(),
    )
    config_url = RemoteVersionController.I.file_url(
        PyprojectConfigFile.I.path(),
    )
    health_url = RemoteVersionController.I.file_url(
        HealthCheckWorkflowConfigFile.I.path(),
    )
    return (
        self.STATUS_MET,
        f"See {contributing_url}, {config_url}, and {health_url}.",
    )
justification_test_policy_mandated
justification_test_policy_mandated() -> tuple[str, str]

Assess the written requirement to add tests.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_test_policy_mandated(self) -> tuple[str, str]:
    """Assess the written requirement to add tests."""
    contributing_url = RemoteVersionController.I.file_url(
        ContributingConfigFile.I.path(),
    )
    hooks_url = RemoteVersionController.I.file_url(
        VersionControlHookManagerConfigFile.I.path(),
    )
    health_url = RemoteVersionController.I.file_url(
        HealthCheckWorkflowConfigFile.I.path(),
    )
    return (
        self.STATUS_MET,
        f"See {contributing_url}, {hooks_url}, and {health_url}.",
    )
justification_test_statement_coverage80
justification_test_statement_coverage80() -> (
    tuple[str, str]
)

Assess the 80 percent statement coverage criterion.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_test_statement_coverage80(self) -> tuple[str, str]:
    """Assess the 80 percent statement coverage criterion."""
    config_url = RemoteVersionController.I.file_url(
        PyprojectConfigFile.I.path(),
    )
    health_url = RemoteVersionController.I.file_url(
        HealthCheckWorkflowConfigFile.I.path(),
    )
    return self.STATUS_MET, f"See {config_url} and {health_url}."
justification_test_statement_coverage90
justification_test_statement_coverage90() -> (
    tuple[str, str]
)

Assess the 90 percent statement coverage criterion.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_test_statement_coverage90(self) -> tuple[str, str]:
    """Assess the 90 percent statement coverage criterion."""
    config_url = RemoteVersionController.I.file_url(
        PyprojectConfigFile.I.path(),
    )
    health_url = RemoteVersionController.I.file_url(
        HealthCheckWorkflowConfigFile.I.path(),
    )
    return self.STATUS_MET, f"See {config_url} and {health_url}."
justification_tests_are_added
justification_tests_are_added() -> tuple[str, str]

Add meaningful tests for the most recent major functionality changes.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_tests_are_added(self) -> tuple[str, str]:
    """Add meaningful tests for the most recent major functionality changes."""
    contributing_url = RemoteVersionController.I.file_url(
        ContributingConfigFile.I.path(),
    )
    template_url = RemoteVersionController.I.file_url(
        PullRequestTemplateConfigFile.I.path(),
    )
    config_url = RemoteVersionController.I.file_url(
        PyprojectConfigFile.I.path(),
    )
    health_url = RemoteVersionController.I.file_url(
        HealthCheckWorkflowConfigFile.I.path(),
    )
    repo_url = RemoteVersionController.I.repo_url()
    return self.STATUS_MET, (
        f"See {contributing_url}, {template_url}, {config_url}, "
        f"{health_url}, and {repo_url}."
    )
justification_tests_documented_added
justification_tests_documented_added() -> tuple[str, str]

Assess test requirements in contribution instructions.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_tests_documented_added(self) -> tuple[str, str]:
    """Assess test requirements in contribution instructions."""
    contributing_url = RemoteVersionController.I.file_url(
        ContributingConfigFile.I.path(),
    )
    template_url = RemoteVersionController.I.file_url(
        PullRequestTemplateConfigFile.I.path(),
    )
    return self.STATUS_MET, f"See {contributing_url} and {template_url}."
justification_two_person_review
justification_two_person_review() -> tuple[str, str]

Assess two-person review of proposed changes.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_two_person_review(self) -> tuple[str, str]:
    """Assess two-person review of proposed changes."""
    settings_url = RemoteVersionController.I.file_url(
        RepositorySettingsConfigFile.I.path(),
    )
    configure_url = RemoteVersionController.I.file_url(
        ConfigureRepositoryConfigFile.I.path(),
    )
    return self.STATUS_MET, f"See {settings_url} and {configure_url}."
justification_updateable_reused_components
justification_updateable_reused_components() -> (
    tuple[str, str]
)

Show that reused components can be identified and updated.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_updateable_reused_components(self) -> tuple[str, str]:
    """Show that reused components can be identified and updated."""
    config_url = RemoteVersionController.I.file_url(PyprojectConfigFile.I.path())
    lock_url = RemoteVersionController.I.file_url(PackageManager.I.lock_file())
    hooks_url = RemoteVersionController.I.file_url(
        VersionControlHookManagerConfigFile.I.path(),
    )
    return self.STATUS_MET, f"See {config_url}, {lock_url}, and {hooks_url}."
justification_version_semver
justification_version_semver() -> tuple[str, str]

Assess use of Semantic Versioning or Calendar Versioning.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_version_semver(self) -> tuple[str, str]:
    """Assess use of Semantic Versioning or Calendar Versioning."""
    config_url = RemoteVersionController.I.file_url(
        PyprojectConfigFile.I.path(),
    )
    release_url = RemoteVersionController.I.file_url(
        ReleaseWorkflowConfigFile.I.path(),
    )
    return self.STATUS_MET, f"See {config_url} and {release_url}."
justification_version_tags
justification_version_tags() -> tuple[str, str]

Show that releases are identified by version-control tags.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_version_tags(self) -> tuple[str, str]:
    """Show that releases are identified by version-control tags."""
    url = RemoteVersionController.I.file_url(
        ReleaseWorkflowConfigFile.I.path(),
    )
    return self.STATUS_MET, f"See {url}."
justification_version_tags_signed
justification_version_tags_signed() -> tuple[str, str]

Assess cryptographic signing of version tags.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_version_tags_signed(self) -> tuple[str, str]:
    """Assess cryptographic signing of version tags."""
    url = RemoteVersionController.I.file_url(ReleaseWorkflowConfigFile.I.path())
    return self.STATUS_UNMET, f"See {url}."
justification_version_unique
justification_version_unique() -> tuple[str, str]

Show that releases have unique version identifiers.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_version_unique(self) -> tuple[str, str]:
    """Show that releases have unique version identifiers."""
    url = RemoteVersionController.I.file_url(
        ReleaseWorkflowConfigFile.I.path(),
    )
    return self.STATUS_MET, f"See {url}."
justification_vulnerabilities_critical_fixed
justification_vulnerabilities_critical_fixed() -> (
    tuple[str, str]
)

Assess remediation of critical vulnerabilities.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_vulnerabilities_critical_fixed(self) -> tuple[str, str]:
    """Assess remediation of critical vulnerabilities."""
    security_url = RemoteVersionController.I.file_url(SecurityConfigFile.I.path())
    hooks_url = RemoteVersionController.I.file_url(
        VersionControlHookManagerConfigFile.I.path(),
    )
    health_url = RemoteVersionController.I.file_url(
        HealthCheckWorkflowConfigFile.I.path(),
    )
    release_url = RemoteVersionController.I.file_url(
        ReleaseWorkflowConfigFile.I.path(),
    )
    return (
        self.STATUS_MET,
        f"See {security_url}, {hooks_url}, {health_url}, and {release_url}.",
    )
justification_vulnerabilities_fixed_60_days
justification_vulnerabilities_fixed_60_days() -> (
    tuple[str, str]
)

Assess the 60-day vulnerability remediation criterion.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_vulnerabilities_fixed_60_days(self) -> tuple[str, str]:
    """Assess the 60-day vulnerability remediation criterion."""
    security_url = RemoteVersionController.I.file_url(SecurityConfigFile.I.path())
    hooks_url = RemoteVersionController.I.file_url(
        VersionControlHookManagerConfigFile.I.path(),
    )
    health_url = RemoteVersionController.I.file_url(
        HealthCheckWorkflowConfigFile.I.path(),
    )
    release_url = RemoteVersionController.I.file_url(
        ReleaseWorkflowConfigFile.I.path(),
    )
    return (
        self.STATUS_MET,
        f"See {security_url}, {hooks_url}, {health_url}, and {release_url}.",
    )
justification_vulnerability_report_private
justification_vulnerability_report_private() -> (
    tuple[str, str]
)

Support private reports over encrypted channels.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_vulnerability_report_private(self) -> tuple[str, str]:
    """Support private reports over encrypted channels."""
    security_url = RemoteVersionController.I.file_url(
        SecurityConfigFile.I.path(),
    )
    return self.STATUS_MET, f"See {security_url}."
justification_vulnerability_report_process
justification_vulnerability_report_process() -> (
    tuple[str, str]
)

Show that the vulnerability reporting process is published.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_vulnerability_report_process(self) -> tuple[str, str]:
    """Show that the vulnerability reporting process is published."""
    url = RemoteVersionController.I.file_url(SecurityConfigFile.I.path())
    return self.STATUS_MET, f"See {url}."
justification_vulnerability_report_response
justification_vulnerability_report_response() -> (
    tuple[str, str]
)

Assess the 14-day initial vulnerability response criterion.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_vulnerability_report_response(self) -> tuple[str, str]:
    """Assess the 14-day initial vulnerability response criterion."""
    url = RemoteVersionController.I.file_url(SecurityConfigFile.I.path())
    return self.STATUS_MET, f"See {url}."
justification_vulnerability_response_process
justification_vulnerability_response_process() -> (
    tuple[str, str]
)

Show that the vulnerability response process is documented.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_vulnerability_response_process(self) -> tuple[str, str]:
    """Show that the vulnerability response process is documented."""
    url = RemoteVersionController.I.file_url(SecurityConfigFile.I.path())
    return self.STATUS_MET, f"See {url}."
justification_warnings
justification_warnings() -> tuple[str, str]

Show that tools are enabled to detect code quality problems.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_warnings(self) -> tuple[str, str]:
    """Show that tools are enabled to detect code quality problems."""
    url = RemoteVersionController.I.file_url(
        VersionControlHookManagerConfigFile.I.path(),
    )
    return self.STATUS_MET, f"See {url}."
justification_warnings_fixed
justification_warnings_fixed() -> tuple[str, str]

Address warnings reported by configured checks.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_warnings_fixed(self) -> tuple[str, str]:
    """Address warnings reported by configured checks."""
    hooks_url = RemoteVersionController.I.file_url(
        VersionControlHookManagerConfigFile.I.path(),
    )
    health_url = RemoteVersionController.I.file_url(
        HealthCheckWorkflowConfigFile.I.path(),
    )
    release_url = RemoteVersionController.I.file_url(
        ReleaseWorkflowConfigFile.I.path(),
    )
    return self.STATUS_MET, f"See {hooks_url}, {health_url}, and {release_url}."
justification_warnings_strict
justification_warnings_strict() -> tuple[str, str]

Show that warning checks are configured strictly.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justification_warnings_strict(self) -> tuple[str, str]:
    """Show that warning checks are configured strictly."""
    config_url = RemoteVersionController.I.file_url(PyprojectConfigFile.I.path())
    hooks_url = RemoteVersionController.I.file_url(
        VersionControlHookManagerConfigFile.I.path(),
    )
    return self.STATUS_MET, f"See {config_url} and {hooks_url}."
justifications
justifications() -> (
    tuple[Callable[[], tuple[str, str]], ...]
)

Return the registered status-and-justification methods.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
def justifications(self) -> tuple[Callable[[], tuple[str, str]], ...]:
    """Return the registered status-and-justification methods."""
    return (
        self.justification_accessibility_best_practices,
        self.justification_automated_integration_testing,
        self.justification_build,
        self.justification_build_common_tools,
        self.justification_build_floss_tools,
        self.justification_build_non_recursive,
        self.justification_build_preserve_debug,
        self.justification_build_repeatable,
        self.justification_build_reproducible,
        self.justification_build_standard_variables,
        self.justification_code_of_conduct,
        self.justification_code_review_standards,
        self.justification_coding_standards,
        self.justification_coding_standards_enforced,
        self.justification_contribution,
        self.justification_contribution_requirements,
        self.justification_copyright_per_file,
        self.justification_crypto_call,
        self.justification_crypto_certificate_verification,
        self.justification_crypto_floss,
        self.justification_crypto_keylength,
        self.justification_crypto_password_storage,
        self.justification_crypto_pfs,
        self.justification_crypto_published,
        self.justification_crypto_random,
        self.justification_crypto_tls12,
        self.justification_crypto_used_network,
        self.justification_crypto_verification_private,
        self.justification_crypto_weaknesses,
        self.justification_crypto_working,
        self.justification_dependency_monitoring,
        self.justification_description_good,
        self.justification_delivery_mitm,
        self.justification_delivery_unsigned,
        self.justification_discussion,
        self.justification_documentation_achievements,
        self.justification_documentation_basics,
        self.justification_documentation_current,
        self.justification_documentation_interface,
        self.justification_documentation_quick_start,
        self.justification_dynamic_analysis,
        self.justification_dynamic_analysis_enable_assertions,
        self.justification_dynamic_analysis_fixed,
        self.justification_dynamic_analysis_unsafe,
        self.justification_english,
        self.justification_enhancement_responses,
        self.justification_external_dependencies,
        self.justification_floss_license,
        self.justification_floss_license_osi,
        self.justification_governance,
        self.justification_installation_common,
        self.justification_installation_development_quick,
        self.justification_installation_standard_variables,
        self.justification_interact,
        self.justification_interfaces_current,
        self.justification_know_common_errors,
        self.justification_know_secure_design,
        self.justification_license_location,
        self.justification_license_per_file,
        self.justification_maintained,
        self.justification_no_leaked_credentials,
        self.justification_osps_ac_01_01,
        self.justification_osps_ac_02_01,
        self.justification_osps_ac_03_01,
        self.justification_osps_ac_03_02,
        self.justification_osps_ac_04_01,
        self.justification_osps_ac_04_02,
        self.justification_osps_br_01_01,
        self.justification_osps_br_01_03,
        self.justification_osps_br_01_04,
        self.justification_osps_br_02_01,
        self.justification_osps_br_02_02,
        self.justification_osps_br_03_01,
        self.justification_osps_br_03_02,
        self.justification_osps_br_04_01,
        self.justification_osps_br_05_01,
        self.justification_osps_br_06_01,
        self.justification_osps_br_07_01,
        self.justification_osps_do_01_01,
        self.justification_osps_do_02_01,
        self.justification_osps_do_03_02,
        self.justification_osps_do_04_01,
        self.justification_osps_do_05_01,
        self.justification_osps_do_06_01,
        self.justification_osps_do_07_01,
        self.justification_osps_gv_01_01,
        self.justification_osps_gv_01_02,
        self.justification_osps_gv_02_01,
        self.justification_osps_gv_03_01,
        self.justification_osps_gv_03_02,
        self.justification_osps_le_01_01,
        self.justification_osps_le_02_01,
        self.justification_osps_le_02_02,
        self.justification_osps_le_03_01,
        self.justification_osps_le_03_02,
        self.justification_osps_qa_01_01,
        self.justification_osps_qa_01_02,
        self.justification_osps_qa_02_01,
        self.justification_osps_qa_03_01,
        self.justification_osps_qa_04_01,
        self.justification_osps_qa_04_02,
        self.justification_osps_qa_05_01,
        self.justification_osps_qa_05_02,
        self.justification_osps_qa_06_01,
        self.justification_osps_qa_06_02,
        self.justification_osps_qa_06_03,
        self.justification_osps_qa_07_01,
        self.justification_osps_sa_02_01,
        self.justification_osps_vm_01_01,
        self.justification_osps_vm_02_01,
        self.justification_osps_vm_03_01,
        self.justification_osps_vm_05_01,
        self.justification_osps_vm_05_02,
        self.justification_osps_vm_05_03,
        self.justification_osps_vm_06_01,
        self.justification_osps_vm_06_02,
        self.justification_regression_tests_added50,
        self.justification_release_notes,
        self.justification_release_notes_vulns,
        self.justification_repo_distributed,
        self.justification_repo_interim,
        self.justification_repo_public,
        self.justification_repo_track,
        self.justification_report_archive,
        self.justification_report_process,
        self.justification_report_responses,
        self.justification_report_tracker,
        self.justification_roles_responsibilities,
        self.justification_sites_https,
        self.justification_sites_password_security,
        self.justification_static_analysis,
        self.justification_static_analysis_common_vulnerabilities,
        self.justification_static_analysis_fixed,
        self.justification_static_analysis_often,
        self.justification_test,
        self.justification_test_branch_coverage80,
        self.justification_test_continuous_integration,
        self.justification_test_invocation,
        self.justification_test_most,
        self.justification_test_policy,
        self.justification_test_policy_mandated,
        self.justification_test_statement_coverage80,
        self.justification_test_statement_coverage90,
        self.justification_tests_are_added,
        self.justification_tests_documented_added,
        self.justification_two_person_review,
        self.justification_updateable_reused_components,
        self.justification_version_semver,
        self.justification_version_tags,
        self.justification_version_tags_signed,
        self.justification_version_unique,
        self.justification_vulnerabilities_critical_fixed,
        self.justification_vulnerabilities_fixed_60_days,
        self.justification_vulnerability_report_private,
        self.justification_vulnerability_report_process,
        self.justification_vulnerability_report_response,
        self.justification_vulnerability_response_process,
        self.justification_warnings,
        self.justification_warnings_fixed,
        self.justification_warnings_strict,
    )
parent_path
parent_path() -> Path

Return the project root.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
@override
def parent_path(self) -> Path:
    """Return the project root."""
    return Path()
stem
stem() -> str

Return .bestpractices.

Source code in src/pyrig_openssf/rig/configs/security/best_practices.py
@override
def stem(self) -> str:
    """Return `.bestpractices`."""
    return ".bestpractices"
security_insights

Configuration for OpenSSF Security Insights metadata.

SecurityInsightsConfigFile

Bases: YMLDictConfigFile

Generate Security Insights metadata using overridable project defaults.

administrator
administrator() -> dict[str, Any]

Build the primary administrator contact.

Source code in src/pyrig_openssf/rig/configs/security/security_insights.py
def administrator(self) -> dict[str, Any]:
    """Build the primary administrator contact."""
    return {
        "name": VersionController.I.repo_owner(),
        "primary": True,
        "email": PyprojectConfigFile.I.maintainer_email(),
        "social": RemoteVersionController.I.profile_url(),
    }
core_team
core_team() -> list[dict[str, Any]]

Build the core team contact list.

Source code in src/pyrig_openssf/rig/configs/security/security_insights.py
def core_team(self) -> list[dict[str, Any]]:
    """Build the core team contact list."""
    administrator: dict[str, Any] = self.administrator()
    maintainers = (
        {**maintainer, "primary": False}
        for maintainer in PyprojectConfigFile.I.maintainers()
        if maintainer["name"] != administrator["name"]
    )
    return [administrator, *maintainers]
header
header() -> dict[str, Any]

Generate the header metadata section.

Source code in src/pyrig_openssf/rig/configs/security/security_insights.py
def header(self) -> dict[str, Any]:
    """Generate the header metadata section."""
    existing_header = self.safe_load().get("header", {})
    today = datetime.now(UTC).date().isoformat()
    return {
        "last-reviewed": existing_header.get("last-reviewed", today),
        "last-updated": existing_header.get("last-updated", today),
        "schema-version": "2.2.0",
        "url": RemoteVersionController.I.file_url(self.path()),
    }
license
license() -> dict[str, Any]

Declare the repository license.

Source code in src/pyrig_openssf/rig/configs/security/security_insights.py
def license(self) -> dict[str, Any]:
    """Declare the repository license."""
    return {
        "url": RemoteVersionController.I.file_url(LicenseConfigFile.I.path()),
        "expression": LicenseConfigFile.I.spdx_identifier(),
    }
parent_path
parent_path() -> Path

Return the project root.

Source code in src/pyrig_openssf/rig/configs/security/security_insights.py
@override
def parent_path(self) -> Path:
    """Return the project root."""
    return Path()
project
project() -> dict[str, Any]

Build the project metadata section.

Source code in src/pyrig_openssf/rig/configs/security/security_insights.py
def project(self) -> dict[str, Any]:
    """Build the project metadata section."""
    return {
        "administrators": [self.administrator()],
        "name": PackageManager.I.project_name(),
        "homepage": RemoteVersionController.I.repo_url(),
        "repositories": [
            {
                "name": PackageManager.I.project_name(),
                "comment": PyprojectConfigFile.I.project_description(),
                "url": RemoteVersionController.I.repo_url(),
            },
        ],
        "documentation": self.project_documentation(),
        "vulnerability-reporting": self.vulnerability_reporting(),
    }
project_documentation
project_documentation() -> dict[str, Any]

Declare links to generated project documentation.

Source code in src/pyrig_openssf/rig/configs/security/security_insights.py
def project_documentation(self) -> dict[str, Any]:
    """Declare links to generated project documentation."""
    return {
        "detailed-guide": DocsBuilder.I.documentation_url(),
        "quickstart-guide": RemoteVersionController.I.file_url(
            ReadmeConfigFile.I.path(),
        ),
        "code-of-conduct": RemoteVersionController.I.file_url(
            CodeOfConductConfigFile.I.path(),
        ),
        "release-process": RemoteVersionController.I.file_url(
            ReleaseWorkflowConfigFile.I.path(),
        ),
        "support-policy": RemoteVersionController.I.file_url(
            SecurityConfigFile.I.path(),
        ),
    }
release
release() -> dict[str, Any]

Describe releases and distribution channels.

Source code in src/pyrig_openssf/rig/configs/security/security_insights.py
def release(self) -> dict[str, Any]:
    """Describe releases and distribution channels."""
    return {
        "automated-pipeline": True,
        "distribution-points": [
            {
                "uri": RemoteVersionController.I.releases_url(),
                "comment": "GitHub releases.",
            },
            {
                "uri": RemoteVersionController.I.file_url(
                    DeployWorkflowConfigFile.I.path(),
                ),
                "comment": "Describes additional distribution points.",
            },
        ],
        "changelog": RemoteVersionController.I.releases_url(),
    }
repository
repository() -> dict[str, Any]

Build the repository metadata section.

Source code in src/pyrig_openssf/rig/configs/security/security_insights.py
def repository(self) -> dict[str, Any]:
    """Build the repository metadata section."""
    return {
        "status": "active",
        "url": RemoteVersionController.I.repo_url(),
        "accepts-change-request": True,
        "accepts-automated-change-request": True,
        "bug-fixes-only": False,
        "no-third-party-packages": False,
        "core-team": self.core_team(),
        "license": self.license(),
        "documentation": self.repository_documentation(),
        "release": self.release(),
        "security": self.security(),
    }
repository_documentation
repository_documentation() -> dict[str, Any]

Declare links to generated repository policies.

Source code in src/pyrig_openssf/rig/configs/security/security_insights.py
def repository_documentation(self) -> dict[str, Any]:
    """Declare links to generated repository policies."""
    return {
        "contributing-guide": RemoteVersionController.I.file_url(
            ContributingConfigFile.I.path(),
        ),
        "review-policy": RemoteVersionController.I.file_url(
            ContributingConfigFile.I.path(),
        ),
        "security-policy": RemoteVersionController.I.file_url(
            SecurityConfigFile.I.path(),
        ),
    }
security
security() -> dict[str, Any]

Build the repository security section.

Source code in src/pyrig_openssf/rig/configs/security/security_insights.py
def security(self) -> dict[str, Any]:
    """Build the repository security section."""
    return {
        "champions": self.security_champions(),
        "assessments": {
            "self": {
                "name": "Security controls",
                "comment": (
                    "Changes require human review and are gated by automated "
                    "checks, including dependency vulnerability auditing, static "
                    "security analysis, and secret scanning."
                ),
                "evidence": RemoteVersionController.I.file_url(
                    HealthCheckWorkflowConfigFile.I.path(),
                ),
            },
        },
        "tools": sorted(self.security_tools(), key=itemgetter("name")),
    }
security_champions
security_champions() -> list[dict[str, Any]]

Build the security champion contact list.

Source code in src/pyrig_openssf/rig/configs/security/security_insights.py
def security_champions(self) -> list[dict[str, Any]]:
    """Build the security champion contact list."""
    return [self.administrator()]
security_tools
security_tools() -> list[dict[str, Any]]

Describe security tools and their integrations.

Source code in src/pyrig_openssf/rig/configs/security/security_insights.py
def security_tools(self) -> list[dict[str, Any]]:
    """Describe security tools and their integrations."""
    pyproject_url = RemoteVersionController.I.file_url(PyprojectConfigFile.I.path())
    pre_commit_url = RemoteVersionController.I.file_url(
        VersionControlHookManagerConfigFile.I.path(),
    )
    return [
        {
            "name": SecurityChecker.I.name(),
            "type": "SAST",
            "rulesets": [
                pyproject_url,
                pre_commit_url,
            ],
            "integration": {"adhoc": True, "ci": True, "release": True},
            "results": {},
        },
        {
            "name": SecretsChecker.I.name(),
            "type": "secret",
            "rulesets": [
                pyproject_url,
                pre_commit_url,
            ],
            "integration": {"adhoc": True, "ci": True, "release": True},
            "results": {},
        },
        {
            "name": CICDSecurityChecker.I.name(),
            "type": "SAST",
            "rulesets": [
                pyproject_url,
                pre_commit_url,
            ],
            "integration": {"adhoc": True, "ci": True, "release": True},
            "results": {},
        },
        {
            "name": PackageManager.I.name(),
            "type": "SCA",
            "rulesets": [
                pyproject_url,
                pre_commit_url,
            ],
            "integration": {"adhoc": True, "ci": True, "release": True},
            "results": {},
        },
        {
            "name": SecurityPracticesChecker.I.name(),
            "type": "other",
            "rulesets": [
                RemoteVersionController.I.file_url(
                    SecurityPracticesWorkflowConfigFile.I.path(),
                ),
            ],
            "integration": {"adhoc": True, "ci": True, "release": True},
            "results": {},
        },
        {
            "name": "Dependabot",
            "type": "SCA",
            "rulesets": [
                RemoteVersionController.I.file_url(
                    DependencyBotConfigFile.I.path(),
                ),
            ],
            "integration": {"adhoc": True, "ci": False, "release": False},
            "results": {},
        },
    ]
stem
stem() -> str

Return security-insights.

Source code in src/pyrig_openssf/rig/configs/security/security_insights.py
@override
def stem(self) -> str:
    """Return `security-insights`."""
    return "security-insights"
vulnerability_reporting
vulnerability_reporting() -> dict[str, Any]

Describe vulnerability reporting.

Source code in src/pyrig_openssf/rig/configs/security/security_insights.py
def vulnerability_reporting(self) -> dict[str, Any]:
    """Describe vulnerability reporting."""
    return {
        "contact": self.administrator(),
        "reports-accepted": True,
        "bug-bounty-available": False,
        "policy": RemoteVersionController.I.file_url(SecurityConfigFile.I.path()),
        "in-scope": ["Vulnerabilities in this project's own code."],
        "out-of-scope": ["Report dependency vulnerabilities to that project."],
    }

version_control

Version-control configuration for OpenSSF integrations.

remote

Remote version-control configuration.

workflows

GitHub Actions workflow configuration.

health_check

Health check workflow extended with reusable security-practices analysis.

HealthCheckWorkflowConfigFile

Bases: HealthCheckWorkflowConfigFile

Include security-practices checks in the required health-check result.

job_security_practices
job_security_practices() -> dict[str, Any]

Call the reusable security-practices workflow.

Source code in src/pyrig_openssf/rig/configs/version_control/remote/workflows/health_check.py
def job_security_practices(self) -> dict[str, Any]:
    """Call the reusable security-practices workflow."""
    return self.job_workflow_call(
        self.job_security_practices,
        workflow=SecurityPracticesWorkflowConfigFile,
    )
jobs_health_check
jobs_health_check() -> (
    tuple[Callable[[], dict[str, Any]], ...]
)

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
@override
def jobs_health_check(self) -> tuple[Callable[[], dict[str, Any]], ...]:
    """Return base health-check jobs followed by security-practices analysis."""
    return (*super().jobs_health_check(), self.job_security_practices)
security_practices

Reusable security-practices analysis and code-scanning alert gate.

SecurityPracticesWorkflowConfigFile

Bases: WorkflowConfigFile

Analyze repository practices and fail on open Scorecard alerts.

action_scorecard
action_scorecard() -> tuple[str, str, str]

Return the Scorecard action name, pinned SHA, and release tag.

Source code in src/pyrig_openssf/rig/configs/version_control/remote/workflows/security_practices.py
def action_scorecard(self) -> tuple[str, str, str]:
    """Return the Scorecard action name, pinned SHA, and release tag."""
    return self.action_from_resource(self.action_scorecard, resources)
action_upload_sarif
action_upload_sarif() -> tuple[str, str, str]

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
def action_upload_sarif(self) -> tuple[str, str, str]:
    """Return the SARIF uploader name, pinned SHA, and release tag."""
    return self.action_from_resource(self.action_upload_sarif, resources)
job_analyze
job_analyze() -> dict[str, Any]

Build the isolated analysis and upload job.

Source code in src/pyrig_openssf/rig/configs/version_control/remote/workflows/security_practices.py
def job_analyze(self) -> dict[str, Any]:
    """Build the isolated analysis and upload job."""
    return self.job(
        self.job_analyze,
        permissions=self.permissions_job_analyze(),
        steps=self.steps_analyze(),
        timeout_minutes=30,
    )
job_check_alerts
job_check_alerts() -> dict[str, Any]

Check alerts after the uploaded analysis has been processed.

Source code in src/pyrig_openssf/rig/configs/version_control/remote/workflows/security_practices.py
def job_check_alerts(self) -> dict[str, Any]:
    """Check alerts after the uploaded analysis has been processed."""
    return self.job(
        self.job_check_alerts,
        needs=(self.job_analyze,),
        permissions=self.permissions_job_check_alerts(),
        steps=self.steps_check_alerts(),
        timeout_minutes=5,
    )
jobs
jobs() -> tuple[Callable[[], dict[str, Any]], ...]

Return the analysis and alert-gate job builders.

Source code in src/pyrig_openssf/rig/configs/version_control/remote/workflows/security_practices.py
@override
def jobs(self) -> tuple[Callable[[], dict[str, Any]], ...]:
    """Return the analysis and alert-gate job builders."""
    return (self.job_analyze, self.job_check_alerts)
permissions_job_analyze
permissions_job_analyze() -> dict[str, str]

Grant repository reads, SARIF upload, and publication signing.

Source code in src/pyrig_openssf/rig/configs/version_control/remote/workflows/security_practices.py
def permissions_job_analyze(self) -> dict[str, str]:
    """Grant repository reads, SARIF upload, and publication signing."""
    return {
        **self.permission_contents(),
        **self.permission("actions"),
        **self.permission("security-events", write=True),
        **self.permission_id_token(write=True),
    }
permissions_job_check_alerts
permissions_job_check_alerts() -> dict[str, str]

Grant read access to code-scanning alerts without OIDC.

Source code in src/pyrig_openssf/rig/configs/version_control/remote/workflows/security_practices.py
def permissions_job_check_alerts(self) -> dict[str, str]:
    """Grant read access to code-scanning alerts without OIDC."""
    return self.permission("security-events")
results_file
results_file() -> Path

Return the SARIF report path.

Source code in src/pyrig_openssf/rig/configs/version_control/remote/workflows/security_practices.py
def results_file(self) -> Path:
    """Return the SARIF report path."""
    return Path(f"{SecurityPracticesChecker.I.name()}.{self.results_format()}")
results_format
results_format() -> str

Return the SARIF report format.

Source code in src/pyrig_openssf/rig/configs/version_control/remote/workflows/security_practices.py
def results_format(self) -> str:
    """Return the SARIF report format."""
    return "sarif"
stem
stem() -> str

Return the workflow filename stem.

Source code in src/pyrig_openssf/rig/configs/version_control/remote/workflows/security_practices.py
@override
def stem(self) -> str:
    """Return the workflow filename stem."""
    return "security-practices"
step_analyze_scorecard
step_analyze_scorecard() -> dict[str, Any]

Run Scorecard with public publication enabled.

Source code in src/pyrig_openssf/rig/configs/version_control/remote/workflows/security_practices.py
def step_analyze_scorecard(self) -> dict[str, Any]:
    """Run Scorecard with public publication enabled."""
    return self.step(
        self.step_analyze_scorecard,
        uses=self.action_scorecard(),
        with_={
            "results_file": self.results_file().as_posix(),
            "results_format": self.results_format(),
            "publish_results": True,
        },
    )
step_check_alerts
step_check_alerts() -> dict[str, Any]

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
def step_check_alerts(self) -> dict[str, Any]:
    """Fail on open Scorecard alerts for the analyzed ref or API errors."""
    return self.step(
        self.step_check_alerts,
        run=RemoteVersionController.I.api_method_args(
            '--raw-field="ref=${GITHUB_REF}"',
            "--raw-field=state=open",
            "--raw-field=tool_name=Scorecard",
            """--jq='if . != [] then error("Alerts found") end'""",
            endpoint='"repos/${GITHUB_REPOSITORY}/code-scanning/alerts"',
            method="GET",
        ).multiline(),
        env={"GH_TOKEN": self.insert_github_token()},
    )
step_upload_sarif
step_upload_sarif() -> dict[str, Any]

Upload Scorecard results and wait for code-scanning processing.

Source code in src/pyrig_openssf/rig/configs/version_control/remote/workflows/security_practices.py
def step_upload_sarif(self) -> dict[str, Any]:
    """Upload Scorecard results and wait for code-scanning processing."""
    return self.step(
        self.step_upload_sarif,
        uses=self.action_upload_sarif(),
        with_={
            "sarif_file": self.results_file().as_posix(),
        },
    )
steps_analyze
steps_analyze() -> list[dict[str, Any]]

Return checkout, analysis, and code-scanning upload steps.

Source code in src/pyrig_openssf/rig/configs/version_control/remote/workflows/security_practices.py
def steps_analyze(self) -> list[dict[str, Any]]:
    """Return checkout, analysis, and code-scanning upload steps."""
    return [
        self.step_checkout_repository(),
        self.step_analyze_scorecard(),
        self.step_upload_sarif(),
    ]
steps_check_alerts
steps_check_alerts() -> list[dict[str, Any]]

Return the code-scanning alert check.

Source code in src/pyrig_openssf/rig/configs/version_control/remote/workflows/security_practices.py
def steps_check_alerts(self) -> list[dict[str, Any]]:
    """Return the code-scanning alert check."""
    return [self.step_check_alerts()]
workflow_triggers
workflow_triggers() -> dict[str, Any]

Allow invocation only through a reusable-workflow call.

Source code in src/pyrig_openssf/rig/configs/version_control/remote/workflows/security_practices.py
@override
def workflow_triggers(self) -> dict[str, Any]:
    """Allow invocation only through a reusable-workflow call."""
    return self.on_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.

badge_baseline
badge_baseline() -> tuple[str, str, str, str]

Return the repository's Baseline badge and assessment link.

Source code in src/pyrig_openssf/rig/tools/security/practices.py
def badge_baseline(self) -> tuple[str, str, str, str]:
    """Return the repository's Baseline badge and assessment link."""
    return (
        self.group(),
        self.project_url("baseline"),
        self.project_url(),
        "Baseline",
    )
badge_best_practices
badge_best_practices() -> tuple[str, str, str, str]

Return the repository's Best Practices badge and assessment link.

Source code in src/pyrig_openssf/rig/tools/security/practices.py
def badge_best_practices(self) -> tuple[str, str, str, str]:
    """Return the repository's Best Practices badge and assessment link."""
    return (
        self.group(),
        self.project_url("badge"),
        self.project_url(),
        "Best Practices",
    )
badges
badges() -> tuple[tuple[str, str, str, str], ...]

Return Scorecard, Best Practices, and Baseline badge metadata.

Source code in src/pyrig_openssf/rig/tools/security/practices.py
@override
def badges(self) -> tuple[tuple[str, str, str, str], ...]:
    """Return Scorecard, Best Practices, and Baseline badge metadata."""
    return (*super().badges(), self.badge_best_practices(), self.badge_baseline())
dev_dependencies
dev_dependencies() -> tuple[str, ...]

Return no dev dependencies because Scorecard runs in GitHub Actions.

Source code in src/pyrig_openssf/rig/tools/security/practices.py
@override
def dev_dependencies(self) -> tuple[str, ...]:
    """Return no dev dependencies because Scorecard runs in GitHub Actions."""
    return ()
group
group() -> str

Return the project-status badge group.

Source code in src/pyrig_openssf/rig/tools/security/practices.py
@override
def group(self) -> str:
    """Return the project-status badge group."""
    return Group.PROJECT_STATUS
image_url
image_url() -> str

Return the repository's published Scorecard badge URL.

Source code in src/pyrig_openssf/rig/tools/security/practices.py
@override
def image_url(self) -> str:
    """Return the repository's published Scorecard badge URL."""
    repository = RemoteVersionController.I.repository()
    return f"https://api.scorecard.dev/projects/github.com/{repository}/badge"
link_url
link_url() -> str

Return the repository's public Scorecard assessment URL.

Source code in src/pyrig_openssf/rig/tools/security/practices.py
@override
def link_url(self) -> str:
    """Return the repository's public Scorecard assessment URL."""
    repository = RemoteVersionController.I.repository()
    return f"https://scorecard.dev/viewer/?uri=github.com/{repository}"
name
name() -> str

Return the Scorecard executable name.

Source code in src/pyrig_openssf/rig/tools/security/practices.py
@override
def name(self) -> str:
    """Return the Scorecard executable name."""
    return "scorecard"
project_url
project_url(as_: str = 'entry') -> str

Return an OpenSSF project lookup URL without requiring a project ID.

Source code in src/pyrig_openssf/rig/tools/security/practices.py
def project_url(self, as_: str = "entry") -> str:
    """Return an OpenSSF project lookup URL without requiring a project ID."""
    query = urlencode({"as": as_, "url": RemoteVersionController.I.repo_url()})
    return f"https://www.bestpractices.dev/en/projects?{query}"
secrets

Secrets scanner command construction and badge metadata.

SecretsChecker

Bases: SecretsChecker

Customize detect-secrets for generated Best Practices criteria.

check_hook
check_hook() -> dict[str, Any]

Exclude only the generated Best Practices assessment file.

Source code in src/pyrig_openssf/rig/tools/security/secrets.py
@override
def check_hook(self) -> dict[str, Any]:
    """Exclude only the generated Best Practices assessment file."""
    from pyrig_openssf.rig.configs.security.best_practices import (  # noqa: PLC0415
        BestPracticesConfigFile,
    )

    hook = super().check_hook()
    path = re.escape(BestPracticesConfigFile.I.path().as_posix())
    hook.setdefault("args", []).extend(
        Args(f"--exclude-files=^{path}$"),
    )
    return hook