Documentation
¶
Overview ¶
Package github manages the configuration and execution of the Vault Secrets Plugin for GitHub.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Client ¶
type Client struct {
*Config
// contains filtered or unexported fields
}
Client encapsulates an HTTP client for talking to the configured GitHub App.
func NewClient ¶
NewClient returns a newly constructed client from the provided config and with sensible default transport settings. It will error if it fails to validate necessary configuration formats like URIs and PEM encoded private keys.
func (*Client) ListInstallations ¶ added in v2.2.2
ListInstallations retrieves a list of App installations associated with the client. It returns a logical.Response containing a map where the keys are account names and the values are corresponding installation IDs. In case of an error during the fetch operation, it returns nil and the error.
func (*Client) RevokeToken ¶
RevokeToken takes a valid access token and performs a revocation against GitHub's APIs. If there are any failures on the wire or parsing request and response object, an error is returned.
type Config ¶
type Config struct {
// PrvKey is the private for signing GitHub access token requests (JWTs).
// NOTE: Should be in a PEM PKCS#1 RSAPrivateKey format.
PrvKey string `json:"prv_key"`
// BaseURL is the base URL for API requests.
// Defaults to GitHub's public API.
BaseURL string `json:"base_url"`
// AppID is the application identifier of the GitHub App.
AppID int `json:"app_id"`
// ExcludeRepositoryMetadata controls filtering of the 'repositories' key
// returned on repository-filtered tokens. It defaults to returning full
// repository metadata but will return a minimised list of repository names
// if set.
ExcludeRepositoryMetadata bool `json:"exclude_repository_metadata"`
}
Config holds all configuration for the backend.
type PermissionSet ¶
type PermissionSet struct {
Name string
TokenRequest *tokenRequest
}
PermissionSet models the data and methods needed for storing and retrieving permission sets in Vault.
Source Files