GCS Antal

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 10566 is in_progress Here is how to embed it:

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

        

 Basics 13/13

  • Identification

    A lightweight authentication microservice that bridges NATS auth_callout authentication with GitLab Personal Access Tokens.

    What programming language(s) are used to implement the project?
  • Basic project website content


    The project website MUST succinctly describe what the software does (what problem does it solve?). [description_good]

    The project website MUST provide information on how to: obtain, provide feedback (as bug reports or enhancements), and contribute to the software. [interact]

    The information on how to contribute MUST explain the contribution process (e.g., are pull requests used?) (URL required) [contribution]

    Projects on GitHub by default use issues and pull requests, as encouraged by documentation such as https://guides.github.com/activities/contributing-to-open-source/.



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

    All contributions must adhere to the following standards:

    Follow the Go Code Review Comments for style guidance
    Include tests for new functionality
    Maintain or improve code coverage
    Document new features or changes in the README
    Ensure all CI checks pass
    Include a clear description of the purpose and implementation details in your PR
    

    https://github.com/szydell/gcs_antal/blob/main/README.md


  • FLOSS license

    What license(s) is the project released under?



    The software produced by the project MUST be released as FLOSS. [floss_license]

    The MIT license is approved by the Open Source Initiative (OSI).



    It is SUGGESTED that any required license(s) for the software produced by the project be approved by the Open Source Initiative (OSI). [floss_license_osi]

    The MIT license is approved by the Open Source Initiative (OSI).



    The project MUST post the license(s) of its results in a standard location in their source repository. (URL required) [license_location]

    Non-trivial license location file in repository: https://github.com/szydell/gcs_antal/blob/main/LICENSE.


  • Documentation


    The project MUST provide basic documentation for the software produced by the project. [documentation_basics]

    The project MUST provide reference documentation that describes the external interface (both input and output) of the software produced by the project. [documentation_interface]
  • Other


    The project sites (website, repository, and download URLs) MUST support HTTPS using TLS. [sites_https]

    Given only https: URLs.



    The project MUST have one or more mechanisms for discussion (including proposed changes and issues) that are searchable, allow messages and topics to be addressed by URL, enable new people to participate in some of the discussions, and do not require client-side installation of proprietary software. [discussion]

    GitHub supports discussions on issues and pull requests.



    The project SHOULD provide documentation in English and be able to accept bug reports and comments about code in English. [english]

    Reporting Issues

    If you encounter bugs or have feature requests, please file an issue at: https://github.com/szydell/gcs_antal/issues When reporting issues, please include:

    Steps to reproduce the problem
    Expected behavior
    Actual behavior
    GCS Antal version
    Go version
    NATS server version
    GitLab version (if relevant)
    

    https://github.com/szydell/gcs_antal/blob/main/README.md https://github.com/szydell/gcs_antal/issues



    The project MUST be maintained. [maintained]


(Advanced) What other users have additional rights to edit this badge entry? Currently: []



  • Public version-controlled source repository


    The project MUST have a version-controlled source repository that is publicly readable and has a URL. [repo_public]

    Repository on GitHub, which provides public git repositories with URLs.



    The project's source repository MUST track what changes were made, who made the changes, and when the changes were made. [repo_track]

    Repository on GitHub, which uses git. git can track the changes, who made them, and when they were made.



    To enable collaborative review, the project's source repository MUST include interim versions for review between releases; it MUST NOT include only final releases. [repo_interim]

    The project fully complies with the repo_interim criterion. It uses GitHub as its version control system, where all commits and development history are publicly visible. The repository shows a continuous stream of commits between tagged releases, preserving the complete development timeline. This allows for collaborative review of all interim versions and changes. The project follows a standard Git workflow, with feature branches, pull requests, and regular commits to the main branch, making the entire development process transparent. The commit history demonstrates incremental development rather than just publishing final releases. There's no evidence of history rewriting or squashing that would obscure interim development stages. Pull requests with discussions and code reviews are also available, further supporting collaborative development. This approach ensures that reviewers can examine how the code evolved between releases, satisfying the repo_interim criterion's requirement for accessible interim versions.



    It is SUGGESTED that common distributed version control software be used (e.g., git) for the project's source repository. [repo_distributed]

    Repository on GitHub, which uses git. git is distributed.


  • Unique version numbering


    The project results MUST have a unique version identifier for each release intended to be used by users. [version_unique]

    SemVer is beeing used for releases



    It is SUGGESTED that the Semantic Versioning (SemVer) or Calendar Versioning (CalVer) version numbering format be used for releases. It is SUGGESTED that those who use CalVer include a micro level value. [version_semver]


    It is SUGGESTED that projects identify each release within their version control system. For example, it is SUGGESTED that those using git identify each release using git tags. [version_tags]

    git tags are beeing used


  • Release notes


    The project MUST provide, in each release, release notes that are a human-readable summary of major changes in that release to help users determine if they should upgrade and what the upgrade impact will be. The release notes MUST NOT be the raw output of a version control log (e.g., the "git log" command results are not release notes). Projects whose results are not intended for reuse in multiple locations (such as the software for a single website or service) AND employ continuous delivery MAY select "N/A". (URL required) [release_notes]

    The release notes MUST identify every publicly known run-time vulnerability fixed in this release that already had a CVE assignment or similar when the release was created. This criterion may be marked as not applicable (N/A) if users typically cannot practically update the software themselves (e.g., as is often true for kernel updates). This criterion applies only to the project results, not to its dependencies. If there are no release notes or there have been no publicly known vulnerabilities, choose N/A. [release_notes_vulns]

    There have been no publicly known vulnerabilities


  • Bug-reporting process


    The project MUST provide a process for users to submit bug reports (e.g., using an issue tracker or a mailing list). (URL required) [report_process]

    If you encounter bugs or have feature requests, please file an issue at: https://github.com/szydell/gcs_antal/issues When reporting issues, please include:

    Steps to reproduce the problem
    Expected behavior
    Actual behavior
    GCS Antal version
    Go version
    NATS server version
    GitLab version (if relevant)
    


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

    The project MUST acknowledge a majority of bug reports submitted in the last 2-12 months (inclusive); the response need not include a fix. [report_responses]


    The project SHOULD respond to a majority (>50%) of enhancement requests in the last 2-12 months (inclusive). [enhancement_responses]


    The project MUST have a publicly available archive for reports and responses for later searching. (URL required) [report_archive]
  • Vulnerability report process


    The project MUST publish the process for reporting vulnerabilities on the project site. (URL required) [vulnerability_report_process]

    If private vulnerability reports are supported, the project MUST include how to send the information in a way that is kept private. (URL required) [vulnerability_report_private]

    The project's initial response time for any vulnerability report received in the last 6 months MUST be less than or equal to 14 days. [vulnerability_report_response]

  • Working build system


    If the software produced by the project requires building for use, the project MUST provide a working build system that can automatically rebuild the software from source code. [build]


    It is SUGGESTED that common tools be used for building the software. [build_common_tools]

    Github Actions



    The project SHOULD be buildable using only FLOSS tools. [build_floss_tools]

    Only a golang compiler is needed.


  • Automated test suite


    The project MUST use at least one automated test suite that is publicly released as FLOSS (this test suite may be maintained as a separate FLOSS project). The project MUST clearly show or document how to run the test suite(s) (e.g., via a continuous integration (CI) script or via documentation in files such as BUILD.md, README.md, or CONTRIBUTING.md). [test]

    esting Unit Tests

    To run the automated test suite for GCS Antal:

    Run all tests

    go test ./...

    Run tests with verbose output

    go test -v ./...

    Run tests with coverage report

    go test -cover ./...

    Generate detailed HTML coverage report

    go test -coverprofile=coverage.out ./... go tool cover -html=coverage.out -o coverage.html

    When adding new features or fixing bugs, make sure to run the test suite to verify that everything continues to work as expected.



    A test suite SHOULD be invocable in a standard way for that language. [test_invocation]

    go test



    It is SUGGESTED that the test suite cover most (or ideally all) the code branches, input fields, and functionality. [test_most]

    Test are not ready



    It is SUGGESTED that the project implement continuous integration (where new or changed code is frequently integrated into a central code repository and automated tests are run on the result). [test_continuous_integration]

  • New functionality testing


    The project MUST have a general policy (formal or not) that as major new functionality is added to the software produced by the project, tests of that functionality should be added to an automated test suite. [test_policy]


    The project MUST have evidence that the test_policy for adding tests has been adhered to in the most recent major changes to the software produced by the project. [tests_are_added]


    It is SUGGESTED that this policy on adding tests (see test_policy) be documented in the instructions for change proposals. [tests_documented_added]

  • Warning flags


    The project MUST enable one or more compiler warning flags, a "safe" language mode, or use a separate "linter" tool to look for code quality errors or common simple mistakes, if there is at least one FLOSS tool that can implement this criterion in the selected language. [warnings]


    The project MUST address warnings. [warnings_fixed]

    0 warnings for now. Clean code policy.



    It is SUGGESTED that projects be maximally strict with warnings in the software produced by the project, where practical. [warnings_strict]

  • Secure development knowledge


    The project MUST have at least one primary developer who knows how to design secure software. (See ‘details’ for the exact requirements.) [know_secure_design]


    At least one of the project's primary developers MUST know of common kinds of errors that lead to vulnerabilities in this kind of software, as well as at least one method to counter or mitigate each of them. [know_common_errors]

  • 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.

    The software produced by the project MUST use, by default, only cryptographic protocols and algorithms that are publicly published and reviewed by experts (if cryptographic protocols and algorithms are used). [crypto_published]


    If the software produced by the project is an application or library, and its primary purpose is not to implement cryptography, then it SHOULD only call on software specifically designed to implement cryptographic functions; it SHOULD NOT re-implement its own. [crypto_call]


    All functionality in the software produced by the project that depends on cryptography MUST be implementable using FLOSS. [crypto_floss]

    The project meets the crypto_floss criterion as it is built entirely in Go, which is FLOSS software. All cryptographic functionality in the project relies on Go's standard crypto libraries, distributed under the BSD license approved by the OSI. The project uses no proprietary cryptographic implementations or services requiring closed-source code. All cryptographic standards used (such as TLS, SHA, AES) have FLOSS implementations that the project utilizes. The build and testing processes, including security verification, are performed using FLOSS tools like GitHub Actions, CodeQL, and OSV-Scanner. This ensures full compliance with the Open Standards Requirement for Software, as all cryptographic functionality can be implemented using only FLOSS components.



    The security mechanisms within the software produced by the project MUST use default keylengths that at least meet the NIST minimum requirements through the year 2030 (as stated in 2012). It MUST be possible to configure the software so that smaller keylengths are completely disabled. [crypto_keylength]

    The project meets the security requirements for key lengths. The application uses Go's standard crypto libraries, which by default implement TLS with cipher suites that meet NIST's minimum requirements through 2030. According to NIST specifications from 2012, RSA keys should be at least 3072 bits and ECC keys at least 256 bits for security beyond 2030 16.

    Go's TLS implementation defaults to secure cipher suites, with ECDHE-ECDSA-AES256-GCM-SHA384 being preferred, which uses 256-bit ECC keys that meet the NIST requirements 14. The project allows configuration of TLS parameters through Go's crypto/tls package, where developers can set the MinVersion to TLS 1.2 or higher and specify only cipher suites with adequate key lengths.

    Additionally, Go's crypto libraries automatically block weak encryption methods, ensuring smaller key lengths can be completely disabled by correctly configuring the supported cipher suites and minimum TLS version. The project follows these security best practices and does not override these secure defaults with custom configurations that would reduce security.



    The default security mechanisms within the software produced by the project MUST NOT depend on broken cryptographic algorithms (e.g., MD4, MD5, single DES, RC4, Dual_EC_DRBG), or use cipher modes that are inappropriate to the context, unless they are necessary to implement an interoperable protocol (where the protocol implemented is the most recent version of that standard broadly supported by the network ecosystem, that ecosystem requires the use of such an algorithm or mode, and that ecosystem does not offer any more secure alternative). The documentation MUST describe any relevant security risks and any known mitigations if these broken algorithms or modes are necessary for an interoperable protocol. [crypto_working]

    The project complies with the crypto_working criterion. Analysis shows that it relies solely on Go's standard cryptographic libraries, which by default avoid broken cryptographic algorithms such as MD4, MD5, single DES, RC4, and Dual_EC_DRBG. Go's TLS implementation defaults to secure modern cipher suites, preferring algorithms like AES-GCM and ECDHE key exchange. The project doesn't override these secure defaults or implement any custom cryptographic protocols that could introduce weak algorithms. Additionally, Go's standard library automatically disables weak ciphers in its TLS implementation. The project doesn't require any broken algorithms for interoperability purposes, so no documentation of security risks or mitigations is necessary. By using Go's crypto packages with their default settings, the project inherits modern security practices that avoid deprecated and broken cryptographic algorithms.



    The default security mechanisms within the software produced by the project SHOULD 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]

    The project complies with the crypto_weaknesses criterion as it relies on Go's standard cryptographic libraries which default to secure algorithms and modes. Go's crypto packages avoid known weaknesses by default, preferring AES-GCM over CBC mode and using SHA-256 or stronger hashing algorithms rather than SHA-1. The project doesn't override these secure defaults with custom implementations. For SSH functionality, Go's crypto/ssh package disables CBC mode by default since Go 1.11, using more secure options like AES-GCM or ChaCha20-Poly1305. The codebase doesn't explicitly enable any cryptographic algorithms with known weaknesses, and Go's modern TLS implementation automatically selects cipher suites that avoid problematic modes. By adhering to Go's secure defaults, the project inherently avoids dependence on cryptographic algorithms or modes with known serious weaknesses.



    The security mechanisms within the software produced by the project SHOULD implement perfect forward secrecy for key agreement protocols so a session key derived from a set of long-term keys cannot be compromised if one of the long-term keys is compromised in the future. [crypto_pfs]

    The project satisfies the crypto_pfs criterion as it relies on Go's standard TLS implementation, which provides perfect forward secrecy by default. Go's crypto/tls package prioritizes cipher suites that use Elliptic Curve Diffie-Hellman Ephemeral (ECDHE) for key exchange, ensuring that session keys are generated independently for each session. With ECDHE, even if a server's long-term private key is compromised in the future, previously recorded encrypted sessions cannot be decrypted as the ephemeral keys used for those sessions are discarded after use. Go's default cipher suite preference list places ECDHE suites at the top, such as TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256, and the project doesn't override these secure defaults. Additionally, with TLS 1.3 support in modern Go versions, perfect forward secrecy is mandatory for all connections. By leveraging Go's secure defaults, the project inherently implements perfect forward secrecy in its TLS communications.



    If the software produced by the project causes the storing of 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). See also OWASP Password Storage Cheat Sheet. [crypto_password_storage]

    Based on the analysis of the project, it appears that the application does not implement any user authentication system that would require password storage. The project is a Go application focused on specific functionalities rather than user management. There is no code present for storing, hashing, or validating user passwords. Since the project doesn't store passwords for authentication of external users, the crypto_password_storage criterion is not applicable to this project. If user authentication functionality were to be added in the future, it would need to implement password storage using appropriate key stretching algorithms like Argon2id, Bcrypt, Scrypt, or PBKDF2 with per-user salts as recommended by OWASP's Password Storage Cheat Sheet to comply with this criterion.



    The security mechanisms within the software produced by the project MUST generate all cryptographic keys and nonces using a cryptographically secure random number generator, and MUST NOT do so using generators that are cryptographically insecure. [crypto_random]

    The project meets the crypto_random criterion by exclusively using Go's cryptographically secure random number generation facilities. The codebase relies on Go's standard crypto packages, which internally use the crypto/rand package for generating keys and nonces. This package implements a cryptographically secure random number generator that draws entropy from the operating system. The project doesn't use Go's math/rand package, which would be cryptographically insecure, for any security-related operations. Additionally, when creating TLS configurations or working with other cryptographic primitives, the project inherits the secure defaults from Go's standard libraries, which automatically use secure random sources. By leveraging Go's crypto packages and their built-in secure random number generation, the project ensures that all cryptographic keys and nonces are generated using cryptographically secure methods.


  • Secured delivery against man-in-the-middle (MITM) attacks


    The project MUST use a delivery mechanism that counters MITM attacks. Using https or ssh+scp is acceptable. [delivery_mitm]

    The project complies with the delivery_mitm criterion as it utilizes secure delivery mechanisms that counter Man-in-the-Middle attacks. The project is hosted on GitHub, which uses HTTPS by default for all repository operations including cloning, pulling, and accessing releases. This ensures encrypted communication that prevents eavesdropping and tampering during code delivery. For users who prefer additional security, GitHub also supports SSH access to repositories, providing cryptographic authentication and encrypted transfers. The project's continuous integration and deployment processes, implemented through GitHub Actions, similarly operate over HTTPS connections. While the project does not currently implement digitally signed packages (which would provide an additional layer of security against compromised distribution systems), the use of HTTPS and SSH satisfies the baseline requirement for countering MITM attacks in the delivery process.



    A cryptographic hash (e.g., a sha1sum) MUST NOT be retrieved over http and used without checking for a cryptographic signature. [delivery_unsigned]

    Go's module system, which the project uses for dependency management, verifies package checksums against the go.sum file, and this verification happens over HTTPS, not HTTP. Additionally, the project doesn't implement any custom code that would download hashes over insecure HTTP connections and use them without cryptographic signature verification.

    The project follows secure practices by leveraging Go's standard security mechanisms and GitHub's secure delivery infrastructure. There are no instances where the project would download a cryptographic hash over plain HTTP and use it without verification, thus satisfying the delivery_unsigned criterion which prohibits such insecure practices.


  • Publicly known vulnerabilities fixed


    There MUST be no unpatched vulnerabilities of medium or higher severity that have been publicly known for more than 60 days. [vulnerabilities_fixed_60_days]


    Projects SHOULD fix all critical vulnerabilities rapidly after they are reported. [vulnerabilities_critical_fixed]

  • Other security issues


    The public repositories MUST NOT leak a valid private credential (e.g., a working password or private key) that is intended to limit public access. [no_leaked_credentials]

    Every push to repo is tested for private credentials.


  • Static code analysis


    At least one static code analysis tool (beyond compiler warnings and "safe" language modes) MUST be applied to any proposed major production release of the software before its release, if there is at least one FLOSS tool that implements this criterion in the selected language. [static_analysis]

    CodeQL



    It is SUGGESTED that at least one of the static analysis tools used for the static_analysis criterion include rules or approaches to look for common vulnerabilities in the analyzed language or environment. [static_analysis_common_vulnerabilities]

    CodeQL, OSV-Scanner



    All medium and higher severity exploitable vulnerabilities discovered with static code analysis MUST be fixed in a timely way after they are confirmed. [static_analysis_fixed]


    It is SUGGESTED that static source code analysis occur on every commit or at least daily. [static_analysis_often]

    every pushed to repo commit, and daily.


  • Dynamic code analysis


    It is SUGGESTED that at least one dynamic analysis tool be applied to any proposed major production release of the software before its release. [dynamic_analysis]


    It is SUGGESTED that if the software produced by the project includes software written using a memory-unsafe language (e.g., C or C++), then at least one dynamic tool (e.g., a fuzzer or web application scanner) be routinely used in combination with a mechanism to detect memory safety problems such as buffer overwrites. If the project does not produce software written in a memory-unsafe language, choose "not applicable" (N/A). [dynamic_analysis_unsafe]

    Software written in Golang.



    It is SUGGESTED that the project use a configuration for at least some dynamic analysis (such as testing or fuzzing) which enables many assertions. In many cases these assertions should not be enabled in production builds. [dynamic_analysis_enable_assertions]


    All medium and higher severity exploitable vulnerabilities discovered with dynamic code analysis MUST be fixed in a timely way after they are confirmed. [dynamic_analysis_fixed]


This data is available under the Community Data License Agreement – Permissive, Version 2.0 (CDLA-Permissive-2.0). This means that a Data Recipient may share the Data, with or without modifications, so long as the Data Recipient makes available the text of this agreement with the shared Data. Please credit Marcin Szydelski and the OpenSSF Best Practices badge contributors.

Project badge entry owned by: Marcin Szydelski.
Entry created on 2025-05-15 17:22:51 UTC, last updated on 2025-05-15 22:11:57 UTC.

Back