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

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616
  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);
  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)
  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. }
  435. else {
  436. got_trusted = TRUE;
  437. }
  438. }
  439. if ((value =
  440. rspamd_config_get_module_opt (cfg, "dkim",
  441. "strict_multiplier")) != NULL) {
  442. dkim_module_ctx->strict_multiplier = ucl_object_toint (value);
  443. }
  444. else {
  445. dkim_module_ctx->strict_multiplier = 1;
  446. }
  447. if ((value =
  448. rspamd_config_get_module_opt (cfg, "dkim", "trusted_only")) != NULL) {
  449. dkim_module_ctx->trusted_only = ucl_object_toboolean (value);
  450. }
  451. else {
  452. dkim_module_ctx->trusted_only = FALSE;
  453. }
  454. if ((value =
  455. rspamd_config_get_module_opt (cfg, "dkim", "sign_headers")) != NULL) {
  456. dkim_module_ctx->sign_headers = ucl_object_tostring (value);
  457. }
  458. if ((value =
  459. rspamd_config_get_module_opt (cfg, "arc", "sign_headers")) != NULL) {
  460. dkim_module_ctx->arc_sign_headers = ucl_object_tostring (value);
  461. }
  462. if (cache_size > 0) {
  463. dkim_module_ctx->dkim_hash = rspamd_lru_hash_new (
  464. cache_size,
  465. g_free,
  466. dkim_module_key_dtor);
  467. rspamd_mempool_add_destructor (cfg->cfg_pool,
  468. (rspamd_mempool_destruct_t)rspamd_lru_hash_destroy,
  469. dkim_module_ctx->dkim_hash);
  470. }
  471. if (sign_cache_size > 0) {
  472. dkim_module_ctx->dkim_sign_hash = rspamd_lru_hash_new (
  473. sign_cache_size,
  474. g_free,
  475. (GDestroyNotify) rspamd_dkim_sign_key_unref);
  476. rspamd_mempool_add_destructor (cfg->cfg_pool,
  477. (rspamd_mempool_destruct_t)rspamd_lru_hash_destroy,
  478. dkim_module_ctx->dkim_sign_hash);
  479. }
  480. if (dkim_module_ctx->trusted_only && !got_trusted) {
  481. msg_err_config (
  482. "trusted_only option is set and no trusted domains are defined; disabling dkim module completely as it is useless in this case");
  483. }
  484. else {
  485. if (!rspamd_config_is_module_enabled (cfg, "dkim")) {
  486. return TRUE;
  487. }
  488. cb_id = rspamd_symcache_add_symbol (cfg->cache,
  489. "DKIM_CHECK",
  490. 0,
  491. dkim_symbol_callback,
  492. NULL,
  493. SYMBOL_TYPE_CALLBACK,
  494. -1);
  495. rspamd_config_add_symbol (cfg,
  496. "DKIM_CHECK",
  497. 0.0,
  498. "DKIM check callback",
  499. "policies",
  500. RSPAMD_SYMBOL_FLAG_IGNORE_METRIC,
  501. 1,
  502. 1);
  503. rspamd_config_add_symbol_group (cfg, "DKIM_CHECK", "dkim");
  504. rspamd_symcache_add_symbol (cfg->cache,
  505. dkim_module_ctx->symbol_reject,
  506. 0,
  507. NULL,
  508. NULL,
  509. SYMBOL_TYPE_VIRTUAL | SYMBOL_TYPE_FINE,
  510. cb_id);
  511. rspamd_symcache_add_symbol (cfg->cache,
  512. dkim_module_ctx->symbol_na,
  513. 0,
  514. NULL, NULL,
  515. SYMBOL_TYPE_VIRTUAL | SYMBOL_TYPE_FINE,
  516. cb_id);
  517. rspamd_symcache_add_symbol (cfg->cache,
  518. dkim_module_ctx->symbol_permfail,
  519. 0,
  520. NULL, NULL,
  521. SYMBOL_TYPE_VIRTUAL | SYMBOL_TYPE_FINE,
  522. cb_id);
  523. rspamd_symcache_add_symbol (cfg->cache,
  524. dkim_module_ctx->symbol_tempfail,
  525. 0,
  526. NULL, NULL,
  527. SYMBOL_TYPE_VIRTUAL | SYMBOL_TYPE_FINE,
  528. cb_id);
  529. rspamd_symcache_add_symbol (cfg->cache,
  530. dkim_module_ctx->symbol_allow,
  531. 0,
  532. NULL, NULL,
  533. SYMBOL_TYPE_VIRTUAL | SYMBOL_TYPE_FINE,
  534. cb_id);
  535. rspamd_symcache_add_symbol (cfg->cache,
  536. "DKIM_TRACE",
  537. 0,
  538. NULL, NULL,
  539. SYMBOL_TYPE_VIRTUAL | SYMBOL_TYPE_NOSTAT,
  540. cb_id);
  541. rspamd_config_add_symbol (cfg,
  542. "DKIM_TRACE",
  543. 0.0,
  544. "DKIM trace symbol",
  545. "policies",
  546. RSPAMD_SYMBOL_FLAG_IGNORE_METRIC,
  547. 1,
  548. 1);
  549. rspamd_config_add_symbol_group (cfg, "DKIM_TRACE", "dkim");
  550. msg_info_config ("init internal dkim module");
  551. #ifndef HAVE_OPENSSL
  552. msg_warn_config (
  553. "openssl is not found so dkim rsa check is disabled, only check body hash, it is NOT safe to trust these results");
  554. #endif
  555. }
  556. return res;
  557. }
  558. /**
  559. * Grab a private key from the cache
  560. * or from the key content provided
  561. */
  562. rspamd_dkim_sign_key_t *
  563. dkim_module_load_key_format (struct rspamd_task *task,
  564. struct dkim_ctx *dkim_module_ctx,
  565. const gchar *key, gsize keylen,
  566. enum rspamd_dkim_key_format key_format)
  567. {
  568. guchar h[rspamd_cryptobox_HASHBYTES],
  569. hex_hash[rspamd_cryptobox_HASHBYTES * 2 + 1];
  570. rspamd_dkim_sign_key_t *ret = NULL;
  571. GError *err = NULL;
  572. struct stat st;
  573. memset (hex_hash, 0, sizeof (hex_hash));
  574. rspamd_cryptobox_hash (h, key, keylen, NULL, 0);
  575. rspamd_encode_hex_buf (h, sizeof (h), hex_hash, sizeof (hex_hash));
  576. if (dkim_module_ctx->dkim_sign_hash) {
  577. ret = rspamd_lru_hash_lookup (dkim_module_ctx->dkim_sign_hash,
  578. hex_hash, time (NULL));
  579. }
  580. /*
  581. * This fails for paths that are also valid base64.
  582. * Maybe the caller should have specified a format.
  583. */
  584. if (key_format == RSPAMD_DKIM_KEY_UNKNOWN) {
  585. if (key[0] == '.' || key[0] == '/') {
  586. if (!rspamd_cryptobox_base64_is_valid (key, keylen)) {
  587. key_format = RSPAMD_DKIM_KEY_FILE;
  588. }
  589. }
  590. else if (rspamd_cryptobox_base64_is_valid (key, keylen)) {
  591. key_format = RSPAMD_DKIM_KEY_BASE64;
  592. }
  593. }
  594. if (ret != NULL && key_format == RSPAMD_DKIM_KEY_FILE) {
  595. msg_debug_task("checking for stale file key");
  596. if (stat (key, &st) != 0) {
  597. msg_err_task("cannot stat key file: %s", strerror (errno));
  598. return NULL;
  599. }
  600. if (rspamd_dkim_sign_key_maybe_invalidate (ret, st.st_mtime)) {
  601. msg_debug_task("removing stale file key");
  602. /*
  603. * Invalidate DKIM key
  604. * removal from lru cache also cleanup the key and value
  605. */
  606. if (dkim_module_ctx->dkim_sign_hash) {
  607. rspamd_lru_hash_remove (dkim_module_ctx->dkim_sign_hash,
  608. hex_hash);
  609. }
  610. ret = NULL;
  611. }
  612. }
  613. /* found key; done */
  614. if (ret != NULL) {
  615. return ret;
  616. }
  617. ret = rspamd_dkim_sign_key_load (key, keylen, key_format, &err);
  618. if (ret == NULL) {
  619. msg_err_task ("cannot load dkim key %s: %e",
  620. key, err);
  621. g_error_free (err);
  622. }
  623. else if (dkim_module_ctx->dkim_sign_hash) {
  624. rspamd_lru_hash_insert (dkim_module_ctx->dkim_sign_hash,
  625. g_strdup (hex_hash), ret, time (NULL), 0);
  626. }
  627. return ret;
  628. }
  629. static gint
  630. lua_dkim_sign_handler (lua_State *L)
  631. {
  632. struct rspamd_task *task = lua_check_task (L, 1);
  633. gint64 arc_idx = 0, expire = 0;
  634. enum rspamd_dkim_type sign_type = RSPAMD_DKIM_NORMAL;
  635. GError *err = NULL;
  636. GString *hdr;
  637. GList *sigs = NULL;
  638. const gchar *selector = NULL, *domain = NULL, *key = NULL, *rawkey = NULL,
  639. *headers = NULL, *sign_type_str = NULL, *arc_cv = NULL,
  640. *pubkey = NULL;
  641. rspamd_dkim_sign_context_t *ctx;
  642. rspamd_dkim_sign_key_t *dkim_key;
  643. gsize rawlen = 0, keylen = 0;
  644. gboolean no_cache = FALSE, strict_pubkey_check = FALSE;
  645. struct dkim_ctx *dkim_module_ctx;
  646. luaL_argcheck (L, lua_type (L, 2) == LUA_TTABLE, 2, "'table' expected");
  647. /*
  648. * Get the following elements:
  649. * - selector
  650. * - domain
  651. * - key
  652. */
  653. if (!rspamd_lua_parse_table_arguments (L, 2, &err,
  654. RSPAMD_LUA_PARSE_ARGUMENTS_DEFAULT,
  655. "key=V;rawkey=V;*domain=S;*selector=S;no_cache=B;headers=S;"
  656. "sign_type=S;arc_idx=I;arc_cv=S;expire=I;pubkey=S;"
  657. "strict_pubkey_check=B",
  658. &keylen, &key, &rawlen, &rawkey, &domain,
  659. &selector, &no_cache, &headers,
  660. &sign_type_str, &arc_idx, &arc_cv, &expire, &pubkey,
  661. &strict_pubkey_check)) {
  662. msg_err_task ("cannot parse table arguments: %e",
  663. err);
  664. g_error_free (err);
  665. lua_pushboolean (L, FALSE);
  666. return 1;
  667. }
  668. dkim_module_ctx = dkim_get_context (task->cfg);
  669. if (key) {
  670. dkim_key = dkim_module_load_key_format (task, dkim_module_ctx, key,
  671. keylen, RSPAMD_DKIM_KEY_UNKNOWN);
  672. }
  673. else if (rawkey) {
  674. dkim_key = dkim_module_load_key_format (task, dkim_module_ctx, rawkey,
  675. rawlen, RSPAMD_DKIM_KEY_UNKNOWN);
  676. }
  677. else {
  678. msg_err_task ("neither key nor rawkey are specified");
  679. lua_pushboolean (L, FALSE);
  680. return 1;
  681. }
  682. if (dkim_key == NULL) {
  683. lua_pushboolean (L, FALSE);
  684. return 1;
  685. }
  686. if (sign_type_str) {
  687. if (strcmp (sign_type_str, "dkim") == 0) {
  688. sign_type = RSPAMD_DKIM_NORMAL;
  689. if (headers == NULL) {
  690. headers = dkim_module_ctx->sign_headers;
  691. }
  692. }
  693. else if (strcmp (sign_type_str, "arc-sign") == 0) {
  694. sign_type = RSPAMD_DKIM_ARC_SIG;
  695. if (headers == NULL) {
  696. headers = dkim_module_ctx->arc_sign_headers;
  697. }
  698. if (arc_idx == 0) {
  699. lua_settop (L, 0);
  700. return luaL_error (L, "no arc idx specified");
  701. }
  702. }
  703. else if (strcmp (sign_type_str, "arc-seal") == 0) {
  704. sign_type = RSPAMD_DKIM_ARC_SEAL;
  705. if (arc_cv == NULL) {
  706. lua_settop (L, 0);
  707. return luaL_error (L, "no arc cv specified");
  708. }
  709. if (arc_idx == 0) {
  710. lua_settop (L, 0);
  711. return luaL_error (L, "no arc idx specified");
  712. }
  713. }
  714. else {
  715. lua_settop (L, 0);
  716. return luaL_error (L, "unknown sign type: %s",
  717. sign_type_str);
  718. }
  719. }
  720. else {
  721. /* Unspecified sign type, assume plain dkim */
  722. if (headers == NULL) {
  723. headers = dkim_module_ctx->sign_headers;
  724. }
  725. }
  726. if (pubkey != NULL) {
  727. /* Also check if private and public keys match */
  728. rspamd_dkim_key_t *pk;
  729. keylen = strlen (pubkey);
  730. pk = rspamd_dkim_parse_key (pubkey, &keylen, NULL);
  731. if (pk == NULL) {
  732. if (strict_pubkey_check) {
  733. msg_err_task ("cannot parse pubkey from string: %s, skip signing",
  734. pubkey);
  735. lua_pushboolean (L, FALSE);
  736. return 1;
  737. }
  738. else {
  739. msg_warn_task ("cannot parse pubkey from string: %s",
  740. pubkey);
  741. }
  742. }
  743. else {
  744. GError *te = NULL;
  745. /* We have parsed the key, so try to check keys */
  746. if (!rspamd_dkim_match_keys (pk, dkim_key, &te)) {
  747. if (strict_pubkey_check) {
  748. msg_err_task ("public key for %s/%s does not match private "
  749. "key: %e, skip signing",
  750. domain, selector, te);
  751. g_error_free (te);
  752. lua_pushboolean (L, FALSE);
  753. rspamd_dkim_key_unref (pk);
  754. return 1;
  755. }
  756. else {
  757. msg_warn_task ("public key for %s/%s does not match private "
  758. "key: %e",
  759. domain, selector, te);
  760. g_error_free (te);
  761. }
  762. }
  763. rspamd_dkim_key_unref (pk);
  764. }
  765. }
  766. ctx = rspamd_create_dkim_sign_context (task, dkim_key,
  767. DKIM_CANON_RELAXED, DKIM_CANON_RELAXED,
  768. headers, sign_type, &err);
  769. if (ctx == NULL) {
  770. msg_err_task ("cannot create sign context: %e",
  771. err);
  772. g_error_free (err);
  773. lua_pushboolean (L, FALSE);
  774. return 1;
  775. }
  776. hdr = rspamd_dkim_sign (task, selector, domain, 0,
  777. expire, arc_idx, arc_cv, ctx);
  778. if (hdr) {
  779. if (!no_cache) {
  780. sigs = rspamd_mempool_get_variable (task->task_pool, "dkim-signature");
  781. if (sigs == NULL) {
  782. sigs = g_list_append (sigs, hdr);
  783. rspamd_mempool_set_variable (task->task_pool, "dkim-signature",
  784. sigs, dkim_module_free_list);
  785. } else {
  786. sigs = g_list_append (sigs, hdr);
  787. (void)sigs;
  788. }
  789. }
  790. lua_pushboolean (L, TRUE);
  791. lua_pushlstring (L, hdr->str, hdr->len);
  792. if (no_cache) {
  793. g_string_free (hdr, TRUE);
  794. }
  795. return 2;
  796. }
  797. lua_pushboolean (L, FALSE);
  798. lua_pushnil (L);
  799. return 2;
  800. }
  801. gint
  802. dkim_module_reconfig (struct rspamd_config *cfg)
  803. {
  804. return dkim_module_config (cfg);
  805. }
  806. /*
  807. * Parse strict value for domain in format: 'reject_multiplier:deny_multiplier'
  808. */
  809. static gboolean
  810. dkim_module_parse_strict (const gchar *value, gdouble *allow, gdouble *deny)
  811. {
  812. const gchar *colon;
  813. gchar *err = NULL;
  814. gdouble val;
  815. gchar numbuf[64];
  816. colon = strchr (value, ':');
  817. if (colon) {
  818. rspamd_strlcpy (numbuf, value,
  819. MIN (sizeof (numbuf), (colon - value) + 1));
  820. val = strtod (numbuf, &err);
  821. if (err == NULL || *err == '\0') {
  822. *deny = val;
  823. colon++;
  824. rspamd_strlcpy (numbuf, colon, sizeof (numbuf));
  825. err = NULL;
  826. val = strtod (numbuf, &err);
  827. if (err == NULL || *err == '\0') {
  828. *allow = val;
  829. return TRUE;
  830. }
  831. }
  832. }
  833. return FALSE;
  834. }
  835. static void
  836. dkim_module_check (struct dkim_check_result *res)
  837. {
  838. gboolean all_done = TRUE;
  839. const gchar *strict_value;
  840. struct dkim_check_result *first, *cur = NULL;
  841. struct dkim_ctx *dkim_module_ctx = dkim_get_context (res->task->cfg);
  842. struct rspamd_task *task = res->task;
  843. first = res->first;
  844. DL_FOREACH (first, cur) {
  845. if (cur->ctx == NULL) {
  846. continue;
  847. }
  848. if (cur->key != NULL && cur->res == NULL) {
  849. cur->res = rspamd_dkim_check (cur->ctx, cur->key, task);
  850. if (dkim_module_ctx->dkim_domains != NULL) {
  851. /* Perform strict check */
  852. const gchar *domain = rspamd_dkim_get_domain (cur->ctx);
  853. if ((strict_value =
  854. rspamd_match_hash_map (dkim_module_ctx->dkim_domains,
  855. domain,
  856. strlen (domain))) != NULL) {
  857. if (!dkim_module_parse_strict (strict_value, &cur->mult_allow,
  858. &cur->mult_deny)) {
  859. cur->mult_allow = dkim_module_ctx->strict_multiplier;
  860. cur->mult_deny = dkim_module_ctx->strict_multiplier;
  861. }
  862. }
  863. }
  864. }
  865. }
  866. DL_FOREACH (first, cur) {
  867. if (cur->ctx == NULL) {
  868. continue;
  869. }
  870. if (cur->res == NULL) {
  871. /* Still need a key */
  872. all_done = FALSE;
  873. }
  874. }
  875. if (all_done) {
  876. /* Create zero terminated array of results */
  877. struct rspamd_dkim_check_result **pres;
  878. guint nres = 0, i = 0;
  879. DL_FOREACH (first, cur) {
  880. if (cur->ctx == NULL || cur->res == NULL) {
  881. continue;
  882. }
  883. nres ++;
  884. }
  885. pres = rspamd_mempool_alloc (task->task_pool, sizeof (*pres) * (nres + 1));
  886. pres[nres] = NULL;
  887. DL_FOREACH (first, cur) {
  888. const gchar *symbol = NULL, *trace = NULL;
  889. gdouble symbol_weight = 1.0;
  890. if (cur->ctx == NULL || cur->res == NULL) {
  891. continue;
  892. }
  893. pres[i++] = cur->res;
  894. if (cur->res->rcode == DKIM_REJECT) {
  895. symbol = dkim_module_ctx->symbol_reject;
  896. trace = "-";
  897. symbol_weight = cur->mult_deny * 1.0;
  898. }
  899. else if (cur->res->rcode == DKIM_CONTINUE) {
  900. symbol = dkim_module_ctx->symbol_allow;
  901. trace = "+";
  902. symbol_weight = cur->mult_allow * 1.0;
  903. }
  904. else if (cur->res->rcode == DKIM_PERM_ERROR) {
  905. trace = "~";
  906. symbol = dkim_module_ctx->symbol_permfail;
  907. }
  908. else if (cur->res->rcode == DKIM_TRYAGAIN) {
  909. trace = "?";
  910. symbol = dkim_module_ctx->symbol_tempfail;
  911. }
  912. if (symbol != NULL) {
  913. const gchar *domain = rspamd_dkim_get_domain (cur->ctx);
  914. const gchar *selector = rspamd_dkim_get_selector (cur->ctx);
  915. gsize tracelen;
  916. gchar *tracebuf;
  917. tracelen = strlen (domain) + strlen (selector) + 4;
  918. tracebuf = rspamd_mempool_alloc (task->task_pool,
  919. tracelen);
  920. rspamd_snprintf (tracebuf, tracelen, "%s:%s", domain, trace);
  921. rspamd_task_insert_result (cur->task,
  922. "DKIM_TRACE",
  923. 0.0,
  924. tracebuf);
  925. rspamd_snprintf (tracebuf, tracelen, "%s:s=%s", domain, selector);
  926. rspamd_task_insert_result (task,
  927. symbol,
  928. symbol_weight,
  929. tracebuf);
  930. }
  931. }
  932. rspamd_mempool_set_variable (task->task_pool,
  933. RSPAMD_MEMPOOL_DKIM_CHECK_RESULTS,
  934. pres, NULL);
  935. }
  936. }
  937. static void
  938. dkim_module_key_handler (rspamd_dkim_key_t *key,
  939. gsize keylen,
  940. rspamd_dkim_context_t *ctx,
  941. gpointer ud,
  942. GError *err)
  943. {
  944. struct dkim_check_result *res = ud;
  945. struct rspamd_task *task;
  946. struct dkim_ctx *dkim_module_ctx;
  947. task = res->task;
  948. dkim_module_ctx = dkim_get_context (task->cfg);
  949. if (key != NULL) {
  950. /* Another ref belongs to the check context */
  951. res->key = rspamd_dkim_key_ref (key);
  952. /*
  953. * We actually receive key with refcount = 1, so we just assume that
  954. * lru hash owns this object now
  955. */
  956. /* Release key when task is processed */
  957. rspamd_mempool_add_destructor (res->task->task_pool,
  958. dkim_module_key_dtor, res->key);
  959. if (dkim_module_ctx->dkim_hash) {
  960. rspamd_lru_hash_insert (dkim_module_ctx->dkim_hash,
  961. g_strdup (rspamd_dkim_get_dns_key (ctx)),
  962. key, res->task->task_timestamp, rspamd_dkim_key_get_ttl (key));
  963. msg_info_task ("stored DKIM key for %s in LRU cache for %d seconds, "
  964. "%d/%d elements in the cache",
  965. rspamd_dkim_get_dns_key (ctx),
  966. rspamd_dkim_key_get_ttl (key),
  967. rspamd_lru_hash_size (dkim_module_ctx->dkim_hash),
  968. rspamd_lru_hash_capacity (dkim_module_ctx->dkim_hash));
  969. }
  970. }
  971. else {
  972. /* Insert tempfail symbol */
  973. msg_info_task ("cannot get key for domain %s: %e",
  974. rspamd_dkim_get_dns_key (ctx), err);
  975. if (err != NULL) {
  976. if (err->code == DKIM_SIGERROR_NOKEY) {
  977. res->res = rspamd_dkim_create_result (ctx, DKIM_TRYAGAIN, task);
  978. res->res->fail_reason = "DNS error when getting key";
  979. }
  980. else {
  981. res->res = rspamd_dkim_create_result (ctx, DKIM_PERM_ERROR, task);
  982. res->res->fail_reason = "invalid DKIM record";
  983. }
  984. }
  985. }
  986. if (err) {
  987. g_error_free (err);
  988. }
  989. dkim_module_check (res);
  990. }
  991. static void
  992. dkim_symbol_callback (struct rspamd_task *task,
  993. struct rspamd_symcache_item *item,
  994. void *unused)
  995. {
  996. rspamd_dkim_context_t *ctx;
  997. rspamd_dkim_key_t *key;
  998. GError *err = NULL;
  999. struct rspamd_mime_header *rh, *rh_cur;
  1000. struct dkim_check_result *res = NULL, *cur;
  1001. guint checked = 0;
  1002. gdouble *dmarc_checks;
  1003. struct dkim_ctx *dkim_module_ctx = dkim_get_context (task->cfg);
  1004. /* Allow dmarc */
  1005. dmarc_checks = rspamd_mempool_get_variable (task->task_pool,
  1006. RSPAMD_MEMPOOL_DMARC_CHECKS);
  1007. if (dmarc_checks) {
  1008. (*dmarc_checks) ++;
  1009. }
  1010. else {
  1011. dmarc_checks = rspamd_mempool_alloc (task->task_pool,
  1012. sizeof (*dmarc_checks));
  1013. *dmarc_checks = 1;
  1014. rspamd_mempool_set_variable (task->task_pool,
  1015. RSPAMD_MEMPOOL_DMARC_CHECKS,
  1016. dmarc_checks, NULL);
  1017. }
  1018. /* First check if plugin should be enabled */
  1019. if ((!dkim_module_ctx->check_authed && task->user != NULL)
  1020. || (!dkim_module_ctx->check_local &&
  1021. rspamd_ip_is_local_cfg (task->cfg, task->from_addr))) {
  1022. msg_info_task ("skip DKIM checks for local networks and authorized users");
  1023. rspamd_symcache_finalize_item (task, item);
  1024. return;
  1025. }
  1026. /* Check whitelist */
  1027. if (rspamd_match_radix_map_addr (dkim_module_ctx->whitelist_ip,
  1028. task->from_addr) != NULL) {
  1029. msg_info_task ("skip DKIM checks for whitelisted address");
  1030. rspamd_symcache_finalize_item (task, item);
  1031. return;
  1032. }
  1033. rspamd_symcache_item_async_inc (task, item, M);
  1034. /* Now check if a message has its signature */
  1035. rh = rspamd_message_get_header_array (task, RSPAMD_DKIM_SIGNHEADER);
  1036. if (rh) {
  1037. msg_debug_task ("dkim signature found");
  1038. DL_FOREACH (rh, rh_cur) {
  1039. if (rh_cur->decoded == NULL || rh_cur->decoded[0] == '\0') {
  1040. msg_info_task ("cannot load empty DKIM signature");
  1041. continue;
  1042. }
  1043. cur = rspamd_mempool_alloc0 (task->task_pool, sizeof (*cur));
  1044. cur->first = res;
  1045. cur->res = NULL;
  1046. cur->task = task;
  1047. cur->mult_allow = 1.0;
  1048. cur->mult_deny = 1.0;
  1049. cur->item = item;
  1050. ctx = rspamd_create_dkim_context (rh_cur->decoded,
  1051. task->task_pool,
  1052. task->resolver,
  1053. dkim_module_ctx->time_jitter,
  1054. RSPAMD_DKIM_NORMAL,
  1055. &err);
  1056. if (res == NULL) {
  1057. res = cur;
  1058. res->first = res;
  1059. res->prev = res;
  1060. }
  1061. else {
  1062. DL_APPEND (res, cur);
  1063. }
  1064. if (ctx == NULL) {
  1065. if (err != NULL) {
  1066. msg_info_task ("cannot parse DKIM signature: %e",
  1067. err);
  1068. g_error_free (err);
  1069. err = NULL;
  1070. }
  1071. else {
  1072. msg_info_task ("cannot parse DKIM signature: "
  1073. "unknown error");
  1074. }
  1075. continue;
  1076. }
  1077. else {
  1078. /* Get key */
  1079. cur->ctx = ctx;
  1080. const gchar *domain = rspamd_dkim_get_domain (cur->ctx);
  1081. if (dkim_module_ctx->trusted_only &&
  1082. (dkim_module_ctx->dkim_domains == NULL ||
  1083. rspamd_match_hash_map (dkim_module_ctx->dkim_domains,
  1084. domain, strlen (domain)) == NULL)) {
  1085. msg_debug_task ("skip dkim check for %s domain",
  1086. rspamd_dkim_get_domain (ctx));
  1087. continue;
  1088. }
  1089. if (dkim_module_ctx->dkim_hash) {
  1090. key = rspamd_lru_hash_lookup (dkim_module_ctx->dkim_hash,
  1091. rspamd_dkim_get_dns_key (ctx),
  1092. task->task_timestamp);
  1093. }
  1094. else {
  1095. key = NULL;
  1096. }
  1097. if (key != NULL) {
  1098. cur->key = rspamd_dkim_key_ref (key);
  1099. /* Release key when task is processed */
  1100. rspamd_mempool_add_destructor (task->task_pool,
  1101. dkim_module_key_dtor, cur->key);
  1102. }
  1103. else {
  1104. if (!rspamd_get_dkim_key (ctx,
  1105. task,
  1106. dkim_module_key_handler,
  1107. cur)) {
  1108. continue;
  1109. }
  1110. }
  1111. }
  1112. checked ++;
  1113. if (checked > dkim_module_ctx->max_sigs) {
  1114. msg_info_task ("message has multiple signatures but we"
  1115. " stopped after %d checked signatures as limit"
  1116. " is reached", checked);
  1117. break;
  1118. }
  1119. }
  1120. }
  1121. else {
  1122. rspamd_task_insert_result (task,
  1123. dkim_module_ctx->symbol_na,
  1124. 1.0,
  1125. NULL);
  1126. }
  1127. if (res != NULL) {
  1128. dkim_module_check (res);
  1129. }
  1130. rspamd_symcache_item_async_dec_check (task, item, M);
  1131. }
  1132. struct rspamd_dkim_lua_verify_cbdata {
  1133. rspamd_dkim_context_t *ctx;
  1134. struct rspamd_task *task;
  1135. lua_State *L;
  1136. rspamd_dkim_key_t *key;
  1137. gint cbref;
  1138. };
  1139. static void
  1140. dkim_module_lua_push_verify_result (struct rspamd_dkim_lua_verify_cbdata *cbd,
  1141. struct rspamd_dkim_check_result *res, GError *err)
  1142. {
  1143. struct rspamd_task **ptask, *task;
  1144. const gchar *error_str = "unknown error";
  1145. gboolean success = FALSE;
  1146. task = cbd->task;
  1147. switch (res->rcode) {
  1148. case DKIM_CONTINUE:
  1149. error_str = NULL;
  1150. success = TRUE;
  1151. break;
  1152. case DKIM_REJECT:
  1153. if (err) {
  1154. error_str = err->message;
  1155. }
  1156. else {
  1157. error_str = "reject";
  1158. }
  1159. break;
  1160. case DKIM_TRYAGAIN:
  1161. if (err) {
  1162. error_str = err->message;
  1163. }
  1164. else {
  1165. error_str = "tempfail";
  1166. }
  1167. break;
  1168. case DKIM_NOTFOUND:
  1169. if (err) {
  1170. error_str = err->message;
  1171. }
  1172. else {
  1173. error_str = "not found";
  1174. }
  1175. break;
  1176. case DKIM_RECORD_ERROR:
  1177. if (err) {
  1178. error_str = err->message;
  1179. }
  1180. else {
  1181. error_str = "bad record";
  1182. }
  1183. break;
  1184. case DKIM_PERM_ERROR:
  1185. if (err) {
  1186. error_str = err->message;
  1187. }
  1188. else {
  1189. error_str = "permanent error";
  1190. }
  1191. break;
  1192. default:
  1193. break;
  1194. }
  1195. lua_rawgeti (cbd->L, LUA_REGISTRYINDEX, cbd->cbref);
  1196. ptask = lua_newuserdata (cbd->L, sizeof (*ptask));
  1197. *ptask = task;
  1198. lua_pushboolean (cbd->L, success);
  1199. if (error_str) {
  1200. lua_pushstring (cbd->L, error_str);
  1201. }
  1202. else {
  1203. lua_pushnil (cbd->L);
  1204. }
  1205. if (cbd->ctx) {
  1206. if (res->domain) {
  1207. lua_pushstring (cbd->L, res->domain);
  1208. }
  1209. else {
  1210. lua_pushnil (cbd->L);
  1211. }
  1212. if (res->selector) {
  1213. lua_pushstring (cbd->L, res->selector);
  1214. }
  1215. else {
  1216. lua_pushnil (cbd->L);
  1217. }
  1218. if (res->short_b) {
  1219. lua_pushstring (cbd->L, res->short_b);
  1220. }
  1221. else {
  1222. lua_pushnil (cbd->L);
  1223. }
  1224. if (res->fail_reason) {
  1225. lua_pushstring (cbd->L, res->fail_reason);
  1226. }
  1227. else {
  1228. lua_pushnil (cbd->L);
  1229. }
  1230. }
  1231. else {
  1232. lua_pushnil (cbd->L);
  1233. lua_pushnil (cbd->L);
  1234. lua_pushnil (cbd->L);
  1235. lua_pushnil (cbd->L);
  1236. }
  1237. if (lua_pcall (cbd->L, 7, 0, 0) != 0) {
  1238. msg_err_task ("call to verify callback failed: %s",
  1239. lua_tostring (cbd->L, -1));
  1240. lua_pop (cbd->L, 1);
  1241. }
  1242. luaL_unref (cbd->L, LUA_REGISTRYINDEX, cbd->cbref);
  1243. }
  1244. static void
  1245. dkim_module_lua_on_key (rspamd_dkim_key_t *key,
  1246. gsize keylen,
  1247. rspamd_dkim_context_t *ctx,
  1248. gpointer ud,
  1249. GError *err)
  1250. {
  1251. struct rspamd_dkim_lua_verify_cbdata *cbd = ud;
  1252. struct rspamd_task *task;
  1253. struct rspamd_dkim_check_result *res;
  1254. struct dkim_ctx *dkim_module_ctx;
  1255. task = cbd->task;
  1256. dkim_module_ctx = dkim_get_context (task->cfg);
  1257. if (key != NULL) {
  1258. /* Another ref belongs to the check context */
  1259. cbd->key = rspamd_dkim_key_ref (key);
  1260. /*
  1261. * We actually receive key with refcount = 1, so we just assume that
  1262. * lru hash owns this object now
  1263. */
  1264. if (dkim_module_ctx->dkim_hash) {
  1265. rspamd_lru_hash_insert (dkim_module_ctx->dkim_hash,
  1266. g_strdup (rspamd_dkim_get_dns_key (ctx)),
  1267. key, cbd->task->task_timestamp, rspamd_dkim_key_get_ttl (key));
  1268. }
  1269. /* Release key when task is processed */
  1270. rspamd_mempool_add_destructor (cbd->task->task_pool,
  1271. dkim_module_key_dtor, cbd->key);
  1272. }
  1273. else {
  1274. /* Insert tempfail symbol */
  1275. msg_info_task ("cannot get key for domain %s: %e",
  1276. rspamd_dkim_get_dns_key (ctx), err);
  1277. if (err != NULL) {
  1278. if (err->code == DKIM_SIGERROR_NOKEY) {
  1279. res = rspamd_dkim_create_result (ctx, DKIM_TRYAGAIN, task);
  1280. res->fail_reason = "DNS error when getting key";
  1281. }
  1282. else {
  1283. res = rspamd_dkim_create_result (ctx, DKIM_PERM_ERROR, task);
  1284. res->fail_reason = "invalid DKIM record";
  1285. }
  1286. }
  1287. else {
  1288. res = rspamd_dkim_create_result (ctx, DKIM_TRYAGAIN, task);
  1289. res->fail_reason = "DNS error when getting key";
  1290. }
  1291. dkim_module_lua_push_verify_result (cbd, res, err);
  1292. if (err) {
  1293. g_error_free (err);
  1294. }
  1295. return;
  1296. }
  1297. res = rspamd_dkim_check (cbd->ctx, cbd->key, cbd->task);
  1298. dkim_module_lua_push_verify_result (cbd, res, NULL);
  1299. }
  1300. static gint
  1301. lua_dkim_verify_handler (lua_State *L)
  1302. {
  1303. struct rspamd_task *task = lua_check_task (L, 1);
  1304. const gchar *sig = luaL_checkstring (L, 2);
  1305. rspamd_dkim_context_t *ctx;
  1306. struct rspamd_dkim_lua_verify_cbdata *cbd;
  1307. rspamd_dkim_key_t *key;
  1308. struct rspamd_dkim_check_result *ret;
  1309. GError *err = NULL;
  1310. const gchar *type_str = NULL;
  1311. enum rspamd_dkim_type type = RSPAMD_DKIM_NORMAL;
  1312. struct dkim_ctx *dkim_module_ctx;
  1313. if (task && sig && lua_isfunction (L, 3)) {
  1314. if (lua_isstring (L, 4)) {
  1315. type_str = lua_tostring (L, 4);
  1316. if (type_str) {
  1317. if (strcmp (type_str, "dkim") == 0) {
  1318. type = RSPAMD_DKIM_NORMAL;
  1319. }
  1320. else if (strcmp (type_str, "arc-sign") == 0) {
  1321. type = RSPAMD_DKIM_ARC_SIG;
  1322. }
  1323. else if (strcmp (type_str, "arc-seal") == 0) {
  1324. type = RSPAMD_DKIM_ARC_SEAL;
  1325. }
  1326. else {
  1327. lua_settop (L, 0);
  1328. return luaL_error (L, "unknown sign type: %s",
  1329. type_str);
  1330. }
  1331. }
  1332. }
  1333. dkim_module_ctx = dkim_get_context (task->cfg);
  1334. ctx = rspamd_create_dkim_context (sig,
  1335. task->task_pool,
  1336. task->resolver,
  1337. dkim_module_ctx->time_jitter,
  1338. type,
  1339. &err);
  1340. if (ctx == NULL) {
  1341. lua_pushboolean (L, false);
  1342. if (err) {
  1343. lua_pushstring (L, err->message);
  1344. g_error_free (err);
  1345. }
  1346. else {
  1347. lua_pushstring (L, "unknown error");
  1348. }
  1349. return 2;
  1350. }
  1351. cbd = rspamd_mempool_alloc (task->task_pool, sizeof (*cbd));
  1352. cbd->L = L;
  1353. cbd->task = task;
  1354. lua_pushvalue (L, 3);
  1355. cbd->cbref = luaL_ref (L, LUA_REGISTRYINDEX);
  1356. cbd->ctx = ctx;
  1357. cbd->key = NULL;
  1358. if (dkim_module_ctx->dkim_hash) {
  1359. key = rspamd_lru_hash_lookup (dkim_module_ctx->dkim_hash,
  1360. rspamd_dkim_get_dns_key (ctx),
  1361. task->task_timestamp);
  1362. }
  1363. else {
  1364. key = NULL;
  1365. }
  1366. if (key != NULL) {
  1367. cbd->key = rspamd_dkim_key_ref (key);
  1368. /* Release key when task is processed */
  1369. rspamd_mempool_add_destructor (task->task_pool,
  1370. dkim_module_key_dtor, cbd->key);
  1371. ret = rspamd_dkim_check (cbd->ctx, cbd->key, cbd->task);
  1372. dkim_module_lua_push_verify_result (cbd, ret, NULL);
  1373. }
  1374. else {
  1375. rspamd_get_dkim_key (ctx,
  1376. task,
  1377. dkim_module_lua_on_key,
  1378. cbd);
  1379. }
  1380. }
  1381. else {
  1382. return luaL_error (L, "invalid arguments");
  1383. }
  1384. lua_pushboolean (L, TRUE);
  1385. lua_pushnil (L);
  1386. return 2;
  1387. }
  1388. static gint
  1389. lua_dkim_canonicalize_handler (lua_State *L)
  1390. {
  1391. gsize nlen, vlen;
  1392. const gchar *hname = luaL_checklstring (L, 1, &nlen),
  1393. *hvalue = luaL_checklstring (L, 2, &vlen);
  1394. static gchar st_buf[8192];
  1395. gchar *buf;
  1396. guint inlen;
  1397. gboolean allocated = FALSE;
  1398. goffset r;
  1399. if (hname && hvalue && nlen > 0) {
  1400. inlen = nlen + vlen + sizeof (":" CRLF);
  1401. if (inlen > sizeof (st_buf)) {
  1402. buf = g_malloc (inlen);
  1403. allocated = TRUE;
  1404. }
  1405. else {
  1406. /* Faster */
  1407. buf = st_buf;
  1408. }
  1409. r = rspamd_dkim_canonize_header_relaxed_str (hname, hvalue, buf, inlen);
  1410. if (r == -1) {
  1411. lua_pushnil (L);
  1412. }
  1413. else {
  1414. lua_pushlstring (L, buf, r);
  1415. }
  1416. if (allocated) {
  1417. g_free (buf);
  1418. }
  1419. }
  1420. else {
  1421. return luaL_error (L, "invalid arguments");
  1422. }
  1423. return 1;
  1424. }