Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pschichtel/postfix-rest-connector
A simple TCP server that can be used as tcp lookup for the Postfix mail server.
https://github.com/pschichtel/postfix-rest-connector
postfix rest tcp
Last synced: about 1 month ago
JSON representation
A simple TCP server that can be used as tcp lookup for the Postfix mail server.
- Host: GitHub
- URL: https://github.com/pschichtel/postfix-rest-connector
- Owner: pschichtel
- License: gpl-3.0
- Created: 2019-03-11T00:58:41.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-11-16T01:33:03.000Z (about 2 months ago)
- Last Synced: 2024-11-16T02:25:29.191Z (about 2 months ago)
- Topics: postfix, rest, tcp
- Language: Kotlin
- Size: 548 KB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# postfix-rest-connector
A simple TCP server that can be used as remote lookup for the Postfix mail server.
## Running
Either install one of the available binaries onto you system or run the container image `ghcr.io/pschichtel/postfix-rest-connector`.
The program accepts exactly one commandline argument: The path, relative or absolute, to a configuration file
as described by the following section. The container images don't contain such configuration, but the file `sample.json`
provides a somewhat complete example to craft one.
## Configuration
```json
{
"user-agent": "Postfix REST Connector",
"endpoints": []
}
```
* `user-agent`: The user-agent to use for outgoing web requests
* `endpoints`: The list of endpoints to set up
### Endpoint
Example:
```json
{
"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:
```json
{
"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](http://www.postfix.org/tcp_table.5.html) example:
```
virtual_mailbox_domains = tcp:127.0.0.1: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:
```json
{
"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](http://www.postfix.org/socketmap_table.5.html) example:
```
virtual_mailbox_domains = socketmap:inet:127.0.0.1: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:
```json
{
"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](http://www.postfix.org/SMTPD_POLICY_README.html) example:
```
smtpd_relay_restrictions =
permit_mynetworks
check_policy_service inet:127.0.0.1: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](http://www.postfix.org/SMTPD_POLICY_README.html).
##### 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)