adapter

Documentation

Overview

Package to request and verify jwt token

Index

• Constants
• type AdapterMock
  • func (mock *AdapterMock) GetToken(userId string, password string) (*TokenResponseDTO, error)
  • func (mock *AdapterMock) RefreshToken(userId string, token string, refreshToken string) (*TokenResponseDTO, error)
• type AuthAdapter
  • func NewAuthiAdapter(correlationId string) AuthAdapter
• type AuthenticateDTO
• type AuthiAdapter
  • func (authAdapter *AuthiAdapter) GetToken(userId string, password string) (*TokenResponseDTO, error)
  • func (authAdapter *AuthiAdapter) RefreshToken(userId string, token string, refreshToken string) (*TokenResponseDTO, error)
• type Claims
• type GetTokenRecord
• type RefreshTokenRecord
• type TokenResponse
• type TokenResponseDTO

Constants

const (
	// Name of header where jwt token is stored
	AuthorizationHeaderName = "Authorization"
	// Name of header where refresh token is stored
	RefreshTokenHeaderName = "refresh_token"
	// Key to set claim in context
	ClaimName = "claim"
	// Environment variable to point to url for the auth service
	EnvAuthUrl = "AUTHI_URL"

	// Url of root path for authi
	AuthiRootPath = "/user"
	//Path to login api
	AuthiLoginPath = "/login"
	//Path to refresh api
	AuthiRefreshPath = "/refresh"

	//Content type for AuthenticateDTO
	ContentTyp = "application/json; charset=utf-8"
)

Types

type AdapterMock

type AdapterMock struct {
	RefreshTokenRecordArray   []*RefreshTokenRecord
	RefreshTokenResponseArray []*TokenResponse

	GetTokenRecordArray   []*GetTokenRecord
	GetTokenResponseArray []*TokenResponse
}

func (*AdapterMock) GetToken

func (mock *AdapterMock) GetToken(userId string, password string) (*TokenResponseDTO, error)

func (*AdapterMock) RefreshToken

func (mock *AdapterMock) RefreshToken(userId string, token string, refreshToken string) (*TokenResponseDTO, error)

type AuthAdapter

type AuthAdapter interface {
	RefreshToken(userId string, token string, refreshToken string) (*TokenResponseDTO, error)
	GetToken(userId string, password string) (*TokenResponseDTO, error)
}

Interface for authentication

func NewAuthiAdapter

func NewAuthiAdapter(correlationId string) AuthAdapter

Initialize auth adapter with public key and url to authi service. Therefor the environment variable AUTH_URL have to be set

type AuthenticateDTO

type AuthenticateDTO struct {
	Password string `json:"password" validate:"required"`
}

Request object for authentication

type AuthiAdapter

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

Implementation of auth adapter to login and refresh token of user

func (*AuthiAdapter) GetToken

func (authAdapter *AuthiAdapter) GetToken(userId string, password string) (*TokenResponseDTO, error)

Login to get token

func (*AuthiAdapter) RefreshToken

func (authAdapter *AuthiAdapter) RefreshToken(userId string, token string, refreshToken string) (*TokenResponseDTO, error)

Get new token with refresh token from authi service

type Claims

type Claims struct {
	UserId uuid.UUID `json:"user_id"`
	jwt.StandardClaims
}

Claim with data from the token

type GetTokenRecord

type GetTokenRecord struct {
	UserId   string
	Password string
}

type RefreshTokenRecord

type RefreshTokenRecord struct {
	UserId       string
	Token        string
	RefreshToken string
}

type TokenResponse

type TokenResponse struct {
	TokenResponseDTO *TokenResponseDTO
	Err              error
}

type TokenResponseDTO

type TokenResponseDTO struct {
	AccessToken      string `json:"access_token"`
	ExpiresIn        int    `json:"expires_in"`
	RefreshToken     string `json:"refresh_token"`
	RefreshExpiresIn int    `json:"refresh_expires_in"`
}

Response with token data