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.

cfg_rcl.c 100KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874
  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. #include "cfg_rcl.h"
  17. #include "rspamd.h"
  18. #include "../../contrib/mumhash/mum.h"
  19. #define HASH_CASELESS
  20. #include "uthash_strcase.h"
  21. #include "utlist.h"
  22. #include "cfg_file.h"
  23. #include "lua/lua_common.h"
  24. #include "expression.h"
  25. #include "composites.h"
  26. #include "libserver/worker_util.h"
  27. #include "unix-std.h"
  28. #include "cryptobox.h"
  29. #include "libutil/multipattern.h"
  30. #include "libmime/email_addr.h"
  31. #include "libmime/lang_detection.h"
  32. #ifdef HAVE_SYSLOG_H
  33. #include <syslog.h>
  34. #endif
  35. #include <math.h>
  36. struct rspamd_rcl_default_handler_data {
  37. struct rspamd_rcl_struct_parser pd;
  38. gchar *key;
  39. rspamd_rcl_default_handler_t handler;
  40. UT_hash_handle hh;
  41. };
  42. struct rspamd_rcl_section {
  43. const gchar *name; /**< name of section */
  44. const gchar *key_attr;
  45. const gchar *default_key;
  46. rspamd_rcl_handler_t handler; /**< handler of section attributes */
  47. enum ucl_type type; /**< type of attribute */
  48. gboolean required; /**< whether this param is required */
  49. gboolean strict_type; /**< whether we need strict type */
  50. UT_hash_handle hh; /** hash handle */
  51. struct rspamd_rcl_section *subsections; /**< hash table of subsections */
  52. struct rspamd_rcl_default_handler_data *default_parser; /**< generic parsing fields */
  53. rspamd_rcl_section_fin_t fin; /** called at the end of section parsing */
  54. gpointer fin_ud;
  55. ucl_object_t *doc_ref; /**< reference to the section's documentation */
  56. };
  57. struct rspamd_worker_param_key {
  58. const gchar *name;
  59. gpointer ptr;
  60. };
  61. struct rspamd_worker_param_parser {
  62. rspamd_rcl_default_handler_t handler; /**< handler function */
  63. struct rspamd_rcl_struct_parser parser; /**< parser attributes */
  64. struct rspamd_worker_param_key key;
  65. };
  66. struct rspamd_worker_cfg_parser {
  67. GHashTable *parsers; /**< parsers hash */
  68. gint type; /**< workers quark */
  69. gboolean (*def_obj_parser)(ucl_object_t *obj, gpointer ud); /**<
  70. default object parser */
  71. gpointer def_ud;
  72. };
  73. static gboolean rspamd_rcl_process_section (struct rspamd_config *cfg,
  74. struct rspamd_rcl_section *sec,
  75. gpointer ptr, const ucl_object_t *obj, rspamd_mempool_t *pool,
  76. GError **err);
  77. /*
  78. * Common section handlers
  79. */
  80. static gboolean
  81. rspamd_rcl_logging_handler (rspamd_mempool_t *pool, const ucl_object_t *obj,
  82. const gchar *key, gpointer ud, struct rspamd_rcl_section *section,
  83. GError **err)
  84. {
  85. const ucl_object_t *val;
  86. const gchar *facility = NULL, *log_type = NULL, *log_level = NULL;
  87. struct rspamd_config *cfg = ud;
  88. val = ucl_object_lookup (obj, "type");
  89. if (val != NULL && ucl_object_tostring_safe (val, &log_type)) {
  90. if (g_ascii_strcasecmp (log_type, "file") == 0) {
  91. /* Need to get filename */
  92. val = ucl_object_lookup (obj, "filename");
  93. if (val == NULL || val->type != UCL_STRING) {
  94. g_set_error (err,
  95. CFG_RCL_ERROR,
  96. ENOENT,
  97. "filename attribute must be specified for file logging type");
  98. return FALSE;
  99. }
  100. cfg->log_type = RSPAMD_LOG_FILE;
  101. cfg->log_file = rspamd_mempool_strdup (cfg->cfg_pool,
  102. ucl_object_tostring (val));
  103. }
  104. else if (g_ascii_strcasecmp (log_type, "syslog") == 0) {
  105. /* Need to get facility */
  106. #ifdef HAVE_SYSLOG_H
  107. cfg->log_facility = LOG_DAEMON;
  108. cfg->log_type = RSPAMD_LOG_SYSLOG;
  109. val = ucl_object_lookup (obj, "facility");
  110. if (val != NULL && ucl_object_tostring_safe (val, &facility)) {
  111. if (g_ascii_strcasecmp (facility, "LOG_AUTH") == 0 ||
  112. g_ascii_strcasecmp (facility, "auth") == 0 ) {
  113. cfg->log_facility = LOG_AUTH;
  114. }
  115. else if (g_ascii_strcasecmp (facility, "LOG_CRON") == 0 ||
  116. g_ascii_strcasecmp (facility, "cron") == 0 ) {
  117. cfg->log_facility = LOG_CRON;
  118. }
  119. else if (g_ascii_strcasecmp (facility, "LOG_DAEMON") == 0 ||
  120. g_ascii_strcasecmp (facility, "daemon") == 0 ) {
  121. cfg->log_facility = LOG_DAEMON;
  122. }
  123. else if (g_ascii_strcasecmp (facility, "LOG_MAIL") == 0 ||
  124. g_ascii_strcasecmp (facility, "mail") == 0) {
  125. cfg->log_facility = LOG_MAIL;
  126. }
  127. else if (g_ascii_strcasecmp (facility, "LOG_USER") == 0 ||
  128. g_ascii_strcasecmp (facility, "user") == 0 ) {
  129. cfg->log_facility = LOG_USER;
  130. }
  131. else if (g_ascii_strcasecmp (facility, "LOG_LOCAL0") == 0 ||
  132. g_ascii_strcasecmp (facility, "local0") == 0) {
  133. cfg->log_facility = LOG_LOCAL0;
  134. }
  135. else if (g_ascii_strcasecmp (facility, "LOG_LOCAL1") == 0 ||
  136. g_ascii_strcasecmp (facility, "local1") == 0) {
  137. cfg->log_facility = LOG_LOCAL1;
  138. }
  139. else if (g_ascii_strcasecmp (facility, "LOG_LOCAL2") == 0 ||
  140. g_ascii_strcasecmp (facility, "local2") == 0) {
  141. cfg->log_facility = LOG_LOCAL2;
  142. }
  143. else if (g_ascii_strcasecmp (facility, "LOG_LOCAL3") == 0 ||
  144. g_ascii_strcasecmp (facility, "local3") == 0) {
  145. cfg->log_facility = LOG_LOCAL3;
  146. }
  147. else if (g_ascii_strcasecmp (facility, "LOG_LOCAL4") == 0 ||
  148. g_ascii_strcasecmp (facility, "local4") == 0) {
  149. cfg->log_facility = LOG_LOCAL4;
  150. }
  151. else if (g_ascii_strcasecmp (facility, "LOG_LOCAL5") == 0 ||
  152. g_ascii_strcasecmp (facility, "local5") == 0) {
  153. cfg->log_facility = LOG_LOCAL5;
  154. }
  155. else if (g_ascii_strcasecmp (facility, "LOG_LOCAL6") == 0 ||
  156. g_ascii_strcasecmp (facility, "local6") == 0) {
  157. cfg->log_facility = LOG_LOCAL6;
  158. }
  159. else if (g_ascii_strcasecmp (facility, "LOG_LOCAL7") == 0 ||
  160. g_ascii_strcasecmp (facility, "local7") == 0) {
  161. cfg->log_facility = LOG_LOCAL7;
  162. }
  163. else {
  164. g_set_error (err,
  165. CFG_RCL_ERROR,
  166. EINVAL,
  167. "invalid log facility: %s",
  168. facility);
  169. return FALSE;
  170. }
  171. }
  172. #endif
  173. }
  174. else if (g_ascii_strcasecmp (log_type,
  175. "stderr") == 0 || g_ascii_strcasecmp (log_type, "console") == 0) {
  176. cfg->log_type = RSPAMD_LOG_CONSOLE;
  177. }
  178. else {
  179. g_set_error (err,
  180. CFG_RCL_ERROR,
  181. EINVAL,
  182. "invalid log type: %s",
  183. log_type);
  184. return FALSE;
  185. }
  186. }
  187. else {
  188. /* No type specified */
  189. msg_warn_config (
  190. "logging type is not specified correctly, log output to the console");
  191. }
  192. /* Handle log level */
  193. val = ucl_object_lookup (obj, "level");
  194. if (val != NULL && ucl_object_tostring_safe (val, &log_level)) {
  195. if (g_ascii_strcasecmp (log_level, "error") == 0) {
  196. cfg->log_level = G_LOG_LEVEL_ERROR | G_LOG_LEVEL_CRITICAL;
  197. }
  198. else if (g_ascii_strcasecmp (log_level, "warning") == 0) {
  199. cfg->log_level = G_LOG_LEVEL_WARNING;
  200. }
  201. else if (g_ascii_strcasecmp (log_level, "info") == 0) {
  202. cfg->log_level = G_LOG_LEVEL_INFO | G_LOG_LEVEL_MESSAGE;
  203. }
  204. else if (g_ascii_strcasecmp (log_level, "message") == 0 ||
  205. g_ascii_strcasecmp (log_level, "notice") == 0) {
  206. cfg->log_level = G_LOG_LEVEL_MESSAGE;
  207. }
  208. else if (g_ascii_strcasecmp (log_level, "silent") == 0) {
  209. cfg->log_level = G_LOG_LEVEL_MESSAGE | G_LOG_LEVEL_INFO;
  210. cfg->log_silent_workers = TRUE;
  211. }
  212. else if (g_ascii_strcasecmp (log_level, "debug") == 0) {
  213. cfg->log_level = G_LOG_LEVEL_DEBUG;
  214. }
  215. else {
  216. g_set_error (err,
  217. CFG_RCL_ERROR,
  218. EINVAL,
  219. "invalid log level: %s",
  220. log_level);
  221. return FALSE;
  222. }
  223. }
  224. /* Handle flags */
  225. val = ucl_object_lookup_any (obj, "color", "log_color", NULL);
  226. if (val && ucl_object_toboolean (val)) {
  227. cfg->log_flags |= RSPAMD_LOG_FLAG_COLOR;
  228. }
  229. val = ucl_object_lookup_any (obj, "systemd", "log_systemd", NULL);
  230. if (val && ucl_object_toboolean (val)) {
  231. cfg->log_flags |= RSPAMD_LOG_FLAG_SYSTEMD;
  232. }
  233. val = ucl_object_lookup (obj, "log_re_cache");
  234. if (val && ucl_object_toboolean (val)) {
  235. cfg->log_flags |= RSPAMD_LOG_FLAG_RE_CACHE;
  236. }
  237. val = ucl_object_lookup_any (obj, "usec", "log_usec", NULL);
  238. if (val && ucl_object_toboolean (val)) {
  239. cfg->log_flags |= RSPAMD_LOG_FLAG_USEC;
  240. }
  241. return rspamd_rcl_section_parse_defaults (cfg, section, cfg->cfg_pool, obj,
  242. cfg, err);
  243. }
  244. static gboolean
  245. rspamd_rcl_options_handler (rspamd_mempool_t *pool, const ucl_object_t *obj,
  246. const gchar *key, gpointer ud,
  247. struct rspamd_rcl_section *section, GError **err)
  248. {
  249. const ucl_object_t *dns, *upstream, *neighbours;
  250. struct rspamd_config *cfg = ud;
  251. struct rspamd_rcl_section *dns_section, *upstream_section, *neighbours_section;
  252. HASH_FIND_STR (section->subsections, "dns", dns_section);
  253. dns = ucl_object_lookup (obj, "dns");
  254. if (dns_section != NULL && dns != NULL) {
  255. if (!rspamd_rcl_section_parse_defaults (cfg,
  256. dns_section, cfg->cfg_pool, dns,
  257. cfg, err)) {
  258. return FALSE;
  259. }
  260. }
  261. HASH_FIND_STR (section->subsections, "upstream", upstream_section);
  262. upstream = ucl_object_lookup (obj, "upstream");
  263. if (upstream_section != NULL && upstream != NULL) {
  264. if (!rspamd_rcl_section_parse_defaults (cfg,
  265. upstream_section, cfg->cfg_pool,
  266. upstream, cfg, err)) {
  267. return FALSE;
  268. }
  269. }
  270. HASH_FIND_STR (section->subsections, "neighbours", neighbours_section);
  271. neighbours = ucl_object_lookup (obj, "neighbours");
  272. if (neighbours_section != NULL && neighbours != NULL) {
  273. const ucl_object_t *cur;
  274. LL_FOREACH (neighbours, cur) {
  275. if (!rspamd_rcl_process_section (cfg, neighbours_section, cfg, cur,
  276. pool, err)) {
  277. return FALSE;
  278. }
  279. }
  280. }
  281. if (rspamd_rcl_section_parse_defaults (cfg,
  282. section, cfg->cfg_pool, obj,
  283. cfg, err)) {
  284. /* We need to init this early */
  285. rspamd_multipattern_library_init (cfg->hs_cache_dir);
  286. return TRUE;
  287. }
  288. return FALSE;
  289. }
  290. struct rspamd_rcl_symbol_data {
  291. struct rspamd_symbols_group *gr;
  292. struct rspamd_config *cfg;
  293. };
  294. static gboolean
  295. rspamd_rcl_group_handler (rspamd_mempool_t *pool, const ucl_object_t *obj,
  296. const gchar *key, gpointer ud,
  297. struct rspamd_rcl_section *section, GError **err)
  298. {
  299. struct rspamd_config *cfg = ud;
  300. struct rspamd_symbols_group *gr;
  301. const ucl_object_t *val;
  302. struct rspamd_rcl_section *subsection;
  303. struct rspamd_rcl_symbol_data sd;
  304. g_assert (key != NULL);
  305. gr = g_hash_table_lookup (cfg->groups, key);
  306. if (gr == NULL) {
  307. gr = rspamd_config_new_group (cfg, key);
  308. }
  309. if (!rspamd_rcl_section_parse_defaults (cfg, section, pool, obj,
  310. gr, err)) {
  311. return FALSE;
  312. }
  313. sd.gr = gr;
  314. sd.cfg = cfg;
  315. /* Handle symbols */
  316. val = ucl_object_lookup (obj, "symbols");
  317. if (val != NULL && ucl_object_type (val) == UCL_OBJECT) {
  318. HASH_FIND_STR (section->subsections, "symbols", subsection);
  319. g_assert (subsection != NULL);
  320. if (!rspamd_rcl_process_section (cfg, subsection, &sd, val,
  321. pool, err)) {
  322. return FALSE;
  323. }
  324. }
  325. return TRUE;
  326. }
  327. static gboolean
  328. rspamd_rcl_symbol_handler (rspamd_mempool_t *pool, const ucl_object_t *obj,
  329. const gchar *key, gpointer ud,
  330. struct rspamd_rcl_section *section, GError **err)
  331. {
  332. struct rspamd_rcl_symbol_data *sd = ud;
  333. struct rspamd_config *cfg;
  334. const ucl_object_t *elt;
  335. const gchar *description = NULL;
  336. gdouble score = 0.0;
  337. guint priority = 1, flags = 0;
  338. gint nshots;
  339. g_assert (key != NULL);
  340. cfg = sd->cfg;
  341. nshots = cfg->default_max_shots;
  342. if ((elt = ucl_object_lookup (obj, "one_shot")) != NULL) {
  343. if (ucl_object_toboolean (elt)) {
  344. nshots = 1;
  345. }
  346. }
  347. if ((elt = ucl_object_lookup (obj, "any_shot")) != NULL) {
  348. if (ucl_object_toboolean (elt)) {
  349. nshots = -1;
  350. }
  351. }
  352. if ((elt = ucl_object_lookup (obj, "one_param")) != NULL) {
  353. if (ucl_object_toboolean (elt)) {
  354. flags |= RSPAMD_SYMBOL_FLAG_ONEPARAM;
  355. }
  356. }
  357. if ((elt = ucl_object_lookup (obj, "ignore")) != NULL) {
  358. if (ucl_object_toboolean (elt)) {
  359. flags |= RSPAMD_SYMBOL_FLAG_IGNORE;
  360. }
  361. }
  362. if ((elt = ucl_object_lookup (obj, "nshots")) != NULL) {
  363. nshots = ucl_object_toint (elt);
  364. }
  365. elt = ucl_object_lookup_any (obj, "score", "weight", NULL);
  366. if (elt) {
  367. score = ucl_object_todouble (elt);
  368. }
  369. elt = ucl_object_lookup (obj, "priority");
  370. if (elt) {
  371. priority = ucl_object_toint (elt);
  372. }
  373. else {
  374. priority = ucl_object_get_priority (obj) + 1;
  375. }
  376. elt = ucl_object_lookup (obj, "description");
  377. if (elt) {
  378. description = ucl_object_tostring (elt);
  379. }
  380. if (sd->gr) {
  381. rspamd_config_add_symbol (cfg, key, score,
  382. description, sd->gr->name, flags, priority, nshots);
  383. }
  384. else {
  385. rspamd_config_add_symbol (cfg, key, score,
  386. description, NULL, flags, priority, nshots);
  387. }
  388. elt = ucl_object_lookup (obj, "groups");
  389. if (elt) {
  390. ucl_object_iter_t gr_it;
  391. const ucl_object_t *cur_gr;
  392. gr_it = ucl_object_iterate_new (elt);
  393. while ((cur_gr = ucl_object_iterate_safe (gr_it, true)) != NULL) {
  394. rspamd_config_add_symbol_group (cfg, key,
  395. ucl_object_tostring (cur_gr));
  396. }
  397. ucl_object_iterate_free (gr_it);
  398. }
  399. return TRUE;
  400. }
  401. static gboolean
  402. rspamd_rcl_actions_handler (rspamd_mempool_t *pool, const ucl_object_t *obj,
  403. const gchar *key, gpointer ud,
  404. struct rspamd_rcl_section *section, GError **err)
  405. {
  406. gdouble action_score;
  407. struct rspamd_config *cfg = ud;
  408. gint action_value;
  409. const ucl_object_t *cur;
  410. ucl_object_iter_t it;
  411. it = ucl_object_iterate_new (obj);
  412. while ((cur = ucl_object_iterate_safe (it, true)) != NULL) {
  413. if (!rspamd_action_from_str (ucl_object_key (cur), &action_value)) {
  414. continue;
  415. }
  416. else {
  417. if (ucl_object_type (cur) == UCL_NULL) {
  418. action_score = NAN;
  419. }
  420. else {
  421. if (!ucl_object_todouble_safe (cur, &action_score)) {
  422. g_set_error (err,
  423. CFG_RCL_ERROR,
  424. EINVAL,
  425. "invalid action definition: '%s'",
  426. ucl_object_key (cur));
  427. ucl_object_iterate_free (it);
  428. return FALSE;
  429. }
  430. }
  431. rspamd_config_set_action_score (cfg,
  432. ucl_object_key (cur),
  433. action_score,
  434. ucl_object_get_priority (cur));
  435. }
  436. }
  437. ucl_object_iterate_free (it);
  438. return rspamd_rcl_section_parse_defaults (cfg, section, pool, obj, cfg, err);
  439. }
  440. static gboolean
  441. rspamd_rcl_worker_handler (rspamd_mempool_t *pool, const ucl_object_t *obj,
  442. const gchar *key, gpointer ud,
  443. struct rspamd_rcl_section *section, GError **err)
  444. {
  445. const ucl_object_t *val, *cur, *cur_obj;
  446. ucl_object_t *robj;
  447. ucl_object_iter_t it = NULL;
  448. const gchar *worker_type, *worker_bind;
  449. struct rspamd_config *cfg = ud;
  450. GQuark qtype;
  451. struct rspamd_worker_conf *wrk;
  452. struct rspamd_worker_cfg_parser *wparser;
  453. struct rspamd_worker_param_parser *whandler;
  454. struct rspamd_worker_param_key srch;
  455. g_assert (key != NULL);
  456. worker_type = key;
  457. qtype = g_quark_try_string (worker_type);
  458. if (qtype != 0) {
  459. wrk = rspamd_config_new_worker (cfg, NULL);
  460. wrk->options = ucl_object_copy (obj);
  461. wrk->worker = rspamd_get_worker_by_type (cfg, qtype);
  462. if (wrk->worker == NULL) {
  463. g_set_error (err,
  464. CFG_RCL_ERROR,
  465. EINVAL,
  466. "unknown worker type: %s",
  467. worker_type);
  468. return FALSE;
  469. }
  470. wrk->type = qtype;
  471. if (wrk->worker->worker_init_func) {
  472. wrk->ctx = wrk->worker->worker_init_func (cfg);
  473. }
  474. }
  475. else {
  476. msg_err_config ("unknown worker type: %s", worker_type);
  477. return TRUE;
  478. }
  479. val = ucl_object_lookup_any (obj, "bind_socket", "listen", "bind", NULL);
  480. /* This name is more logical */
  481. if (val != NULL) {
  482. it = ucl_object_iterate_new (val);
  483. while ((cur = ucl_object_iterate_safe (it, true)) != NULL) {
  484. if (!ucl_object_tostring_safe (cur, &worker_bind)) {
  485. continue;
  486. }
  487. if (!rspamd_parse_bind_line (cfg, wrk, worker_bind)) {
  488. g_set_error (err,
  489. CFG_RCL_ERROR,
  490. EINVAL,
  491. "cannot parse bind line: %s",
  492. worker_bind);
  493. ucl_object_iterate_free (it);
  494. return FALSE;
  495. }
  496. }
  497. ucl_object_iterate_free (it);
  498. }
  499. if (!rspamd_rcl_section_parse_defaults (cfg, section, cfg->cfg_pool, obj,
  500. wrk, err)) {
  501. return FALSE;
  502. }
  503. /* Parse other attributes */
  504. wparser = g_hash_table_lookup (cfg->wrk_parsers, &qtype);
  505. if (wparser != NULL && obj->type == UCL_OBJECT) {
  506. it = ucl_object_iterate_new (obj);
  507. while ((cur = ucl_object_iterate_full (it, UCL_ITERATE_EXPLICIT)) != NULL) {
  508. srch.name = ucl_object_key (cur);
  509. srch.ptr = wrk->ctx; /* XXX: is it valid? */
  510. whandler = g_hash_table_lookup (wparser->parsers, &srch);
  511. if (whandler != NULL) {
  512. LL_FOREACH (cur, cur_obj) {
  513. if (!whandler->handler (cfg->cfg_pool,
  514. cur_obj,
  515. &whandler->parser,
  516. section,
  517. err)) {
  518. ucl_object_iterate_free (it);
  519. return FALSE;
  520. }
  521. if (!(whandler->parser.flags & RSPAMD_CL_FLAG_MULTIPLE)) {
  522. break;
  523. }
  524. }
  525. }
  526. }
  527. ucl_object_iterate_free (it);
  528. if (wparser->def_obj_parser != NULL) {
  529. robj = ucl_object_ref (obj);
  530. if (!wparser->def_obj_parser (robj, wparser->def_ud)) {
  531. ucl_object_unref (robj);
  532. return FALSE;
  533. }
  534. ucl_object_unref (robj);
  535. }
  536. }
  537. cfg->workers = g_list_prepend (cfg->workers, wrk);
  538. return TRUE;
  539. }
  540. static gboolean
  541. rspamd_rcl_lua_handler (rspamd_mempool_t *pool, const ucl_object_t *obj,
  542. const gchar *key, gpointer ud,
  543. struct rspamd_rcl_section *section, GError **err)
  544. {
  545. struct rspamd_config *cfg = ud;
  546. const gchar *lua_src = rspamd_mempool_strdup (pool,
  547. ucl_object_tostring (obj));
  548. gchar *cur_dir, *lua_dir, *lua_file, *tmp1, *tmp2;
  549. lua_State *L = cfg->lua_state;
  550. GString *tb;
  551. gint err_idx;
  552. tmp1 = g_strdup (lua_src);
  553. tmp2 = g_strdup (lua_src);
  554. lua_dir = dirname (tmp1);
  555. lua_file = basename (tmp2);
  556. if (lua_dir && lua_file) {
  557. cur_dir = g_malloc (PATH_MAX);
  558. if (getcwd (cur_dir, PATH_MAX) != NULL && chdir (lua_dir) != -1) {
  559. /* Push traceback function */
  560. lua_pushcfunction (L, &rspamd_lua_traceback);
  561. err_idx = lua_gettop (L);
  562. /* Load file */
  563. if (luaL_loadfile (L, lua_file) != 0) {
  564. g_set_error (err,
  565. CFG_RCL_ERROR,
  566. EINVAL,
  567. "cannot load lua file %s: %s",
  568. lua_src,
  569. lua_tostring (L, -1));
  570. if (chdir (cur_dir) == -1) {
  571. msg_err_config ("cannot chdir to %s: %s", cur_dir,
  572. strerror (errno));
  573. }
  574. g_free (cur_dir);
  575. g_free (tmp1);
  576. g_free (tmp2);
  577. return FALSE;
  578. }
  579. /* Now do it */
  580. if (lua_pcall (L, 0, 0, err_idx) != 0) {
  581. tb = lua_touserdata (L, -1);
  582. g_set_error (err,
  583. CFG_RCL_ERROR,
  584. EINVAL,
  585. "cannot init lua file %s: %s",
  586. lua_src,
  587. tb->str);
  588. g_string_free (tb, TRUE);
  589. lua_pop (L, 2);
  590. if (chdir (cur_dir) == -1) {
  591. msg_err_config ("cannot chdir to %s: %s", cur_dir,
  592. strerror (errno));
  593. }
  594. g_free (cur_dir);
  595. g_free (tmp1);
  596. g_free (tmp2);
  597. return FALSE;
  598. }
  599. lua_pop (L, 1);
  600. }
  601. else {
  602. g_set_error (err, CFG_RCL_ERROR, ENOENT, "cannot chdir to %s: %s",
  603. lua_dir, strerror (errno));
  604. if (chdir (cur_dir) == -1) {
  605. msg_err_config ("cannot chdir to %s: %s", cur_dir, strerror (errno));
  606. }
  607. g_free (cur_dir);
  608. g_free (tmp1);
  609. g_free (tmp2);
  610. return FALSE;
  611. }
  612. if (chdir (cur_dir) == -1) {
  613. msg_err_config ("cannot chdir to %s: %s", cur_dir, strerror (errno));
  614. }
  615. g_free (cur_dir);
  616. g_free (tmp1);
  617. g_free (tmp2);
  618. }
  619. else {
  620. g_free (tmp1);
  621. g_free (tmp2);
  622. g_set_error (err, CFG_RCL_ERROR, ENOENT, "cannot find to %s: %s",
  623. lua_src, strerror (errno));
  624. return FALSE;
  625. }
  626. return TRUE;
  627. }
  628. gboolean
  629. rspamd_rcl_add_lua_plugins_path (struct rspamd_config *cfg,
  630. const gchar *path,
  631. GError **err)
  632. {
  633. struct stat st;
  634. struct script_module *cur_mod;
  635. GPtrArray *paths;
  636. gchar *fname, *ext_pos;
  637. guint i;
  638. if (stat (path, &st) == -1) {
  639. g_set_error (err,
  640. CFG_RCL_ERROR,
  641. errno,
  642. "cannot stat path %s, %s",
  643. path,
  644. strerror (errno));
  645. return FALSE;
  646. }
  647. /* Handle directory */
  648. if (S_ISDIR (st.st_mode)) {
  649. paths = rspamd_glob_path (path, "*.lua", TRUE, err);
  650. if (!paths) {
  651. return FALSE;
  652. }
  653. PTR_ARRAY_FOREACH (paths, i, fname) {
  654. cur_mod =
  655. rspamd_mempool_alloc (cfg->cfg_pool,
  656. sizeof (struct script_module));
  657. cur_mod->path = rspamd_mempool_strdup (cfg->cfg_pool, fname);
  658. cur_mod->name = g_path_get_basename (cur_mod->path);
  659. rspamd_mempool_add_destructor (cfg->cfg_pool, g_free,
  660. cur_mod->name);
  661. ext_pos = strstr (cur_mod->name, ".lua");
  662. if (ext_pos != NULL) {
  663. *ext_pos = '\0';
  664. }
  665. if (cfg->script_modules == NULL) {
  666. cfg->script_modules = g_list_append (cfg->script_modules,
  667. cur_mod);
  668. rspamd_mempool_add_destructor (cfg->cfg_pool,
  669. (rspamd_mempool_destruct_t) g_list_free,
  670. cfg->script_modules);
  671. } else {
  672. cfg->script_modules = g_list_append (cfg->script_modules,
  673. cur_mod);
  674. }
  675. }
  676. g_ptr_array_free (paths, TRUE);
  677. }
  678. else {
  679. /* Handle single file */
  680. cur_mod =
  681. rspamd_mempool_alloc (cfg->cfg_pool, sizeof (struct script_module));
  682. cur_mod->path = rspamd_mempool_strdup (cfg->cfg_pool, path);
  683. cur_mod->name = g_path_get_basename (cur_mod->path);
  684. rspamd_mempool_add_destructor (cfg->cfg_pool, g_free,
  685. cur_mod->name);
  686. ext_pos = strstr (cur_mod->name, ".lua");
  687. if (ext_pos != NULL) {
  688. *ext_pos = '\0';
  689. }
  690. if (cfg->script_modules == NULL) {
  691. cfg->script_modules = g_list_append (cfg->script_modules,
  692. cur_mod);
  693. rspamd_mempool_add_destructor (cfg->cfg_pool,
  694. (rspamd_mempool_destruct_t)g_list_free,
  695. cfg->script_modules);
  696. }
  697. else {
  698. cfg->script_modules = g_list_append (cfg->script_modules,
  699. cur_mod);
  700. }
  701. }
  702. return TRUE;
  703. }
  704. static gboolean
  705. rspamd_rcl_modules_handler (rspamd_mempool_t *pool, const ucl_object_t *obj,
  706. const gchar *key, gpointer ud,
  707. struct rspamd_rcl_section *section, GError **err)
  708. {
  709. const ucl_object_t *val, *cur;
  710. struct rspamd_config *cfg = ud;
  711. const gchar *data;
  712. if (obj->type == UCL_OBJECT) {
  713. val = ucl_object_lookup (obj, "path");
  714. LL_FOREACH (val, cur)
  715. {
  716. if (ucl_object_tostring_safe (cur, &data)) {
  717. if (!rspamd_rcl_add_lua_plugins_path (cfg,
  718. rspamd_mempool_strdup (cfg->cfg_pool, data), err)) {
  719. return FALSE;
  720. }
  721. }
  722. }
  723. }
  724. else if (ucl_object_tostring_safe (obj, &data)) {
  725. if (!rspamd_rcl_add_lua_plugins_path (cfg,
  726. rspamd_mempool_strdup (cfg->cfg_pool, data), err)) {
  727. return FALSE;
  728. }
  729. }
  730. else {
  731. g_set_error (err,
  732. CFG_RCL_ERROR,
  733. EINVAL,
  734. "module parameter has wrong type (must be an object or a string)");
  735. return FALSE;
  736. }
  737. return TRUE;
  738. }
  739. struct statfile_parser_data {
  740. struct rspamd_config *cfg;
  741. struct rspamd_classifier_config *ccf;
  742. };
  743. static gboolean
  744. rspamd_rcl_statfile_handler (rspamd_mempool_t *pool, const ucl_object_t *obj,
  745. const gchar *key, gpointer ud,
  746. struct rspamd_rcl_section *section, GError **err)
  747. {
  748. struct statfile_parser_data *stud = ud;
  749. struct rspamd_classifier_config *ccf;
  750. struct rspamd_config *cfg;
  751. const ucl_object_t *val;
  752. struct rspamd_statfile_config *st;
  753. GList *labels;
  754. g_assert (key != NULL);
  755. cfg = stud->cfg;
  756. ccf = stud->ccf;
  757. st = rspamd_config_new_statfile (cfg, NULL);
  758. st->symbol = rspamd_mempool_strdup (cfg->cfg_pool, key);
  759. if (rspamd_rcl_section_parse_defaults (cfg, section, pool, obj, st, err)) {
  760. ccf->statfiles = rspamd_mempool_glist_prepend (pool, ccf->statfiles, st);
  761. if (st->label != NULL) {
  762. labels = g_hash_table_lookup (ccf->labels, st->label);
  763. if (labels != NULL) {
  764. labels = g_list_append (labels, st);
  765. }
  766. else {
  767. g_hash_table_insert (ccf->labels, st->label,
  768. g_list_prepend (NULL, st));
  769. }
  770. }
  771. if (st->symbol != NULL) {
  772. g_hash_table_insert (cfg->classifiers_symbols, st->symbol, st);
  773. }
  774. else {
  775. g_set_error (err,
  776. CFG_RCL_ERROR,
  777. EINVAL,
  778. "statfile must have a symbol defined");
  779. return FALSE;
  780. }
  781. st->opts = (ucl_object_t *)obj;
  782. st->clcf = ccf;
  783. val = ucl_object_lookup (obj, "spam");
  784. if (val == NULL) {
  785. msg_info_config (
  786. "statfile %s has no explicit 'spam' setting, trying to guess by symbol",
  787. st->symbol);
  788. if (rspamd_substring_search_caseless (st->symbol,
  789. strlen (st->symbol),"spam", 4) != -1) {
  790. st->is_spam = TRUE;
  791. }
  792. else if (rspamd_substring_search_caseless (st->symbol,
  793. strlen (st->symbol),"ham", 3) != -1) {
  794. st->is_spam = FALSE;
  795. }
  796. else {
  797. g_set_error (err,
  798. CFG_RCL_ERROR,
  799. EINVAL,
  800. "cannot guess spam setting from %s",
  801. st->symbol);
  802. return FALSE;
  803. }
  804. msg_info_config ("guessed that statfile with symbol %s is %s",
  805. st->symbol,
  806. st->is_spam ?
  807. "spam" : "ham");
  808. }
  809. return TRUE;
  810. }
  811. return FALSE;
  812. }
  813. static gboolean
  814. rspamd_rcl_classifier_handler (rspamd_mempool_t *pool,
  815. const ucl_object_t *obj,
  816. const gchar *key,
  817. gpointer ud,
  818. struct rspamd_rcl_section *section,
  819. GError **err)
  820. {
  821. const ucl_object_t *val, *cur;
  822. ucl_object_iter_t it = NULL;
  823. struct rspamd_config *cfg = ud;
  824. struct statfile_parser_data stud;
  825. const gchar *st_key;
  826. struct rspamd_classifier_config *ccf;
  827. gboolean res = TRUE;
  828. struct rspamd_rcl_section *stat_section;
  829. struct rspamd_tokenizer_config *tkcf = NULL;
  830. lua_State *L;
  831. g_assert (key != NULL);
  832. ccf = rspamd_config_new_classifier (cfg, NULL);
  833. ccf->classifier = rspamd_mempool_strdup (cfg->cfg_pool, key);
  834. if (rspamd_rcl_section_parse_defaults (cfg, section, cfg->cfg_pool, obj,
  835. ccf, err)) {
  836. HASH_FIND_STR (section->subsections, "statfile", stat_section);
  837. if (ccf->classifier == NULL) {
  838. ccf->classifier = "bayes";
  839. }
  840. if (ccf->name == NULL) {
  841. ccf->name = ccf->classifier;
  842. }
  843. it = ucl_object_iterate_new (obj);
  844. while ((val = ucl_object_iterate_safe (it, true)) != NULL && res) {
  845. st_key = ucl_object_key (val);
  846. if (st_key != NULL) {
  847. if (g_ascii_strcasecmp (st_key, "statfile") == 0) {
  848. LL_FOREACH (val, cur) {
  849. stud.cfg = cfg;
  850. stud.ccf = ccf;
  851. res = rspamd_rcl_process_section (cfg, stat_section, &stud,
  852. cur, cfg->cfg_pool, err);
  853. if (!res) {
  854. ucl_object_iterate_free (it);
  855. return FALSE;
  856. }
  857. }
  858. }
  859. else if (g_ascii_strcasecmp (st_key, "tokenizer") == 0) {
  860. tkcf = rspamd_mempool_alloc0 (cfg->cfg_pool, sizeof (*tkcf));
  861. if (ucl_object_type (val) == UCL_STRING) {
  862. tkcf->name = ucl_object_tostring (val);
  863. }
  864. else if (ucl_object_type (val) == UCL_OBJECT) {
  865. cur = ucl_object_lookup (val, "name");
  866. if (cur != NULL) {
  867. tkcf->name = ucl_object_tostring (cur);
  868. tkcf->opts = val;
  869. }
  870. else {
  871. cur = ucl_object_lookup (val, "type");
  872. if (cur != NULL) {
  873. tkcf->name = ucl_object_tostring (cur);
  874. tkcf->opts = val;
  875. }
  876. }
  877. }
  878. }
  879. }
  880. }
  881. ucl_object_iterate_free (it);
  882. }
  883. else {
  884. msg_err_config ("fatal configuration error, cannot parse statfile definition");
  885. }
  886. if (tkcf == NULL) {
  887. tkcf = rspamd_mempool_alloc0 (cfg->cfg_pool, sizeof (*tkcf));
  888. tkcf->name = NULL;
  889. }
  890. ccf->tokenizer = tkcf;
  891. /* Handle lua conditions */
  892. val = ucl_object_lookup_any (obj, "condition", "learn_condition", NULL);
  893. if (val) {
  894. LL_FOREACH (val, cur) {
  895. if (ucl_object_type (cur) == UCL_STRING) {
  896. const gchar *lua_script;
  897. gsize slen;
  898. gint err_idx, ref_idx;
  899. GString *tb = NULL;
  900. lua_script = ucl_object_tolstring (cur, &slen);
  901. L = cfg->lua_state;
  902. lua_pushcfunction (L, &rspamd_lua_traceback);
  903. err_idx = lua_gettop (L);
  904. /* Load file */
  905. if (luaL_loadbuffer (L, lua_script, slen, "learn_condition") != 0) {
  906. g_set_error (err,
  907. CFG_RCL_ERROR,
  908. EINVAL,
  909. "cannot load lua condition script: %s",
  910. lua_tostring (L, -1));
  911. lua_settop (L, 0); /* Error function */
  912. return FALSE;
  913. }
  914. /* Now do it */
  915. if (lua_pcall (L, 0, 1, err_idx) != 0) {
  916. tb = lua_touserdata (L, -1);
  917. g_set_error (err,
  918. CFG_RCL_ERROR,
  919. EINVAL,
  920. "cannot init lua condition script: %s",
  921. tb->str);
  922. g_string_free (tb, TRUE);
  923. lua_settop (L, 0);
  924. return FALSE;
  925. }
  926. if (!lua_isfunction (L, -1)) {
  927. g_set_error (err,
  928. CFG_RCL_ERROR,
  929. EINVAL,
  930. "cannot init lua condition script: "
  931. "must return function");
  932. lua_settop (L, 0);
  933. return FALSE;
  934. }
  935. ref_idx = luaL_ref (L, LUA_REGISTRYINDEX);
  936. rspamd_lua_add_ref_dtor (L, cfg->cfg_pool, ref_idx);
  937. ccf->learn_conditions = rspamd_mempool_glist_append (
  938. cfg->cfg_pool,
  939. ccf->learn_conditions,
  940. GINT_TO_POINTER (ref_idx));
  941. lua_settop (L, 0);
  942. }
  943. }
  944. }
  945. ccf->opts = (ucl_object_t *)obj;
  946. cfg->classifiers = g_list_prepend (cfg->classifiers, ccf);
  947. return res;
  948. }
  949. static gboolean
  950. rspamd_rcl_composite_handler (rspamd_mempool_t *pool,
  951. const ucl_object_t *obj,
  952. const gchar *key,
  953. gpointer ud,
  954. struct rspamd_rcl_section *section,
  955. GError **err)
  956. {
  957. const ucl_object_t *val, *elt;
  958. struct rspamd_expression *expr;
  959. struct rspamd_config *cfg = ud;
  960. struct rspamd_composite *composite;
  961. const gchar *composite_name, *composite_expression, *group,
  962. *description;
  963. gdouble score;
  964. gboolean new = TRUE;
  965. g_assert (key != NULL);
  966. composite_name = key;
  967. val = ucl_object_lookup (obj, "enabled");
  968. if (val != NULL && !ucl_object_toboolean (val)) {
  969. msg_info_config ("composite %s is disabled", composite_name);
  970. return TRUE;
  971. }
  972. if (g_hash_table_lookup (cfg->composite_symbols, composite_name) != NULL) {
  973. msg_warn_config ("composite %s is redefined", composite_name);
  974. new = FALSE;
  975. }
  976. val = ucl_object_lookup (obj, "expression");
  977. if (val == NULL || !ucl_object_tostring_safe (val, &composite_expression)) {
  978. g_set_error (err,
  979. CFG_RCL_ERROR,
  980. EINVAL,
  981. "composite must have an expression defined");
  982. return FALSE;
  983. }
  984. if (!rspamd_parse_expression (composite_expression, 0, &composite_expr_subr,
  985. NULL, cfg->cfg_pool, err, &expr)) {
  986. if (err && *err) {
  987. msg_err_config ("cannot parse composite expression for %s: %e",
  988. composite_name, *err);
  989. }
  990. else {
  991. msg_err_config ("cannot parse composite expression for %s: unknown error",
  992. composite_name);
  993. }
  994. return FALSE;
  995. }
  996. composite =
  997. rspamd_mempool_alloc0 (cfg->cfg_pool, sizeof (struct rspamd_composite));
  998. composite->expr = expr;
  999. composite->id = g_hash_table_size (cfg->composite_symbols);
  1000. composite->str_expr = composite_expression;
  1001. composite->sym = composite_name;
  1002. val = ucl_object_lookup (obj, "score");
  1003. if (val != NULL && ucl_object_todouble_safe (val, &score)) {
  1004. /* Also set score in the metric */
  1005. val = ucl_object_lookup (obj, "group");
  1006. if (val != NULL) {
  1007. group = ucl_object_tostring (val);
  1008. }
  1009. else {
  1010. group = "composite";
  1011. }
  1012. val = ucl_object_lookup (obj, "description");
  1013. if (val != NULL) {
  1014. description = ucl_object_tostring (val);
  1015. }
  1016. else {
  1017. description = composite_expression;
  1018. }
  1019. rspamd_config_add_symbol (cfg, composite_name, score,
  1020. description, group, FALSE, FALSE,
  1021. 1);
  1022. elt = ucl_object_lookup (obj, "groups");
  1023. if (elt) {
  1024. ucl_object_iter_t gr_it;
  1025. const ucl_object_t *cur_gr;
  1026. gr_it = ucl_object_iterate_new (elt);
  1027. while ((cur_gr = ucl_object_iterate_safe (gr_it, true)) != NULL) {
  1028. rspamd_config_add_symbol_group (cfg, key,
  1029. ucl_object_tostring (cur_gr));
  1030. }
  1031. ucl_object_iterate_free (gr_it);
  1032. }
  1033. }
  1034. val = ucl_object_lookup (obj, "policy");
  1035. if (val) {
  1036. composite->policy = rspamd_composite_policy_from_str (
  1037. ucl_object_tostring (val));
  1038. if (composite->policy == RSPAMD_COMPOSITE_POLICY_UNKNOWN) {
  1039. g_set_error (err,
  1040. CFG_RCL_ERROR,
  1041. EINVAL,
  1042. "composite %s has incorrect policy", composite_name);
  1043. return FALSE;
  1044. }
  1045. }
  1046. g_hash_table_insert (cfg->composite_symbols,
  1047. (gpointer)composite_name,
  1048. composite);
  1049. if (new) {
  1050. rspamd_symcache_add_symbol (cfg->cache, composite_name, 0,
  1051. NULL, NULL, SYMBOL_TYPE_COMPOSITE, -1);
  1052. }
  1053. return TRUE;
  1054. }
  1055. static gboolean
  1056. rspamd_rcl_composites_handler (rspamd_mempool_t *pool,
  1057. const ucl_object_t *obj,
  1058. const gchar *key,
  1059. gpointer ud,
  1060. struct rspamd_rcl_section *section,
  1061. GError **err)
  1062. {
  1063. ucl_object_iter_t it = NULL;
  1064. const ucl_object_t *cur;
  1065. gboolean success = TRUE;
  1066. it = ucl_object_iterate_new (obj);
  1067. while ((cur = ucl_object_iterate_safe (it, true))) {
  1068. success = rspamd_rcl_composite_handler(pool, cur,
  1069. ucl_object_key(cur), ud, section, err);
  1070. if (!success) {
  1071. break;
  1072. }
  1073. }
  1074. ucl_object_iterate_free (it);
  1075. return success;
  1076. }
  1077. static gboolean
  1078. rspamd_rcl_neighbours_handler (rspamd_mempool_t *pool,
  1079. const ucl_object_t *obj,
  1080. const gchar *key,
  1081. gpointer ud,
  1082. struct rspamd_rcl_section *section,
  1083. GError **err)
  1084. {
  1085. struct rspamd_config *cfg = ud;
  1086. const ucl_object_t *hostval, *pathval;
  1087. ucl_object_t *neigh;
  1088. gboolean has_port = FALSE, has_proto = FALSE;
  1089. GString *urlstr;
  1090. const gchar *p;
  1091. if (key == NULL) {
  1092. g_set_error (err,
  1093. CFG_RCL_ERROR,
  1094. EINVAL,
  1095. "missing name for neighbour");
  1096. return FALSE;
  1097. }
  1098. hostval = ucl_object_lookup (obj, "host");
  1099. if (hostval == NULL || ucl_object_type (hostval) != UCL_STRING) {
  1100. g_set_error (err,
  1101. CFG_RCL_ERROR,
  1102. EINVAL,
  1103. "missing host for neighbour: %s", ucl_object_key (obj));
  1104. return FALSE;
  1105. }
  1106. neigh = ucl_object_typed_new (UCL_OBJECT);
  1107. ucl_object_insert_key (neigh, ucl_object_copy (hostval), "host", 0, false);
  1108. if ((p = strrchr (ucl_object_tostring (hostval), ':')) != NULL) {
  1109. if (g_ascii_isdigit (p[1])) {
  1110. has_port = TRUE;
  1111. }
  1112. }
  1113. if (strstr (ucl_object_tostring (hostval), "://") != NULL) {
  1114. has_proto = TRUE;
  1115. }
  1116. /* Now make url */
  1117. urlstr = g_string_sized_new (63);
  1118. pathval = ucl_object_lookup (obj, "path");
  1119. if (!has_proto) {
  1120. g_string_append_len (urlstr, "http://", sizeof ("http://") - 1);
  1121. }
  1122. g_string_append (urlstr, ucl_object_tostring (hostval));
  1123. if (!has_port) {
  1124. g_string_append (urlstr, ":11334");
  1125. }
  1126. if (pathval == NULL) {
  1127. g_string_append (urlstr, "/");
  1128. }
  1129. else {
  1130. g_string_append (urlstr, ucl_object_tostring (pathval));
  1131. }
  1132. ucl_object_insert_key (neigh,
  1133. ucl_object_fromlstring (urlstr->str, urlstr->len),
  1134. "url", 0, false);
  1135. g_string_free (urlstr, TRUE);
  1136. ucl_object_insert_key (cfg->neighbours, neigh, key, 0, true);
  1137. return TRUE;
  1138. }
  1139. struct rspamd_rcl_section *
  1140. rspamd_rcl_add_section (struct rspamd_rcl_section **top,
  1141. const gchar *name, const gchar *key_attr, rspamd_rcl_handler_t handler,
  1142. enum ucl_type type, gboolean required, gboolean strict_type)
  1143. {
  1144. struct rspamd_rcl_section *new;
  1145. ucl_object_t *parent_doc;
  1146. new = g_malloc0 (sizeof (struct rspamd_rcl_section));
  1147. new->name = name;
  1148. new->key_attr = key_attr;
  1149. new->handler = handler;
  1150. new->type = type;
  1151. new->strict_type = strict_type;
  1152. if (*top == NULL) {
  1153. parent_doc = NULL;
  1154. new->doc_ref = NULL;
  1155. }
  1156. else {
  1157. parent_doc = (*top)->doc_ref;
  1158. new->doc_ref = ucl_object_ref (rspamd_rcl_add_doc_obj (parent_doc,
  1159. NULL,
  1160. name,
  1161. type,
  1162. NULL,
  1163. 0,
  1164. NULL,
  1165. 0));
  1166. }
  1167. HASH_ADD_KEYPTR (hh, *top, new->name, strlen (new->name), new);
  1168. return new;
  1169. }
  1170. struct rspamd_rcl_section *
  1171. rspamd_rcl_add_section_doc (struct rspamd_rcl_section **top,
  1172. const gchar *name, const gchar *key_attr, rspamd_rcl_handler_t handler,
  1173. enum ucl_type type, gboolean required, gboolean strict_type,
  1174. ucl_object_t *doc_target,
  1175. const gchar *doc_string)
  1176. {
  1177. struct rspamd_rcl_section *new_section;
  1178. new_section = g_malloc0 (sizeof (struct rspamd_rcl_section));
  1179. new_section->name = name;
  1180. new_section->key_attr = key_attr;
  1181. new_section->handler = handler;
  1182. new_section->type = type;
  1183. new_section->strict_type = strict_type;
  1184. new_section->doc_ref = ucl_object_ref (rspamd_rcl_add_doc_obj (doc_target,
  1185. doc_string,
  1186. name,
  1187. type,
  1188. NULL,
  1189. 0,
  1190. NULL,
  1191. 0));
  1192. HASH_ADD_KEYPTR (hh, *top, new_section->name, strlen (new_section->name), new_section);
  1193. return new_section;
  1194. }
  1195. struct rspamd_rcl_default_handler_data *
  1196. rspamd_rcl_add_default_handler (struct rspamd_rcl_section *section,
  1197. const gchar *name,
  1198. rspamd_rcl_default_handler_t handler,
  1199. goffset offset,
  1200. gint flags,
  1201. const gchar *doc_string)
  1202. {
  1203. struct rspamd_rcl_default_handler_data *nhandler;
  1204. nhandler = g_malloc0 (sizeof (struct rspamd_rcl_default_handler_data));
  1205. nhandler->key = g_strdup (name);
  1206. nhandler->handler = handler;
  1207. nhandler->pd.offset = offset;
  1208. nhandler->pd.flags = flags;
  1209. if (section->doc_ref != NULL) {
  1210. rspamd_rcl_add_doc_obj (section->doc_ref,
  1211. doc_string,
  1212. name,
  1213. UCL_NULL,
  1214. handler,
  1215. flags,
  1216. NULL,
  1217. 0);
  1218. }
  1219. HASH_ADD_KEYPTR (hh, section->default_parser, nhandler->key, strlen (
  1220. nhandler->key), nhandler);
  1221. return nhandler;
  1222. }
  1223. struct rspamd_rcl_section *
  1224. rspamd_rcl_config_init (struct rspamd_config *cfg, GHashTable *skip_sections)
  1225. {
  1226. struct rspamd_rcl_section *new = NULL, *sub, *ssub;
  1227. /*
  1228. * Important notice:
  1229. * the order of parsing is equal to order of this initialization, therefore
  1230. * it is possible to init some portions of config prior to others
  1231. */
  1232. /**
  1233. * Logging section
  1234. */
  1235. if (!(skip_sections && g_hash_table_lookup (skip_sections, "logging"))) {
  1236. sub = rspamd_rcl_add_section_doc (&new,
  1237. "logging", NULL,
  1238. rspamd_rcl_logging_handler,
  1239. UCL_OBJECT,
  1240. FALSE,
  1241. TRUE,
  1242. cfg->doc_strings,
  1243. "Configure rspamd logging");
  1244. /* Default handlers */
  1245. rspamd_rcl_add_default_handler (sub,
  1246. "log_buffer",
  1247. rspamd_rcl_parse_struct_integer,
  1248. G_STRUCT_OFFSET (struct rspamd_config, log_buf_size),
  1249. RSPAMD_CL_FLAG_INT_32,
  1250. "Size of log buffer in bytes (for file logging)");
  1251. rspamd_rcl_add_default_handler (sub,
  1252. "log_urls",
  1253. rspamd_rcl_parse_struct_boolean,
  1254. G_STRUCT_OFFSET (struct rspamd_config, log_urls),
  1255. 0,
  1256. "Write each URL found in a message to the log file");
  1257. rspamd_rcl_add_default_handler (sub,
  1258. "debug_ip",
  1259. rspamd_rcl_parse_struct_ucl,
  1260. G_STRUCT_OFFSET (struct rspamd_config, debug_ip_map),
  1261. 0,
  1262. "Enable debugging log for the specified IP addresses");
  1263. rspamd_rcl_add_default_handler (sub,
  1264. "debug_symbols",
  1265. rspamd_rcl_parse_struct_string_list,
  1266. G_STRUCT_OFFSET (struct rspamd_config, debug_symbols),
  1267. 0,
  1268. "Enable debug for the specified symbols");
  1269. rspamd_rcl_add_default_handler (sub,
  1270. "debug_modules",
  1271. rspamd_rcl_parse_struct_string_list,
  1272. G_STRUCT_OFFSET (struct rspamd_config, debug_modules),
  1273. RSPAMD_CL_FLAG_STRING_LIST_HASH,
  1274. "Enable debugging for the specified modules");
  1275. rspamd_rcl_add_default_handler (sub,
  1276. "log_format",
  1277. rspamd_rcl_parse_struct_string,
  1278. G_STRUCT_OFFSET (struct rspamd_config, log_format_str),
  1279. 0,
  1280. "Specify format string for the task logging output "
  1281. "(https://rspamd.com/doc/configuration/logging.html "
  1282. "for details)");
  1283. rspamd_rcl_add_default_handler (sub,
  1284. "encryption_key",
  1285. rspamd_rcl_parse_struct_pubkey,
  1286. G_STRUCT_OFFSET (struct rspamd_config, log_encryption_key),
  1287. 0,
  1288. "Encrypt sensitive information in logs using this pubkey");
  1289. rspamd_rcl_add_default_handler (sub,
  1290. "error_elts",
  1291. rspamd_rcl_parse_struct_integer,
  1292. G_STRUCT_OFFSET (struct rspamd_config, log_error_elts),
  1293. RSPAMD_CL_FLAG_UINT,
  1294. "Size of circular buffer for last errors (10 by default)");
  1295. rspamd_rcl_add_default_handler (sub,
  1296. "error_maxlen",
  1297. rspamd_rcl_parse_struct_integer,
  1298. G_STRUCT_OFFSET (struct rspamd_config, log_error_elt_maxlen),
  1299. RSPAMD_CL_FLAG_UINT,
  1300. "Size of each element in error log buffer (1000 by default)");
  1301. /* Documentation only options, handled in log_handler to map flags */
  1302. rspamd_rcl_add_doc_by_path (cfg,
  1303. "logging",
  1304. "Enable colored output (for console logging)",
  1305. "log_color",
  1306. UCL_BOOLEAN,
  1307. NULL,
  1308. 0,
  1309. NULL,
  1310. 0);
  1311. rspamd_rcl_add_doc_by_path (cfg,
  1312. "logging",
  1313. "Enable systemd compatible logging",
  1314. "systemd",
  1315. UCL_BOOLEAN,
  1316. NULL,
  1317. 0,
  1318. NULL,
  1319. 0);
  1320. rspamd_rcl_add_doc_by_path (cfg,
  1321. "logging",
  1322. "Write statistics of regexp processing to log (useful for hyperscan)",
  1323. "log_re_cache",
  1324. UCL_BOOLEAN,
  1325. NULL,
  1326. 0,
  1327. NULL,
  1328. 0);
  1329. rspamd_rcl_add_doc_by_path (cfg,
  1330. "logging",
  1331. "Use microseconds resolution for timestamps",
  1332. "log_usec",
  1333. UCL_BOOLEAN,
  1334. NULL,
  1335. 0,
  1336. NULL,
  1337. 0);
  1338. }
  1339. if (!(skip_sections && g_hash_table_lookup (skip_sections, "options"))) {
  1340. /**
  1341. * Options section
  1342. */
  1343. sub = rspamd_rcl_add_section_doc (&new,
  1344. "options", NULL,
  1345. rspamd_rcl_options_handler,
  1346. UCL_OBJECT,
  1347. FALSE,
  1348. TRUE,
  1349. cfg->doc_strings,
  1350. "Global rspamd options");
  1351. rspamd_rcl_add_default_handler (sub,
  1352. "cache_file",
  1353. rspamd_rcl_parse_struct_string,
  1354. G_STRUCT_OFFSET (struct rspamd_config, cache_filename),
  1355. RSPAMD_CL_FLAG_STRING_PATH,
  1356. "Path to the cache file");
  1357. rspamd_rcl_add_default_handler (sub,
  1358. "cache_reload",
  1359. rspamd_rcl_parse_struct_time,
  1360. G_STRUCT_OFFSET (struct rspamd_config, cache_reload_time),
  1361. RSPAMD_CL_FLAG_TIME_FLOAT,
  1362. "How often cache reload should be performed");
  1363. /* Old DNS configuration */
  1364. rspamd_rcl_add_default_handler (sub,
  1365. "dns_nameserver",
  1366. rspamd_rcl_parse_struct_ucl,
  1367. G_STRUCT_OFFSET (struct rspamd_config, nameservers),
  1368. 0,
  1369. "Legacy option for DNS servers used");
  1370. rspamd_rcl_add_default_handler (sub,
  1371. "dns_timeout",
  1372. rspamd_rcl_parse_struct_time,
  1373. G_STRUCT_OFFSET (struct rspamd_config, dns_timeout),
  1374. RSPAMD_CL_FLAG_TIME_FLOAT,
  1375. "Legacy option for DNS request timeout");
  1376. rspamd_rcl_add_default_handler (sub,
  1377. "dns_retransmits",
  1378. rspamd_rcl_parse_struct_integer,
  1379. G_STRUCT_OFFSET (struct rspamd_config, dns_retransmits),
  1380. RSPAMD_CL_FLAG_INT_32,
  1381. "Legacy option for DNS retransmits count");
  1382. rspamd_rcl_add_default_handler (sub,
  1383. "dns_sockets",
  1384. rspamd_rcl_parse_struct_integer,
  1385. G_STRUCT_OFFSET (struct rspamd_config, dns_io_per_server),
  1386. RSPAMD_CL_FLAG_INT_32,
  1387. "Legacy option for DNS sockets per server count");
  1388. rspamd_rcl_add_default_handler (sub,
  1389. "dns_max_requests",
  1390. rspamd_rcl_parse_struct_integer,
  1391. G_STRUCT_OFFSET (struct rspamd_config, dns_max_requests),
  1392. RSPAMD_CL_FLAG_INT_32,
  1393. "Legacy option for DNS maximum requests per task count");
  1394. rspamd_rcl_add_default_handler (sub,
  1395. "classify_headers",
  1396. rspamd_rcl_parse_struct_string_list,
  1397. G_STRUCT_OFFSET (struct rspamd_config, classify_headers),
  1398. 0,
  1399. "List of headers used for classifiers");
  1400. rspamd_rcl_add_default_handler (sub,
  1401. "control_socket",
  1402. rspamd_rcl_parse_struct_string,
  1403. G_STRUCT_OFFSET (struct rspamd_config, control_socket_path),
  1404. 0,
  1405. "Path to the control socket");
  1406. rspamd_rcl_add_default_handler (sub,
  1407. "explicit_modules",
  1408. rspamd_rcl_parse_struct_string_list,
  1409. G_STRUCT_OFFSET (struct rspamd_config, explicit_modules),
  1410. RSPAMD_CL_FLAG_STRING_LIST_HASH,
  1411. "Always load these modules even if they are not configured explicitly");
  1412. rspamd_rcl_add_default_handler (sub,
  1413. "allow_raw_input",
  1414. rspamd_rcl_parse_struct_boolean,
  1415. G_STRUCT_OFFSET (struct rspamd_config, allow_raw_input),
  1416. 0,
  1417. "Allow non MIME input for rspamd");
  1418. rspamd_rcl_add_default_handler (sub,
  1419. "raw_mode",
  1420. rspamd_rcl_parse_struct_boolean,
  1421. G_STRUCT_OFFSET (struct rspamd_config, raw_mode),
  1422. 0,
  1423. "Don't try to convert all messages to utf8");
  1424. rspamd_rcl_add_default_handler (sub,
  1425. "one_shot",
  1426. rspamd_rcl_parse_struct_boolean,
  1427. G_STRUCT_OFFSET (struct rspamd_config, one_shot_mode),
  1428. 0,
  1429. "Add all symbols only once per message");
  1430. rspamd_rcl_add_default_handler (sub,
  1431. "check_attachements",
  1432. rspamd_rcl_parse_struct_boolean,
  1433. G_STRUCT_OFFSET (struct rspamd_config, check_text_attachements),
  1434. 0,
  1435. "Treat text attachments as normal text parts");
  1436. rspamd_rcl_add_default_handler (sub,
  1437. "check_attachments",
  1438. rspamd_rcl_parse_struct_boolean,
  1439. G_STRUCT_OFFSET (struct rspamd_config, check_text_attachements),
  1440. 0,
  1441. "Treat text attachments as normal text parts");
  1442. rspamd_rcl_add_default_handler (sub,
  1443. "tempdir",
  1444. rspamd_rcl_parse_struct_string,
  1445. G_STRUCT_OFFSET (struct rspamd_config, temp_dir),
  1446. RSPAMD_CL_FLAG_STRING_PATH,
  1447. "Directory for temporary files");
  1448. rspamd_rcl_add_default_handler (sub,
  1449. "pidfile",
  1450. rspamd_rcl_parse_struct_string,
  1451. G_STRUCT_OFFSET (struct rspamd_config, pid_file),
  1452. RSPAMD_CL_FLAG_STRING_PATH,
  1453. "Path to the pid file");
  1454. rspamd_rcl_add_default_handler (sub,
  1455. "filters",
  1456. rspamd_rcl_parse_struct_string_list,
  1457. G_STRUCT_OFFSET (struct rspamd_config, filters),
  1458. 0,
  1459. "List of internal filters enabled");
  1460. rspamd_rcl_add_default_handler (sub,
  1461. "max_diff",
  1462. rspamd_rcl_parse_struct_integer,
  1463. G_STRUCT_OFFSET (struct rspamd_config, max_diff),
  1464. RSPAMD_CL_FLAG_INT_SIZE,
  1465. "Legacy option, do not use");
  1466. rspamd_rcl_add_default_handler (sub,
  1467. "map_watch_interval",
  1468. rspamd_rcl_parse_struct_time,
  1469. G_STRUCT_OFFSET (struct rspamd_config, map_timeout),
  1470. RSPAMD_CL_FLAG_TIME_FLOAT,
  1471. "Interval for checking maps");
  1472. rspamd_rcl_add_default_handler (sub,
  1473. "map_file_watch_multiplier",
  1474. rspamd_rcl_parse_struct_double,
  1475. G_STRUCT_OFFSET (struct rspamd_config, map_file_watch_multiplier),
  1476. 0,
  1477. "Multiplier for map watch interval when map is file");
  1478. rspamd_rcl_add_default_handler (sub,
  1479. "maps_cache_dir",
  1480. rspamd_rcl_parse_struct_string,
  1481. G_STRUCT_OFFSET (struct rspamd_config, maps_cache_dir),
  1482. 0,
  1483. "Directory to save maps cached data (default: $DBDIR)");
  1484. rspamd_rcl_add_default_handler (sub,
  1485. "monitoring_watch_interval",
  1486. rspamd_rcl_parse_struct_time,
  1487. G_STRUCT_OFFSET (struct rspamd_config, monitored_interval),
  1488. RSPAMD_CL_FLAG_TIME_FLOAT,
  1489. "Interval for checking monitored instances");
  1490. rspamd_rcl_add_default_handler (sub,
  1491. "disable_monitoring",
  1492. rspamd_rcl_parse_struct_boolean,
  1493. G_STRUCT_OFFSET (struct rspamd_config, disable_monitored),
  1494. 0,
  1495. "Disable monitoring completely");
  1496. rspamd_rcl_add_default_handler (sub,
  1497. "dynamic_conf",
  1498. rspamd_rcl_parse_struct_string,
  1499. G_STRUCT_OFFSET (struct rspamd_config, dynamic_conf),
  1500. 0,
  1501. "Path to the dynamic configuration");
  1502. rspamd_rcl_add_default_handler (sub,
  1503. "rrd",
  1504. rspamd_rcl_parse_struct_string,
  1505. G_STRUCT_OFFSET (struct rspamd_config, rrd_file),
  1506. RSPAMD_CL_FLAG_STRING_PATH,
  1507. "Path to RRD file");
  1508. rspamd_rcl_add_default_handler (sub,
  1509. "history_file",
  1510. rspamd_rcl_parse_struct_string,
  1511. G_STRUCT_OFFSET (struct rspamd_config, history_file),
  1512. RSPAMD_CL_FLAG_STRING_PATH,
  1513. "Path to history file");
  1514. rspamd_rcl_add_default_handler (sub,
  1515. "check_all_filters",
  1516. rspamd_rcl_parse_struct_boolean,
  1517. G_STRUCT_OFFSET (struct rspamd_config, check_all_filters),
  1518. 0,
  1519. "Always check all filters");
  1520. rspamd_rcl_add_default_handler (sub,
  1521. "enable_experimental",
  1522. rspamd_rcl_parse_struct_boolean,
  1523. G_STRUCT_OFFSET (struct rspamd_config, enable_experimental),
  1524. 0,
  1525. "Enable experimental plugins");
  1526. rspamd_rcl_add_default_handler (sub,
  1527. "disable_pcre_jit",
  1528. rspamd_rcl_parse_struct_boolean,
  1529. G_STRUCT_OFFSET (struct rspamd_config, disable_pcre_jit),
  1530. 0,
  1531. "Disable PCRE JIT");
  1532. rspamd_rcl_add_default_handler (sub,
  1533. "disable_lua_squeeze",
  1534. rspamd_rcl_parse_struct_boolean,
  1535. G_STRUCT_OFFSET (struct rspamd_config, disable_lua_squeeze),
  1536. 0,
  1537. "Disable Lua rules squeezing");
  1538. rspamd_rcl_add_default_handler (sub,
  1539. "min_word_len",
  1540. rspamd_rcl_parse_struct_integer,
  1541. G_STRUCT_OFFSET (struct rspamd_config, min_word_len),
  1542. RSPAMD_CL_FLAG_UINT,
  1543. "Minimum length of the word to be considered in statistics/fuzzy");
  1544. rspamd_rcl_add_default_handler (sub,
  1545. "max_word_len",
  1546. rspamd_rcl_parse_struct_integer,
  1547. G_STRUCT_OFFSET (struct rspamd_config, max_word_len),
  1548. RSPAMD_CL_FLAG_UINT,
  1549. "Maximum length of the word to be considered in statistics/fuzzy");
  1550. rspamd_rcl_add_default_handler (sub,
  1551. "words_decay",
  1552. rspamd_rcl_parse_struct_integer,
  1553. G_STRUCT_OFFSET (struct rspamd_config, words_decay),
  1554. RSPAMD_CL_FLAG_UINT,
  1555. "Start skipping words at this amount");
  1556. rspamd_rcl_add_default_handler (sub,
  1557. "url_tld",
  1558. rspamd_rcl_parse_struct_string,
  1559. G_STRUCT_OFFSET (struct rspamd_config, tld_file),
  1560. RSPAMD_CL_FLAG_STRING_PATH,
  1561. "Path to the TLD file for urls detector");
  1562. rspamd_rcl_add_default_handler (sub,
  1563. "tld",
  1564. rspamd_rcl_parse_struct_string,
  1565. G_STRUCT_OFFSET (struct rspamd_config, tld_file),
  1566. RSPAMD_CL_FLAG_STRING_PATH,
  1567. "Path to the TLD file for urls detector");
  1568. rspamd_rcl_add_default_handler (sub,
  1569. "hs_cache_dir",
  1570. rspamd_rcl_parse_struct_string,
  1571. G_STRUCT_OFFSET (struct rspamd_config, hs_cache_dir),
  1572. RSPAMD_CL_FLAG_STRING_PATH,
  1573. "Path directory where rspamd would save hyperscan cache");
  1574. rspamd_rcl_add_default_handler (sub,
  1575. "history_rows",
  1576. rspamd_rcl_parse_struct_integer,
  1577. G_STRUCT_OFFSET (struct rspamd_config, history_rows),
  1578. RSPAMD_CL_FLAG_UINT,
  1579. "Number of records in the history file");
  1580. rspamd_rcl_add_default_handler (sub,
  1581. "disable_hyperscan",
  1582. rspamd_rcl_parse_struct_boolean,
  1583. G_STRUCT_OFFSET (struct rspamd_config, disable_hyperscan),
  1584. 0,
  1585. "Disable hyperscan optimizations for regular expressions");
  1586. rspamd_rcl_add_default_handler (sub,
  1587. "vectorized_hyperscan",
  1588. rspamd_rcl_parse_struct_boolean,
  1589. G_STRUCT_OFFSET (struct rspamd_config, vectorized_hyperscan),
  1590. 0,
  1591. "Use hyperscan in vectorized mode (experimental)");
  1592. rspamd_rcl_add_default_handler (sub,
  1593. "cores_dir",
  1594. rspamd_rcl_parse_struct_string,
  1595. G_STRUCT_OFFSET (struct rspamd_config, cores_dir),
  1596. RSPAMD_CL_FLAG_STRING_PATH,
  1597. "Path to the directory where rspamd core files are intended to be dumped");
  1598. rspamd_rcl_add_default_handler (sub,
  1599. "max_cores_size",
  1600. rspamd_rcl_parse_struct_integer,
  1601. G_STRUCT_OFFSET (struct rspamd_config, max_cores_size),
  1602. RSPAMD_CL_FLAG_INT_SIZE,
  1603. "Limit of joint size of all files in `cores_dir`");
  1604. rspamd_rcl_add_default_handler (sub,
  1605. "max_cores_count",
  1606. rspamd_rcl_parse_struct_integer,
  1607. G_STRUCT_OFFSET (struct rspamd_config, max_cores_count),
  1608. RSPAMD_CL_FLAG_INT_SIZE,
  1609. "Limit of files count in `cores_dir`");
  1610. rspamd_rcl_add_default_handler (sub,
  1611. "local_addrs",
  1612. rspamd_rcl_parse_struct_ucl,
  1613. G_STRUCT_OFFSET (struct rspamd_config, local_addrs),
  1614. 0,
  1615. "Use the specified addresses as local ones");
  1616. rspamd_rcl_add_default_handler (sub,
  1617. "local_networks",
  1618. rspamd_rcl_parse_struct_ucl,
  1619. G_STRUCT_OFFSET (struct rspamd_config, local_addrs),
  1620. 0,
  1621. "Use the specified addresses as local ones (alias for `local_addrs`)");
  1622. rspamd_rcl_add_default_handler (sub,
  1623. "trusted_keys",
  1624. rspamd_rcl_parse_struct_string_list,
  1625. G_STRUCT_OFFSET (struct rspamd_config, trusted_keys),
  1626. RSPAMD_CL_FLAG_STRING_LIST_HASH,
  1627. "List of trusted public keys used for signatures in base32 encoding");
  1628. rspamd_rcl_add_default_handler (sub,
  1629. "enable_shutdown_workaround",
  1630. rspamd_rcl_parse_struct_boolean,
  1631. G_STRUCT_OFFSET (struct rspamd_config, enable_shutdown_workaround),
  1632. 0,
  1633. "Enable workaround for legacy clients");
  1634. rspamd_rcl_add_default_handler (sub,
  1635. "ignore_received",
  1636. rspamd_rcl_parse_struct_boolean,
  1637. G_STRUCT_OFFSET (struct rspamd_config, ignore_received),
  1638. 0,
  1639. "Ignore data from the first received header");
  1640. rspamd_rcl_add_default_handler (sub,
  1641. "ssl_ca_path",
  1642. rspamd_rcl_parse_struct_string,
  1643. G_STRUCT_OFFSET (struct rspamd_config, ssl_ca_path),
  1644. RSPAMD_CL_FLAG_STRING_PATH,
  1645. "Path to ssl CA file");
  1646. rspamd_rcl_add_default_handler (sub,
  1647. "ssl_ciphers",
  1648. rspamd_rcl_parse_struct_string,
  1649. G_STRUCT_OFFSET (struct rspamd_config, ssl_ciphers),
  1650. 0,
  1651. "List of ssl ciphers (e.g. HIGH:!aNULL:!kRSA:!PSK:!SRP:!MD5:!RC4)");
  1652. rspamd_rcl_add_default_handler (sub,
  1653. "magic_file",
  1654. rspamd_rcl_parse_struct_string,
  1655. G_STRUCT_OFFSET (struct rspamd_config, magic_file),
  1656. 0,
  1657. "Path to a custom libmagic file");
  1658. rspamd_rcl_add_default_handler (sub,
  1659. "max_message",
  1660. rspamd_rcl_parse_struct_integer,
  1661. G_STRUCT_OFFSET (struct rspamd_config, max_message),
  1662. RSPAMD_CL_FLAG_INT_SIZE,
  1663. "Maximum size of the message to be scanned (50Mb by default)");
  1664. rspamd_rcl_add_default_handler (sub,
  1665. "max_pic",
  1666. rspamd_rcl_parse_struct_integer,
  1667. G_STRUCT_OFFSET (struct rspamd_config, max_pic_size),
  1668. RSPAMD_CL_FLAG_INT_SIZE,
  1669. "Maximum size of the picture to be normalized (1Mb by default)");
  1670. rspamd_rcl_add_default_handler (sub,
  1671. "images_cache",
  1672. rspamd_rcl_parse_struct_integer,
  1673. G_STRUCT_OFFSET (struct rspamd_config, max_pic_size),
  1674. RSPAMD_CL_FLAG_INT_SIZE,
  1675. "Size of DCT data cache for images (256 elements by default)");
  1676. rspamd_rcl_add_default_handler (sub,
  1677. "zstd_input_dictionary",
  1678. rspamd_rcl_parse_struct_string,
  1679. G_STRUCT_OFFSET (struct rspamd_config, zstd_input_dictionary),
  1680. RSPAMD_CL_FLAG_STRING_PATH,
  1681. "Dictionary for zstd inbound protocol compression");
  1682. rspamd_rcl_add_default_handler (sub,
  1683. "zstd_output_dictionary",
  1684. rspamd_rcl_parse_struct_string,
  1685. G_STRUCT_OFFSET (struct rspamd_config, zstd_output_dictionary),
  1686. RSPAMD_CL_FLAG_STRING_PATH,
  1687. "Dictionary for outbound zstd compression");
  1688. rspamd_rcl_add_default_handler (sub,
  1689. "compat_messages",
  1690. rspamd_rcl_parse_struct_boolean,
  1691. G_STRUCT_OFFSET (struct rspamd_config, compat_messages),
  1692. 0,
  1693. "Use pre 1.4 style of messages in the protocol");
  1694. rspamd_rcl_add_default_handler (sub,
  1695. "max_shots",
  1696. rspamd_rcl_parse_struct_integer,
  1697. G_STRUCT_OFFSET (struct rspamd_config, default_max_shots),
  1698. 0,
  1699. "Maximum number of hits per a single symbol (default: 100)");
  1700. rspamd_rcl_add_default_handler (sub,
  1701. "sessions_cache",
  1702. rspamd_rcl_parse_struct_boolean,
  1703. G_STRUCT_OFFSET (struct rspamd_config, enable_sessions_cache),
  1704. 0,
  1705. "Enable sessions cache to debug dangling sessions");
  1706. rspamd_rcl_add_default_handler (sub,
  1707. "max_sessions_cache",
  1708. rspamd_rcl_parse_struct_integer,
  1709. G_STRUCT_OFFSET (struct rspamd_config, max_sessions_cache),
  1710. 0,
  1711. "Maximum number of sessions in cache before warning (default: 100)");
  1712. /* Neighbours configuration */
  1713. rspamd_rcl_add_section_doc (&sub->subsections, "neighbours", "name",
  1714. rspamd_rcl_neighbours_handler,
  1715. UCL_OBJECT, FALSE, TRUE,
  1716. cfg->doc_strings,
  1717. "List of members of Rspamd cluster");
  1718. /* New DNS configuration */
  1719. ssub = rspamd_rcl_add_section_doc (&sub->subsections, "dns", NULL, NULL,
  1720. UCL_OBJECT, FALSE, TRUE,
  1721. cfg->doc_strings,
  1722. "Options for DNS resolver");
  1723. rspamd_rcl_add_default_handler (ssub,
  1724. "nameserver",
  1725. rspamd_rcl_parse_struct_ucl,
  1726. G_STRUCT_OFFSET (struct rspamd_config, nameservers),
  1727. 0,
  1728. "List of DNS servers");
  1729. rspamd_rcl_add_default_handler (ssub,
  1730. "server",
  1731. rspamd_rcl_parse_struct_ucl,
  1732. G_STRUCT_OFFSET (struct rspamd_config, nameservers),
  1733. 0,
  1734. "List of DNS servers");
  1735. rspamd_rcl_add_default_handler (ssub,
  1736. "timeout",
  1737. rspamd_rcl_parse_struct_time,
  1738. G_STRUCT_OFFSET (struct rspamd_config, dns_timeout),
  1739. RSPAMD_CL_FLAG_TIME_FLOAT,
  1740. "DNS request timeout");
  1741. rspamd_rcl_add_default_handler (ssub,
  1742. "retransmits",
  1743. rspamd_rcl_parse_struct_integer,
  1744. G_STRUCT_OFFSET (struct rspamd_config, dns_retransmits),
  1745. RSPAMD_CL_FLAG_INT_32,
  1746. "DNS request retransmits");
  1747. rspamd_rcl_add_default_handler (ssub,
  1748. "sockets",
  1749. rspamd_rcl_parse_struct_integer,
  1750. G_STRUCT_OFFSET (struct rspamd_config, dns_io_per_server),
  1751. RSPAMD_CL_FLAG_INT_32,
  1752. "Number of sockets per DNS server");
  1753. rspamd_rcl_add_default_handler (ssub,
  1754. "connections",
  1755. rspamd_rcl_parse_struct_integer,
  1756. G_STRUCT_OFFSET (struct rspamd_config, dns_io_per_server),
  1757. RSPAMD_CL_FLAG_INT_32,
  1758. "Number of sockets per DNS server");
  1759. rspamd_rcl_add_default_handler (ssub,
  1760. "enable_dnssec",
  1761. rspamd_rcl_parse_struct_boolean,
  1762. G_STRUCT_OFFSET (struct rspamd_config, enable_dnssec),
  1763. 0,
  1764. "Enable DNSSEC support in Rspamd");
  1765. /* New upstreams configuration */
  1766. ssub = rspamd_rcl_add_section_doc (&sub->subsections, "upstream", NULL, NULL,
  1767. UCL_OBJECT, FALSE, TRUE,
  1768. cfg->doc_strings,
  1769. "Upstreams configuration parameters");
  1770. rspamd_rcl_add_default_handler (ssub,
  1771. "max_errors",
  1772. rspamd_rcl_parse_struct_integer,
  1773. G_STRUCT_OFFSET (struct rspamd_config, upstream_max_errors),
  1774. RSPAMD_CL_FLAG_UINT,
  1775. "Maximum number of errors during `error_time` to consider upstream down");
  1776. rspamd_rcl_add_default_handler (ssub,
  1777. "error_time",
  1778. rspamd_rcl_parse_struct_time,
  1779. G_STRUCT_OFFSET (struct rspamd_config, upstream_error_time),
  1780. RSPAMD_CL_FLAG_TIME_FLOAT,
  1781. "Time frame to check errors");
  1782. rspamd_rcl_add_default_handler (ssub,
  1783. "revive_time",
  1784. rspamd_rcl_parse_struct_time,
  1785. G_STRUCT_OFFSET (struct rspamd_config, upstream_revive_time),
  1786. RSPAMD_CL_FLAG_TIME_FLOAT,
  1787. "Time before attempting to recover upstream after an error");
  1788. }
  1789. if (!(skip_sections && g_hash_table_lookup (skip_sections, "actions"))) {
  1790. /**
  1791. * Symbols and actions sections
  1792. */
  1793. sub = rspamd_rcl_add_section_doc (&new,
  1794. "actions", NULL,
  1795. rspamd_rcl_actions_handler,
  1796. UCL_OBJECT,
  1797. FALSE,
  1798. TRUE,
  1799. cfg->doc_strings,
  1800. "Actions configuration");
  1801. rspamd_rcl_add_default_handler (sub,
  1802. "unknown_weight",
  1803. rspamd_rcl_parse_struct_double,
  1804. G_STRUCT_OFFSET (struct rspamd_config, unknown_weight),
  1805. 0,
  1806. "Accept unknown symbols with the specified weight");
  1807. rspamd_rcl_add_default_handler (sub,
  1808. "grow_factor",
  1809. rspamd_rcl_parse_struct_double,
  1810. G_STRUCT_OFFSET (struct rspamd_config, grow_factor),
  1811. 0,
  1812. "Multiply the subsequent symbols by this number "
  1813. "(does not affect symbols with score less or "
  1814. "equal to zero)");
  1815. rspamd_rcl_add_default_handler (sub,
  1816. "subject",
  1817. rspamd_rcl_parse_struct_string,
  1818. G_STRUCT_OFFSET (struct rspamd_config, subject),
  1819. 0,
  1820. "Rewrite subject with this value");
  1821. }
  1822. if (!(skip_sections && g_hash_table_lookup (skip_sections, "group"))) {
  1823. sub = rspamd_rcl_add_section_doc (&new,
  1824. "group", "name",
  1825. rspamd_rcl_group_handler,
  1826. UCL_OBJECT,
  1827. FALSE,
  1828. TRUE,
  1829. cfg->doc_strings,
  1830. "Symbol groups configuration");
  1831. ssub = rspamd_rcl_add_section_doc (&sub->subsections, "symbols", "name",
  1832. rspamd_rcl_symbol_handler,
  1833. UCL_OBJECT, FALSE, TRUE,
  1834. cfg->doc_strings,
  1835. "Symbols configuration");
  1836. /* Group part */
  1837. rspamd_rcl_add_default_handler (sub,
  1838. "disabled",
  1839. rspamd_rcl_parse_struct_boolean,
  1840. G_STRUCT_OFFSET (struct rspamd_symbols_group, disabled),
  1841. 0,
  1842. "Disable symbols group");
  1843. rspamd_rcl_add_default_handler (sub,
  1844. "enabled",
  1845. rspamd_rcl_parse_struct_boolean,
  1846. G_STRUCT_OFFSET (struct rspamd_symbols_group, disabled),
  1847. RSPAMD_CL_FLAG_BOOLEAN_INVERSE,
  1848. "Enable or disable symbols group");
  1849. rspamd_rcl_add_default_handler (sub,
  1850. "max_score",
  1851. rspamd_rcl_parse_struct_double,
  1852. G_STRUCT_OFFSET (struct rspamd_symbols_group, max_score),
  1853. 0,
  1854. "Maximum score that could be reached by this symbols group");
  1855. }
  1856. if (!(skip_sections && g_hash_table_lookup (skip_sections, "worker"))) {
  1857. /**
  1858. * Worker section
  1859. */
  1860. sub = rspamd_rcl_add_section_doc (&new,
  1861. "worker", "type",
  1862. rspamd_rcl_worker_handler,
  1863. UCL_OBJECT,
  1864. FALSE,
  1865. TRUE,
  1866. cfg->doc_strings,
  1867. "Workers common options");
  1868. rspamd_rcl_add_default_handler (sub,
  1869. "count",
  1870. rspamd_rcl_parse_struct_integer,
  1871. G_STRUCT_OFFSET (struct rspamd_worker_conf, count),
  1872. RSPAMD_CL_FLAG_INT_16,
  1873. "Number of workers to spawn");
  1874. rspamd_rcl_add_default_handler (sub,
  1875. "max_files",
  1876. rspamd_rcl_parse_struct_integer,
  1877. G_STRUCT_OFFSET (struct rspamd_worker_conf, rlimit_nofile),
  1878. RSPAMD_CL_FLAG_INT_32,
  1879. "Maximum number of opened files per worker");
  1880. rspamd_rcl_add_default_handler (sub,
  1881. "max_core",
  1882. rspamd_rcl_parse_struct_integer,
  1883. G_STRUCT_OFFSET (struct rspamd_worker_conf, rlimit_maxcore),
  1884. RSPAMD_CL_FLAG_INT_32,
  1885. "Max size of core file in bytes");
  1886. rspamd_rcl_add_default_handler (sub,
  1887. "enabled",
  1888. rspamd_rcl_parse_struct_boolean,
  1889. G_STRUCT_OFFSET (struct rspamd_worker_conf, enabled),
  1890. 0,
  1891. "Enable or disable a worker (true by default)");
  1892. }
  1893. if (!(skip_sections && g_hash_table_lookup (skip_sections, "modules"))) {
  1894. /**
  1895. * Modules handler
  1896. */
  1897. sub = rspamd_rcl_add_section_doc (&new,
  1898. "modules", NULL,
  1899. rspamd_rcl_modules_handler,
  1900. UCL_OBJECT,
  1901. FALSE,
  1902. FALSE,
  1903. cfg->doc_strings,
  1904. "Lua plugins to load");
  1905. }
  1906. if (!(skip_sections && g_hash_table_lookup (skip_sections, "classifier"))) {
  1907. /**
  1908. * Classifiers handler
  1909. */
  1910. sub = rspamd_rcl_add_section_doc (&new,
  1911. "classifier", "type",
  1912. rspamd_rcl_classifier_handler,
  1913. UCL_OBJECT,
  1914. FALSE,
  1915. TRUE,
  1916. cfg->doc_strings,
  1917. "CLassifier options");
  1918. /* Default classifier is 'bayes' for now */
  1919. sub->default_key = "bayes";
  1920. rspamd_rcl_add_default_handler (sub,
  1921. "min_tokens",
  1922. rspamd_rcl_parse_struct_integer,
  1923. G_STRUCT_OFFSET (struct rspamd_classifier_config, min_tokens),
  1924. RSPAMD_CL_FLAG_INT_32,
  1925. "Minimum count of tokens (words) to be considered for statistics");
  1926. rspamd_rcl_add_default_handler (sub,
  1927. "max_tokens",
  1928. rspamd_rcl_parse_struct_integer,
  1929. G_STRUCT_OFFSET (struct rspamd_classifier_config, max_tokens),
  1930. RSPAMD_CL_FLAG_INT_32,
  1931. "Maximum count of tokens (words) to be considered for statistics");
  1932. rspamd_rcl_add_default_handler (sub,
  1933. "min_learns",
  1934. rspamd_rcl_parse_struct_integer,
  1935. G_STRUCT_OFFSET (struct rspamd_classifier_config, min_learns),
  1936. RSPAMD_CL_FLAG_UINT,
  1937. "Minimum number of learns for each statfile to use this classifier");
  1938. rspamd_rcl_add_default_handler (sub,
  1939. "backend",
  1940. rspamd_rcl_parse_struct_string,
  1941. G_STRUCT_OFFSET (struct rspamd_classifier_config, backend),
  1942. 0,
  1943. "Statfiles engine");
  1944. rspamd_rcl_add_default_handler (sub,
  1945. "name",
  1946. rspamd_rcl_parse_struct_string,
  1947. G_STRUCT_OFFSET (struct rspamd_classifier_config, name),
  1948. 0,
  1949. "Name of classifier");
  1950. /*
  1951. * Statfile defaults
  1952. */
  1953. ssub = rspamd_rcl_add_section_doc (&sub->subsections,
  1954. "statfile", "symbol",
  1955. rspamd_rcl_statfile_handler,
  1956. UCL_OBJECT,
  1957. TRUE,
  1958. TRUE,
  1959. sub->doc_ref,
  1960. "Statfiles options");
  1961. rspamd_rcl_add_default_handler (ssub,
  1962. "label",
  1963. rspamd_rcl_parse_struct_string,
  1964. G_STRUCT_OFFSET (struct rspamd_statfile_config, label),
  1965. 0,
  1966. "Statfile unique label");
  1967. rspamd_rcl_add_default_handler (ssub,
  1968. "spam",
  1969. rspamd_rcl_parse_struct_boolean,
  1970. G_STRUCT_OFFSET (struct rspamd_statfile_config, is_spam),
  1971. 0,
  1972. "Sets if this statfile contains spam samples");
  1973. }
  1974. if (!(skip_sections && g_hash_table_lookup (skip_sections, "composite"))) {
  1975. /**
  1976. * Composites handlers
  1977. */
  1978. sub = rspamd_rcl_add_section_doc (&new,
  1979. "composite", "name",
  1980. rspamd_rcl_composite_handler,
  1981. UCL_OBJECT,
  1982. FALSE,
  1983. TRUE,
  1984. cfg->doc_strings,
  1985. "Rspamd composite symbols");
  1986. sub = rspamd_rcl_add_section_doc (&new,
  1987. "composites", NULL,
  1988. rspamd_rcl_composites_handler,
  1989. UCL_OBJECT,
  1990. FALSE,
  1991. TRUE,
  1992. cfg->doc_strings,
  1993. "Rspamd composite symbols");
  1994. }
  1995. if (!(skip_sections && g_hash_table_lookup (skip_sections, "lua"))) {
  1996. /**
  1997. * Lua handler
  1998. */
  1999. sub = rspamd_rcl_add_section_doc (&new,
  2000. "lua", NULL,
  2001. rspamd_rcl_lua_handler,
  2002. UCL_STRING,
  2003. FALSE,
  2004. TRUE,
  2005. cfg->doc_strings,
  2006. "Lua files to load");
  2007. }
  2008. return new;
  2009. }
  2010. struct rspamd_rcl_section *
  2011. rspamd_rcl_config_get_section (struct rspamd_rcl_section *top,
  2012. const char *path)
  2013. {
  2014. struct rspamd_rcl_section *cur, *found = NULL;
  2015. char **path_components;
  2016. gint ncomponents, i;
  2017. if (path == NULL) {
  2018. return top;
  2019. }
  2020. path_components = g_strsplit_set (path, "/", -1);
  2021. ncomponents = g_strv_length (path_components);
  2022. cur = top;
  2023. for (i = 0; i < ncomponents; i++) {
  2024. if (cur == NULL) {
  2025. g_strfreev (path_components);
  2026. return NULL;
  2027. }
  2028. HASH_FIND_STR (cur, path_components[i], found);
  2029. if (found == NULL) {
  2030. g_strfreev (path_components);
  2031. return NULL;
  2032. }
  2033. cur = found;
  2034. }
  2035. g_strfreev (path_components);
  2036. return found;
  2037. }
  2038. static gboolean
  2039. rspamd_rcl_process_section (struct rspamd_config *cfg,
  2040. struct rspamd_rcl_section *sec,
  2041. gpointer ptr, const ucl_object_t *obj, rspamd_mempool_t *pool,
  2042. GError **err)
  2043. {
  2044. ucl_object_iter_t it;
  2045. const ucl_object_t *cur;
  2046. gboolean is_nested = TRUE;
  2047. const gchar *key = NULL;
  2048. g_assert (obj != NULL);
  2049. g_assert (sec->handler != NULL);
  2050. if (sec->key_attr != NULL) {
  2051. it = ucl_object_iterate_new (obj);
  2052. while ((cur = ucl_object_iterate_full (it, UCL_ITERATE_EXPLICIT)) != NULL) {
  2053. if (ucl_object_type (cur) != UCL_OBJECT) {
  2054. is_nested = FALSE;
  2055. break;
  2056. }
  2057. }
  2058. ucl_object_iterate_free (it);
  2059. }
  2060. else {
  2061. is_nested = FALSE;
  2062. }
  2063. if (is_nested) {
  2064. /* Just reiterate on all subobjects */
  2065. it = ucl_object_iterate_new (obj);
  2066. while ((cur = ucl_object_iterate_full (it, UCL_ITERATE_EXPLICIT)) != NULL) {
  2067. if (!sec->handler (pool, cur, ucl_object_key (cur), ptr, sec, err)) {
  2068. ucl_object_iterate_free (it);
  2069. return FALSE;
  2070. }
  2071. }
  2072. ucl_object_iterate_free (it);
  2073. return TRUE;
  2074. }
  2075. else {
  2076. if (sec->key_attr != NULL) {
  2077. /* First of all search for required attribute and use it as a key */
  2078. cur = ucl_object_lookup (obj, sec->key_attr);
  2079. if (cur == NULL) {
  2080. if (sec->default_key == NULL) {
  2081. g_set_error (err, CFG_RCL_ERROR, EINVAL, "required attribute "
  2082. "'%s' is missing for section '%s', current key: %s",
  2083. sec->key_attr,
  2084. sec->name,
  2085. ucl_object_emit (obj, UCL_EMIT_CONFIG));
  2086. return FALSE;
  2087. }
  2088. else {
  2089. msg_info ("using default key '%s' for mandatory field '%s' "
  2090. "for section '%s'", sec->default_key, sec->key_attr,
  2091. sec->name);
  2092. key = sec->default_key;
  2093. }
  2094. }
  2095. else if (ucl_object_type (cur) != UCL_STRING) {
  2096. g_set_error (err, CFG_RCL_ERROR, EINVAL, "required attribute %s"
  2097. " is not a string for section %s",
  2098. sec->key_attr, sec->name);
  2099. return FALSE;
  2100. }
  2101. else {
  2102. key = ucl_object_tostring (cur);
  2103. }
  2104. }
  2105. }
  2106. return sec->handler (pool, obj, key, ptr, sec, err);
  2107. }
  2108. gboolean
  2109. rspamd_rcl_parse (struct rspamd_rcl_section *top,
  2110. struct rspamd_config *cfg,
  2111. gpointer ptr, rspamd_mempool_t *pool,
  2112. const ucl_object_t *obj, GError **err)
  2113. {
  2114. const ucl_object_t *found, *cur_obj;
  2115. struct rspamd_rcl_section *cur, *tmp, *found_sec;
  2116. if (obj->type != UCL_OBJECT) {
  2117. g_set_error (err,
  2118. CFG_RCL_ERROR,
  2119. EINVAL,
  2120. "top configuration must be an object");
  2121. return FALSE;
  2122. }
  2123. /* Iterate over known sections and ignore unknown ones */
  2124. HASH_ITER (hh, top, cur, tmp)
  2125. {
  2126. if (strcmp (cur->name, "*") == 0) {
  2127. /* Default section handler */
  2128. LL_FOREACH (obj, cur_obj) {
  2129. HASH_FIND_STR (top, ucl_object_key (cur_obj), found_sec);
  2130. if (found_sec == NULL) {
  2131. if (cur->handler != NULL) {
  2132. if (!rspamd_rcl_process_section (cfg, cur, ptr, cur_obj,
  2133. pool, err)) {
  2134. return FALSE;
  2135. }
  2136. }
  2137. else {
  2138. rspamd_rcl_section_parse_defaults (cfg,
  2139. cur,
  2140. pool,
  2141. cur_obj,
  2142. ptr,
  2143. err);
  2144. }
  2145. }
  2146. }
  2147. }
  2148. else {
  2149. found = ucl_object_lookup (obj, cur->name);
  2150. if (found == NULL) {
  2151. if (cur->required) {
  2152. g_set_error (err, CFG_RCL_ERROR, ENOENT,
  2153. "required section %s is missing", cur->name);
  2154. return FALSE;
  2155. }
  2156. }
  2157. else {
  2158. /* Check type */
  2159. if (cur->strict_type) {
  2160. if (cur->type != found->type) {
  2161. g_set_error (err, CFG_RCL_ERROR, EINVAL,
  2162. "object in section %s has invalid type", cur->name);
  2163. return FALSE;
  2164. }
  2165. }
  2166. LL_FOREACH (found, cur_obj) {
  2167. if (cur->handler != NULL) {
  2168. if (!rspamd_rcl_process_section (cfg, cur, ptr, cur_obj,
  2169. pool, err)) {
  2170. return FALSE;
  2171. }
  2172. }
  2173. else {
  2174. rspamd_rcl_section_parse_defaults (cfg, cur,
  2175. pool,
  2176. cur_obj,
  2177. ptr,
  2178. err);
  2179. }
  2180. }
  2181. }
  2182. }
  2183. if (cur->fin) {
  2184. cur->fin (pool, cur->fin_ud);
  2185. }
  2186. }
  2187. return TRUE;
  2188. }
  2189. gboolean
  2190. rspamd_rcl_section_parse_defaults (struct rspamd_config *cfg,
  2191. struct rspamd_rcl_section *section,
  2192. rspamd_mempool_t *pool, const ucl_object_t *obj, gpointer ptr,
  2193. GError **err)
  2194. {
  2195. const ucl_object_t *found, *cur_obj;
  2196. struct rspamd_rcl_default_handler_data *cur, *tmp;
  2197. if (obj->type != UCL_OBJECT) {
  2198. g_set_error (err,
  2199. CFG_RCL_ERROR,
  2200. EINVAL,
  2201. "default configuration must be an object for section %s "
  2202. "(actual type is %s)",
  2203. section->name, ucl_object_type_to_string (obj->type));
  2204. return FALSE;
  2205. }
  2206. HASH_ITER (hh, section->default_parser, cur, tmp)
  2207. {
  2208. found = ucl_object_lookup (obj, cur->key);
  2209. if (found != NULL) {
  2210. cur->pd.user_struct = ptr;
  2211. cur->pd.cfg = cfg;
  2212. LL_FOREACH (found, cur_obj) {
  2213. if (!cur->handler (pool, cur_obj, &cur->pd, section, err)) {
  2214. return FALSE;
  2215. }
  2216. if (!(cur->pd.flags & RSPAMD_CL_FLAG_MULTIPLE)) {
  2217. break;
  2218. }
  2219. }
  2220. }
  2221. }
  2222. return TRUE;
  2223. }
  2224. gboolean
  2225. rspamd_rcl_parse_struct_string (rspamd_mempool_t *pool,
  2226. const ucl_object_t *obj,
  2227. gpointer ud,
  2228. struct rspamd_rcl_section *section,
  2229. GError **err)
  2230. {
  2231. struct rspamd_rcl_struct_parser *pd = ud;
  2232. gchar **target;
  2233. const gsize num_str_len = 32;
  2234. target = (gchar **)(((gchar *)pd->user_struct) + pd->offset);
  2235. switch (obj->type) {
  2236. case UCL_STRING:
  2237. *target =
  2238. rspamd_mempool_strdup (pool, ucl_copy_value_trash (obj));
  2239. break;
  2240. case UCL_INT:
  2241. *target = rspamd_mempool_alloc (pool, num_str_len);
  2242. rspamd_snprintf (*target, num_str_len, "%L", obj->value.iv);
  2243. break;
  2244. case UCL_FLOAT:
  2245. *target = rspamd_mempool_alloc (pool, num_str_len);
  2246. rspamd_snprintf (*target, num_str_len, "%f", obj->value.dv);
  2247. break;
  2248. case UCL_BOOLEAN:
  2249. *target = rspamd_mempool_alloc (pool, num_str_len);
  2250. rspamd_snprintf (*target, num_str_len, "%s",
  2251. ((gboolean)obj->value.iv) ? "true" : "false");
  2252. break;
  2253. default:
  2254. g_set_error (err,
  2255. CFG_RCL_ERROR,
  2256. EINVAL,
  2257. "cannot convert object or array to string");
  2258. return FALSE;
  2259. }
  2260. return TRUE;
  2261. }
  2262. gboolean
  2263. rspamd_rcl_parse_struct_integer (rspamd_mempool_t *pool,
  2264. const ucl_object_t *obj,
  2265. gpointer ud,
  2266. struct rspamd_rcl_section *section,
  2267. GError **err)
  2268. {
  2269. struct rspamd_rcl_struct_parser *pd = ud;
  2270. union {
  2271. gint *ip;
  2272. gint32 *i32p;
  2273. gint16 *i16p;
  2274. gint64 *i64p;
  2275. guint *up;
  2276. gsize *sp;
  2277. } target;
  2278. int64_t val;
  2279. if (pd->flags == RSPAMD_CL_FLAG_INT_32) {
  2280. target.i32p = (gint32 *)(((gchar *)pd->user_struct) + pd->offset);
  2281. if (!ucl_object_toint_safe (obj, &val)) {
  2282. g_set_error (err,
  2283. CFG_RCL_ERROR,
  2284. EINVAL,
  2285. "cannot convert param to integer");
  2286. return FALSE;
  2287. }
  2288. *target.i32p = val;
  2289. }
  2290. else if (pd->flags == RSPAMD_CL_FLAG_INT_64) {
  2291. target.i64p = (gint64 *)(((gchar *)pd->user_struct) + pd->offset);
  2292. if (!ucl_object_toint_safe (obj, &val)) {
  2293. g_set_error (err,
  2294. CFG_RCL_ERROR,
  2295. EINVAL,
  2296. "cannot convert param to integer");
  2297. return FALSE;
  2298. }
  2299. *target.i64p = val;
  2300. }
  2301. else if (pd->flags == RSPAMD_CL_FLAG_INT_SIZE) {
  2302. target.sp = (gsize *)(((gchar *)pd->user_struct) + pd->offset);
  2303. if (!ucl_object_toint_safe (obj, &val)) {
  2304. g_set_error (err,
  2305. CFG_RCL_ERROR,
  2306. EINVAL,
  2307. "cannot convert param to integer");
  2308. return FALSE;
  2309. }
  2310. *target.sp = val;
  2311. }
  2312. else if (pd->flags == RSPAMD_CL_FLAG_INT_16) {
  2313. target.i16p = (gint16 *)(((gchar *)pd->user_struct) + pd->offset);
  2314. if (!ucl_object_toint_safe (obj, &val)) {
  2315. g_set_error (err,
  2316. CFG_RCL_ERROR,
  2317. EINVAL,
  2318. "cannot convert param to integer");
  2319. return FALSE;
  2320. }
  2321. *target.i16p = val;
  2322. }
  2323. else if (pd->flags == RSPAMD_CL_FLAG_UINT) {
  2324. target.up = (guint *)(((gchar *)pd->user_struct) + pd->offset);
  2325. if (!ucl_object_toint_safe (obj, &val)) {
  2326. g_set_error (err,
  2327. CFG_RCL_ERROR,
  2328. EINVAL,
  2329. "cannot convert param to integer");
  2330. return FALSE;
  2331. }
  2332. *target.up = val;
  2333. }
  2334. else {
  2335. target.ip = (gint *)(((gchar *)pd->user_struct) + pd->offset);
  2336. if (!ucl_object_toint_safe (obj, &val)) {
  2337. g_set_error (err,
  2338. CFG_RCL_ERROR,
  2339. EINVAL,
  2340. "cannot convert param to integer");
  2341. return FALSE;
  2342. }
  2343. *target.ip = val;
  2344. }
  2345. return TRUE;
  2346. }
  2347. gboolean
  2348. rspamd_rcl_parse_struct_double (rspamd_mempool_t *pool,
  2349. const ucl_object_t *obj,
  2350. gpointer ud,
  2351. struct rspamd_rcl_section *section,
  2352. GError **err)
  2353. {
  2354. struct rspamd_rcl_struct_parser *pd = ud;
  2355. gdouble *target;
  2356. target = (gdouble *)(((gchar *)pd->user_struct) + pd->offset);
  2357. if (!ucl_object_todouble_safe (obj, target)) {
  2358. g_set_error (err,
  2359. CFG_RCL_ERROR,
  2360. EINVAL,
  2361. "cannot convert param %s to double", ucl_object_key (obj));
  2362. return FALSE;
  2363. }
  2364. return TRUE;
  2365. }
  2366. gboolean
  2367. rspamd_rcl_parse_struct_time (rspamd_mempool_t *pool,
  2368. const ucl_object_t *obj,
  2369. gpointer ud,
  2370. struct rspamd_rcl_section *section,
  2371. GError **err)
  2372. {
  2373. struct rspamd_rcl_struct_parser *pd = ud;
  2374. union {
  2375. gint *psec;
  2376. guint32 *pu32;
  2377. gdouble *pdv;
  2378. struct timeval *ptv;
  2379. struct timespec *pts;
  2380. } target;
  2381. gdouble val;
  2382. if (!ucl_object_todouble_safe (obj, &val)) {
  2383. g_set_error (err,
  2384. CFG_RCL_ERROR,
  2385. EINVAL,
  2386. "cannot convert param %s to double", ucl_object_key (obj));
  2387. return FALSE;
  2388. }
  2389. if (pd->flags == RSPAMD_CL_FLAG_TIME_TIMEVAL) {
  2390. target.ptv =
  2391. (struct timeval *)(((gchar *)pd->user_struct) + pd->offset);
  2392. target.ptv->tv_sec = (glong)val;
  2393. target.ptv->tv_usec = (val - (glong)val) * 1000000;
  2394. }
  2395. else if (pd->flags == RSPAMD_CL_FLAG_TIME_TIMESPEC) {
  2396. target.pts =
  2397. (struct timespec *)(((gchar *)pd->user_struct) + pd->offset);
  2398. target.pts->tv_sec = (glong)val;
  2399. target.pts->tv_nsec = (val - (glong)val) * 1000000000000LL;
  2400. }
  2401. else if (pd->flags == RSPAMD_CL_FLAG_TIME_FLOAT) {
  2402. target.pdv = (double *)(((gchar *)pd->user_struct) + pd->offset);
  2403. *target.pdv = val;
  2404. }
  2405. else if (pd->flags == RSPAMD_CL_FLAG_TIME_INTEGER) {
  2406. target.psec = (gint *)(((gchar *)pd->user_struct) + pd->offset);
  2407. *target.psec = val * 1000;
  2408. }
  2409. else if (pd->flags == RSPAMD_CL_FLAG_TIME_UINT_32) {
  2410. target.pu32 = (guint32 *)(((gchar *)pd->user_struct) + pd->offset);
  2411. *target.pu32 = val * 1000;
  2412. }
  2413. else {
  2414. g_set_error (err,
  2415. CFG_RCL_ERROR,
  2416. EINVAL,
  2417. "invalid flags to parse time value in %s", ucl_object_key (obj));
  2418. return FALSE;
  2419. }
  2420. return TRUE;
  2421. }
  2422. gboolean
  2423. rspamd_rcl_parse_struct_keypair (rspamd_mempool_t *pool,
  2424. const ucl_object_t *obj,
  2425. gpointer ud,
  2426. struct rspamd_rcl_section *section,
  2427. GError **err)
  2428. {
  2429. struct rspamd_rcl_struct_parser *pd = ud;
  2430. struct rspamd_cryptobox_keypair **target, *kp;
  2431. target = (struct rspamd_cryptobox_keypair **)(((gchar *)pd->user_struct) +
  2432. pd->offset);
  2433. if (obj->type == UCL_OBJECT) {
  2434. kp = rspamd_keypair_from_ucl (obj);
  2435. if (kp != NULL) {
  2436. rspamd_mempool_add_destructor (pool,
  2437. (rspamd_mempool_destruct_t)rspamd_keypair_unref, kp);
  2438. *target = kp;
  2439. }
  2440. else {
  2441. g_set_error (err,
  2442. CFG_RCL_ERROR,
  2443. EINVAL,
  2444. "cannot load the keypair specified: %s",
  2445. ucl_object_key (obj));
  2446. return FALSE;
  2447. }
  2448. }
  2449. else {
  2450. g_set_error (err,
  2451. CFG_RCL_ERROR,
  2452. EINVAL,
  2453. "no sane pubkey or privkey found in the keypair: %s",
  2454. ucl_object_key (obj));
  2455. return FALSE;
  2456. }
  2457. return TRUE;
  2458. }
  2459. gboolean
  2460. rspamd_rcl_parse_struct_pubkey (rspamd_mempool_t *pool,
  2461. const ucl_object_t *obj,
  2462. gpointer ud,
  2463. struct rspamd_rcl_section *section,
  2464. GError **err)
  2465. {
  2466. struct rspamd_rcl_struct_parser *pd = ud;
  2467. struct rspamd_cryptobox_pubkey **target, *pk;
  2468. gsize len;
  2469. const gchar *str;
  2470. gint keypair_type = RSPAMD_KEYPAIR_KEX,
  2471. keypair_mode = RSPAMD_CRYPTOBOX_MODE_25519;
  2472. if (pd->flags & RSPAMD_CL_FLAG_SIGNKEY) {
  2473. keypair_type = RSPAMD_KEYPAIR_SIGN;
  2474. }
  2475. if (pd->flags & RSPAMD_CL_FLAG_NISTKEY) {
  2476. keypair_mode = RSPAMD_CRYPTOBOX_MODE_NIST;
  2477. }
  2478. target = (struct rspamd_cryptobox_pubkey **)(((gchar *)pd->user_struct) +
  2479. pd->offset);
  2480. if (obj->type == UCL_STRING) {
  2481. str = ucl_object_tolstring (obj, &len);
  2482. pk = rspamd_pubkey_from_base32 (str, len, keypair_type,
  2483. keypair_mode);
  2484. if (pk != NULL) {
  2485. *target = pk;
  2486. }
  2487. else {
  2488. g_set_error (err,
  2489. CFG_RCL_ERROR,
  2490. EINVAL,
  2491. "cannot load the pubkey specified: %s",
  2492. ucl_object_key (obj));
  2493. return FALSE;
  2494. }
  2495. }
  2496. else {
  2497. g_set_error (err,
  2498. CFG_RCL_ERROR,
  2499. EINVAL,
  2500. "no sane pubkey found in the element: %s",
  2501. ucl_object_key (obj));
  2502. return FALSE;
  2503. }
  2504. rspamd_mempool_add_destructor (pool,
  2505. (rspamd_mempool_destruct_t)rspamd_pubkey_unref, pk);
  2506. return TRUE;
  2507. }
  2508. static void
  2509. rspamd_rcl_insert_string_list_item (gpointer *target, rspamd_mempool_t *pool,
  2510. const gchar *src, gboolean is_hash)
  2511. {
  2512. union {
  2513. GHashTable *hv;
  2514. GList *lv;
  2515. gpointer p;
  2516. } d;
  2517. gchar *val;
  2518. d.p = *target;
  2519. if (is_hash) {
  2520. if (d.hv == NULL) {
  2521. d.hv = g_hash_table_new (rspamd_str_hash, rspamd_str_equal);
  2522. rspamd_mempool_add_destructor (pool,
  2523. (rspamd_mempool_destruct_t)g_hash_table_unref, d.hv);
  2524. }
  2525. val = rspamd_mempool_strdup (pool, src);
  2526. g_hash_table_insert (d.hv, val, val);
  2527. }
  2528. else {
  2529. val = rspamd_mempool_strdup (pool, src);
  2530. d.lv = g_list_prepend (d.lv, val);
  2531. }
  2532. *target = d.p;
  2533. }
  2534. gboolean
  2535. rspamd_rcl_parse_struct_string_list (rspamd_mempool_t *pool,
  2536. const ucl_object_t *obj,
  2537. gpointer ud,
  2538. struct rspamd_rcl_section *section,
  2539. GError **err)
  2540. {
  2541. struct rspamd_rcl_struct_parser *pd = ud;
  2542. gpointer *target;
  2543. gchar *val, **strvec, **cvec;
  2544. const ucl_object_t *cur;
  2545. const gsize num_str_len = 32;
  2546. ucl_object_iter_t iter = NULL;
  2547. gboolean is_hash, need_destructor = TRUE;
  2548. is_hash = pd->flags & RSPAMD_CL_FLAG_STRING_LIST_HASH;
  2549. target = (gpointer *)(((gchar *)pd->user_struct) + pd->offset);
  2550. if (!is_hash && *target != NULL) {
  2551. need_destructor = FALSE;
  2552. }
  2553. iter = ucl_object_iterate_new (obj);
  2554. while ((cur = ucl_object_iterate_safe (iter, true)) != NULL) {
  2555. switch (cur->type) {
  2556. case UCL_STRING:
  2557. strvec = g_strsplit_set (ucl_object_tostring (cur), ",", -1);
  2558. cvec = strvec;
  2559. while (*cvec) {
  2560. rspamd_rcl_insert_string_list_item (target, pool, *cvec, is_hash);
  2561. cvec ++;
  2562. }
  2563. g_strfreev (strvec);
  2564. /* Go to the next object */
  2565. continue;
  2566. case UCL_INT:
  2567. val = rspamd_mempool_alloc (pool, num_str_len);
  2568. rspamd_snprintf (val, num_str_len, "%L", cur->value.iv);
  2569. break;
  2570. case UCL_FLOAT:
  2571. val = rspamd_mempool_alloc (pool, num_str_len);
  2572. rspamd_snprintf (val, num_str_len, "%f", cur->value.dv);
  2573. break;
  2574. case UCL_BOOLEAN:
  2575. val = rspamd_mempool_alloc (pool, num_str_len);
  2576. rspamd_snprintf (val, num_str_len, "%s",
  2577. ((gboolean)cur->value.iv) ? "true" : "false");
  2578. break;
  2579. default:
  2580. g_set_error (err,
  2581. CFG_RCL_ERROR,
  2582. EINVAL,
  2583. "cannot convert an object or array to string: %s",
  2584. ucl_object_key (obj));
  2585. ucl_object_iterate_free (iter);
  2586. return FALSE;
  2587. }
  2588. rspamd_rcl_insert_string_list_item (target, pool, val, is_hash);
  2589. }
  2590. ucl_object_iterate_free (iter);
  2591. if (*target == NULL) {
  2592. g_set_error (err,
  2593. CFG_RCL_ERROR,
  2594. EINVAL,
  2595. "non-empty array of strings is expected: %s, "
  2596. "got: %s, of length: %d",
  2597. ucl_object_key (obj), ucl_object_type_to_string (obj->type),
  2598. obj->len);
  2599. return FALSE;
  2600. }
  2601. if (!is_hash && *target != NULL) {
  2602. *target = g_list_reverse (*target);
  2603. if (need_destructor) {
  2604. rspamd_mempool_add_destructor (pool,
  2605. (rspamd_mempool_destruct_t) g_list_free,
  2606. *target);
  2607. }
  2608. }
  2609. return TRUE;
  2610. }
  2611. gboolean
  2612. rspamd_rcl_parse_struct_ucl (rspamd_mempool_t *pool,
  2613. const ucl_object_t *obj,
  2614. gpointer ud,
  2615. struct rspamd_rcl_section *section,
  2616. GError **err)
  2617. {
  2618. struct rspamd_rcl_struct_parser *pd = ud;
  2619. const ucl_object_t **target;
  2620. target = (const ucl_object_t **)(((gchar *)pd->user_struct) + pd->offset);
  2621. *target = obj;
  2622. return TRUE;
  2623. }
  2624. gboolean
  2625. rspamd_rcl_parse_struct_boolean (rspamd_mempool_t *pool,
  2626. const ucl_object_t *obj,
  2627. gpointer ud,
  2628. struct rspamd_rcl_section *section,
  2629. GError **err)
  2630. {
  2631. struct rspamd_rcl_struct_parser *pd = ud;
  2632. gboolean *target;
  2633. target = (gboolean *)(((gchar *)pd->user_struct) + pd->offset);
  2634. if (obj->type == UCL_BOOLEAN) {
  2635. *target = obj->value.iv;
  2636. }
  2637. else if (obj->type == UCL_INT) {
  2638. *target = obj->value.iv;
  2639. }
  2640. else {
  2641. g_set_error (err,
  2642. CFG_RCL_ERROR,
  2643. EINVAL,
  2644. "cannot convert an object to boolean: %s",
  2645. ucl_object_key (obj));
  2646. return FALSE;
  2647. }
  2648. if (pd->flags & RSPAMD_CL_FLAG_BOOLEAN_INVERSE) {
  2649. *target = !*target;
  2650. }
  2651. return TRUE;
  2652. }
  2653. gboolean
  2654. rspamd_rcl_parse_struct_addr (rspamd_mempool_t *pool,
  2655. const ucl_object_t *obj,
  2656. gpointer ud,
  2657. struct rspamd_rcl_section *section,
  2658. GError **err)
  2659. {
  2660. struct rspamd_rcl_struct_parser *pd = ud;
  2661. rspamd_inet_addr_t **target;
  2662. const gchar *val;
  2663. target = (rspamd_inet_addr_t **)(((gchar *)pd->user_struct) + pd->offset);
  2664. if (ucl_object_type (obj) == UCL_STRING) {
  2665. val = ucl_object_tostring (obj);
  2666. if (!rspamd_parse_inet_address (target, val, 0)) {
  2667. g_set_error (err,
  2668. CFG_RCL_ERROR,
  2669. EINVAL,
  2670. "cannot parse inet address: %s", val);
  2671. return FALSE;
  2672. }
  2673. }
  2674. else {
  2675. g_set_error (err,
  2676. CFG_RCL_ERROR,
  2677. EINVAL,
  2678. "cannot convert an object to inet address: %s",
  2679. ucl_object_key (obj));
  2680. return FALSE;
  2681. }
  2682. return TRUE;
  2683. }
  2684. gboolean
  2685. rspamd_rcl_parse_struct_mime_addr (rspamd_mempool_t *pool,
  2686. const ucl_object_t *obj,
  2687. gpointer ud,
  2688. struct rspamd_rcl_section *section,
  2689. GError **err)
  2690. {
  2691. struct rspamd_rcl_struct_parser *pd = ud;
  2692. GPtrArray **target, *tmp_addr = NULL;
  2693. const gchar *val;
  2694. ucl_object_iter_t it;
  2695. const ucl_object_t *cur;
  2696. target = (GPtrArray **)(((gchar *)pd->user_struct) + pd->offset);
  2697. it = ucl_object_iterate_new (obj);
  2698. while ((cur = ucl_object_iterate_safe (it, true)) != NULL) {
  2699. if (ucl_object_type (cur) == UCL_STRING) {
  2700. val = ucl_object_tostring (obj);
  2701. tmp_addr = rspamd_email_address_from_mime (pool, val,
  2702. strlen (val), tmp_addr);
  2703. }
  2704. else {
  2705. g_set_error (err,
  2706. CFG_RCL_ERROR,
  2707. EINVAL,
  2708. "cannot get inet address from ucl object in %s",
  2709. ucl_object_key (obj));
  2710. ucl_object_iterate_free (it);
  2711. return FALSE;
  2712. }
  2713. }
  2714. ucl_object_iterate_free (it);
  2715. *target = tmp_addr;
  2716. return TRUE;
  2717. }
  2718. static guint
  2719. rspamd_worker_param_key_hash (gconstpointer p)
  2720. {
  2721. const struct rspamd_worker_param_key *k = p;
  2722. rspamd_cryptobox_fast_hash_state_t st;
  2723. rspamd_cryptobox_fast_hash_init (&st, rspamd_hash_seed ());
  2724. rspamd_cryptobox_fast_hash_update (&st, k->name, strlen (k->name));
  2725. rspamd_cryptobox_fast_hash_update (&st, &k->ptr, sizeof (gpointer));
  2726. return rspamd_cryptobox_fast_hash_final (&st);
  2727. }
  2728. static gboolean
  2729. rspamd_worker_param_key_equal (gconstpointer p1, gconstpointer p2)
  2730. {
  2731. const struct rspamd_worker_param_key *k1 = p1, *k2 = p2;
  2732. if (k1->ptr == k2->ptr) {
  2733. return strcmp (k1->name, k2->name) == 0;
  2734. }
  2735. return FALSE;
  2736. }
  2737. void
  2738. rspamd_rcl_register_worker_option (struct rspamd_config *cfg,
  2739. GQuark type,
  2740. const gchar *name,
  2741. rspamd_rcl_default_handler_t handler,
  2742. gpointer target,
  2743. glong offset,
  2744. gint flags,
  2745. const gchar *doc_string)
  2746. {
  2747. struct rspamd_worker_param_parser *nhandler;
  2748. struct rspamd_worker_cfg_parser *nparser;
  2749. struct rspamd_worker_param_key srch;
  2750. const ucl_object_t *doc_workers, *doc_target;
  2751. ucl_object_t *doc_obj;
  2752. nparser = g_hash_table_lookup (cfg->wrk_parsers, &type);
  2753. if (nparser == NULL) {
  2754. rspamd_rcl_register_worker_parser (cfg, type, NULL, NULL);
  2755. nparser = g_hash_table_lookup (cfg->wrk_parsers, &type);
  2756. g_assert (nparser != NULL);
  2757. }
  2758. srch.name = name;
  2759. srch.ptr = target;
  2760. nhandler = g_hash_table_lookup (nparser->parsers, &srch);
  2761. if (nhandler != NULL) {
  2762. msg_warn_config (
  2763. "handler for parameter %s is already registered for worker type %s",
  2764. name,
  2765. g_quark_to_string (type));
  2766. return;
  2767. }
  2768. nhandler =
  2769. rspamd_mempool_alloc0 (cfg->cfg_pool,
  2770. sizeof (struct rspamd_worker_param_parser));
  2771. nhandler->key.name = name;
  2772. nhandler->key.ptr = target;
  2773. nhandler->parser.flags = flags;
  2774. nhandler->parser.offset = offset;
  2775. nhandler->parser.user_struct = target;
  2776. nhandler->handler = handler;
  2777. g_hash_table_insert (nparser->parsers, &nhandler->key, nhandler);
  2778. doc_workers = ucl_object_lookup (cfg->doc_strings, "workers");
  2779. if (doc_workers == NULL) {
  2780. doc_obj = ucl_object_typed_new (UCL_OBJECT);
  2781. ucl_object_insert_key (cfg->doc_strings, doc_obj, "workers", 0, false);
  2782. doc_workers = doc_obj;
  2783. }
  2784. doc_target = ucl_object_lookup (doc_workers, g_quark_to_string (type));
  2785. if (doc_target == NULL) {
  2786. doc_obj = ucl_object_typed_new (UCL_OBJECT);
  2787. ucl_object_insert_key ((ucl_object_t *)doc_workers, doc_obj,
  2788. g_quark_to_string (type), 0, true);
  2789. doc_target = doc_obj;
  2790. }
  2791. rspamd_rcl_add_doc_obj ((ucl_object_t *) doc_target,
  2792. doc_string,
  2793. name,
  2794. UCL_NULL,
  2795. handler,
  2796. flags,
  2797. NULL,
  2798. 0);
  2799. }
  2800. void
  2801. rspamd_rcl_register_worker_parser (struct rspamd_config *cfg, gint type,
  2802. gboolean (*func)(ucl_object_t *, gpointer), gpointer ud)
  2803. {
  2804. struct rspamd_worker_cfg_parser *nparser;
  2805. nparser = g_hash_table_lookup (cfg->wrk_parsers, &type);
  2806. if (nparser == NULL) {
  2807. /* Allocate new parser for this worker */
  2808. nparser =
  2809. rspamd_mempool_alloc0 (cfg->cfg_pool,
  2810. sizeof (struct rspamd_worker_cfg_parser));
  2811. nparser->type = type;
  2812. nparser->parsers = g_hash_table_new (rspamd_worker_param_key_hash,
  2813. rspamd_worker_param_key_equal);
  2814. rspamd_mempool_add_destructor (cfg->cfg_pool,
  2815. (rspamd_mempool_destruct_t)g_hash_table_unref, nparser->parsers);
  2816. g_hash_table_insert (cfg->wrk_parsers, &nparser->type, nparser);
  2817. }
  2818. nparser->def_obj_parser = func;
  2819. nparser->def_ud = ud;
  2820. }
  2821. /* Checksum functions */
  2822. static int
  2823. rspamd_rcl_emitter_append_c (unsigned char c, size_t nchars, void *ud)
  2824. {
  2825. rspamd_cryptobox_hash_state_t *hs = ud;
  2826. guint64 d[2];
  2827. d[0] = nchars;
  2828. d[1] = c;
  2829. rspamd_cryptobox_hash_update (hs, (const guchar *)d, sizeof (d));
  2830. return 0;
  2831. }
  2832. static int
  2833. rspamd_rcl_emitter_append_len (unsigned const char *str, size_t len, void *ud)
  2834. {
  2835. rspamd_cryptobox_hash_state_t *hs = ud;
  2836. rspamd_cryptobox_hash_update (hs, str, len);
  2837. return 0;
  2838. }
  2839. static int
  2840. rspamd_rcl_emitter_append_int (int64_t elt, void *ud)
  2841. {
  2842. rspamd_cryptobox_hash_state_t *hs = ud;
  2843. rspamd_cryptobox_hash_update (hs, (const guchar *)&elt, sizeof (elt));
  2844. return 0;
  2845. }
  2846. static int
  2847. rspamd_rcl_emitter_append_double (double elt, void *ud)
  2848. {
  2849. rspamd_cryptobox_hash_state_t *hs = ud;
  2850. rspamd_cryptobox_hash_update (hs, (const guchar *)&elt, sizeof (elt));
  2851. return 0;
  2852. }
  2853. void
  2854. rspamd_rcl_section_free (gpointer p)
  2855. {
  2856. struct rspamd_rcl_section *top = p, *cur, *tmp;
  2857. struct rspamd_rcl_default_handler_data *dh, *dhtmp;
  2858. HASH_ITER (hh, top, cur, tmp) {
  2859. HASH_DEL (top, cur);
  2860. if (cur->subsections) {
  2861. rspamd_rcl_section_free (cur->subsections);
  2862. }
  2863. HASH_ITER (hh, cur->default_parser, dh, dhtmp) {
  2864. HASH_DEL (cur->default_parser, dh);
  2865. g_free (dh->key);
  2866. g_free (dh);
  2867. }
  2868. ucl_object_unref (cur->doc_ref);
  2869. g_free (cur);
  2870. }
  2871. }
  2872. /**
  2873. * Calls for an external lua function to apply potential config transformations
  2874. * if needed. This function can change the cfg->rcl_obj.
  2875. *
  2876. * Example of transformation function:
  2877. *
  2878. * function(obj)
  2879. * if obj.something == 'foo' then
  2880. * obj.something = "bla"
  2881. * return true, obj
  2882. * end
  2883. *
  2884. * return false, nil
  2885. * end
  2886. *
  2887. * If function returns 'false' then rcl_obj is not touched. Otherwise,
  2888. * it is changed, then rcl_obj is imported from lua. Old config is dereferenced.
  2889. * @param cfg
  2890. */
  2891. void
  2892. rspamd_rcl_maybe_apply_lua_transform (struct rspamd_config *cfg)
  2893. {
  2894. lua_State *L = cfg->lua_state;
  2895. gint err_idx, ret;
  2896. GString *tb;
  2897. gchar str[PATH_MAX];
  2898. static const char *transform_script = "lua_cfg_transform";
  2899. g_assert (L != NULL);
  2900. rspamd_snprintf (str, sizeof (str), "return require \"%s\"",
  2901. transform_script);
  2902. if (luaL_dostring (L, str) != 0) {
  2903. msg_warn_config ("cannot execute lua script %s: %s",
  2904. str, lua_tostring (L, -1));
  2905. return;
  2906. }
  2907. else {
  2908. if (lua_type (L, -1) != LUA_TFUNCTION) {
  2909. msg_warn_config ("lua script must return "
  2910. "function and not %s",
  2911. lua_typename (L, lua_type (L, -1)));
  2912. return;
  2913. }
  2914. }
  2915. lua_pushcfunction (L, &rspamd_lua_traceback);
  2916. err_idx = lua_gettop (L);
  2917. /* Push function */
  2918. lua_pushvalue (L, -2);
  2919. /* Push the existing config */
  2920. ucl_object_push_lua (L, cfg->rcl_obj, true);
  2921. if ((ret = lua_pcall (L, 1, 2, err_idx)) != 0) {
  2922. tb = lua_touserdata (L, -1);
  2923. msg_err ("call to rspamadm lua script failed (%d): %v", ret, tb);
  2924. if (tb) {
  2925. g_string_free (tb, TRUE);
  2926. }
  2927. lua_settop (L, 0);
  2928. return;
  2929. }
  2930. if (lua_toboolean (L, -2) && lua_type (L, -1) == LUA_TTABLE) {
  2931. ucl_object_t *old_cfg = cfg->rcl_obj;
  2932. msg_info_config ("configuration has been transformed in Lua");
  2933. cfg->rcl_obj = ucl_object_lua_import (L, -1);
  2934. ucl_object_unref (old_cfg);
  2935. }
  2936. /* error function */
  2937. lua_settop (L, 0);
  2938. }
  2939. static bool
  2940. rspamd_rcl_decrypt_handler(struct ucl_parser *parser,
  2941. const unsigned char *source, size_t source_len,
  2942. unsigned char **destination, size_t *dest_len,
  2943. void *user_data)
  2944. {
  2945. GError *err = NULL;
  2946. struct rspamd_cryptobox_keypair *kp = (struct rspamd_cryptobox_keypair *)user_data;
  2947. if (!rspamd_keypair_decrypt (kp, source, source_len,
  2948. destination, dest_len, &err)) {
  2949. msg_err ("cannot decrypt file: %e", err);
  2950. g_error_free (err);
  2951. return false;
  2952. }
  2953. return true;
  2954. }
  2955. static void
  2956. rspamd_rcl_decrypt_free (unsigned char *data, size_t len, void *user_data)
  2957. {
  2958. g_free (data);
  2959. }
  2960. void
  2961. rspamd_config_calculate_cksum (struct rspamd_config *cfg)
  2962. {
  2963. rspamd_cryptobox_hash_state_t hs;
  2964. unsigned char cksumbuf[rspamd_cryptobox_HASHBYTES];
  2965. struct ucl_emitter_functions f;
  2966. /* Calculate checksum */
  2967. rspamd_cryptobox_hash_init (&hs, NULL, 0);
  2968. f.ucl_emitter_append_character = rspamd_rcl_emitter_append_c;
  2969. f.ucl_emitter_append_double = rspamd_rcl_emitter_append_double;
  2970. f.ucl_emitter_append_int = rspamd_rcl_emitter_append_int;
  2971. f.ucl_emitter_append_len = rspamd_rcl_emitter_append_len;
  2972. f.ucl_emitter_free_func = NULL;
  2973. f.ud = &hs;
  2974. ucl_object_emit_full (cfg->rcl_obj, UCL_EMIT_MSGPACK,
  2975. &f, cfg->config_comments);
  2976. rspamd_cryptobox_hash_final (&hs, cksumbuf);
  2977. cfg->checksum = rspamd_encode_base32 (cksumbuf, sizeof (cksumbuf));
  2978. /* Also change the tag of cfg pool to be equal to the checksum */
  2979. rspamd_strlcpy (cfg->cfg_pool->tag.uid, cfg->checksum,
  2980. MIN (sizeof (cfg->cfg_pool->tag.uid), strlen (cfg->checksum)));
  2981. }
  2982. gboolean
  2983. rspamd_config_parse_ucl (struct rspamd_config *cfg, const gchar *filename,
  2984. GHashTable *vars, GError **err)
  2985. {
  2986. struct stat st;
  2987. gint fd;
  2988. struct ucl_parser *parser;
  2989. gchar keypair_path[PATH_MAX];
  2990. struct rspamd_cryptobox_keypair *decrypt_keypair = NULL;
  2991. gchar *data;
  2992. if (stat (filename, &st) == -1) {
  2993. g_set_error (err, cfg_rcl_error_quark (), errno,
  2994. "cannot stat %s: %s", filename, strerror (errno));
  2995. return FALSE;
  2996. }
  2997. if ((fd = open (filename, O_RDONLY)) == -1) {
  2998. g_set_error (err, cfg_rcl_error_quark (), errno,
  2999. "cannot open %s: %s", filename, strerror (errno));
  3000. return FALSE;
  3001. }
  3002. /* Now mmap this file to simplify reading process */
  3003. if ((data = mmap (NULL, st.st_size, PROT_READ, MAP_SHARED, fd, 0)) == MAP_FAILED) {
  3004. g_set_error (err, cfg_rcl_error_quark (), errno,
  3005. "cannot mmap %s: %s", filename, strerror (errno));
  3006. close (fd);
  3007. return FALSE;
  3008. }
  3009. close (fd);
  3010. /* Try to load keyfile if available */
  3011. rspamd_snprintf (keypair_path, sizeof (keypair_path), "%s.key",
  3012. filename);
  3013. if (stat (keypair_path, &st) == -1 &&
  3014. (fd = open (keypair_path, O_RDONLY)) != -1) {
  3015. struct ucl_parser *kp_parser;
  3016. kp_parser = ucl_parser_new (0);
  3017. if (ucl_parser_add_fd (kp_parser, fd)) {
  3018. ucl_object_t *kp_obj;
  3019. kp_obj = ucl_parser_get_object (kp_parser);
  3020. g_assert (kp_obj != NULL);
  3021. decrypt_keypair = rspamd_keypair_from_ucl (kp_obj);
  3022. if (decrypt_keypair == NULL) {
  3023. msg_err_config_forced ("cannot load keypair from %s: invalid keypair",
  3024. keypair_path);
  3025. }
  3026. else {
  3027. /* Add decryption support to UCL */
  3028. rspamd_mempool_add_destructor (cfg->cfg_pool,
  3029. (rspamd_mempool_destruct_t)rspamd_keypair_unref,
  3030. decrypt_keypair);
  3031. }
  3032. ucl_object_unref (kp_obj);
  3033. }
  3034. else {
  3035. msg_err_config_forced ("cannot load keypair from %s: %s",
  3036. keypair_path, ucl_parser_get_error (kp_parser));
  3037. }
  3038. ucl_parser_free (kp_parser);
  3039. }
  3040. parser = ucl_parser_new (UCL_PARSER_SAVE_COMMENTS);
  3041. rspamd_ucl_add_conf_variables (parser, vars);
  3042. rspamd_ucl_add_conf_macros (parser, cfg);
  3043. ucl_parser_set_filevars (parser, filename, true);
  3044. if (decrypt_keypair) {
  3045. struct ucl_parser_special_handler *decrypt_handler;
  3046. decrypt_handler = rspamd_mempool_alloc0 (cfg->cfg_pool,
  3047. sizeof (*decrypt_handler));
  3048. decrypt_handler->user_data = decrypt_keypair;
  3049. decrypt_handler->magic = encrypted_magic;
  3050. decrypt_handler->magic_len = sizeof (encrypted_magic);
  3051. decrypt_handler->handler = rspamd_rcl_decrypt_handler;
  3052. decrypt_handler->free_function = rspamd_rcl_decrypt_free;
  3053. ucl_parser_add_special_handler (parser, decrypt_handler);
  3054. }
  3055. if (!ucl_parser_add_chunk (parser, data, st.st_size)) {
  3056. g_set_error (err, cfg_rcl_error_quark (), errno,
  3057. "ucl parser error: %s", ucl_parser_get_error (parser));
  3058. ucl_parser_free (parser);
  3059. munmap (data, st.st_size);
  3060. return FALSE;
  3061. }
  3062. munmap (data, st.st_size);
  3063. cfg->rcl_obj = ucl_parser_get_object (parser);
  3064. cfg->config_comments = ucl_object_ref (ucl_parser_get_comments (parser));
  3065. ucl_parser_free (parser);
  3066. return TRUE;
  3067. }
  3068. gboolean
  3069. rspamd_config_read (struct rspamd_config *cfg, const gchar *filename,
  3070. rspamd_rcl_section_fin_t logger_fin,
  3071. gpointer logger_ud, GHashTable *vars)
  3072. {
  3073. GError *err = NULL;
  3074. struct rspamd_rcl_section *top, *logger_section;
  3075. const ucl_object_t *logger_obj;
  3076. if (!rspamd_config_parse_ucl (cfg, filename, vars, &err)) {
  3077. msg_err_config_forced ("failed to load config: %e", err);
  3078. g_error_free (err);
  3079. return FALSE;
  3080. }
  3081. top = rspamd_rcl_config_init (cfg, NULL);
  3082. rspamd_lua_set_path (cfg->lua_state, cfg->rcl_obj, vars);
  3083. rspamd_lua_set_globals (cfg, cfg->lua_state, vars);
  3084. rspamd_mempool_add_destructor (cfg->cfg_pool, rspamd_rcl_section_free, top);
  3085. err = NULL;
  3086. if (logger_fin != NULL) {
  3087. HASH_FIND_STR (top, "logging", logger_section);
  3088. if (logger_section != NULL) {
  3089. logger_obj = ucl_object_lookup_any (cfg->rcl_obj, "logging",
  3090. "logger", NULL);
  3091. if (logger_obj == NULL) {
  3092. logger_fin (cfg->cfg_pool, logger_ud);
  3093. }
  3094. else {
  3095. if (!rspamd_rcl_process_section (cfg, logger_section, cfg,
  3096. logger_obj, cfg->cfg_pool, &err)) {
  3097. msg_err_config_forced ("cannot init logger: %e", err);
  3098. g_error_free (err);
  3099. return FALSE;
  3100. } else {
  3101. logger_fin (cfg->cfg_pool, logger_ud);
  3102. }
  3103. }
  3104. HASH_DEL (top, logger_section);
  3105. }
  3106. }
  3107. /* Transform config if needed */
  3108. rspamd_rcl_maybe_apply_lua_transform (cfg);
  3109. rspamd_config_calculate_cksum (cfg);
  3110. if (!rspamd_rcl_parse (top, cfg, cfg, cfg->cfg_pool, cfg->rcl_obj, &err)) {
  3111. msg_err_config ("rcl parse error: %e", err);
  3112. if (err) {
  3113. g_error_free (err);
  3114. }
  3115. return FALSE;
  3116. }
  3117. cfg->lang_det = rspamd_language_detector_init (cfg);
  3118. return TRUE;
  3119. }
  3120. static void
  3121. rspamd_rcl_doc_obj_from_handler (ucl_object_t *doc_obj,
  3122. rspamd_rcl_default_handler_t handler,
  3123. gint flags)
  3124. {
  3125. gboolean has_example = FALSE, has_type = FALSE;
  3126. const gchar *type = NULL;
  3127. if (ucl_object_lookup (doc_obj, "example") != NULL) {
  3128. has_example = TRUE;
  3129. }
  3130. if (ucl_object_lookup (doc_obj, "type") != NULL) {
  3131. has_type = TRUE;
  3132. }
  3133. if (handler == rspamd_rcl_parse_struct_string) {
  3134. if (!has_type) {
  3135. ucl_object_insert_key (doc_obj, ucl_object_fromstring ("string"),
  3136. "type", 0, false);
  3137. }
  3138. }
  3139. else if (handler == rspamd_rcl_parse_struct_integer) {
  3140. type = "int";
  3141. if (flags & RSPAMD_CL_FLAG_INT_16) {
  3142. type = "int16";
  3143. }
  3144. else if (flags & RSPAMD_CL_FLAG_INT_32) {
  3145. type = "int32";
  3146. }
  3147. else if (flags & RSPAMD_CL_FLAG_INT_64) {
  3148. type = "int64";
  3149. }
  3150. else if (flags & RSPAMD_CL_FLAG_INT_SIZE) {
  3151. type = "size";
  3152. }
  3153. else if (flags & RSPAMD_CL_FLAG_UINT) {
  3154. type = "uint";
  3155. }
  3156. if (!has_type) {
  3157. ucl_object_insert_key (doc_obj, ucl_object_fromstring (type),
  3158. "type", 0, false);
  3159. }
  3160. }
  3161. else if (handler == rspamd_rcl_parse_struct_double) {
  3162. if (!has_type) {
  3163. ucl_object_insert_key (doc_obj, ucl_object_fromstring ("double"),
  3164. "type", 0, false);
  3165. }
  3166. }
  3167. else if (handler == rspamd_rcl_parse_struct_time) {
  3168. type = "time";
  3169. if (!has_type) {
  3170. ucl_object_insert_key (doc_obj, ucl_object_fromstring (type),
  3171. "type", 0, false);
  3172. }
  3173. }
  3174. else if (handler == rspamd_rcl_parse_struct_string_list) {
  3175. if (!has_type) {
  3176. ucl_object_insert_key (doc_obj, ucl_object_fromstring ("string list"),
  3177. "type", 0, false);
  3178. }
  3179. if (!has_example) {
  3180. ucl_object_insert_key (doc_obj,
  3181. ucl_object_fromstring_common ("param = \"str1, str2, str3\" OR "
  3182. "param = [\"str1\", \"str2\", \"str3\"]", 0, 0),
  3183. "example",
  3184. 0,
  3185. false);
  3186. }
  3187. }
  3188. else if (handler == rspamd_rcl_parse_struct_boolean) {
  3189. if (!has_type) {
  3190. ucl_object_insert_key (doc_obj,
  3191. ucl_object_fromstring ("bool"),
  3192. "type",
  3193. 0,
  3194. false);
  3195. }
  3196. }
  3197. else if (handler == rspamd_rcl_parse_struct_keypair) {
  3198. if (!has_type) {
  3199. ucl_object_insert_key (doc_obj,
  3200. ucl_object_fromstring ("keypair"),
  3201. "type",
  3202. 0,
  3203. false);
  3204. }
  3205. if (!has_example) {
  3206. ucl_object_insert_key (doc_obj,
  3207. ucl_object_fromstring ("keypair { "
  3208. "pubkey = <base32_string>;"
  3209. " privkey = <base32_string>; "
  3210. "}"),
  3211. "example",
  3212. 0,
  3213. false);
  3214. }
  3215. }
  3216. else if (handler == rspamd_rcl_parse_struct_addr) {
  3217. if (!has_type) {
  3218. ucl_object_insert_key (doc_obj,
  3219. ucl_object_fromstring ("socket address"),
  3220. "type",
  3221. 0,
  3222. false);
  3223. }
  3224. }
  3225. else if (handler == rspamd_rcl_parse_struct_mime_addr) {
  3226. if (!has_type) {
  3227. ucl_object_insert_key (doc_obj,
  3228. ucl_object_fromstring ("email address"),
  3229. "type",
  3230. 0,
  3231. false);
  3232. }
  3233. }
  3234. }
  3235. ucl_object_t *
  3236. rspamd_rcl_add_doc_obj (ucl_object_t *doc_target,
  3237. const char *doc_string,
  3238. const char *doc_name,
  3239. ucl_type_t type,
  3240. rspamd_rcl_default_handler_t handler,
  3241. gint flags,
  3242. const char *default_value,
  3243. gboolean required)
  3244. {
  3245. ucl_object_t *doc_obj;
  3246. if (doc_target == NULL || doc_name == NULL) {
  3247. return NULL;
  3248. }
  3249. doc_obj = ucl_object_typed_new (UCL_OBJECT);
  3250. /* Insert doc string itself */
  3251. if (doc_string) {
  3252. ucl_object_insert_key (doc_obj,
  3253. ucl_object_fromstring_common (doc_string, 0, 0),
  3254. "data", 0, false);
  3255. }
  3256. else {
  3257. ucl_object_insert_key (doc_obj, ucl_object_fromstring ("undocumented"),
  3258. "data", 0, false);
  3259. }
  3260. if (type != UCL_NULL) {
  3261. ucl_object_insert_key (doc_obj,
  3262. ucl_object_fromstring (ucl_object_type_to_string (type)),
  3263. "type", 0, false);
  3264. }
  3265. rspamd_rcl_doc_obj_from_handler (doc_obj, handler, flags);
  3266. ucl_object_insert_key (doc_obj,
  3267. ucl_object_frombool (required),
  3268. "required", 0, false);
  3269. if (default_value) {
  3270. ucl_object_insert_key (doc_obj,
  3271. ucl_object_fromstring_common (default_value, 0, 0),
  3272. "default", 0, false);
  3273. }
  3274. ucl_object_insert_key (doc_target, doc_obj, doc_name, 0, true);
  3275. return doc_obj;
  3276. }
  3277. ucl_object_t *
  3278. rspamd_rcl_add_doc_by_path (struct rspamd_config *cfg,
  3279. const gchar *doc_path,
  3280. const char *doc_string,
  3281. const char *doc_name,
  3282. ucl_type_t type,
  3283. rspamd_rcl_default_handler_t handler,
  3284. gint flags,
  3285. const char *default_value,
  3286. gboolean required)
  3287. {
  3288. const ucl_object_t *found, *cur;
  3289. ucl_object_t *obj;
  3290. gchar **path_components, **comp;
  3291. if (doc_path == NULL) {
  3292. /* Assume top object */
  3293. return rspamd_rcl_add_doc_obj (cfg->doc_strings,
  3294. doc_string,
  3295. doc_name,
  3296. type,
  3297. handler,
  3298. flags,
  3299. default_value,
  3300. required);
  3301. }
  3302. else {
  3303. found = ucl_object_lookup_path (cfg->doc_strings, doc_path);
  3304. if (found != NULL) {
  3305. return rspamd_rcl_add_doc_obj ((ucl_object_t *) found,
  3306. doc_string,
  3307. doc_name,
  3308. type,
  3309. handler,
  3310. flags,
  3311. default_value,
  3312. required);
  3313. }
  3314. /* Otherwise we need to insert all components of the path */
  3315. path_components = g_strsplit_set (doc_path, ".", -1);
  3316. cur = cfg->doc_strings;
  3317. for (comp = path_components; *comp != NULL; comp++) {
  3318. if (ucl_object_type (cur) != UCL_OBJECT) {
  3319. msg_err_config ("Bad path while lookup for '%s' at %s",
  3320. doc_path, *comp);
  3321. return NULL;
  3322. }
  3323. found = ucl_object_lookup (cur, *comp);
  3324. if (found == NULL) {
  3325. obj = ucl_object_typed_new (UCL_OBJECT);
  3326. ucl_object_insert_key ((ucl_object_t *) cur,
  3327. obj,
  3328. *comp,
  3329. 0,
  3330. true);
  3331. cur = obj;
  3332. }
  3333. else {
  3334. cur = found;
  3335. }
  3336. }
  3337. }
  3338. return rspamd_rcl_add_doc_obj (ucl_object_ref (cur),
  3339. doc_string,
  3340. doc_name,
  3341. type,
  3342. handler,
  3343. flags,
  3344. default_value,
  3345. required);
  3346. }
  3347. static void
  3348. rspamd_rcl_add_doc_from_comments (struct rspamd_config *cfg,
  3349. ucl_object_t *top_doc, const ucl_object_t *obj,
  3350. const ucl_object_t *comments, gboolean is_top)
  3351. {
  3352. ucl_object_iter_t it = NULL;
  3353. const ucl_object_t *cur, *cmt;
  3354. ucl_object_t *cur_doc;
  3355. if (ucl_object_type (obj) == UCL_OBJECT) {
  3356. while ((cur = ucl_object_iterate (obj, &it, true)) != NULL) {
  3357. cur_doc = NULL;
  3358. if ((cmt = ucl_comments_find (comments, cur)) != NULL) {
  3359. cur_doc = rspamd_rcl_add_doc_obj (top_doc,
  3360. ucl_object_tostring (cmt), ucl_object_key (cur),
  3361. ucl_object_type (cur), NULL, 0, NULL, FALSE);
  3362. }
  3363. if (ucl_object_type (cur) == UCL_OBJECT) {
  3364. if (cur_doc) {
  3365. rspamd_rcl_add_doc_from_comments (cfg, cur_doc, cur,
  3366. comments,
  3367. FALSE);
  3368. }
  3369. else {
  3370. rspamd_rcl_add_doc_from_comments (cfg, top_doc, cur,
  3371. comments,
  3372. FALSE);
  3373. }
  3374. }
  3375. }
  3376. }
  3377. else if (!is_top) {
  3378. if ((cmt = ucl_comments_find (comments, obj)) != NULL) {
  3379. rspamd_rcl_add_doc_obj (top_doc,
  3380. ucl_object_tostring (cmt), ucl_object_key (obj),
  3381. ucl_object_type (obj), NULL, 0, NULL, FALSE);
  3382. }
  3383. }
  3384. }
  3385. ucl_object_t *
  3386. rspamd_rcl_add_doc_by_example (struct rspamd_config *cfg,
  3387. const gchar *root_path,
  3388. const gchar *doc_string,
  3389. const gchar *doc_name,
  3390. const gchar *example_data, gsize example_len)
  3391. {
  3392. struct ucl_parser *parser;
  3393. ucl_object_t *top, *top_doc;
  3394. const ucl_object_t *comments;
  3395. parser = ucl_parser_new (UCL_PARSER_NO_FILEVARS|UCL_PARSER_SAVE_COMMENTS);
  3396. if (!ucl_parser_add_chunk (parser, example_data, example_len)) {
  3397. msg_err_config ("cannot parse example: %s",
  3398. ucl_parser_get_error (parser));
  3399. ucl_parser_free (parser);
  3400. return NULL;
  3401. }
  3402. top = ucl_parser_get_object (parser);
  3403. comments = ucl_parser_get_comments (parser);
  3404. /* Add top object */
  3405. top_doc = rspamd_rcl_add_doc_by_path (cfg, root_path, doc_string,
  3406. doc_name, ucl_object_type (top), NULL, 0, NULL, FALSE);
  3407. ucl_object_insert_key (top_doc,
  3408. ucl_object_fromstring_common (example_data, example_len, 0),
  3409. "example", 0, false);
  3410. rspamd_rcl_add_doc_from_comments (cfg, top_doc, top, comments, TRUE);
  3411. return top_doc;
  3412. }