From 9be652f8ffa7df69b11846ed1c9079f84c8e6697 Mon Sep 17 00:00:00 2001 From: Jon Siwek Date: Wed, 30 Nov 2011 10:13:20 -0600 Subject: [PATCH 01/14] Rearrange packet filter and dpd documentation. --- doc/index.rst | 1 - doc/scripts/common.rst | 19 ------------------- doc/scripts/index.rst | 4 ++-- src/BroDoc.cc | 6 ++++-- .../doc.autogen-reST-example/example.rst | 4 ++-- 5 files changed, 8 insertions(+), 26 deletions(-) delete mode 100644 doc/scripts/common.rst diff --git a/doc/index.rst b/doc/index.rst index ad503af50b..33f47ef151 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -39,7 +39,6 @@ Script Reference .. toctree:: :maxdepth: 1 - scripts/common scripts/builtins scripts/bifs scripts/packages diff --git a/doc/scripts/common.rst b/doc/scripts/common.rst deleted file mode 100644 index 6105585b2c..0000000000 --- a/doc/scripts/common.rst +++ /dev/null @@ -1,19 +0,0 @@ -Common Documentation -==================== - -.. _common_port_analysis_doc: - -Port Analysis -------------- - -TODO: add some stuff here - -.. _common_packet_filter_doc: - -Packet Filter -------------- - -TODO: add some stuff here - -.. note:: Filters are only relevant when dynamic protocol detection (DPD) - is explicitly turned off (Bro release 1.6 enabled DPD by default). diff --git a/doc/scripts/index.rst b/doc/scripts/index.rst index 5de203afe7..bf0fa25f10 100644 --- a/doc/scripts/index.rst +++ b/doc/scripts/index.rst @@ -1,7 +1,7 @@ .. This is a stub doc to which broxygen appends during the build process -Index of All Bro Scripts -======================== +Index of All Individual Bro Scripts +=================================== .. toctree:: :maxdepth: 1 diff --git a/src/BroDoc.cc b/src/BroDoc.cc index b84b9d023d..91aed5ec62 100644 --- a/src/BroDoc.cc +++ b/src/BroDoc.cc @@ -215,14 +215,16 @@ void BroDoc::WriteDocFile() const if ( ! port_analysis.empty() ) { WriteSectionHeading("Port Analysis", '-'); - WriteToDoc(":ref:`More Information `\n\n"); + WriteToDoc("Loading this script makes the following changes to " + ":bro:see:`dpd_config`.\n\n"); WriteStringList("%s", port_analysis); } if ( ! packet_filter.empty() ) { WriteSectionHeading("Packet Filter", '-'); - WriteToDoc(":ref:`More Information `\n\n"); + WriteToDoc("Loading this script makes the following changes to " + ":bro:see:`capture_filters`.\n\n"); WriteToDoc("Filters added::\n\n"); WriteToDoc("%s\n", packet_filter.c_str()); } diff --git a/testing/btest/Baseline/doc.autogen-reST-example/example.rst b/testing/btest/Baseline/doc.autogen-reST-example/example.rst index 880fa0e171..7c61277187 100644 --- a/testing/btest/Baseline/doc.autogen-reST-example/example.rst +++ b/testing/btest/Baseline/doc.autogen-reST-example/example.rst @@ -281,7 +281,7 @@ Redefinitions Port Analysis ------------- -:ref:`More Information ` +Loading this script makes the following changes to :bro:see:`dpd_config`. SSL:: @@ -292,7 +292,7 @@ SSL:: Packet Filter ------------- -:ref:`More Information ` +Loading this script makes the following changes to :bro:see:`capture_filters`. Filters added:: From 70004cb04d865fcc48aea11c05c01fe66a2b4f0d Mon Sep 17 00:00:00 2001 From: Seth Hall Date: Wed, 30 Nov 2011 11:35:53 -0500 Subject: [PATCH 02/14] Small updates to address the "globals" ticket. Fixes #633 --- scripts/base/protocols/dns/main.bro | 6 +++--- scripts/base/protocols/irc/main.bro | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/scripts/base/protocols/dns/main.bro b/scripts/base/protocols/dns/main.bro index 2580b003dd..c8c56bdc00 100644 --- a/scripts/base/protocols/dns/main.bro +++ b/scripts/base/protocols/dns/main.bro @@ -65,11 +65,11 @@ redef capture_filters += { ["netbios-ns"] = "udp port 137", }; -global dns_ports = { 53/udp, 53/tcp, 137/udp, 5353/udp, 5355/udp } &redef; +const dns_ports = { 53/udp, 53/tcp, 137/udp, 5353/udp, 5355/udp }; redef dpd_config += { [ANALYZER_DNS] = [$ports = dns_ports] }; -global dns_udp_ports = { 53/udp, 137/udp, 5353/udp, 5355/udp } &redef; -global dns_tcp_ports = { 53/tcp } &redef; +const dns_udp_ports = { 53/udp, 137/udp, 5353/udp, 5355/udp }; +const dns_tcp_ports = { 53/tcp }; redef dpd_config += { [ANALYZER_DNS_UDP_BINPAC] = [$ports = dns_udp_ports] }; redef dpd_config += { [ANALYZER_DNS_TCP_BINPAC] = [$ports = dns_tcp_ports] }; diff --git a/scripts/base/protocols/irc/main.bro b/scripts/base/protocols/irc/main.bro index 731a943819..e74eea21f1 100644 --- a/scripts/base/protocols/irc/main.bro +++ b/scripts/base/protocols/irc/main.bro @@ -41,7 +41,7 @@ redef capture_filters += { ["irc-6668"] = "port 6668" }; redef capture_filters += { ["irc-6669"] = "port 6669" }; # DPD configuration. -global irc_ports = { 6666/tcp, 6667/tcp, 6668/tcp, 6669/tcp } &redef; +const irc_ports = { 6666/tcp, 6667/tcp, 6668/tcp, 6669/tcp }; redef dpd_config += { [ANALYZER_IRC] = [$ports = irc_ports] }; redef likely_server_ports += { 6666/tcp, 6667/tcp, 6668/tcp, 6669/tcp }; From 4444c56a9494fc3e38c1d39ae7d0d0fc812b5b8f Mon Sep 17 00:00:00 2001 From: Jon Siwek Date: Wed, 30 Nov 2011 13:31:54 -0600 Subject: [PATCH 03/14] Fix double-free of DNS_Mgr_Request object (addresses #661) In DNS::Resolve, they could be deleted once from where they were stored in the nb_dns_info cookie and once again from where they were stored in the DNS_Mgr::requests list. Before commit bd9c9372368f547d0930932de0995f50762b501c, they were only deleted from the requests list, so this commit reverts to that behavior without any leaks being reported by the core/leaks tests. --- src/DNS_Mgr.cc | 2 -- testing/btest/core/leaks/dns.bro | 4 ++++ 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/src/DNS_Mgr.cc b/src/DNS_Mgr.cc index 736c262222..2b9d07a969 100644 --- a/src/DNS_Mgr.cc +++ b/src/DNS_Mgr.cc @@ -595,8 +595,6 @@ void DNS_Mgr::Resolve() } else --num_pending; - - delete dr; } } diff --git a/testing/btest/core/leaks/dns.bro b/testing/btest/core/leaks/dns.bro index 1dce9c2c82..3d3fdc6f09 100644 --- a/testing/btest/core/leaks/dns.bro +++ b/testing/btest/core/leaks/dns.bro @@ -4,6 +4,10 @@ # # @TEST-EXEC: HEAP_CHECK_DUMP_DIRECTORY=. HEAPCHECK=local bro -m -r $TRACES/wikipedia.trace %INPUT +const foo: set[addr] = { + google.com +}; + # Add the state tracking information variable to the connection record event connection_established(c: connection) From 8d7ca1360f48b0f6a36aedbd121a263ff1f00c8f Mon Sep 17 00:00:00 2001 From: Jon Siwek Date: Wed, 30 Nov 2011 13:56:30 -0600 Subject: [PATCH 04/14] Fix error emitted when loading local.bro in bare mode Regarding the redef of SMTP::entity_excerpt_len without having been previously defined. --- scripts/site/local.bro | 1 + 1 file changed, 1 insertion(+) diff --git a/scripts/site/local.bro b/scripts/site/local.bro index 597b92ba3d..7546a52b4b 100644 --- a/scripts/site/local.bro +++ b/scripts/site/local.bro @@ -66,6 +66,7 @@ redef signature_files += "frameworks/signatures/detect-windows-shells.sig"; # Uncomment this redef if you want to extract SMTP MIME entities for # some file types. The numbers given indicate how many bytes to extract for # the various mime types. +@load base/protocols/smtp/entities-excerpt redef SMTP::entity_excerpt_len += { # ["text/plain"] = 1024, # ["text/html"] = 1024, From eb3af25e573199706ec009a5a93253caeb3477dd Mon Sep 17 00:00:00 2001 From: Robin Sommer Date: Wed, 30 Nov 2011 20:16:09 -0800 Subject: [PATCH 05/14] Fine-tuning the Sphinx layout to better match www. Still needs some more tweaking, but it's getting there. --- doc/_static/broxygen-extra.css | 12 +++++ doc/_static/logo-bro.png | Bin 0 -> 10869 bytes doc/_templates/layout.html | 81 ++++++++++++++++++++++++++++++--- doc/conf.py.in | 30 ++---------- doc/index.rst | 4 +- 5 files changed, 92 insertions(+), 35 deletions(-) create mode 100644 doc/_static/logo-bro.png diff --git a/doc/_static/broxygen-extra.css b/doc/_static/broxygen-extra.css index dd56416783..d873e286bc 100644 --- a/doc/_static/broxygen-extra.css +++ b/doc/_static/broxygen-extra.css @@ -1,3 +1,15 @@ .highlight { background-color: #ffffff; } + +h1 { + font-weight: bold; + font-size: 32px; + line-height:32px; + text-align: center; + padding-top: 3px; + margin-bottom: 30px; + font-family: Palatino,'Palatino Linotype',Georgia,serif;; + color: #000; + border-bottom: 0px; +} diff --git a/doc/_static/logo-bro.png b/doc/_static/logo-bro.png new file mode 100644 index 0000000000000000000000000000000000000000..96cc5d443c9efbe03b0905fcd965e37e8c9bf021 GIT binary patch literal 10869 zcmV-*DvH&KP)KLZ*U+IBfRsybQWXdwQbLP>6pAqfylh#{fb6;Z(vMMVS~$e@S=j*ftg6;Uhf59&ghTmgWD0l;*T zI709Y^p6lP1rIRMx#05C~cW=H_Aw*bJ-5DT&Z2n+x)QHX^p z00esgV8|mQcmRZ%02D^@S3L16t`O%c004NIvOKvYIYoh62rY33S640`D9%Y2D-rV&neh&#Q1i z007~1e$oCcFS8neI|hJl{-P!B1ZZ9hpmq0)X0i`JwE&>$+E?>%_LC6RbVIkUx0b+_+BaR3cnT7Zv!AJxW zizFb)h!jyGOOZ85F;a?DAXP{m@;!0_IfqH8(HlgRxt7s3}k3K`kFu>>-2Q$QMFfPW!La{h336o>X zu_CMttHv6zR;&ZNiS=X8v3CR#fknUxHUxJ0uoBa_M6WNWeqIg~6QE69c9o#eyhGvpiOA@W-aonk<7r1(?fC{oI5N*U!4 zfg=2N-7=cNnjjOr{yriy6mMFgG#l znCF=fnQv8CDz++o6_Lscl}eQ+l^ZHARH>?_s@|##Rr6KLRFA1%Q+=*RRWnoLsR`7U zt5vFIcfW3@?wFpwUVxrVZ>QdQz32KIeJ}k~{cZZE^+ya? z2D1z#2HOnI7(B%_ac?{wFUQ;QQA1tBKtrWrm0_3Rgps+?Jfqb{jYbcQX~taRB;#$y zZN{S}1|}gUOHJxc?wV3fxuz+mJ4`!F$IZ;mqRrNsHJd##*D~ju=bP7?-?v~|cv>vB zsJ6IeNwVZxrdjT`yl#bBIa#GxRa#xMMy;K#CDyyGyQdMSxlWT#tDe?p!?5wT$+oGt z8L;Kp2HUQ-ZMJ=3XJQv;x5ci*?vuTfeY$;({XGW_huIFR9a(?@3)XSs8O^N5RyOM=TTmp(3=8^+zpz2r)C z^>JO{deZfso3oq3?Wo(Y?l$ge?uXo;%ru`Vo>?<<(8I_>;8Eq#KMS9gFl*neeosSB zfoHYnBQIkwkyowPu(zdms`p{<7e4kra-ZWq<2*OsGTvEV%s0Td$hXT+!*8Bnh2KMe zBmZRodjHV?r+_5^X9J0WL4jKW`}lf%A-|44I@@LTvf1rHjG(ze6+w@Jt%Bvjts!X0 z?2xS?_ve_-kiKB_KiJlZ$9G`c^=E@oNG)mWWaNo-3TIW8)$Hg0Ub-~8?KhvJ>$ z3*&nim@mj(aCxE5!t{lw7O5^0EIO7zOo&c6l<+|iDySBWCGrz@C5{St!X3hAA}`T4 z(TLbXTq+(;@<=L8dXnssyft|w#WSTW<++3>sgS%(4NTpeI-VAqb|7ssJvzNHgOZVu zaYCvgO_R1~>SyL=cFU|~g|hy|Zi}}s9+d~lYqOB71z9Z$wnC=pR9Yz4DhIM>Wmjgu z&56o6maCpC&F##y%G;1PobR9i?GnNg;gYtchD%p19a!eQtZF&3JaKv33gZ<8D~47E ztUS1iwkmDaPpj=$m#%)jCVEY4fnLGNg2A-`YwHVD3gv};>)hAvT~AmqS>Lr``i7kw zJ{5_It`yrBmlc25DBO7E8;5VoznR>Ww5hAaxn$2~(q`%A-YuS64wkBy=9dm`4cXeX z4c}I@?e+FW+b@^RDBHV(wnMq2zdX3SWv9u`%{xC-q*U}&`cyXV(%rRT*Z6MH?i+i& z_B8C(+grT%{XWUQ+f@NoP1R=AW&26{v-dx)iK^-Nmiuj8txj!m?Z*Ss1N{dh4z}01 z)YTo*JycSU)+_5r4#yw9{+;i4Ee$peRgIj+;v;ZGdF1K$3E%e~4LaI(jC-u%2h$&R z9cLXcYC@Xwnns&bn)_Q~Te?roKGD|d-g^8;+aC{{G(1^(O7m37Y1-+6)01cN&y1aw zoqc{T`P^XJqPBbIW6s}d4{z_f5Om?vMgNQEJG?v2T=KYd^0M3I6IZxbny)%vZR&LD zJpPl@Psh8QyPB@KTx+@RdcC!KX7}kEo;S|j^u2lU7XQ}Oo;f|;z4Ll+_r>@1-xl3| zawq-H%e&ckC+@AhPrP6BKT#_XdT7&;F71j}Joy zkC~6lh7E@6o;W@^IpRNZ{ptLtL(gQ-CY~4mqW;US7Zxvm_|@yz&e53Bp_lTPlfP|z zrTyx_>lv@x#=^!PzR7qqF<$gm`|ZJZ+;<)Cqu&ot2z=0000WV@Og>004R=004l4008;_004mL004C`008P>0026e000+nl3&F} z001ALNklx~{rjf4;n0}>dF0oyVd5_@nWoJlZYJjly9 z8BDU4*Pht%Zeqo=IQFjhjC>M1nKPM0$@r0E*T=#hCyt-;12BpN!e9vyk4Epe8g=W@ z>h7xjqpIjq(~>2Sgs}BH=brAauIH_9{qFboy}x@4W^JNo2a16TpcKf{{O1IukW#MM zu2i$!1(ayEEd>h09BbBQZNdO80UTkLJC#xb)F>cS*OP!Upg>d9|H_ng3l+eZDC?_$ ztq1`#%I^y0dyxY0Vr9Rxz@D{>AkhM~LIWDD6)1qSYryPMfQ16)k}%sjld*kzK0)s49E0;Z6o6{Iw)#Lh0Go0yPUZLen(Hl|^~~2cEs#RIk(N)EYP_a2 z&Ks?Qv|IzKicx5T>UkYu&Z|^ID+Q_~EGa@BCbkjf*~AS`bb+TaY?j~1AtfmijaWnnyNv4)Nmh1su`b`)y@MJ=$^ zWux(B#^BYCS?F9nz-n)nQ@NoI4Un~-t5_*D8f8EWlp30}H%hZyt^rSt zrs*vSbK|tl_E-SU3yJv4G{-Gc_FXtiVCc|1K#njTuvFQnq#UC#Oe>+iwo=UlRWuHo zqNNw5n&5NRrb#IXy+JByoMWg1c^d9VNYGQG@q8sAUcG#V+}xrt-myZXdW7=y(E?7p z<^gtv@yuux7w0UcnEartSmUWw?@~C16s3C9!Z5s7%PUK{w1;b^w>(9oTzfbgp`{zH z&k5X|qXdw%HcoRWfVFFY<_hsLY6a(wQrULR`t}eG9L}46QA`@etJ=r-FO*t@tIq;v zd-gsz2rB`;qky$EgaVXmBK``EC$3Puian&+uL)@m^S&f?Xdi`sNS_113W73RL6~iw zvk)DfYq^vPD$rC|fySe#OeKHE`LBdoopQ1)PZLWNaH)>12D=4efrZ5y76Of>C&xYZN{_%ekhn zMb!2{YUxDzD6L&l$nq~-tWg%mdxr8b2cye5rOaxN(+ObJRO-MO_oi3_UVF$k*L;&i z81@rW=D7hedx3gm|XwFYdlJ|h7OU1Fa!(&1Detg zcmTKZeL(Xm%>Xc~9JnBaGW-VEs@%u-fujV~A#LmGyq3VLK9zRG0~cs6t~liBbZ9Ov zk4tkACew^S5-?XO4&^fqm;=OV0ILFYI!sc)J*)uMtrQo~33LE$K(kWXl+vv{Ak*QA zD>Mp_L*s;s2qwgW#0)4+cMbqXk? zYrKd+FHj5oNr?;oQ2|XlQ!`q|PB77_Lc?uK2o9kt;nIBRJPkj#&qVN+hR9m>Fc;>~ zCYW=BAk<;AQ*ugfd3A>3v_)+!8)FD4tN>(FTlJ>c3RrjR0VG-!H%aq zf;xU7W2a?aH7nLM6RQ5FdSgk`Y!qK1VAlix8#q1-%F8Mq;LpH)K*}U}UoCi@A?id; z2sJEXhHCer95!!~B$P$K6ITLQgTWw0MMX)mv9VHOVxp9soGhiJq(~_#Dbk!dbEKrC zBq=^VUb5TmlHG2XA|oTe3_$Ky6oVTl>He35-0Kp;4{oi{tT!RrcqM9s+6=fx3A7vp zy9`T4Q4}WPWp4*|0bfy~|Iu|WgMo~U403XEm_L6$^XAPXEiH}2#6)6aW3gJTSS%LI zW-~^k5xriIPAA7Tk|ZIDB7VOgolZwxT^&1j?&QpwGb0a@y&9}G=xK%i9vJk1B!O=T z0{$7IYF)Pd3HTQ!UYHDt6y&J_eiDL(V&ymw63nS67%x7AD>$(-C5i|5fZ)JJ!kk?G zWhx0#z}>+27^Az`CB;K17~ZXs}Z83K&Jy&H$+51ze`rG;^V;QhPE@%)&p+uwFKh-Q~+0Xh4D{~ zru7X~n94LXvS=a{;&Q;N>a-6M?5-`S?`=a-p3~Op?V&le*oH}(XxG+5z^WS}+ghlDt2Smi)0eTL+MNdm3zKliC z-6B`1*$hStWG{lX8$d6C>kNGQDOh5m_5_^y6#6>hLN^Td&ty+M3_P!Z*mVW6TB!!a zb`6~fbxL`RoD*(R!K-rF;*b+mm4u>Ep1$$gR^WdCD@O1JqmfmsR&o37x3g)}CYCQ> ze#M@3H1l{oY}~k!%F4oyp4H{f5szVB9^d@tHz_PE zWbxv~({h*YyYD`J^{Zb6fxB!OH~muy58ZqtD`KP3=> zp7>Xab7{XqF0AeP*LvDwf_d9&iyf9q=r7~oTao+p-wfknzpFeg6EPj|Fz_G1QUI&f z%J%KsDJ?B!@7}%Ka?33wCMHhHohdIb=aEMq2`)&@<+|NZ@#76QusYF(R|J1RBH$e+ zFzmxG3J3@+Oid@w5YLfX7Z-#qaI67qE}Zj2WfSPrz~+EsXP^)0mY`Pxl0cXXoqBM# zgCP<8DIl7lqY)&z$2U7Wo87y2)8F4uTU*=J1n&x98*;DS<-{><$ax)FKt83=g*@Pd zvdpQh`;=0`0%trNw_HQ2%LzZkCJ#72!3)V&bjJS$L?EKCDw0HXT9)(258NH@ZQC`cQIh<30IL#71`O%Oi>UtJ4E-NoQ> zoA#2R|CLv6zC^p{-><2c-#KiFEqmNQkQ^V6wKTURa_Em8yzx?GdM@nM1Y$xTq zd~Qs!g5QsX1bV&f4JG9}66kdJB>{`c#Jc?Ju+7f^!3#}w;5-4gXqb}#q5&*67!1gP zn>`K8v7nEFAs@sff=__X7->2#}A9^M;b@BBd0BA=eke=(%IrW5{_2!j2s~ z`0?J^8~O)962Pd3=on~efX0&$6$7me zFzkigwK7j`I|;|$1OG4pzyJO3*|u%lCFd`SA_oo};N_QJ=JnTK4_?Rg*~`HHQLr-6 z?6%QF0H>yQz|{l)3hd3w$`W3E^;KSY z;f1RXT!4N1_Km#ZTQ-B;4>k$GAc0Yki!=;^2xdJPL`)HSq9Y7Mn{`+X5=s7kVq5B= zrxSc$2n@r8PB`*0lZp_|84|+`}iId_rMi;fx8PUwrY! z;16p83}nFR3v@XL>FgRnCknDZ5e2#U1q_mbD7^(kKt%BSK@_pY#j_-T#ps%Ia})gY z^YE7r7+L{``sJXGdC(RC=1fRk2DSCj-3ML?=H-Jy=C=Fy@29S=Zp>@3*=%gzzMa=z zdyS(+n9o48%f>$5olY13=+uSEIV{oyv}X zqevU2$_{=@_!o|hW(ME|lgae0pa1;l{O)(Zn>O`eJl5LU%KrWPHSzQU$Q2>Ak2Zso zPuxyGLh$?Ky4C9e5rbZb9uY|t5d;Ch-%n>}2lM7-jqUMV zKV&b2K^OG2fliV^n~*Ys`@Z?+o8!K=tgI{^c;EpJ9y~}@RTYmv{y2Ggc~f1b76mgC zxyj`Up5`f~fZ)uTFmeRWPk>Tgh+3d>4>kI`SD^~~7&#oLNW)3S6${yHwr`b}m$PTj zo*5@xR#sNxcDsWMVp6~x0H2;5bz@i0(!lk*49>< zo12l45QNW>(1-fr)n_5X2r+Y@s};Q8Dc3lW?T?EJKqXF>O zx%|A#y>W4IyWV)?4Q{{v_L(TUkLXFmXa;{goRPp8fOCG1pC0C!SKgtjxf7Ggghg+_ zXflB$VbJR_7!0(uv~c1?9sL6X)YjJG@pwM}!0k=Y;ep{u7?vPsHFWksb1U=@fzB)| z5q)m(i5KJRW5FO*Q?X%ShHpgPd)V%M~)n!s;Y{;d-rnVjW=R8nDu? zpK4h~aCZAL4S;Ku&oV&+Ts5l8L(TwtmS6_F8o+I3?76N&?MHEOaZkMV+H0&^w~m== zTeohdyj;1gFB`c_tV$srl+Ty zs_JUqc;gMayT;i&w(1sGe;dTuVChPD_Z>KU0)_@5CKe(iq2V-m+;Hj$cn2|?%^W{| zocZ(TPkLR{*Vpsmhad9Zd+$+MS;^V6XAwp5QVq-D;J*9rBQrCThaP%}_V!Ub+#cle z@^u{=XR7tesy8k(5S(DSNTVvK8>_sdh~Vgm@!A7XQBhC4^2#eS8n_@Q;RIbt9Gps& zbzB`XfZCh!C(q~8;}M*Cw}!;*`NYO`ApY_(`kEUN^m?MBV;CG7q@}reVqWo79pr3) z>#m3TPH5``p9#z{5S0R+F7Sw8oeQRu;2p&4_0rbXHYMQA$;lxnCx>0TcH#AUId$q3 z)z#G;K75$^`g*#$x>&n*EqC92H?gs?2!g=Re)coI``z!-+uIv%mv<|UaH5$<&M+Mr znFQxY!=M0nC&A(8j}z>7F4Ay~;t3pho5^JQmp}gTj}#OX%xK_xy5b1|_6Ieaa zbsAE2VAI2iAdl|p>6!AnF`LaSUAmN|OP5kq6l9H!jg7Rox8w16kR*wvOPBJ@GtaPR z&mM+`hC+9frvzYUC!rJLx0=8WodV1Uk$cd7!^nh*JSN!XD+t0`;MdPT|GaR=9d|I( z&F}Z)^=fi#4FbeizkOQl(4#;*uf)!$;z%U72*Oo}gUjiN%_y)ja0(%0) z&w&eFa=K(p91Ql2a9&r!d9Tz`Q&X{8tpoxA1VO;#@vwgV`jK7hnr8r5b%lpi#eoqH zRAt+x3TRdLtSSl*OvK~rbh^2cB>iFc?%k2QcJ1O?FhLMT1|5DKbb94B=u8JhWI%Kl zH1&gjE?Ad>KMf-1LF6QK0L0IMRslY!g0n8@HNj9abVR^O7Z~P&CjmN)5YUY`P?}QH z>-Ef^KcA?msEd5q?RK+$`*t>N+!$_?6<2sjRRME_1Fu$D*h%nBGxts;Kodpr7uR2Z zefo3HJ;$|TCX>W#f@M*Ec=gmCs_r%u@g)lu-Rmt`E(7K^pKea5gtg-t`5~odl;vX<;DAo2TPupdtI7V>X*Fg4gHsk(rqp z+Sy^g96WtqnF`k5tkdcKR;SbbV|8_P*KN1mMsaa5ot>RC7Q8pya6|BiB!NxO|Dz1C1sXS!&^WZA#!bh=fd zD8BUUv(K_>)hd4d>tD}E@UB>~g4ER1;DYWZh;~E&yO7-rtNLK|1;}cI^d`tPL;MA> zG=gqFY|4Zu{u?aF8uKQfsQrxY{(j7f$>|P zAKSHS7X<|cy!-CEGYY)X(a|FT(cKOQ4}fzRbZekJ7mh_ky%l;g!0DG|tkVNf<%Y&+ z@Ggd3&%o{{VOaqrJ0L0!Ojdcs#KLtPNx6}-6a6%JbPNypX>IS}KR&AE;JE=Lj|7LS z0INKX?R+Y&*AtzJrWat}^`EbLh;5-Idi$JtOKp-l^Moz4SIe{TMPoLnF zXBc#rJs_wCy^a&(718FrL_yH}Q}V&Y|w>KlSHHS+i5YgwufXlS6XuWzcVvc^0mpt z*-QYhYReT*{4Kp+Z~EHTzQ*^y_dPaj*f8zjl_ZJHn>X{$JDU0BvX;Tke*+N_@?2!1 z7y5g_c?vS;gVhdc8ITIJH9$awwr=R`1f3{rw*x+~8X!9xJbiGY9&~z`HxGnl`0zDI zvcsxX(9odJg)Vq&Ke+lX^2y4|N|rBQKCWx&?Chkju8zZp4^vrL$&n*Ra5|mg5@#mU z{K(_j_94$aUxhreH(ylnUX)u!QM?~{AYaV7b?ex*YZrIjbr&|9ZQ1}_TU*QO)vM|6 z@7J7J0pxE2uUqD{^+!N3Li&6;-*#Ruv^7J(3j;mS-X;fFkybDmpx-Sg+gOuikK5J& zwm3-7fmSD+tAmWi5T7J_`QZWh^gU<_Ho-so(T{lIi6_FI^YHL6_4V}}IdX(UhYoT0 z@L^7#JV|$V_jFWQ2k=+mZRCl)kB{aUzR2KJEnAYL`y@%a2S{}|9BkXRjqTgFkK5~9 zsr}*?zu^A+?;p7^uK;dZE6=HL{sd&?fHevdQo&$`o^}{EKvO&Pw}Cwh3>Fv?AP|5^ z8(1VcJIp@>(WzjHg8EM&F&^g5hmLkIM8KhgaQ@Sahu*Yl6K}osRuC;69n{v=QdLz& zWo0EbH8q?)dzL_8O5dk40Q3MYKs|D@Of~T7c%-l|3wYIFB0=%O_X7Dwqmi3$zL|UO zxraOMxMRu(aPHo{d*m>40Vr4wCL8D@AT0$VO-fc+tDFbi+5;^Yhv+#-tNPUKm3Vv~}R*t~f&cinXtx88ay zcDsE_q@o==cJPNk{2@f}i-+YKW#zzRl;>sedH_9ioP(i0h>nM-1ZZ!N!5s+5Nj07x z`L{Jmo?x%xIAkt{%w=%0N}gQA-FArv9S8&%7#Nt!XSEIZ5P34`gNkRJ)QN<@tl-ry zPM0KUt0YO^LY{tJpPru1rcIl;^Ugb2zkdCsdgS5ZVeY;6US4|XrICM_A|ZE`JpZoG z2L>a!x}dKKB7BgMDG%Lg?t^rPoKW7^E04NJ&4B1ws5=Y;Es*7au70SlRAyA4HtPod zf;`{YhfGl~*erNQ3GgIIx>J&*yO6WsgoK0y^7Hdqv}h5F7A<1o!i8jHWRR4UbVd2E zk3IGnKmF-XFa0CZ3aJYqDN~*a-8U%fzzHcb2Ob=PxHl1u*l=Rfn{gAa1@}XZ_1nn?_~^k$w8hgYm+2NH%O9{{&^diOeP{DBe7U4 zL`6kmwOWacjJ%lcr`PL=h=}0y>C+rNdX#I-{)9Y*><3r#Bxb=oaf<<#0XHGf{IeXG zqsc%1B3mW$Nbomj!pY2n_sY$V{Q7{E$RpC00rMnDikZqvo@Q$S_5%Ng`~q%f!TZGk z?g-#(NHBuSDKag71`1?2g`nrGUH&4PFOEE4(U+i41r9msvz3NbC!3pFfn9rEv-mq&0y#Idy)ZVb47VPUM00000 LNkvXXu0mjf*c*iH literal 0 HcmV?d00001 diff --git a/doc/_templates/layout.html b/doc/_templates/layout.html index 8edeeb07b6..cb6181361d 100644 --- a/doc/_templates/layout.html +++ b/doc/_templates/layout.html @@ -9,7 +9,7 @@ {% endblock %} {% block header %} - {% endblock %} @@ -17,15 +17,82 @@ {% block relbar1 %}{% endblock %} {% block content %} -
-
- {{ super() }} -
-
+ +
+
+ +
+ +
+ {{ relbar() }} +
+ +
+ {% block body %} + {% endblock %} +
+
+ + +
+ +
+ +
+
+ + +
+

+ Table of Contents +

+

+

    {{toc}}
+

+
+ + {% if next %} +
+

+ Next Page +

+

+ {{ next.title }} +

+
+ {% endif %} + + {% if prev %} +
+

+ Previous Page +

+

+ {{ prev.title }} +

+
+ {% endif %} + +
+
+ +
+
+
+ + Copyright {{ copyright }}. + Last updated on {{ last_updated }}. + Created using Sphinx {{ sphinx_version }}. + +
+
+
+
+ + {% endblock %} {% block footer %} -{{ super() }} {% endblock %} diff --git a/doc/conf.py.in b/doc/conf.py.in index 8844370a07..8959c0b2c9 100644 --- a/doc/conf.py.in +++ b/doc/conf.py.in @@ -90,44 +90,20 @@ pygments_style = 'sphinx' # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. -html_theme = 'default' +html_theme = 'basic' html_last_updated_fmt = '%B %d, %Y' # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the # documentation. -html_theme_options = { -"rightsidebar": "true", -"stickysidebar": "false", -"externalrefs": "false", -"footerbgcolor": "#333", -"footertextcolor": "#ddd", -"sidebarbgcolor": "#ffffff", -#"sidebarbtncolor": "", -"sidebartextcolor": "#333", -"sidebarlinkcolor": "#2a85a7", -"relbarbgcolor": "#ffffff", -"relbartextcolor": "#333", -"relbarlinkcolor": "#2a85a7", -"bgcolor": "#ffffff", -"textcolor": "#333", -"linkcolor": "#2a85a7", -"visitedlinkcolor": "#2a85a7", -"headbgcolor": "#f0f0f0", -"headtextcolor": "#000", -"headlinkcolor": "#2a85a7", -"codebgcolor": "#FFFAE2", -#"codetextcolor": "", -"bodyfont": "Arial, Helvetica, sans-serif", -"headfont": "Palatino,'Palatino Linotype',Georgia,serif", -} +html_theme_options = { } # Add any paths that contain custom themes here, relative to this directory. #html_theme_path = [] # The name for this set of Sphinx documents. If None, it defaults to -# " v documentation". +# " v Documentation". #html_title = None # A shorter title for the navigation bar. Default is the same as html_title. diff --git a/doc/index.rst b/doc/index.rst index ad503af50b..a5af2a4f8d 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -1,9 +1,11 @@ .. Bro documentation master file +================= Bro Documentation ================= -Documentation for version: |version| +Guides +------ .. toctree:: :maxdepth: 1 From f6494a09c95063f717539a19b44454c1abba3ab5 Mon Sep 17 00:00:00 2001 From: Jon Siwek Date: Thu, 1 Dec 2011 09:16:38 -0600 Subject: [PATCH 06/14] Add missing doc targets to top Makefile; remove old doc/Makefile. (fixes #705) --- Makefile | 12 +++++++++ doc/CMakeLists.txt | 6 ++--- doc/Makefile | 7 ----- doc/README | 5 ++-- doc/bin/rst2html.py | 62 --------------------------------------------- doc/scripts/README | 2 +- 6 files changed, 19 insertions(+), 75 deletions(-) delete mode 100644 doc/Makefile delete mode 100755 doc/bin/rst2html.py diff --git a/Makefile b/Makefile index e0c2860873..83a149ca58 100644 --- a/Makefile +++ b/Makefile @@ -29,6 +29,18 @@ doc: configured docclean: configured $(MAKE) -C $(BUILD) $@ +restdoc: configured + $(MAKE) -C $(BUILD) $@ + +restclean: configured + $(MAKE) -C $(BUILD) $@ + +broxygen: configured + $(MAKE) -C $(BUILD) $@ + +broxygenclean: configured + $(MAKE) -C $(BUILD) $@ + dist: @rm -rf $(VERSION_FULL) $(VERSION_FULL).tgz @rm -rf $(VERSION_MIN) $(VERSION_MIN).tgz diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt index 2f5bd93cdf..bdbb0e7b69 100644 --- a/doc/CMakeLists.txt +++ b/doc/CMakeLists.txt @@ -60,16 +60,16 @@ add_custom_target(broxygen # The "sphinxclean" target removes just the Sphinx input/output directories # from the build directory. -add_custom_target(broxygen-clean +add_custom_target(broxygenclean COMMAND "${CMAKE_COMMAND}" -E remove_directory ${DOC_SOURCE_WORKDIR} COMMAND "${CMAKE_COMMAND}" -E remove_directory ${DOC_OUTPUT_DIR} VERBATIM) -add_dependencies(broxygen broxygen-clean restdoc) +add_dependencies(broxygen broxygenclean restdoc) add_custom_target(doc) add_custom_target(docclean) add_dependencies(doc broxygen) -add_dependencies(docclean broxygen-clean restclean) +add_dependencies(docclean broxygenclean restclean) diff --git a/doc/Makefile b/doc/Makefile deleted file mode 100644 index 2756093a27..0000000000 --- a/doc/Makefile +++ /dev/null @@ -1,7 +0,0 @@ - -all: - test -d html || mkdir html - for i in *.rst; do echo "$$i ..."; ./bin/rst2html.py $$i >html/`echo $$i | sed 's/rst$$/html/g'`; done - -clean: - rm -rf html diff --git a/doc/README b/doc/README index a9f2cdbc4e..57d569db84 100644 --- a/doc/README +++ b/doc/README @@ -15,8 +15,9 @@ which adds some reST directives and roles that aid in generating useful index entries and cross-references. Other extensions can be added in a similar fashion. -Either the ``make doc`` or ``make broxygen`` can be used to locally -render the reST files into HTML. Those targets depend on: +Either the ``make doc`` or ``make broxygen`` targets in the top-level +Makefile can be used to locally render the reST files into HTML. +Those targets depend on: * Python interpreter >= 2.5 * `Sphinx `_ >= 1.0.1 diff --git a/doc/bin/rst2html.py b/doc/bin/rst2html.py deleted file mode 100755 index 79c835d6c4..0000000000 --- a/doc/bin/rst2html.py +++ /dev/null @@ -1,62 +0,0 @@ -#!/usr/bin/env python -# -# Derived from docutils standard rst2html.py. -# -# $Id: rst2html.py 4564 2006-05-21 20:44:42Z wiemann $ -# Author: David Goodger -# Copyright: This module has been placed in the public domain. -# -# -# Extension: we add to dummy directorives "code" and "console" to be -# compatible with Bro's web site setup. - -try: - import locale - locale.setlocale(locale.LC_ALL, '') -except: - pass - -import textwrap - -from docutils.core import publish_cmdline, default_description - -from docutils import nodes -from docutils.parsers.rst import directives, Directive -from docutils.parsers.rst.directives.body import LineBlock - -class Literal(Directive): - #max_line_length = 68 - max_line_length = 0 - - required_arguments = 0 - optional_arguments = 1 - final_argument_whitespace = True - has_content = True - - def wrapped_content(self): - content = [] - - if Literal.max_line_length: - for line in self.content: - content += textwrap.wrap(line, Literal.max_line_length, subsequent_indent=" ") - else: - content = self.content - - return u'\n'.join(content) - - def run(self): - self.assert_has_content() - content = self.wrapped_content() - literal = nodes.literal_block(content, content) - return [literal] - -directives.register_directive('code', Literal) -directives.register_directive('console', Literal) - -description = ('Generates (X)HTML documents from standalone reStructuredText ' - 'sources. ' + default_description) - -publish_cmdline(writer_name='html', description=description) - - - diff --git a/doc/scripts/README b/doc/scripts/README index b3e44914f4..a15812609c 100644 --- a/doc/scripts/README +++ b/doc/scripts/README @@ -1,6 +1,6 @@ This directory contains scripts and templates that can be used to automate the generation of Bro script documentation. Several build targets are defined -by CMake: +by CMake and available in the top-level Makefile: ``restdoc`` From 14c1d2ae1fcb1b8e9692a0b79816d95e0bcb5325 Mon Sep 17 00:00:00 2001 From: Jon Siwek Date: Thu, 1 Dec 2011 09:31:38 -0600 Subject: [PATCH 07/14] Remove example redef of SMTP::entity_excerpt_len from local.bro. --- scripts/site/local.bro | 9 --------- 1 file changed, 9 deletions(-) diff --git a/scripts/site/local.bro b/scripts/site/local.bro index 7546a52b4b..8e1f4d802b 100644 --- a/scripts/site/local.bro +++ b/scripts/site/local.bro @@ -62,12 +62,3 @@ redef signature_files += "frameworks/signatures/detect-windows-shells.sig"; @load protocols/http/detect-MHR # Detect SQL injection attacks @load protocols/http/detect-sqli - -# Uncomment this redef if you want to extract SMTP MIME entities for -# some file types. The numbers given indicate how many bytes to extract for -# the various mime types. -@load base/protocols/smtp/entities-excerpt -redef SMTP::entity_excerpt_len += { -# ["text/plain"] = 1024, -# ["text/html"] = 1024, -}; From 0c8b5a712d1d3117e19b8fb13dbd505938dba75d Mon Sep 17 00:00:00 2001 From: Jon Siwek Date: Thu, 1 Dec 2011 14:07:08 -0600 Subject: [PATCH 08/14] Add a remote_log_peer event which contains an event_peer record param. Addresses #493. --- .../base/frameworks/communication/main.bro | 7 ++++ src/RemoteSerializer.cc | 30 ++++++++++----- src/event.bif | 23 ++++++++++++ .../send.log | 17 +++++++++ .../communication_log_baseline.bro | 37 +++++++++++++++++++ 5 files changed, 104 insertions(+), 10 deletions(-) create mode 100644 testing/btest/Baseline/scripts.base.frameworks.communication.communication_log_baseline/send.log create mode 100644 testing/btest/scripts/base/frameworks/communication/communication_log_baseline.bro diff --git a/scripts/base/frameworks/communication/main.bro b/scripts/base/frameworks/communication/main.bro index 569ba140a9..01c608c8db 100644 --- a/scripts/base/frameworks/communication/main.bro +++ b/scripts/base/frameworks/communication/main.bro @@ -130,6 +130,13 @@ event remote_log(level: count, src: count, msg: string) do_script_log_common(level, src, msg); } +# This is a core generated event. +event remote_log_peer(p: event_peer, level: count, src: count, msg: string) + { + local rmsg = fmt("[#%d/%s:%d] %s", p$id, p$host, p$p, msg); + do_script_log_common(level, src, rmsg); + } + function do_script_log(p: event_peer, msg: string) { do_script_log_common(REMOTE_LOG_INFO, REMOTE_SRC_SCRIPT, msg); diff --git a/src/RemoteSerializer.cc b/src/RemoteSerializer.cc index a21a7abc60..3a24b8792a 100644 --- a/src/RemoteSerializer.cc +++ b/src/RemoteSerializer.cc @@ -2923,24 +2923,34 @@ void RemoteSerializer::Log(LogLevel level, const char* msg) void RemoteSerializer::Log(LogLevel level, const char* msg, Peer* peer, LogSrc src) { + if ( peer ) + { + val_list* vl = new val_list(); + vl->append(peer->val->Ref()); + vl->append(new Val(level, TYPE_COUNT)); + vl->append(new Val(src, TYPE_COUNT)); + vl->append(new StringVal(msg)); + mgr.QueueEvent(remote_log_peer, vl); + } + else + { + val_list* vl = new val_list(); + vl->append(new Val(level, TYPE_COUNT)); + vl->append(new Val(src, TYPE_COUNT)); + vl->append(new StringVal(msg)); + mgr.QueueEvent(remote_log, vl); + } + const int BUFSIZE = 1024; char buffer[BUFSIZE]; - int len = 0; if ( peer ) - len += snprintf(buffer + len, sizeof(buffer) - len, - "[#%d/%s:%d] ", int(peer->id), ip2a(peer->ip), - peer->port); + len += snprintf(buffer + len, sizeof(buffer) - len, "[#%d/%s:%d] ", + int(peer->id), ip2a(peer->ip), peer->port); len += safe_snprintf(buffer + len, sizeof(buffer) - len, "%s", msg); - val_list* vl = new val_list(); - vl->append(new Val(level, TYPE_COUNT)); - vl->append(new Val(src, TYPE_COUNT)); - vl->append(new StringVal(buffer)); - mgr.QueueEvent(remote_log, vl); - DEBUG_COMM(fmt("parent: %.6f %s", current_time(), buffer)); } diff --git a/src/event.bif b/src/event.bif index d953ac78fe..0c2f7eb780 100644 --- a/src/event.bif +++ b/src/event.bif @@ -444,6 +444,29 @@ event remote_state_inconsistency%(operation: string, id: string, # Generated for communication log message. event remote_log%(level: count, src: count, msg: string%); +## Generated for communication log messages. While this event is +## intended primarily for use by Bro's communication framework, it can also trigger +## additional code if helpful. This event is equivalent to +## :bro:see:`remote_log` except the message is with respect to a certain peer. +## +## p: A record describing the remote peer. +## +## level: The log level, which is either :bro:enum:`REMOTE_LOG_INFO` or +## :bro:enum:`REMOTE_LOG_ERROR`. +## +## src: The component of the comminication system that logged the message. +## Currently, this will be one of :bro:enum:`REMOTE_SRC_CHILD` (Bro's +## child process), :bro:enum:`REMOTE_SRC_PARENT` (Bro's main process), or +## :bro:enum:`REMOTE_SRC_SCRIPT` (the script level). +## +## msg: The message logged. +## +## .. bro:see:: remote_capture_filter remote_connection_closed remote_connection_error +## remote_connection_established remote_connection_handshake_done +## remote_event_registered remote_pong remote_state_access_performed +## remote_state_inconsistency print_hook remote_log +event remote_log_peer%(p: event_peer, level: count, src: count, msg: string%); + # Generated when a remote peer has answered to our ping. event remote_pong%(p: event_peer, seq: count, d1: interval, d2: interval, d3: interval%); diff --git a/testing/btest/Baseline/scripts.base.frameworks.communication.communication_log_baseline/send.log b/testing/btest/Baseline/scripts.base.frameworks.communication.communication_log_baseline/send.log new file mode 100644 index 0000000000..9cf441d61a --- /dev/null +++ b/testing/btest/Baseline/scripts.base.frameworks.communication.communication_log_baseline/send.log @@ -0,0 +1,17 @@ +#separator \x09 +#path communication +#fields ts peer src_name connected_peer_desc connected_peer_addr connected_peer_port level message +#types time string string string addr port string string +1322759704.176437 bro parent - - - info raised pipe's socket buffer size from 8K to 1024K +1322759704.176437 bro parent - - - info [#1/127.0.0.1:47757] added peer +1322759704.183341 bro child - - - info [#1/127.0.0.1:47757] connected +1322759704.183738 bro parent - - - info [#1/127.0.0.1:47757] peer connected +1322759704.183738 bro parent - - - info [#1/127.0.0.1:47757] phase: version +1322759704.184034 bro script - - - info connection established +1322759704.184034 bro script - - - info requesting events matching /^?(NOTHING)$?/ +1322759704.184034 bro script - - - info accepting state +1322759704.185120 bro parent - - - info [#1/127.0.0.1:47757] phase: handshake +1322759704.185120 bro parent - - - info warning: no events to request +1322759704.185120 bro parent - - - info terminating... +1322759704.185120 bro parent - - - info [#1/127.0.0.1:47757] peer_description is bro +1322759704.185120 bro parent - - - info [#1/127.0.0.1:47757] closing connection diff --git a/testing/btest/scripts/base/frameworks/communication/communication_log_baseline.bro b/testing/btest/scripts/base/frameworks/communication/communication_log_baseline.bro new file mode 100644 index 0000000000..74ff297010 --- /dev/null +++ b/testing/btest/scripts/base/frameworks/communication/communication_log_baseline.bro @@ -0,0 +1,37 @@ +# +# @TEST-EXEC: btest-bg-run receiver bro -b ../receiver.bro +# @TEST-EXEC: btest-bg-run sender bro -b ../sender.bro +# @TEST-EXEC: btest-bg-wait -k 2 +# +# Don't diff the receiver log just because port is always going to change +# @TEST-EXEC: grep -v pid sender/communication.log >send.log +# @TEST-EXEC: btest-diff send.log + +@TEST-START-FILE sender.bro + +@load base/frameworks/communication/main + +redef Communication::nodes += { + ["foo"] = [$host = 127.0.0.1, $events = /NOTHING/, $connect=T] +}; + +event remote_connection_established(p: event_peer) + { + terminate_communication(); + terminate(); + } + +@TEST-END-FILE + +############# + +@TEST-START-FILE receiver.bro + +@load frameworks/communication/listen + +event remote_connection_closed(p: event_peer) + { + terminate(); + } + +@TEST-END-FILE From edc0a451f8d72c2f14990498ba105047aecca0a5 Mon Sep 17 00:00:00 2001 From: Jon Siwek Date: Thu, 1 Dec 2011 16:18:56 -0600 Subject: [PATCH 09/14] Teach LogWriterAscii to use BRO_LOG_SUFFIX env. var. (addresses #704) --- src/LogWriterAscii.cc | 11 ++++++++--- src/LogWriterAscii.h | 1 + src/main.cc | 2 ++ .../scripts/base/frameworks/logging/env-ext.test | 2 ++ 4 files changed, 13 insertions(+), 3 deletions(-) create mode 100644 testing/btest/scripts/base/frameworks/logging/env-ext.test diff --git a/src/LogWriterAscii.cc b/src/LogWriterAscii.cc index 5bd476c936..9b1fda3b62 100644 --- a/src/LogWriterAscii.cc +++ b/src/LogWriterAscii.cc @@ -88,7 +88,7 @@ bool LogWriterAscii::DoInit(string path, int num_fields, if ( output_to_stdout ) path = "/dev/stdout"; - fname = IsSpecial(path) ? path : path + ".log"; + fname = IsSpecial(path) ? path : path + "." + LogExt(); if ( ! (file = fopen(fname.c_str(), "w")) ) { @@ -320,7 +320,7 @@ bool LogWriterAscii::DoRotate(string rotated_path, double open, fclose(file); file = 0; - string nname = rotated_path + ".log"; + string nname = rotated_path + "." + LogExt(); rename(fname.c_str(), nname.c_str()); if ( ! FinishedRotation(nname, fname, open, close, terminating) ) @@ -338,4 +338,9 @@ bool LogWriterAscii::DoSetBuf(bool enabled) return true; } - +string LogWriterAscii::LogExt() + { + const char* ext = getenv("BRO_LOG_SUFFIX"); + if ( ! ext ) ext = "log"; + return ext; + } diff --git a/src/LogWriterAscii.h b/src/LogWriterAscii.h index 7755f71d06..72127c8b1f 100644 --- a/src/LogWriterAscii.h +++ b/src/LogWriterAscii.h @@ -13,6 +13,7 @@ public: ~LogWriterAscii(); static LogWriter* Instantiate() { return new LogWriterAscii; } + static string LogExt(); protected: virtual bool DoInit(string path, int num_fields, diff --git a/src/main.cc b/src/main.cc index dfa46c3050..b4a27862c9 100644 --- a/src/main.cc +++ b/src/main.cc @@ -47,6 +47,7 @@ extern "C" void OPENSSL_add_all_algorithms_conf(void); #include "ConnCompressor.h" #include "DPM.h" #include "BroDoc.h" +#include "LogWriterAscii.h" #include "binpac_bro.h" @@ -194,6 +195,7 @@ void usage() fprintf(stderr, " $BRO_PREFIXES | prefix list (%s)\n", bro_prefixes()); fprintf(stderr, " $BRO_DNS_FAKE | disable DNS lookups (%s)\n", bro_dns_fake()); fprintf(stderr, " $BRO_SEED_FILE | file to load seeds from (not set)\n"); + fprintf(stderr, " $BRO_LOG_SUFFIX | ASCII log file extension (.%s)\n", LogWriterAscii::LogExt().c_str()); exit(1); } diff --git a/testing/btest/scripts/base/frameworks/logging/env-ext.test b/testing/btest/scripts/base/frameworks/logging/env-ext.test new file mode 100644 index 0000000000..e9f690caa4 --- /dev/null +++ b/testing/btest/scripts/base/frameworks/logging/env-ext.test @@ -0,0 +1,2 @@ +# @TEST-EXEC: BRO_LOG_SUFFIX=txt bro -r $TRACES/wikipedia.trace +# @TEST-EXEC: test -f conn.txt From e8a25ee68fbdca4950ec737258da1d7e0ee06a82 Mon Sep 17 00:00:00 2001 From: Robin Sommer Date: Thu, 1 Dec 2011 15:49:10 -0800 Subject: [PATCH 10/14] Updating CHANGES and VERSION. --- CHANGES | 5 +++++ VERSION | 2 +- 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/CHANGES b/CHANGES index 9474645544..6b0a0d5a70 100644 --- a/CHANGES +++ b/CHANGES @@ -1,4 +1,9 @@ +2.0-beta-72 | 2011-11-30 20:16:09 -0800 + + * Fine-tuning the Sphinx layout to better match www. (Jon Siwek and + Robin Sommer) + 2.0-beta-69 | 2011-11-29 16:55:31 -0800 * Fixing ASCII logger to escape the unset-field place holder if diff --git a/VERSION b/VERSION index 0ce06b2179..b46b52a627 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -2.0-beta-69 +2.0-beta-72 From f59c76685848c18ccc76a7570bd3a63060fad396 Mon Sep 17 00:00:00 2001 From: Robin Sommer Date: Fri, 2 Dec 2011 17:00:08 -0800 Subject: [PATCH 11/14] Portability fix for new patch. --- .../send.log | 25 +++++++++---------- .../communication_log_baseline.bro | 2 +- 2 files changed, 13 insertions(+), 14 deletions(-) diff --git a/testing/btest/Baseline/scripts.base.frameworks.communication.communication_log_baseline/send.log b/testing/btest/Baseline/scripts.base.frameworks.communication.communication_log_baseline/send.log index 9cf441d61a..7f71757ca0 100644 --- a/testing/btest/Baseline/scripts.base.frameworks.communication.communication_log_baseline/send.log +++ b/testing/btest/Baseline/scripts.base.frameworks.communication.communication_log_baseline/send.log @@ -2,16 +2,15 @@ #path communication #fields ts peer src_name connected_peer_desc connected_peer_addr connected_peer_port level message #types time string string string addr port string string -1322759704.176437 bro parent - - - info raised pipe's socket buffer size from 8K to 1024K -1322759704.176437 bro parent - - - info [#1/127.0.0.1:47757] added peer -1322759704.183341 bro child - - - info [#1/127.0.0.1:47757] connected -1322759704.183738 bro parent - - - info [#1/127.0.0.1:47757] peer connected -1322759704.183738 bro parent - - - info [#1/127.0.0.1:47757] phase: version -1322759704.184034 bro script - - - info connection established -1322759704.184034 bro script - - - info requesting events matching /^?(NOTHING)$?/ -1322759704.184034 bro script - - - info accepting state -1322759704.185120 bro parent - - - info [#1/127.0.0.1:47757] phase: handshake -1322759704.185120 bro parent - - - info warning: no events to request -1322759704.185120 bro parent - - - info terminating... -1322759704.185120 bro parent - - - info [#1/127.0.0.1:47757] peer_description is bro -1322759704.185120 bro parent - - - info [#1/127.0.0.1:47757] closing connection +1322788789.351248 bro parent - - - info [#1/127.0.0.1:47757] added peer +1322788789.354851 bro child - - - info [#1/127.0.0.1:47757] connected +1322788789.354956 bro parent - - - info [#1/127.0.0.1:47757] peer connected +1322788789.354956 bro parent - - - info [#1/127.0.0.1:47757] phase: version +1322788789.355429 bro script - - - info connection established +1322788789.355429 bro script - - - info requesting events matching /^?(NOTHING)$?/ +1322788789.355429 bro script - - - info accepting state +1322788789.355967 bro parent - - - info [#1/127.0.0.1:47757] phase: handshake +1322788789.355967 bro parent - - - info warning: no events to request +1322788789.355967 bro parent - - - info terminating... +1322788789.355967 bro parent - - - info [#1/127.0.0.1:47757] peer_description is bro +1322788789.355967 bro parent - - - info [#1/127.0.0.1:47757] closing connection diff --git a/testing/btest/scripts/base/frameworks/communication/communication_log_baseline.bro b/testing/btest/scripts/base/frameworks/communication/communication_log_baseline.bro index 74ff297010..c3078684af 100644 --- a/testing/btest/scripts/base/frameworks/communication/communication_log_baseline.bro +++ b/testing/btest/scripts/base/frameworks/communication/communication_log_baseline.bro @@ -4,7 +4,7 @@ # @TEST-EXEC: btest-bg-wait -k 2 # # Don't diff the receiver log just because port is always going to change -# @TEST-EXEC: grep -v pid sender/communication.log >send.log +# @TEST-EXEC: egrep -v 'pid|socket buffer size' sender/communication.log >send.log # @TEST-EXEC: btest-diff send.log @TEST-START-FILE sender.bro From 89f4e44f6ab5b2e98f80aeab46418ff5e4f09b01 Mon Sep 17 00:00:00 2001 From: Robin Sommer Date: Fri, 2 Dec 2011 17:00:58 -0800 Subject: [PATCH 12/14] Updating submodule(s). [nomail] --- CHANGES | 21 +++++++++++++++++++++ VERSION | 2 +- aux/bro-aux | 2 +- aux/broctl | 2 +- 4 files changed, 24 insertions(+), 3 deletions(-) diff --git a/CHANGES b/CHANGES index 6b0a0d5a70..4f34ec88b6 100644 --- a/CHANGES +++ b/CHANGES @@ -1,4 +1,25 @@ +2.0-beta-88 | 2011-12-02 17:00:58 -0800 + + * Teach LogWriterAscii to use BRO_LOG_SUFFIX environemt variable. + Addresses #704. (Jon Siwek) + + * Fix double-free of DNS_Mgr_Request object. Addresses #661. + + * Add a remote_log_peer event which comes with an event_peer record + parameter. Addresses #493. (Jon Siwek) + + * Remove example redef of SMTP::entity_excerpt_len from local.bro. + Fixes error emitted when loading local.bro in bare mode. (Jon + Siwek) + + * Add missing doc targets to top Makefile; remove old doc/Makefile. + Fixes #705. (Jon Siwek) + + * Turn some globals into constants. Addresses #633. (Seth Hall) + + * Rearrange packet filter and DPD documentation. (Jon Siwek) + 2.0-beta-72 | 2011-11-30 20:16:09 -0800 * Fine-tuning the Sphinx layout to better match www. (Jon Siwek and diff --git a/VERSION b/VERSION index b46b52a627..b436bdb2cd 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -2.0-beta-72 +2.0-beta-88 diff --git a/aux/bro-aux b/aux/bro-aux index 7ea5837b4b..4a8551ae52 160000 --- a/aux/bro-aux +++ b/aux/bro-aux @@ -1 +1 @@ -Subproject commit 7ea5837b4ba8403731ca4a9875616c0ab501342f +Subproject commit 4a8551ae52d52c395b366a4eb68e63356e01999e diff --git a/aux/broctl b/aux/broctl index 6771d28af2..919eda0c1c 160000 --- a/aux/broctl +++ b/aux/broctl @@ -1 +1 @@ -Subproject commit 6771d28af299f025a701e67f51311513af1cbc22 +Subproject commit 919eda0c1c6ce2681de6d1b975b73313b834353d From 5a58053ef10a36d003b1e7cd1e26dd7fd42eb4e4 Mon Sep 17 00:00:00 2001 From: Robin Sommer Date: Fri, 2 Dec 2011 17:19:47 -0800 Subject: [PATCH 13/14] Updating submodule(s). [nomail] --- aux/broctl | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/aux/broctl b/aux/broctl index 919eda0c1c..be772bbada 160000 --- a/aux/broctl +++ b/aux/broctl @@ -1 +1 @@ -Subproject commit 919eda0c1c6ce2681de6d1b975b73313b834353d +Subproject commit be772bbada79b106db33fb9de5f56fa71226adc5 From ab1ac72d4b5fc9a1e21d01a5513abc9584ec1279 Mon Sep 17 00:00:00 2001 From: Robin Sommer Date: Sat, 3 Dec 2011 14:45:02 -0800 Subject: [PATCH 14/14] Updating submodule(s). [nomail] --- aux/bro-aux | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/aux/bro-aux b/aux/bro-aux index 4a8551ae52..4d387ce660 160000 --- a/aux/bro-aux +++ b/aux/bro-aux @@ -1 +1 @@ -Subproject commit 4a8551ae52d52c395b366a4eb68e63356e01999e +Subproject commit 4d387ce660468b44df99d4c87d6016ae4ed2fdc4