From 158b826e545ea46b2ff0d4f2133e3456d51d2cf9 Mon Sep 17 00:00:00 2001 From: Renaud Calle Date: Tue, 30 Sep 2025 11:46:10 +0000 Subject: [PATCH 1/3] =?UTF-8?q?=F0=9F=93=84=20license:=20Update=20license?= =?UTF-8?q?=20&=20reuse?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .reuse/dep5 | 8 - LICENSES/BSD-3-Clause.txt | 32 ++-- LICENSES/CC-BY-4.0.txt | 324 -------------------------------------- REUSE.toml | 10 ++ 4 files changed, 28 insertions(+), 346 deletions(-) delete mode 100644 .reuse/dep5 delete mode 100644 LICENSES/CC-BY-4.0.txt create mode 100644 REUSE.toml diff --git a/.reuse/dep5 b/.reuse/dep5 deleted file mode 100644 index 64485b2..0000000 --- a/.reuse/dep5 +++ /dev/null @@ -1,8 +0,0 @@ -Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/ -Upstream-Name: cred-scan -Upstream-Contact: Outscale support -Source: https://gitlab.com/outscale-dev/cred-scan/ - -Files: *.sh *.txt *.md *.yml *.yaml -Copyright: 2022 Outscale SAS -License: BSD-3-Clause diff --git a/LICENSES/BSD-3-Clause.txt b/LICENSES/BSD-3-Clause.txt index 044c737..ae694e9 100644 --- a/LICENSES/BSD-3-Clause.txt +++ b/LICENSES/BSD-3-Clause.txt @@ -1,24 +1,28 @@ -Redistribution and use in source and binary forms, with or without modification, -are permitted provided that the following conditions are met: +BSD 3-Clause License -1. Redistributions of source code must retain the above copyright notice, -this list of conditions and the following disclaimer. +Copyright (c) 2025, Outscale + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: + +1. Redistributions of source code must retain the above copyright notice, this + list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, -this list of conditions and the following disclaimer in the documentation -and/or other materials provided with the distribution. + this list of conditions and the following disclaimer in the documentation + and/or other materials provided with the distribution. -3. Neither the name of the copyright holder nor the names of its contributors -may be used to endorse or promote products derived from this software without -specific prior written permission. +3. Neither the name of the copyright holder nor the names of its + contributors may be used to endorse or promote products derived from + this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE -ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE -LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE +FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, -OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE -USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. \ No newline at end of file +OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. \ No newline at end of file diff --git a/LICENSES/CC-BY-4.0.txt b/LICENSES/CC-BY-4.0.txt deleted file mode 100644 index 40e1c63..0000000 --- a/LICENSES/CC-BY-4.0.txt +++ /dev/null @@ -1,324 +0,0 @@ -Creative Commons Attribution 4.0 International Creative Commons Corporation -("Creative Commons") is not a law firm and does not provide legal services -or legal advice. Distribution of Creative Commons public licenses does not -create a lawyer-client or other relationship. Creative Commons makes its licenses -and related information available on an "as-is" basis. Creative Commons gives -no warranties regarding its licenses, any material licensed under their terms -and conditions, or any related information. Creative Commons disclaims all -liability for damages resulting from their use to the fullest extent possible. - -Using Creative Commons Public Licenses - -Creative Commons public licenses provide a standard set of terms and conditions -that creators and other rights holders may use to share original works of -authorship and other material subject to copyright and certain other rights -specified in the public license below. The following considerations are for -informational purposes only, are not exhaustive, and do not form part of our -licenses. - -Considerations for licensors: Our public licenses are intended for use by -those authorized to give the public permission to use material in ways otherwise -restricted by copyright and certain other rights. Our licenses are irrevocable. -Licensors should read and understand the terms and conditions of the license -they choose before applying it. Licensors should also secure all rights necessary -before applying our licenses so that the public can reuse the material as -expected. Licensors should clearly mark any material not subject to the license. -This includes other CC-licensed material, or material used under an exception -or limitation to copyright. More considerations for licensors : wiki.creativecommons.org/Considerations_for_licensors - -Considerations for the public: By using one of our public licenses, a licensor -grants the public permission to use the licensed material under specified -terms and conditions. If the licensor's permission is not necessary for any -reason–for example, because of any applicable exception or limitation to copyright–then -that use is not regulated by the license. Our licenses grant only permissions -under copyright and certain other rights that a licensor has authority to -grant. Use of the licensed material may still be restricted for other reasons, -including because others have copyright or other rights in the material. A -licensor may make special requests, such as asking that all changes be marked -or described. Although not required by our licenses, you are encouraged to -respect those requests where reasonable. More considerations for the public -: wiki.creativecommons.org/Considerations_for_licensees Creative Commons Attribution -4.0 International Public License - -By exercising the Licensed Rights (defined below), You accept and agree to -be bound by the terms and conditions of this Creative Commons Attribution -4.0 International Public License ("Public License"). To the extent this Public -License may be interpreted as a contract, You are granted the Licensed Rights -in consideration of Your acceptance of these terms and conditions, and the -Licensor grants You such rights in consideration of benefits the Licensor -receives from making the Licensed Material available under these terms and -conditions. - -Section 1 – Definitions. - -a. Adapted Material means material subject to Copyright and Similar Rights -that is derived from or based upon the Licensed Material and in which the -Licensed Material is translated, altered, arranged, transformed, or otherwise -modified in a manner requiring permission under the Copyright and Similar -Rights held by the Licensor. For purposes of this Public License, where the -Licensed Material is a musical work, performance, or sound recording, Adapted -Material is always produced where the Licensed Material is synched in timed -relation with a moving image. - -b. Adapter's License means the license You apply to Your Copyright and Similar -Rights in Your contributions to Adapted Material in accordance with the terms -and conditions of this Public License. - -c. Copyright and Similar Rights means copyright and/or similar rights closely -related to copyright including, without limitation, performance, broadcast, -sound recording, and Sui Generis Database Rights, without regard to how the -rights are labeled or categorized. For purposes of this Public License, the -rights specified in Section 2(b)(1)-(2) are not Copyright and Similar Rights. - -d. Effective Technological Measures means those measures that, in the absence -of proper authority, may not be circumvented under laws fulfilling obligations -under Article 11 of the WIPO Copyright Treaty adopted on December 20, 1996, -and/or similar international agreements. - -e. Exceptions and Limitations means fair use, fair dealing, and/or any other -exception or limitation to Copyright and Similar Rights that applies to Your -use of the Licensed Material. - -f. Licensed Material means the artistic or literary work, database, or other -material to which the Licensor applied this Public License. - -g. Licensed Rights means the rights granted to You subject to the terms and -conditions of this Public License, which are limited to all Copyright and -Similar Rights that apply to Your use of the Licensed Material and that the -Licensor has authority to license. - -h. Licensor means the individual(s) or entity(ies) granting rights under this -Public License. - -i. Share means to provide material to the public by any means or process that -requires permission under the Licensed Rights, such as reproduction, public -display, public performance, distribution, dissemination, communication, or -importation, and to make material available to the public including in ways -that members of the public may access the material from a place and at a time -individually chosen by them. - -j. Sui Generis Database Rights means rights other than copyright resulting -from Directive 96/9/EC of the European Parliament and of the Council of 11 -March 1996 on the legal protection of databases, as amended and/or succeeded, -as well as other essentially equivalent rights anywhere in the world. - -k. You means the individual or entity exercising the Licensed Rights under -this Public License. Your has a corresponding meaning. - -Section 2 – Scope. - - a. License grant. - -1. Subject to the terms and conditions of this Public License, the Licensor -hereby grants You a worldwide, royalty-free, non-sublicensable, non-exclusive, -irrevocable license to exercise the Licensed Rights in the Licensed Material -to: - - A. reproduce and Share the Licensed Material, in whole or in part; and - - B. produce, reproduce, and Share Adapted Material. - -2. Exceptions and Limitations. For the avoidance of doubt, where Exceptions -and Limitations apply to Your use, this Public License does not apply, and -You do not need to comply with its terms and conditions. - - 3. Term. The term of this Public License is specified in Section 6(a). - -4. Media and formats; technical modifications allowed. The Licensor authorizes -You to exercise the Licensed Rights in all media and formats whether now known -or hereafter created, and to make technical modifications necessary to do -so. The Licensor waives and/or agrees not to assert any right or authority -to forbid You from making technical modifications necessary to exercise the -Licensed Rights, including technical modifications necessary to circumvent -Effective Technological Measures. For purposes of this Public License, simply -making modifications authorized by this Section 2(a)(4) never produces Adapted -Material. - - 5. Downstream recipients. - -A. Offer from the Licensor – Licensed Material. Every recipient of the Licensed -Material automatically receives an offer from the Licensor to exercise the -Licensed Rights under the terms and conditions of this Public License. - -B. No downstream restrictions. You may not offer or impose any additional -or different terms or conditions on, or apply any Effective Technological -Measures to, the Licensed Material if doing so restricts exercise of the Licensed -Rights by any recipient of the Licensed Material. - -6. No endorsement. Nothing in this Public License constitutes or may be construed -as permission to assert or imply that You are, or that Your use of the Licensed -Material is, connected with, or sponsored, endorsed, or granted official status -by, the Licensor or others designated to receive attribution as provided in -Section 3(a)(1)(A)(i). - - b. Other rights. - -1. Moral rights, such as the right of integrity, are not licensed under this -Public License, nor are publicity, privacy, and/or other similar personality -rights; however, to the extent possible, the Licensor waives and/or agrees -not to assert any such rights held by the Licensor to the limited extent necessary -to allow You to exercise the Licensed Rights, but not otherwise. - -2. Patent and trademark rights are not licensed under this Public License. - -3. To the extent possible, the Licensor waives any right to collect royalties -from You for the exercise of the Licensed Rights, whether directly or through -a collecting society under any voluntary or waivable statutory or compulsory -licensing scheme. In all other cases the Licensor expressly reserves any right -to collect such royalties. - -Section 3 – License Conditions. - -Your exercise of the Licensed Rights is expressly made subject to the following -conditions. - - a. Attribution. - -1. If You Share the Licensed Material (including in modified form), You must: - -A. retain the following if it is supplied by the Licensor with the Licensed -Material: - -i. identification of the creator(s) of the Licensed Material and any others -designated to receive attribution, in any reasonable manner requested by the -Licensor (including by pseudonym if designated); - - ii. a copyright notice; - - iii. a notice that refers to this Public License; - - iv. a notice that refers to the disclaimer of warranties; - -v. a URI or hyperlink to the Licensed Material to the extent reasonably practicable; - -B. indicate if You modified the Licensed Material and retain an indication -of any previous modifications; and - -C. indicate the Licensed Material is licensed under this Public License, and -include the text of, or the URI or hyperlink to, this Public License. - -2. You may satisfy the conditions in Section 3(a)(1) in any reasonable manner -based on the medium, means, and context in which You Share the Licensed Material. -For example, it may be reasonable to satisfy the conditions by providing a -URI or hyperlink to a resource that includes the required information. - -3. If requested by the Licensor, You must remove any of the information required -by Section 3(a)(1)(A) to the extent reasonably practicable. - -4. If You Share Adapted Material You produce, the Adapter's License You apply -must not prevent recipients of the Adapted Material from complying with this -Public License. - -Section 4 – Sui Generis Database Rights. - -Where the Licensed Rights include Sui Generis Database Rights that apply to -Your use of the Licensed Material: - -a. for the avoidance of doubt, Section 2(a)(1) grants You the right to extract, -reuse, reproduce, and Share all or a substantial portion of the contents of -the database; - -b. if You include all or a substantial portion of the database contents in -a database in which You have Sui Generis Database Rights, then the database -in which You have Sui Generis Database Rights (but not its individual contents) -is Adapted Material; and - -c. You must comply with the conditions in Section 3(a) if You Share all or -a substantial portion of the contents of the database. - -For the avoidance of doubt, this Section 4 supplements and does not replace -Your obligations under this Public License where the Licensed Rights include -other Copyright and Similar Rights. - -Section 5 – Disclaimer of Warranties and Limitation of Liability. - -a. Unless otherwise separately undertaken by the Licensor, to the extent possible, -the Licensor offers the Licensed Material as-is and as-available, and makes -no representations or warranties of any kind concerning the Licensed Material, -whether express, implied, statutory, or other. This includes, without limitation, -warranties of title, merchantability, fitness for a particular purpose, non-infringement, -absence of latent or other defects, accuracy, or the presence or absence of -errors, whether or not known or discoverable. Where disclaimers of warranties -are not allowed in full or in part, this disclaimer may not apply to You. - -b. To the extent possible, in no event will the Licensor be liable to You -on any legal theory (including, without limitation, negligence) or otherwise -for any direct, special, indirect, incidental, consequential, punitive, exemplary, -or other losses, costs, expenses, or damages arising out of this Public License -or use of the Licensed Material, even if the Licensor has been advised of -the possibility of such losses, costs, expenses, or damages. Where a limitation -of liability is not allowed in full or in part, this limitation may not apply -to You. - -c. The disclaimer of warranties and limitation of liability provided above -shall be interpreted in a manner that, to the extent possible, most closely -approximates an absolute disclaimer and waiver of all liability. - -Section 6 – Term and Termination. - -a. This Public License applies for the term of the Copyright and Similar Rights -licensed here. However, if You fail to comply with this Public License, then -Your rights under this Public License terminate automatically. - -b. Where Your right to use the Licensed Material has terminated under Section -6(a), it reinstates: - -1. automatically as of the date the violation is cured, provided it is cured -within 30 days of Your discovery of the violation; or - - 2. upon express reinstatement by the Licensor. - -c. For the avoidance of doubt, this Section 6(b) does not affect any right -the Licensor may have to seek remedies for Your violations of this Public -License. - -d. For the avoidance of doubt, the Licensor may also offer the Licensed Material -under separate terms or conditions or stop distributing the Licensed Material -at any time; however, doing so will not terminate this Public License. - - e. Sections 1, 5, 6, 7, and 8 survive termination of this Public License. - -Section 7 – Other Terms and Conditions. - -a. The Licensor shall not be bound by any additional or different terms or -conditions communicated by You unless expressly agreed. - -b. Any arrangements, understandings, or agreements regarding the Licensed -Material not stated herein are separate from and independent of the terms -and conditions of this Public License. - -Section 8 – Interpretation. - -a. For the avoidance of doubt, this Public License does not, and shall not -be interpreted to, reduce, limit, restrict, or impose conditions on any use -of the Licensed Material that could lawfully be made without permission under -this Public License. - -b. To the extent possible, if any provision of this Public License is deemed -unenforceable, it shall be automatically reformed to the minimum extent necessary -to make it enforceable. If the provision cannot be reformed, it shall be severed -from this Public License without affecting the enforceability of the remaining -terms and conditions. - -c. No term or condition of this Public License will be waived and no failure -to comply consented to unless expressly agreed to by the Licensor. - -d. Nothing in this Public License constitutes or may be interpreted as a limitation -upon, or waiver of, any privileges and immunities that apply to the Licensor -or You, including from the legal processes of any jurisdiction or authority. - -Creative Commons is not a party to its public licenses. Notwithstanding, Creative -Commons may elect to apply one of its public licenses to material it publishes -and in those instances will be considered the "Licensor." The text of the -Creative Commons public licenses is dedicated to the public domain under the -CC0 Public Domain Dedication. Except for the limited purpose of indicating -that material is shared under a Creative Commons public license or as otherwise -permitted by the Creative Commons policies published at creativecommons.org/policies, -Creative Commons does not authorize the use of the trademark "Creative Commons" -or any other trademark or logo of Creative Commons without its prior written -consent including, without limitation, in connection with any unauthorized -modifications to any of its public licenses or any other arrangements, understandings, -or agreements concerning use of licensed material. For the avoidance of doubt, -this paragraph does not form part of the public licenses. - -Creative Commons may be contacted at creativecommons.org. \ No newline at end of file diff --git a/REUSE.toml b/REUSE.toml new file mode 100644 index 0000000..221c170 --- /dev/null +++ b/REUSE.toml @@ -0,0 +1,10 @@ +version = 1 +SPDX-PackageName = "cred-scan" +SPDX-PackageSupplier = "Outscale " +SPDX-PackageDownloadLocation = "https://github.com/outscale/cred-scan/" + +[[annotations]] +path = ["**.sh", "**.txt", "**.md", "**.yml", "**.yaml"] +precedence = "aggregate" +SPDX-FileCopyrightText = "2025 Outscale SAS " +SPDX-License-Identifier = "BSD-3-Clause" From 7254fb1330250323dc03c75a20220e79dede5069 Mon Sep 17 00:00:00 2001 From: Renaud Calle Date: Tue, 30 Sep 2025 11:47:06 +0000 Subject: [PATCH 2/3] =?UTF-8?q?=F0=9F=92=9A=20ci:=20Fix=20ci=20actions?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/workflows/github-sanity-scan.yml | 7 +++++-- .github/workflows/pull-request.yml | 2 +- 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/.github/workflows/github-sanity-scan.yml b/.github/workflows/github-sanity-scan.yml index 7e5fb55..5df1fb9 100644 --- a/.github/workflows/github-sanity-scan.yml +++ b/.github/workflows/github-sanity-scan.yml @@ -4,11 +4,14 @@ on: pull_request: branches: [ main ] +permissions: + contents: read + jobs: github-sanity-scan: - runs-on: ubuntu-20.04 + runs-on: ubuntu-latest steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v5 - name: Github sanity scanner uses: outscale/github-sanity-scan@main with: diff --git a/.github/workflows/pull-request.yml b/.github/workflows/pull-request.yml index e6adf98..88adb20 100644 --- a/.github/workflows/pull-request.yml +++ b/.github/workflows/pull-request.yml @@ -8,7 +8,7 @@ jobs: scan: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v5 - name: Install shellcheck run: sudo apt-get install -y shellcheck - name: Run tests From b8cf517d007b7b59ad0c16c028848f6341197b22 Mon Sep 17 00:00:00 2001 From: Renaud Calle Date: Tue, 30 Sep 2025 11:47:48 +0000 Subject: [PATCH 3/3] =?UTF-8?q?=F0=9F=93=9D=20docs:=20Update=20Readme?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- CODE_OF_CONDUCT.md | 44 ++++++++++++ CONTRIBUTING.md | 56 ++++++++++++++++ README.md | 162 +++++++++++++++++++++++++++++++-------------- 3 files changed, 211 insertions(+), 51 deletions(-) create mode 100644 CODE_OF_CONDUCT.md create mode 100644 CONTRIBUTING.md diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..8beabf7 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,44 @@ +# Code of Conduct + +This project follows the [Contributor Covenant](https://www.contributor-covenant.org) Code of Conduct. + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our project and community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment include: + +- Demonstrating empathy and kindness +- Being respectful of differing viewpoints and experiences +- Giving and gracefully accepting constructive feedback +- Taking responsibility and apologizing to those affected by mistakes +- Focusing on what is best for the community + +Examples of unacceptable behavior include: + +- The use of sexualized language or imagery +- Trolling, insulting, or derogatory comments +- Public or private harassment +- Publishing others’ private information without explicit permission +- Other conduct which could reasonably be considered inappropriate + +## Enforcement Responsibilities + +Project maintainers are responsible for clarifying and enforcing this code of conduct and will take appropriate and fair corrective action in response to any behavior they deem inappropriate. + +## Reporting + +If you experience or witness unacceptable behavior, please report it via one of the following channels: + +- 💬 [Discord](https://discord.gg/HUVtY5gT6s) +- 📧 [opensource@outscale.com](mailto:opensource@outscale.com) + +Reports will be handled confidentially and reviewed promptly. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant, version 2.1](https://www.contributor-covenant.org/version/2/1/code_of_conduct.html). diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..35a38e4 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,56 @@ +# Contributing Guidelines + +First off, thank you for taking the time to contribute! 🙌 +Your help is appreciated and helps make this project better for everyone. + +--- + +## How to Contribute + +### 🐛 Reporting Bugs +If you find a bug, please open an issue and include: +- A clear and descriptive title +- Steps to reproduce the issue +- Expected and actual behavior +- Any relevant logs, screenshots, or environment information + +### ✨ Suggesting Enhancements +Have an idea for a new feature or improvement? +- Open an issue and describe your suggestion +- Explain the use case and potential benefits +- Optional: propose an implementation strategy + +### 🛠️ Submitting Code Changes +To submit a patch or enhancement: +1. Fork the repository +2. Create a new branch (`git checkout -b feature/your-feature-name`) +3. Make your changes +4. Test your changes (if applicable) +5. Open a pull request with a clear description of your changes + +### ✅ Code of Conduct +By participating, you agree to uphold our [Code of Conduct](CODE_OF_CONDUCT.md). + +--- + +## Guidelines + +- Keep pull requests focused and atomic (one feature or fix per PR). +- Follow any existing code style or formatting conventions. +- Document your code where necessary. +- Include tests when adding new logic (if applicable). +- Use clear, meaningful commit messages (optionally following [Conventional Commits](https://www.conventionalcommits.org/) and using [Gitmoji](https://gitmoji.dev/) for added clarity and consistency). + +## 📝 Commit Template + +To help you follow the Gitmoji and Conventional Commit format, you can enable the local commit template: + +```bash +git config commit.template .github/commit-template.txt +``` + +--- + +## Questions? + +If you have any questions or need help, feel free to [open an issue](../../issues) or reach out to the maintainers on [Discord](https://discord.gg/HUVtY5gT6s). diff --git a/README.md b/README.md index 3727234..11b87cc 100644 --- a/README.md +++ b/README.md @@ -1,83 +1,143 @@ # Credential Scanner -[![Project Graduated](https://docs.outscale.com/fr/userguide/_images/Project-Graduated-green.svg)](https://docs.outscale.com/en/userguide/Open-Source-Projects.html) -This small bash script will scan for leaked [Access Keys or Secret Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html) in a folder. +[![Project Graduated](https://docs.outscale.com/fr/userguide/_images/Project-Graduated-green.svg)](https://docs.outscale.com/en/userguide/Open-Source-Projects.html) [![](https://dcbadge.limes.pink/api/server/HUVtY5gT6s?style=flat&theme=default-inverted)](https://discord.gg/HUVtY5gT6s) -# Usage +

+ Key Icon +
+ Detect leaked Access Keys and Secret Keys in your codebase. +

-Just provide the folder to scan (recursively): -Example -``` -./scan.sh FOLDER_PATH -``` +--- + +## 🌐 Links + +* 🔑 About Access Keys: [Outscale Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html) +* ⚙️ GitHub Action: [action.yml](./action.yml) +* 🧪 Test Script: [tests/tests.sh](./tests/tests.sh) +* 🤝 Contribution Guide: [CONTRIBUTING.md](./CONTRIBUTING.md) +* 💬 Join us on [Discord](https://discord.gg/YOUR_INVITE_CODE) + +--- + +## 📄 Table of Contents + +* [Overview](#-overview) +* [Features](#-features) +* [Requirements](#-requirements) +* [Usage](#-usage) +* [GitHub Actions Integration](#-github-actions-integration) +* [Contributing](#-contributing) +* [License](#-license) + +--- + +## 🧭 Overview + +**Credential Scanner** is a lightweight Bash script that recursively scans a directory for leaked [Outscale Access Keys and Secret Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). + +It skips binary files and uses strict patterns to avoid false positives and catch high-confidence secrets. + +--- + +## ✨ Features + +* Recursive scanning of directories +* Skips binary files +* Detects: + + * Access Keys (20-character uppercase alphanumeric) + * Secret Keys (40-character uppercase alphanumeric) +* Ignores known test keys: + + * `ABCDEFGHIJ0123456789` + * `0123456789ABCDEFGHIJ` +* Ignores weak matches: -# Features + * Access Keys with <3 digits or <3 uppercase letters + * Secret Keys with <5 digits or <5 uppercase letters -- Skip binary files -- Search for: - - Access Keys (20 capital alphanumeric random string) - - Secret Keys (40 capital alphanumeric random string) -- Special Access Keys are ignored: - - `ABCDEFGHIJ0123456789` - - `0123456789ABCDEFGHIJ` -- Access Keys withs less than 3 digits or less than 3 capital alphabetic characters are ignored. -- Secret Keys with less than 5 digits or less than 5 capital alphabetic characters are ignored. +--- -# Contributing +## ✅ Requirements -Feel free to open an issue for discussion. -`./tests/tests.sh` to run tests. +* Bash shell (Linux/macOS/WSL) +* `grep`, `find`, and standard POSIX utilities -# Using scanner in Github actions +--- -## Description +## 🚀 Usage -This Github action allows you to scan for leaked credentials. -See [action.yml](action.yml) +```bash +./scan.sh /path/to/your/codebase +``` + +Example: + +```bash +./scan.sh ./src/ +``` + +--- + +## 🧪 GitHub Actions Integration + +You can integrate this scanner directly into your GitHub workflows to detect secrets on pull requests. + +### 📥 Inputs -## Inputs +| Input | Description | Required | Default | +| ----------- | ------------ | -------- | ------- | +| `scan_path` | Path to scan | ✅ Yes | `"./"` | -| Parameter | Description | Required | Default | -| :------------------ | :-------------------------------------------------------------------- | :------- | :-------- | -| `scan_path` | Folder to scan | `true` | `"./"` | +### 📤 Outputs -## Output -N/A +None -## Example +### 🧾 Example Workflow -- Create workflow folder: `mkdir -p .github/workflows` -- Add new workflow `.github/workflows/cred-scan.yml`: +Create a file at `.github/workflows/cred-scan.yml`: ```yaml name: Credential Scanner on: pull_request: - branches: [ master ] + branches: [ main ] + +permissions: + contents: read jobs: cred-scan: - runs-on: ubuntu-20.04 + runs-on: ubuntu-latest steps: - - uses: actions/checkout@v2 - - name: Scan credentials - uses: outscale-dev/cred-scan@main - with: - scan_path: "./" + - uses: actions/checkout@v5 + - name: Scan credentials + uses: outscale/cred-scan@main + with: + scan_path: "./" ``` -# License +--- -> Copyright Outscale SAS -> -> BSD-3-Clause +## 🤝 Contributing -`LICENSE` folder contain raw licenses terms following spdx naming. +We welcome contributions and discussions! -You can check which license apply to which copyright owner through `.reuse/dep5` specification. +* Run tests with: -You can test [reuse](https://reuse.software/.) compliance by running: -``` -docker run --rm --volume $(pwd):/data fsfe/reuse:0.11.1 lint -``` + ```bash + ./tests/tests.sh + ``` + +Please read our [Contributing Guidelines](CONTRIBUTING.md) and [Code of Conduct](CODE_OF_CONDUCT.md) before submitting a pull request. + +--- + +## 📜 License + +**Credential Scanner** is licensed under the BSD 3-Clause License. +© Outscale SAS + +This project follows the [REUSE Specification](https://reuse.software/).