-
Notifications
You must be signed in to change notification settings - Fork 40
(old) feat: output security reports as JSON when requested #136
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
Closed
Changes from all commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
50b72c0
Add files / tests for outputting security reports as JSON when requested
jajanet 3faf18f
tighten instructions, set to specific file name only, and update chec…
jajanet 3493140
fix regex
jajanet 1e3a81f
fix more regex
jajanet 009798b
add gemini suggestions
jajanet 9e2a85c
fix tests
jajanet eb9af7c
Fix JSON output types
jajanet 04444c1
Add absolute pathing
jajanet 231ba24
Explicitly tell extension to keep generated security file if generated
jajanet 8a94119
Add json output usage instructions
jajanet 62228e8
cache for performance + pull out/use list for readability
jajanet File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -13,6 +13,7 @@ import { promises as fs } from 'fs'; | |
| import path from 'path'; | ||
| import { getAuditScope } from './filesystem.js'; | ||
| import { findLineNumbers } from './security.js'; | ||
| import { parseMarkdownToDict } from './parser.js'; | ||
|
|
||
| import { runPoc } from './poc.js'; | ||
|
|
||
|
|
@@ -64,6 +65,36 @@ server.tool( | |
| (input: { filePath: string }) => runPoc(input) | ||
| ); | ||
|
|
||
| server.tool( | ||
| 'convert_report_to_json', | ||
| 'Converts the Markdown security report into a JSON file named security_report.json in the .gemini_security folder.', | ||
| {} as any, | ||
| (async () => { | ||
| try { | ||
| const reportPath = path.join(process.cwd(), '.gemini_security/DRAFT_SECURITY_REPORT.md'); | ||
| const outputPath = path.join(process.cwd(), '.gemini_security/security_report.json'); | ||
|
|
||
| const content = await fs.readFile(reportPath, 'utf-8'); | ||
| const results = parseMarkdownToDict(content); | ||
|
|
||
| await fs.writeFile(outputPath, JSON.stringify(results, null, 2)); | ||
|
|
||
| return { | ||
| content: [{ | ||
| type: 'text', | ||
| text: `Successfully created JSON report at ${outputPath}` | ||
| }] | ||
| }; | ||
| } catch (error) { | ||
| const message = error instanceof Error ? error.message : String(error); | ||
| return { | ||
| content: [{ type: 'text', text: `Error converting to JSON: ${message}` }], | ||
| isError: true | ||
| }; | ||
| } | ||
| }) as any | ||
| ); | ||
|
|
||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
🟡 Casting the function to `any` using `as any` bypasses TypeScript's type safety checks. It would be more robust to define and use a specific type for the server tool implementation to ensure type safety and prevent potential runtime errors.
|
||
| server.registerPrompt( | ||
| 'security:note-adder', | ||
| { | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,184 @@ | ||
| /** | ||
| * @license | ||
| * Copyright 2025 Google LLC | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
|
|
||
| import { describe, it, expect } from 'vitest'; | ||
| import { parseMarkdownToDict } from './parser.js'; | ||
|
|
||
| describe('parseMarkdownToDict', () => { | ||
| it('should parse a standard security vulnerability correctly', () => { | ||
| const mdContent = ` | ||
| Vulnerability: Hardcoded API Key | ||
| Vulnerability Type: Security | ||
| Severity: Critical | ||
| Source Location: config/settings.js:15-15 | ||
| Line Content: const KEY = "sk_live_12345"; | ||
| Description: A production secret was found hardcoded in the source. | ||
| Recommendation: Move the secret to an environment variable. | ||
| `; | ||
|
|
||
| const results = parseMarkdownToDict(mdContent); | ||
|
|
||
| expect(results).toHaveLength(1); | ||
| expect(results[0]).toMatchObject({ | ||
| vulnerability: 'Hardcoded API Key', | ||
| vulnerabilityType: 'Security', | ||
| severity: 'Critical', | ||
| lineContent: 'const KEY = "sk_live_12345";', | ||
| sourceLocation: { | ||
| file: 'config/settings.js', | ||
| startLine: 15, | ||
| endLine: 15 | ||
| } | ||
| }); | ||
| }); | ||
|
|
||
| it('should parse a privacy violation with Sink and Data Type', () => { | ||
| const mdContent = ` | ||
| Vulnerability: PII Leak in Logs | ||
| Vulnerability Type: Privacy | ||
| Severity: Medium | ||
| Source Location: src/auth.ts:22 | ||
| Sink Location: console.log:45 | ||
| Data Type: Email Address | ||
| Line Content: logger.info("User logged in: " + user.email); | ||
| Description: Unmasked email addresses are being written to application logs. | ||
| Recommendation: Redact the email address before logging. | ||
| `; | ||
|
|
||
| const results = parseMarkdownToDict(mdContent); | ||
|
|
||
| expect(results).toHaveLength(1); | ||
| expect(results[0]).toMatchObject({ | ||
| sinkLocation: { | ||
| file: 'console.log', | ||
| startLine: 45, | ||
| endLine: 45 | ||
| }, | ||
| dataType: 'Email Address' | ||
| }); | ||
| }); | ||
|
|
||
| it('should handle multiple vulnerabilities in one file', () => { | ||
| const mdContent = ` | ||
| Vulnerability: SQL Injection | ||
| Vulnerability Type: Security | ||
| Severity: High | ||
| Source Location: db.js:10 | ||
| Line Content: query = "SELECT * FROM users WHERE id = " + id; | ||
| Description: Raw input used in query. | ||
| Recommendation: Use parameterized queries. | ||
| Vulnerability: Reflected XSS | ||
| Vulnerability Type: Security | ||
| Severity: Medium | ||
| Source Location: app.js:100 | ||
| Line Content: res.send("Hello " + req.query.name); | ||
| Description: User input rendered without escaping. | ||
| Recommendation: Use a templating engine with auto-escaping. | ||
| `; | ||
|
|
||
| const results = parseMarkdownToDict(mdContent); | ||
| expect(results).toHaveLength(2); | ||
| expect(results[0].vulnerability).toBe('SQL Injection'); | ||
| expect(results[1].vulnerability).toBe('Reflected XSS'); | ||
| }); | ||
|
|
||
| it('should handle markdown formatting like bolding and bullets', () => { | ||
| const mdContent = ` | ||
| * **Vulnerability:** Hardcoded Secret | ||
| - **Severity:** High | ||
| * **Source Location:** \`index.js:5-10\` | ||
| - **Line Content:** \`\`\`javascript | ||
| const secret = "password"; | ||
| \`\`\` | ||
| `; | ||
|
|
||
| const results = parseMarkdownToDict(mdContent); | ||
|
|
||
| expect(results[0].vulnerability).toBe('Hardcoded Secret'); | ||
| expect(results[0].severity).toBe('High'); | ||
| expect(results[0].sourceLocation.file).toBe('index.js'); | ||
| expect(results[0].lineContent).toBe('const secret = "password";'); | ||
| }); | ||
|
|
||
| it('should return empty array if no "Vulnerability:" trigger is found', () => { | ||
| const mdContent = "This is a summary report with no specific findings."; | ||
| const results = parseMarkdownToDict(mdContent); | ||
| expect(results).toHaveLength(0); | ||
| }); | ||
|
|
||
| it('should handle missing line numbers and sink location', () => { | ||
| const mdContent = ` | ||
| Vulnerability: Missing Line Numbers | ||
| Vulnerability Type: Security | ||
| Severity: High | ||
| Source Location: src/index.ts | ||
| Line Content: const apiKey = process.env.API_KEY; | ||
| Description: Source location without line numbers. | ||
| Recommendation: Verify the vulnerability details. | ||
| `; | ||
|
|
||
| const results = parseMarkdownToDict(mdContent); | ||
|
|
||
| expect(results).toHaveLength(1); | ||
| expect(results[0]).toMatchObject({ | ||
| vulnerability: 'Missing Line Numbers', | ||
| vulnerabilityType: 'Security', | ||
| severity: 'High', | ||
| lineContent: 'const apiKey = process.env.API_KEY;' | ||
| }); | ||
| expect(results[0].sourceLocation.file).toBe('src/index.ts'); | ||
| }); | ||
|
|
||
| it('should handle missing end line number', () => { | ||
| const mdContent = ` | ||
| Vulnerability: No End Line | ||
| Vulnerability Type: Security | ||
| Severity: Medium | ||
| Source Location: app.js:42 | ||
| Line Content: res.send(userInput); | ||
| Description: Source location with only start line number. | ||
| Recommendation: Check this line. | ||
| `; | ||
|
|
||
| const results = parseMarkdownToDict(mdContent); | ||
|
|
||
| expect(results).toHaveLength(1); | ||
| expect(results[0].sourceLocation).toMatchObject({ | ||
| file: 'app.js', | ||
| startLine: 42 | ||
| }); | ||
| }); | ||
|
|
||
| it('should handle missing sink location', () => { | ||
| const mdContent = ` | ||
| Vulnerability: No Sink Info | ||
| Vulnerability Type: Privacy | ||
| Severity: Low | ||
| Source Location: logger.ts:15 | ||
| Data Type: User ID | ||
| Line Content: console.log(user.id); | ||
| Description: Vulnerability without sink location details. | ||
| Recommendation: Use proper logging. | ||
| `; | ||
|
|
||
| const results = parseMarkdownToDict(mdContent); | ||
|
|
||
| expect(results).toHaveLength(1); | ||
| expect(results[0]).toMatchObject({ | ||
| vulnerability: 'No Sink Info', | ||
| vulnerabilityType: 'Privacy', | ||
| severity: 'Low' | ||
| }); | ||
| expect(results[0].dataType).toBe('User ID'); | ||
| expect( | ||
| results[0].sinkLocation === undefined || | ||
| (results[0].sinkLocation?.file === null && | ||
| results[0].sinkLocation?.startLine === null && | ||
| results[0].sinkLocation?.endLine === null) | ||
| ).toBe(true); | ||
| }); | ||
| }); |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.