HTTP API, TCP sunucusu ve spamd

HTTP API#

Shell

spamscanner http --port 7832 --token "$SPAMSCANNER_TOKEN"

--host aksini belirtmedikçe 127.0.0.1 adresini dinler. Bir belirteç ayarlandığında /health dışındaki her istek Authorization: Bearer <token> gerektirir. Makinenin dışına açmadan önce TLS'li bir ters vekil sunucunun arkasına koyun.

Yöntem ve yol	Gövde	Yanıt
`GET /health`		`{"ok": true, "version": "7.0.0"}`
`POST /scan`	Ham ileti	JSON olarak tarama sonucu
`POST /check`	Ham ileti	`X-Spam-*` üst bilgileri eklenmiş ileti, `message/rfc822` olarak
`POST /learn/spam`	Ham ileti	`{"ok": true, "learned": "spam"}`; belirteç gerektirir
`POST /learn/ham`	Ham ileti	`{"ok": true, "learned": "ham"}`; belirteç gerektirir

Sorgu parametreleri SMTP oturumunu tanımlar:

Parametre	Anlamı
`ip`	İstemcinin IP adresi
`hostname`	İstemcinin doğrulanmış ters DNS adı
`helo`	İstemcinin HELO veya EHLO adı
`from`	Zarf göndericisi
`to`	Bir alıcı; tekrarlayın veya birkaç alıcıyı virgülle ayırın
`verbose=1`	`/scan`: sözcük listesini ve konuyu da döndürür
`subjectTag`	`/check`: spamın konusunun başına ekler, örneğin `%5BSPAM%5D`

/check ayrıca X-Spam-Flag, X-Spam-Score ve X-Spam-Action değerlerini yanıt üst bilgileri olarak döndürür; böylece bir istemci iletiyi ayrıştırmadan karar verebilir.

25 MB'tan büyük iletiler 413 alır. Başarısız olan bir tarama {"error": "..."} ile birlikte 500 alır.

Shell

curl -s -X POST -H "Authorization: Bearer $SPAMSCANNER_TOKEN" \
  --data-binary @message.eml "http://127.0.0.1:7832/scan?ip=203.0.113.5&to=bob@example.org" | jq '.isSpam, .score, .tests'

--out model.json ile, /learn aracılığıyla öğretilenler her istekten sonra o dosyaya kaydedilir. Bu seçenek olmadan öğrenilenler sunucu yeniden başlatılana kadar geçerlidir.

Node.js'ten:

JavaScript

const response = await fetch('http://127.0.0.1:7832/scan?ip=203.0.113.5', {
  method: 'POST',
  headers: {authorization: `Bearer ${process.env.SPAMSCANNER_TOKEN}`},
  body: rawMessage,
});
const {isSpam, score, action} = await response.json();

Python'dan:

Python

import os, urllib.request

request = urllib.request.Request(
    'http://127.0.0.1:7832/scan',
    data=open('message.eml', 'rb').read(),
    headers={'Authorization': f"Bearer {os.environ['SPAMSCANNER_TOKEN']}"},
    method='POST',
)
print(urllib.request.urlopen(request).read().decode())

TCP sunucusu#

Shell

spamscanner server --port 7830

Ham iletiyi gönderin, bağlantının gönderme tarafını kapatın ve tek satırlık JSON'u okuyun:

Shell

nc -N 127.0.0.1 7830 < message.eml

--verbose ile yanıt bunun yerine bir metin satırıdır: SPAM 16.3/5.0 BAYES_999,PHISHING_LOOKALIKE_DOMAIN,DECEPTIVE_LINK,FROM_NAME_BRAND veya HAM -2.5/5.0 BAYES_00.

spamd#

Shell

spamscanner spamd --port 783

spamc, Exim, Haraka ve diğer SpamAssassin istemcileri için SpamAssassin uyumlu bir sunucu. Exim ve Haraka'yı kurmak

Komut	Yanıt
`CHECK`	`Spam: True ; 16.3 / 5.0`
`SYMBOLS`	Karar ve tetiklenen testlerin adları
`REPORT`	Karar ve testler, puanlar ve nedenlerden oluşan bir tablo
`REPORT_IFSPAM`	`REPORT` gibi, ham için boş bir raporla
`PROCESS`	Karar ve `X-Spam-*` üst bilgileri eklenmiş ileti
`HEADERS`	Karar ve iletinin `X-Spam-*` üst bilgileri eklenmiş üst bilgi bloğu
`PING`	`PONG`
`SKIP`	Hiçbir şey
`TELL`	`--allow-tell` ile spam veya ham öğrenir; `--out` dosyasına kaydeder

Sıkıştırılmış istekler (Compress: zlib) reddedilir.