{"id":18302324,"url":"https://github.com/outscale/cred-scan","last_synced_at":"2025-07-25T21:15:29.824Z","repository":{"id":94912499,"uuid":"467932401","full_name":"outscale/cred-scan","owner":"outscale","description":"Scan for leaked AK/SK","archived":false,"fork":false,"pushed_at":"2023-04-07T10:23:38.000Z","size":39,"stargazers_count":1,"open_issues_count":2,"forks_count":0,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-03-16T05:31:54.086Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/outscale.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSES/BSD-3-Clause.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-03-09T13:11:54.000Z","updated_at":"2023-02-20T13:48:55.000Z","dependencies_parsed_at":"2024-12-23T02:41:02.352Z","dependency_job_id":"60c70c62-9e9c-440f-8a62-519d9f308268","html_url":"https://github.com/outscale/cred-scan","commit_stats":{"total_commits":14,"total_committers":2,"mean_commits":7.0,"dds":0.0714285714285714,"last_synced_commit":"4667a36ab007b54442745277ac34d0c5c8d8e158"},"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/outscale%2Fcred-scan","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/outscale%2Fcred-scan/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/outscale%2Fcred-scan/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/outscale%2Fcred-scan/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/outscale","download_url":"https://codeload.github.com/outscale/cred-scan/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248018061,"owners_count":21034048,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-05T15:19:18.368Z","updated_at":"2025-04-09T10:10:43.276Z","avatar_url":"https://github.com/outscale.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Credential Scanner\n[![Project Graduated](https://docs.outscale.com/fr/userguide/_images/Project-Graduated-green.svg)](https://docs.outscale.com/en/userguide/Open-Source-Projects.html)\n\nThis 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.\n\n# Usage\n\nJust provide the folder to scan (recursively):\nExample\n```\n./scan.sh FOLDER_PATH\n```\n\n# Features\n\n- Skip binary files\n- Search for:\n  - Access Keys (20 capital alphanumeric random string)\n  - Secret Keys (40 capital alphanumeric random string)\n- Special Access Keys are ignored:\n  - `ABCDEFGHIJ0123456789`\n  - `0123456789ABCDEFGHIJ`\n- Access Keys withs less than 3 digits or less than 3 capital alphabetic characters are ignored.\n- Secret Keys with less than 5 digits or less than 5 capital alphabetic characters are ignored.\n\n# Contributing\n\nFeel free to open an issue for discussion.\n`./tests/tests.sh` to run tests.\n\n# Using scanner in Github actions\n\n## Description\n\nThis Github action allows you to scan for leaked credentials.\nSee [action.yml](action.yml)\n\n## Inputs\n\n| Parameter           | Description                                                           | Required | Default   |\n| :------------------ | :-------------------------------------------------------------------- | :------- | :-------- |\n| `scan_path`         | Folder to scan                                                        | `true`   | `\"./\"`    |\n\n## Output\nN/A\n\n## Example\n\n- Create workflow folder: `mkdir -p .github/workflows`\n- Add new workflow `.github/workflows/cred-scan.yml`:\n\n```yaml\nname: Credential Scanner\n\non:\n  pull_request:\n    branches: [ master ]\n\njobs:\n  cred-scan:\n    runs-on: ubuntu-20.04\n    steps:\n    - uses: actions/checkout@v2\n    - name: Scan credentials\n      uses: outscale-dev/cred-scan@main\n      with:\n        scan_path: \"./\"\n```\n\n# License\n\n\u003e Copyright Outscale SAS\n\u003e\n\u003e BSD-3-Clause\n\n`LICENSE` folder contain raw licenses terms following spdx naming.\n\nYou can check which license apply to which copyright owner through `.reuse/dep5` specification.\n\nYou can test [reuse](https://reuse.software/.) compliance by running:\n```\ndocker run --rm --volume $(pwd):/data fsfe/reuse:0.11.1 lint\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foutscale%2Fcred-scan","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foutscale%2Fcred-scan","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foutscale%2Fcred-scan/lists"}