-
Notifications
You must be signed in to change notification settings - Fork 2.2k
Expand file tree
/
Copy pathorgs_codesecurity_configurations.go
More file actions
380 lines (335 loc) · 18.2 KB
/
orgs_codesecurity_configurations.go
File metadata and controls
380 lines (335 loc) · 18.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
// Copyright 2024 The go-github AUTHORS. All rights reserved.
//
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
package github
import (
"context"
"fmt"
"net/http"
)
// DependencyGraphAutosubmitActionOptions represents the options for the DependencyGraphAutosubmitAction.
type DependencyGraphAutosubmitActionOptions struct {
LabeledRunners *bool `json:"labeled_runners,omitempty"`
}
// CodeScanningOptions represents the options for the Security Configuration code scanning feature.
type CodeScanningOptions struct {
AllowAdvanced *bool `json:"allow_advanced,omitempty"`
}
// CodeScanningDefaultSetupOptions represents the feature options for the code scanning default options.
type CodeScanningDefaultSetupOptions struct {
RunnerType string `json:"runner_type"`
RunnerLabel *string `json:"runner_label,omitempty"`
}
// RepositoryAttachment represents a repository attachment to a code security configuration.
type RepositoryAttachment struct {
Status *string `json:"status"`
Repository *Repository `json:"repository"`
}
// SecretScanningDelegatedBypassOptions represents the feature options for the secret scanning delegated bypass.
type SecretScanningDelegatedBypassOptions struct {
Reviewers []*BypassReviewer `json:"reviewers,omitzero"`
}
// BypassReviewer represents the bypass reviewers for the delegated bypass of a code security configuration.
// SecurityConfigurationID is added by GitHub in responses.
type BypassReviewer struct {
ReviewerID int64 `json:"reviewer_id"`
ReviewerType string `json:"reviewer_type"`
SecurityConfigurationID *int64 `json:"security_configuration_id,omitempty"`
}
// CodeSecurityConfiguration represents a code security configuration.
type CodeSecurityConfiguration struct {
ID *int64 `json:"id,omitempty"`
TargetType *string `json:"target_type,omitempty"`
Name string `json:"name"`
Description string `json:"description"`
AdvancedSecurity *string `json:"advanced_security,omitempty"`
DependencyGraph *string `json:"dependency_graph,omitempty"`
DependencyGraphAutosubmitAction *string `json:"dependency_graph_autosubmit_action,omitempty"`
DependencyGraphAutosubmitActionOptions *DependencyGraphAutosubmitActionOptions `json:"dependency_graph_autosubmit_action_options,omitempty"`
DependabotAlerts *string `json:"dependabot_alerts,omitempty"`
DependabotSecurityUpdates *string `json:"dependabot_security_updates,omitempty"`
CodeScanningDefaultSetup *string `json:"code_scanning_default_setup,omitempty"`
CodeScanningDefaultSetupOptions *CodeScanningDefaultSetupOptions `json:"code_scanning_default_setup_options,omitempty"`
CodeScanningDelegatedAlertDismissal *string `json:"code_scanning_delegated_alert_dismissal,omitempty"`
CodeScanningOptions *CodeScanningOptions `json:"code_scanning_options,omitempty"`
CodeSecurity *string `json:"code_security,omitempty"`
SecretScanning *string `json:"secret_scanning,omitempty"`
SecretScanningPushProtection *string `json:"secret_scanning_push_protection,omitempty"`
SecretScanningDelegatedBypass *string `json:"secret_scanning_delegated_bypass,omitempty"`
SecretScanningDelegatedBypassOptions *SecretScanningDelegatedBypassOptions `json:"secret_scanning_delegated_bypass_options,omitempty"`
SecretScanningValidityChecks *string `json:"secret_scanning_validity_checks,omitempty"`
SecretScanningNonProviderPatterns *string `json:"secret_scanning_non_provider_patterns,omitempty"`
SecretScanningGenericSecrets *string `json:"secret_scanning_generic_secrets,omitempty"`
SecretScanningDelegatedAlertDismissal *string `json:"secret_scanning_delegated_alert_dismissal,omitempty"`
SecretProtection *string `json:"secret_protection,omitempty"`
PrivateVulnerabilityReporting *string `json:"private_vulnerability_reporting,omitempty"`
Enforcement *string `json:"enforcement,omitempty"`
URL *string `json:"url,omitempty"`
HTMLURL *string `json:"html_url,omitempty"`
CreatedAt *Timestamp `json:"created_at,omitempty"`
UpdatedAt *Timestamp `json:"updated_at,omitempty"`
}
// CodeSecurityConfigurationWithDefaultForNewRepos represents a code security configuration with default for new repos param.
type CodeSecurityConfigurationWithDefaultForNewRepos struct {
Configuration *CodeSecurityConfiguration `json:"configuration"`
DefaultForNewRepos *string `json:"default_for_new_repos,omitempty"`
}
// RepositoryCodeSecurityConfiguration represents a code security configuration for a repository.
type RepositoryCodeSecurityConfiguration struct {
State *string `json:"state,omitempty"`
Configuration *CodeSecurityConfiguration `json:"configuration,omitempty"`
}
// ListOrgCodeSecurityConfigurationOptions specifies optional parameters to get security configurations for orgs.
//
// Note: Pagination is powered by before/after cursor-style pagination. After the initial call,
// inspect the returned *Response. Use resp.After as the opts.After value to request
// the next page, and resp.Before as the opts.Before value to request the previous
// page. Set either Before or After for a request; if both are
// supplied GitHub API will return an error. PerPage controls the number of items
// per page (max 100 per GitHub API docs).
type ListOrgCodeSecurityConfigurationOptions struct {
// A cursor, as given in the Link header. If specified, the query only searches for security configurations before this cursor.
Before string `url:"before,omitempty"`
// A cursor, as given in the Link header. If specified, the query only searches for security configurations after this cursor.
After string `url:"after,omitempty"`
// For paginated result sets, the number of results to include per page.
PerPage int `url:"per_page,omitempty"`
// The target type of the code security configurations to get.
//
// `target_type` defaults to all, can be one of `global`, `all`
TargetType string `url:"target_type,omitempty"`
}
// ListCodeSecurityConfigurationRepositoriesOptions specifies optional parameters to list repositories for security configurations for orgs and enterprises.
//
// Note: Pagination is powered by before/after cursor-style pagination. After the initial call,
// inspect the returned *Response. Use resp.After as the opts.After value to request
// the next page, and resp.Before as the opts.Before value to request the previous
// page. Set either Before or After for a request; if both are
// supplied GitHub API will return an error. PerPage controls the number of items
// per page (max 100 per GitHub API docs).
type ListCodeSecurityConfigurationRepositoriesOptions struct {
// A cursor, as given in the Link header. If specified, the query only searches for repositories before this cursor.
Before string `url:"before,omitempty"`
// A cursor, as given in the Link header. If specified, the query only searches for repositories after this cursor.
After string `url:"after,omitempty"`
// For paginated result sets, the number of results to include per page.
PerPage int `url:"per_page,omitempty"`
// A comma-separated list of statuses. If specified, only repositories with these attachment statuses will be returned.
//
// `status` defaults to all, can be one of `all`, `attached`, `attaching`, `removed`, `enforced`, `failed`, `updating`, `removed_by_enterprise` and also `detached` but only for the org endpoint.
Status string `url:"status,omitempty"`
}
// ListCodeSecurityConfigurations gets code security configurations for an organization.
//
// GitHub API docs: https://docs.github.com/rest/code-security/configurations#get-code-security-configurations-for-an-organization
//
//meta:operation GET /orgs/{org}/code-security/configurations
func (s *OrganizationsService) ListCodeSecurityConfigurations(ctx context.Context, org string, opts *ListOrgCodeSecurityConfigurationOptions) ([]*CodeSecurityConfiguration, *Response, error) {
u := fmt.Sprintf("orgs/%v/code-security/configurations", org)
u, err := addOptions(u, opts)
if err != nil {
return nil, nil, err
}
req, err := s.client.NewRequest("GET", u, nil)
if err != nil {
return nil, nil, err
}
var configurations []*CodeSecurityConfiguration
resp, err := s.client.Do(ctx, req, &configurations)
if err != nil {
return nil, resp, err
}
return configurations, resp, nil
}
// CreateCodeSecurityConfiguration creates a code security configuration for an organization.
//
// GitHub API docs: https://docs.github.com/rest/code-security/configurations#create-a-code-security-configuration
//
//meta:operation POST /orgs/{org}/code-security/configurations
func (s *OrganizationsService) CreateCodeSecurityConfiguration(ctx context.Context, org string, config CodeSecurityConfiguration) (*CodeSecurityConfiguration, *Response, error) {
u := fmt.Sprintf("orgs/%v/code-security/configurations", org)
req, err := s.client.NewRequest("POST", u, config)
if err != nil {
return nil, nil, err
}
var configuration *CodeSecurityConfiguration
resp, err := s.client.Do(ctx, req, &configuration)
if err != nil {
return nil, resp, err
}
return configuration, resp, nil
}
// ListDefaultCodeSecurityConfigurations gets default code security configurations for an organization.
//
// GitHub API docs: https://docs.github.com/rest/code-security/configurations#get-default-code-security-configurations
//
//meta:operation GET /orgs/{org}/code-security/configurations/defaults
func (s *OrganizationsService) ListDefaultCodeSecurityConfigurations(ctx context.Context, org string) ([]*CodeSecurityConfigurationWithDefaultForNewRepos, *Response, error) {
u := fmt.Sprintf("orgs/%v/code-security/configurations/defaults", org)
req, err := s.client.NewRequest("GET", u, nil)
if err != nil {
return nil, nil, err
}
var configurations []*CodeSecurityConfigurationWithDefaultForNewRepos
resp, err := s.client.Do(ctx, req, &configurations)
if err != nil {
return nil, resp, err
}
return configurations, resp, nil
}
// DetachCodeSecurityConfigurationsFromRepositories detaches code security configuration from an organization's repositories.
//
// GitHub API docs: https://docs.github.com/rest/code-security/configurations#detach-configurations-from-repositories
//
//meta:operation DELETE /orgs/{org}/code-security/configurations/detach
func (s *OrganizationsService) DetachCodeSecurityConfigurationsFromRepositories(ctx context.Context, org string, repoIDs []int64) (*Response, error) {
u := fmt.Sprintf("orgs/%v/code-security/configurations/detach", org)
type selectedRepoIDs struct {
SelectedIDs []int64 `json:"selected_repository_ids"`
}
req, err := s.client.NewRequest("DELETE", u, selectedRepoIDs{SelectedIDs: repoIDs})
if err != nil {
return nil, err
}
resp, err := s.client.Do(ctx, req, nil)
if err != nil {
return resp, err
}
return resp, nil
}
// GetCodeSecurityConfiguration gets a code security configuration available in an organization.
//
// GitHub API docs: https://docs.github.com/rest/code-security/configurations#get-a-code-security-configuration
//
//meta:operation GET /orgs/{org}/code-security/configurations/{configuration_id}
func (s *OrganizationsService) GetCodeSecurityConfiguration(ctx context.Context, org string, configurationID int64) (*CodeSecurityConfiguration, *Response, error) {
u := fmt.Sprintf("orgs/%v/code-security/configurations/%v", org, configurationID)
req, err := s.client.NewRequest("GET", u, nil)
if err != nil {
return nil, nil, err
}
var configuration *CodeSecurityConfiguration
resp, err := s.client.Do(ctx, req, &configuration)
if err != nil {
return nil, resp, err
}
return configuration, resp, nil
}
// UpdateCodeSecurityConfiguration updates a code security configuration for an organization.
//
// GitHub API docs: https://docs.github.com/rest/code-security/configurations#update-a-code-security-configuration
//
//meta:operation PATCH /orgs/{org}/code-security/configurations/{configuration_id}
func (s *OrganizationsService) UpdateCodeSecurityConfiguration(ctx context.Context, org string, configurationID int64, config CodeSecurityConfiguration) (*CodeSecurityConfiguration, *Response, error) {
u := fmt.Sprintf("orgs/%v/code-security/configurations/%v", org, configurationID)
req, err := s.client.NewRequest("PATCH", u, config)
if err != nil {
return nil, nil, err
}
var configuration *CodeSecurityConfiguration
resp, err := s.client.Do(ctx, req, &configuration)
if err != nil {
return nil, resp, err
}
return configuration, resp, nil
}
// DeleteCodeSecurityConfiguration deletes a code security configuration for an organization.
//
// GitHub API docs: https://docs.github.com/rest/code-security/configurations#delete-a-code-security-configuration
//
//meta:operation DELETE /orgs/{org}/code-security/configurations/{configuration_id}
func (s *OrganizationsService) DeleteCodeSecurityConfiguration(ctx context.Context, org string, configurationID int64) (*Response, error) {
u := fmt.Sprintf("orgs/%v/code-security/configurations/%v", org, configurationID)
req, err := s.client.NewRequest("DELETE", u, nil)
if err != nil {
return nil, err
}
resp, err := s.client.Do(ctx, req, nil)
if err != nil {
return resp, err
}
return resp, nil
}
// AttachCodeSecurityConfigurationToRepositories attaches code security configurations to repositories for an organization.
//
// GitHub API docs: https://docs.github.com/rest/code-security/configurations#attach-a-configuration-to-repositories
//
//meta:operation POST /orgs/{org}/code-security/configurations/{configuration_id}/attach
func (s *OrganizationsService) AttachCodeSecurityConfigurationToRepositories(ctx context.Context, org string, configurationID int64, scope string, repoIDs []int64) (*Response, error) {
u := fmt.Sprintf("orgs/%v/code-security/configurations/%v/attach", org, configurationID)
type selectedRepoIDs struct {
Scope string `json:"scope"`
SelectedIDs []int64 `json:"selected_repository_ids,omitempty"`
}
req, err := s.client.NewRequest("POST", u, selectedRepoIDs{Scope: scope, SelectedIDs: repoIDs})
if err != nil {
return nil, err
}
resp, err := s.client.Do(ctx, req, nil)
if err != nil && resp.StatusCode != http.StatusAccepted { // StatusAccepted(202) is the expected status code as job is queued for processing
return resp, err
}
return resp, nil
}
// SetDefaultCodeSecurityConfiguration sets a code security configuration as the default for an organization.
//
// GitHub API docs: https://docs.github.com/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization
//
//meta:operation PUT /orgs/{org}/code-security/configurations/{configuration_id}/defaults
func (s *OrganizationsService) SetDefaultCodeSecurityConfiguration(ctx context.Context, org string, configurationID int64, newReposParam string) (*CodeSecurityConfigurationWithDefaultForNewRepos, *Response, error) {
u := fmt.Sprintf("orgs/%v/code-security/configurations/%v/defaults", org, configurationID)
type configParam struct {
DefaultForNewRepos string `json:"default_for_new_repos"`
}
req, err := s.client.NewRequest("PUT", u, configParam{DefaultForNewRepos: newReposParam})
if err != nil {
return nil, nil, err
}
var config *CodeSecurityConfigurationWithDefaultForNewRepos
resp, err := s.client.Do(ctx, req, &config)
if err != nil {
return nil, resp, err
}
return config, resp, nil
}
// ListCodeSecurityConfigurationRepositories gets repositories associated with a code security configuration.
//
// GitHub API docs: https://docs.github.com/rest/code-security/configurations#get-repositories-associated-with-a-code-security-configuration
//
//meta:operation GET /orgs/{org}/code-security/configurations/{configuration_id}/repositories
func (s *OrganizationsService) ListCodeSecurityConfigurationRepositories(ctx context.Context, org string, configurationID int64, opts *ListCodeSecurityConfigurationRepositoriesOptions) ([]*RepositoryAttachment, *Response, error) {
u := fmt.Sprintf("orgs/%v/code-security/configurations/%v/repositories", org, configurationID)
u, err := addOptions(u, opts)
if err != nil {
return nil, nil, err
}
req, err := s.client.NewRequest("GET", u, nil)
if err != nil {
return nil, nil, err
}
var attachments []*RepositoryAttachment
resp, err := s.client.Do(ctx, req, &attachments)
if err != nil {
return nil, resp, err
}
return attachments, resp, nil
}
// GetCodeSecurityConfigurationForRepository gets code security configuration that manages a repository's code security settings.
//
// GitHub API docs: https://docs.github.com/rest/code-security/configurations#get-the-code-security-configuration-associated-with-a-repository
//
//meta:operation GET /repos/{owner}/{repo}/code-security-configuration
func (s *OrganizationsService) GetCodeSecurityConfigurationForRepository(ctx context.Context, org, repo string) (*RepositoryCodeSecurityConfiguration, *Response, error) {
u := fmt.Sprintf("repos/%v/%v/code-security-configuration", org, repo)
req, err := s.client.NewRequest("GET", u, nil)
if err != nil {
return nil, nil, err
}
var repoConfig *RepositoryCodeSecurityConfiguration
resp, err := s.client.Do(ctx, req, &repoConfig)
if err != nil {
return nil, resp, err
}
return repoConfig, resp, nil
}