imnetcat / cout Goto Github PK

View Code? Open in Web Editor NEW

3.0 3.0 0.0 4.23 MB

Cout lib is a header-only library for SMTP client + example of SMTP client used this lib included

License: MIT License

C++ 99.60% C 0.40%

c-plus-plus cpp cpp17 desktop-windows email esmtp framework mailer openssl single-file smtp smtp-client smtp-mailer

cout's Introduction

Hi there, I'm Danil - aka imnetcat 👋

I'm a student, developer, and open source contributor !

Student of National Technical University of Ukraine 'Kyiv Polytechnic Institute'
Member of Metarhia
Interesting in:
- genetic algorithm, code some experiments with it
- low level and network programming - write console chat app & realization of SMTP protocol
- cybersecurity, vulnerability exploitation
- cryptocurrencies and blockchain

cout's People

Contributors

Stargazers

Watchers

cout's Issues

Добавить ESMPTSA

Добавить полноценный ESMPTSA как единый интерфейс для всех SMTP классов

Добавить свой фреймворк для юнит-тестирования

Return code

удалить RETCODE алиас, заменить его где-надо, использовать throw

compiler - linker flags?

Здравствуйте.

Видимо, я первый, кто начал активно пользоваться Вашим проектом, поэтому у меня есть несколько вопросов.

я не очень опытный в C++, и, возможно, я задаю глупый вопорос.

Нельзя ли куда нибудь в документацию добавить пример команды сборки проекта для какого нибудь компилятора? С указанием нужных библиотек.

Вопрос вызван вот чем. При попытке собрать простой пример с отправкой письма компиляция проходит без проблем, а при линковке возникают многочисленные ошибки вида " undefined reference to 'Protocol::SMTP::MAIL::AddRecipient()'" и т.п. - все на Protocol::SMTP::MAIL

Собираю под Windows 10 x64, пользуюсь компилятором gcc из пакета msys2, команда сборки выглядит так:

g++.exe -std=c++17 -lssl-1_1-x64 -lcrypto-1_1-x64 -LC:/Programs/msys64/mingw64/bin/ -g test_mail.cpp -o test_mail.exe

Посмотрите, возможно, я просто что то не так делаю прии сборке.

Собирал код из ветки master.

Прикреплаю файлы с примером программы (там только пароль заменен на звездочки) и файл с ошибками при сборке.
Файлу с примером программы пришлось приписать расширение .txt - иначе не прикрепляется.

test_mail.cpp.txt
errors.txt

При попытке собрать main.cpp ошибки такие же.

Буду благодарен за любую помощь.

С понедельника пытаюсь научиться отправлять письма из своей программы :-)

Спасибо заранее.

Связаться со мной можно по mail [email protected]

исправить все warning'и

ESMTPSA

Невозможно создать расширенный SMPT с аутентификацией и шифрованием из-за конфликта имён в классах ESMTPA и ESMTPS
Необходимо использовать виртуальные методы

Строковые буферы

Перенести буферы SendBuf & RecvBuf из сокетов в SMTP
Сделать обёртку над буферами

Буферизация

Буферизацию вынести в отдельный класс как обёртку над сокетами

Make

Нужно было бы зависимости (OpenSSL) с помощью CMake оформить

Виртуальный интерфейс

Нужно создать единый интерфейс с помощью чисто виртуального базового класса Protocol

Сделать класс Core

Упаковать конфиги, обработку ошибок, логирование и утилиты в класс Core, сделать доступ ко всем перечисленым классам через Core

Константность методов

В большинстве классов не указана константность их методов это может привести к ошибкам в будующем. Стоит указать константность

using namespace std

Нужно вынести все
using namespace std;
из заголовочных файлов в cpp файлы, для предотвращения конфликтов имён

Монолитность обработки ошибок

Необходимо создать концепцию обработки ошибок при которой ошибки можно было бы разбить на отдельные структуры и использовать абстрактные классы для обработки ошибок, что бы можно было бы переопределять обработчик и легко добавлять и изменять ошибки

Улучшить документацию функций интерфейса

Interface

Собрать Mail & Client & Server в единый интерфейс

noexcept

Добавить модификаторы noexcept там где они нужны

Идентификация сервера

Вынести поддерживаемые серверы как пользовательский конфиг, выделить структуру сервера

SMTP

Нужно исправить SMTP в соответствии с спецификацией RFC 5321, RFC 7504

Следование стандарту языка с++17

Необходимо заменить все устаревшие функции, пришедшие из С, на аналогичные им функции из библиотек С++
В частности это касается функций sprintf/sprintf_s, fopen_s, strcat и т.д.
Вместо С-ориентированой работы с файлами через fopen/fclose стоит использовать потоки, вместо выделения памяти вручную стоит использовать конструкторы&деструкторы, вместо "char *" нужно использовать "string", а вместо копирования, и дописывание в конец строки с помощью С-шных функций необходимо использовать потоки stringstream и строки

обёртка namespace

Что бы избежать конфликта имён нужно всё обернуть в свой namespace emeil-client

Замена конкатенации строк на потоки

Для повышения производительности заменить всю конкатенацию строк на строковые потоки

Убрать из сокетов авторизацию

Сокетам не нужно знать о авторизации, нужно переместить эти свойства в соответсвующий класс

Добавить расширенные юнит-тесты

Декомпозиция всего решения

Что бы исправить многие проблемы и добавить новый функционал сперва необходимо декомпозировать всё решение целиков, так как оно написано одним монолитным кодом

Декомпозировать SMTP

Нужно выделить аутентификацию и шифрование из класса SMTP в отдельные классы

Конфликт имён в ESMTP

Нужно переписать класс Socket с использованием виртуальных методов

Нужно создать простую демку для этого фреймворка

Добавить юнит-тесты

Нужно добавить тесты, с помощью моего небольшого фреймворка для юнит-тестирования
Но что бы это сделать сначала нужно декомпозировать решение #7

Отправка байтов вместо строчных значений

Сокеты должны оперировать байтовыми потоками вместо строчных значений. Нужно переписать методы протокола Send & Receive так что бы работать с байтами

Создать уровень абстракции вокруг методов шифрования

Обработка ошибок return VS throw

Ошибки обрабатываются с помощью return'ов, что не желательно для с++17, не является эффективным методом обработки ошибок, мешает работе программы в случае не критических ошибок, делает сложным создание и обработку предупреждений (не критических ошибок)
Необходимо использовать throw и расставить try&catch блоки в необходимых местах

Логирование

Вывод логов и обработку их в целом стоит распределить по уровням, в конфиг вынести некий макрос в котором определять текущий уровень логирования и в соответствии с макросом обрабатывать логи скрывая те что ниже уровня и показывая те что выше
Определить три уровня логирования
Minimal-level - минимальный уровень логирования на случай если Debug-level слишком много логов выводит
Debug-level - предназначен для отладки
Full-level - наиболее подробный рассказ о том что происходит в программе на тот случай если не хватает Debug-level

Поддержка Linux

Для поддержки Linux-based систем нужно выделить класс сокетов и с помощью условных директив препроцессора добавить пережать под UNIX сокеты при компиляции под линукс

Переход на gcc

Нужно перенести код на gcc компилятор

Декомпозиция шифрования и авторизационных абстракций

Нужно вынести в отдельные классы шифрование и авторизацию, а так же создать правильные конструкторы и деструкторы для этих классов и после так же декомпозировать методы этих классов