server

Documentation

Index

• Constants
• Variables
• func GitHubTokenToUsername(ctx context.Context, oauthToken string) (string, error)
• type APIServer
  • func NewAuthServer(env *serviceenv.ServiceEnv, txnEnv *txnenv.TransactionEnv, etcdPrefix string, ...) (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"

	// SamlPort is the port where SAML ID Providers can send auth assertions
	SamlPort = 654
)

Variables

var DefaultAuthConfig = auth.AuthConfig{
	LiveConfigVersion: 1,
	IDProviders: []*auth.IDProvider{
		&auth.IDProvider{
			Name:        "GitHub",
			Description: "oauth-based authentication with github.com",
			GitHub:      &auth.IDProvider_GitHubOptions{},
		},
	},
}

DefaultAuthConfig is the default config for the auth API server

var DefaultDashRedirectURL = &url.URL{
	Scheme: "http",
	Host:   "localhost:30080",

	Path: path.Join("/", "auth", "autologin"),
}

DefaultDashRedirectURL is the default URL used for redirecting the dashboard

Functions

func GitHubTokenToUsername

func GitHubTokenToUsername(ctx context.Context, 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

Types

type APIServer

type APIServer interface {
	auth.APIServer
	txnenv.AuthTransactionServer
}

APIServer represents an auth api server

func NewAuthServer

func NewAuthServer(
	env *serviceenv.ServiceEnv,
	txnEnv *txnenv.TransactionEnv,
	etcdPrefix string,
	public bool,
) (APIServer, error)

NewAuthServer returns an implementation of auth.APIServer.