credentials

Documentation

Index

• func AccessError(msg string, err error, opts ...authErrorOption) error
• func IsAccessError(err error) bool
• func WithAddress(address string) addressAuthErrorOption
• func WithCredentials(credentials Credentials) credentialsUnauthenticatedErrorOption
• func WithDatabase(database string) databaseAuthErrorOption
• func WithEndpoint(endpoint string) endpointAuthErrorOption
• func WithGrpcDialOptions(opts ...grpc.DialOption) grpcDialOptionsOption
• func WithNodeID(id uint32) authErrorOption
• type AccessToken
  • func NewAccessTokenCredentials(token string, opts ...AccessTokenCredentialsOption) *AccessToken
  • func (c AccessToken) String() string
  • func (c AccessToken) Token(_ context.Context) (string, error)
• type AccessTokenCredentialsOption
• type Anonymous
  • func NewAnonymousCredentials(opts ...AnonymousCredentialsOption) *Anonymous
  • func (c Anonymous) String() string
  • func (c Anonymous) Token(_ context.Context) (string, error)
• type AnonymousCredentialsOption
• type Credentials
• type SourceInfoOption
  • func WithSourceInfo(sourceInfo string) SourceInfoOption
  • func (sourceInfo SourceInfoOption) ApplyAccessTokenCredentialsOption(h *AccessToken)
  • func (sourceInfo SourceInfoOption) ApplyAnonymousCredentialsOption(h *Anonymous)
  • func (sourceInfo SourceInfoOption) ApplyStaticCredentialsOption(h *Static)
• type Static
  • func NewStaticCredentials(user, password, endpoint string, opts ...StaticCredentialsOption) *Static
  • func (c *Static) String() string
  • func (c *Static) Token(ctx context.Context) (token string, err error)
• type StaticCredentialsOption

Functions

func AccessError

func AccessError(msg string, err error, opts ...authErrorOption) error

func IsAccessError

func IsAccessError(err error) bool

func WithAddress

func WithAddress(address string) addressAuthErrorOption

func WithCredentials

func WithCredentials(credentials Credentials) credentialsUnauthenticatedErrorOption

func WithDatabase

func WithDatabase(database string) databaseAuthErrorOption

func WithEndpoint

func WithEndpoint(endpoint string) endpointAuthErrorOption

func WithGrpcDialOptions

func WithGrpcDialOptions(opts ...grpc.DialOption) grpcDialOptionsOption

func WithNodeID

func WithNodeID(id uint32) authErrorOption

Types

type AccessToken

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

AccessToken implements Credentials interface with static authorization parameters.

func NewAccessTokenCredentials

func NewAccessTokenCredentials(token string, opts ...AccessTokenCredentialsOption) *AccessToken

func (AccessToken) String

func (c AccessToken) String() string

Token implements Credentials.

func (AccessToken) Token

func (c AccessToken) Token(_ context.Context) (string, error)

Token implements Credentials.

type AccessTokenCredentialsOption

type AccessTokenCredentialsOption interface {
	ApplyAccessTokenCredentialsOption(c *AccessToken)
}

type Anonymous

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

Anonymous implements Credentials interface with Anonymous access

func NewAnonymousCredentials

func NewAnonymousCredentials(opts ...AnonymousCredentialsOption) *Anonymous

func (Anonymous) String

func (c Anonymous) String() string

Token implements Credentials.

func (Anonymous) Token

func (c Anonymous) Token(_ context.Context) (string, error)

Token implements Credentials.

type AnonymousCredentialsOption

type AnonymousCredentialsOption interface {
	ApplyAnonymousCredentialsOption(c *Anonymous)
}

type Credentials

type Credentials interface {
	// Token must return actual token or error
	Token(ctx context.Context) (string, error)
}

Credentials is an interface of YDB credentials required for connect with YDB

type SourceInfoOption

type SourceInfoOption string

func WithSourceInfo

func WithSourceInfo(sourceInfo string) SourceInfoOption

WithSourceInfo option append to credentials object the source info for reporting source info details on error case

func (SourceInfoOption) ApplyAccessTokenCredentialsOption

func (sourceInfo SourceInfoOption) ApplyAccessTokenCredentialsOption(h *AccessToken)

func (SourceInfoOption) ApplyAnonymousCredentialsOption

func (sourceInfo SourceInfoOption) ApplyAnonymousCredentialsOption(h *Anonymous)

func (SourceInfoOption) ApplyStaticCredentialsOption

func (sourceInfo SourceInfoOption) ApplyStaticCredentialsOption(h *Static)

type Static

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

Static implements Credentials interface with static authorization parameters.

func NewStaticCredentials

func NewStaticCredentials(user, password, endpoint string, opts ...StaticCredentialsOption) *Static

func (*Static) String

func (c *Static) String() string

func (*Static) Token

func (c *Static) Token(ctx context.Context) (token string, err error)

type StaticCredentialsOption

type StaticCredentialsOption interface {
	ApplyStaticCredentialsOption(c *Static)
}