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

cfg_rcl.c 103KB

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