common

Documentation

Index

• func GetAllGistsForUser(client *gh.Client) ([]*gh.Gist, error)
• func GetAllReposForUser(client *gh.Client) ([]*gh.Repository, error)
• func PrintGists(gists []*gh.Gist, showAll bool)
• func PrintGitHubRepos(repos []*gh.Repository)
• type Permission
• type SecretInfo
• type TokenMetadata
  • func GetTokenMetadata(token string, client *gh.Client) (*TokenMetadata, error)
• type TokenType

Functions

func GetAllGistsForUser

func GetAllGistsForUser(client *gh.Client) ([]*gh.Gist, error)

func GetAllReposForUser

func GetAllReposForUser(client *gh.Client) ([]*gh.Repository, error)

func PrintGists

func PrintGists(gists []*gh.Gist, showAll bool)

func PrintGitHubRepos

func PrintGitHubRepos(repos []*gh.Repository)

Types

type Permission

type Permission int

type SecretInfo

type SecretInfo struct {
	Metadata *TokenMetadata
	Repos    []*gh.Repository
	Gists    []*gh.Gist
	// AccessibleRepos, RepoAccessMap, and UserAccessMap are only set if
	// the token has fine-grained access.
	AccessibleRepos []*gh.Repository
	RepoAccessMap   any
	UserAccessMap   any
}

type TokenMetadata

type TokenMetadata struct {
	Type        TokenType
	FineGrained bool
	User        *gh.User
	Expiration  time.Time
	// OauthScopes is only set for classic tokens.
	OauthScopes []analyzers.Permission
}

func GetTokenMetadata

func GetTokenMetadata(token string, client *gh.Client) (*TokenMetadata, error)

GetTokenMetadata gets the username, expiration date, and x-oauth-scopes headers for a given token by sending a GET request to the /user endpoint Returns a response object for usage in the checkFineGrained function

type TokenType

type TokenType string

const (
	TokenTypeFineGrainedPAT TokenType = "Fine-Grained GitHub Personal Access Token"
	TokenTypeClassicPAT     TokenType = "Classic GitHub Personal Access Token"
	TokenTypeUserToServer   TokenType = "GitHub User-to-Server Token"
	TokenTypeGitHubToken    TokenType = "GitHub Token"
)