repository-scanner

Projects that follow the best practices below can voluntarily self-certify and show that they've achieved an Open Source Security Foundation (OpenSSF) best practices badge.

If this is your project, please show your badge status on your project page! The badge status looks like this: Badge level for project 7799 is silver Here is how to embed it:

These are the Silver level criteria. You can also view the Passing or Gold level criteria.

        

 Basics 17/17 ●

  • Identification

    The Repository Scanner (RESC) is a tool used to detect secrets in source code management and version control systems (e.g. GitHub, BitBucket, or Azure DevOps). Among the types of secrets that the Repository Scanner detects are credentials, passwords, tokens, API keys, and certificates. The tool is maintained and updated by the ABN AMRO Bank to match the constantly changing cyber security landscape.

    The Repository Scanner was created to prevent that credentials and other sensitive information are left unprotected in code repositories. Exposing sensitive information in such a way can have severe consequences for the security posture of an organization. An attacker can use the data to compromise the organization's network. This can be prevented by scanning a repository with the RESC tool. It marks all the instances of exposed sensitive information in the source code.

  • Prerequisites


    Enough for a badge!

    The project MUST achieve a passing level badge. [achieve_passing]

  • Basic project website content


    Enough for a badge!

    The information on how to contribute MUST include the requirements for acceptable contributions (e.g., a reference to any required coding standard). (URL required) [contribution_requirements]

    https://github.com/abnamro/repository-scanner/blob/main/contributing.md


  • Project oversight


    Enough for a badge!

    The project SHOULD have a legal mechanism where all developers of non-trivial amounts of project software assert that they are legally authorized to make these contributions. The most common and easily-implemented approach for doing this is by using a Developer Certificate of Origin (DCO), where users add "signed-off-by" in their commits and the project links to the DCO website. However, this MAY be implemented as a Contributor License Agreement (CLA), or other legal mechanism. (URL required) [dco]

    All the RESC PRs required verified signature. https://github.com/abnamro/repository-scanner/pulls?q=


    Enough for a badge!

    The project MUST clearly define and document its project governance model (the way it makes decisions, including key roles). (URL required) [governance]

    We use GitHub to track proposed changes via its issue tracker and pull requests. pull request: https://github.com/abnamro/repository-scanner/pulls issues: https://github.com/abnamro/repository-scanner/issues


    Enough for a badge!

    The project MUST adopt a code of conduct and post it in a standard location. (URL required) [code_of_conduct]

    https://github.com/abnamro/repository-scanner/blob/main/code-of-conduct.md


    Enough for a badge!

    The project MUST clearly define and publicly document the key roles in the project and their responsibilities, including any tasks those roles must perform. It MUST be clear who has which role(s), though this might not be documented in the same way. (URL required) [roles_responsibilities]

    ABN AMRO is the owner of the project, who decides who will be working on the project. https://github.com/abnamro


    Enough for a badge!

    The project MUST be able to continue with minimal interruption if any one person dies, is incapacitated, or is otherwise unable or unwilling to continue support of the project. In particular, the project MUST be able to create and close issues, accept proposed changes, and release versions of software, within a week of confirmation of the loss of support from any one individual. This MAY be done by ensuring someone else has any necessary keys, passwords, and legal rights to continue the project. Individuals who run a FLOSS project MAY do this by providing keys in a lockbox and a will providing any needed legal rights (e.g., for DNS names). (URL required) [access_continuity]

    The project is maintained under ABN AMRO, ABN AMRO will take care of project. https://github.com/abnamro/repository-scanner/graphs/contributors


    Enough for a badge!

    The project SHOULD have a "bus factor" of 2 or more. (URL required) [bus_factor]

    The project is maintained under ABN AMRO, ABN will take care of project. https://github.com/abnamro/repository-scanner/graphs/contributors


  • Documentation


    Enough for a badge!

    The project MUST have a documented roadmap that describes what the project intends to do and not do for at least the next year. (URL required) [documentation_roadmap]

    https://github.com/abnamro/repository-scanner/blob/add-roadmap/docs/roadmap.md


    Enough for a badge!

    The project MUST include documentation of the architecture (aka high-level design) of the software produced by the project. If the project does not produce software, select "not applicable" (N/A). (URL required) [documentation_architecture]

    https://github.com/abnamro/repository-scanner/tree/main/images example: https://github.com/abnamro/repository-scanner/blob/main/images/RESC_HighLevel_Diagram.png


    Enough for a badge!

    The project MUST document what the user can and cannot expect in terms of security from the software produced by the project (its "security requirements"). (URL required) [documentation_security]

    Enough for a badge!

    The project MUST provide a "quick start" guide for new users to help them quickly do something with the software. (URL required) [documentation_quick_start]

    examples: https://github.com/abnamro/repository-scanner/blob/main/deployment/resc-helm-wizard/images/RESC_Installation.gif https://github.com/abnamro/repository-scanner/blob/main/images/RESC_Preview.gif


    Enough for a badge!

    The project MUST make an effort to keep the documentation consistent with the current version of the project results (including software produced by the project). Any known documentation defects making it inconsistent MUST be fixed. If the documentation is generally current, but erroneously includes some older information that is no longer true, just treat that as a defect, then track and fix as usual. [documentation_current]

    All the details are listed in the release versions https://github.com/abnamro/repository-scanner/releases


    Enough for a badge!

    The project repository front page and/or website MUST identify and hyperlink to any achievements, including this best practices badge, within 48 hours of public recognition that the achievement has been attained. (URL required) [documentation_achievements]

    https://github.com/abnamro/repository-scanner#readme example: https://www.bestpractices.dev/en/projects/7799 https://github.com/abnamro/repository-scanner/actions


  • Accessibility and internationalization


    Enough for a badge!

    The project (both project sites and project results) SHOULD follow accessibility best practices so that persons with disabilities can still participate in the project and use the project results where it is reasonable to do so. [accessibility_best_practices]

    The product and the documentation are straight-forward text-based and don't require UI colors/changes.


    Enough for a badge!

    The software produced by the project SHOULD be internationalized to enable easy localization for the target audience's culture, region, or language. If internationalization (i18n) does not apply (e.g., the software doesn't generate text intended for end-users and doesn't sort human-readable text), select "not applicable" (N/A). [internationalization]

    N/A its designed for english language.


  • Other


    Enough for a badge!

    If the project sites (website, repository, and download URLs) store passwords for authentication of external users, the passwords MUST be stored as iterated hashes with a per-user salt by using a key stretching (iterated) algorithm (e.g., Argon2id, Bcrypt, Scrypt, or PBKDF2). If the project sites do not store passwords for this purpose, select "not applicable" (N/A). [sites_password_security]

    We are not using any cryptographic mechanism, because we dont have functionality to store any sensitive data


  • Previous versions


    Enough for a badge!

    The project MUST maintain the most often used older versions of the product or provide an upgrade path to newer versions. If the upgrade path is difficult, the project MUST document how to perform the upgrade (e.g., the interfaces that have changed and detailed suggested steps to help upgrade). [maintenance_or_update]

    https://github.com/abnamro/repository-scanner/releases


  • Bug-reporting process


    Enough for a badge!

    The project MUST use an issue tracker for tracking individual issues. [report_tracker]

    https://github.com/abnamro/repository-scanner/issues?q=


  • Vulnerability report process


    Enough for a badge!

    The project MUST give credit to the reporter(s) of all vulnerability reports resolved in the last 12 months, except for the reporter(s) who request anonymity. If there have been no vulnerabilities resolved in the last 12 months, select "not applicable" (N/A). (URL required) [vulnerability_report_credit]

    Till now no one has reported any vulnerabilities. https://github.com/abnamro/repository-scanner/security/policy


    Enough for a badge!

    The project MUST have a documented process for responding to vulnerability reports. (URL required) [vulnerability_response_process]

    We have the security bug reporting policiy/guidelines https://github.com/abnamro/repository-scanner/security/policy


  • Secure development knowledge


    Enough for a badge!

    The project MUST implement secure design principles (from "know_secure_design"), where applicable. If the project is not producing software, select "not applicable" (N/A). [implement_secure_design]

    In kubernetes deployments files we are using secure by default configuartion by adding the securityContext. Example: https://github.com/abnamro/repository-scanner/blob/main/deployment/kubernetes/charts/resc-database/templates/database_deployment.yaml#L52C11-L64C35

    Authenticated communication made while connecting with celery queues. Example: https://github.com/abnamro/repository-scanner/blob/main/components/resc-vcs-scanner/src/vcs_scanner/secret_scanners/celery_worker.py#L33

    We have secuerity headers in place for API response: In API: https://github.com/abnamro/repository-scanner/blob/main/components/resc-backend/src/resc_backend/resc_web_service/dependencies.py#L122 https://github.com/abnamro/repository-scanner/blob/main/components/resc-backend/src/resc_backend/constants.py#L96

    Deployment is made secure by using passwords for different components and passwords needs be provided by user during set up process using resc-helm-wizard cli. Example: https://github.com/abnamro/repository-scanner/tree/main/deployment/resc-helm-wizard


  • Use basic good cryptographic practices

    Note that some software does not need to use cryptographic mechanisms. If your project produces software that (1) includes, activates, or enables encryption functionality, and (2) might be released from the United States (US) to outside the US or to a non-US-citizen, you may be legally required to take a few extra steps. Typically this just involves sending an email. For more information, see the encryption section of Understanding Open Source Technology & US Export Controls.

    Enough for a badge!

    The default security mechanisms within the software produced by the project MUST NOT depend on cryptographic algorithms or modes with known serious weaknesses (e.g., the SHA-1 cryptographic hash algorithm or the CBC mode in SSH). [crypto_weaknesses]

    Yes, We are not using any cryptographic mechanism, because we dont have functionality to encrypt any data


    Enough for a badge!

    The project SHOULD support multiple cryptographic algorithms, so users can quickly switch if one is broken. Common symmetric key algorithms include AES, Twofish, and Serpent. Common cryptographic hash algorithm alternatives include SHA-2 (including SHA-224, SHA-256, SHA-384 AND SHA-512) and SHA-3. [crypto_algorithm_agility]

    Yes, We are not using any cryptographic mechanism, because we dont have functionality to encrypt any data


    Enough for a badge!

    The project MUST support storing authentication credentials (such as passwords and dynamic tokens) and private cryptographic keys in files that are separate from other information (such as configuration files, databases, and logs), and permit users to update and replace them without code recompilation. If the project never processes authentication credentials and private cryptographic keys, select "not applicable" (N/A). [crypto_credential_agility]

    N/A. We are not using any cryptographic mechanism, because we dont have functionality to encrypt/store any sensitive data


    Enough for a badge!

    The software produced by the project SHOULD support secure protocols for all of its network communications, such as SSHv2 or later, TLS1.2 or later (HTTPS), IPsec, SFTP, and SNMPv3. Insecure protocols such as FTP, HTTP, telnet, SSLv3 or earlier, and SSHv1 SHOULD be disabled by default, and only enabled if the user specifically configures it. If the software produced by the project does not support network communications, select "not applicable" (N/A). [crypto_used_network]

    N/A


    Enough for a badge!

    The software produced by the project SHOULD, if it supports or uses TLS, support at least TLS version 1.2. Note that the predecessor of TLS was called SSL. If the software does not use TLS, select "not applicable" (N/A). [crypto_tls12]

    N/A


    Enough for a badge!

    The software produced by the project MUST, if it supports TLS, perform TLS certificate verification by default when using TLS, including on subresources. If the software does not use TLS, select "not applicable" (N/A). [crypto_certificate_verification]

    N/A


    Enough for a badge!

    The software produced by the project MUST, if it supports TLS, perform certificate verification before sending HTTP headers with private information (such as secure cookies). If the software does not use TLS, select "not applicable" (N/A). [crypto_verification_private]

    N/A


  • Secure release


    Enough for a badge!

    The project MUST cryptographically sign releases of the project results intended for widespread use, and there MUST be a documented process explaining to users how they can obtain the public signing keys and verify the signature(s). The private key for these signature(s) MUST NOT be on site(s) used to directly distribute the software to the public. If releases are not intended for widespread use, select "not applicable" (N/A). [signed_releases]

    N/A. We are not using any cryptographic mechanism, because we dont have functionality to encrypt/store any sensitive data


    Enough for a badge!

    It is SUGGESTED that in the version control system, each important version tag (a tag that is part of a major release, minor release, or fixes publicly noted vulnerabilities) be cryptographically signed and verifiable as described in signed_releases. [version_tags_signed]

    Every release/commit is signed and verified. https://github.com/abnamro/repository-scanner/releases


  • Other security issues


    Enough for a badge!

    The project results MUST check all inputs from potentially untrusted sources to ensure they are valid (an *allowlist*), and reject invalid inputs, if there are any restrictions on the data at all. [input_validation]

    We are using Pydantic as data validation library for Python components in all our schemas. Example: https://github.com/abnamro/repository-scanner/blob/main/components/resc-backend/src/resc_backend/resc_web_service/schema/detailed_finding.py

    For all of our rest apis, we are using validation for query parameters provided by Fast API. Example: https://github.com/abnamro/repository-scanner/blob/main/components/resc-backend/src/resc_backend/resc_web_service/endpoints/rule_packs.py#L132

    Also we have custom validation in place. Example: https://github.com/abnamro/repository-scanner/blob/main/components/resc-backend/src/resc_backend/resc_web_service/helpers/rule.py#L330

    Also we have proper exception handling in place to return error codes instead of any detailed error or stacktrace. Example: https://github.com/abnamro/repository-scanner/blob/main/components/resc-backend/src/resc_backend/resc_web_service/helpers/exception_handler.py


    Enough for a badge!

    Hardening mechanisms SHOULD be used in the software produced by the project so that software defects are less likely to result in security vulnerabilities. [hardening]

    We have secuerity headers in place for API response: In API: https://github.com/abnamro/repository-scanner/blob/main/components/resc-backend/src/resc_backend/resc_web_service/dependencies.py#L122 https://github.com/abnamro/repository-scanner/blob/main/components/resc-backend/src/resc_backend/constants.py#L96

    In nginx ingress: https://github.com/abnamro/repository-scanner/blob/main/deployment/kubernetes/charts/resc-frontend/templates/frontend_ingress.yaml#L21

    We have also added few security headers to the project, to avoid security vulnerabilities https://github.com/abnamro/repository-scanner/blob/4e74a188a8cdb99027fbba67b288fe9c655c3e33/components/resc-backend/src/resc_backend/resc_web_service/dependencies.py#L109


    Enough for a badge!

    The project MUST provide an assurance case that justifies why its security requirements are met. The assurance case MUST include: a description of the threat model, clear identification of trust boundaries, an argument that secure design principles have been applied, and an argument that common implementation security weaknesses have been countered. (URL required) [assurance_case]

    We, as part of a secure coding team of 6 developers working for Bank security, will prioritise security requirements from the start of the project, we work on shift left security, we have a threat model in place in our internal space. https://github.com/abnamro/repository-scanner/blob/main/docs/threatmodel.md Also, please see the photos below for the whole architecture model with security. https://github.com/abnamro/repository-scanner/tree/main/images



This data is available under the Creative Commons Attribution version 3.0 or later license (CC-BY-3.0+). All are free to share and adapt the data, but must give appropriate credit. Please credit Repository-Scanner and the OpenSSF Best Practices badge contributors.

Project badge entry owned by: Repository-Scanner.
Entry created on 2023-09-04 14:01:53 UTC, last updated on 2023-09-29 13:59:59 UTC. Last achieved passing badge on 2023-09-05 10:32:15 UTC.

Back