You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copyright (c) 2025 Secret Society LLC - All Rights Reserved
1
+
MIT License
2
2
3
-
NOTICE: This software, VibeSafe (the "Software"), is provided free of charge for execution and use. The source code is made available for transparency and inspection purposes only.
3
+
Copyright (c) 2025 Secret Society LLC
4
4
5
-
PERMISSION IS NOT GRANTED to modify, copy, merge, publish, distribute, sublicense, and/or sell copies of the Software, or any substantial portions of it.
5
+
Permission is hereby granted, free of charge, to any person obtaining a copy
6
+
of this software and associated documentation files (the "Software"), to deal
7
+
in the Software without restriction, including without limitation the rights to
of the Software, and to permit persons to whom the Software is furnished to do
10
+
so, subject to the following conditions:
6
11
7
-
PERMISSION IS NOT GRANTED to create derivative works based on the Software or its source code.
12
+
The above copyright notice and this permission notice shall be included in all
13
+
copies or substantial portions of the Software.
8
14
9
-
PERMISSION IS NOT GRANTED to redistribute the Software or its source code.
15
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+
SOFTWARE.
22
+
---
10
23
11
-
Reverse engineering, decompiling, or disassembling the Software is prohibited.
24
+
Trademark Notice:
12
25
13
-
The Software is provided "AS IS", without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose and noninfringement. In no event shall the authors or copyright holders be liable for any claim, damages or other liability, whether in an action of contract, tort or otherwise, arising from, out of or in connection with the Software or the use or other dealings in the Software.
14
-
15
-
By using or accessing the Software or its source code, you agree to these terms. If you do not agree to these terms, do not use or access the Software or its source code.
16
-
17
-
For any licensing inquiries beyond the scope of this license, please contact [email protected].
26
+
VibeSafe™ is a trademark of Secret Society LLC.
27
+
The MIT License does not grant permission to use the trade name, trademark, service mark, or product name “VibeSafe” except for attribution or with prior written consent.
Copy file name to clipboardExpand all lines: README.md
+65-20
Original file line number
Diff line number
Diff line change
@@ -4,30 +4,54 @@ A CLI tool to scan your codebase for security vibes.
4
4
5
5
VibeSafe helps developers quickly check their projects for common security issues like exposed secrets, outdated dependencies with known vulnerabilities (CVEs), and generates helpful reports.
6
6
7
-
## Features
8
-
9
-
***Secret Scanning:** Detects potential secrets using regex patterns (AWS Keys, JWTs, SSH Keys, generic high-entropy strings) and specifically flags secrets found in `.env` files.
10
-
***Dependency Scanning:** Parses `package.json` (for npm/yarn projects) and checks dependencies against the OSV.dev vulnerability database for known CVEs. *(Note: Currently only scans direct dependencies listed in `package.json`. Lockfile analysis for precise versions and transitive dependencies is planned for a future update.)*
11
-
***Configuration Scanning:** Checks JSON and YAML files for common insecure settings (e.g., `DEBUG = true`, `devMode = true`, permissive CORS like `origin: '*'`)
12
-
***HTTP Client Issues:** Detects potential missing timeout or cancellation configurations in calls using `axios`, `fetch`, `got`, and `request`. (*See Limitations below*).
13
-
***Unvalidated Upload Detection:** Identifies potential missing file size/type restrictions in common upload libraries (`multer`, `formidable`, `express-fileupload`, `busboy`) and generic patterns (`new FormData()`, `<input type="file">`).
14
-
***Exposed Endpoint Detection:** Flags potentially sensitive endpoints (e.g., `/admin`, `/debug`, `/status`, `/info`, `/metrics`) in Node.js web applications using common routing patterns or string literals.
15
-
***Rate Limit Check (Heuristic):** Issues a project-level advisory if API routes are detected but no known rate-limiting package (e.g., `express-rate-limit`, `@upstash/ratelimit`) is found in dependencies.
16
-
***Improper Logging Detection:** Flags potential logging of full error objects (e.g., `console.error(err)`), which can leak stack traces, and detects logging of potentially sensitive data based on keywords (e.g., `password`, `email`, `token`).
17
-
***Multiple Output Formats:** Provides results via console output (with colors!), JSON (`--output`), or a Markdown report (`--report` with default `VIBESAFE-REPORT.md`).
18
-
***AI-Powered Suggestions (Optional):** Generates fix suggestions in the Markdown report using OpenAI (requires API key).
19
-
***Filtering:** Focus on high-impact issues using `--high-only`.
20
-
***Customizable Ignores:** Use a `.vibesafeignore` file (similar syntax to `.gitignore`) to exclude specific files or directories from the scan.
21
-
22
-
## Installation
7
+
## ✨ Features
8
+
9
+
- 🔐 **Secret Scanning**
10
+
Flags AWS keys, JWTs, SSH keys, high-entropy strings, and secrets in `.env` files.
11
+
12
+
- 📦 **Dependency Vulnerability Detection**
13
+
Checks `package.json` dependencies against the [OSV.dev](https://osv.dev) vulnerability database. *(Direct deps only for now — lockfile support coming soon).*
14
+
15
+
- ⚙️ **Insecure Config Detection**
16
+
Scans JSON/YAML for flags like `DEBUG=true`, `devMode`, permissive CORS, etc.
17
+
18
+
- 🌐 **HTTP Client Scan**
19
+
Detects missing timeouts or abort controllers in `axios`, `fetch`, `got`, etc.
20
+
21
+
- 📤 **Upload Validation Check**
22
+
Warns on lack of file size/type checks in `multer`, `formidable`, etc.
23
+
24
+
- 🔎 **Exposed Endpoint Detection**
25
+
Flags risky endpoints like `/admin`, `/debug`, or `/metrics`, including for **Next.js API routes**.
26
+
27
+
- 🚫 **Missing Rate Limiting (Heuristic)**
28
+
Warns if your project has API routes but no known rate-limit package installed.
29
+
30
+
- 🪵 **Improper Logging Patterns**
31
+
Finds logs that may leak sensitive info or log full error stacks unsafely.
32
+
33
+
- 📄 **Multi-format Output**
34
+
Console, JSON (`--output`), or Markdown reports (`--report`).
35
+
36
+
- 🧠 **AI-Powered Fix Suggestions (Optional)**
37
+
Add an OpenAI API key for smart recommendations in Markdown reports.
38
+
39
+
- 🎯 **Focus on Critical Issues**
40
+
Use `--high-only` to trim noise.
41
+
42
+
- 🙈 **Custom Ignores**
43
+
Exclude files using `.vibesafeignore`, just like `.gitignore`.
44
+
45
+
46
+
## 📦 Installation
23
47
24
48
```bash
25
49
npm install -g vibesafe
26
50
```
27
51
28
52
*(Note: Currently, for local development, use `npm link` after building)*
29
53
30
-
## Usage
54
+
## 🚀 Usage
31
55
32
56
**Basic Scan (Current Directory):**
33
57
@@ -83,7 +107,7 @@ vibesafe scan -r ai-report.md
83
107
vibesafe scan --high-only
84
108
```
85
109
86
-
## Ignoring Files (.vibesafeignore)
110
+
## 🛑📁 Ignoring Files (.vibesafeignore)
87
111
88
112
Create a `.vibesafeignore` file in the root of the directory being scanned. Add file paths or glob patterns (one per line) to exclude them from the scan. The syntax is the same as `.gitignore`.
89
113
@@ -99,7 +123,28 @@ config/legacy-secrets.conf
99
123
# Allow scanning a specific .env file if needed (overrides default info behavior)
100
124
# !.env.production
101
125
```
126
+
## 🤝 Contributing
127
+
128
+
We welcome contributions from the community!
129
+
130
+
If you have an idea for a new scanner, a bug fix, or a way to make VibeSafe better, check out our [Contributing Guide](./CONTRIBUTING.md) to get started.
131
+
132
+
Whether you're submitting a pull request or opening an issue, we appreciate your help in making security tools more developer-friendly.
133
+
134
+
## 🧾 License
135
+
136
+
VibeSafe is open source software licensed under the [MIT License](./LICENSE).
137
+
138
+
You're free to use, modify, and distribute it — even commercially — as long as the original copyright
139
+
and license are included.
140
+
141
+
For questions or commercial partnership inquiries, contact **[email protected]**.
142
+
143
+
---
144
+
145
+
## 📛 Trademark Notice
102
146
103
-
## License
147
+
**VibeSafe™** is a trademark of Secret Society LLC.
148
+
Use of the name “VibeSafe” for derivative tools, competing products, or commercial services is **not permitted without prior written consent.**
104
149
105
-
This project uses a custom proprietary license. Please see the [LICENSE](LICENSE) file for details. TL;DR: Free to use, source visible, but no modification, copying, or redistribution allowed.
150
+
You are free to fork or build upon this code under the [MIT License](./LICENSE), but please use a different name and branding for public or commercial distributions.
0 commit comments