Skip to content

Commit

Permalink
feat: added actors allowed to bypass policy (#281)
Browse files Browse the repository at this point in the history
* new policy

---------

Co-authored-by: noamd <[email protected]>
Co-authored-by: noamd-legit <[email protected]>
  • Loading branch information
3 people authored Dec 31, 2023
1 parent d64d188 commit 0bb41c2
Show file tree
Hide file tree
Showing 6 changed files with 54 additions and 7 deletions.
3 changes: 2 additions & 1 deletion go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -70,10 +70,11 @@ require (
github.com/golang-jwt/jwt/v4 v4.4.3 // indirect
github.com/golang/groupcache v0.0.0-20210331224755-41bb18bfe9da // indirect
github.com/golang/protobuf v1.5.3 // indirect
github.com/google/go-cmp v0.5.9 // indirect
github.com/google/go-cmp v0.6.0 // indirect
github.com/google/go-containerregistry v0.12.1 // indirect
github.com/google/go-github/v38 v38.1.0 // indirect
github.com/google/go-github/v45 v45.2.0 // indirect
github.com/google/go-github/v57 v57.0.0 // indirect
github.com/google/go-querystring v1.1.0 // indirect
github.com/google/osv-scanner v1.2.1-0.20230302232134-592acbc2539b // indirect
github.com/google/uuid v1.3.0 // indirect
Expand Down
4 changes: 4 additions & 0 deletions go.sum
Original file line number Diff line number Diff line change
Expand Up @@ -1164,6 +1164,8 @@ github.com/google/go-cmp v0.5.7/go.mod h1:n+brtR0CgQNWTVd5ZUFpTBC8YFBDLK/h/bpaJ8
github.com/google/go-cmp v0.5.8/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY=
github.com/google/go-cmp v0.5.9 h1:O2Tfq5qg4qc4AmwVlvv0oLiVAGB7enBSJ2x2DqQFi38=
github.com/google/go-cmp v0.5.9/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY=
github.com/google/go-cmp v0.6.0 h1:ofyhxvXcZhMsU5ulbFiLKl/XBFqE1GSq7atu8tAmTRI=
github.com/google/go-cmp v0.6.0/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY=
github.com/google/go-containerregistry v0.5.1/go.mod h1:Ct15B4yir3PLOP5jsy0GNeYVaIZs/MK/Jz5any1wFW0=
github.com/google/go-containerregistry v0.12.1 h1:W1mzdNUTx4Zla4JaixCRLhORcR7G6KxE5hHl5fkPsp8=
github.com/google/go-containerregistry v0.12.1/go.mod h1:sdIK+oHQO7B93xI8UweYdl887YhuIwg9vz8BSLH3+8k=
Expand All @@ -1173,6 +1175,8 @@ github.com/google/go-github/v45 v45.2.0 h1:5oRLszbrkvxDDqBCNj2hjDZMKmvexaZ1xw/FC
github.com/google/go-github/v45 v45.2.0/go.mod h1:FObaZJEDSTa/WGCzZ2Z3eoCDXWJKMenWWTrd8jrta28=
github.com/google/go-github/v53 v53.2.0 h1:wvz3FyF53v4BK+AsnvCmeNhf8AkTaeh2SoYu/XUvTtI=
github.com/google/go-github/v53 v53.2.0/go.mod h1:XhFRObz+m/l+UCm9b7KSIC3lT3NWSXGt7mOsAWEloao=
github.com/google/go-github/v57 v57.0.0 h1:L+Y3UPTY8ALM8x+TV0lg+IEBI+upibemtBD8Q9u7zHs=
github.com/google/go-github/v57 v57.0.0/go.mod h1:s0omdnye0hvK/ecLvpsGfJMiRt85PimQh4oygmLIxHw=
github.com/google/go-querystring v1.0.0/go.mod h1:odCYkC5MyYFN7vkCjXpyrEuKhc/BUO6wN/zVPAxq5ck=
github.com/google/go-querystring v1.1.0 h1:AnCroh3fv4ZBgVIf1Iwtovgjaw/GiKJo8M8yD/fhyJ8=
github.com/google/go-querystring v1.1.0/go.mod h1:Kcdr2DB4koayq7X8pmAG4sNG59So17icRSOU623lUBU=
Expand Down
17 changes: 14 additions & 3 deletions internal/clients/github/client.go
Original file line number Diff line number Diff line change
Expand Up @@ -599,12 +599,23 @@ func (c *Client) GetRulesForBranch(organization, repository, branch string) ([]*
return nil, err
}

var p []*types.RepositoryRule
_, err = c.client.Do(c.context, req, &p)
var rules []*types.RepositoryRule
_, err = c.client.Do(c.context, req, &rules)
if err != nil {
return nil, err
}
return p, nil

for _, rule := range rules {
specific, _, err := c.Client().Repositories.GetRuleset(c.context, organization, repository, rule.Id, true)
if err != nil {
continue
}

rule.Ruleset = specific
}

return rules, nil

}

func (c *Client) GetSecurityAndAnalysisForEnterprise(enterprise string) (*types.AnalysisAndSecurityPolicies, error) {
Expand Down
9 changes: 7 additions & 2 deletions internal/clients/github/types/types.go
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
package types

import "encoding/json"
import (
"encoding/json"
"github.com/google/go-github/v53/github"
)

type TokenPermissions struct {
DefaultWorkflowPermissions *string `json:"default_workflow_permissions,omitempty"`
Expand All @@ -10,6 +13,8 @@ type TokenPermissions struct {
type RepositoryRule struct {
Type string `json:"type"`
Parameters *json.RawMessage `json:"parameters,omitempty"`
Id int64 `json:"ruleset_id"`
Ruleset *github.Ruleset `json:"ruleset"`
}

type AnalysisAndSecurityPolicies struct {
Expand All @@ -18,4 +23,4 @@ type AnalysisAndSecurityPolicies struct {
SecretScanningEnabledForNewRepositories bool `json:"secret_scanning_enabled_for_new_repositories"`
SecretScanningPushProtectionEnabledForNewRepos bool `json:"secret_scanning_push_protection_enabled_for_new_repositories"`
SecretScanningPushProtectionCustomLink string `json:"secret_scanning_push_protection_custom_link"`
}
}
2 changes: 1 addition & 1 deletion internal/collected/github/repository.go
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ type Repository struct {
Collaborators []*github.User `json:"collaborators,omitempty"`
ActionsTokenPermissions *types.TokenPermissions `json:"actions_token_permissions"`
DependencyGraphManifests *GitHubQLDependencyGraphManifests `json:"dependency_graph_manifests"`
RulesSet []*types.RepositoryRule `json:"rules_set"`
RulesSet []*types.RepositoryRule `json:"rules_set,omitempty"`
}

func (r Repository) ViolationEntityType() string {
Expand Down
26 changes: 26 additions & 0 deletions policies/github/repository.rego
Original file line number Diff line number Diff line change
Expand Up @@ -513,3 +513,29 @@ default actions_can_approve_pull_requests := true
actions_can_approve_pull_requests := false{
not input.actions_token_permissions.can_approve_pull_request_reviews
}

# METADATA
# scope: rule
# title: Users Are Allowed To Bypass Ruleset Rules
# description: Rulesets rules are not enforced for some users. When defining rulesets it is recommended to make sure that no one is allowed to bypass these rules in order to avoid inadvertent or intentional alterations to critical code which can lead to potential errors or vulnerabilities in the software.
# custom:
# remediationSteps:
# - Go to the repository settings page
# - Under "Code and automation", select "Rules -> Rulesets"
# - Find the relevant ruleset
# - Empty the "Bypass list"
# - Press "Save Changes"
# severity: MEDIUM
# requiredScopes: [repo]
# threat: Attackers that gain access to a user that can bypass the ruleset rules can compromise the codebase without anyone noticing, introducing malicious code that would go straight ahead to production.
default users_allowed_to_bypass_ruleset := true

users_allowed_to_bypass_ruleset := false {
count(input.rules_set) == 0
}

users_allowed_to_bypass_ruleset := false {
some index
rule := input.rules_set[index]
count(rule.ruleset.bypass_actors) == 0
}

0 comments on commit 0bb41c2

Please sign in to comment.