-
Notifications
You must be signed in to change notification settings - Fork 731
feat: get rubygems owners as security-contacts [CM-1241] #4328
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
Changes from 3 commits
68a00e4
dee4ffc
74e94b0
507747f
87c24a3
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,13 +1,12 @@ | ||
| import { ExtractorResult, ProvenanceEntry, RawContact } from '../../types' | ||
| import { extractEmails, fetchJson, registryHeaders } from '../http' | ||
| import { extractEmails, fetchJson, isEmail, registryHeaders } from '../http' | ||
|
|
||
| import { ParsedPurl } from './purl' | ||
|
|
||
| const SOURCE = 'rubygems' | ||
|
|
||
| /* eslint-disable @typescript-eslint/no-explicit-any */ | ||
|
|
||
| // RubyGems hides author emails; we can only surface emails when an author string embeds one. | ||
| // bug_tracker_uri is an issue tracker, not a security contact, so it is intentionally skipped. | ||
| export function mapRubygems(doc: unknown, sourceUrl: string, fetchedAt: string): RawContact[] { | ||
| if (!doc || typeof doc !== 'object') return [] | ||
|
|
@@ -34,13 +33,61 @@ export function mapRubygems(doc: unknown, sourceUrl: string, fetchedAt: string): | |
| return contacts | ||
| } | ||
|
|
||
| export function mapRubygemsOwners( | ||
| owners: unknown, | ||
| sourceUrl: string, | ||
| fetchedAt: string, | ||
| ): RawContact[] { | ||
| if (!Array.isArray(owners)) return [] | ||
|
|
||
| const prov = (): ProvenanceEntry[] => [ | ||
| { source: SOURCE, sourceTier: 'B', path: sourceUrl, fetchedAt }, | ||
| ] | ||
| const contacts: RawContact[] = [] | ||
| const seen = new Set<string>() | ||
| for (const owner of owners) { | ||
| const o = (owner ?? {}) as Record<string, unknown> | ||
| const email = o.email | ||
| if (typeof email !== 'string' || !isEmail(email)) continue | ||
| const key = email.toLowerCase() | ||
| if (seen.has(key)) continue | ||
| seen.add(key) | ||
| const handle = typeof o.handle === 'string' ? o.handle : undefined | ||
| contacts.push({ | ||
| channel: 'email', | ||
| value: email, | ||
| handle, | ||
|
mbani01 marked this conversation as resolved.
Outdated
|
||
| role: 'maintainer', | ||
| tier: 'B', | ||
| provenance: prov(), | ||
| }) | ||
| } | ||
| return contacts | ||
| } | ||
|
|
||
| export async function fetchRubygems( | ||
| parsed: ParsedPurl, | ||
| timeoutMs: number, | ||
| userAgent: string, | ||
| ): Promise<ExtractorResult> { | ||
| const url = `https://rubygems.org/api/v1/gems/${encodeURIComponent(parsed.name)}.json` | ||
| const { json } = await fetchJson(url, timeoutMs, registryHeaders(userAgent)) | ||
| if (!json) return { contacts: [], policies: {} } | ||
| return { contacts: mapRubygems(json, url, new Date().toISOString()), policies: {} } | ||
| const gemUrl = `https://rubygems.org/api/v1/gems/${encodeURIComponent(parsed.name)}.json` | ||
| const ownersUrl = `https://rubygems.org/api/v1/gems/${encodeURIComponent(parsed.name)}/owners.json` | ||
| const fetchedAt = new Date().toISOString() | ||
|
|
||
| const [gemResult, ownersResult] = await Promise.all([ | ||
| fetchJson(gemUrl, timeoutMs, registryHeaders(userAgent)), | ||
| fetchJson(ownersUrl, timeoutMs, registryHeaders(userAgent)).catch(() => ({ | ||
| status: 0, | ||
| json: null, | ||
| })), | ||
|
mbani01 marked this conversation as resolved.
Comment on lines
+81
to
+84
Comment on lines
+79
to
+84
|
||
| ]) | ||
|
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. Gem failure drops owner contactsMedium Severity
Reviewed by Cursor Bugbot for commit 87c24a3. Configure here. |
||
|
|
||
| if (!gemResult.json) return { contacts: [], policies: {} } | ||
|
|
||
| const contacts = [ | ||
| ...mapRubygems(gemResult.json, gemUrl, fetchedAt), | ||
| ...mapRubygemsOwners(ownersResult.json, ownersUrl, fetchedAt), | ||
| ] | ||
|
|
||
| return { contacts, policies: {} } | ||
| } | ||


Uh oh!
There was an error while loading. Please reload this page.