github

package

v0.3.1 Latest Latest Go to latest Published: Mar 1, 2024 License: Apache-2.0 Imports: 13 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/in-toto/go-witness

Links

Open Source Insights

Documentation ¶

Constants ¶

View Source

const (
	Name    = "github"
	Type    = "https://witness.dev/attestations/github/v0.1"
	RunType = attestation.PreMaterialRunType
)

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Attestor ¶

type Attestor struct {
	JWT          *jwt.Attestor `json:"jwt,omitempty"`
	CIConfigPath string        `json:"ciconfigpath"`
	PipelineID   string        `json:"pipelineid"`
	PipelineName string        `json:"pipelinename"`
	PipelineUrl  string        `json:"pipelineurl"`
	ProjectUrl   string        `json:"projecturl"`
	RunnerID     string        `json:"runnerid"`
	CIHost       string        `json:"cihost"`
	CIServerUrl  string        `json:"ciserverurl"`
	RunnerArch   string        `json:"runnerarch"`
	RunnerOS     string        `json:"runneros"`
	// contains filtered or unexported fields
}

Attestor is a struct that holds the necessary information for github attestation.

func New ¶

func New() *Attestor

New creates and returns a new github attestor.

func (*Attestor) Attest ¶

func (a *Attestor) Attest(ctx *attestation.AttestationContext) error

Attest performs the attestation for the github environment.

func (*Attestor) BackRefs ¶

func (a *Attestor) BackRefs() map[string]cryptoutil.DigestSet

BackRefs returns a map of back references and their corresponding digest sets.

func (*Attestor) Name ¶

func (a *Attestor) Name() string

Name returns the name of the attestor.

func (*Attestor) RunType ¶

func (a *Attestor) RunType() attestation.RunType

RunType returns the run type of the attestor.

func (*Attestor) Subjects ¶

func (a *Attestor) Subjects() map[string]cryptoutil.DigestSet

Subjects returns a map of subjects and their corresponding digest sets.

func (*Attestor) Type ¶

func (a *Attestor) Type() string

Type returns the type of the attestor.

type ErrNotGitlab ¶

type ErrNotGitlab struct{}

ErrNotGitlab is an error type that indicates the environment is not a github ci job.

func (ErrNotGitlab) Error ¶

func (e ErrNotGitlab) Error() string

Error returns the error message for ErrNotGitlab.

type GithubTokenResponse ¶

type GithubTokenResponse struct {
	Count int    `json:"count"`
	Value string `json:"value"`
}

GithubTokenResponse is a struct that holds the response from the github token request.

Source Files ¶

View all Source files

github.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL