Prise en main

Spam Scanner nécessite Node.js 18 ou une version ultérieure, ou rien du tout avec le binaire autonome.

Installation#

Comme outil en ligne de commande :

npm install --global spamscanner
spamscanner version

Comme bibliothèque dans un projet Node.js :

npm install spamscanner

Comme binaire autonome pour Linux ou macOS, avec Node.js et le modèle intégrés :

curl -fsSL https://github.com/spamscanner/spamscanner/releases/latest/download/install.sh | bash

Des binaires pour Linux (x64 et arm64), macOS (Intel et Apple silicon) et Windows sont joints à chaque version publiée.

Analyser un message#

Enregistrez un message dans un fichier (la plupart des logiciels de messagerie appellent cela « Enregistrer sous » ou « Afficher l’original ») et analysez-le :

spamscanner scan message.eml

SPAM  score 16.3 (spam at 5.0, reject at 15.0)  action: reject  language: en
     +6.3  BAYES_999                    Classifier spam probability 99.9%
     +5.0  PHISHING_LOOKALIKE_DOMAIN    "paypa1-secure.top" imitates paypal by swapping characters
     +3.0  DECEPTIVE_LINK               A link shows "https://www.paypal.com/signin" but goes to paypa1-secure.top
     +2.0  FROM_NAME_BRAND              Display name says "paypal" but the message is from paypa1-secure.top

Le code de sortie vaut 0 pour du hamCourrier légitime : le contraire du spam. (courrier légitime), 1 pour du spam et 2 en cas d’erreur : les scripts peuvent donc l’utiliser directement. --json affiche le résultat complet et --headers affiche le message avec les en-têtes X-Spam-* ajoutés.

Les messages peuvent aussi provenir de l’entrée standard :

cat message.eml | spamscanner scan -

L’utiliser depuis Node.js#

import SpamScanner from 'spamscanner';
import {readFile} from 'node:fs/promises';

const scanner = new SpamScanner();
const result = await scanner.scan(await readFile('message.eml'));

console.log(result.isSpam, result.score, result.action);
for (const test of result.tests) {
  console.log(test.name, test.score, test.description);
}

CommonJS fonctionne aussi :

const SpamScanner = require('spamscanner');

scan() prend le message brut sous forme de Buffer, de chaîne, de Uint8Array ou de flux lisible. Une chaîne est toujours le texte d’un message : Spam Scanner ne lit jamais un fichier parce qu’une chaîne ressemble à un chemin. Utilisez scanner.scanFile(path) pour les fichiers.

Lui décrire la session SMTP#

L’adresse IP du client, son nom d’hôte vérifié, le nom HELO et l’enveloppe rendent le résultat plus précis : l’authentification a besoin de l’adresse IP, et la règle d’usurpation de son propre domaine a besoin des destinataires.

const result = await scanner.scan(raw, {
  session: {
    remoteAddress: '203.0.113.5',
    resolvedClientHostname: 'mail.example.com',
    helo: 'mail.example.com',
    envelope: {
      mailFrom: {address: 'alice@example.com'},
      rcptTo: [{address: 'bob@example.org'}],
    },
  },
});

La même chose en ligne de commande :

spamscanner scan message.eml --ip 203.0.113.5 --helo mail.example.com \
  --from alice@example.com --to bob@example.org --auth

Activer d’autres vérifications#

Aucune n’est activée par défaut, car chacune nécessite un service ou une décision :

Les résolveurs filtrants de Cloudflare (1.1.1.2 pour les logiciels malveillants, 1.1.1.3 pour le contenu pour adultes) sont interrogés par défaut sur les hôtes des liens. Désactivez-les avec phishing: {cloudflare: false} ou --no-cloudflare. Ce qui quitte la machine

Spamhaus et certaines autres listes de blocage ne répondent pas aux requêtes envoyées par des résolveurs publics comme 8.8.8.8 ou 1.1.1.1. Utilisez-les avec un résolveur cache local, et vérifiez leurs conditions d’utilisation pour votre volume.

Étapes suivantes#

• Placez-le devant un serveur de messagerie : Postfix et Sendmail, autres serveurs.
• Apprenez-lui votre propre courrier : entraînement.
• Ajoutez un modèle de langage pour les cas limites : modèles de langage.