diff --git a/README.md b/README.md index 596dc4c..874c595 100644 --- a/README.md +++ b/README.md @@ -11,17 +11,23 @@ Kingfisher is a blazingly fast secret‑scanning and live validation tool built Originally forked from Praetorian’s Nosey Parker, Kingfisher **adds** live cloud-API validation; many more targets (GitLab, BitBucket, Gitea, S3, Docker, Jira, Confluence, Slack); compressed-file extraction and scanning; baseline and allowlist controls; language-aware detection (~20 languages); and a native Windows binary. See [Origins and Divergence](#origins-and-divergence) for details. ## Key Features +- **Multiple Scan Targets**:

+ Files + Local Git + GitHub + GitLab + Bitbucket + Gitea + Docker + Jira + Confluence + Slack + AWS S3 +

+ - **Performance**: multithreaded, Hyperscan‑powered scanning built for huge codebases - **Extensible rules**: hundreds of built-in detectors plus YAML-defined custom rules ([docs/RULES.md](/docs/RULES.md)) - **Broad AI SaaS coverage**: finds and validates tokens for OpenAI, Anthropic, Google Gemini, Cohere, Mistral, Stability AI, Replicate, xAI (Grok), Ollama, Langchain, Perplexity, Weights & Biases, Cerebras, Friendli, Fireworks.ai, NVIDIA NIM, Together.ai, Zhipu, and many more -- **Multiple targets**: - - **Git history**: local repos or GitHub/GitLab/Gitea/Bitbucket orgs, users, and workspaces - - **Repository artifacts**: with `--repo-artifacts`, scan GitHub/GitLab/Bitbucket repository artifacts such as issues, pull/merge requests, wikis, snippets, and owner gists in addition to code (Gitea wikis are also cloned when available) - - **Docker images**: public or private via `--docker-image` - - **Jira issues**: JQL‑driven scans with `--jira-url` and `--jql` - - **Confluence pages**: CQL‑driven scans with `--confluence-url` and `--cql` - - **Slack messages**: query‑based scans with `--slack-query` - - **AWS S3**: bucket scans via `--s3-bucket`/`--s3-prefix` with credentials from `KF_AWS_KEY`/`KF_AWS_SECRET`, `--role-arn`, `--aws-local-profile`, or anonymous - **Compressed Files**: Supports extracting and scanning compressed files for secrets - Decode Base64 blobs and scan their contents for secrets while skipping short strings for performance. This has a small performance impact and can be disabled with `--no-base64` - **Baseline management**: generate and track baselines to suppress known secrets ([docs/BASELINE.md](/docs/BASELINE.md)) diff --git a/docs/icons.sh b/docs/icons.sh new file mode 100755 index 0000000..31d287c --- /dev/null +++ b/docs/icons.sh @@ -0,0 +1,17 @@ +# Create a local icon dir +mkdir -p icons + +# Simple Icons (CDN source is stable and permissively licensed) +curl -fsSL https://cdn.jsdelivr.net/npm/simple-icons@v11/icons/github.svg -o icons/github.svg +curl -fsSL https://cdn.jsdelivr.net/npm/simple-icons@v11/icons/gitlab.svg -o icons/gitlab.svg +curl -fsSL https://cdn.jsdelivr.net/npm/simple-icons@v11/icons/bitbucket.svg -o icons/bitbucket.svg +curl -fsSL https://cdn.jsdelivr.net/npm/simple-icons@v11/icons/gitea.svg -o icons/gitea.svg +curl -fsSL https://cdn.jsdelivr.net/npm/simple-icons@v11/icons/slack.svg -o icons/slack.svg +curl -fsSL https://cdn.jsdelivr.net/npm/simple-icons@v11/icons/jirasoftware.svg -o icons/jira.svg +curl -fsSL https://cdn.jsdelivr.net/npm/simple-icons@v11/icons/confluence.svg -o icons/confluence.svg +curl -fsSL https://cdn.jsdelivr.net/npm/simple-icons@v11/icons/amazonaws.svg -o icons/aws.svg +curl -fsSL https://cdn.jsdelivr.net/npm/simple-icons@v11/icons/docker.svg -o icons/docker.svg + +# A neutral folder + git icon from Octicons for files/dirs + local git repos +curl -fsSL https://raw.githubusercontent.com/primer/octicons/main/icons/file-directory-24.svg -o icons/folder.svg +curl -fsSL https://raw.githubusercontent.com/primer/octicons/main/icons/git-branch-24.svg -o icons/git.svg