github

Documentation

Index

• func SetHeaderInfo(headers *HeaderInfo, s1 *detectors.Result)
• func SetUserResponse(userResponse *UserRes, s1 *detectors.Result)
• type HeaderInfo
• type Scanner
  • func (Scanner) DefaultEndpoint() string
  • func (s Scanner) FromData(ctx context.Context, verify bool, data []byte) (results []detectors.Result, err error)
  • func (s Scanner) Keywords() []string
  • func (s Scanner) Type() detectorspb.DetectorType
  • func (s Scanner) VerifyGithub(ctx context.Context, client *http.Client, token string) (bool, *UserRes, *HeaderInfo, error)
  • func (Scanner) Version() int
• type UserRes

Functions

func SetHeaderInfo

func SetHeaderInfo(headers *HeaderInfo, s1 *detectors.Result)

func SetUserResponse

func SetUserResponse(userResponse *UserRes, s1 *detectors.Result)

Types

type HeaderInfo

type HeaderInfo struct {
	Scopes string `json:"X-OAuth-Scopes"`
	Expiry string `json:"github-authentication-token-expiration"`
}

type Scanner

type Scanner struct{ detectors.EndpointSetter }

func (Scanner) DefaultEndpoint

func (Scanner) DefaultEndpoint() string

func (Scanner) FromData

func (s Scanner) FromData(ctx context.Context, verify bool, data []byte) (results []detectors.Result, err error)

FromData will find and optionally verify GitHub secrets in a given set of bytes.

func (Scanner) Keywords

func (s Scanner) Keywords() []string

Keywords are used for efficiently pre-filtering chunks. Use identifiers in the secret preferably, or the provider name.

func (Scanner) Type

func (s Scanner) Type() detectorspb.DetectorType

func (Scanner) VerifyGithub

func (s Scanner) VerifyGithub(ctx context.Context, client *http.Client, token string) (bool, *UserRes, *HeaderInfo, error)

func (Scanner) Version

func (Scanner) Version() int

type UserRes

type UserRes struct {
	Login     string `json:"login"`
	Type      string `json:"type"`
	SiteAdmin bool   `json:"site_admin"`
	Name      string `json:"name"`
	Company   string `json:"company"`
	UserURL   string `json:"html_url"`
	Email     string `json:"email"`
	Location  string `json:"location"`
	// Included in GitHub Enterprise Server.
	LdapDN string `json:"ldap_dn"`
}

TODO: Add secret context?? Information about access, ownership etc