Par Alec Berney & Nicolas Crausaz
Ce laboratoire fait partie du cours RES de l'HEIG-VD. Il consiste en l'implémentation d'un logiciel d'envoi de "prank" par email.
Les objectifs de ce laboratoire sont de:
- Devenir familier avec le protocole SMTP, en travaillant avec les messages SMTP sans utiliser de librairies spécifiques pour SMTP.
- Utiliser des outils de test client-serveur, comme un "mock server".
- Créer et envoyer des emails forgés
Le fonctionnement de l'application se résume assez simplement:
Le programme réparti un certain nombre de personnes (adresses mail) dans un certain nombre de groupes (tout ceci est configurable). Chaque groupe contient 1 "pranker" considéré comme l'expéditeur de l'email forgé, les autres membres du groupe seront considérés comme les victimes, c’est-à-dire les destinataires du mail. Un groupe est donc au minimum composé de deux personnes.
Les pranks sont choisis aléatoirement parmi une liste personnalisable.
Nous allons maintenant expliquer les différents aspects / particularités de chaque classe (de gauche à droite)
Cette classe permet d'envoyer les mails au serveur SMTP. Sa particularité principale est qu'elle ne traite pas les codes erreurs reçues par le serveur. Elle lit / consomme chaque réponse du serveur mais ne fait aucune gestion d'erreur. Cependant, elle log toutes les réponses du serveur et ces propres envois, afin d'avoir une trace de ce qui s'est passé. Si une erreur est parvenue pendant l'envoi du mail, elle sera loggée au niveau "SEVERE" et l'email ne s'enverra pas. Cette classe implémente l'interface ISMTPClient qui représente les méthodes qu'un client SMTP doit proposer au minimum dans notre conception.
Cette classe modélise un mail qui pourra être envoyé à l'aide du SMTPClient.
Cette classe permet de récupérer les informations de configuration de l'application. Elle vérifie également que ces dernières soient conformes aux attentes. Elle vérife aussi que les entrées obligatoires contiennent bien une valeur. Nous avons décidé d'en faire un Singleton.
Cette classe utilise simplement les autres classes afin de faire tourner le programme.
Cette classe modélise un groupe qui contient un "pranker" qui correspond à l'expéditeur du futur email. Le groupe contient également une liste de "victimes" qui correspondent aux destinataires du futur email.
Cette classe gère toute la logique de l'application. C'est-à-dire qu'elle créée les groupes avec le bon nombre de personnes et génère également les emails à partir des pranks. La liste des mails / pranks sera ensuite prête à envoyer par le SMTPClient.
Cette classe modélise une personne et plus précisément un email pour cette application. Elle va être utilisée pour constituer les groupes. Le format de l'email doit est validé lors de la création d'un objet Person.
Cette classe est un parser texte utilisé afin de récupérer les addresses mails contenues dans le fichier lié. Les données lues sont sérialisées en object Person.
Cette classe est un parser JSON utilisé afin de récupérer et générer les pranks présents dans le fichier pranks.json. Les données lues sont sérialisées en object Prank.
Cette classe représente un prank un contenant un titre et un contenu. Un prank sera transformé en Mail durant l'exécution afin d'être envoyé par le SMTPClient.
Voici un exemple d'une intération client-serveur du protocole SMTP, dans notre application.
Dans cet exemple, on envoie 1 seul mail à plusieurs destinataires, puis on ferme la connexion. Il serait également possible d'envoyer plusieurs mails à la suite en envoyant une requête RSET après le ".". Le serveur répondrait "250 OK" en cas de succès. Il serait ensuite possible de recréer tout le processus depuis la commande EHLO clientName"
Nous avons réalisé des tests unitaires pour presque toutes les classes créées. Les tests unitaires les plus poussés étant ceux du client SMTP, objectif principal du laboratoire. Tous ces tests pouvant être executés; attention, certains tests envoient des emails (ceux du client SMTP). Il vaut mieux donc utilisé le mock server pour effectuer les tests.
$ mvn clean test
Nous avons un dernier problème qui persiste lors d'envoi multiple d'email. Il arrive que certains mails soient vides. Pour corriger ce problème, nous avons temporisé l'envoi multiple par une attente d'une demi seconde entre chaque mail (voir issue #12)
Il serait également possible d'ajouter une gestion plus forte des erreurs au niveau des réponses du serveur SMTP, par exemple en vérifiant le code renvoyé par le serveur à chaque transmission.
Pour utiliser cette application, commencez par clone ce repository.
Afin d'être prêt à envoyer vous pranks, vous allez d'abord devoir préparer quelques éléments. Premièrement, remplissez le fichier d'adresses mails fichier d'adresses mails (configs/emails.utf8) avec tous les emails auquel vous souhaitez envoyer et recevoir des pranks. Ensuite, remplissez le fichier de pranks (configs/pranks.json) avec vos meilleures blagues, chaque prank doit avoir un titre (qui sera le sujet du mail) et un contenu (corps du mail).
Vous allez probablement devoir éditer la configuration (configs/config.properties) pour répondre à vos besoin:
SMTP_DEFAULT_PORT= <Port de votre serveur SMTP | Requis>
SMTP_DEFAULT_SERVER= <Adresse IP Port de votre serveur | Requis>
NUMBER_OF_GROUPS= <Nombre de groupes / mail qui seront envoyés | Requis>
CLIENT_NAME= <Nom de l'application | Requis>
MAIL_HIDDEN_SENDER= <Adresse mail cachée de l'expéditeur des pranks | Requis | Le format de l'email doit être valide>
MAIL_CC= <Adresse mail qui sera mise en copie de chaque prank | Optionnel>
MAIL_BCC= <Adresse mail qui sera mise en copie cachée de chaque prank | Optionnel>
Notez que les valeurs spécifiés par Requis doivent être spécifiées, sinon l'application vous transmettra son mécontentement.
Si vous souhaitez tester l'application sans envoyer de vrai emails, nous avons mis à disposition un mock server qui fera office de serveur SMTP. Pour travailler avec ce serveur, modifiez les deux premiers champs du fichier de configuration de cette manière:
SMTP_DEFAULT_PORT=2525
SMTP_DEFAULT_SERVER=localhost
Ceci fait, vous allez pouvoir démarrer le container Docker du mock server:
Construire l'image:
$ ./docker/build.sh
Démarrer le container:
$ ./docker/run.sh
Tout est prêt, vous pouvez désormais commencer à envoyer vos pranks en exécutant:
$ java -jar .\target\smtp-pranks-1.0-SNAPSHOT-launcher.jar
Si vous avez utilisé notre serveur Mock, les mails sont visibles sur http://localhost:8282.