verifyemail

Documentation

Index

• Constants
• type PIN
  • func GeneratePIN() PIN
  • func (pin PIN) Format() string
  • func (pin PIN) String() string
• type PINStore
• type SMTPInfo
• type SMTPVerifier
  • func NewSMTPVerifier(info SMTPInfo, store PINStore) (*SMTPVerifier, error)
  • func (v *SMTPVerifier) SendConfirmationEmail(ctx context.Context, member acmregister.Member) error
• type ShibbolethVerifier
  • func (v ShibbolethVerifier) VerifyEmail(ctx context.Context, email acmregister.Email) error

Constants

const PINDigits = 4

PINDigits is the number of digits in the PIN code.

Types

type PIN

type PIN int

PIN describes a PIN code.

const InvalidPIN PIN = 0000

InvalidPIN is an invalid PIN to be used as a placeholder.

func GeneratePIN

func GeneratePIN() PIN

GeneratePIN generates a random PIN code for use.

func (PIN) Format

func (pin PIN) Format() string

Format always formats the PIN as a 4-digit number without checking.

func (PIN) String

func (pin PIN) String() string

String formats a PIN code from 0001 to 9999. Anything else is invalid.

type PINStore

type PINStore interface {
	io.Closer
	acmregister.ContainsContext

	// GeneratePIN generates a new PIN that's assigned to the given email.
	//
	// TODO: invalidate the old PIN if there's already an existing one.
	GeneratePIN(discord.GuildID, discord.UserID) (PIN, error)
	// ValidatePIN validates the email associated with the given PIN. PINStores
	// should use its underlying SubmissionStore for this.
	ValidatePIN(discord.GuildID, discord.UserID, PIN) (*acmregister.MemberMetadata, error)
}

PINStore describes an interface that stores the state for verifying PINs over email.

type SMTPInfo

type SMTPInfo struct {
	Host         string
	Email        string
	Password     string
	TemplatePath string
}

type SMTPVerifier

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

func NewSMTPVerifier

func NewSMTPVerifier(info SMTPInfo, store PINStore) (*SMTPVerifier, error)

func (*SMTPVerifier) SendConfirmationEmail

func (v *SMTPVerifier) SendConfirmationEmail(ctx context.Context, member acmregister.Member) error

SendConfirmationEmail sends a confirmation email to the recipient with the email address.

type ShibbolethVerifier

type ShibbolethVerifier struct {
	// URL is a Shibboleth URL that redirects to the SSO portal.
	URL string
}

ShibbolethVerifier implements VerifyEmail.

func (ShibbolethVerifier) VerifyEmail

func (v ShibbolethVerifier) VerifyEmail(ctx context.Context, email acmregister.Email) error

VerifyEmail implements acmregister.EmailVerifier.