seCureLI is a tool that enables you to experience the delight of building products by helping you get ideas from your head into working software as frictionlessly as possible, in a reliable, secure, scalable, and observable way.
seCureLI:
seCureLI isn’t a magic tool that makes things secure because you have it. It enables a lot of other tools that you could set up individually and helps you as a builder write better code.
Looking to contribute? Read our CONTRIBUTING.md
To install seCureLI via homebrew, issue the following commands
brew tap slalombuild/secureli
brew install secureli
To install seCureLI via pip, issue the following commands
pip install secureli
Once installed you can see the latest documentation for seCureLI by entering the following on a command prompt:
$ secureli --help
You will see a list of commands and descriptions of each. You can also pull up documentation for each command with the same pattern. For example:
$ secureli init --help
Usage: secureli init [OPTIONS]
Detect languages and initialize pre-commit hooks and linters for the project
╭─ Options ──────────────────────────────────────────────────────────────────────────────────────╮
│ --reset -r Disregard the installed configuration, if any, and treat as a new install │
│ --yes -y Say 'yes' to every prompt automatically without input │
│ --directory .,-d PATH Run secureli against a specific directory [default: .]
│ --help Show this message and exit. │
╰────────────────────────────────────────────────────────────────────────────────────────────────╯
When invoking these commands, you can combine the short versions into a single flag. For example, the following commands are equivalent:
% secureli init --reset --yes
% secureli init -ry
After seCureLI is installed, you can use it to configure your local git repository with a set of pre-commit hooks appropriate for your repo, based on the languages found in your repo's source code files.
All you need to do is run:
% secureli init
Running secureli init will allow seCureLI to detect the languages in your repo, install pre-commit, install all the appropriate pre-commit hooks for your local repo, run a scan for secrets in your local repo, and update the installed hooks.
If you have an existing pre-commit config file you want to preserve when running secureli init, you can use the --preserve-precommit-config flag. This is useful for example when checking out a repo with an existing pre-commit config file.
To manually trigger a scan, run:
% secureli scan
This will run through all hooks and custom scans, unless a --specific-test option is used. The default is to scan staged files only. To scan all files instead, use the --mode all-files option.
By default, seCureLI will only scan files that are staged for commit. If you want to scan a different set of files, you can use the --file parameter. You can specify multiple files by passing the parameter multiple times, e.g. --file file1 --file file2.
seCureLI utilizes its own PII scan, rather than using an existing pre-commit hook. To exclude a line from being flagged by the PII scanner, you can use a disable-pii-scan marker in a comment to disable the scan for that line.
test_var = "some dummy data I don't want scanned" # disable-pii-scan
seCureLI utilizes its own custom regex scan to flag any text that matches a user provided regex pattern. To include a regex pattern in the scan simply add the pattern to your .secureli.yaml by running
secureli update --new-pattern <your-custom-regex>
seCureLI has Slalom-maintained templates for security management of the following languages.
If you installed seCureLI using Homebrew, you can use the standard homebrew update command to pull down the latest formula.
brew update
If you installed seCureLI using pip, you can use the following command to upgrade to the latest version of seCureLI.
pip install --upgrade secureli
In order to upgrade to the latest released version of each pre-commit hook configured for your repo, use the following command.
secureli update --latest
seCureLI is configurable via a .secureli.yaml file present in the root of your local repository.
| Key | Description |
|---|---|
repo_files | Affects how seCureLI will interpret the repository, both for language analysis and as it executes various linters. |
echo | Adjusts how seCureLI will print information to the user. |
language_support | Affects seCureLI's language analysis and support phase. |
pii_scanner | Includes options for seCureLI's PII scanner |
telemetry | Includes options for seCureLI telemetry/api logging |
| Key | Description |
|---|---|
max_file_size | A number in bytes. Files over this size will not be considered during language analysis, for speed purposes. Default: 100000 |
ignored_file_extensions | Which file extensions not to consider during language analysis. |
exclude_file_patterns | Which file patterns to ignore during language analysis and code analysis execution. Use a typical file pattern you might find in a .gitignore file, such as *.py or tests/. Certain patterns you will have to wrap in double-quotes for the entry to be valid YAML. |
| Key | Description |
|---|---|
level | The log level to display to the user. Defaults to ERROR, which includes error and print messages, without including warnings or info messages. |
| Key | Description |
|---|---|
ignored_extensions | The extensions of files to ignore in addition to the defaults. |
| Key | Description |
|---|---|
api_url | The url endpoint to post telemetry logs to. This value is an alternative to setting the url as an environment variable. Note: The environment variable will precede this setting value |
pre-commit is used for configuring pre-commit hooks. The configuration file is .secureli/.pre-commit-config.yaml, relative to the root of your repo. For details on modifying this file, see the pre-commit documentation on configuring hooks.
If there is a .pre-commit-config file in your root when you initialize seCureLI, it will be merged with the default configuration written to .secureli/.pre-commit-config.yaml.
Special care needs to be taken when passing arguments to pre-commit hooks in .pre-commit-config.yaml. In particular, if you're passing parameters which themselves take arguments, you must ensure that both the parameter and its arguments are separate items in the array.
Examples:
BAD
- args:
- --exclude-files *.md
This is an array with a single element, ["--exclude files *.md"]. This probably won't work as you're expecting.
GOOD
- args:
- --exclude-files
- *.md
This is an array where the parameter and its argument are separate items; ["--exclude files", "*.md"]
ALSO GOOD
- args: ["--exclude-files", "*.md"]
.secureli/repo-config.yamlThis file is generated by seCureLI and contains the configuration for the repo.
It is not intended to be modified by the user. Running secureli update will
update this file with the latest configuration.
seCureLI can send secret detection events to an observability platform, such as New Relic. Other platforms may also work, but have not been tested. Should you need seCureLI to work with other platforms, please create a new issue in github, or contribute to the open source project.
FROM Log Select sum(failure_count_details.detect_secrets) as 'Caught Secret Count'
Copyright 2024 Slalom, Inc.
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
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.
FAQs
Secure Project Manager
We found that secureli demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.