srp

Documentation

Overview

Package srp calculates the responses to cognito srp challenges to authenticate client and get tokens

This is de facto utility package for main Auth package

Is is de facto copy-paste from https://github.com/AlexRudd/cognito-srp (which is based on capless warrant: https://github.com/capless/warrant) The only changed thing is that I removed the dependency to aws sdk and aws cognitoidentityprovider because for this package they are not needed. (changes are documented in comments)

Index

• type CognitoSRP
  • func NewCognitoSRP(username, password, poolId, clientId string, clientSecret *string) (*CognitoSRP, error)
  • func (csrp *CognitoSRP) GetAuthParams() map[string]string
  • func (csrp *CognitoSRP) GetClientId() string
  • func (csrp *CognitoSRP) GetSecretHash(username string) (string, error)
  • func (csrp *CognitoSRP) GetUserPoolId() string
  • func (csrp *CognitoSRP) GetUserPoolName() string
  • func (csrp *CognitoSRP) GetUsername() string
  • func (csrp *CognitoSRP) PasswordVerifierChallenge(challengeParms map[string]string, ts time.Time) (*RespondToAuthChallengeInput, error)
• type RespondToAuthChallengeInput

Types

type CognitoSRP

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

CognitoSRP handles SRP authentication with AWS Cognito

func NewCognitoSRP

func NewCognitoSRP(username, password, poolId, clientId string, clientSecret *string) (*CognitoSRP, error)

NewCognitoSRP creates a CognitoSRP object

func (*CognitoSRP) GetAuthParams

func (csrp *CognitoSRP) GetAuthParams() map[string]string

GetAuthParams returns the AuthParms map of values required for make InitiateAuth requests

func (*CognitoSRP) GetClientId

func (csrp *CognitoSRP) GetClientId() string

GetClientId returns the configured Cognito Cient ID

func (*CognitoSRP) GetSecretHash

func (csrp *CognitoSRP) GetSecretHash(username string) (string, error)

GetSecretHash returns the secret hash string required to make certain Cognito Identity Provider API calls (if client is configured with a secret)

func (*CognitoSRP) GetUserPoolId

func (csrp *CognitoSRP) GetUserPoolId() string

GetUserPoolId returns the configured Cognito User Pool ID

func (*CognitoSRP) GetUserPoolName

func (csrp *CognitoSRP) GetUserPoolName() string

GetUserPoolName returns the configured Cognito User Pool Name

func (*CognitoSRP) GetUsername

func (csrp *CognitoSRP) GetUsername() string

GetUsername returns the configured Cognito user username

func (*CognitoSRP) PasswordVerifierChallenge

func (csrp *CognitoSRP) PasswordVerifierChallenge(challengeParms map[string]string, ts time.Time) (*RespondToAuthChallengeInput, error)

PasswordVerifierChallenge returns a github.com/aws/aws-sdk-go-v2/service/cognitoidentityprovider.RespondToAuthChallengeInput object which can be used to fulfil a PASSWORD_VERIFIER Cognito challenge

type RespondToAuthChallengeInput

type RespondToAuthChallengeInput struct {
	ChallengeName      string
	ChallengeResponses map[string]string
	ClientId           *string
}

RespondToAuthChallengeInput is added in spite of importing the type from aws sdk for cognitoidentityprovider