package credentials

import "github.com/ydb-platform/ydb-go-sdk/v3/credentials"

Index ¶

• func NewAccessTokenCredentials( accessToken string, opts ...credentials.AccessTokenCredentialsOption, ) *credentials.AccessToken
• func NewAnonymousCredentials( opts ...credentials.AnonymousCredentialsOption, ) *credentials.Anonymous
• func NewFixedTokenSource(token, tokenType string) credentials.TokenSource
• func NewJWTTokenSource(opts ...credentials.JWTTokenSourceOption) (credentials.TokenSource, error)
• func NewStaticCredentials( user, password, authEndpoint string, opts ...credentials.StaticCredentialsOption, ) *credentials.Static
• func WithAudience(audience ...string) oauthCredentialsAndJWTCredentialsOption
• func WithGrpcDialOptions(opts ...grpc.DialOption) credentials.StaticCredentialsOption
• func WithID(id string) credentials.JWTTokenSourceOption
• func WithIssuer(issuer string) credentials.JWTTokenSourceOption
• func WithKeyID(id string) credentials.JWTTokenSourceOption
• func WithPrivateKey(key interface{}) credentials.JWTTokenSourceOption
• func WithRSAPrivateKeyPEMContent(key []byte) credentials.JWTTokenSourceOption
• func WithRSAPrivateKeyPEMFile(path string) credentials.JWTTokenSourceOption
• func WithSigningMethod(method jwt.SigningMethod) credentials.JWTTokenSourceOption
• func WithSourceInfo(sourceInfo string) credentials.SourceInfoOption
• func WithSubject(subject string) credentials.JWTTokenSourceOption
• func WithTokenTTL(ttl time.Duration) credentials.JWTTokenSourceOption
• type Credentials
• func NewOauth2TokenExchangeCredentials( opts ...credentials.Oauth2TokenExchangeCredentialsOption, ) (Credentials, error)
• type Oauth2TokenExchangeCredentialsOption
• func WithActorToken(actorToken credentials.TokenSource) Oauth2TokenExchangeCredentialsOption
• func WithFixedActorToken(token, tokenType string) Oauth2TokenExchangeCredentialsOption
• func WithFixedSubjectToken(token, tokenType string) Oauth2TokenExchangeCredentialsOption
• func WithGrantType(grantType string) Oauth2TokenExchangeCredentialsOption
• func WithJWTActorToken(opts ...credentials.JWTTokenSourceOption) Oauth2TokenExchangeCredentialsOption
• func WithJWTSubjectToken(opts ...credentials.JWTTokenSourceOption) Oauth2TokenExchangeCredentialsOption
• func WithRequestTimeout(timeout time.Duration) Oauth2TokenExchangeCredentialsOption
• func WithRequestedTokenType(requestedTokenType string) Oauth2TokenExchangeCredentialsOption
• func WithResource(resource string) Oauth2TokenExchangeCredentialsOption
• func WithScope(scope ...string) Oauth2TokenExchangeCredentialsOption
• func WithSubjectToken(subjectToken credentials.TokenSource) Oauth2TokenExchangeCredentialsOption
• func WithTokenEndpoint(endpoint string) Oauth2TokenExchangeCredentialsOption
• type Token
• type TokenSource

Functions ¶

func NewAccessTokenCredentials ¶

func NewAccessTokenCredentials(
	accessToken string, opts ...credentials.AccessTokenCredentialsOption,
) *credentials.AccessToken

NewAccessTokenCredentials makes access token credentials object Passed options redefines default values of credentials object internal fields

func NewAnonymousCredentials ¶

func NewAnonymousCredentials(
	opts ...credentials.AnonymousCredentialsOption,
) *credentials.Anonymous

NewAnonymousCredentials makes anonymous credentials object Passed options redefines default values of credentials object internal fields

func NewFixedTokenSource ¶

func NewFixedTokenSource(token, tokenType string) credentials.TokenSource

NewFixedTokenSource makes fixed token source for OAuth 2.0 token exchange credentials

func NewJWTTokenSource ¶

func NewJWTTokenSource(opts ...credentials.JWTTokenSourceOption) (credentials.TokenSource, error)

NewJWTTokenSource makes JWT token source for OAuth 2.0 token exchange credentials

func NewStaticCredentials ¶

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

NewStaticCredentials makes static credentials object

func WithAudience ¶

func WithAudience(audience ...string) oauthCredentialsAndJWTCredentialsOption

func WithGrpcDialOptions ¶

func WithGrpcDialOptions(opts ...grpc.DialOption) credentials.StaticCredentialsOption

WithGrpcDialOptions option append to static credentials object GRPC dial options

func WithID ¶

func WithID(id string) credentials.JWTTokenSourceOption

ID

func WithIssuer ¶

func WithIssuer(issuer string) credentials.JWTTokenSourceOption

Issuer

func WithKeyID ¶

func WithKeyID(id string) credentials.JWTTokenSourceOption

KeyID

func WithPrivateKey ¶

func WithPrivateKey(key interface{}) credentials.JWTTokenSourceOption

PrivateKey

func WithRSAPrivateKeyPEMContent ¶

func WithRSAPrivateKeyPEMContent(key []byte) credentials.JWTTokenSourceOption

PrivateKey

func WithRSAPrivateKeyPEMFile ¶

func WithRSAPrivateKeyPEMFile(path string) credentials.JWTTokenSourceOption

PrivateKey

func WithSigningMethod ¶

func WithSigningMethod(method jwt.SigningMethod) credentials.JWTTokenSourceOption

SigningMethod

func WithSourceInfo ¶

func WithSourceInfo(sourceInfo string) credentials.SourceInfoOption

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

func WithSubject ¶

func WithSubject(subject string) credentials.JWTTokenSourceOption

Subject

func WithTokenTTL ¶

func WithTokenTTL(ttl time.Duration) credentials.JWTTokenSourceOption

TokenTTL

Types ¶

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

func NewOauth2TokenExchangeCredentials ¶

func NewOauth2TokenExchangeCredentials(
	opts ...credentials.Oauth2TokenExchangeCredentialsOption,
) (Credentials, error)

NewOauth2TokenExchangeCredentials makes OAuth 2.0 token exchange protocol credentials object https://www.rfc-editor.org/rfc/rfc8693

type Oauth2TokenExchangeCredentialsOption ¶

type Oauth2TokenExchangeCredentialsOption = credentials.Oauth2TokenExchangeCredentialsOption

func WithActorToken ¶

func WithActorToken(actorToken credentials.TokenSource) Oauth2TokenExchangeCredentialsOption

ActorTokenSource

func WithFixedActorToken ¶

func WithFixedActorToken(token, tokenType string) Oauth2TokenExchangeCredentialsOption

ActorTokenSource

func WithFixedSubjectToken ¶

func WithFixedSubjectToken(token, tokenType string) Oauth2TokenExchangeCredentialsOption

SubjectTokenSource

func WithGrantType ¶

func WithGrantType(grantType string) Oauth2TokenExchangeCredentialsOption

GrantType

func WithJWTActorToken ¶

func WithJWTActorToken(opts ...credentials.JWTTokenSourceOption) Oauth2TokenExchangeCredentialsOption

ActorTokenSource

func WithJWTSubjectToken ¶

func WithJWTSubjectToken(opts ...credentials.JWTTokenSourceOption) Oauth2TokenExchangeCredentialsOption

SubjectTokenSource

func WithRequestTimeout ¶

func WithRequestTimeout(timeout time.Duration) Oauth2TokenExchangeCredentialsOption

RequestTimeout

func WithRequestedTokenType ¶

func WithRequestedTokenType(requestedTokenType string) Oauth2TokenExchangeCredentialsOption

RequestedTokenType

func WithResource ¶

func WithResource(resource string) Oauth2TokenExchangeCredentialsOption

Resource

func WithScope ¶

func WithScope(scope ...string) Oauth2TokenExchangeCredentialsOption

Scope

func WithSubjectToken ¶

func WithSubjectToken(subjectToken credentials.TokenSource) Oauth2TokenExchangeCredentialsOption

SubjectTokenSource

func WithTokenEndpoint ¶

func WithTokenEndpoint(endpoint string) Oauth2TokenExchangeCredentialsOption

TokenEndpoint

type Token ¶

type Token = credentials.Token

type TokenSource ¶

type TokenSource = credentials.TokenSource

Source Files ¶

credentials.go options.go