subjectpass

package

v0.0.11 Latest Latest Go to latest Published: Apr 30, 2024 License: MIT Imports: 14 Imported by: 2

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

github.com/mjl-/mox

Links

Open Source Insights

Documentation ¶

Overview ¶

Package subjectpass implements a mechanism for reject an incoming message with a challenge to include a token in a next delivery attempt.

An SMTP server can reject a message with instructions to send another message, this time including a special token. The sender will receive a DSN, which will include the error message with instructions. By sending the message again with the token, as instructed, the SMTP server can recognize the token, verify it, and accept the message.

Index ¶

Variables
func Generate(elog *slog.Logger, mailFrom smtp.Address, key []byte, tm time.Time) string
func Verify(elog *slog.Logger, r io.ReaderAt, key []byte, period time.Duration) (rerr error)

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	MetricGenerate stub.Counter    = stub.CounterIgnore{}
	MetricVerify   stub.CounterVec = stub.CounterVecIgnore{}
)

View Source

var (
	ErrMessage = errors.New("subjectpass: malformed message")
	ErrAbsent  = errors.New("subjectpass: no token found")
	ErrFrom    = errors.New("subjectpass: bad From")
	ErrInvalid = errors.New("subjectpass: malformed token")
	ErrVerify  = errors.New("subjectpass: verification failed")
	ErrExpired = errors.New("subjectpass: token expired")
)

View Source

var Explanation = "" /* 134-byte string literal not displayed */

Functions ¶

func Generate ¶

func Generate(elog *slog.Logger, mailFrom smtp.Address, key []byte, tm time.Time) string

Generate generates a token that is valid for "mailFrom", starting from "tm" and signed with "key".

The token is of the form: (pass:<signeddata>). Instructions to the sender should be to include this token in the Subject header of a new message.

func Verify ¶

func Verify(elog *slog.Logger, r io.ReaderAt, key []byte, period time.Duration) (rerr error)

Verify parses "message" and checks if it includes a subjectpass token in its Subject header that is still valid (within "period") and signed with "key".

Types ¶

This section is empty.

Source Files ¶

View all Source files

subjectpass.go

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