pps

README

postfix-policy-server

postfix-policy-server (pps) provides a simple framework to create Postfix SMTP Access Policy Delegation Servers in Go.

Usage

The pps framework allows you to start a new TCP server that listens for incoming policy requests from a Postfix mail server. Once a new connection is established and the dataset from Postfix has been sent, the data will be processed as a PolicySet and handed to a provided Handle() method that is provided by the user, using pps's Handler interface.

Check out the Go reference for further details or have a look at the example echo-server that is provided with this package.

Documentation

Index

• Constants
• type Connection
• type CtxKey
• type Handler
• type PolicySet
• type PostfixResp
• type Server
  • func New(options ...ServerOpt) Server
  • func (s *Server) Run(ctx context.Context, h Handler) error
  • func (s *Server) RunWithListener(l net.Listener, ctx context.Context, h Handler) error
  • func (s *Server) SetAddr(a string)
  • func (s *Server) SetPort(p string)
• type ServerOpt
  • func WithAddr(a string) ServerOpt
  • func WithPort(p string) ServerOpt

Constants

const DefaultAddr = "0.0.0.0"

DefaultAddr is the default address the server is listening on

const DefaultPort = "10005"

DefaultPort is the default port the server is listening on

Types

type Connection

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

Connection represents an incoming policy server connection

type CtxKey

type CtxKey int

CtxKey represents the different key ids for values added to contexts

const (

	// CtxNoLog lets the user control wether the server should log to
	// STDERR or not
	CtxNoLog CtxKey
)

type Handler

type Handler interface {
	Handle(*PolicySet) PostfixResp
}

Handler interface for handling incoming policy requests and returning the corresponding action

type PolicySet

type PolicySet struct {
	// Postfix version 2.1 and later
	Request           string
	ProtocolState     string
	ProtocolName      string
	HELOName          string
	QueueId           string
	Sender            string
	Recipient         string
	RecipientCount    uint64
	ClientAddress     net.IP
	ClientName        string
	ReverseClientName string
	Instance          string

	// Postfix version 2.2 and later
	SASLMethod       string
	SASLUsername     string
	SASLSender       string
	Size             uint64
	CCertSubject     string
	CCertIssuer      string
	CCertFingerprint string

	// Postfix version 2.3 and later
	EncryptionProtocol string
	EncryptionCipher   string
	EncryptionKeysize  uint64
	ETRNDomain         string

	// Postfix version 2.5 and later
	Stress bool

	// Postfix version 2.9 and later
	CCertPubkeyFingerprint string

	// Postfix version 3.0 and later
	ClientPort uint64

	// Postfix version 3.1 and later
	PolicyContext string

	// Postfix version 3.2 and later
	ServerAddress net.IP
	ServerPort    uint64

	// postfix-policy-server specific values
	PPSConnId string
}

PolicySet is a set information provided by the postfix policyd request

type PostfixResp

type PostfixResp string

PostfixResp is a possible response value for the policy request

const (
	RespOk            PostfixResp = "OK"
	RespReject        PostfixResp = "REJECT"
	RespDefer         PostfixResp = "DEFER"
	RespDeferIfReject PostfixResp = "DEFER_IF_REJECT"
	RespDeferIfPermit PostfixResp = "DEFER_IF_PERMIT"
	RespDiscard       PostfixResp = "DISCARD"
	RespDunno         PostfixResp = "DUNNO"
	RespHold          PostfixResp = "HOLD"
	RespInfo          PostfixResp = "INFO"
	RespWarn          PostfixResp = "WARN"
)

Possible responses to the postfix server See: http://www.postfix.org/access.5.html

type Server

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

Server defines a new policy server with corresponding settings

func New

func New(options ...ServerOpt) Server

New returns a new server object

func (*Server) Run

func (s *Server) Run(ctx context.Context, h Handler) error

Run starts a server based on the Server object

func (*Server) RunWithListener

func (s *Server) RunWithListener(l net.Listener, ctx context.Context, h Handler) error

RunWithListener starts a server based on the Server object with a given network listener

func (*Server) SetAddr

func (s *Server) SetAddr(a string)

SetAddr will override the listening address on an already existing policy server

func (*Server) SetPort

func (s *Server) SetPort(p string)

SetPort will override the listening port on an already existing policy server

type ServerOpt

type ServerOpt func(*Server)

ServerOpt is an override function for the New() method

func WithAddr

func WithAddr(a string) ServerOpt

WithAddr overrides the default listening address for the policy server

func WithPort

func WithPort(p string) ServerOpt

WithPort overrides the default listening port for the policy server