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

cfg_rcl.cxx 119KB

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