issueapi

Documentation

Overview

Package issueapi implements the API handler for taking a code request, assigning an OTP, saving it to the database and returning the result. This is invoked over AJAX from the Web frontend.

Index

• func CanonicalPhoneNumber(phone string, defaultRegion string) (string, error)
• func GenerateAlphanumericCode(length uint) (string, error)
• func GenerateCode(length uint) (string, error)
• func ScrubPhoneNumbers(s string) string
• func ValidateDate(date, minDate, maxDate time.Time, tzOffset int) (*time.Time, error)
• type Controller
  • func New(cfg config.IssueAPIConfig, db *database.Database, limiter limiter.Store, ...) *Controller
  • func (c *Controller) BatchIssueWithAPIAuth(w http.ResponseWriter, r *http.Request) *IssueResult
  • func (c *Controller) BatchIssueWithUIAuth(w http.ResponseWriter, r *http.Request) *IssueResult
  • func (c *Controller) BuildSMS(ctx context.Context, realm *database.Realm, signer crypto.Signer, keyID string, ...) (string, error)
  • func (c *Controller) BuildVerificationCode(ctx context.Context, internalRequest *IssueRequestInternal, ...) (*database.VerificationCode, *IssueResult)
  • func (c *Controller) CommitCode(ctx context.Context, vCode *database.VerificationCode, realm *database.Realm, ...) error
  • func (c *Controller) HandleBatchIssueAPI() http.Handler
  • func (c *Controller) HandleBatchIssueUI() http.Handler
  • func (c *Controller) HandleIssueAPI() http.Handler
  • func (c *Controller) HandleIssueUI() http.Handler
  • func (c *Controller) HandleUserReport() http.Handler
  • func (c *Controller) IssueCode(ctx context.Context, vCode *database.VerificationCode, realm *database.Realm) *IssueResult
  • func (c *Controller) IssueMany(ctx context.Context, requests []*IssueRequestInternal) []*IssueResult
  • func (c *Controller) IssueOne(ctx context.Context, request *IssueRequestInternal) *IssueResult
  • func (c *Controller) IssueWithAPIAuth(w http.ResponseWriter, r *http.Request) *IssueResult
  • func (c *Controller) IssueWithUIAuth(w http.ResponseWriter, r *http.Request) *IssueResult
  • func (c *Controller) SendSMS(ctx context.Context, realm *database.Realm, smsProvider sms.Provider, ...)
• type IssueRequestInternal
• type IssueResult
  • func (result *IssueResult) IssueCodeResponse() *api.IssueCodeResponse

Functions

func CanonicalPhoneNumber

func CanonicalPhoneNumber(phone string, defaultRegion string) (string, error)

CanonicalPhoneNumber returns the E.164 formatted phone number.

func GenerateAlphanumericCode

func GenerateAlphanumericCode(length uint) (string, error)

GenerateAlphanumericCode will generate an alpha numberic code. It uses the length to estimate how many bytes of randomness will base64 encode to that length string. For example 16 character string requires 12 bytes.

func GenerateCode

func GenerateCode(length uint) (string, error)

GenerateCode creates a new OTP code.

func ScrubPhoneNumbers

func ScrubPhoneNumbers(s string) string

ScrubPhoneNumbers checks for phone numbers in known Twilio error strings that contains user phone numbers.

func ValidateDate

func ValidateDate(date, minDate, maxDate time.Time, tzOffset int) (*time.Time, error)

ValidateDate validates the date given -- returning the time or an error.

Types

type Controller

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

func New

func New(cfg config.IssueAPIConfig, db *database.Database, limiter limiter.Store, smsSigner keys.KeyManager, h *render.Renderer) *Controller

New creates a new IssueAPI controller.

func (*Controller) BatchIssueWithAPIAuth

func (c *Controller) BatchIssueWithAPIAuth(w http.ResponseWriter, r *http.Request) *IssueResult

func (*Controller) BatchIssueWithUIAuth

func (c *Controller) BatchIssueWithUIAuth(w http.ResponseWriter, r *http.Request) *IssueResult

func (*Controller) BuildSMS

func (c *Controller) BuildSMS(ctx context.Context, realm *database.Realm, signer crypto.Signer, keyID string, request *api.IssueCodeRequest, vercode *database.VerificationCode) (string, error)

BuildSMS builds and signs (if configured) the SMS message. It returns the complete and compiled message.

func (*Controller) BuildVerificationCode

func (c *Controller) BuildVerificationCode(ctx context.Context, internalRequest *IssueRequestInternal, realm *database.Realm) (*database.VerificationCode, *IssueResult)

BuildVerificationCode populates and validates a code from an issue request.

func (*Controller) CommitCode

func (c *Controller) CommitCode(ctx context.Context, vCode *database.VerificationCode, realm *database.Realm, retryCount uint) error

CommitCode will generate a verification code and save it to the database, based on the paremters provided. It returns the short code, long code, a UUID for accessing the code, and any errors.

func (*Controller) HandleBatchIssueAPI

func (c *Controller) HandleBatchIssueAPI() http.Handler

HandleBatchIssueAPI responds to the /batch-issue API for issuing verification codes

func (*Controller) HandleBatchIssueUI

func (c *Controller) HandleBatchIssueUI() http.Handler

HandleBatchIssueUI responds to the /batch-issue API for issuing verification codes

func (*Controller) HandleIssueAPI

func (c *Controller) HandleIssueAPI() http.Handler

HandleIssueAPI responds to the /issue API for issuing verification codes

func (*Controller) HandleIssueUI

func (c *Controller) HandleIssueUI() http.Handler

HandleIssueUI responds to the /issue API for issuing verification codes

func (*Controller) HandleUserReport

func (c *Controller) HandleUserReport() http.Handler

func (*Controller) IssueCode

func (c *Controller) IssueCode(ctx context.Context, vCode *database.VerificationCode, realm *database.Realm) *IssueResult

func (*Controller) IssueMany

func (c *Controller) IssueMany(ctx context.Context, requests []*IssueRequestInternal) []*IssueResult

IssueMany handles validating a list of IssueCodeRequest, issuing new codes, and sending SMS messages.

func (*Controller) IssueOne

func (c *Controller) IssueOne(ctx context.Context, request *IssueRequestInternal) *IssueResult

IssueOne handles validating a single IssueCodeRequest, issuing a new code, and sending an SMS message.

func (*Controller) IssueWithAPIAuth

func (c *Controller) IssueWithAPIAuth(w http.ResponseWriter, r *http.Request) *IssueResult

func (*Controller) IssueWithUIAuth

func (c *Controller) IssueWithUIAuth(w http.ResponseWriter, r *http.Request) *IssueResult

func (*Controller) SendSMS

func (c *Controller) SendSMS(ctx context.Context, realm *database.Realm, smsProvider sms.Provider, signer crypto.Signer, keyID string, request *api.IssueCodeRequest, result *IssueResult)

SendSMS sends the sms mesage with the given provider and wraps any seen errors into the IssueResult

type IssueRequestInternal

type IssueRequestInternal struct {
	IssueRequest  *api.IssueCodeRequest
	UserRequested bool
	// These files are for user initiated report
	Nonce []byte
}

IssueRequestInternal is used to join the base issue request with the optional nonce. If the nonce is provided and the the report type is self_report (user initiated code), then extra safeguards are applied.

type IssueResult

type IssueResult struct {
	VerCode      *database.VerificationCode
	GeneratedSMS string
	ErrorReturn  *api.ErrorReturn
	HTTPCode     int
	// contains filtered or unexported fields
}

IssueResult is the response returned from IssueLogic.IssueOne or IssueMany.

func (*IssueResult) IssueCodeResponse

func (result *IssueResult) IssueCodeResponse() *api.IssueCodeResponse

IssueCodeResponse converts an IssueResult to the external api response.