client

Documentation

Index

• Constants
• type Client
  • func NewAuthClient(voucherURL string) (*Client, error)
  • func NewClient(voucherURL string) (*Client, error)
  • func NewClientContext(ctx context.Context, voucherURL string, options ...Option) (*Client, error)
  • func (c *Client) Check(ctx context.Context, check string, image reference.Canonical) (voucher.Response, error)
  • func (c *Client) CopyURL() *url.URL
  • func (c *Client) SetBasicAuth(username, password string)
  • func (c *Client) Verify(ctx context.Context, check string, image reference.Canonical) (voucher.Response, error)
• type Option
  • func WithBasicAuth(username, password string) Option
  • func WithDefaultIDTokenAuth() Option
  • func WithHTTPClient(httpClient *http.Client) Option
  • func WithIDTokenAuth() Option
  • func WithUserAgent(userAgent string) Option

Constants

const DefaultUserAgent = "voucher-client/2"

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client is a client for the Voucher API.

func NewAuthClient

func NewAuthClient(voucherURL string) (*Client, error)

NewAuthClient creates a new auth Client set to connect to the passed hostname using tokens. Deprecated: use NewClientContext and the WithIDTokenAuth option instead

func NewClient

func NewClient(voucherURL string) (*Client, error)

NewClient creates a new auth Client. Deprecated: use NewClientContext

func NewClientContext

func NewClientContext(ctx context.Context, voucherURL string, options ...Option) (*Client, error)

NewClientContext creates a new Client set to connect to the passed hostname.

func (*Client) Check

func (c *Client) Check(ctx context.Context, check string, image reference.Canonical) (voucher.Response, error)

Check executes a request to a Voucher server, to the appropriate check URI, and with the passed reference.Canonical. Returns a voucher.Response and an error.

func (*Client) CopyURL

func (c *Client) CopyURL() *url.URL

CopyURL returns a copy of this client's URL

func (*Client) SetBasicAuth

func (c *Client) SetBasicAuth(username, password string)

SetBasicAuth adds the username and password to the Client struct Deprecated: use the WithBasicAuth option instead

func (*Client) Verify

func (c *Client) Verify(ctx context.Context, check string, image reference.Canonical) (voucher.Response, error)

type Option

type Option func(context.Context, *Client) error

func WithBasicAuth

func WithBasicAuth(username, password string) Option

WithBasicAuth sets the username and password to use for the client.

func WithDefaultIDTokenAuth

func WithDefaultIDTokenAuth() Option

WithDefaultIDTokenAuth configures the client to use Google's default token.

func WithHTTPClient

func WithHTTPClient(httpClient *http.Client) Option

WithHTTPClient customizes the http.Client used by the client. Customize the client's Transport to do arbitrary authentication.

func WithIDTokenAuth

func WithIDTokenAuth() Option

WithIDTokenAuth configures the client to use an ID token.

func WithUserAgent

func WithUserAgent(userAgent string) Option

WithUserAgent sets the User-Agent header for the client.