JarCasting
JarCasting JarCasting

Postfix REST Connector

A simple TCP server that can be used as tcp lookup for the Postfix mail server.

License

License
GroupId

GroupId

tel.schich
ArtifactId

ArtifactId

postfix-rest-connector
Last Version

Last Version

1.1.0
Release Date

Release Date
Type

Type

jar
Description

Description

Postfix REST Connector
A simple TCP server that can be used as tcp lookup for the Postfix mail server.
Project URL

Project URL

https://github.com/pschichtel/postfix-rest-connector
Source Code Management

Source Code Management

https://github.com/pschichtel/postfix-rest-connector

Download postfix-rest-connector

Filename Size
postfix-rest-connector-1.1.0.pom
postfix-rest-connector-1.1.0.jar 34 KB
postfix-rest-connector-1.1.0-sources.jar 22 KB
postfix-rest-connector-1.1.0-javadoc.jar 74 KB
Browse

How to add to project

<!-- https://jarcasting.com/artifacts/tel.schich/postfix-rest-connector/ -->
<dependency>
    <groupId>tel.schich</groupId>
    <artifactId>postfix-rest-connector</artifactId>
    <version>1.1.0</version>
</dependency>
// https://jarcasting.com/artifacts/tel.schich/postfix-rest-connector/
implementation 'tel.schich:postfix-rest-connector:1.1.0'
// https://jarcasting.com/artifacts/tel.schich/postfix-rest-connector/
implementation ("tel.schich:postfix-rest-connector:1.1.0")
'tel.schich:postfix-rest-connector:jar:1.1.0'
<dependency org="tel.schich" name="postfix-rest-connector" rev="1.1.0">
  <artifact name="postfix-rest-connector" type="jar" />
</dependency>
@Grapes(
@Grab(group='tel.schich', module='postfix-rest-connector', version='1.1.0')
)
libraryDependencies += "tel.schich" % "postfix-rest-connector" % "1.1.0"
[tel.schich/postfix-rest-connector "1.1.0"]

Dependencies

compile (4)

Group / Artifact Type Version
com.fasterxml.jackson.core : jackson-databind jar 2.9.9
org.asynchttpclient : async-http-client jar 2.9.0
org.slf4j : slf4j-api jar 1.8.0-beta4
org.slf4j : slf4j-simple Optional jar 1.8.0-beta4

test (4)

Group / Artifact Type Version
org.junit.jupiter : junit-jupiter-api jar 5.4.2
org.junit.jupiter : junit-jupiter-engine jar 5.4.2
org.junit.platform : junit-platform-launcher jar 1.4.2
org.junit.platform : junit-platform-runner jar 1.4.2

Project Modules

There are no modules declared in this project.

postfix-rest-connector

A simple TCP server that can be used as remote lookup for the Postfix mail server.

Configuration

{
  "user-agent": "Postfix REST Connector",
  "endpoints": []
}
  • user-agent: The user-agent to use for outgoing web requests
  • endpoints: The list of endpoints to setup

Endpoint

Example:

{
  "name": "domain-lookup",
  "mode": "tcp-lookup",
  "target": "https://somehost/tcp-lookup-route",
  "bind-address": "0.0.0.0",
  "bind-port": 9000,
  "auth-token": "test123",
  "request-timeout": 2000
}
  • name: A name for logs
  • mode: The kind of endpoint
  • target: The URL to be called
  • bind-address: The local IP address to bind to
  • bind-port: The local TCP port to bind
  • auth-token: An authentication token that the remote application can verify
  • request-timeout: The request timeout in milliseconds

Modes

TCP

Endpoint example:

{
  "name": "domain-lookup",
  "mode": "tcp-lookup",
  "target": "https://somehost/tcp-lookup-route",
  "bind-address": "0.0.0.0",
  "bind-port": 9001,
  "auth-token": "test123",
  "request-timeout": 2000
}

Postfix example:

virtual_mailbox_domains = tcp:localhost:9001
Minimal Request
GET {target-path}?key={lookup-key} HTTP/1.0
Host: {target-host}
User-Agent: {user-agent}
X-Auth-Token: {auth-token}
Minimal Expected Successful Response
HTTP/1.0 200 OK
Content-Length: {length}

["json", "string", "array"]
Error Response Statuses
  • 404: For new results
  • Anything >= 400 and < 500: Signal misconfiguration (permanent error)
  • Anything >= 500 and < 600: Signal technical error (temporary error)

Socketmap

Endpoint example:

{
  "name": "domain-lookup",
  "mode": "socketmap-lookup",
  "target": "https://somehost/socketmap-lookup-route",
  "bind-address": "0.0.0.0",
  "bind-port": 9002,
  "auth-token": "test123",
  "request-timeout": 2000
}

Postfix example:

virtual_mailbox_domains = socketmap:inet:localhost:9002:domain
Minimal Request
GET {target-path}?name={map name}&key={lookup-key} HTTP/1.0
Host: {target-host}
User-Agent: {user-agent}
X-Auth-Token: {auth-token}
Minimal Expected Successful Response
HTTP/1.0 200 OK
Content-Length: {length}

["json", "string", "array"]
Error Response Statuses
  • 404: For new results
  • Anything >= 400 and < 500: Signal misconfiguration (permanent error)
  • Anything >= 500 and < 600: Signal technical error (temporary error)

Policy Check

Endpoint example:

{
  "name": "domain-lookup",
  "mode": "policy",
  "target": "https://somehost/policy-check-route",
  "bind-address": "0.0.0.0",
  "bind-port": 9003,
  "auth-token": "test123",
  "request-timeout": 2000
}

Postfix example:

smtpd_relay_restrictions =
    permit_mynetworks
    check_policy_service inet:localhost:9003
    reject
Minimal Request
GET {target-path} HTTP/1.0
Host: {target-host}
User-Agent: {user-agent}
X-Auth-Token: {auth-token}

name=value&name2=value2

Actual values are documented at the Postfix policy documentation.

Minimal Expected Successful Response
HTTP/1.0 200 OK
Content-Length: {length}

{policy action}
Error Response Statuses
  • Anything >= 400 and < 500: Signal misconfiguration (permanent error)
  • Anything >= 500 and < 600: Signal technical error (temporary error)

Versions

Version
1.1.0
1.0.0