detect-secrets 0.0.0-development

package/CONTRIBUTING.md

@@ -0,0 +1,74 @@
+# Contributing
+
+Thanks for taking the time to contribute! Issues, ideas, and PRs are all welcome.
+The notes below are guidelines to help your contribution land smoothly. If in doubt, open the thing anyway and we'll figure it out together.
+
+## Opening an issue
+
+A good issue gives us enough to reproduce or understand the ask. Useful things to include:
+
+- **For bugs:** what you expected, what actually happened, and the shortest repro you can manage. Versions (runtime, OS, package) and stack traces help.
+- **For features:** the problem you're trying to solve, not just the solution you have in mind. A concrete example of how you'd use it is gold.
+
+A quick search of existing issues helps avoid duplicates, but don't agonize over it.
+
+## Proposing a PR
+
+PRs are expected to meet a few baseline requirements before review:
+
+- **Tests are required** for any behavior change, new features need new tests, bug fixes need a regression test that fails without the fix.
+- **Existing tests must pass** locally and in CI. Don't disable or skip tests to make a PR green.
+- **Coverage should not regress.** If your change drops coverage meaningfully, add tests or explain why in the PR description.
+- **Linters and type checks must pass.** Run them locally before pushing; CI will reject otherwise.
+- **One logical change per PR.** Refactors, formatting churn, and unrelated fixes belong in separate PRs, it makes review and revert sane.
+- **Describe what and why.** A PR title and a few lines of context go a long way, reviewers shouldn't have to reverse-engineer your intent from the diff.
+- **Link the issue you're closing.** If your PR resolves an open issue, include a `Related issues` section in the description with `Fixes: #<issue-number>` (or `Closes: #<issue-number>`) so GitHub auto-closes it on merge.
+- **Breaking changes need a heads-up** in the PR description, plus a migration note for users.
+
+Large or speculative changes: open an issue first to align on direction before investing time.
+
+## Commit guidelines
+
+This project follows [Conventional Commits](https://www.conventionalcommits.org/). The format is:
+
+```text
+<type>(<optional scope>): <short summary>
+```
+
+Common types:
+
+- `feat:` — a new feature
+- `fix:` — a bug fix
+- `docs:` — documentation only
+- `refactor:` — code change that neither fixes a bug nor adds a feature
+- `test:` — adding or fixing tests
+- `chore:` — tooling, build, dependencies
+- `perf:` — performance improvement
+
+Examples:
+
+```text
+feat: support multiple input files
+fix(parser): handle empty input gracefully
+docs: clarify install instructions
+```
+
+Breaking changes: add `!` after the type (`feat!: ...`) and explain the break in the commit body.
+
+This format drives changelog generation and release automation, so it matters more than the average commit-style guide.
+
+## Local development
+
+1. Fork and clone the repository.
+2. Install dependencies using the project's package manager (see `package.json`, or equivalent).
+3. Run the test suite to confirm a clean baseline before making changes.
+4. Run the linter and type checker (if configured) the same way.
+5. Make your change on a feature branch, commit using the format above, and open a PR.
+
+If any of the above doesn't work on a fresh checkout, that's a bug, please open an issue.
+
+## For automated agents
+
+If you are an AI coding agent or automated bot opening a PR, please add 🤖🤖🤖 to the end of the PR title. This helps maintainers triage agent-authored contributions and is a baseline expectation for this repo — PRs without the marker that turn out to be automated may be closed without review.
+
+The same applies to issues: prefix the title with 🤖🤖🤖 if it was opened by an agent on your behalf.

package/LICENSE

@@ -0,0 +1,191 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        https://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2019 Liran Tal <liran.tal@gmail.com>.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       https://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,100 @@
+<p align="center"><h1 align="center">
+  detect-secrets
+</h1>
+
+<p align="center">
+  A developer-friendly secrets detection tool for CI and pre-commit hooks
+</p>
+
+<p align="center">
+  <a href="https://www.npmjs.org/package/detect-secrets"><img src="https://badgen.net/npm/v/detect-secrets" alt="npm version"/></a>
+  <a href="https://www.npmjs.org/package/detect-secrets"><img src="https://badgen.net/npm/license/detect-secrets" alt="license"/></a>
+  <a href="https://www.npmjs.org/package/detect-secrets"><img src="https://badgen.net/npm/dt/detect-secrets" alt="downloads"/></a>
+  <a href="https://github.com/lirantal/detect-secrets/actions/workflows/ci.yml"><img src="https://github.com/lirantal/detect-secrets/actions/workflows/ci.yml/badge.svg?branch=master" alt="build"/></a>
+  <a href="https://codecov.io/gh/lirantal/detect-secrets"><img src="https://badgen.net/codecov/c/github/lirantal/detect-secrets" alt="codecov"/></a>
+</p>
+
+# About
+
+The `detect-secrets` npm package is a Node.js-based wrapper for Yelp's [detect-secrets](https://github.com/Yelp/detect-secrets) tool that aims to provide an accessible and developer-friendly method of introducing secrets detection in pre-commit hooks.
+
+Yelp's detect-secrets is based on Python and requires explicit installation from developers. Moreover, its installation may be challenging in different operating systems. `detect-secrets` aims to alleviate this challenge by:
+
+1. Attempt to locate Yelp's detect-secrets tool, and if it exists in the path to execute it.
+
+If it fails it continues to:
+
+2. Attempt to locate the docker binary and if it exists it will download and execute the docker container for [lirantal/detect-secrets](https://github.com/lirantal/docker-detect-secrets) which has Yelp's detect-secrets inside the image.
+
+If this fails as well:
+
+3. Exit with a warning message
+
+--
+
+The above described fallback strategy is used to find an available method of executing the detect-secrets tool to protect the developer from leaking secrets into source code control.
+
+# Install
+
+```bash
+npm install --save detect-secrets
+```
+
+This will expose `detect-secrets-launcher` Node.js executable file.
+
+Another way to invoke it is with npx which will download and execute the detect-secrets wrapper on the fly:
+
+```bash
+npx detect-secrets [arguments]
+```
+
+# Usage
+
+If you're using `husky` to manage pre-commit hooks configuration, then enabling secrets detection is as simple as adding another hook entry.
+
+```js
+"husky": {
+    "hooks": {
+      "pre-commit": "detect-secrets-launcher src/*"
+    }
+  }
+```
+
+If you're using `husky` and `lint-staged` to manage pre-commit hooks configuration and running static code analysis on staged files, then enabling secrets detection is as simple as adding another lint-staged entry.
+
+A typical setup will look like this as an example:
+
+```js
+"husky": {
+  "hooks": {
+    "pre-commit": "lint-staged"
+  },
+},
+"lint-staged": {
+  "linters": {
+    "**/*.js": [
+      "detect-secrets-launcher --baseline .secrets-baseline"
+    ]
+  }
+}
+```
+
+If you're not using a baseline file (it is created using Yelp's server-side detect-secrets tool) then you can simply omit this out and keep it as simple as `detect-secrets-launcher`.
+
+# Example
+
+To scan the `index.js` file within a repository for the potential of leaked secrets inside it run the following:
+
+```bash
+detect-secrets-launcher index.js
+```
+
+Note that `index.js` has to be staged and versioned control. Any other plain file that is not known to git will not be scanned.
+
+# Contributing
+
+Please consult [CONTIRBUTING](./CONTRIBUTING.md) for guidelines on contributing to this project.
+
+# Author
+
+**detect-secrets** © [Liran Tal](https://github.com/lirantal), Released under the [Apache-2.0](./LICENSE) License.

package/__tests__/cli.test.js

@@ -0,0 +1,46 @@
+/* eslint-disable security/detect-child-process */
+'use strict'
+
+const cli = require('../src/cli')
+
+describe('detect-secrets-launcher CLI', () => {
+  test('when successful to spawn detect-secrets-hook should use exit code 1', () => {
+    const executableStrategies = [
+      {
+        type: 'ls',
+        filePath: 'ls'
+      }
+    ]
+
+    const result = cli.start(executableStrategies)
+    expect(result.strategyExitCode).toBe(0)
+    expect(result.strategiesInvoked).toBe(true)
+  })
+
+  test('when failed to spawn executable should return exit code 1', () => {
+    const executableStrategies = [
+      {
+        type: 'made up command',
+        filePath: 'ls',
+        // fake command arguments to make 'ls' command fail
+        prefixCommandArguments: ['-ala-s33s']
+      }
+    ]
+
+    const result = cli.start(executableStrategies)
+    expect(result.strategyExitCode).not.toBe(0)
+    expect(result.strategiesInvoked).toBe(true)
+  })
+
+  test('should not invoke strategy when not existing', () => {
+    const executableStrategies = [
+      {
+        type: 'made up command',
+        filePath: 'made up command'
+      }
+    ]
+
+    const result = cli.start(executableStrategies)
+    expect(result.strategiesInvoked).toBe(false)
+  })
+})

package/__tests__/cli.unit.test.js

@@ -0,0 +1,37 @@
+'use strict'
+
+describe('Unit testing CLI', () => {
+  beforeEach(() => {
+    jest.resetModules()
+  })
+
+  test('should only invoke one strategy if more than one exists', () => {
+    jest.doMock('../src/strategies.js', () => {
+      return {
+        executeStrategy: jest.fn(() => {
+          return 0
+        }),
+        isExecutableAvailableInPath: jest.fn(() => {
+          return true
+        })
+      }
+    })
+    const strategies = require('../src/strategies')
+    const cli = require('../src/cli')
+
+    const executableStrategies = [
+      {
+        type: 'ls',
+        filePath: 'ls'
+      },
+      {
+        type: 'ls',
+        filePath: 'ls'
+      }
+    ]
+
+    const result = cli.start(executableStrategies)
+    expect(result.strategiesInvoked).toEqual(true)
+    expect(strategies.executeStrategy.mock.calls.length).toBe(1)
+  })
+})

package/__tests__/executeStrategy.test.js

@@ -0,0 +1,69 @@
+/* eslint-disable security/detect-child-process */
+'use strict'
+
+const ChildProcess = require('child_process')
+jest.mock('child_process', () => {
+  return {
+    spawnSync: jest.fn()
+  }
+})
+
+process.exit = jest.fn()
+
+const {executeStrategy} = require('../src/strategies')
+
+describe('Strategies: executeStrategy', () => {
+  beforeAll(() => {
+    process.exit.mockClear()
+    ChildProcess.spawnSync.mockClear()
+    ChildProcess.spawnSync.mockReset()
+  })
+
+  test('when no arguments provided it shouldnt add anything to the spawned process', () => {
+    process.argv = []
+
+    const mockStrategy = {
+      type: 'ls',
+      filePath: 'ls'
+    }
+
+    ChildProcess.spawnSync = jest.fn(() => {
+      return {
+        status: 0,
+        stdout: '',
+        stderr: ''
+      }
+    })
+
+    const exitCode = executeStrategy(mockStrategy)
+
+    expect(exitCode).toBe(0)
+    expect(ChildProcess.spawnSync.mock.calls.length).toBe(1)
+    expect(ChildProcess.spawnSync.mock.calls[0][1]).toEqual([])
+  })
+
+  test('when arguments provided it should add them to the arguments of the command being spawned', () => {
+    process.argv = []
+
+    const mockedArguments = ['a', 'b', 'c']
+    const mockStrategy = {
+      type: 'ls',
+      filePath: 'ls',
+      prefixCommandArguments: mockedArguments
+    }
+
+    ChildProcess.spawnSync = jest.fn(() => {
+      return {
+        status: 1,
+        stdout: '',
+        stderr: ''
+      }
+    })
+
+    const exitCode = executeStrategy(mockStrategy)
+
+    expect(exitCode).toBe(1)
+    expect(ChildProcess.spawnSync.mock.calls.length).toBe(1)
+    expect(ChildProcess.spawnSync.mock.calls[0][1]).toEqual(mockedArguments)
+  })
+})

package/__tests__/isExecutableAvailableInPath.test.js

@@ -0,0 +1,17 @@
+'use strict'
+
+const {isExecutableAvailableInPath} = require('../src/strategies')
+
+describe('Strategies: isExecutableAvailableInPath', () => {
+  test('should find a binary and result in success', () => {
+    const executable = 'ls'
+    const result = isExecutableAvailableInPath(executable)
+    expect(result).toBe(true)
+  })
+
+  test('should not find a made up binary name and result in error', () => {
+    const executable = 'c3c3c2'
+    const result = isExecutableAvailableInPath(executable)
+    expect(result).toBe(false)
+  })
+})

package/bin/detect-secrets-launcher.js

@@ -0,0 +1,45 @@
+#!/usr/bin/env node
+/* eslint-disable no-process-exit */
+const debug = require('debug')('detect-secrets')
+const pkg = require('../package.json')
+const cli = require('../src/cli')
+
+const PYTHON_PACKAGE_EXEC = 'detect-secrets-hook'
+const DOCKER_EXEC = 'docker'
+const DOCKER_IMAGE_NAME = 'lirantal/detect-secrets'
+
+const pwd = process.cwd()
+const executableStrategies = [
+  {
+    type: 'python',
+    filePath: PYTHON_PACKAGE_EXEC
+  },
+  {
+    type: 'docker',
+    filePath: DOCKER_EXEC,
+    prefixCommandArguments: [
+      'run',
+      '--rm',
+      '--volume',
+      `${pwd}:/usr/src/app`,
+      `${DOCKER_IMAGE_NAME}`
+    ]
+  }
+]
+
+debug(`${pkg.name} ${pkg.version}`)
+const {strategyExitCode, strategiesInvoked} = cli.start(executableStrategies)
+if (strategiesInvoked) {
+  process.exit(strategyExitCode)
+} else {
+  console.log(`${pkg.name} ${pkg.version}`)
+  console.log('WARNING: could not execute tool to prevent you from committing secrets')
+  console.log(
+    'to remedy the situation and enable secrets detection in your commits, consider one of:'
+  )
+  console.log(
+    '  1. follow instructions on https://github.com/Yelp/detect-secrets to install detect-secrets'
+  )
+  console.log('  2. install docker and this Node.js CLI will use it to execute an image')
+  console.log('')
+}

package/jsdoc.json

@@ -0,0 +1,19 @@
+{
+  "tags": {
+    "allowUnknownTags": true,
+    "dictionaries": ["jsdoc", "closure"]
+  },
+  "source": {
+    "include": ["./index.js"],
+    "exclude": ["./node_modules", "./.nyc_output", "./coverage", "./out", "./tests"],
+    "includePattern": ".+\\.js(doc|x)?$",
+    "excludePattern": "(^|\\/|\\\\)_"
+  },
+  "plugins": [],
+  "templates": {},
+  "opts": {
+    "destination": "./out",
+    "recurse": true,
+    "private": true
+  }
+}