aws

package

v2.1.4 Latest Latest Go to latest Published: Jun 21, 2020 License: Apache-2.0 Imports: 12 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

gitlab.com/ModelRocket/sparks/v2

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func New(name string, params types.StringMap) (auth.Provider, error)
type AuthChallenge
- func (c *AuthChallenge) Error() string
type AuthToken
type User
type UserPool

Constants ¶

View Source

const (
	// JWKSURL is the cognito well-known public keys url
	JWKSURL = "https://cognito-idp.%s.amazonaws.com/%s/.well-known/jwks.json"
)

Variables ¶

This section is empty.

Functions ¶

func New ¶

func New(name string, params types.StringMap) (auth.Provider, error)

New returns a cognito user pool instance as an auth.Provider This method takes the following required parameters:

client_id: the cognito client id
public_keys: base64 encoded json string, retrieved from:
	https://cognito-idp.<region>.amazonaws.com/<pool_id>/.well-known/jwks.json

Types ¶

type AuthChallenge ¶

type AuthChallenge struct {
	Name    *string
	Params  map[string]*string
	Session *string
}

AuthChallenge is a congnito auth challenge

func (*AuthChallenge) Error ¶

func (c *AuthChallenge) Error() string

type AuthToken ¶

type AuthToken struct {
	keychain.AuthToken
}

AuthToken is an JWT AuthToken

func (*AuthToken) ID ¶

func (t *AuthToken) ID() string

ID returns the token id

func (*AuthToken) Scope ¶

func (t *AuthToken) Scope() []string

Scope returns the token scope

func (*AuthToken) Username ¶

func (t *AuthToken) Username() string

Username returns the token username

type User ¶

type User struct {
	*cognitoidentityprovider.UserType
	// contains filtered or unexported fields
}

User is a cognito User

func (*User) Attributes ¶

func (u *User) Attributes() types.StringMap

Attributes returns a map of user attributes

func (*User) Enabled ¶

func (u *User) Enabled() bool

Enabled represents the user's status

func (*User) Groups ¶

func (u *User) Groups() []string

Groups returns a list of groups the user belongs to

func (u *User) Login() string

Login returns the user login i.e. username

func (*User) Status ¶

func (u *User) Status() string

Status returns the user status

type UserPool ¶

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

UserPool is a congnito UserPool

func (*UserPool) AuthenticateUser ¶

func (p *UserPool) AuthenticateUser(username, password string) (keychain.AuthToken, error)

AuthenticateUser authenticates the user and returns an AuthToken

func (*UserPool) ChangeUserPassword ¶

func (p *UserPool) ChangeUserPassword(username, current, proposed string) error

ChangeUserPassword changes the users password This method first attempt to authenticate the user to get a session token then it uses this token to perform the actual password change.

func (*UserPool) CreateUser ¶

func (p *UserPool) CreateUser(username, password string, attributes map[string]string, options ...types.StringMap) (auth.User, error)

CreateUser creates a new user

func (*UserPool) DeleteUser ¶

func (p *UserPool) DeleteUser(username string) error

DeleteUser deletes a user record

func (*UserPool) DisableUser ¶

func (p *UserPool) DisableUser(username string) error

DisableUser disables a user account

func (*UserPool) GetUser ¶

func (p *UserPool) GetUser(username string) (auth.User, error)

GetUser returns a user

func (*UserPool) UpdateUser ¶

func (p *UserPool) UpdateUser(username string, attributes types.StringMap) error

UpdateUser updates a users attributes

Source Files ¶

View all Source files

provider.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL