Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Add missing fields to SecurityAdvisoryEvent and rename others #2889

Merged
merged 2 commits into from
Aug 29, 2023
Merged

Add missing fields to SecurityAdvisoryEvent and rename others #2889

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2d733ae
fix: add missing fields to SecurityAdvisoryEvent
nikpivkin Aug 20, 2023
09b8437
fix naming
nikpivkin Aug 21, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions github/dependabot_alerts.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ type Dependency struct {
Scope *string `json:"scope,omitempty"`
}

// AdvisoryCVSs represents the advisory pertaining to the Common Vulnerability Scoring System.
type AdvisoryCVSs struct {
// AdvisoryCVSS represents the advisory pertaining to the Common Vulnerability Scoring System.
type AdvisoryCVSS struct {
Score *float64 `json:"score,omitempty"`
VectorString *string `json:"vector_string,omitempty"`
}
Expand All @@ -37,7 +37,7 @@ type DependabotSecurityAdvisory struct {
Description *string `json:"description,omitempty"`
Vulnerabilities []*AdvisoryVulnerability `json:"vulnerabilities,omitempty"`
Severity *string `json:"severity,omitempty"`
CVSs *AdvisoryCVSs `json:"cvss,omitempty"`
CVSS *AdvisoryCVSS `json:"cvss,omitempty"`
CWEs []*AdvisoryCWEs `json:"cwes,omitempty"`
Identifiers []*AdvisoryIdentifier `json:"identifiers,omitempty"`
References []*AdvisoryReference `json:"references,omitempty"`
Expand Down
9 changes: 9 additions & 0 deletions github/event_types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1591,6 +1591,8 @@ type WorkflowRunEvent struct {
//
// GitHub API docs: https://docs.github.com/en/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#security_advisory
type SecurityAdvisory struct {
CVSS *AdvisoryCVSS `json:"cvss,omitempty"`
CWEs []*AdvisoryCWEs `json:"cwes,omitempty"`
GHSAID *string `json:"ghsa_id,omitempty"`
Summary *string `json:"summary,omitempty"`
Description *string `json:"description,omitempty"`
Expand Down Expand Up @@ -1639,6 +1641,13 @@ type FirstPatchedVersion struct {
type SecurityAdvisoryEvent struct {
Action *string `json:"action,omitempty"`
SecurityAdvisory *SecurityAdvisory `json:"security_advisory,omitempty"`

// The following fields are only populated by Webhook events.
Enterprise *Enterprise `json:"enterprise,omitempty"`
Installation *Installation `json:"installation,omitempty"`
Organization *Organization `json:"organization,omitempty"`
Repository *Repository `json:"repository,omitempty"`
Sender *User `json:"sender,omitempty"`
}

// CodeScanningAlertEvent is triggered when a code scanning finds a potential vulnerability or error in your code.
Expand Down
306 changes: 306 additions & 0 deletions github/event_types_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16308,6 +16308,16 @@ func TestSecurityAdvisoryEvent_Marshal(t *testing.T) {
u := &SecurityAdvisoryEvent{
Action: String("published"),
SecurityAdvisory: &SecurityAdvisory{
CVSS: &AdvisoryCVSS{
Score: Float64(1.0),
VectorString: String("vs"),
},
CWEs: []*AdvisoryCWEs{
{
CWEID: String("cweid"),
Name: String("n"),
},
},
GHSAID: String("GHSA-rf4j-j272-some"),
Summary: String("Siuuuuuuuuu"),
Description: String("desc"),
Expand Down Expand Up @@ -16340,13 +16350,164 @@ func TestSecurityAdvisoryEvent_Marshal(t *testing.T) {
},
},
},
Enterprise: &Enterprise{
ID: Int(1),
Slug: String("s"),
Name: String("n"),
NodeID: String("nid"),
AvatarURL: String("au"),
Description: String("d"),
WebsiteURL: String("wu"),
HTMLURL: String("hu"),
CreatedAt: &Timestamp{referenceTime},
UpdatedAt: &Timestamp{referenceTime},
},
Installation: &Installation{
ID: Int64(1),
NodeID: String("nid"),
AppID: Int64(1),
AppSlug: String("as"),
TargetID: Int64(1),
Account: &User{
Login: String("l"),
ID: Int64(1),
URL: String("u"),
AvatarURL: String("a"),
GravatarID: String("g"),
Name: String("n"),
Company: String("c"),
Blog: String("b"),
Location: String("l"),
Email: String("e"),
Hireable: Bool(true),
Bio: String("b"),
TwitterUsername: String("t"),
PublicRepos: Int(1),
Followers: Int(1),
Following: Int(1),
CreatedAt: &Timestamp{referenceTime},
SuspendedAt: &Timestamp{referenceTime},
},
AccessTokensURL: String("atu"),
RepositoriesURL: String("ru"),
HTMLURL: String("hu"),
TargetType: String("tt"),
SingleFileName: String("sfn"),
RepositorySelection: String("rs"),
Events: []string{"e"},
SingleFilePaths: []string{"s"},
Permissions: &InstallationPermissions{
Actions: String("a"),
Administration: String("ad"),
Checks: String("c"),
Contents: String("co"),
ContentReferences: String("cr"),
Deployments: String("d"),
Environments: String("e"),
Issues: String("i"),
Metadata: String("md"),
Members: String("m"),
OrganizationAdministration: String("oa"),
OrganizationHooks: String("oh"),
OrganizationPlan: String("op"),
OrganizationPreReceiveHooks: String("opr"),
OrganizationProjects: String("op"),
OrganizationSecrets: String("os"),
OrganizationSelfHostedRunners: String("osh"),
OrganizationUserBlocking: String("oub"),
Packages: String("pkg"),
Pages: String("pg"),
PullRequests: String("pr"),
RepositoryHooks: String("rh"),
RepositoryProjects: String("rp"),
RepositoryPreReceiveHooks: String("rprh"),
Secrets: String("s"),
SecretScanningAlerts: String("ssa"),
SecurityEvents: String("se"),
SingleFile: String("sf"),
Statuses: String("s"),
TeamDiscussions: String("td"),
VulnerabilityAlerts: String("va"),
Workflows: String("w"),
},
CreatedAt: &Timestamp{referenceTime},
UpdatedAt: &Timestamp{referenceTime},
HasMultipleSingleFiles: Bool(false),
SuspendedBy: &User{
Login: String("l"),
ID: Int64(1),
URL: String("u"),
AvatarURL: String("a"),
GravatarID: String("g"),
Name: String("n"),
Company: String("c"),
Blog: String("b"),
Location: String("l"),
Email: String("e"),
Hireable: Bool(true),
Bio: String("b"),
TwitterUsername: String("t"),
PublicRepos: Int(1),
Followers: Int(1),
Following: Int(1),
CreatedAt: &Timestamp{referenceTime},
SuspendedAt: &Timestamp{referenceTime},
},
SuspendedAt: &Timestamp{referenceTime},
},
Organization: &Organization{
BillingEmail: String("be"),
Blog: String("b"),
Company: String("c"),
Email: String("e"),
TwitterUsername: String("tu"),
Location: String("loc"),
Name: String("n"),
Description: String("d"),
IsVerified: Bool(true),
HasOrganizationProjects: Bool(true),
HasRepositoryProjects: Bool(true),
DefaultRepoPermission: String("drp"),
MembersCanCreateRepos: Bool(true),
MembersCanCreateInternalRepos: Bool(true),
MembersCanCreatePrivateRepos: Bool(true),
MembersCanCreatePublicRepos: Bool(false),
MembersAllowedRepositoryCreationType: String("marct"),
MembersCanCreatePages: Bool(true),
MembersCanCreatePublicPages: Bool(false),
MembersCanCreatePrivatePages: Bool(true),
},
Repository: &Repository{
ID: Int64(1),
URL: String("s"),
Name: String("n"),
},
Sender: &User{
Login: String("l"),
ID: Int64(1),
NodeID: String("n"),
URL: String("u"),
ReposURL: String("r"),
EventsURL: String("e"),
AvatarURL: String("a"),
},
}

want := `{
"action": "published",
"security_advisory": {
"ghsa_id": "GHSA-rf4j-j272-some",
"summary": "Siuuuuuuuuu",
"cvss": {
"score": 1.0,
"vector_string": "vs"
},
"cwes": [
{
"cwe_id": "cweid",
"name": "n"
}
],
"description": "desc",
"severity": "moderate",
"identifiers": [
Expand Down Expand Up @@ -16376,6 +16537,151 @@ func TestSecurityAdvisoryEvent_Marshal(t *testing.T) {
}
}
]
},
"enterprise": {
"id": 1,
"slug": "s",
"name": "n",
"node_id": "nid",
"avatar_url": "au",
"description": "d",
"website_url": "wu",
"html_url": "hu",
"created_at": ` + referenceTimeStr + `,
"updated_at": ` + referenceTimeStr + `
},
"installation": {
"id": 1,
"node_id": "nid",
"app_id": 1,
"app_slug": "as",
"target_id": 1,
"account": {
"login": "l",
"id": 1,
"avatar_url": "a",
"gravatar_id": "g",
"name": "n",
"company": "c",
"blog": "b",
"location": "l",
"email": "e",
"hireable": true,
"bio": "b",
"twitter_username": "t",
"public_repos": 1,
"followers": 1,
"following": 1,
"created_at": ` + referenceTimeStr + `,
"suspended_at": ` + referenceTimeStr + `,
"url": "u"
},
"access_tokens_url": "atu",
"repositories_url": "ru",
"html_url": "hu",
"target_type": "tt",
"single_file_name": "sfn",
"repository_selection": "rs",
"events": [
"e"
],
"single_file_paths": [
"s"
],
"permissions": {
"actions": "a",
"administration": "ad",
"checks": "c",
"contents": "co",
"content_references": "cr",
"deployments": "d",
"environments": "e",
"issues": "i",
"metadata": "md",
"members": "m",
"organization_administration": "oa",
"organization_hooks": "oh",
"organization_plan": "op",
"organization_pre_receive_hooks": "opr",
"organization_projects": "op",
"organization_secrets": "os",
"organization_self_hosted_runners": "osh",
"organization_user_blocking": "oub",
"packages": "pkg",
"pages": "pg",
"pull_requests": "pr",
"repository_hooks": "rh",
"repository_projects": "rp",
"repository_pre_receive_hooks": "rprh",
"secrets": "s",
"secret_scanning_alerts": "ssa",
"security_events": "se",
"single_file": "sf",
"statuses": "s",
"team_discussions": "td",
"vulnerability_alerts": "va",
"workflows": "w"
},
"created_at": ` + referenceTimeStr + `,
"updated_at": ` + referenceTimeStr + `,
"has_multiple_single_files": false,
"suspended_by": {
"login": "l",
"id": 1,
"avatar_url": "a",
"gravatar_id": "g",
"name": "n",
"company": "c",
"blog": "b",
"location": "l",
"email": "e",
"hireable": true,
"bio": "b",
"twitter_username": "t",
"public_repos": 1,
"followers": 1,
"following": 1,
"created_at": ` + referenceTimeStr + `,
"suspended_at": ` + referenceTimeStr + `,
"url": "u"
},
"suspended_at": ` + referenceTimeStr + `
},
"organization": {
"name": "n",
"company": "c",
"blog": "b",
"location": "loc",
"email": "e",
"twitter_username": "tu",
"description": "d",
"billing_email": "be",
"is_verified": true,
"has_organization_projects": true,
"has_repository_projects": true,
"default_repository_permission": "drp",
"members_can_create_repositories": true,
"members_can_create_public_repositories": false,
"members_can_create_private_repositories": true,
"members_can_create_internal_repositories": true,
"members_allowed_repository_creation_type": "marct",
"members_can_create_pages": true,
"members_can_create_public_pages": false,
"members_can_create_private_pages": true
},
"repository": {
"id": 1,
"url": "s",
"name": "n"
},
"sender": {
"login": "l",
"id": 1,
"node_id": "n",
"avatar_url": "a",
"url": "u",
"events_url": "e",
"repos_url": "r"
}
}`

Expand Down
Loading
Loading