選択できるのは25トピックまでです。 トピックは、先頭が英数字で、英数字とダッシュ('-')を使用した35文字以内のものにしてください。

cfg_rcl.c 113KB

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