You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

dkim_check.c 39KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622
  1. /*-
  2. * Copyright 2016 Vsevolod Stakhov
  3. *
  4. * Licensed under the Apache License, Version 2.0 (the "License");
  5. * you may not use this file except in compliance with the License.
  6. * You may obtain a copy of the License at
  7. *
  8. * http://www.apache.org/licenses/LICENSE-2.0
  9. *
  10. * Unless required by applicable law or agreed to in writing, software
  11. * distributed under the License is distributed on an "AS IS" BASIS,
  12. * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13. * See the License for the specific language governing permissions and
  14. * limitations under the License.
  15. */
  16. /***MODULE:dkim
  17. * rspamd module that checks dkim records of incoming email
  18. *
  19. * Allowed options:
  20. * - symbol_allow (string): symbol to insert in case of allow (default: 'R_DKIM_ALLOW')
  21. * - symbol_reject (string): symbol to insert (default: 'R_DKIM_REJECT')
  22. * - symbol_tempfail (string): symbol to insert in case of temporary fail (default: 'R_DKIM_TEMPFAIL')
  23. * - symbol_permfail (string): symbol to insert in case of permanent failure (default: 'R_DKIM_PERMFAIL')
  24. * - symbol_na (string): symbol to insert in case of no signing (default: 'R_DKIM_NA')
  25. * - whitelist (map): map of whitelisted networks
  26. * - domains (map): map of domains to check
  27. * - strict_multiplier (number): multiplier for strict domains
  28. * - time_jitter (number): jitter in seconds to allow time diff while checking
  29. * - trusted_only (flag): check signatures only for domains in 'domains' map
  30. */
  31. #include "config.h"
  32. #include "libmime/message.h"
  33. #include "libserver/dkim.h"
  34. #include "libutil/hash.h"
  35. #include "libserver/maps/map.h"
  36. #include "libserver/maps/map_helpers.h"
  37. #include "rspamd.h"
  38. #include "utlist.h"
  39. #include "unix-std.h"
  40. #include "lua/lua_common.h"
  41. #include "libserver/mempool_vars_internal.h"
  42. #define DEFAULT_SYMBOL_REJECT "R_DKIM_REJECT"
  43. #define DEFAULT_SYMBOL_TEMPFAIL "R_DKIM_TEMPFAIL"
  44. #define DEFAULT_SYMBOL_ALLOW "R_DKIM_ALLOW"
  45. #define DEFAULT_SYMBOL_NA "R_DKIM_NA"
  46. #define DEFAULT_SYMBOL_PERMFAIL "R_DKIM_PERMFAIL"
  47. #define DEFAULT_CACHE_SIZE 2048
  48. #define DEFAULT_TIME_JITTER 60
  49. #define DEFAULT_MAX_SIGS 5
  50. static const gchar *M = "rspamd dkim plugin";
  51. static const gchar default_sign_headers[] = ""
  52. "(o)from:(x)sender:(o)reply-to:(o)subject:(x)date:(x)message-id:"
  53. "(o)to:(o)cc:(x)mime-version:(x)content-type:(x)content-transfer-encoding:"
  54. "resent-to:resent-cc:resent-from:resent-sender:resent-message-id:"
  55. "(x)in-reply-to:(x)references:list-id:list-help:list-owner:list-unsubscribe:"
  56. "list-unsubscribe-post:list-subscribe:list-post:(x)openpgp:(x)autocrypt";
  57. static const gchar default_arc_sign_headers[] = ""
  58. "(o)from:(x)sender:(o)reply-to:(o)subject:(x)date:(x)message-id:"
  59. "(o)to:(o)cc:(x)mime-version:(x)content-type:(x)content-transfer-encoding:"
  60. "resent-to:resent-cc:resent-from:resent-sender:resent-message-id:"
  61. "(x)in-reply-to:(x)references:list-id:list-help:list-owner:list-unsubscribe:"
  62. "list-unsubscribe-post:list-subscribe:list-post:dkim-signature:(x)openpgp:"
  63. "(x)autocrypt";
  64. struct dkim_ctx {
  65. struct module_ctx ctx;
  66. const gchar *symbol_reject;
  67. const gchar *symbol_tempfail;
  68. const gchar *symbol_allow;
  69. const gchar *symbol_na;
  70. const gchar *symbol_permfail;
  71. struct rspamd_radix_map_helper *whitelist_ip;
  72. struct rspamd_hash_map_helper *dkim_domains;
  73. guint strict_multiplier;
  74. guint time_jitter;
  75. rspamd_lru_hash_t *dkim_hash;
  76. rspamd_lru_hash_t *dkim_sign_hash;
  77. const gchar *sign_headers;
  78. const gchar *arc_sign_headers;
  79. guint max_sigs;
  80. gboolean trusted_only;
  81. gboolean check_local;
  82. gboolean check_authed;
  83. };
  84. struct dkim_check_result {
  85. rspamd_dkim_context_t *ctx;
  86. rspamd_dkim_key_t *key;
  87. struct rspamd_task *task;
  88. struct rspamd_dkim_check_result *res;
  89. gdouble mult_allow;
  90. gdouble mult_deny;
  91. struct rspamd_symcache_item *item;
  92. struct dkim_check_result *next, *prev, *first;
  93. };
  94. static void dkim_symbol_callback (struct rspamd_task *task,
  95. struct rspamd_symcache_item *item,
  96. void *unused);
  97. static void dkim_sign_callback (struct rspamd_task *task,
  98. struct rspamd_symcache_item *item,
  99. void *unused);
  100. static gint lua_dkim_sign_handler (lua_State *L);
  101. static gint lua_dkim_verify_handler (lua_State *L);
  102. static gint lua_dkim_canonicalize_handler (lua_State *L);
  103. /* Initialization */
  104. gint dkim_module_init (struct rspamd_config *cfg, struct module_ctx **ctx);
  105. gint dkim_module_config (struct rspamd_config *cfg, bool validate);
  106. gint dkim_module_reconfig (struct rspamd_config *cfg);
  107. module_t dkim_module = {
  108. "dkim",
  109. dkim_module_init,
  110. dkim_module_config,
  111. dkim_module_reconfig,
  112. NULL,
  113. RSPAMD_MODULE_VER,
  114. (guint)-1,
  115. };
  116. static inline struct dkim_ctx *
  117. dkim_get_context (struct rspamd_config *cfg)
  118. {
  119. return (struct dkim_ctx *)g_ptr_array_index (cfg->c_modules,
  120. dkim_module.ctx_offset);
  121. }
  122. static void
  123. dkim_module_key_dtor (gpointer k)
  124. {
  125. rspamd_dkim_key_t *key = k;
  126. rspamd_dkim_key_unref (key);
  127. }
  128. static void
  129. dkim_module_free_list (gpointer k)
  130. {
  131. g_list_free_full ((GList *)k, rspamd_gstring_free_hard);
  132. }
  133. gint
  134. dkim_module_init (struct rspamd_config *cfg, struct module_ctx **ctx)
  135. {
  136. struct dkim_ctx *dkim_module_ctx;
  137. dkim_module_ctx = rspamd_mempool_alloc0 (cfg->cfg_pool,
  138. sizeof (*dkim_module_ctx));
  139. dkim_module_ctx->sign_headers = default_sign_headers;
  140. dkim_module_ctx->arc_sign_headers = default_arc_sign_headers;
  141. dkim_module_ctx->max_sigs = DEFAULT_MAX_SIGS;
  142. *ctx = (struct module_ctx *)dkim_module_ctx;
  143. rspamd_rcl_add_doc_by_path (cfg,
  144. NULL,
  145. "DKIM check plugin",
  146. "dkim",
  147. UCL_OBJECT,
  148. NULL,
  149. 0,
  150. NULL,
  151. 0);
  152. rspamd_rcl_add_doc_by_path (cfg,
  153. "dkim",
  154. "Map of IP addresses that should be excluded from DKIM checks",
  155. "whitelist",
  156. UCL_STRING,
  157. NULL,
  158. 0,
  159. NULL,
  160. 0);
  161. rspamd_rcl_add_doc_by_path (cfg,
  162. "dkim",
  163. "Symbol that is added if DKIM check is successful",
  164. "symbol_allow",
  165. UCL_STRING,
  166. NULL,
  167. 0,
  168. DEFAULT_SYMBOL_ALLOW,
  169. 0);
  170. rspamd_rcl_add_doc_by_path (cfg,
  171. "dkim",
  172. "Symbol that is added if DKIM check is unsuccessful",
  173. "symbol_reject",
  174. UCL_STRING,
  175. NULL,
  176. 0,
  177. DEFAULT_SYMBOL_REJECT,
  178. 0);
  179. rspamd_rcl_add_doc_by_path (cfg,
  180. "dkim",
  181. "Symbol that is added if DKIM check can't be completed (e.g. DNS failure)",
  182. "symbol_tempfail",
  183. UCL_STRING,
  184. NULL,
  185. 0,
  186. DEFAULT_SYMBOL_TEMPFAIL,
  187. 0);
  188. rspamd_rcl_add_doc_by_path (cfg,
  189. "dkim",
  190. "Symbol that is added if mail is not signed",
  191. "symbol_na",
  192. UCL_STRING,
  193. NULL,
  194. 0,
  195. DEFAULT_SYMBOL_NA,
  196. 0);
  197. rspamd_rcl_add_doc_by_path (cfg,
  198. "dkim",
  199. "Symbol that is added if permanent failure encountered",
  200. "symbol_permfail",
  201. UCL_STRING,
  202. NULL,
  203. 0,
  204. DEFAULT_SYMBOL_PERMFAIL,
  205. 0);
  206. rspamd_rcl_add_doc_by_path (cfg,
  207. "dkim",
  208. "Size of DKIM keys cache",
  209. "dkim_cache_size",
  210. UCL_INT,
  211. NULL,
  212. 0,
  213. G_STRINGIFY (DEFAULT_CACHE_SIZE),
  214. 0);
  215. rspamd_rcl_add_doc_by_path (cfg,
  216. "dkim",
  217. "Allow this time difference when checking DKIM signature time validity",
  218. "time_jitter",
  219. UCL_TIME,
  220. NULL,
  221. 0,
  222. G_STRINGIFY (DEFAULT_TIME_JITTER),
  223. 0);
  224. rspamd_rcl_add_doc_by_path (cfg,
  225. "dkim",
  226. "Domains to check DKIM for (check all domains if this option is empty)",
  227. "domains",
  228. UCL_STRING,
  229. NULL,
  230. 0,
  231. "empty",
  232. 0);
  233. rspamd_rcl_add_doc_by_path (cfg,
  234. "dkim",
  235. "Map of domains that are treated as 'trusted' meaning that DKIM policy failure has more significant score",
  236. "trusted_domains",
  237. UCL_STRING,
  238. NULL,
  239. 0,
  240. "empty",
  241. 0);
  242. rspamd_rcl_add_doc_by_path (cfg,
  243. "dkim",
  244. "Multiply dkim score by this factor for trusted domains",
  245. "strict_multiplier",
  246. UCL_FLOAT,
  247. NULL,
  248. 0,
  249. NULL,
  250. 0);
  251. rspamd_rcl_add_doc_by_path (cfg,
  252. "dkim",
  253. "Check DKIM policies merely for `trusted_domains`",
  254. "trusted_only",
  255. UCL_BOOLEAN,
  256. NULL,
  257. 0,
  258. "false",
  259. 0);
  260. rspamd_rcl_add_doc_by_path (cfg,
  261. "dkim",
  262. "Lua script that tells if a message should be signed and with what params (obsoleted)",
  263. "sign_condition",
  264. UCL_STRING,
  265. NULL,
  266. 0,
  267. "empty",
  268. 0);
  269. rspamd_rcl_add_doc_by_path (cfg,
  270. "dkim",
  271. "Obsoleted: maximum number of DKIM signatures to check",
  272. "max_sigs",
  273. UCL_INT,
  274. NULL,
  275. 0,
  276. "n/a",
  277. 0);
  278. rspamd_rcl_add_doc_by_path (cfg,
  279. "dkim",
  280. "Headers used in signing",
  281. "sign_headers",
  282. UCL_STRING,
  283. NULL,
  284. 0,
  285. default_sign_headers,
  286. 0);
  287. return 0;
  288. }
  289. gint
  290. dkim_module_config (struct rspamd_config *cfg, bool validate)
  291. {
  292. const ucl_object_t *value;
  293. gint res = TRUE, cb_id = -1;
  294. guint cache_size, sign_cache_size;
  295. gboolean got_trusted = FALSE;
  296. struct dkim_ctx *dkim_module_ctx = dkim_get_context (cfg);
  297. /* Register global methods */
  298. lua_getglobal (cfg->lua_state, "rspamd_plugins");
  299. if (lua_type (cfg->lua_state, -1) == LUA_TTABLE) {
  300. lua_pushstring (cfg->lua_state, "dkim");
  301. lua_createtable (cfg->lua_state, 0, 1);
  302. /* Set methods */
  303. lua_pushstring (cfg->lua_state, "sign");
  304. lua_pushcfunction (cfg->lua_state, lua_dkim_sign_handler);
  305. lua_settable (cfg->lua_state, -3);
  306. lua_pushstring (cfg->lua_state, "verify");
  307. lua_pushcfunction (cfg->lua_state, lua_dkim_verify_handler);
  308. lua_settable (cfg->lua_state, -3);
  309. lua_pushstring (cfg->lua_state, "canon_header_relaxed");
  310. lua_pushcfunction (cfg->lua_state, lua_dkim_canonicalize_handler);
  311. lua_settable (cfg->lua_state, -3);
  312. /* Finish dkim key */
  313. lua_settable (cfg->lua_state, -3);
  314. }
  315. lua_pop (cfg->lua_state, 1); /* Remove global function */
  316. dkim_module_ctx->whitelist_ip = NULL;
  317. value = rspamd_config_get_module_opt (cfg, "dkim", "check_local");
  318. if (value == NULL) {
  319. value = rspamd_config_get_module_opt (cfg, "options", "check_local");
  320. }
  321. if (value != NULL) {
  322. dkim_module_ctx->check_local = ucl_object_toboolean (value);
  323. }
  324. else {
  325. dkim_module_ctx->check_local = FALSE;
  326. }
  327. value = rspamd_config_get_module_opt (cfg, "dkim",
  328. "check_authed");
  329. if (value == NULL) {
  330. value = rspamd_config_get_module_opt (cfg, "options",
  331. "check_authed");
  332. }
  333. if (value != NULL) {
  334. dkim_module_ctx->check_authed = ucl_object_toboolean (value);
  335. }
  336. else {
  337. dkim_module_ctx->check_authed = FALSE;
  338. }
  339. if ((value =
  340. rspamd_config_get_module_opt (cfg, "dkim", "symbol_reject")) != NULL) {
  341. dkim_module_ctx->symbol_reject = ucl_object_tostring (value);
  342. }
  343. else {
  344. dkim_module_ctx->symbol_reject = DEFAULT_SYMBOL_REJECT;
  345. }
  346. if ((value =
  347. rspamd_config_get_module_opt (cfg, "dkim",
  348. "symbol_tempfail")) != NULL) {
  349. dkim_module_ctx->symbol_tempfail = ucl_object_tostring (value);
  350. }
  351. else {
  352. dkim_module_ctx->symbol_tempfail = DEFAULT_SYMBOL_TEMPFAIL;
  353. }
  354. if ((value =
  355. rspamd_config_get_module_opt (cfg, "dkim", "symbol_allow")) != NULL) {
  356. dkim_module_ctx->symbol_allow = ucl_object_tostring (value);
  357. }
  358. else {
  359. dkim_module_ctx->symbol_allow = DEFAULT_SYMBOL_ALLOW;
  360. }
  361. if ((value =
  362. rspamd_config_get_module_opt (cfg, "dkim", "symbol_na")) != NULL) {
  363. dkim_module_ctx->symbol_na = ucl_object_tostring (value);
  364. }
  365. else {
  366. dkim_module_ctx->symbol_na = DEFAULT_SYMBOL_NA;
  367. }
  368. if ((value =
  369. rspamd_config_get_module_opt (cfg, "dkim", "symbol_permfail")) != NULL) {
  370. dkim_module_ctx->symbol_permfail = ucl_object_tostring (value);
  371. }
  372. else {
  373. dkim_module_ctx->symbol_permfail = DEFAULT_SYMBOL_PERMFAIL;
  374. }
  375. if ((value =
  376. rspamd_config_get_module_opt (cfg, "dkim",
  377. "dkim_cache_size")) != NULL) {
  378. cache_size = ucl_object_toint (value);
  379. }
  380. else {
  381. cache_size = DEFAULT_CACHE_SIZE;
  382. }
  383. if ((value =
  384. rspamd_config_get_module_opt (cfg, "dkim",
  385. "sign_cache_size")) != NULL) {
  386. sign_cache_size = ucl_object_toint (value);
  387. }
  388. else {
  389. sign_cache_size = 128;
  390. }
  391. if ((value =
  392. rspamd_config_get_module_opt (cfg, "dkim", "time_jitter")) != NULL) {
  393. dkim_module_ctx->time_jitter = ucl_object_todouble (value);
  394. }
  395. else {
  396. dkim_module_ctx->time_jitter = DEFAULT_TIME_JITTER;
  397. }
  398. if ((value =
  399. rspamd_config_get_module_opt (cfg, "dkim", "max_sigs")) != NULL) {
  400. dkim_module_ctx->max_sigs = ucl_object_toint (value);
  401. }
  402. if ((value =
  403. rspamd_config_get_module_opt (cfg, "dkim", "whitelist")) != NULL) {
  404. rspamd_config_radix_from_ucl (cfg, value, "DKIM whitelist",
  405. &dkim_module_ctx->whitelist_ip, NULL, NULL, "dkim whitelist");
  406. }
  407. if ((value =
  408. rspamd_config_get_module_opt (cfg, "dkim", "domains")) != NULL) {
  409. if (!rspamd_map_add_from_ucl (cfg, value,
  410. "DKIM domains",
  411. rspamd_kv_list_read,
  412. rspamd_kv_list_fin,
  413. rspamd_kv_list_dtor,
  414. (void **)&dkim_module_ctx->dkim_domains,
  415. NULL, RSPAMD_MAP_DEFAULT)) {
  416. msg_warn_config ("cannot load dkim domains list from %s",
  417. ucl_object_tostring (value));
  418. }
  419. else {
  420. got_trusted = TRUE;
  421. }
  422. }
  423. if (!got_trusted && (value =
  424. rspamd_config_get_module_opt (cfg, "dkim", "trusted_domains")) != NULL) {
  425. if (!rspamd_map_add_from_ucl (cfg, value,
  426. "DKIM domains",
  427. rspamd_kv_list_read,
  428. rspamd_kv_list_fin,
  429. rspamd_kv_list_dtor,
  430. (void **)&dkim_module_ctx->dkim_domains,
  431. NULL, RSPAMD_MAP_DEFAULT)) {
  432. msg_warn_config ("cannot load dkim domains list from %s",
  433. ucl_object_tostring (value));
  434. if (validate) {
  435. return FALSE;
  436. }
  437. }
  438. else {
  439. got_trusted = TRUE;
  440. }
  441. }
  442. if ((value =
  443. rspamd_config_get_module_opt (cfg, "dkim",
  444. "strict_multiplier")) != NULL) {
  445. dkim_module_ctx->strict_multiplier = ucl_object_toint (value);
  446. }
  447. else {
  448. dkim_module_ctx->strict_multiplier = 1;
  449. }
  450. if ((value =
  451. rspamd_config_get_module_opt (cfg, "dkim", "trusted_only")) != NULL) {
  452. dkim_module_ctx->trusted_only = ucl_object_toboolean (value);
  453. }
  454. else {
  455. dkim_module_ctx->trusted_only = FALSE;
  456. }
  457. if ((value =
  458. rspamd_config_get_module_opt (cfg, "dkim", "sign_headers")) != NULL) {
  459. dkim_module_ctx->sign_headers = ucl_object_tostring (value);
  460. }
  461. if ((value =
  462. rspamd_config_get_module_opt (cfg, "arc", "sign_headers")) != NULL) {
  463. dkim_module_ctx->arc_sign_headers = ucl_object_tostring (value);
  464. }
  465. if (cache_size > 0) {
  466. dkim_module_ctx->dkim_hash = rspamd_lru_hash_new (
  467. cache_size,
  468. g_free,
  469. dkim_module_key_dtor);
  470. rspamd_mempool_add_destructor (cfg->cfg_pool,
  471. (rspamd_mempool_destruct_t)rspamd_lru_hash_destroy,
  472. dkim_module_ctx->dkim_hash);
  473. }
  474. if (sign_cache_size > 0) {
  475. dkim_module_ctx->dkim_sign_hash = rspamd_lru_hash_new (
  476. sign_cache_size,
  477. g_free,
  478. (GDestroyNotify) rspamd_dkim_sign_key_unref);
  479. rspamd_mempool_add_destructor (cfg->cfg_pool,
  480. (rspamd_mempool_destruct_t)rspamd_lru_hash_destroy,
  481. dkim_module_ctx->dkim_sign_hash);
  482. }
  483. if (dkim_module_ctx->trusted_only && !got_trusted) {
  484. msg_err_config ("trusted_only option is set and no trusted domains are defined");
  485. if (validate) {
  486. return FALSE;
  487. }
  488. }
  489. else {
  490. if (!rspamd_config_is_module_enabled (cfg, "dkim")) {
  491. return TRUE;
  492. }
  493. cb_id = rspamd_symcache_add_symbol (cfg->cache,
  494. "DKIM_CHECK",
  495. 0,
  496. dkim_symbol_callback,
  497. NULL,
  498. SYMBOL_TYPE_CALLBACK,
  499. -1);
  500. rspamd_config_add_symbol (cfg,
  501. "DKIM_CHECK",
  502. 0.0,
  503. "DKIM check callback",
  504. "policies",
  505. RSPAMD_SYMBOL_FLAG_IGNORE_METRIC,
  506. 1,
  507. 1);
  508. rspamd_config_add_symbol_group (cfg, "DKIM_CHECK", "dkim");
  509. rspamd_symcache_add_symbol (cfg->cache,
  510. dkim_module_ctx->symbol_reject,
  511. 0,
  512. NULL,
  513. NULL,
  514. SYMBOL_TYPE_VIRTUAL | SYMBOL_TYPE_FINE,
  515. cb_id);
  516. rspamd_symcache_add_symbol (cfg->cache,
  517. dkim_module_ctx->symbol_na,
  518. 0,
  519. NULL, NULL,
  520. SYMBOL_TYPE_VIRTUAL | SYMBOL_TYPE_FINE,
  521. cb_id);
  522. rspamd_symcache_add_symbol (cfg->cache,
  523. dkim_module_ctx->symbol_permfail,
  524. 0,
  525. NULL, NULL,
  526. SYMBOL_TYPE_VIRTUAL | SYMBOL_TYPE_FINE,
  527. cb_id);
  528. rspamd_symcache_add_symbol (cfg->cache,
  529. dkim_module_ctx->symbol_tempfail,
  530. 0,
  531. NULL, NULL,
  532. SYMBOL_TYPE_VIRTUAL | SYMBOL_TYPE_FINE,
  533. cb_id);
  534. rspamd_symcache_add_symbol (cfg->cache,
  535. dkim_module_ctx->symbol_allow,
  536. 0,
  537. NULL, NULL,
  538. SYMBOL_TYPE_VIRTUAL | SYMBOL_TYPE_FINE,
  539. cb_id);
  540. rspamd_symcache_add_symbol (cfg->cache,
  541. "DKIM_TRACE",
  542. 0,
  543. NULL, NULL,
  544. SYMBOL_TYPE_VIRTUAL | SYMBOL_TYPE_NOSTAT,
  545. cb_id);
  546. rspamd_config_add_symbol (cfg,
  547. "DKIM_TRACE",
  548. 0.0,
  549. "DKIM trace symbol",
  550. "policies",
  551. RSPAMD_SYMBOL_FLAG_IGNORE_METRIC,
  552. 1,
  553. 1);
  554. rspamd_config_add_symbol_group (cfg, "DKIM_TRACE", "dkim");
  555. msg_info_config ("init internal dkim module");
  556. #ifndef HAVE_OPENSSL
  557. msg_warn_config (
  558. "openssl is not found so dkim rsa check is disabled, only check body hash, it is NOT safe to trust these results");
  559. #endif
  560. }
  561. return res;
  562. }
  563. /**
  564. * Grab a private key from the cache
  565. * or from the key content provided
  566. */
  567. rspamd_dkim_sign_key_t *
  568. dkim_module_load_key_format (struct rspamd_task *task,
  569. struct dkim_ctx *dkim_module_ctx,
  570. const gchar *key, gsize keylen,
  571. enum rspamd_dkim_key_format key_format)
  572. {
  573. guchar h[rspamd_cryptobox_HASHBYTES],
  574. hex_hash[rspamd_cryptobox_HASHBYTES * 2 + 1];
  575. rspamd_dkim_sign_key_t *ret = NULL;
  576. GError *err = NULL;
  577. struct stat st;
  578. memset (hex_hash, 0, sizeof (hex_hash));
  579. rspamd_cryptobox_hash (h, key, keylen, NULL, 0);
  580. rspamd_encode_hex_buf (h, sizeof (h), hex_hash, sizeof (hex_hash));
  581. if (dkim_module_ctx->dkim_sign_hash) {
  582. ret = rspamd_lru_hash_lookup (dkim_module_ctx->dkim_sign_hash,
  583. hex_hash, time (NULL));
  584. }
  585. /*
  586. * This fails for paths that are also valid base64.
  587. * Maybe the caller should have specified a format.
  588. */
  589. if (key_format == RSPAMD_DKIM_KEY_UNKNOWN) {
  590. if (key[0] == '.' || key[0] == '/') {
  591. if (!rspamd_cryptobox_base64_is_valid (key, keylen)) {
  592. key_format = RSPAMD_DKIM_KEY_FILE;
  593. }
  594. }
  595. else if (rspamd_cryptobox_base64_is_valid (key, keylen)) {
  596. key_format = RSPAMD_DKIM_KEY_BASE64;
  597. }
  598. }
  599. if (ret != NULL && key_format == RSPAMD_DKIM_KEY_FILE) {
  600. msg_debug_task("checking for stale file key");
  601. if (stat (key, &st) != 0) {
  602. msg_err_task("cannot stat key file: %s", strerror (errno));
  603. return NULL;
  604. }
  605. if (rspamd_dkim_sign_key_maybe_invalidate (ret, st.st_mtime)) {
  606. msg_debug_task("removing stale file key");
  607. /*
  608. * Invalidate DKIM key
  609. * removal from lru cache also cleanup the key and value
  610. */
  611. if (dkim_module_ctx->dkim_sign_hash) {
  612. rspamd_lru_hash_remove (dkim_module_ctx->dkim_sign_hash,
  613. hex_hash);
  614. }
  615. ret = NULL;
  616. }
  617. }
  618. /* found key; done */
  619. if (ret != NULL) {
  620. return ret;
  621. }
  622. ret = rspamd_dkim_sign_key_load (key, keylen, key_format, &err);
  623. if (ret == NULL) {
  624. msg_err_task ("cannot load dkim key %s: %e",
  625. key, err);
  626. g_error_free (err);
  627. }
  628. else if (dkim_module_ctx->dkim_sign_hash) {
  629. rspamd_lru_hash_insert (dkim_module_ctx->dkim_sign_hash,
  630. g_strdup (hex_hash), ret, time (NULL), 0);
  631. }
  632. return ret;
  633. }
  634. static gint
  635. lua_dkim_sign_handler (lua_State *L)
  636. {
  637. struct rspamd_task *task = lua_check_task (L, 1);
  638. gint64 arc_idx = 0, expire = 0;
  639. enum rspamd_dkim_type sign_type = RSPAMD_DKIM_NORMAL;
  640. GError *err = NULL;
  641. GString *hdr;
  642. GList *sigs = NULL;
  643. const gchar *selector = NULL, *domain = NULL, *key = NULL, *rawkey = NULL,
  644. *headers = NULL, *sign_type_str = NULL, *arc_cv = NULL,
  645. *pubkey = NULL;
  646. rspamd_dkim_sign_context_t *ctx;
  647. rspamd_dkim_sign_key_t *dkim_key;
  648. gsize rawlen = 0, keylen = 0;
  649. gboolean no_cache = FALSE, strict_pubkey_check = FALSE;
  650. struct dkim_ctx *dkim_module_ctx;
  651. luaL_argcheck (L, lua_type (L, 2) == LUA_TTABLE, 2, "'table' expected");
  652. /*
  653. * Get the following elements:
  654. * - selector
  655. * - domain
  656. * - key
  657. */
  658. if (!rspamd_lua_parse_table_arguments (L, 2, &err,
  659. RSPAMD_LUA_PARSE_ARGUMENTS_DEFAULT,
  660. "key=V;rawkey=V;*domain=S;*selector=S;no_cache=B;headers=S;"
  661. "sign_type=S;arc_idx=I;arc_cv=S;expire=I;pubkey=S;"
  662. "strict_pubkey_check=B",
  663. &keylen, &key, &rawlen, &rawkey, &domain,
  664. &selector, &no_cache, &headers,
  665. &sign_type_str, &arc_idx, &arc_cv, &expire, &pubkey,
  666. &strict_pubkey_check)) {
  667. msg_err_task ("cannot parse table arguments: %e",
  668. err);
  669. g_error_free (err);
  670. lua_pushboolean (L, FALSE);
  671. return 1;
  672. }
  673. dkim_module_ctx = dkim_get_context (task->cfg);
  674. if (key) {
  675. dkim_key = dkim_module_load_key_format (task, dkim_module_ctx, key,
  676. keylen, RSPAMD_DKIM_KEY_UNKNOWN);
  677. }
  678. else if (rawkey) {
  679. dkim_key = dkim_module_load_key_format (task, dkim_module_ctx, rawkey,
  680. rawlen, RSPAMD_DKIM_KEY_UNKNOWN);
  681. }
  682. else {
  683. msg_err_task ("neither key nor rawkey are specified");
  684. lua_pushboolean (L, FALSE);
  685. return 1;
  686. }
  687. if (dkim_key == NULL) {
  688. lua_pushboolean (L, FALSE);
  689. return 1;
  690. }
  691. if (sign_type_str) {
  692. if (strcmp (sign_type_str, "dkim") == 0) {
  693. sign_type = RSPAMD_DKIM_NORMAL;
  694. if (headers == NULL) {
  695. headers = dkim_module_ctx->sign_headers;
  696. }
  697. }
  698. else if (strcmp (sign_type_str, "arc-sign") == 0) {
  699. sign_type = RSPAMD_DKIM_ARC_SIG;
  700. if (headers == NULL) {
  701. headers = dkim_module_ctx->arc_sign_headers;
  702. }
  703. if (arc_idx == 0) {
  704. lua_settop (L, 0);
  705. return luaL_error (L, "no arc idx specified");
  706. }
  707. }
  708. else if (strcmp (sign_type_str, "arc-seal") == 0) {
  709. sign_type = RSPAMD_DKIM_ARC_SEAL;
  710. if (arc_cv == NULL) {
  711. lua_settop (L, 0);
  712. return luaL_error (L, "no arc cv specified");
  713. }
  714. if (arc_idx == 0) {
  715. lua_settop (L, 0);
  716. return luaL_error (L, "no arc idx specified");
  717. }
  718. }
  719. else {
  720. lua_settop (L, 0);
  721. return luaL_error (L, "unknown sign type: %s",
  722. sign_type_str);
  723. }
  724. }
  725. else {
  726. /* Unspecified sign type, assume plain dkim */
  727. if (headers == NULL) {
  728. headers = dkim_module_ctx->sign_headers;
  729. }
  730. }
  731. if (pubkey != NULL) {
  732. /* Also check if private and public keys match */
  733. rspamd_dkim_key_t *pk;
  734. keylen = strlen (pubkey);
  735. pk = rspamd_dkim_parse_key (pubkey, &keylen, NULL);
  736. if (pk == NULL) {
  737. if (strict_pubkey_check) {
  738. msg_err_task ("cannot parse pubkey from string: %s, skip signing",
  739. pubkey);
  740. lua_pushboolean (L, FALSE);
  741. return 1;
  742. }
  743. else {
  744. msg_warn_task ("cannot parse pubkey from string: %s",
  745. pubkey);
  746. }
  747. }
  748. else {
  749. GError *te = NULL;
  750. /* We have parsed the key, so try to check keys */
  751. if (!rspamd_dkim_match_keys (pk, dkim_key, &te)) {
  752. if (strict_pubkey_check) {
  753. msg_err_task ("public key for %s/%s does not match private "
  754. "key: %e, skip signing",
  755. domain, selector, te);
  756. g_error_free (te);
  757. lua_pushboolean (L, FALSE);
  758. rspamd_dkim_key_unref (pk);
  759. return 1;
  760. }
  761. else {
  762. msg_warn_task ("public key for %s/%s does not match private "
  763. "key: %e",
  764. domain, selector, te);
  765. g_error_free (te);
  766. }
  767. }
  768. rspamd_dkim_key_unref (pk);
  769. }
  770. }
  771. ctx = rspamd_create_dkim_sign_context (task, dkim_key,
  772. DKIM_CANON_RELAXED, DKIM_CANON_RELAXED,
  773. headers, sign_type, &err);
  774. if (ctx == NULL) {
  775. msg_err_task ("cannot create sign context: %e",
  776. err);
  777. g_error_free (err);
  778. lua_pushboolean (L, FALSE);
  779. return 1;
  780. }
  781. hdr = rspamd_dkim_sign (task, selector, domain, 0,
  782. expire, arc_idx, arc_cv, ctx);
  783. if (hdr) {
  784. if (!no_cache) {
  785. sigs = rspamd_mempool_get_variable (task->task_pool, "dkim-signature");
  786. if (sigs == NULL) {
  787. sigs = g_list_append (sigs, hdr);
  788. rspamd_mempool_set_variable (task->task_pool, "dkim-signature",
  789. sigs, dkim_module_free_list);
  790. } else {
  791. sigs = g_list_append (sigs, hdr);
  792. (void)sigs;
  793. }
  794. }
  795. lua_pushboolean (L, TRUE);
  796. lua_pushlstring (L, hdr->str, hdr->len);
  797. if (no_cache) {
  798. g_string_free (hdr, TRUE);
  799. }
  800. return 2;
  801. }
  802. lua_pushboolean (L, FALSE);
  803. lua_pushnil (L);
  804. return 2;
  805. }
  806. gint
  807. dkim_module_reconfig (struct rspamd_config *cfg)
  808. {
  809. return dkim_module_config (cfg, false);
  810. }
  811. /*
  812. * Parse strict value for domain in format: 'reject_multiplier:deny_multiplier'
  813. */
  814. static gboolean
  815. dkim_module_parse_strict (const gchar *value, gdouble *allow, gdouble *deny)
  816. {
  817. const gchar *colon;
  818. gchar *err = NULL;
  819. gdouble val;
  820. gchar numbuf[64];
  821. colon = strchr (value, ':');
  822. if (colon) {
  823. rspamd_strlcpy (numbuf, value,
  824. MIN (sizeof (numbuf), (colon - value) + 1));
  825. val = strtod (numbuf, &err);
  826. if (err == NULL || *err == '\0') {
  827. *deny = val;
  828. colon++;
  829. rspamd_strlcpy (numbuf, colon, sizeof (numbuf));
  830. err = NULL;
  831. val = strtod (numbuf, &err);
  832. if (err == NULL || *err == '\0') {
  833. *allow = val;
  834. return TRUE;
  835. }
  836. }
  837. }
  838. return FALSE;
  839. }
  840. static void
  841. dkim_module_check (struct dkim_check_result *res)
  842. {
  843. gboolean all_done = TRUE;
  844. const gchar *strict_value;
  845. struct dkim_check_result *first, *cur = NULL;
  846. struct dkim_ctx *dkim_module_ctx = dkim_get_context (res->task->cfg);
  847. struct rspamd_task *task = res->task;
  848. first = res->first;
  849. DL_FOREACH (first, cur) {
  850. if (cur->ctx == NULL) {
  851. continue;
  852. }
  853. if (cur->key != NULL && cur->res == NULL) {
  854. cur->res = rspamd_dkim_check (cur->ctx, cur->key, task);
  855. if (dkim_module_ctx->dkim_domains != NULL) {
  856. /* Perform strict check */
  857. const gchar *domain = rspamd_dkim_get_domain (cur->ctx);
  858. if ((strict_value =
  859. rspamd_match_hash_map (dkim_module_ctx->dkim_domains,
  860. domain,
  861. strlen (domain))) != NULL) {
  862. if (!dkim_module_parse_strict (strict_value, &cur->mult_allow,
  863. &cur->mult_deny)) {
  864. cur->mult_allow = dkim_module_ctx->strict_multiplier;
  865. cur->mult_deny = dkim_module_ctx->strict_multiplier;
  866. }
  867. }
  868. }
  869. }
  870. }
  871. DL_FOREACH (first, cur) {
  872. if (cur->ctx == NULL) {
  873. continue;
  874. }
  875. if (cur->res == NULL) {
  876. /* Still need a key */
  877. all_done = FALSE;
  878. }
  879. }
  880. if (all_done) {
  881. /* Create zero terminated array of results */
  882. struct rspamd_dkim_check_result **pres;
  883. guint nres = 0, i = 0;
  884. DL_FOREACH (first, cur) {
  885. if (cur->ctx == NULL || cur->res == NULL) {
  886. continue;
  887. }
  888. nres ++;
  889. }
  890. pres = rspamd_mempool_alloc (task->task_pool, sizeof (*pres) * (nres + 1));
  891. pres[nres] = NULL;
  892. DL_FOREACH (first, cur) {
  893. const gchar *symbol = NULL, *trace = NULL;
  894. gdouble symbol_weight = 1.0;
  895. if (cur->ctx == NULL || cur->res == NULL) {
  896. continue;
  897. }
  898. pres[i++] = cur->res;
  899. if (cur->res->rcode == DKIM_REJECT) {
  900. symbol = dkim_module_ctx->symbol_reject;
  901. trace = "-";
  902. symbol_weight = cur->mult_deny * 1.0;
  903. }
  904. else if (cur->res->rcode == DKIM_CONTINUE) {
  905. symbol = dkim_module_ctx->symbol_allow;
  906. trace = "+";
  907. symbol_weight = cur->mult_allow * 1.0;
  908. }
  909. else if (cur->res->rcode == DKIM_PERM_ERROR) {
  910. trace = "~";
  911. symbol = dkim_module_ctx->symbol_permfail;
  912. }
  913. else if (cur->res->rcode == DKIM_TRYAGAIN) {
  914. trace = "?";
  915. symbol = dkim_module_ctx->symbol_tempfail;
  916. }
  917. if (symbol != NULL) {
  918. const gchar *domain = rspamd_dkim_get_domain (cur->ctx);
  919. const gchar *selector = rspamd_dkim_get_selector (cur->ctx);
  920. gsize tracelen;
  921. gchar *tracebuf;
  922. tracelen = strlen (domain) + strlen (selector) + 4;
  923. tracebuf = rspamd_mempool_alloc (task->task_pool,
  924. tracelen);
  925. rspamd_snprintf (tracebuf, tracelen, "%s:%s", domain, trace);
  926. rspamd_task_insert_result (cur->task,
  927. "DKIM_TRACE",
  928. 0.0,
  929. tracebuf);
  930. rspamd_snprintf (tracebuf, tracelen, "%s:s=%s", domain, selector);
  931. rspamd_task_insert_result (task,
  932. symbol,
  933. symbol_weight,
  934. tracebuf);
  935. }
  936. }
  937. rspamd_mempool_set_variable (task->task_pool,
  938. RSPAMD_MEMPOOL_DKIM_CHECK_RESULTS,
  939. pres, NULL);
  940. }
  941. }
  942. static void
  943. dkim_module_key_handler (rspamd_dkim_key_t *key,
  944. gsize keylen,
  945. rspamd_dkim_context_t *ctx,
  946. gpointer ud,
  947. GError *err)
  948. {
  949. struct dkim_check_result *res = ud;
  950. struct rspamd_task *task;
  951. struct dkim_ctx *dkim_module_ctx;
  952. task = res->task;
  953. dkim_module_ctx = dkim_get_context (task->cfg);
  954. if (key != NULL) {
  955. /* Another ref belongs to the check context */
  956. res->key = rspamd_dkim_key_ref (key);
  957. /*
  958. * We actually receive key with refcount = 1, so we just assume that
  959. * lru hash owns this object now
  960. */
  961. /* Release key when task is processed */
  962. rspamd_mempool_add_destructor (res->task->task_pool,
  963. dkim_module_key_dtor, res->key);
  964. if (dkim_module_ctx->dkim_hash) {
  965. rspamd_lru_hash_insert (dkim_module_ctx->dkim_hash,
  966. g_strdup (rspamd_dkim_get_dns_key (ctx)),
  967. key, res->task->task_timestamp, rspamd_dkim_key_get_ttl (key));
  968. msg_info_task ("stored DKIM key for %s in LRU cache for %d seconds, "
  969. "%d/%d elements in the cache",
  970. rspamd_dkim_get_dns_key (ctx),
  971. rspamd_dkim_key_get_ttl (key),
  972. rspamd_lru_hash_size (dkim_module_ctx->dkim_hash),
  973. rspamd_lru_hash_capacity (dkim_module_ctx->dkim_hash));
  974. }
  975. }
  976. else {
  977. /* Insert tempfail symbol */
  978. msg_info_task ("cannot get key for domain %s: %e",
  979. rspamd_dkim_get_dns_key (ctx), err);
  980. if (err != NULL) {
  981. if (err->code == DKIM_SIGERROR_NOKEY) {
  982. res->res = rspamd_dkim_create_result (ctx, DKIM_TRYAGAIN, task);
  983. res->res->fail_reason = "DNS error when getting key";
  984. }
  985. else {
  986. res->res = rspamd_dkim_create_result (ctx, DKIM_PERM_ERROR, task);
  987. res->res->fail_reason = "invalid DKIM record";
  988. }
  989. }
  990. }
  991. if (err) {
  992. g_error_free (err);
  993. }
  994. dkim_module_check (res);
  995. }
  996. static void
  997. dkim_symbol_callback (struct rspamd_task *task,
  998. struct rspamd_symcache_item *item,
  999. void *unused)
  1000. {
  1001. rspamd_dkim_context_t *ctx;
  1002. rspamd_dkim_key_t *key;
  1003. GError *err = NULL;
  1004. struct rspamd_mime_header *rh, *rh_cur;
  1005. struct dkim_check_result *res = NULL, *cur;
  1006. guint checked = 0;
  1007. gdouble *dmarc_checks;
  1008. struct dkim_ctx *dkim_module_ctx = dkim_get_context (task->cfg);
  1009. /* Allow dmarc */
  1010. dmarc_checks = rspamd_mempool_get_variable (task->task_pool,
  1011. RSPAMD_MEMPOOL_DMARC_CHECKS);
  1012. if (dmarc_checks) {
  1013. (*dmarc_checks) ++;
  1014. }
  1015. else {
  1016. dmarc_checks = rspamd_mempool_alloc (task->task_pool,
  1017. sizeof (*dmarc_checks));
  1018. *dmarc_checks = 1;
  1019. rspamd_mempool_set_variable (task->task_pool,
  1020. RSPAMD_MEMPOOL_DMARC_CHECKS,
  1021. dmarc_checks, NULL);
  1022. }
  1023. /* First check if plugin should be enabled */
  1024. if ((!dkim_module_ctx->check_authed && task->user != NULL)
  1025. || (!dkim_module_ctx->check_local &&
  1026. rspamd_ip_is_local_cfg (task->cfg, task->from_addr))) {
  1027. msg_info_task ("skip DKIM checks for local networks and authorized users");
  1028. rspamd_symcache_finalize_item (task, item);
  1029. return;
  1030. }
  1031. /* Check whitelist */
  1032. if (rspamd_match_radix_map_addr (dkim_module_ctx->whitelist_ip,
  1033. task->from_addr) != NULL) {
  1034. msg_info_task ("skip DKIM checks for whitelisted address");
  1035. rspamd_symcache_finalize_item (task, item);
  1036. return;
  1037. }
  1038. rspamd_symcache_item_async_inc (task, item, M);
  1039. /* Now check if a message has its signature */
  1040. rh = rspamd_message_get_header_array(task, RSPAMD_DKIM_SIGNHEADER, FALSE);
  1041. if (rh) {
  1042. msg_debug_task ("dkim signature found");
  1043. DL_FOREACH (rh, rh_cur) {
  1044. if (rh_cur->decoded == NULL || rh_cur->decoded[0] == '\0') {
  1045. msg_info_task ("cannot load empty DKIM signature");
  1046. continue;
  1047. }
  1048. cur = rspamd_mempool_alloc0 (task->task_pool, sizeof (*cur));
  1049. cur->first = res;
  1050. cur->res = NULL;
  1051. cur->task = task;
  1052. cur->mult_allow = 1.0;
  1053. cur->mult_deny = 1.0;
  1054. cur->item = item;
  1055. ctx = rspamd_create_dkim_context (rh_cur->decoded,
  1056. task->task_pool,
  1057. task->resolver,
  1058. dkim_module_ctx->time_jitter,
  1059. RSPAMD_DKIM_NORMAL,
  1060. &err);
  1061. if (res == NULL) {
  1062. res = cur;
  1063. res->first = res;
  1064. res->prev = res;
  1065. }
  1066. else {
  1067. DL_APPEND (res, cur);
  1068. }
  1069. if (ctx == NULL) {
  1070. if (err != NULL) {
  1071. msg_info_task ("cannot parse DKIM signature: %e",
  1072. err);
  1073. g_error_free (err);
  1074. err = NULL;
  1075. }
  1076. else {
  1077. msg_info_task ("cannot parse DKIM signature: "
  1078. "unknown error");
  1079. }
  1080. continue;
  1081. }
  1082. else {
  1083. /* Get key */
  1084. cur->ctx = ctx;
  1085. const gchar *domain = rspamd_dkim_get_domain (cur->ctx);
  1086. if (dkim_module_ctx->trusted_only &&
  1087. (dkim_module_ctx->dkim_domains == NULL ||
  1088. rspamd_match_hash_map (dkim_module_ctx->dkim_domains,
  1089. domain, strlen (domain)) == NULL)) {
  1090. msg_debug_task ("skip dkim check for %s domain",
  1091. rspamd_dkim_get_domain (ctx));
  1092. continue;
  1093. }
  1094. if (dkim_module_ctx->dkim_hash) {
  1095. key = rspamd_lru_hash_lookup (dkim_module_ctx->dkim_hash,
  1096. rspamd_dkim_get_dns_key (ctx),
  1097. task->task_timestamp);
  1098. }
  1099. else {
  1100. key = NULL;
  1101. }
  1102. if (key != NULL) {
  1103. cur->key = rspamd_dkim_key_ref (key);
  1104. /* Release key when task is processed */
  1105. rspamd_mempool_add_destructor (task->task_pool,
  1106. dkim_module_key_dtor, cur->key);
  1107. }
  1108. else {
  1109. if (!rspamd_get_dkim_key (ctx,
  1110. task,
  1111. dkim_module_key_handler,
  1112. cur)) {
  1113. continue;
  1114. }
  1115. }
  1116. }
  1117. checked ++;
  1118. if (checked > dkim_module_ctx->max_sigs) {
  1119. msg_info_task ("message has multiple signatures but we"
  1120. " stopped after %d checked signatures as limit"
  1121. " is reached", checked);
  1122. break;
  1123. }
  1124. }
  1125. }
  1126. else {
  1127. rspamd_task_insert_result (task,
  1128. dkim_module_ctx->symbol_na,
  1129. 1.0,
  1130. NULL);
  1131. }
  1132. if (res != NULL) {
  1133. dkim_module_check (res);
  1134. }
  1135. rspamd_symcache_item_async_dec_check (task, item, M);
  1136. }
  1137. struct rspamd_dkim_lua_verify_cbdata {
  1138. rspamd_dkim_context_t *ctx;
  1139. struct rspamd_task *task;
  1140. lua_State *L;
  1141. rspamd_dkim_key_t *key;
  1142. gint cbref;
  1143. };
  1144. static void
  1145. dkim_module_lua_push_verify_result (struct rspamd_dkim_lua_verify_cbdata *cbd,
  1146. struct rspamd_dkim_check_result *res, GError *err)
  1147. {
  1148. struct rspamd_task **ptask, *task;
  1149. const gchar *error_str = "unknown error";
  1150. gboolean success = FALSE;
  1151. task = cbd->task;
  1152. switch (res->rcode) {
  1153. case DKIM_CONTINUE:
  1154. error_str = NULL;
  1155. success = TRUE;
  1156. break;
  1157. case DKIM_REJECT:
  1158. if (err) {
  1159. error_str = err->message;
  1160. }
  1161. else {
  1162. error_str = "reject";
  1163. }
  1164. break;
  1165. case DKIM_TRYAGAIN:
  1166. if (err) {
  1167. error_str = err->message;
  1168. }
  1169. else {
  1170. error_str = "tempfail";
  1171. }
  1172. break;
  1173. case DKIM_NOTFOUND:
  1174. if (err) {
  1175. error_str = err->message;
  1176. }
  1177. else {
  1178. error_str = "not found";
  1179. }
  1180. break;
  1181. case DKIM_RECORD_ERROR:
  1182. if (err) {
  1183. error_str = err->message;
  1184. }
  1185. else {
  1186. error_str = "bad record";
  1187. }
  1188. break;
  1189. case DKIM_PERM_ERROR:
  1190. if (err) {
  1191. error_str = err->message;
  1192. }
  1193. else {
  1194. error_str = "permanent error";
  1195. }
  1196. break;
  1197. default:
  1198. break;
  1199. }
  1200. lua_rawgeti (cbd->L, LUA_REGISTRYINDEX, cbd->cbref);
  1201. ptask = lua_newuserdata (cbd->L, sizeof (*ptask));
  1202. *ptask = task;
  1203. lua_pushboolean (cbd->L, success);
  1204. if (error_str) {
  1205. lua_pushstring (cbd->L, error_str);
  1206. }
  1207. else {
  1208. lua_pushnil (cbd->L);
  1209. }
  1210. if (cbd->ctx) {
  1211. if (res->domain) {
  1212. lua_pushstring (cbd->L, res->domain);
  1213. }
  1214. else {
  1215. lua_pushnil (cbd->L);
  1216. }
  1217. if (res->selector) {
  1218. lua_pushstring (cbd->L, res->selector);
  1219. }
  1220. else {
  1221. lua_pushnil (cbd->L);
  1222. }
  1223. if (res->short_b) {
  1224. lua_pushstring (cbd->L, res->short_b);
  1225. }
  1226. else {
  1227. lua_pushnil (cbd->L);
  1228. }
  1229. if (res->fail_reason) {
  1230. lua_pushstring (cbd->L, res->fail_reason);
  1231. }
  1232. else {
  1233. lua_pushnil (cbd->L);
  1234. }
  1235. }
  1236. else {
  1237. lua_pushnil (cbd->L);
  1238. lua_pushnil (cbd->L);
  1239. lua_pushnil (cbd->L);
  1240. lua_pushnil (cbd->L);
  1241. }
  1242. if (lua_pcall (cbd->L, 7, 0, 0) != 0) {
  1243. msg_err_task ("call to verify callback failed: %s",
  1244. lua_tostring (cbd->L, -1));
  1245. lua_pop (cbd->L, 1);
  1246. }
  1247. luaL_unref (cbd->L, LUA_REGISTRYINDEX, cbd->cbref);
  1248. }
  1249. static void
  1250. dkim_module_lua_on_key (rspamd_dkim_key_t *key,
  1251. gsize keylen,
  1252. rspamd_dkim_context_t *ctx,
  1253. gpointer ud,
  1254. GError *err)
  1255. {
  1256. struct rspamd_dkim_lua_verify_cbdata *cbd = ud;
  1257. struct rspamd_task *task;
  1258. struct rspamd_dkim_check_result *res;
  1259. struct dkim_ctx *dkim_module_ctx;
  1260. task = cbd->task;
  1261. dkim_module_ctx = dkim_get_context (task->cfg);
  1262. if (key != NULL) {
  1263. /* Another ref belongs to the check context */
  1264. cbd->key = rspamd_dkim_key_ref (key);
  1265. /*
  1266. * We actually receive key with refcount = 1, so we just assume that
  1267. * lru hash owns this object now
  1268. */
  1269. if (dkim_module_ctx->dkim_hash) {
  1270. rspamd_lru_hash_insert (dkim_module_ctx->dkim_hash,
  1271. g_strdup (rspamd_dkim_get_dns_key (ctx)),
  1272. key, cbd->task->task_timestamp, rspamd_dkim_key_get_ttl (key));
  1273. }
  1274. /* Release key when task is processed */
  1275. rspamd_mempool_add_destructor (cbd->task->task_pool,
  1276. dkim_module_key_dtor, cbd->key);
  1277. }
  1278. else {
  1279. /* Insert tempfail symbol */
  1280. msg_info_task ("cannot get key for domain %s: %e",
  1281. rspamd_dkim_get_dns_key (ctx), err);
  1282. if (err != NULL) {
  1283. if (err->code == DKIM_SIGERROR_NOKEY) {
  1284. res = rspamd_dkim_create_result (ctx, DKIM_TRYAGAIN, task);
  1285. res->fail_reason = "DNS error when getting key";
  1286. }
  1287. else {
  1288. res = rspamd_dkim_create_result (ctx, DKIM_PERM_ERROR, task);
  1289. res->fail_reason = "invalid DKIM record";
  1290. }
  1291. }
  1292. else {
  1293. res = rspamd_dkim_create_result (ctx, DKIM_TRYAGAIN, task);
  1294. res->fail_reason = "DNS error when getting key";
  1295. }
  1296. dkim_module_lua_push_verify_result (cbd, res, err);
  1297. if (err) {
  1298. g_error_free (err);
  1299. }
  1300. return;
  1301. }
  1302. res = rspamd_dkim_check (cbd->ctx, cbd->key, cbd->task);
  1303. dkim_module_lua_push_verify_result (cbd, res, NULL);
  1304. }
  1305. static gint
  1306. lua_dkim_verify_handler (lua_State *L)
  1307. {
  1308. struct rspamd_task *task = lua_check_task (L, 1);
  1309. const gchar *sig = luaL_checkstring (L, 2);
  1310. rspamd_dkim_context_t *ctx;
  1311. struct rspamd_dkim_lua_verify_cbdata *cbd;
  1312. rspamd_dkim_key_t *key;
  1313. struct rspamd_dkim_check_result *ret;
  1314. GError *err = NULL;
  1315. const gchar *type_str = NULL;
  1316. enum rspamd_dkim_type type = RSPAMD_DKIM_NORMAL;
  1317. struct dkim_ctx *dkim_module_ctx;
  1318. if (task && sig && lua_isfunction (L, 3)) {
  1319. if (lua_isstring (L, 4)) {
  1320. type_str = lua_tostring (L, 4);
  1321. if (type_str) {
  1322. if (strcmp (type_str, "dkim") == 0) {
  1323. type = RSPAMD_DKIM_NORMAL;
  1324. }
  1325. else if (strcmp (type_str, "arc-sign") == 0) {
  1326. type = RSPAMD_DKIM_ARC_SIG;
  1327. }
  1328. else if (strcmp (type_str, "arc-seal") == 0) {
  1329. type = RSPAMD_DKIM_ARC_SEAL;
  1330. }
  1331. else {
  1332. lua_settop (L, 0);
  1333. return luaL_error (L, "unknown sign type: %s",
  1334. type_str);
  1335. }
  1336. }
  1337. }
  1338. dkim_module_ctx = dkim_get_context (task->cfg);
  1339. ctx = rspamd_create_dkim_context (sig,
  1340. task->task_pool,
  1341. task->resolver,
  1342. dkim_module_ctx->time_jitter,
  1343. type,
  1344. &err);
  1345. if (ctx == NULL) {
  1346. lua_pushboolean (L, false);
  1347. if (err) {
  1348. lua_pushstring (L, err->message);
  1349. g_error_free (err);
  1350. }
  1351. else {
  1352. lua_pushstring (L, "unknown error");
  1353. }
  1354. return 2;
  1355. }
  1356. cbd = rspamd_mempool_alloc (task->task_pool, sizeof (*cbd));
  1357. cbd->L = L;
  1358. cbd->task = task;
  1359. lua_pushvalue (L, 3);
  1360. cbd->cbref = luaL_ref (L, LUA_REGISTRYINDEX);
  1361. cbd->ctx = ctx;
  1362. cbd->key = NULL;
  1363. if (dkim_module_ctx->dkim_hash) {
  1364. key = rspamd_lru_hash_lookup (dkim_module_ctx->dkim_hash,
  1365. rspamd_dkim_get_dns_key (ctx),
  1366. task->task_timestamp);
  1367. }
  1368. else {
  1369. key = NULL;
  1370. }
  1371. if (key != NULL) {
  1372. cbd->key = rspamd_dkim_key_ref (key);
  1373. /* Release key when task is processed */
  1374. rspamd_mempool_add_destructor (task->task_pool,
  1375. dkim_module_key_dtor, cbd->key);
  1376. ret = rspamd_dkim_check (cbd->ctx, cbd->key, cbd->task);
  1377. dkim_module_lua_push_verify_result (cbd, ret, NULL);
  1378. }
  1379. else {
  1380. rspamd_get_dkim_key (ctx,
  1381. task,
  1382. dkim_module_lua_on_key,
  1383. cbd);
  1384. }
  1385. }
  1386. else {
  1387. return luaL_error (L, "invalid arguments");
  1388. }
  1389. lua_pushboolean (L, TRUE);
  1390. lua_pushnil (L);
  1391. return 2;
  1392. }
  1393. static gint
  1394. lua_dkim_canonicalize_handler (lua_State *L)
  1395. {
  1396. gsize nlen, vlen;
  1397. const gchar *hname = luaL_checklstring (L, 1, &nlen),
  1398. *hvalue = luaL_checklstring (L, 2, &vlen);
  1399. static gchar st_buf[8192];
  1400. gchar *buf;
  1401. guint inlen;
  1402. gboolean allocated = FALSE;
  1403. goffset r;
  1404. if (hname && hvalue && nlen > 0) {
  1405. inlen = nlen + vlen + sizeof (":" CRLF);
  1406. if (inlen > sizeof (st_buf)) {
  1407. buf = g_malloc (inlen);
  1408. allocated = TRUE;
  1409. }
  1410. else {
  1411. /* Faster */
  1412. buf = st_buf;
  1413. }
  1414. r = rspamd_dkim_canonize_header_relaxed_str (hname, hvalue, buf, inlen);
  1415. if (r == -1) {
  1416. lua_pushnil (L);
  1417. }
  1418. else {
  1419. lua_pushlstring (L, buf, r);
  1420. }
  1421. if (allocated) {
  1422. g_free (buf);
  1423. }
  1424. }
  1425. else {
  1426. return luaL_error (L, "invalid arguments");
  1427. }
  1428. return 1;
  1429. }