Documentation
¶
Overview ¶
Package github also provides a verifier for GitHub OAuth tokens. It uses the GitHub API GET /user endpoint to check token validity.
Package github provides a verifier for GitHub personal access tokens. It uses the GitHub API GET /user endpoint to check token validity.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type OAuthVerifier ¶
type OAuthVerifier struct {
// contains filtered or unexported fields
}
OAuthVerifier checks whether a GitHub OAuth token is active by calling the GitHub API. It NEVER logs or persists raw token values.
func NewOAuthForTrustedInstance ¶ added in v1.8.0
func NewOAuthForTrustedInstance(instanceURL string) (*OAuthVerifier, error)
NewOAuthForTrustedInstance constructs a subtype-aware GitHub App/OAuth verifier for an explicit GitHub.com or GHES API origin.
func (*OAuthVerifier) Type ¶
func (v *OAuthVerifier) Type() string
Type returns the detector ID this verifier handles.
func (*OAuthVerifier) Verify ¶
func (v *OAuthVerifier) Verify(ctx context.Context, raw detector.RawFinding) finding.VerificationResult
Verify checks if the detected GitHub OAuth token is valid/active. Raw contains the token value.
func (*OAuthVerifier) WithTrustedInstance ¶ added in v1.8.0
func (*OAuthVerifier) WithTrustedInstance(instanceURL string) (verifier.Verifier, error)
WithTrustedInstance implements verifier.TrustedInstanceConfigurer.
type Verifier ¶
type Verifier struct {
// contains filtered or unexported fields
}
Verifier checks whether a GitHub token is active by calling the GitHub API. It NEVER logs or persists raw token values.
func NewForTrustedInstance ¶ added in v1.8.0
NewForTrustedInstance constructs a GitHub PAT verifier for an origin chosen explicitly by the operator (GitHub.com API or a GHES API origin).
func (*Verifier) Verify ¶
func (v *Verifier) Verify(ctx context.Context, raw detector.RawFinding) finding.VerificationResult
Verify checks if the detected GitHub token is valid/active. Raw contains the token value.
Source Files