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

cfg_rcl.c 102KB

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