prismor 0.1.2__py3-none-any.whl → 1.1.1__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,9 @@
1
+ prismor/__init__.py,sha256=BOXH4-mgofT0oOVGwS87lA8eiykjAa3IOO6Fdw-8z4U,230
2
+ prismor/api.py,sha256=QqxsWrliL2OZJxyENp7XrIj2be1E9q8qaq10b_p6Z5s,22405
3
+ prismor/cli.py,sha256=Y6swkJVsWTCTUY5EOjoUwhMrLCig0CsWHd3fxqKbMjU,25436
4
+ prismor-1.1.1.dist-info/licenses/LICENSE,sha256=qWFF8Eh6gpZOq_3effdd6hfeMN2WN9ZG4vOyFk2MyhU,1065
5
+ prismor-1.1.1.dist-info/METADATA,sha256=70WOYegQ1OiGV5zP0xzd_ZdeRVqxA2S61wZLHYa2DM4,18966
6
+ prismor-1.1.1.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
7
+ prismor-1.1.1.dist-info/entry_points.txt,sha256=Uiu0HW04eq2Gb6sQC9o-LqMKMyW1SKwkojxrkFeVfqg,45
8
+ prismor-1.1.1.dist-info/top_level.txt,sha256=nlJGoJ3fQXRL27RXQ5LJU2LX1kl1VSgKXyKjcSR28lw,8
9
+ prismor-1.1.1.dist-info/RECORD,,
@@ -1,5 +1,5 @@
1
1
  Wheel-Version: 1.0
2
- Generator: setuptools (80.9.0)
2
+ Generator: setuptools (80.10.2)
3
3
  Root-Is-Purelib: true
4
4
  Tag: py3-none-any
5
5
 
@@ -1,371 +0,0 @@
1
- Metadata-Version: 2.4
2
- Name: prismor
3
- Version: 0.1.2
4
- Summary: A CLI tool for scanning GitHub repositories for vulnerabilities, secrets, and generating SBOMs
5
- Home-page: https://github.com/PrismorSec/prismor-cli
6
- Author: Prismor
7
- Author-email: support@prismor.dev
8
- Project-URL: Bug Reports, https://github.com/PrismorSec/prismor-cli/issues
9
- Project-URL: Source, https://github.com/PrismorSec/prismor-cli
10
- Project-URL: Documentation, https://docs.prismor.dev
11
- Project-URL: Homepage, https://prismor.dev
12
- Keywords: security scanning vulnerability sbom secrets github
13
- Classifier: Development Status :: 4 - Beta
14
- Classifier: Intended Audience :: Developers
15
- Classifier: Topic :: Security
16
- Classifier: Topic :: Software Development :: Quality Assurance
17
- Classifier: License :: OSI Approved :: MIT License
18
- Classifier: Programming Language :: Python :: 3
19
- Classifier: Programming Language :: Python :: 3.7
20
- Classifier: Programming Language :: Python :: 3.8
21
- Classifier: Programming Language :: Python :: 3.9
22
- Classifier: Programming Language :: Python :: 3.10
23
- Classifier: Programming Language :: Python :: 3.11
24
- Classifier: Programming Language :: Python :: 3.12
25
- Requires-Python: >=3.7
26
- Description-Content-Type: text/markdown
27
- License-File: LICENSE
28
- Requires-Dist: click>=8.0.0
29
- Requires-Dist: requests>=2.25.0
30
- Dynamic: author
31
- Dynamic: author-email
32
- Dynamic: classifier
33
- Dynamic: description
34
- Dynamic: description-content-type
35
- Dynamic: home-page
36
- Dynamic: keywords
37
- Dynamic: license-file
38
- Dynamic: project-url
39
- Dynamic: requires-dist
40
- Dynamic: requires-python
41
- Dynamic: summary
42
-
43
- # Prismor CLI
44
-
45
- A powerful command-line tool for scanning GitHub repositories for security vulnerabilities, secrets, and generating Software Bill of Materials (SBOM).
46
-
47
- **Get started at [https://prismor.dev](https://prismor.dev)** - Sign up for free to get your API key and access full dashboarding and analysis features!
48
-
49
- ## Features
50
-
51
- - 🔍 **Vulnerability Scanning (VEX)** - Detect security vulnerabilities in your codebase
52
- - 🔐 **Secret Detection** - Find exposed secrets, API keys, and credentials
53
- - 📦 **SBOM Generation** - Generate comprehensive Software Bill of Materials
54
- - ⚡ **Full Scan** - Run all security checks in one command
55
- - 🎨 **Beautiful CLI Output** - Colorful, easy-to-read results
56
- - 🔗 **Flexible Repository Input** - Support for `username/repo` or full GitHub URLs
57
-
58
- ## Quick Start
59
-
60
- 1. **Sign up** at [https://prismor.dev](https://prismor.dev)
61
- 2. **Generate your API Key** from the dashboard
62
- 3. **Install** the CLI: `pip install prismor`
63
- 4. **Set your API key**: `export PRISMOR_API_KEY=your_api_key`
64
- 5. **Run your first scan**: `prismor --scan username/repo --fullscan`
65
-
66
- For the complete analysis with dashboards and reports, visit [Prismor.dev](https://prismor.dev) after running scans!
67
-
68
- ## Installation
69
-
70
- Install Prismor CLI via pip:
71
-
72
- ```bash
73
- pip install prismor
74
- ```
75
-
76
- ## Prerequisites
77
-
78
- ### Getting Your API Key
79
-
80
- Before using Prismor CLI, you need to get your API key from [Prismor.dev](https://prismor.dev):
81
-
82
- 1. Visit [https://prismor.dev](https://prismor.dev)
83
- 2. **Sign up** for a free account
84
- 3. Navigate to your dashboard
85
- 4. **Generate an API Key**
86
- 5. Copy your API key
87
-
88
- ### Setting Up Your API Key
89
-
90
- Once you have your API key, set it as an environment variable:
91
-
92
- ```bash
93
- export PRISMOR_API_KEY=your_api_key_here
94
- ```
95
-
96
- To make this permanent, add it to your shell configuration file (`~/.bashrc`, `~/.zshrc`, etc.):
97
-
98
- ```bash
99
- echo 'export PRISMOR_API_KEY=your_api_key_here' >> ~/.zshrc
100
- source ~/.zshrc
101
- ```
102
-
103
- ### Private Repositories
104
-
105
- To scan **private repositories**, you need to integrate your GitHub account:
106
-
107
- 1. Go to [Prismor.dev](https://prismor.dev)
108
- 2. Navigate to **Settings** or **Integrations**
109
- 3. **Connect your GitHub account**
110
- 4. Authorize Prismor to access your private repositories
111
-
112
- This allows Prismor to securely access and scan your private repositories.
113
-
114
- ## Usage
115
-
116
- ### Basic Syntax
117
-
118
- ```bash
119
- prismor --scan <repository> [scan-type]
120
- ```
121
-
122
- ### Repository Format
123
-
124
- You can specify repositories in two ways:
125
-
126
- 1. **Username/Repository format:**
127
- ```bash
128
- prismor --scan Ar9av/trychai-web-revamped --fullscan
129
- ```
130
-
131
- 2. **Full GitHub URL:**
132
- ```bash
133
- prismor --scan https://github.com/Ar9av/trychai-web-revamped --fullscan
134
- ```
135
-
136
- ### Scan Types
137
-
138
- #### 1. Vulnerability Scanning (VEX)
139
-
140
- Scan for security vulnerabilities in your dependencies and code:
141
-
142
- ```bash
143
- prismor --scan myrepository --vex
144
- ```
145
-
146
- #### 2. Secret Detection
147
-
148
- Detect exposed secrets, API keys, passwords, and other sensitive information:
149
-
150
- ```bash
151
- prismor --scan myrepository --detect-secret
152
- ```
153
-
154
- #### 3. SBOM Generation
155
-
156
- Generate a Software Bill of Materials for your repository:
157
-
158
- ```bash
159
- prismor --scan myrepository --sbom
160
- ```
161
-
162
- #### 4. Full Scan
163
-
164
- Run all security checks (VEX + Secret Detection + SBOM):
165
-
166
- ```bash
167
- prismor --scan myrepository --fullscan
168
- ```
169
-
170
- ### Multiple Scan Types
171
-
172
- You can combine multiple scan types:
173
-
174
- ```bash
175
- prismor --scan myrepository --vex --detect-secret
176
- ```
177
-
178
- ### JSON Output
179
-
180
- Get results in JSON format for automation and integration:
181
-
182
- ```bash
183
- prismor --scan myrepository --fullscan --json
184
- ```
185
-
186
- ## Examples
187
-
188
- ### Example 1: Quick Vulnerability Scan
189
-
190
- ```bash
191
- prismor --scan facebook/react --vex
192
- ```
193
-
194
- ### Example 2: Comprehensive Security Audit
195
-
196
- ```bash
197
- prismor --scan https://github.com/microsoft/vscode --fullscan
198
- ```
199
-
200
- ### Example 3: Secret Detection Only
201
-
202
- ```bash
203
- prismor --scan openai/gpt-3 --detect-secret
204
- ```
205
-
206
- ### Example 4: SBOM Generation with JSON Output
207
-
208
- ```bash
209
- prismor --scan kubernetes/kubernetes --sbom --json > sbom-results.json
210
- ```
211
-
212
- ## Additional Commands
213
-
214
- ### Check Configuration
215
-
216
- View your current Prismor CLI configuration:
217
-
218
- ```bash
219
- prismor config
220
- ```
221
-
222
- ### Version Information
223
-
224
- Display the version of Prismor CLI:
225
-
226
- ```bash
227
- prismor version
228
- ```
229
-
230
- Or:
231
-
232
- ```bash
233
- prismor --version
234
- ```
235
-
236
- ### Help
237
-
238
- Get help and see all available options:
239
-
240
- ```bash
241
- prismor --help
242
- ```
243
-
244
- ## Output
245
-
246
- Prismor CLI provides clear, colorful output with:
247
-
248
- - ✓ Success indicators
249
- - ✗ Error messages
250
- - ℹ Information updates
251
- - ⚠ Warnings
252
- - Detailed scan results including:
253
- - Repository information
254
- - Vulnerability counts
255
- - Secret detection findings
256
- - SBOM artifact counts
257
- - Download links for detailed reports
258
-
259
- ## Full Analysis & Dashboarding
260
-
261
- For comprehensive analysis and visualization of your scan results, visit the **[Prismor Dashboard](https://prismor.dev)**:
262
-
263
- ### Features Available on Prismor.dev:
264
- - 📊 **Interactive Dashboards** - Visualize security trends and metrics
265
- - 📈 **Historical Analysis** - Track vulnerabilities over time
266
- - 🎯 **Detailed Reports** - In-depth analysis of all findings
267
- - 🔔 **Alerts & Notifications** - Get notified of critical issues
268
- - 👥 **Team Collaboration** - Share reports with your team
269
- - 🔄 **CI/CD Integration** - Automate scans in your pipeline
270
- - 📁 **Repository Management** - Manage multiple repositories in one place
271
-
272
- ### Accessing Full Reports:
273
-
274
- After running a scan with the CLI, you can:
275
-
276
- 1. Visit [https://prismor.dev](https://prismor.dev)
277
- 2. Log into your dashboard
278
- 3. View all your scan results with rich visualizations
279
- 4. Export reports in various formats
280
- 5. Set up automated scanning schedules
281
-
282
- The CLI provides quick results in your terminal, while the web dashboard offers comprehensive analysis and long-term security monitoring.
283
-
284
- ## API Information
285
-
286
- Prismor CLI communicates with the Prismor API at `https://api.prismor.dev`. The CLI handles:
287
-
288
- - Authentication via API key
289
- - Request formatting
290
- - Error handling
291
- - Response parsing
292
- - Result presentation
293
-
294
- ## Troubleshooting
295
-
296
- ### API Key Not Set
297
-
298
- If you see an error about `PRISMOR_API_KEY` not being set:
299
-
300
- ```bash
301
- export PRISMOR_API_KEY=your_api_key_here
302
- ```
303
-
304
- ### Invalid Repository Format
305
-
306
- Ensure your repository is in one of these formats:
307
- - `username/repository`
308
- - `https://github.com/username/repository`
309
-
310
- ### Connection Issues
311
-
312
- If you experience connection issues:
313
- 1. Check your internet connection
314
- 2. Verify the API endpoint is accessible
315
- 3. Ensure your API key is valid
316
-
317
- ## Development
318
-
319
- ### Local Installation
320
-
321
- For development, clone the repository and install in editable mode:
322
-
323
- ```bash
324
- git clone https://github.com/PrismorSec/prismor-cli.git
325
- cd prismor-cli
326
- pip install -e .
327
- ```
328
-
329
- ### Project Structure
330
-
331
- ```
332
- prismor-cli/
333
- ├── prismor/
334
- │ ├── __init__.py # Package initialization
335
- │ ├── cli.py # CLI interface and commands
336
- │ └── api.py # API client and communication
337
- ├── setup.py # Package configuration
338
- ├── requirements.txt # Dependencies
339
- └── README.md # Documentation
340
- ```
341
-
342
- ## Requirements
343
-
344
- - Python 3.7 or higher
345
- - `click` >= 8.0.0
346
- - `requests` >= 2.25.0
347
-
348
- ## License
349
-
350
- MIT License - See LICENSE file for details
351
-
352
- ## Support
353
-
354
- - **Website**: [https://prismor.dev](https://prismor.dev)
355
- - **Dashboard**: [https://prismor.dev](https://prismor.dev) (Sign up for full features)
356
- - **Documentation**: [https://docs.prismor.dev](https://docs.prismor.dev)
357
- - **Issues**: [https://github.com/PrismorSec/prismor-cli/issues](https://github.com/prismor/prismor-cli/issues)
358
-
359
- ### Need Help?
360
-
361
- 1. Visit [Prismor.dev](https://prismor.dev) for full documentation and support
362
- 2. Check the dashboard for detailed scan results and analysis
363
- 3. Join our community for questions and discussions
364
-
365
- ## Contributing
366
-
367
- Contributions are welcome! Please feel free to submit a Pull Request.
368
-
369
- ---
370
-
371
- Made with ❤️ by Prismor
@@ -1,9 +0,0 @@
1
- prismor/__init__.py,sha256=6sRGygr6VrNie8Xd_B9Zeq6Q0ThWRftLBnVzZBdGEb4,230
2
- prismor/api.py,sha256=YrFnw1adT4ci6ehR4qB03kSOxw9l1o4fm0KSGUlDU4s,8886
3
- prismor/cli.py,sha256=K0aOxtbhE-gUoRw7selqT1a7BTr80A4Ogvvcspx5BUk,13582
4
- prismor-0.1.2.dist-info/licenses/LICENSE,sha256=qWFF8Eh6gpZOq_3effdd6hfeMN2WN9ZG4vOyFk2MyhU,1065
5
- prismor-0.1.2.dist-info/METADATA,sha256=sDwR9KP4wlNOdQON-j-42Sabowz2q7IhCXb4dss8s1I,9394
6
- prismor-0.1.2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
7
- prismor-0.1.2.dist-info/entry_points.txt,sha256=Uiu0HW04eq2Gb6sQC9o-LqMKMyW1SKwkojxrkFeVfqg,45
8
- prismor-0.1.2.dist-info/top_level.txt,sha256=nlJGoJ3fQXRL27RXQ5LJU2LX1kl1VSgKXyKjcSR28lw,8
9
- prismor-0.1.2.dist-info/RECORD,,