Você não pode selecionar mais de 25 tópicos Os tópicos devem começar com uma letra ou um número, podem incluir traços ('-') e podem ter até 35 caracteres.

SNFMulti.cpp 139KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267
  1. // SNFMulti.cpp
  2. //
  3. // (C) Copyright 2006 - 2009 ARM Research Labs, LLC
  4. // See www.armresearch.com for the copyright terms.
  5. //
  6. // 20060121_M
  7. //
  8. // See SNFMulti.hpp for history and detailed notes.
  9. #include <sys/types.h>
  10. #include <sys/stat.h>
  11. #include <ctime>
  12. #include <cstring>
  13. #include <cstdlib>
  14. #include <sstream>
  15. #include "SNFMulti.hpp"
  16. #include "snf_saccades.hpp"
  17. #include "../CodeDweller/timing.hpp"
  18. //#include "../nvwa-0.6/nvwa/debug_new.h"
  19. using namespace std;
  20. //// Version Info
  21. const char* SNF_ENGINE_VERSION = "SNFMulti Engine Version 3.1.0 Build: " __DATE__ " " __TIME__;
  22. //// Script Caller Methods
  23. const ThreadType ScriptCaller::Type("Script Caller"); // Script caller thread type mnemonic.
  24. const ThreadState ScriptCaller::CallingSystem("In system()"); // Script caller "CallingSystem" state.
  25. const ThreadState ScriptCaller::PendingGuardTime("Guard Time"); // Script caller "GuardTime" state.
  26. const ThreadState ScriptCaller::StandingBy("Standby"); // Script caller "Standby" state.
  27. const ThreadState ScriptCaller::Disabled("Disabled"); // State when unable to run.
  28. const int ScriptGuardDefault = 180000; // 3 Minute Default Guard Time.
  29. ScriptCaller::ScriptCaller(string S) : // Script caller constructor (with name).
  30. Thread(ScriptCaller::Type, S), // Set up the thread type and name.
  31. GuardTimer(ScriptGuardDefault), // Initialize the guard time.
  32. GoFlag(false), // Not ready to go yet.
  33. DieFlag(false), // Not ready to die yet.
  34. myLastResult(0) { // No last result yet.
  35. run(); // Launch the thread.
  36. }
  37. ScriptCaller::~ScriptCaller() { // Destructor.
  38. DieFlag = true; // Set the die flag.
  39. Sleeper WaitATic(1000); // One second sleeper.
  40. for(int x = 10; x > 0; x--) { // We don't join, we might get stuck.
  41. if(false == isRunning()) break; // If we're still running then wait
  42. WaitATic(); // up to 10 seconds, then just exit.
  43. } // If the thread is stuck it will
  44. } // just get closed.
  45. string ScriptCaller::ScriptToRun() { // Safely grab the SystemCallText.
  46. ScopeMutex Freeze(MyMutex); // Protect the string.
  47. return SystemCallText; // Grab a copy of the text.
  48. }
  49. bool ScriptCaller::hasGuardExpired() { // True if guard time has expired.
  50. ScopeMutex Freeze(MyMutex); // Protect the timer.
  51. return GuardTimer.isExpired(); // If it has expired we're true.
  52. }
  53. void ScriptCaller::SystemCall(string S) { // Set the SystemCall text.
  54. ScopeMutex Freeze(MyMutex); // Protect the string object.
  55. SystemCallText = S; // Set it's data.
  56. }
  57. const int MinimumGuardTime = 60000; // Minimum Guard Time 1 minute.
  58. void ScriptCaller::GuardTime(int T) { // Set the Guard Time.
  59. if(MinimumGuardTime > T) T = MinimumGuardTime; // Enforce our lower limit.
  60. ScopeMutex Freeze(MyMutex); // Protect the Guard Timer.
  61. GuardTimer.setDuration(T); // Set the duration.
  62. GuardTimer.restart(); // Restart the timer.
  63. }
  64. void ScriptCaller::trigger() { // Trigger the system() call.
  65. GoFlag = true; // Set the flag.
  66. }
  67. int ScriptCaller::LastResult() { // Return the result code from
  68. return myLastResult; // the last system() call.
  69. }
  70. void ScriptCaller::myTask() { // Safely call system() when triggered.
  71. Sleeper WaitATic(1000); // One second sleeper.
  72. while(false == DieFlag) { // While it's not time to die:
  73. WaitATic(); // Pause for 1 sec each round.
  74. string ScriptThisRound = ScriptToRun(); // Grab the current script.
  75. if(0 < ScriptToRun().length()) { // If script text is defined and
  76. if(true == GoFlag) { // If GoFlag is triggered and
  77. if(hasGuardExpired()) { // Guard time is expired:
  78. CurrentThreadState(CallingSystem); // Publish our state.
  79. myLastResult = system(ScriptThisRound.c_str()); // Make the system call.
  80. GoFlag = false; // Done with that trigger.
  81. GuardTimer.restart(); // Restart our Guard Time.
  82. } else { // If we're waiting for Guard Time:
  83. CurrentThreadState(PendingGuardTime); // publish that state and hold down
  84. GoFlag = false; // the trigger signal (no stale go).
  85. }
  86. } else { // If nothing is triggered yet then
  87. CurrentThreadState(StandingBy); // we are standing by.
  88. }
  89. } else { // If we have no script to run then
  90. CurrentThreadState(Disabled); // we are disabled.
  91. }
  92. }
  93. }
  94. //// Rulebase Reloader Methods
  95. // How to get timestamps on critical files.
  96. time_t getFileTimestamp(string FileName) {
  97. struct stat FileNameStat; // First we need a stat buffer.
  98. if(0 != stat(FileName.c_str(), &FileNameStat)) { // If we can't get the stat we
  99. return 0; // will return 0;
  100. } // If all goes well we return
  101. return FileNameStat.st_mtime; // the last modified time_t.
  102. }
  103. void snf_Reloader::captureFileStats() { // Get stats for later comparison.
  104. snfCFGData& C = *(MyRulebase.MyCFGmgr.ActiveConfiguration()); // Reference the active config.
  105. RulebaseFileCheckName = C.RuleFilePath; // Build/Get Rulebase File Name.
  106. ConfigFileCheckName = C.ConfigFilePath; // Build/Get Configuration File Name.
  107. IgnoreListCheckFileName = C.paths_workspace_path; // Build/Get Ignore File Name.
  108. IgnoreListCheckFileName.append("GBUdbIgnoreList.txt");
  109. RulebaseFileTimestamp = getFileTimestamp(RulebaseFileCheckName); // Timestamps to check for
  110. ConfigurationTimestamp = getFileTimestamp(ConfigFileCheckName); // changes in configuration data
  111. IgnoreListTimestamp = getFileTimestamp(IgnoreListCheckFileName); // or rulebase files.
  112. }
  113. bool snf_Reloader::StatsAreDifferent() { // Check file stats for changes.
  114. return ( // Return true if any of the
  115. RulebaseFileTimestamp != getFileTimestamp(RulebaseFileCheckName) || // Rulebase File, or the
  116. ConfigurationTimestamp != getFileTimestamp(ConfigFileCheckName) || // Configuration File, or the
  117. IgnoreListTimestamp != getFileTimestamp(IgnoreListCheckFileName) // Ignore List File have changed.
  118. );
  119. }
  120. const int MSPerSec = 1000; // 1000 milliseconds per second.
  121. void snf_Reloader::captureGetterConfig() { // Update RulebaseGetter config.
  122. snfCFGData& C = *(MyRulebase.MyCFGmgr.ActiveConfiguration()); // Reference the active config.
  123. RulebaseGetterIsTurnedOn = ( // Is the script caller on or off?
  124. true == C.update_script_on_off && // We're on if the bit is set and
  125. 0 < C.update_script_call.length() // we have a non-empty script to call.
  126. );
  127. if(RulebaseGetterIsTurnedOn) { // If it is turned on:
  128. RulebaseGetter.SystemCall(C.update_script_call); // Set the script call and
  129. RulebaseGetter.GuardTime(C.update_script_guard_time * MSPerSec); // the cycle guard time.
  130. }
  131. else { // If the scripter is turned off:
  132. RulebaseGetter.SystemCall(""); // Set the script to nothing.
  133. }
  134. }
  135. const string snfReloadContext = "--RELOADING--"; // Context for info and error logs.
  136. void snf_Reloader::myTask() { // How do we do this refresh thing?
  137. Sleeper WaitATic(1000); // Wait a second between checks.
  138. while(!TimeToStop) { // While it's not time to stop:
  139. if(
  140. RulebaseGetterIsTurnedOn && // If our rulebase getter is enabled
  141. MyRulebase.MyLOGmgr.isUpdateAvailable() // and a new rulebase is availalbe:
  142. ) {
  143. RulebaseGetter.trigger(); // Trigger the update script (if any).
  144. }
  145. if(StatsAreDifferent()) { // Check the stats. If different:
  146. try { // safely attempt a reload.
  147. WaitATic(); // Wait a tic to let things stabilize
  148. MyRulebase.refresh(); // then call refresh on the handler.
  149. captureFileStats(); // If it works, capture the new stats.
  150. captureGetterConfig(); // Also update the RulebaseGetter.
  151. MyRulebase.logThisInfo( // Log our success.
  152. snfReloadContext, snf_SUCCESS, "Success");
  153. }
  154. catch(snf_RulebaseHandler::IgnoreListError) { // If we get an IgnoreListError - say so.
  155. MyRulebase.logThisError(
  156. snfReloadContext, snf_ERROR_RULE_FILE, "IgnoreListError");
  157. }
  158. catch(snf_RulebaseHandler::ConfigurationError) { // If we get a ConfigurationError - say so.
  159. MyRulebase.logThisError(
  160. snfReloadContext, snf_ERROR_RULE_FILE, "ConfigurationError");
  161. }
  162. catch(snf_RulebaseHandler::FileError x) { // If we get a FileError - say so.
  163. MyRulebase.logThisError(
  164. snfReloadContext, snf_ERROR_RULE_FILE, "FileError");
  165. }
  166. catch(snf_RulebaseHandler::AuthenticationError x) { // If we get a Auth Error - say so.
  167. MyRulebase.logThisError(
  168. snfReloadContext, snf_ERROR_RULE_AUTH, "AuthError");
  169. }
  170. catch(snf_RulebaseHandler::Busy x) { // If we get a Busy Exception - say so.
  171. MyRulebase.logThisError(
  172. snfReloadContext, snf_ERROR_UNKNOWN, "BusyError");
  173. }
  174. catch(snf_RulebaseHandler::Panic x) { // If we get a Panic - say so.
  175. MyRulebase.logThisError(
  176. snfReloadContext, snf_ERROR_UNKNOWN, "PanicError");
  177. }
  178. catch(...) { // If we get some other error - shout!
  179. MyRulebase.logThisError(
  180. snfReloadContext, snf_ERROR_UNKNOWN, "UnhandledError");
  181. }
  182. }
  183. WaitATic(); // Wait before the next loop.
  184. }
  185. }
  186. const ThreadType snf_Reloader::Type("snf_Reloader"); // The thread's type.
  187. snf_Reloader::snf_Reloader(snf_RulebaseHandler& R) : // When we are created, we
  188. Thread(snf_Reloader::Type, "Reloader"), // brand and name our thread.
  189. MyRulebase(R), // Capture the rulebase handler.
  190. TimeToStop(false), // It's not time to stop yet.
  191. RulebaseGetter("RulebaseGetter"), // Setup our ScriptCaller thread.
  192. RulebaseGetterIsTurnedOn(false) { // Rulebase getter is off at first.
  193. captureFileStats(); // Set up the initial stats.
  194. captureGetterConfig(); // Set up RulebaseGetter config.
  195. run(); // Run our maintenenace thread.
  196. }
  197. snf_Reloader::~snf_Reloader() { // When we are destroyed we
  198. TimeToStop = true; // set our time to stop bit
  199. join(); // and wait for the thread.
  200. }
  201. //// snfCFGPacket Methods
  202. snfCFGPacket::snfCFGPacket(snf_RulebaseHandler* R) : // When we are created:
  203. MyRulebase(R), // Capture our rulebase handler and
  204. MyTokenMatrix(NULL), // ready our token matrix and
  205. MyCFGData(NULL) { // cfg pointers.
  206. if(MyRulebase) { MyRulebase->grab(*this); } // Safely grab our rulebase.
  207. }
  208. snfCFGPacket::~snfCFGPacket() { if(MyRulebase) MyRulebase->drop(*this); } // Safely drop our rulebase when we die.
  209. TokenMatrix* snfCFGPacket::Tokens() { return MyTokenMatrix; } // Consumers read the Token Matrix and
  210. snfCFGData* snfCFGPacket::Config() { return MyCFGData; } // the snfCFGData.
  211. bool snfCFGPacket::bad() { // If anything is missing it's not good.
  212. return (NULL == MyTokenMatrix || NULL == MyCFGData); // True if any of these aren NULL.
  213. }
  214. bool snfCFGPacket::isRulePanic(int R) { // Test for a rule panic.
  215. return(RulePanics.end() != RulePanics.find(R)); // Find it in the list, it's a panic.
  216. }
  217. //// Rulebase Handler Methods
  218. snf_RulebaseHandler::~snf_RulebaseHandler(){ // Destruct the handler.
  219. close(); // Close before we go.
  220. }
  221. bool snf_RulebaseHandler::isReady(){ // Is the object ready?
  222. return (NULL!=Rulebase); // Have Rulebase? We're ready.
  223. }
  224. bool snf_RulebaseHandler::isBusy(){ // Is a refresh/open in progress or
  225. return (RefreshInProgress || 0<RetiringCount); // an older rulebase is not yet retired.
  226. }
  227. int snf_RulebaseHandler::getReferenceCount(){ // How many Engines using this handler.
  228. return ReferenceCount; // Tell them the count bob.
  229. }
  230. int snf_RulebaseHandler::getCurrentCount(){ // How many Engines active in the current rb.
  231. return CurrentCount; // Tell them what it is bob.
  232. }
  233. int snf_RulebaseHandler::getRetiringCount(){ // How many Engines active in the old rb.
  234. return RetiringCount; // Tell them what it is bob.
  235. }
  236. // FileUTC(FileName) - utility function for tagging the active rulebase
  237. string FileUTC(string FileName) { // Gets a files UTC.
  238. struct stat FileNameStat; // First we need a stat buffer.
  239. string t; // We also need a Timestamp holder.
  240. if(0 != stat(FileName.c_str(), &FileNameStat)) { // If we can't get the stat we
  241. t.append("000000000000"); return t; // will return 000000000000 to
  242. } // make sure we should get the file.
  243. struct tm FileNameTime; // Allocate a time structure.
  244. FileNameTime = *(gmtime(&FileNameStat.st_mtime)); // Copy the file time to it as UTC.
  245. char TimestampBfr[20]; // Timestamp buffer.
  246. sprintf(TimestampBfr,"%04d%02d%02d%02d%02d%02d", // Format yyyymmddhhmmss
  247. FileNameTime.tm_year+1900,
  248. FileNameTime.tm_mon+1,
  249. FileNameTime.tm_mday,
  250. FileNameTime.tm_hour,
  251. FileNameTime.tm_min,
  252. FileNameTime.tm_sec
  253. );
  254. t.append(TimestampBfr); // Append the timestamp to t
  255. return t; // and return it to the caller.
  256. }
  257. // Auto Reload Controls
  258. bool snf_RulebaseHandler::AutoRefresh(bool On) { // Turn on/off auto refresh.
  259. if(On) { // If they want Reload On:
  260. if(!AutoRefresh()) { // and it isn't already on:
  261. try { MyReloader = new snf_Reloader(*this); } // try to set up a Reloader.
  262. catch(...) { MyReloader = 0; } // If that fails we don't
  263. } // have one. If it's already
  264. } // on do nothing.
  265. else { // If they want Reload Off:
  266. if(AutoRefresh()) { // and it is turned on:
  267. delete MyReloader; // destroy the reloader and
  268. MyReloader = 0; // zero it's pointer.
  269. }
  270. }
  271. return AutoRefresh(); // Return the truth (on/off)
  272. }
  273. bool snf_RulebaseHandler::AutoRefresh() { // True if AutoRefresh is on.
  274. return (0 != MyReloader); // If we have one, it's on.
  275. }
  276. // _snf_LoadNewRulebase()
  277. // This is actually a common sub-funtion. It expects that the object is in the "RefreshInProgress" state,
  278. // and that everything is in place and safe for a new rulebase to be loaded into the object. Once it's
  279. // done it will reset from the "RefreshInProgress" state and along the way will throw any errors that
  280. // are appropriate. The other functions can count on this one to polish off the various forms of rulebase
  281. // load activity.
  282. const LogicCheck SaneRefreshProcessCheck("snf_RulebaseHandler::_snf_LoadNewRulebase():SaneRefreshProcessCheck(RefreshInProgress)");
  283. void snf_RulebaseHandler::_snf_LoadNewRulebase(){ // Common internal load/check routine.
  284. SaneRefreshProcessCheck(RefreshInProgress); // We only get called when this flag is set.
  285. try { MyCFGmgr.load(); } // Load a fresh copy of the configuration.
  286. catch(...) { // If something goes wrong:
  287. RefreshInProgress = false; // we are no longer "in refresh"
  288. throw ConfigurationError("_snf_LoadNewRulebase() MyCFGmgr.load() failed"); // throw the Configuration exception.
  289. }
  290. string RuleFilePath = MyCFGmgr.RuleFilePath(); // Get our rulebase file path and our
  291. string SecurityKey = MyCFGmgr.SecurityKey(); // security key from the CFG manager.
  292. if(0>=RuleFilePath.length()) { // If we don't have a path, we're hosed.
  293. RefreshInProgress = false; // We are no longer "in refresh"
  294. throw FileError("_snf_LoadNewRulebase() Zero length RuleFilePath"); // Can't load a RB file with no path!
  295. }
  296. if(0>=SecurityKey.length()) { // No security string? toast!
  297. RefreshInProgress = false; // We are no longer "in refresh"
  298. throw AuthenticationError("snf_LoadNewRulebase() Zero length SecurityKey"); // Can't authenticate without a key!
  299. }
  300. // Notify sub modules of the new configuration data.
  301. MyGeneration++; // Increment the generation number.
  302. snfCFGData& CFGData = (*(MyCFGmgr.ActiveConfiguration())); // Capture the active config...
  303. CFGData.Generation = MyGeneration; // Tag the configuration data.
  304. MyLOGmgr.configure(CFGData); // Update the LOGmgr's configuration.
  305. MyNETmgr.configure(CFGData); // Update the NETmgr's configuration.
  306. MyGBUdbmgr.configure(CFGData); // Update the GBUdbmgr's configuration.
  307. // Load the new rulebase locally (on stack) and see if it authenticates.
  308. TokenMatrix* TryThis = NULL; // We need our candidate to remain in scope.
  309. try { // This try block decodes the problem.
  310. try { // This try block does cleanup work.
  311. TryThis = new TokenMatrix(); // Grab a new Token Matrix
  312. TryThis->Load(RuleFilePath); // Load it from the provided file path
  313. TryThis->Validate(SecurityKey); // Validate it with the provided security key
  314. TryThis->Verify(SecurityKey); // Verify that it is not corrupt.
  315. }
  316. catch(...) { // Clean up after any exceptions.
  317. RefreshInProgress = false; // We're not refreshing now.
  318. if(TryThis) { // If we allocated a TokenMatrix then
  319. delete TryThis; // we need to reclaim the memory
  320. TryThis = 0; // and erase the pointer.
  321. } // With everything nice and clean we can
  322. throw; // rethrow he exception for decoding.
  323. }
  324. } // If nothing threw, we're golden!
  325. catch (TokenMatrix::BadFile) { // BadFile translates to FileError
  326. throw FileError("_snf_LoadNewRulebase() TokenMatrix::BadFile");
  327. }
  328. catch (TokenMatrix::BadMatrix) { // BadMatrix translates to AuthenticationError
  329. throw AuthenticationError("_snf_LoadNewRulebase() TokenMatrix::BadMatrix");
  330. }
  331. catch (TokenMatrix::BadAllocation) { // BadAllocation translates to AllocationError
  332. throw AllocationError("_snf_LoadNewRulebase() TokenMatrix::BadAllocation");
  333. }
  334. catch (TokenMatrix::OutOfRange) { // OutOfRange should never happen so PANIC!
  335. throw Panic("_snf_LoadNewRulebase() TokenMatrix::OutOfRange");
  336. }
  337. catch (exception e) {
  338. throw;
  339. }
  340. catch (...) { // Something unpredicted happens? PANIC!
  341. throw Panic("_snf_LoadNewRulebase() TokenMatrix.load() ???");
  342. }
  343. // At this point the rulebase looks good. If we need to go big-endian do it!
  344. #ifdef __BIG_ENDIAN__
  345. TryThis->FlipEndian(); // Flip tokens to big-endian format.
  346. #endif
  347. MyLOGmgr.updateActiveUTC(FileUTC(RuleFilePath)); // Update the Active Rulebase UTC.
  348. MyMutex.lock(); // Lock the mutex while changing state.
  349. OldRulebase = Rulebase; // Move the current rulebase and count to
  350. RetiringCount = CurrentCount; // the retiring slot.
  351. if(0>=RetiringCount && NULL!=OldRulebase) { // If nobody cares about the old rulebase
  352. delete OldRulebase; // then delete it, and wipe everything
  353. OldRulebase = NULL; // clean for the next retiree.
  354. RetiringCount = 0;
  355. }
  356. CurrentCount = 0; // Set the current count to zero (it's fresh!)
  357. Rulebase = TryThis; // Copy our new rulebase into production.
  358. MyMutex.unlock(); // Release the hounds!!!
  359. // If there is a GBUdb Ignore List, refresh with it (This might go elsewhere).
  360. // Failure to read the GBUdbIgnoreList if all else went well does not cause
  361. // the rulebase update (if any) to fail.
  362. /**** This section needs work ****/
  363. try {
  364. string IgnoreListPath = CFGData.paths_workspace_path;
  365. IgnoreListPath.append("GBUdbIgnoreList.txt");
  366. if(0 == MyGBUdb.readIgnoreList(IgnoreListPath.c_str())) // We must have at least 1 IP listed.
  367. throw ConfigurationError(
  368. "_snf_LoadNewRulebase() GBUdbIgnoreList min 1 entry!");
  369. }
  370. catch(...) { // Ignore list read might fail.
  371. RefreshInProgress = false; // If so, don't keep things hung.
  372. throw IgnoreListError("_snf_LoadNewRulebase() readIgnoreList() ???"); // If it does, throw FileError.
  373. }
  374. RefreshInProgress = false; // Done with the refresh process.
  375. return; // Our work is done here.
  376. }
  377. // open()
  378. // This loads a new rulebase (usually the first one only) into the handler. This is the first of two loading
  379. // methods on this object. This one checks for isBusy() because it is highly invasive. If it is called after
  380. // the object has been running it is important that it not run while anything in the object is active. This
  381. // is because it is likely in this case we would be loading an entirely new rulebase that would lead to odd
  382. // results if some scanner instances were activily using a different one.
  383. void snf_RulebaseHandler::open(const char* path, const char* licenseid, const char* authentication){
  384. MyMutex.lock(); // Lock the mutex while changing state.
  385. if(isBusy()) { // Be sure we're not busy.
  386. MyMutex.unlock(); throw Busy("snf_RulebaseHandler::open() busy"); // If we are then throw.
  387. }
  388. RefreshInProgress = true; // Set RefreshInProgress.
  389. MyMutex.unlock(); // Unlock the mutex and
  390. MyCFGmgr.initialize(path, licenseid, authentication); // Initialize our configuration.
  391. _snf_LoadNewRulebase(); // get on with loading the rulebase.
  392. MyGBUdbmgr.load(); // Load the GBUdb as configured.
  393. AutoRefresh(true); // Turn on Refresh by default.
  394. logThisInfo("--INITIALIZING--", 0, "Success"); // Log the happy event.
  395. return;
  396. }
  397. // refresh()
  398. // This loads a fresh copy of the current rulebase. This is the second loading method on the object. It is
  399. // specifically designed to work without stopping scanning activities. This one checks for isBusy() because
  400. // there may be an old rulebase that is not yet completely retired --- that is, some scanners may be using it.
  401. // If there is still an old rulebase on it's way out then we can't shove it aside without breaking something,
  402. // so we have to throw.
  403. //
  404. // Under normal circumstances, this call will cause a new rulebase to be loaded without disturbing any scans
  405. // underway on the current rulebase. The current rulebase will be put into retirement while any active scans
  406. // are completed, and then it will quietly go away when the last has finished. The new rulebase will take it's
  407. // place and will be handed out to all new grab() requests.
  408. void snf_RulebaseHandler::refresh(){ // Reloads the rulebase.
  409. MyMutex.lock(); // Lock the mutex while changing states.
  410. if(isBusy()) { // If we're busy then throw.
  411. MyMutex.unlock(); throw Busy("snf_RulebaseHandler::refresh() busy");
  412. }
  413. RefreshInProgress = true; // Set RefreshInProgress and
  414. MyMutex.unlock(); // unlock the mutex. Then get on with
  415. _snf_LoadNewRulebase(); // loading a fresh copy of the rulebase
  416. return;
  417. }
  418. void snf_RulebaseHandler::close(){ // Closes this handler.
  419. try {
  420. AutoRefresh(false); // Stop AutoRefresh if it's on.
  421. }
  422. catch(exception& e) { throw; } // Rethrow good exceptions.
  423. catch(...) { throw Panic("snf_RulebaseHandler::close() AutoRefresh(false) panic!"); } // Panic blank exceptions.
  424. try {
  425. MyXCImgr.stop(); // Stop the XCI manager.
  426. }
  427. catch(exception& e) { throw; } // Rethrow good exceptions.
  428. catch(...) { throw Panic("snf_RulebaseHandler::close() MyXCImgr.stop() panic!"); } // Panic blank exceptions.
  429. if(isBusy() || 0<CurrentCount || 0<ReferenceCount) { // Check that there is no activity.
  430. throw Busy("snf_RulebaseHandler::close() busy"); // With XCI stopped we should not
  431. } // be busy.
  432. try {
  433. MyLOGmgr.stop(); // Stop the LOG manager.
  434. }
  435. catch(exception& e) { throw; } // Rethrow good exceptions.
  436. catch(...) { throw Panic("snf_RulebaseHandler::close() MyLOGmgr.stop() panic!"); } // Panic blank exceptions.
  437. try {
  438. MyNETmgr.stop(); // Stop the NET manager.
  439. }
  440. catch(exception& e) { throw; } // Rethrow good exceptions.
  441. catch(...) { throw Panic("snf_RulebaseHandler::close() MyNETmgr.stop() panic!"); } // Panic blank exceptions.
  442. try {
  443. MyGBUdbmgr.stop(); // Stop the GBUdb manager.
  444. }
  445. catch(exception& e) { throw; } // Rethrow good exceptions.
  446. catch(...) { throw Panic("snf_RulebaseHandler::close() MyGBUdbmgr.stop() panic!"); } // Panic blank exceptions.
  447. try {
  448. if(NULL!=Rulebase) {delete Rulebase; Rulebase=NULL;} // If we have a Rulebase destroy it.
  449. }
  450. catch(exception& e) { throw; } // Rethrow good exceptions.
  451. catch(...) { throw Panic("snf_RulebaseHandler::close() delete Rulebase panic!"); } // Panic blank exceptions.
  452. try {
  453. if(NULL!=OldRulebase) {delete OldRulebase; OldRulebase=NULL;} // Shouldn't happen, but just in case.
  454. }
  455. catch(exception& e) { throw; } // Rethrow good exceptions.
  456. catch(...) { throw Panic("snf_RulebaseHandler::close() delete OldRulebase panic!"); } // Panic blank exceptions.
  457. }
  458. void snf_RulebaseHandler::use(){ // Make use of this Rulebase Handler.
  459. MyMutex.lock(); // Lock the object
  460. ReferenceCount++; // Boost the count
  461. MyMutex.unlock(); // Unlock the object
  462. }
  463. void snf_RulebaseHandler::unuse(){ // Finish with this Rulebase Handler.
  464. MyMutex.lock(); // Lock the object
  465. ReferenceCount--; // Reduce the count
  466. MyMutex.unlock(); // Unlock the object
  467. }
  468. // A word about Generation... In practice whenever the configuration or rulebase
  469. // changes the entire thing is reloaded. The Generation() function gives other
  470. // modules a way to know if they need to update their interpretation of the
  471. // configuration. They can keep track of the last Generation value they got and
  472. // compare it to the latest Generation. If the two are different then they need
  473. // to update their configuration - just in case it has changed.
  474. int snf_RulebaseHandler::Generation() { return MyGeneration; } // Returns the generation number.
  475. // A word about autopanics.
  476. // The first time throgh this we outsmarted ourselves with an ellaborate
  477. // wait-to-insert scheme. That led to the possibilty of a deadlock. Now we
  478. // copy the (usually empty or very short) set of rule panics to the
  479. // configuration packet when it is grabbed and only use the one mutext to hold
  480. // the configuration steady while doing so. All queries are made to the local
  481. // copy of the panic list and all writes are made, under mutex, to the active
  482. // configuration. Simpler, no significant penalty, and no more deadlocks.
  483. // A word about configuration packets.
  484. // Along the way we simplified things by making the snfCFGPacket do it's own
  485. // grab and drop upon construction and destruction. This way we don't have to
  486. // remember to handle all possible cases during a scan or other opertion -- once
  487. // the operation goes out of scope the configuration packet drop()s with it.
  488. void snf_RulebaseHandler::grab(snfCFGPacket& CP) { // Activate this Rulebase.
  489. ScopeMutex HoldStillPlease(MyMutex); // Lock the rulebase until we're done.
  490. CurrentCount++; // Boost the count for myself.
  491. CP.MyTokenMatrix = Rulebase; // Grab the current rulebase.
  492. CP.MyCFGData = MyCFGmgr.ActiveConfiguration(); // Grab the active configuration.
  493. CP.RulePanics = MyCFGmgr.ActiveConfiguration()->RulePanicHandler.IntegerSet; // Copy the RulePanic set.
  494. }
  495. void snf_RulebaseHandler::drop(snfCFGPacket& CP) { // Deactiveate this Rulebase.
  496. const TokenMatrix* t = CP.MyTokenMatrix; // Grab the token matrix pointer.
  497. CP.MyCFGData = NULL; // Null the configuration pointer.
  498. ScopeMutex HoldStillPlease(MyMutex); // Lock the rulebase until we're done.
  499. if(t==Rulebase) { // If we're dropping the current rulebase
  500. CurrentCount--; // then reduce the current count.
  501. } else // If not that then...
  502. if(t==OldRulebase) { // If we're dropping the old rulebase
  503. RetiringCount--; // reduce the retiring count and check...
  504. if(0>=RetiringCount) { // to see if it is completely retired.
  505. if(NULL!=OldRulebase) delete OldRulebase; // If it is then delete it and
  506. OldRulebase = NULL; RetiringCount = 0; // reset it's pointer and counter.
  507. }
  508. } else { // If we're dropping something else,
  509. throw Panic("snf_RulebaseHandler::drop() panic"); // it is time to panic, so, then PANIC!
  510. }
  511. }
  512. // When adding a rule panic entry the rulebase and configuration state cannot
  513. // be changed, nor grabbed by an snfCFGPacket. This ensures that the IntegerSet
  514. // is only adjusted by one thread at a time and that any threads using the set
  515. // will have a consistent result based on their last grab().
  516. void snf_RulebaseHandler::addRulePanic(int RuleID) { // Add a rule panic id dynamically.
  517. ScopeMutex JustMe(MyMutex); // Freeze the rulebase while we adjust
  518. MyCFGmgr.ActiveConfiguration() // the active configuration to
  519. ->RulePanicHandler.IntegerSet.insert(RuleID); // insert the new rule panic ruleid.
  520. } // When we're done, unlock and move on.
  521. IPTestRecord& snf_RulebaseHandler::performIPTest(IPTestRecord& I) { // Perform an IP test.
  522. snfCFGPacket MyCFGPacket(this); // We need a CFG packet.
  523. try { // Safely process the IP.
  524. if(false == MyCFGPacket.bad()) { // If we've got a good packet:
  525. I.G = MyGBUdb.getRecord(I.IP); // Lookup the IP in GBUdb.
  526. I.R = MyCFGPacket.Config()->RangeEvaluation(I.G); // Evaluate it's statistics.
  527. // Convert the RangeEvaluation into the configured Code
  528. switch(I.R) {
  529. case Unknown: // Unknown - not defined.
  530. case Normal: // Benefit of the doubt.
  531. case New: { // It is new to us.
  532. I.Code = 0; // Zero is the default - no code.
  533. break;
  534. }
  535. case White: { // This is a good guy.
  536. I.Code = MyCFGPacket.Config()->WhiteRangeHandler.Symbol;
  537. break;
  538. }
  539. case Caution: { // This is suspicious.
  540. I.Code = MyCFGPacket.Config()->CautionRangeHandler.Symbol;
  541. break;
  542. }
  543. case Black: { // This is bad.
  544. I.Code = MyCFGPacket.Config()->BlackRangeHandler.Symbol;
  545. break;
  546. }
  547. case Truncate: { // Don't even bother looking.
  548. I.Code = MyCFGPacket.Config()
  549. ->gbudb_regions_black_truncate_symbol;
  550. break;
  551. }
  552. }
  553. } // If something is broken we punt.
  554. } catch (...) {} // Ignore exceptions (none expected)
  555. return I; // Return the processed record.
  556. }
  557. void snf_RulebaseHandler::logThisIPTest(IPTestRecord& I, string Action) { // Log an IP test result & action.
  558. MyLOGmgr.logThisIPTest(I, Action);
  559. }
  560. void snf_RulebaseHandler::logThisError( // Log an error message.
  561. string ContextName, int Code, string Text
  562. ) {
  563. MyLOGmgr.logThisError(ContextName, Code, Text);
  564. }
  565. void snf_RulebaseHandler::logThisInfo( // Log an informational message.
  566. string ContextName, int Code, string Text
  567. ) {
  568. MyLOGmgr.logThisInfo(ContextName, Code, Text);
  569. }
  570. string snf_RulebaseHandler::PlatformVersion(string NewPlatformVersion) { // Set platform version info.
  571. return MyLOGmgr.PlatformVersion(NewPlatformVersion);
  572. }
  573. string snf_RulebaseHandler::PlatformVersion() { // Get platform version info.
  574. return MyLOGmgr.PlatformVersion();
  575. }
  576. string snf_RulebaseHandler::PlatformConfiguration() { // Get platform configuration.
  577. ScopeMutex LockAndGrab(MyMutex); // Freeze things for a moment and
  578. return MyCFGmgr.ActiveConfiguration()->PlatformElementContents; // copy the platform configuration.
  579. }
  580. string snf_RulebaseHandler::EngineVersion() { // Get engine version info.
  581. return MyLOGmgr.EngineVersion();
  582. }
  583. void snf_RulebaseHandler::
  584. XCIServerCommandHandler(snfXCIServerCommandHandler& XCH) { // Registers a new XCI Srvr Cmd handler.
  585. ScopeMutex ThereCanBeOnlyOne(XCIServerCommandMutex); // Serialize access to this resource.
  586. myXCIServerCommandHandler = &XCH; // Assign the new handler as provided.
  587. }
  588. string snf_RulebaseHandler::processXCIServerCommandRequest(snf_xci& X) { // Handle a parsed XCI Srvr Cmd request.
  589. ScopeMutex ThereCanBeOnlyOne(XCIServerCommandMutex); // Serialize access to this resource.
  590. if(0 == myXCIServerCommandHandler) { // If we don't have a handler then
  591. snfXCIServerCommandHandler H; // create a base handler and
  592. return H.processXCIRequest(X); // return it's default response.
  593. } // If we do have a handler then pass
  594. return myXCIServerCommandHandler->processXCIRequest(X); // on the request and return the
  595. } // response.
  596. //// snf_IPTestEngine Methods
  597. snf_IPTestEngine::snf_IPTestEngine() : // The constructor is simple - it
  598. Lookup(NULL), ScanData(NULL) { // sets up our internal references.
  599. } // Before use these must be set.
  600. void snf_IPTestEngine::setGBUdb(GBUdb& G) { // Here's how we set the GBUdb.
  601. Lookup = &G;
  602. }
  603. void snf_IPTestEngine::setScanData(snfScanData& S) { // Here's how we set the ScanData object.
  604. ScanData = &S;
  605. }
  606. void snf_IPTestEngine::setCFGData(snfCFGData& C) { // Here's how we set the CFGData.
  607. CFGData = &C;
  608. }
  609. void snf_IPTestEngine::setLOGmgr(snfLOGmgr& L) { // Here's how we set the LOGmgr.
  610. LOGmgr = &L;
  611. }
  612. // 20090127 _M Added special handling for forced IP sources. First, they are
  613. // always considered the source and second if they are in the GBUdb ignore list
  614. // then GBUdb training bypass is established.
  615. string& snf_IPTestEngine::test(string& input, string& output) { // Perform IP lookups and put IPs into ScanData.
  616. if(NULL == Lookup || NULL == ScanData) { // If we are not set up properly then we
  617. output = "{IPTest Config Error}"; // will return an error string.
  618. return output;
  619. }
  620. try { // If we're out of IP records, no analysis.
  621. IPScanRecord& I = ScanData->newIPScanRecord(); // Grab a new IP scan record and
  622. IP4Address IP = input; // Convert the string to an IP.
  623. // Identify forced Source IP addresses
  624. bool ThisSourceIsForced = ( // This IP is a forced source IP if:
  625. (0 == I.Ordinal) && ( // we are looking at the first IP and
  626. (0UL != ScanData->CallerForcedSourceIP()) || // either the Caller forced the IP or
  627. (0UL != ScanData->HeaderDirectiveSourceIP()) // the IP was forced by a header directive.
  628. )
  629. );
  630. // Bad IPs are possible, especially if the source was forced. In that
  631. // case forced source IP is meaningless so we want to ignore it and
  632. // we want to make the case visible in the logs. An ordinary IP that
  633. // is invalid has no consequence so we simply skip those.
  634. // Note that a source IP that has it's ignore flag set causes an
  635. // implied training bypass inside the scan function. Setting the bad
  636. // IP as the source and setting it's ignore flag will have the desired
  637. // effect.
  638. if(0UL == IP) { // If we got a 0 or a bad conversion then
  639. output = "{0.0.0.0 Is Not A Usable IP}"; // we won't be testing this IP.
  640. if(ThisSourceIsForced) { // If this ip is a forced source then
  641. I.GBUdbData.Flag(Ignore); // we will force a training bypass,
  642. ScanData->SourceIPRecord(I); // we will record it as the source,
  643. ScanData->SourceIPEvaluation = output; // and capture the error output.
  644. }
  645. return output;
  646. }
  647. if(0xFFFFFFFF == IP) { // If we got a 255.255.255.255 then
  648. output = "{255.255.255.255 Is Not A Usable IP}"; // we won't be testing this IP.
  649. if(ThisSourceIsForced) { // If this ip is a forced source then
  650. I.GBUdbData.Flag(Ignore); // we will force a training bypass,
  651. ScanData->SourceIPRecord(I); // we will record it as the source,
  652. ScanData->SourceIPEvaluation = output; // and capture the error output.
  653. }
  654. return output;
  655. }
  656. GBUdbRecord R = Lookup->getRecord(IP); // Get the GBUdb record for it.
  657. I.IP = IP; // store the IP and the
  658. I.GBUdbData = R; // GBUdb record we retrieved.
  659. output = "{"; // Next we start to build our IP data insert.
  660. ostringstream S; // We will use a string stream for formatting.
  661. switch(R.Flag()) { // Identify the flag data for this IP.
  662. case Good: S << "Good "; break;
  663. case Bad: S << "Bad "; break;
  664. case Ugly: S << "Ugly "; break;
  665. case Ignore: S << "Ignore "; break;
  666. }
  667. S << "c=" << R.Confidence() << " " // Include the Confidence and
  668. << "p=" << R.Probability(); // Probability.
  669. // Process ordinary Source IP addresses
  670. if( // The message source IP address is the
  671. (false == ScanData->FoundSourceIP()) && // first IP we find that is either forced
  672. (ThisSourceIsForced || (Ignore != R.Flag())) // OR is NOT part of our infrastructure.
  673. ) { // When we find the correct source IP:
  674. if( // Check to see if we're drilling down.
  675. (false == ThisSourceIsForced) && // We drill when the source is NOT forced
  676. (ScanData->isDrillDownSource(I)) // AND we have a matching drilldown.
  677. ) {
  678. Lookup->setIgnore(IP); // If we're drilling down ignore this IP.
  679. }
  680. else { // If not drilling down this is the source:
  681. ScanData->SourceIPRecord(I); // we log it in as the source
  682. S << " Source"; // and report our findings in our tag.
  683. // Since we are dealing with our source IP
  684. // this is a good place to evaluate our truncate feature.
  685. snfIPRange IPR =
  686. ScanData->SourceIPRange(CFGData->RangeEvaluation(R)); // Establish the IP range for this scan.
  687. // We will also emit a range identifier for pattern matches that might use it.
  688. switch(IPR) {
  689. case Unknown: { S << " Unknown"; break; } // Unknown - not defined.
  690. case White: { S << " White"; break; } // This is a good guy.
  691. case Normal: { S << " Normal"; break; } // Benefit of the doubt.
  692. case New: { S << " New"; break; } // It is new to us.
  693. case Caution: { S << " Caution"; break; } // This is suspicious.
  694. case Black: { S << " Black"; break; } // This is bad.
  695. case Truncate: { S << " Truncate"; break; } // Don't even bother looking.
  696. }
  697. ScanData->SourceIPEvaluation = S.str(); // Capture the source IP eval.
  698. // The RangeEvaluation() call above settles a lot of questions for us.
  699. // The Truncate return code only happens when the IP is either Bad w/
  700. // truncate turned on, or the statistics place the IP in the Truncate
  701. // range. If the Good flag is set the function always returns White so
  702. // here we only have to check for the Truncate flag.
  703. if(Truncate == IPR) { // If all of the conditions are met
  704. ScanData->GBUdbTruncateTriggered = true; // then Truncate has been triggered.
  705. ScanData->GBUdbPeekTriggered = LOGmgr->OkToPeek( // Since truncate was triggered, see if
  706. CFGData->gbudb_regions_black_truncate_peek_one_in); // we would also trigger a peek.
  707. // The reason we check the truncate on_off flag here is that the
  708. // IP range _may_ return a Truncate result if no Flags are set on
  709. // the IP and the IP is far enough into the black to reach the
  710. // Truncate threshold.
  711. if(CFGData->gbudb_regions_black_truncate_on_off) { // If truncate is on either peek or truncate.
  712. if(ScanData->GBUdbPeekTriggered) { // If a peek has been triggered then
  713. ScanData->GBUdbPeekExecuted = true; // mark the event and don't truncate.
  714. } else { // If a peek was not triggered then
  715. ScanData->GBUdbTruncateExecuted = true; // Record our trucnate action.
  716. output = ""; // Set up the truncate signal (empty string)
  717. return output; // and return it! We're done!
  718. }
  719. }
  720. }
  721. }
  722. }
  723. // If we're not truncating then we're going to return our IP evaulation tag
  724. // to the filter chain function module so it can emit it into the stream.
  725. output.append(S.str());
  726. output.append("}");
  727. }
  728. catch(snfScanData::NoFreeIPScanRecords) {
  729. output = "{too_many}";
  730. }
  731. catch(...) {
  732. output = "{fault}";
  733. }
  734. return output;
  735. }
  736. //// Engine Handler Methods
  737. snf_EngineHandler::~snf_EngineHandler(){ // Shutdown clenas up and checks for safety.
  738. if(isReady()) close(); // If we're live, close on our way out.
  739. }
  740. void snf_EngineHandler::open(snf_RulebaseHandler* Handler){ // Light up the engine.
  741. MyMutex.lock(); // Serialize this...
  742. if(isReady()) { // If we're already open then we need to
  743. MyMutex.unlock(); // unlock this object and let them know
  744. throw Busy("snf_EngineHandler::open() busy"); // we are busy.
  745. } // If we're not busy, then let's light it up.
  746. MyRulebase=Handler; // Install our rulebase handler.
  747. MyRulebase->use(); // Up the use count to let it know we're here.
  748. MyIPTestEngine.setGBUdb(MyRulebase->MyGBUdb); // Set up the IPTester's GBUdb.
  749. MyIPTestEngine.setScanData(MyScanData); // Set up the IPTester's ScanData reference.
  750. MyIPTestEngine.setLOGmgr(MyRulebase->MyLOGmgr); // Set up the IPTester's LOGmgr.
  751. MyMutex.unlock(); // Unlock our mutex, then...
  752. return; // our work is done.
  753. }
  754. bool snf_EngineHandler::isReady(){ // Is the Engine good to go?
  755. return (NULL!=MyRulebase); // Have rulebase will travel.
  756. }
  757. void snf_EngineHandler::close(){ // Close down the engine.
  758. MyMutex.lock(); // Serialize this...
  759. if(!isReady()){ // If we're not already open we can't close.
  760. MyMutex.unlock(); // Something is seriously wrong, so unlock
  761. throw Panic("snf_EngineHandler::close() !isReady panic"); // and hit the panic button!
  762. } // But, if everything is ok then we can
  763. MyRulebase->unuse(); // unuse our rulebase and quietly forget
  764. MyRulebase = NULL; // about it.
  765. if(NULL!=CurrentMatrix) { // If we have a leftover evaluation matrix
  766. delete CurrentMatrix; // we can let that go and forget about
  767. CurrentMatrix = NULL; // it as well.
  768. }
  769. MyMutex.unlock(); // Finally, we unlock our mutex and...
  770. return; // Our work is done here.
  771. }
  772. enum PatternResultTypes { // To train GBUdb we need a generalized
  773. NoPattern, // way to evaluate the results from the
  774. WhitePattern, // snf pattern matching scan.
  775. BlackPattern,
  776. IPPattern,
  777. AboveBandPattern
  778. };
  779. // In order to optimize message file reads when header injection is not activated
  780. // we need to look ahead to see if header injection is likely to be turned on when
  781. // we do the scan. This is a short term fix. The better fix might be to perform
  782. // the configuration load prior to scanning the message -- but that is a much larger
  783. // refactoring that ties up configuration and rulebase resources for a longer time.
  784. // Instead we're going to take an optimistic route and just peek at the configuration.
  785. // If the configuration changes while we're loading the file to be scanned then
  786. // we have two cases. If we go from XHDRInject off to XHDRInject on then we will
  787. // miss adding headers to the message - not a bad outcome. If we go from XHDRInject
  788. // on to XHDRInject off then we might emit headers for an extra message - also not
  789. // a bad outcome.
  790. bool snf_RulebaseHandler::testXHDRInjectOn() {
  791. ScopeMutex HoldStillPlease(MyMutex); // Lock the rulebase until we're done.
  792. snfCFGData* myCFG = MyCFGmgr.ActiveConfiguration(); // Grab the active configuration.
  793. bool myXHDRInjectOnFlag = (LogOutputMode_Inject == myCFG->XHDROutput_Mode); // True if output mode is inject.
  794. return myXHDRInjectOnFlag; // return the result.
  795. }
  796. int snf_EngineHandler::scanMessageFile( // Scan this message file.
  797. const string MessageFilePath, // -- this is the file path (and id)
  798. const int MessageSetupTime, // -- setup time already used.
  799. const IP4Address MessageSource // -- message source IP (for injection).
  800. ) {
  801. Timer AdditionalSetupTime;
  802. ScopeMutex DoingAFileScan(FileScan); // Protect MyScanData @ this entry.
  803. // Preliminary setup. Clearing the ScanData resets the ReadyToClear flag
  804. // and allows us to set some data for more accurate tracking and so that if
  805. // something goes wrong the ScanData will be helpful in determining the
  806. // state of the engine.
  807. MyScanData.clear(); // Clear the scan data.
  808. MyScanData.StartOfJobUTC = MyRulebase->MyLOGmgr.Timestamp(); // Set the job start timestamp.
  809. MyScanData.ScanName = MessageFilePath;
  810. // Now that the preliminaries are established we can begin our work.
  811. int MessageFileSize = 0; // Here will be the size of it.
  812. ifstream MessageFile; // Here will be our input file.
  813. MessageFile.exceptions( // It will throw exceptions for
  814. ifstream::eofbit | ifstream::failbit | ifstream::badbit // these unwanted events.
  815. );
  816. try { // Try opening the message file.
  817. MessageFile.open(MessageFilePath.c_str(), ios::in | ios::binary); // Open the file, binary mode.
  818. MessageFile.seekg(0, ios::end); // Find the end of the file,
  819. MessageFileSize = MessageFile.tellg(); // read that position as the size,
  820. MessageFile.seekg(0, ios::beg); // then go back to the beginning.
  821. MyScanData.ScanSize = MessageFileSize; // Capture the message file size.
  822. }
  823. catch(...) { // Trouble? Throw FileError.
  824. MyRulebase->MyLOGmgr.logThisError( // Log the error.
  825. MyScanData, "scanMessageFile().open",
  826. snf_ERROR_MSG_FILE, "ERROR_MSG_FILE"
  827. );
  828. throw FileError("snf_EngineHandler::scanMessageFile() Open/Seek");
  829. }
  830. if(0 >= MessageFileSize) { // Handle zero length files.
  831. MessageFile.close(); // No need to keep this open.
  832. MyRulebase->MyLOGmgr.logThisError( // Log the error.
  833. MyScanData, "scanMessageFile().isFileEmpty?",
  834. snf_ERROR_MSG_FILE, "ERROR_MSG_FILE"
  835. );
  836. throw FileError("snf_EngineHandler::scanMessageFile() FileEmpty!");
  837. }
  838. bool isXHeaderInjectionOn = MyRulebase->testXHDRInjectOn();
  839. bool noNeedToReadFullFile = (false == isXHeaderInjectionOn);
  840. if(noNeedToReadFullFile) {
  841. MessageFileSize = min(MessageFileSize, snf_ScanHorizon);
  842. }
  843. vector<unsigned char> MessageBuffer; // Allocate a buffer and size
  844. try { MessageBuffer.resize(MessageFileSize, 0); } // it to fit the message.
  845. catch(...) { // Trouble? Throw AllocationError.
  846. MyRulebase->MyLOGmgr.logThisError( // Log the error.
  847. MyScanData, "scanMessageFile().alloc",
  848. snf_ERROR_MSG_FILE, "ERROR_MSG_ALLOC"
  849. );
  850. throw AllocationError("snf_EngineHandler::scanMessageFile() Alloc");
  851. }
  852. try { MessageFile.read((char*) &MessageBuffer[0], MessageFileSize); } // Read the file into the buffer.
  853. catch(...) {
  854. MyRulebase->MyLOGmgr.logThisError( // Log the error.
  855. MyScanData, "scanMessageFile().read",
  856. snf_ERROR_MSG_FILE, "ERROR_MSG_READ"
  857. );
  858. throw FileError("snf_EngineHandler::scanMessageFile() Read");
  859. }
  860. MessageFile.close(); // Close the file.
  861. // Additional Setup Time will be captured as the call is made.
  862. int ScanResultCode = scanMessage( // Scan the message we've loaded.
  863. &MessageBuffer[0], // Here is the buffer pointer,
  864. MessageBuffer.size(), // here is the size of the message,
  865. MessageFilePath, // the path is the identifier,
  866. (AdditionalSetupTime.getElapsedTime() + MessageSetupTime), // and this is our setup time total.
  867. MessageSource // Pass on the source if provided.
  868. );
  869. // Inject headers if required.
  870. if(isXHeaderInjectionOn) { // If we are to inject headers:
  871. const char* XHDRInjStage = "Begin"; // Keep track of what we're doing.
  872. try {
  873. // The insertion point will be at the end of the existing headers.
  874. // We pick that point to be right between the two <cr><lf> so that
  875. // the first blank line will appear at the end of our headers.
  876. // We accommodate either <cr><lf> or <lf> line endings.
  877. // We are careful not to search past the end of unreasonably short
  878. // message files.
  879. unsigned int InsertPoint = 0; // Find the insertion point.
  880. bool UseLFOnly = false; // Use \n line endings in files?
  881. bool CRLFPresent = false; // Detected \r\n pairs?
  882. unsigned int BiggestPatternSize = 4; // How far we look ahead.
  883. bool BigEnoughMessage = BiggestPatternSize < MessageBuffer.size();
  884. if(BigEnoughMessage){
  885. unsigned int Limit = MessageBuffer.size() - BiggestPatternSize;
  886. bool DataWasSkipped = MessageBuffer.size() > MyScanData.ScanSize;
  887. unsigned int i = 0;
  888. if(DataWasSkipped) { // If our scanner skipped data at
  889. i = MessageBuffer.size() - MyScanData.ScanSize; // the top of the message buffer then
  890. } // we will skip it too.
  891. for(; i < Limit; i++) { // Search for the first blank line.
  892. if( // Detect CRLF pairs if present.
  893. false == CRLFPresent &&
  894. '\r' == MessageBuffer.at(i) &&
  895. '\n' == MessageBuffer.at(i + 1)
  896. ) CRLFPresent = true;
  897. if( // In a properly formatted RFC822
  898. '\r' == MessageBuffer.at(i) && // message that looks like
  899. '\n' == MessageBuffer.at(i + 1) && // <cr><lf><cr><lf>
  900. '\r' == MessageBuffer.at(i + 2) &&
  901. '\n' == MessageBuffer.at(i + 3)
  902. ) {
  903. InsertPoint = i + 2;
  904. break;
  905. } else
  906. if( // In some bizarre cases it might
  907. '\n' == MessageBuffer.at(i) && // look like <lf><lf>.
  908. '\n' == MessageBuffer.at(i + 1)
  909. ) {
  910. InsertPoint = i + 1;
  911. UseLFOnly = true; // We have to strip <CR> from our
  912. break; // injected header line ends.
  913. }
  914. }
  915. }
  916. // Here we must interpret the results of our search. Do we know where
  917. // our insert point is or do we punt and use the top of the message?
  918. if(0 == InsertPoint) { // No blank line? We need to punt.
  919. if(false == CRLFPresent) { // What kind of line ends do we use?
  920. UseLFOnly = true; // If no CRLF found use LF only.
  921. } // Either way we will be inserting
  922. } // our headers at the top of the msg.
  923. // At this point we know where to split the message and insert
  924. // our X Headers.
  925. XHDRInjStage = "Open Temp File"; // Update our process monitor.
  926. string TempFileName = MessageFilePath; // Prepare a temp file name
  927. TempFileName.append(".tmp"); // based on the message file.
  928. ofstream TempFile; // Here will be our temp file.
  929. TempFile.exceptions(ofstream::failbit | ofstream::badbit); // It will throw these exceptions.
  930. TempFile.open(TempFileName.c_str(), ios::binary | ios::trunc); // Open and truncate the file.
  931. // If our insert point is the top of the message we'll skip this.
  932. if(0 < InsertPoint) { // If we have an insert point:
  933. XHDRInjStage = "Write Temp File.1"; // Update our process monitor.
  934. TempFile.write( // Write the message file up
  935. reinterpret_cast<char*>(&MessageBuffer[0]), // to our split.
  936. InsertPoint
  937. );
  938. }
  939. // If our file has \n line ends we need to strip the \r from our
  940. // rfc822 \r\n line ends.
  941. XHDRInjStage = "XHDR <CR><LF> to <LF>";
  942. if(true == UseLFOnly) { // If we are using <LF> only:
  943. string ReworkedHeaders = ""; // Make a new string and rework
  944. for( // our headers.
  945. string::iterator iS = MyScanData.XHDRsText.begin(); // Run through the headers one
  946. iS != MyScanData.XHDRsText.end(); iS++ // byte at a time.
  947. ) {
  948. if('\r' != (*iS)) ReworkedHeaders.push_back(*iS); // Strip out any <CR> chars.
  949. }
  950. MyScanData.XHDRsText.swap(ReworkedHeaders); // Swap in our reworked headers.
  951. }
  952. // Now we are ready to inject our headers.
  953. XHDRInjStage = "Write Temp File.2"; // Update our process monitor.
  954. TempFile.write( // Inject our headers.
  955. MyScanData.XHDRsText.c_str(),
  956. MyScanData.XHDRsText.length()
  957. );
  958. XHDRInjStage = "Write Temp File.3"; // Update our process monitor.
  959. TempFile.write( // Write the rest of the message.
  960. reinterpret_cast<char*>(&MessageBuffer[InsertPoint]),
  961. MessageBuffer.size() - InsertPoint
  962. );
  963. XHDRInjStage = "Close Temp File"; // Update our process monitor.
  964. TempFile.close(); // Close the file (flushing it).
  965. Sleeper PauseBeforeRetry(300); // Delay to use between retries.
  966. XHDRInjStage = "Drop Msg"; // Update our process monitor.
  967. if(remove(MessageFilePath.c_str())) { // Remove the old message file
  968. PauseBeforeRetry(); // If it fails, pause and retry.
  969. if(remove(MessageFilePath.c_str())) { // If that fails,
  970. PauseBeforeRetry(); // pause, then try once more.
  971. if(remove(MessageFilePath.c_str())) { // If that fails, throw.
  972. throw XHDRError("XHDR injector can't remove original!");
  973. }
  974. }
  975. }
  976. XHDRInjStage = "Rename Temp -> Msg"; // Update our process monitor.
  977. if(rename(TempFileName.c_str(), MessageFilePath.c_str())) { // Make Temp our new message file.
  978. PauseBeforeRetry(); // If it fails, pause and retry.
  979. if(rename(TempFileName.c_str(), MessageFilePath.c_str())) { // If that fails,
  980. PauseBeforeRetry(); // pause then try once more.
  981. if(rename(TempFileName.c_str(), MessageFilePath.c_str())) { // If that fails, throw.
  982. throw XHDRError("XHDR injector can't rename tmp file!");
  983. }
  984. }
  985. }
  986. }
  987. catch(XHDRError& e) { // For full XHDRError exceptions.
  988. string ERROR_MSG_XHDRi = "ERROR_MSG_XHDRi: "; // Format the XHDRInj error msg.
  989. ERROR_MSG_XHDRi.append(XHDRInjStage);
  990. ERROR_MSG_XHDRi.append(" ");
  991. ERROR_MSG_XHDRi.append(e.what());
  992. MyRulebase->MyLOGmgr.logThisError( // Log the error.
  993. MyScanData, "scanMessageFile().xhdr.inject",
  994. snf_ERROR_MSG_FILE, ERROR_MSG_XHDRi
  995. );
  996. throw; // Rethrow any XHDRError exceptions.
  997. }
  998. catch(exception& e) { // For ordinary runtime exceptions.
  999. string ERROR_MSG_XHDRi = "ERROR_MSG_XHDRi: "; // Format the XHDRInj error msg.
  1000. ERROR_MSG_XHDRi.append(XHDRInjStage);
  1001. ERROR_MSG_XHDRi.append(" ");
  1002. ERROR_MSG_XHDRi.append(e.what());
  1003. MyRulebase->MyLOGmgr.logThisError( // Log the error.
  1004. MyScanData, "scanMessageFile().xhdr.inject",
  1005. snf_ERROR_MSG_FILE, ERROR_MSG_XHDRi
  1006. );
  1007. throw XHDRError(ERROR_MSG_XHDRi); // Rethrow as XHDRError exceptions.
  1008. }
  1009. catch(...) { // If we encounter a problem then
  1010. string ERROR_MSG_XHDRi = "ERROR_MSG_XHDRi: "; // Format the XHDRInj error msg.
  1011. ERROR_MSG_XHDRi.append(XHDRInjStage);
  1012. MyRulebase->MyLOGmgr.logThisError( // Log the error.
  1013. MyScanData, "scanMessageFile().xhdr.inject",
  1014. snf_ERROR_MSG_FILE, ERROR_MSG_XHDRi
  1015. );
  1016. string XHDRError_msg = "Message Rewrite Failed: "; // Format our throw message with
  1017. XHDRError_msg.append(XHDRInjStage); // our detailed stage data and
  1018. throw XHDRError(XHDRError_msg); // throw our special exception.
  1019. }
  1020. }
  1021. // Create an .xhdr file if required.
  1022. if(MyScanData.XHeaderFileOn) {
  1023. try {
  1024. ofstream XHDRFile; // Output file will be XHDRFile.
  1025. XHDRFile.exceptions(ofstream::failbit | ofstream::badbit); // These events will throw exceptions.
  1026. string XHDRFileName = MessageFilePath; // Build the XHDR file name by adding
  1027. XHDRFileName.append(".xhdr"); // .xhdr to the message file name.
  1028. XHDRFile.open(XHDRFileName.c_str(), ios::binary | ios::trunc); // Open (and truncate) the file.
  1029. XHDRFile << MyScanData.XHDRsText; // Spit out the XHDRs.
  1030. XHDRFile.close(); // All done.
  1031. }
  1032. catch(...) { // If we encounter a problem then
  1033. MyRulebase->MyLOGmgr.logThisError( // Log the error.
  1034. MyScanData, "scanMessageFile().xhdr.file",
  1035. snf_ERROR_MSG_FILE, "ERROR_MSG_XHDRf"
  1036. );
  1037. throw XHDRError(".xhdr file write failed"); // throw our special exception.
  1038. }
  1039. }
  1040. return ScanResultCode; // Return the actual result, of course.
  1041. }
  1042. string snf_EngineHandler::extractMessageID( // Find and return the first Message-ID
  1043. const unsigned char* Msg, // Input the Message buffer to search
  1044. const int Len // and the length of the buffer.
  1045. ) {
  1046. string ExtractedID = ""; // Start with an empty string.
  1047. bool FoundID = false; // Haven't found it yet.
  1048. int C = 0; // Cursor position.
  1049. while(!FoundID && (C < (Len - 12))) { // Loop through the Msg looking for
  1050. if( // the Message-ID: header.
  1051. ('\n' == Msg[C]) && // Starting at the new line find
  1052. ('M' == Msg[C + 1] || 'm' == Msg[C + 1]) && // Message-ID: (per RFC822)
  1053. ('e' == Msg[C + 2] || 'E' == Msg[C + 2]) &&
  1054. ('s' == Msg[C + 3] || 'S' == Msg[C + 3]) && // We use an unrolled comparison
  1055. ('s' == Msg[C + 4] || 'S' == Msg[C + 4]) && // loop here for raw speed and
  1056. ('a' == Msg[C + 5] || 'A' == Msg[C + 5]) && // optimization. Note that we
  1057. ('g' == Msg[C + 6] || 'G' == Msg[C + 6]) && // compare the most likely characters
  1058. ('e' == Msg[C + 7] || 'E' == Msg[C + 7]) && // first in each case, and we don't
  1059. ('-' == Msg[C + 8]) && // need to go through a buffer length
  1060. ('I' == Msg[C + 9] || 'i' == Msg[C + 9]) && // check at each byte for partial
  1061. ('D' == Msg[C + 10] || 'd' == Msg[C + 10]) && // matches.
  1062. (':' == Msg[C + 11]) &&
  1063. (' ' == Msg[C + 12] || '\t' == Msg[C + 12])
  1064. ) {
  1065. C = C + 13; // Starting just after the space
  1066. while(C < Len) { // and staying within bounds
  1067. unsigned char X = Msg[C]; // grab each character in the ID.
  1068. if(isprint(X)) { // If it is printable,
  1069. if(' ' == X) X = '_'; // massage out the spaces as _ and
  1070. if(127 < X) X = '|'; // high characters as | and
  1071. if('\'' == X || '\"' == X) X = '`'; // ' or " to ` in order to make the
  1072. ExtractedID.push_back(X); // ID safe for logging, then push
  1073. } else // the result into our string. When
  1074. if('\r' == X || '\n' == X) break; /* leave copy loop */ // we reach the end we're done.
  1075. ++C; // else get ready for the next byte.
  1076. }
  1077. FoundID = true; // Set the flag: we found Message-ID:
  1078. break; /* leave search loop */ // We got what we came for. Break!
  1079. } else { // When we don't find the Message-ID:
  1080. if( // we check for end of headers.
  1081. ('\n' == Msg[C] && '\n' == Msg[C+1]) || // Either <LF><LF> or
  1082. ('\r' == Msg[C] && '\n' == Msg[C+1] && // <CR><LF><CF><LF>
  1083. '\r' == Msg[C+2] && '\n' == Msg[C+3])
  1084. ) { // If we've found the end of headers
  1085. break; // we're done looking. If we did not
  1086. } // find the end of headers then
  1087. ++C; // we move to the next position.
  1088. }
  1089. }
  1090. // At this point we either have the Extracted ID, or we need a substitute.
  1091. if(0 == ExtractedID.length()) { // If we need a substitute ID then
  1092. MyRulebase->MyLOGmgr.SerialNumber(ExtractedID); // use the next available serial number.
  1093. }
  1094. return ExtractedID; // Return the extracted id or substitute.
  1095. }
  1096. const LogicFault FaultBadMessageBuffer1("snf_EngineHandler::scanMessage():FaultBadMessageBuffer1(NULL == inputMessageBuffer)");
  1097. const LogicFault FaultBadMessageBuffer2("snf_EngineHandler::scanMessage():FaultBadMessageBuffer2(0 >= inputMessageLength)");
  1098. const char Unknown_SNFMatchFlag = '-';
  1099. const char Panic_SNFMatchFlag = 'p';
  1100. const char Match_SNFMatchFlag = 'm';
  1101. const char White_SNFMatchFlag = 'w';
  1102. const char Final_SNFMatchFlag = 'f';
  1103. void captureMatchRecord(snf_match& M, MatchRecord* R) {
  1104. M.flag = Unknown_SNFMatchFlag;
  1105. M.ruleid = R->RuleId();
  1106. M.symbol = R->RuleGroup();
  1107. M.index = R->MatchStartPosition;
  1108. M.endex = R->MatchEndPosition;
  1109. }
  1110. void snf_SaccadesHandler::applySaccades(EvaluationMatrix* Scanner, vector<unsigned char>& Data) {
  1111. if(NULL == Scanner) return;
  1112. bool isTimeToPeek = (0 >= TimeToPeekCounter);
  1113. if(isTimeToPeek) {
  1114. TimeToPeekCounter = TimeToPeekReset;
  1115. return;
  1116. } else {
  1117. --TimeToPeekCounter;
  1118. }
  1119. vector<saccade> Saccades = grabSaccades();
  1120. for(vector<saccade>::iterator i = Saccades.begin(); i != Saccades.end(); i++) {
  1121. const saccade& s = (*i);
  1122. if(s.start >= Data.size()) break;
  1123. Scanner->evaluateSegment(Data, s.start, s.finish);
  1124. }
  1125. }
  1126. bool isLearnableMatch(MatchRecord* m) {
  1127. bool isGoodSymbol = (0 <= m->RuleGroup() && 64 > m->RuleGroup());
  1128. bool isBeyondAlwaysScan = (snf_SaccadesHandler::AlwaysScanLength < m->MatchEndPosition);
  1129. return (isGoodSymbol && isBeyondAlwaysScan);
  1130. }
  1131. void snf_SaccadesHandler::learnMatches(MatchRecord* Matches) {
  1132. if(NULL == Matches) return;
  1133. vector<saccade> MatchesToLearn;
  1134. saccade WatchForHeaderWhiteRules(0, AlwaysScanLength);
  1135. MatchesToLearn.push_back(WatchForHeaderWhiteRules);
  1136. for(MatchRecord* m = Matches; NULL != m; m = m->NextMatchRecord) {
  1137. if(isLearnableMatch(m)) {
  1138. MatchesToLearn.push_back(
  1139. saccade(
  1140. m->MatchStartPosition,
  1141. m->MatchEndPosition)
  1142. );
  1143. }
  1144. }
  1145. if(0 < MatchesToLearn.size()) {
  1146. lockAndLearn(MatchesToLearn);
  1147. }
  1148. }
  1149. static snf_SaccadesHandler SaccadeBrain;
  1150. int snf_EngineHandler::scanMessage( // Scan this message (in buffer).
  1151. const unsigned char* inputMessageBuffer, // -- this is the message buffer.
  1152. const int inputMessageLength, // -- this is the length of the buffer.
  1153. const string MessageName, // -- this is the message identifier.
  1154. const int MessageSetupTime, // -- setup time used (for logging).
  1155. const IP4Address MessageSource // -- message source IP (for injection).
  1156. ) {
  1157. ScopeTimer ScanTimeCapture(MyScanData.ScanTime); // Start the scan time clock.
  1158. unsigned char* MessageBuffer = NULL; // Explicitly initialize these two
  1159. int MessageLength = 0; // so the compiler will be happy.
  1160. FaultBadMessageBuffer1(NULL == inputMessageBuffer); // Fault on null message buffer.
  1161. FaultBadMessageBuffer2(0 >= inputMessageLength); // Fault on bad message bfr length.
  1162. // Protect this engine - only one scan at a time per EngineHandler ;-)
  1163. ScopeMutex ScannerIsBusy(MyMutex); // Serialize this...
  1164. // Preliminary job setup.
  1165. // In our pre-processing we may adjust our input buffer so we capture the
  1166. // originals and then use the captured values. For example if we are scanning
  1167. // Communigate message files we will want to skip the communigate headers.
  1168. MessageBuffer = const_cast<unsigned char*>(inputMessageBuffer); // Capture the input buffer.
  1169. MessageLength = inputMessageLength; // Capture the input length.
  1170. MyScanData.clear(); // Clear the scan data.
  1171. MyScanData.ScanSize = MessageLength; // Grab the message length.
  1172. MyScanData.SetupTime = MessageSetupTime; // Capture the setup time.
  1173. if(0 == MyScanData.StartOfJobUTC) { // If the job timestamp is not
  1174. MyScanData.StartOfJobUTC = MyRulebase->MyLOGmgr.Timestamp(); // yet set then set it.
  1175. }
  1176. MyScanData.CallerForcedSourceIP(MessageSource); // Capture the MessageSource if any.
  1177. // Special note about exceptions here...
  1178. // Setting up the filter chain can throw an exception. It can't go in it's own try block or it will
  1179. // be out of scope for the remainder of the function... SO, I've wrapped everything inside of the
  1180. // Lock() in a try block ... and there's a nested one also for scanning the content. The result is
  1181. // that I can put all of the unlock work in the "outer" try block and re-throw anything that's
  1182. // needed.
  1183. snfCFGPacket MyCFGPacket(MyRulebase); // We need this to stay in scope.
  1184. // Set up the filter chain, configure the scanner, and scan the message.
  1185. try {
  1186. if(MyCFGPacket.bad()) { // If it's not there it's a big problem.
  1187. throw Panic("snf_EngineHandler::scanMessage() MyCFGPacket.bad()");
  1188. }
  1189. // Adapt to CGP message files - skip the CGP headers
  1190. MyScanData.MessageFileTypeCGPOn = // Find out if we are expecting
  1191. MyCFGPacket.Config()->MessageFileTypeCGP_on_off; // Communigate message files.
  1192. if(MyScanData.MessageFileTypeCGPOn) { // If we are scanning CGP files:
  1193. while(4 < MessageLength) { // Skip over the CGP headers.
  1194. if( // On Winx systems look for the first
  1195. '\r' == MessageBuffer[0] && // blank line encoded as CRLF CRLF.
  1196. '\n' == MessageBuffer[1] &&
  1197. '\r' == MessageBuffer[2] &&
  1198. '\n' == MessageBuffer[3]
  1199. ) { // If we find it then skip past
  1200. MessageBuffer += 4; // the new line and break out
  1201. MessageLength -= 4; // of the loop.
  1202. break;
  1203. } else // On *nix systems look for the first
  1204. if( // blank line encoded as LF LF.
  1205. '\n' == MessageBuffer[0] &&
  1206. '\n' == MessageBuffer[1]
  1207. ) { // If we find it then skip past
  1208. MessageBuffer += 2; // the blank line and break out
  1209. MessageLength -= 2; // of the loop.
  1210. break;
  1211. }
  1212. else { // If we don't find it then
  1213. ++MessageBuffer; // eat one byte from the buffer
  1214. --MessageLength; // and keep going.
  1215. }
  1216. }
  1217. // At this point our MessagBuffer contains just the message we
  1218. // want to scan.
  1219. MyScanData.ScanSize = MessageLength; // Reset the scan size.
  1220. }
  1221. // Identify this message.
  1222. if( // How do we identify this scan?
  1223. 0 == MessageName.length() || // If no name was provided or
  1224. true == MyCFGPacket.Config()->Scan_Identifier_Force_Message_Id // we are forcing RFC822 IDs then
  1225. ) { // extract the Message-ID from the
  1226. MyScanData.ScanName = extractMessageID(MessageBuffer, MessageLength); // message and use that.
  1227. } else { // If a name was provided and we
  1228. MyScanData.ScanName = MessageName; // are not forcing RFC822 IDs then
  1229. } // use the name provided to us.
  1230. // Set up our filter chain.
  1231. stringstream PrependedHeaders; // Use this to prepend X-Headers.
  1232. FilterChainCBFR IU(MessageBuffer, MessageLength, PrependedHeaders); // Set up the filter chain.
  1233. FilterChainHeaderAnalysis IV(&IU, MyIPTestEngine); // Include header analysis.
  1234. FilterChainBase64 IW(&IV); // Include Base64 decoding.
  1235. FilterChainQuotedPrintable IX(&IW); // Include Quoted Printable decoding.
  1236. FilterChainUrlDecode IY(&IX); // Include URL decoder.
  1237. FilterChainDefunker IZ(&IY); // Include Defunking.
  1238. // Now we set up our scanner and grab the current token matrix.
  1239. if(NULL!=CurrentMatrix) { delete CurrentMatrix; CurrentMatrix=NULL; } // If we have old results, delete them.
  1240. try {
  1241. CurrentMatrix = new EvaluationMatrix(MyCFGPacket.Tokens()); // Allocate a new matrix for this scan.
  1242. } catch(...) { // Check that the allocation worked.
  1243. throw AllocationError("new EvaluationMatrix() ???");
  1244. }
  1245. // Here we get down to it and start scanning the message.
  1246. const char* DebugInfo = "scanMessage() Begin Message Scan"; // If we panic, here we are.
  1247. try {
  1248. // The IPTestEngine has the ability to truncate the message in the filter
  1249. // chain under certain conditions. In order to configure those conditions
  1250. // the IPTestEngine needs to have the configuration data being used for
  1251. // the current scan.
  1252. DebugInfo = "scanMessage() setCFGData()"; // If we panic, here we are.
  1253. MyIPTestEngine.setCFGData(*(MyCFGPacket.Config())); // Setup the CFG data to use.
  1254. // Check processed headers for header directive rules. One of these might
  1255. // include a directive to get the message source IP from a header. If so
  1256. // then MyScanData will have been modified. Also if there are drill-down
  1257. // directives then MyScanData will have been modified to mark any headers
  1258. // that should be ignored -- in this case the IP test used in the filter
  1259. // chain will take appropriate action as it comes across the Received
  1260. // headers that have been marked.
  1261. DebugInfo = "scanMessage() Get Header Directives";
  1262. MyScanData.HeaderDirectiveFlags = 0x00000000; // Clear the header directive flags.
  1263. if(0 < MyCFGPacket.Config()-> // Check to see if we have any
  1264. HeaderDirectivesHandler.HeaderDirectives.size()) { // header directive rules and if we do:
  1265. HeaderFinder HeaderDirectivesParser( // Parse the headers in the message
  1266. &MyScanData, // and update the ScanData using the
  1267. MyCFGPacket.Config()->HeaderDirectivesHandler.HeaderDirectives, // directives in our configuration packet.
  1268. MessageBuffer, // Pass the message as a pointer with
  1269. MessageLength // a specific buffer length.
  1270. );
  1271. MyScanData.HeaderDirectiveFlags = HeaderDirectivesParser(); // Capture the parsed results.
  1272. }
  1273. // Message header rules in earlier versions occasionally failed because there was not
  1274. // a new-line character in front of the very first header. So, now we insert one :-)
  1275. // This allows all header rules to start off with a ^ indicating the start of the line.
  1276. // 20070719_M Added \n to X-snfScanSize: synthetic header.
  1277. // 20070120_M There are some messages where the size is a specific part of
  1278. // the pattern so we will now be emitting this data into the engine. A later
  1279. // version of the engine should handle this kind of thing using a special
  1280. // filter chain module.
  1281. DebugInfo = "scanMessage() ^X-snfScanSize"; // If we panic here we are.
  1282. // Build the scan size info
  1283. PrependedHeaders << "X-snfScanSize: " << MyScanData.ScanSize << "\n"; // and format as an X- header.
  1284. // Add a phantom received header to the top IF the message source has been
  1285. // forced by the caller or by a header directive. After that the normal
  1286. // scanning and header analysis process should pick up the IP as the
  1287. // source of the message. (It will not if the IP is ignored in the GBUdb!)
  1288. DebugInfo = "scanMessage() PhantomReceived"; // If we panic we are here.
  1289. if(0UL != MyScanData.CallerForcedSourceIP()) { // If the caller forced the source IP:
  1290. PrependedHeaders // Make a phantom Received header
  1291. << "Received: Caller.Forced.Source.IP [" // showing that the caller forced
  1292. << (string) MyScanData.CallerForcedSourceIP() << "]\n"; // the source IP.
  1293. } else
  1294. // If not forced by the caller but a
  1295. if(0UL != MyScanData.HeaderDirectiveSourceIP()) { // header directive forced the source IP:
  1296. PrependedHeaders // Make a phantom Received header
  1297. << "Received: Header.Directive.Source.IP [" // showing that a header directive
  1298. << (string) MyScanData.HeaderDirectiveSourceIP() << "]\n"; // established the source IP.
  1299. }
  1300. // Most of the time we will extract the source IP the normal way.
  1301. // If there are other prepended headers to add they should go here.
  1302. /** Add other prepended headers **/
  1303. // 20070719_M Reworked the engine to handle the filter-chain section in
  1304. // a tight loop separately from the scanning section. This should allow
  1305. // for tighter optimization in some cases (less cache thrashing) and also
  1306. // provides for later development of parallel analysis of the pre-filtered
  1307. // data, as well as the ability to output the pre-filtered data for use in
  1308. // rule development and debugging.
  1309. DebugInfo = "scanMessage() IZ.GetByte() ==> FilteredData"; // If we panic we are here.
  1310. unsigned char xb=0;
  1311. MyScanData.FilteredData.clear(); // Clear the FilteredData buffer.
  1312. try { // Watch for exceptions and scan
  1313. for(int a = 0; a < snf_ScanHorizon; a++) // the message through the filter
  1314. MyScanData.FilteredData.push_back(xb=IZ.GetByte()); // chain into the FilteredData buffer.
  1315. } // When we run out of data we will
  1316. catch(FilterChain::Empty) {} // get the Empty exception and stop.
  1317. // Scan each byte in the file up to the horizon or the end of the message.
  1318. // If something goes wrong, an exception will be thrown.
  1319. DebugInfo = "scanMessage() EvaluateThis(FilteredData)"; // If we panic, here we are.
  1320. if(false == MyScanData.GBUdbTruncateExecuted) { // If we haven't already truncated:
  1321. //for(int a = 0, b = MyScanData.FilteredData.size(); a < b; a++) // Scan through the filtered data one
  1322. // CurrentMatrix->EvaluateThis(MyScanData.FilteredData[a]); // byte at a time.
  1323. unsigned int fullLength = MyScanData.FilteredData.size();
  1324. SaccadeBrain.applySaccades(CurrentMatrix, MyScanData.FilteredData);
  1325. bool messageNotRecognized = (NULL == CurrentMatrix->ResultList);
  1326. if(messageNotRecognized) {
  1327. CurrentMatrix->evaluateSegment(MyScanData.FilteredData, 0, fullLength);
  1328. SaccadeBrain.learnMatches(CurrentMatrix->ResultList);
  1329. }
  1330. }
  1331. DebugInfo = "scanMessage() Scan Data Complete"; // If we panic, here we are.
  1332. }
  1333. catch(EvaluationMatrix::BadAllocation) { // Check for bad allocation during scan.
  1334. throw AllocationError("EvaluationMatrix::BadAllocation");
  1335. }
  1336. catch(EvaluationMatrix::MaxEvalsExceeded) { // Check for too many evaluators.
  1337. throw MaxEvals("EvaluationMatrix::MaxEvalsExceeded");
  1338. }
  1339. catch(EvaluationMatrix::OutOfRange) { // Check for out of range of (bad) matrix.
  1340. throw BadMatrix("EvaluationMatrix::OutOfRange");
  1341. }
  1342. catch(exception& e) { // Some other known exception?
  1343. throw; // rethrow.
  1344. }
  1345. catch(...){ // In order to prevent thread craziness
  1346. throw Panic(DebugInfo); // throw a Panic.
  1347. } // The mutex will unlock in the outer try.
  1348. }
  1349. // Here is the end of the outer try block. We can catch and rethrow whatever happend
  1350. // and we can also keep our mutex properly managed.
  1351. catch(AllocationError& e) { // Allocation Errors pass through.
  1352. MyRulebase->MyLOGmgr.logThisError( // Log the error.
  1353. MyScanData, "scanMessage()",
  1354. snf_ERROR_ALLOCATION, "ERROR_ALLOCATION"
  1355. );
  1356. throw;
  1357. }
  1358. catch(MaxEvals& e) { // MaxEvals == Panic, with a log.
  1359. MyRulebase->MyLOGmgr.logThisError( // Log the error.
  1360. MyScanData, "scanMessage()",
  1361. snf_ERROR_MAX_EVALS, "ERROR_MAX_EVALS"
  1362. );
  1363. throw;
  1364. }
  1365. catch(BadMatrix& e) { // BadMatrix == Panic, with a log.
  1366. MyRulebase->MyLOGmgr.logThisError( // Log the error.
  1367. MyScanData, "scanMessage()",
  1368. snf_ERROR_BAD_MATRIX, "ERROR_BAD_MATRIX"
  1369. );
  1370. throw;
  1371. }
  1372. catch(Panic& e) { // Panic is panic.
  1373. MyRulebase->MyLOGmgr.logThisError( // Log the error.
  1374. MyScanData, "scanMessage()",
  1375. snf_ERROR_BAD_MATRIX, "ERROR_PANIC"
  1376. );
  1377. throw;
  1378. }
  1379. catch(exception& e) { // Other exceptions.
  1380. MyRulebase->MyLOGmgr.logThisError( // Log the error.
  1381. MyScanData, "scanMessage()",
  1382. snf_ERROR_UNKNOWN, "ERROR_EXCEPTION"
  1383. );
  1384. throw;
  1385. }
  1386. catch(...) { // Anything else == Panic.
  1387. MyRulebase->MyLOGmgr.logThisError( // Log the error.
  1388. MyScanData, "scanMessage()",
  1389. snf_ERROR_UNKNOWN, "ERROR_UNKNOWN"
  1390. );
  1391. throw Panic("snf_EngineHandler::scanMessage() ERROR_UNKNOWN!");
  1392. }
  1393. // At this point, we've completed our scan and we're ready to evaluate our results to find the correct symbol to return.
  1394. ResultsCount = 0; // Reset the count,
  1395. ResultsRemaining = 0; // Remaining count,
  1396. FinalResult = NULL; // Final Result marker,
  1397. ResultCursor = CurrentMatrix -> ResultList; // And cursor position for our results.
  1398. // Now that our result processing gadgets are reset, let's process the results list.
  1399. int const CLEAN_RESULT = 0; // CLEAN means no matches or white.
  1400. int const NO_SYMBOL = 999; // NO_SYMBOL is higher than any SYMBOL
  1401. int S = NO_SYMBOL; // so we start there and work down.
  1402. snf_match TmpSNFMatch; // We'll need a buffer for our matches.
  1403. while(NULL!=ResultCursor) { // While we have records to process...
  1404. captureMatchRecord(TmpSNFMatch, ResultCursor); // grab the next record and evaluate it.
  1405. bool isPanickedRule = MyCFGPacket.isRulePanic(TmpSNFMatch.ruleid);
  1406. bool isVotingCandidate = (false == isPanickedRule);
  1407. bool isWhiteRule = (
  1408. MyCFGPacket.Config()->TrainingWhiteRuleHandler.isListed(TmpSNFMatch.ruleid) ||
  1409. 0 == TmpSNFMatch.symbol
  1410. );
  1411. bool isBestResultCode = (TmpSNFMatch.symbol < S);
  1412. // Set an appropriate flag.
  1413. if(isPanickedRule) TmpSNFMatch.flag = Panic_SNFMatchFlag;
  1414. else if(isWhiteRule) TmpSNFMatch.flag = White_SNFMatchFlag;
  1415. else TmpSNFMatch.flag = Match_SNFMatchFlag;
  1416. // Vote for best rule match.
  1417. if(isVotingCandidate && isBestResultCode) {
  1418. FinalResult = ResultCursor;
  1419. S = TmpSNFMatch.symbol;
  1420. }
  1421. // Record this MatchRecord and mMove on to next result.
  1422. MyScanData.MatchRecords.push_back(TmpSNFMatch);
  1423. ResultsCount++;
  1424. ResultCursor=ResultCursor->NextMatchRecord;
  1425. }
  1426. if(NO_SYMBOL != S) { // If a pattern match was detected then
  1427. MyScanData.PatternWasFound = true; // trip the flag and record the
  1428. MyScanData.PatternID = FinalResult->RuleId(); // Rule ID and the
  1429. MyScanData.PatternSymbol = FinalResult->RuleGroup(); // Symbol.
  1430. }
  1431. //// GBUdb Integration ///////////////////////////////////////////////////////
  1432. // To integrate GBUdb we need to generalize the result from the pattern scan.
  1433. PatternResultTypes ScanResultType = NoPattern; // What kind of result have we here?
  1434. if(0 < (MyScanData.HeaderDirectiveFlags & HeaderDirectiveWhite)) { // If a white header directive matched
  1435. ScanResultType = WhitePattern; // then we have a "WhitePattern'.
  1436. } else
  1437. if(MyCFGPacket.Config()->TrainingWhiteRuleHandler.isListed(S)) { // If the pattern was mapped to a white
  1438. ScanResultType = WhitePattern; // rule group then we have a 'WhitePattern'.
  1439. } else
  1440. if(CLEAN_RESULT == S) { // If there was a standard white rule
  1441. ScanResultType = WhitePattern; // result then we have a 'WhitePattern'.
  1442. } else
  1443. if(NO_SYMBOL == S) { // If there was no pattern match then
  1444. ScanResultType = NoPattern; // we have 'NoPattern'.
  1445. } else
  1446. if(63 == S) { // If the pattern was a standard IP rule
  1447. ScanResultType = IPPattern; // then we have an 'IPPattern'.
  1448. } else
  1449. if(62 >= S) { // In general, other nonzer rule groups
  1450. ScanResultType = BlackPattern; // indicate we have a 'BlackPatter'.
  1451. } else
  1452. if(63 < S) { // Any pattern number > 63 is special.
  1453. ScanResultType = AboveBandPattern; // Any of these are an 'AboveBandPattern'
  1454. }
  1455. if(MyScanData.FoundSourceIP()) { // We need an identified IP source.
  1456. // Train the GBUdb based on our pattern matching results.
  1457. // Evaluate our training conditions.
  1458. bool TrainingIsTurnedOn = MyCFGPacket.Config()->GBUdbTrainingOn_Off;
  1459. bool MessageWasNotTruncated = (false == MyScanData.GBUdbTruncateExecuted);
  1460. bool ThereIsNoBypassHeaderDirective = (0 == (MyScanData.HeaderDirectiveFlags & HeaderDirectiveBypass));
  1461. bool ThereIsNoBypassResultCodeRule = (false == MyCFGPacket.Config()->TrainingBypassRuleHandler.isListed(S));
  1462. bool ThereIsNoImpliedBypassDirective = (Ignore != (MyScanData.SourceIPRecord().GBUdbData.Flag()));
  1463. // If these conditions are favorable then train the GBUdb.
  1464. if( // Check to see if training is enabled.
  1465. TrainingIsTurnedOn && // If it is turned on AND
  1466. MessageWasNotTruncated && // The message was not truncated AND
  1467. ThereIsNoBypassHeaderDirective && // There is NO Bypass header directive AND
  1468. ThereIsNoBypassResultCodeRule && // There is NO Bypass result code rule AND
  1469. ThereIsNoImpliedBypassDirective // There is NO Implied bypass directive:
  1470. ) {
  1471. // GBUdb training is enabled.
  1472. switch(ScanResultType) { // Evaluate the scan result.
  1473. case NoPattern: // On no pattern (benefit of doubt) or
  1474. case WhitePattern: { // a white pattern:
  1475. MyRulebase->MyGBUdb.addGood( // then add a good count to the
  1476. MyScanData.SourceIPRecord().IP); // source IP.
  1477. break;
  1478. }
  1479. case BlackPattern: { // On a black pattern:
  1480. MyRulebase->MyGBUdb.addBad( // add a bad count to the source IP
  1481. MyScanData.SourceIPRecord().IP); // in the GBUdb.
  1482. break;
  1483. }
  1484. default: break; // In all other cases, don't train.
  1485. }
  1486. }
  1487. // GBUdb Training Is Complete
  1488. // At this point our SourceIPRange tells us exactly how to evaluate
  1489. // the source IP for this message.
  1490. switch(MyScanData.SourceIPRange()) {
  1491. case White: { // If the IP was in the white zone
  1492. MyScanData.GBUdbWhiteTriggered = true; // mark that down.
  1493. if(MyCFGPacket.Config()->WhiteRangeHandler.On_Off) { // If we're also turned on then
  1494. if( // do we need to force the symbol?
  1495. BlackPattern == ScanResultType || // We do if the pattern scan resulted
  1496. IPPattern == ScanResultType // in a black or IPblack match.
  1497. ) { // If we must force a white result:
  1498. S = MyCFGPacket.Config()->WhiteRangeHandler.Symbol; // force the symbol and
  1499. MyScanData.GBUdbWhiteSymbolForced = true; // record that it was done.
  1500. }
  1501. // AutoPanic
  1502. int AutoPanicRangeLowerBound = // Calculate the current lower bound
  1503. MyRulebase->MyLOGmgr.LatestRuleID() - // for rule id's that are eligible to
  1504. MyCFGPacket.Config()->gbudb_regions_white_panic_rule_range; // trigger auto-panics.
  1505. if(BlackPattern == ScanResultType || IPPattern == ScanResultType) { // Was there a pattern/source conflict?
  1506. MyScanData.GBUdbPatternSourceConflict = true; // Record the event.
  1507. if(MyScanData.PatternID > AutoPanicRangeLowerBound) { // If the pattern ID is in range then
  1508. MyScanData.GBUdbAutoPanicTriggered = true; // record that the AutoPanic triggered.
  1509. if(MyCFGPacket.Config()->gbudb_regions_white_panic_on_off) { // If rule panics are turned on then
  1510. MyScanData.GBUdbAutoPanicExecuted = true; // indicate we are executing an autopanic.
  1511. MyRulebase->addRulePanic(MyScanData.PatternID); // Add the rule panic.
  1512. }
  1513. }
  1514. }
  1515. }
  1516. break;
  1517. }
  1518. case Normal: { // If the IP is normal...
  1519. MyScanData.GBUdbNormalTriggered = true; // Count the event.
  1520. break; // That's all.
  1521. }
  1522. case New: {
  1523. break;
  1524. }
  1525. case Caution: { // If the IP is in the caution range.
  1526. MyScanData.GBUdbCautionTriggered = true; // Track that this range fired.
  1527. if(
  1528. MyCFGPacket.Config()->CautionRangeHandler.On_Off && // If we're also turned on and there
  1529. NoPattern == ScanResultType // is no pattern match then
  1530. ) { // we will override the scan result:
  1531. S = MyCFGPacket.Config()->CautionRangeHandler.Symbol; // set the symbol as configured and
  1532. MyScanData.GBUdbCautionSymbolForced = true; // record that it was done.
  1533. }
  1534. break;
  1535. }
  1536. // Truncate is a kind of uber-black, so we do some weirdness here.
  1537. // If Truncate happens, then black was triggered by definition. In
  1538. // peek cases or if Truncate is turned off then Truncate might not
  1539. // execute-- when that happens we need to fall back to Black behavior.
  1540. case Truncate: // If the IP was in the truncate range
  1541. case Black: { // and/or If the IP is in the black range
  1542. MyScanData.GBUdbBlackTriggered = true; // mark that down.
  1543. if(MyScanData.GBUdbTruncateExecuted) { // If the truncate action was executed
  1544. S = MyCFGPacket.Config()->gbudb_regions_black_truncate_symbol; // we set the output symbol accordingly.
  1545. } else // Truncate overrides black.. but if
  1546. if( // Black is in charge do this...
  1547. MyCFGPacket.Config()->BlackRangeHandler.On_Off && // If black action is turned on and there
  1548. NoPattern == ScanResultType // is no pattern match then
  1549. ) { // we will override the scan data:
  1550. S = MyCFGPacket.Config()->BlackRangeHandler.Symbol; // set the symbol as configured and
  1551. MyScanData.GBUdbBlackSymbolForced = true; // record that it was done.
  1552. }
  1553. // Now that all of the overrides have been handled we can handle
  1554. // sampling. When a black IP is detected and a pattern match is not
  1555. // then we may sample the data.
  1556. int BlackSampleRate = // Grab the sample rate to make the
  1557. MyCFGPacket.Config()->gbudb_regions_black_sample_grab_one_in; // logic clearer.
  1558. bool SampleThresholdReached = // Check the spam probability of the
  1559. (MyCFGPacket.Config()->gbudb_regions_black_sample_probability <= // source IP against the configuration
  1560. MyScanData.SourceIPRecord().GBUdbData.Probability()); // to see if this IP is a candidate.
  1561. if( // Should we sample?
  1562. false == MyScanData.GBUdbTruncateExecuted && // If this was not a truncation and
  1563. NoPattern == ScanResultType && // No pattern match was found and
  1564. SampleThresholdReached && // We reached out sample threshold and
  1565. MyRulebase->MyLOGmgr.OkToSample(BlackSampleRate) // It's ok for us to sample this round
  1566. ) { // then our sampling mechanism is triggerd.
  1567. MyScanData.GBUdbSampleTriggered = true; // Mark down that event.
  1568. if(MyCFGPacket.Config()->gbudb_regions_black_sample_on_off) { // If sampling is turned on then
  1569. MyScanData.GBUdbSampleExecuted = true; // we will be sampling this data.
  1570. if(MyCFGPacket.Config()->gbudb_regions_black_sample_passthrough) { // If sampling by passthrough then
  1571. S = MyCFGPacket.Config()-> // Force the symbol value to passthrough
  1572. gbudb_regions_black_sample_passthrough_symbol; // (usually 0 - same as CLEAN).
  1573. } else { // If sampling internally then
  1574. MyRulebase->MyNETmgr.sendSample( // send this message as a sample.
  1575. (*(MyCFGPacket.Config())), // Pass our current config info,
  1576. MyScanData, // our scan data,
  1577. MessageBuffer, // and the message itself.
  1578. MessageLength
  1579. );
  1580. }
  1581. }
  1582. }
  1583. break;
  1584. }
  1585. case Unknown: // Unknown - most likely we couldn't
  1586. default: { // find a usable source.
  1587. break; // Do nothing.
  1588. }
  1589. }
  1590. } // End of IP source depended work (GBUdbOverrides)
  1591. // At this point we know the final result of our scan
  1592. // and the number of results we have. It's time to set up our result
  1593. // processing widgets for further query and return the result of this scan.
  1594. ResultCursor = CurrentMatrix -> ResultList; // Starting at the top of the list
  1595. ResultsRemaining = ResultsCount; // with all of the results ahead of us.
  1596. if(NO_SYMBOL==S) S = CLEAN_RESULT; // When there were no results, CLEAN
  1597. MyScanData.CompositeFinalResult = S; // Record what we will return.
  1598. if( // Prepare our final result.
  1599. CLEAN_RESULT == S && // If we have a clean result code
  1600. ScanResultType != WhitePattern && // and it wasn't forced by a white
  1601. false == MyScanData.GBUdbWhiteSymbolForced) { // rule or white GBUdb then we mark
  1602. TmpSNFMatch.flag = 'c'; // the final record Clean.
  1603. } else { // Otherwise we mark the final record
  1604. TmpSNFMatch.flag = 'f'; // as Final - meaning deliberately zero.
  1605. }
  1606. TmpSNFMatch.index = 0; // Our index is charater zero.
  1607. TmpSNFMatch.endex = CurrentMatrix->CountOfCharacters - 1; // Our endex is the end of the message.
  1608. TmpSNFMatch.symbol = MyScanData.CompositeFinalResult; // Our symbol is in CompositeFinal.
  1609. // The rule id is dependent on what's happened...
  1610. if( // If the symbol has been forced...
  1611. MyScanData.GBUdbTruncateExecuted || // Was it a Truncate-IP scan?
  1612. MyScanData.GBUdbWhiteSymbolForced || // Was it a White-IP scan?
  1613. MyScanData.GBUdbBlackSymbolForced || // Was it a Black-IP scan?
  1614. MyScanData.GBUdbCautionSymbolForced || // Was it a Caution-IP scan?
  1615. NULL == FinalResult // OR there was no valid match
  1616. ) { // then our rule id will be
  1617. TmpSNFMatch.ruleid = 0; // ZERO.
  1618. } else { // Normally the rule id will be
  1619. TmpSNFMatch.ruleid = FinalResult->RuleId(); // that of the winning pattern match.
  1620. }
  1621. MyScanData.MatchRecords.push_back(TmpSNFMatch); // Push our final entry onto the list.
  1622. MyScanData.MatchRecordsCursor = MyScanData.MatchRecords.begin(); // Reset the delivery system to the
  1623. MyScanData.MatchRecordsDelivered = 0; // beginning of the results list.
  1624. MyScanData.ScanDepth = CurrentMatrix->MaximumCountOfEvaluators; // Capture the scan depth.
  1625. MyScanData.ScanTime.stop(); // Stop the scan time clock.
  1626. MyRulebase->MyLOGmgr.logThisScan((*(MyCFGPacket.Config())), MyScanData); // Log the data from this scan.
  1627. // Since V2-9rc19 of this engine, the Engine mutex and snfCFGPacket handle
  1628. // their own cleanup when this call goes out of scope. ScannerIsBusy(MyMutex)
  1629. // will unlock() on destruction and snfCFGPacket will MyRulebase->drop().
  1630. return S; // Return the final scan result.
  1631. }
  1632. int snf_EngineHandler::getResults(snf_match* MatchBuffer){ // Get the next match buffer.
  1633. ScopeMutex SerializeThis(MyMutex); // Serialize this...
  1634. if(NULL == MatchBuffer) { // If we were given the reset signal
  1635. MyScanData.MatchRecordsCursor = MyScanData.MatchRecords.begin(); // Move the cursor to the beginning
  1636. MyScanData.MatchRecordsDelivered = 0; // and reset the delivered count.
  1637. } else { // If we are in delivery mode and
  1638. if(MyScanData.MatchRecords.end() != MyScanData.MatchRecordsCursor) { // there are more to deliver then
  1639. (*MatchBuffer) = (*MyScanData.MatchRecordsCursor); // deliver the current match and
  1640. ++MyScanData.MatchRecordsCursor; // move on to the next. Be sure to
  1641. ++MyScanData.MatchRecordsDelivered; // count this one as delivered.
  1642. }
  1643. }
  1644. return MyScanData.MatchRecords.size() - MyScanData.MatchRecordsDelivered; // Return a count of unseen records.
  1645. }
  1646. int snf_EngineHandler::getDepth(){ // Get the scan depth.
  1647. ScopeMutex SerializeThis(MyMutex); // Protect our reading.
  1648. return MyScanData.ScanDepth; // Return the latest scan depth.
  1649. }
  1650. const string snf_EngineHandler::getClassicLog() { // Get classic log entries for last scan.
  1651. ScopeMutex SerializeThis(MyMutex); // Serialize this...
  1652. return MyScanData.ClassicLogText; // Return the log text.
  1653. }
  1654. const string snf_EngineHandler::getXMLLog() { // Get XML log entries or last scan.
  1655. ScopeMutex SerializeThis(MyMutex); // Serialize this...
  1656. return MyScanData.XMLLogText; // Return the log text.
  1657. }
  1658. const string snf_EngineHandler::getXHDRs() { // Get XHDRs for last scan.
  1659. ScopeMutex SerializeThis(MyMutex); // Serialize this...
  1660. return MyScanData.XHDRsText; // Return the XHeaders text.
  1661. }
  1662. //// Multi Engine Handler Methods
  1663. // snf_RoundRulebaseCursor()
  1664. // Returns the next rulebase slot id wrapping around to zero.
  1665. int snf_MultiEngineHandler::RoundRulebaseCursor(){ // Return the next Rulebase handle
  1666. RulebaseCursor++; // Increase the cursor.
  1667. if(snf_MAX_RULEBASES<=RulebaseCursor) // If we've reached the end of the array
  1668. RulebaseCursor=0; // then we start back at zero.
  1669. return RulebaseCursor; // Return the new handle candidate.
  1670. }
  1671. // snf_RoundEngineCursor()
  1672. // Returns the next engine slot id wrapping around to zero.
  1673. int snf_MultiEngineHandler::RoundEngineCursor(){ // Return the next Engine handle candidate.
  1674. EngineCursor++; // Increase the cursor.
  1675. if(snf_MAX_SCANNERS<=EngineCursor) // If we've reached the end of the array
  1676. EngineCursor=0; // then we start back at zero.
  1677. return EngineCursor; // Return the new handle candidate.
  1678. }
  1679. snf_MultiEngineHandler::~snf_MultiEngineHandler(){ // Clean up, safety check, shut down.
  1680. RulebaseScan.lock(); // Lock both the rulebase and
  1681. EngineScan.lock(); // engine scan rulebases.
  1682. RulebaseCursor = EngineCursor = SHUTDOWN; // Set the cursors to the FINISHED value.
  1683. // The handlers in the arrays will all get closed by their destructors.
  1684. // The SHUTDOWN value in the cursors will force any errant threads to get no love.
  1685. RulebaseScan.unlock();
  1686. EngineScan.unlock();
  1687. }
  1688. // snf_OpenRulebase()
  1689. // Grab the first available rulebse handler and light it up.
  1690. int snf_MultiEngineHandler::OpenRulebase(const char* path, const char* licenseid, const char* authentication){
  1691. RulebaseScan.lock(); // Serialize this.
  1692. if(SHUTDOWN==RulebaseCursor) { // Not ok to open after shutdown.
  1693. RulebaseScan.unlock();
  1694. throw Panic("snf_MultiEngineHandler::OpenRulebase() No open after shutdown");
  1695. }
  1696. int Handle = RoundRulebaseCursor(); // Grab the next hanlder on the list.
  1697. if(RulebaseHandlers[Handle].isReady()) { // Check to see if it's already in use. If so,
  1698. int wherewasi = Handle; // keep track of where we started.
  1699. while(RulebaseHandlers[(Handle=RoundRulebaseCursor())].isReady()){ // Loop to find an free handler.
  1700. if(wherewasi==Handle) { // If we get back where we started
  1701. RulebaseScan.unlock(); // Unlock the Rulebase Scanning process
  1702. throw TooMany("snf_MultiEngineHandler::OpenRulebase() Too Many Open"); // and tell the caller Too Many are open.
  1703. }
  1704. }
  1705. }
  1706. // Now we have a Handle to a free RulebaseHandler. Time to open it up.
  1707. try {
  1708. RulebaseHandlers[Handle].open(path,licenseid,authentication); // Try to open the handler.
  1709. } // If an exception is thrown...
  1710. catch(snf_RulebaseHandler::AuthenticationError& e) // Catch and re-throw the appropriate
  1711. { RulebaseScan.unlock(); throw AuthenticationError(e.what()); } // exception.
  1712. catch(snf_RulebaseHandler::AllocationError& e)
  1713. { RulebaseScan.unlock(); throw AllocationError(e.what()); }
  1714. catch(snf_RulebaseHandler::FileError& e)
  1715. { RulebaseScan.unlock(); throw FileError(e.what()); }
  1716. catch(snf_RulebaseHandler::Busy& e)
  1717. { RulebaseScan.unlock(); throw Panic(e.what()); } // Wasn't busy above!! Shoudn't be here!!!
  1718. catch(exception& e)
  1719. { RulebaseScan.unlock(); throw; }
  1720. catch(...) {
  1721. RulebaseScan.unlock();
  1722. throw Panic("snf_MultiEngineHandler::OpenRulebase() ???");
  1723. }
  1724. RulebaseScan.unlock(); // If everything went well then UnLock
  1725. return Handle; // and return the happy new handle.
  1726. }
  1727. // snf_RefreshRulebase()
  1728. // Reload the rulebase associated with the handler.
  1729. void snf_MultiEngineHandler::RefreshRulebase(int RulebaseHandle){ // Refreshing a rulebase (Not Serialized)
  1730. try {
  1731. RulebaseHandlers[RulebaseHandle].refresh(); // Try to refresh the rulebase.
  1732. } // Catch and rethrow any exceptions.
  1733. catch(snf_RulebaseHandler::AuthenticationError& e) {
  1734. throw AuthenticationError(e.what());
  1735. }
  1736. catch(snf_RulebaseHandler::AllocationError& e) {
  1737. throw AllocationError(e.what());
  1738. }
  1739. catch(snf_RulebaseHandler::FileError& e) {
  1740. throw FileError(e.what());
  1741. }
  1742. catch(snf_RulebaseHandler::Busy& e) {
  1743. throw Busy(e.what());
  1744. }
  1745. catch(exception& e) {
  1746. throw;
  1747. }
  1748. catch(...) {
  1749. throw Panic("snf_MultiEngineHandler::RefreshRulebase() ???");
  1750. }
  1751. }
  1752. // snf_CloseRulebase()
  1753. // Shut down this Rulebase handler.
  1754. void snf_MultiEngineHandler::CloseRulebase(int RulebaseHandle){ // Closing a rulebase handler
  1755. RulebaseScan.lock(); // Serialize this - the handler changes state.
  1756. try { // Try to close the handler.
  1757. RulebaseHandlers[RulebaseHandle].close();
  1758. }
  1759. catch(snf_RulebaseHandler::Busy& e) { // A busy throw we can understand.
  1760. RulebaseScan.unlock(); throw Busy(e.what());
  1761. }
  1762. catch(exception& e) { // Other exceptions? rethrow.
  1763. RulebaseScan.unlock(); throw;
  1764. }
  1765. catch(...) { // Any other throw is big trouble.
  1766. RulebaseScan.unlock();
  1767. throw Panic("snf_MultiEngineHandler::CloseRulebase() ???");
  1768. }
  1769. RulebaseScan.unlock(); // When done, unlock the Rulebase Scan process.
  1770. }
  1771. // snf_OpenEngine()
  1772. // Grab the first available Engine handler and light it up
  1773. int snf_MultiEngineHandler::OpenEngine(int RulebaseHandle){
  1774. EngineScan.lock(); // Serialize this.
  1775. if(SHUTDOWN==EngineCursor) { // Not ok to open after shutdown.
  1776. EngineScan.unlock();
  1777. throw Panic("snf_MultiEngineHandler::OpenEngine() No open after shutdwon");
  1778. }
  1779. int Handle = RoundEngineCursor(); // Grab the next hanlder on the list.
  1780. if(EngineHandlers[Handle].isReady()) { // Check to see if it's already in use. If so,
  1781. int wherewasi = Handle; // keep track of where we started.
  1782. while(EngineHandlers[(Handle=RoundEngineCursor())].isReady()){ // Loop to find an free handler.
  1783. if(wherewasi==Handle) { // If we get back where we started
  1784. EngineScan.unlock(); // Unlock the Rulebase Scanning process
  1785. throw TooMany("snf_MultiEngineHandler::OpenEngine() too many open"); // and tell the caller Too Many are open.
  1786. }
  1787. }
  1788. }
  1789. // Now we have a Handle to a free RulebaseHandler. Time to open it up.
  1790. try {
  1791. EngineHandlers[Handle].open(&RulebaseHandlers[RulebaseHandle]); // Try to open the handler.
  1792. } // If an exception is thrown...
  1793. catch(snf_EngineHandler::AllocationError& e) // Catch and rethrow as appropriate.
  1794. { EngineScan.unlock(); throw AllocationError(e.what()); }
  1795. catch(snf_EngineHandler::Busy& e)
  1796. { EngineScan.unlock(); throw Panic(e.what()); } // Not busy above should not be busy now!!!
  1797. catch(exception& e) {
  1798. EngineScan.unlock();
  1799. throw;
  1800. }
  1801. catch(...) {
  1802. EngineScan.unlock();
  1803. throw Panic("snf_MultiEngineHandler::OpenEngine() ???");
  1804. }
  1805. EngineScan.unlock(); // If everything went well then UnLock
  1806. return Handle; // and return the happy new handle.
  1807. }
  1808. // snf_CloseEngine()
  1809. // Shut down this Engine handler.
  1810. void snf_MultiEngineHandler::CloseEngine(int EngineHandle){ // Closing an engine handler.
  1811. EngineScan.lock(); // Serialize this, the object changes states.
  1812. try {
  1813. EngineHandlers[EngineHandle].close(); // Try closing the handler.
  1814. }
  1815. catch(snf_EngineHandler::AllocationError& e) // Catch and throw any exceptions as needed.
  1816. { EngineScan.unlock(); throw AllocationError(e.what()); }
  1817. catch(snf_EngineHandler::Busy& e)
  1818. { EngineScan.unlock(); throw Busy(e.what()); }
  1819. catch(exception& e) {
  1820. EngineScan.unlock();
  1821. throw;
  1822. }
  1823. catch(...) {
  1824. EngineScan.unlock();
  1825. throw Panic("snf_MultiEngineHandler::CloseEngine() ???");
  1826. }
  1827. EngineScan.unlock(); // Unlock when we're closed.
  1828. }
  1829. // snf_Scan()
  1830. // Scan the MessageBuffer with this Engine.
  1831. int snf_MultiEngineHandler::Scan(int EngineHandle, const unsigned char* MessageBuffer, int MessageLength){
  1832. // NOT serialized. Many scans at once, presumably one scan engine per thread.
  1833. int ScanResult; // ScanResult stays in scope.
  1834. try {
  1835. ScanResult=EngineHandlers[EngineHandle]
  1836. .scanMessage(MessageBuffer,MessageLength); // Try the scan on the given engine.
  1837. }
  1838. catch(snf_EngineHandler::AllocationError& e) { // Re-throw any exceptions as needed.
  1839. throw AllocationError(e.what());
  1840. }
  1841. catch(snf_EngineHandler::Busy& e) { throw Busy(e.what()); }
  1842. catch(exception& e) { throw; }
  1843. catch(...) { throw Panic("snf_MultiEngineHandler::Scan() ???"); }
  1844. return ScanResult; // Return the results.
  1845. }
  1846. // The Engine prvides detailed match results through this function.
  1847. int snf_MultiEngineHandler::getResults(int EngineHandle, snf_match* matchbfr){
  1848. // NOT serialized. Many scans at once, presumably one scan engine per thread.
  1849. int ResultCount; // ResultCount stays in scope.
  1850. try {
  1851. ResultCount=EngineHandlers[EngineHandle].getResults(matchbfr); // Try the scan on the given engine.
  1852. }
  1853. catch(snf_EngineHandler::AllocationError& e) { // Re-throw any exceptions as needed.
  1854. throw AllocationError(e.what());
  1855. }
  1856. catch(snf_EngineHandler::Busy& e) { throw Busy(e.what()); }
  1857. catch(exception& e) { throw; }
  1858. catch(...) { throw Panic("snf_MultiEngineHandler::getResults() ???"); }
  1859. return ResultCount; // Return the results.
  1860. }
  1861. // The Engine provies the scan depth through this function.
  1862. int snf_MultiEngineHandler::getDepth(int EngineHandle){
  1863. // NOT serialized. Many scans at once, presumably one scan engine per thread.
  1864. int DepthResult; // ScanResult stays in scope.
  1865. try {
  1866. DepthResult=EngineHandlers[EngineHandle].getDepth(); // Try the scan on the given engine.
  1867. }
  1868. catch(snf_EngineHandler::AllocationError& e) { // Re-throw any exceptions as needed.
  1869. throw AllocationError(e.what());
  1870. }
  1871. catch(snf_EngineHandler::Busy& e) { throw Busy(e.what()); }
  1872. catch(exception& e) { throw; }
  1873. catch(...) { throw Panic("snf_MultiEngineHandler::getDepth() ???"); }
  1874. return DepthResult; // Return the results.
  1875. }