server

Documentation

Index

• Constants
• func GitHubTokenToUsername(ctx context.Context, githubUsername string, oauthToken string) (string, error)
• func NewAuthServer(pachdAddress string, etcdAddress string, etcdPrefix string) (authclient.APIServer, error)

Constants

const (
	// DisableAuthenticationEnvVar specifies an environment variable that, if set, causes
	// Pachyderm authentication to ignore github and authmatically generate a
	// pachyderm token for any username in the AuthenticateRequest.GitHubToken field
	DisableAuthenticationEnvVar = "PACHYDERM_AUTHENTICATION_DISABLED_FOR_TESTING"

	// GitHubPrefix indicates that this Subject is a GitHub user (because users
	// can authenticate via GitHub, and Pachyderm doesn't have a users table,
	// every GitHub user is also a logical Pachyderm user (but most won't be on
	// any ACLs)
	GitHubPrefix = "github:"

	// RobotPrefix indicates that this Subject is a Pachyderm robot user. Any
	// string (with this prefix) is a logical Pachyderm robot user.
	RobotPrefix = "robot:"
)

Functions

func GitHubTokenToUsername

func GitHubTokenToUsername(ctx context.Context, githubUsername string, oauthToken string) (string, error)

GitHubTokenToUsername takes a OAuth access token issued by GitHub and uses it discover the username of the user who obtained the code (or verify that the code belongs to githubUsername). This is how Pachyderm currently implements authorization in a production cluster

func NewAuthServer

func NewAuthServer(pachdAddress string, etcdAddress string, etcdPrefix string) (authclient.APIServer, error)

NewAuthServer returns an implementation of authclient.APIServer.