In some chapters of the rules documentation, many sections used examples of rules, but these were inserted into images. These have been replaced by text and HTML emphasis.
Additionally, some tables embedded into images were also replaced by reST tables.
pull/3062/head
Ralph Broenink8 years agocommitted byVictor Julien
alert ip $EXTERNAL_NET any -> $HOME_NET any (msg:"GPL MISC 0 ttl"; :example-rule-emphasis:`ttl:0;` reference:url,support.microsoft.com/default.aspx?scid=kb#-#-EN-US#-#-q138268; reference:url,www.isi.edu/in-notes/rfc1122.txt; classtype:misc-activity; sid:2101321; rev:9;)
Ipopts
Ipopts
^^^^^^
^^^^^^
@ -37,7 +40,20 @@ set. Ipopts has to be used at the beginning of a rule. You can only
match on one option per rule. There are several options on which can
match on one option per rule. There are several options on which can
be matched. These are:
be matched. These are:
..image:: header-keywords/ipopts.png
========= =============================
IP Option Description
========= =============================
rr Record Route
eol End of List
nop No Op
ts Time Stamp
sec IP Security
esec IP Extended Security
lsrr Loose Source Routing
ssrr Strict Source Routing
satid Stream Identifier
any any IP options are set
========= =============================
Format of the ipopts keyword::
Format of the ipopts keyword::
@ -49,7 +65,9 @@ For example::
Example of ipopts in a rule:
Example of ipopts in a rule:
..image:: header-keywords/ipopts_rule.png
..container:: example-rule
alert ip $EXTERNAL_NET any -> $HOME_NET any (msg:"GPL MISC source route ssrr"; :example-rule-emphasis:`ipopts:ssrr;` reference:arachnids,422; classtype:bad-unknown; sid:2100502; rev:3;)
sameip
sameip
^^^^^^
^^^^^^
@ -64,7 +82,9 @@ keyword is::
Example of sameip in a rule:
Example of sameip in a rule:
..image:: header-keywords/sameip.png
..container:: example-rule
alert ip any any -> any any (msg:"GPL SCAN same SRC/DST"; :example-rule-emphasis:`sameip;` reference:bugtraq,2666; reference:cve,1999-0016; reference:url,www.cert.org/advisories/CA-1997-28.html; classtype:bad-unknown; sid:2100527; rev:9;)
alert ip any any -> any any (msg:"GPL MISC IP Proto 103 PIM"; :example-rule-emphasis:`ip_proto:103;` reference:bugtraq,8211; reference:cve,2003-0567; classtype:non-standard-protocol; sid:2102189; rev:4;)
alert tcp $EXTERNAL_NET any -> $HOME_NET any (msg:"ET EXPLOIT Invalid non-fragmented packet with fragment offset>0"; :example-rule-emphasis:`fragbits: M;` fragoffset: >0; reference:url,doc.emergingthreats.net/bin/view/Main/2001022; classtype:bad-unknown; sid:2001022; rev:5; metadata:created_at 2010_07_30, updated_at 2010_07_30;)
Fragoffset
Fragoffset
^^^^^^^^^^
^^^^^^^^^^
@ -199,7 +225,9 @@ Format of fragoffset::
Example of fragoffset in a rule:
Example of fragoffset in a rule:
..image:: header-keywords/fragoffset.png
..container:: example-rule
alert tcp $EXTERNAL_NET any -> $HOME_NET any (msg:"ET EXPLOIT Invalid non-fragmented packet with fragment offset>0"; fragbits: M; :example-rule-emphasis:`fragoffset: >0;` reference:url,doc.emergingthreats.net/bin/view/Main/2001022; classtype:bad-unknown; sid:2001022; rev:5; metadata:created_at 2010_07_30, updated_at 2010_07_30;)
TCP keywords
TCP keywords
------------
------------
@ -226,7 +254,9 @@ Example::
Example of seq in a signature:
Example of seq in a signature:
..image:: header-keywords/seq.png
..container:: example-rule
alert tcp $EXTERNAL_NET any -> $HOME_NET any (msg:"GPL SCAN NULL"; flow:stateless; ack:0; flags:0; :example-rule-emphasis:`seq:0;` reference:arachnids,4; classtype:attempted-recon; sid:2100623; rev:7;)
Example of seq in a packet (Wireshark):
Example of seq in a packet (Wireshark):
@ -249,7 +279,9 @@ Format of ack::
Example of ack in a signature:
Example of ack in a signature:
..image:: header-keywords/ack.png
..container:: example-rule
alert tcp $EXTERNAL_NET any -> $HOME_NET any (msg:"GPL SCAN NULL"; flow:stateless; :example-rule-emphasis:`ack:0;` flags:0; seq:0; reference:arachnids,4; classtype:attempted-recon; sid:2100623; rev:7;)
Example of ack in a packet (Wireshark):
Example of ack in a packet (Wireshark):
@ -275,7 +307,9 @@ The format of the window keyword::
Example of window in a rule:
Example of window in a rule:
..image:: header-keywords/Window.png
..container:: example-rule
alert tcp $EXTERNAL_NET any -> $HOME_NET any (msg:"GPL DELETED typot trojan traffic"; flow:stateless; flags:S,12; :example-rule-emphasis:`window:55808;` reference:mcafee,100406; classtype:trojan-activity; sid:2182; rev:8;)
ICMP keywords
ICMP keywords
-------------
-------------
@ -316,7 +350,44 @@ This example looks for an ICMP type greater than 10::
Example of the itype keyword in a signature:
Example of the itype keyword in a signature:
..image:: header-keywords/icmp_type.png
..container:: example-rule
alert icmp $EXTERNAL_NET any -> $HOME_NET any (msg:"GPL SCAN Broadscan Smurf Scanner"; dsize:4; icmp_id:0; icmp_seq:0; :example-rule-emphasis:`itype:8;` classtype:attempted-recon; sid:2100478; rev:4;)
The following lists all ICMP types known at the time of writing. A recent table can be found `at the website of IANA <https://www.iana.org/assignments/icmp-parameters/icmp-parameters.xhtml>`_
Meta-settings have no effect on Suricata's inspection; they do have an effect on the way Suricata reports events.
Meta-settings have no effect on Suricata's inspection; they do have an effect on the way Suricata reports events.
msg (message)
msg (message)
@ -26,6 +28,10 @@ It is a convention that msg is always the first keyword of a signature.
Another example of msg in a signature:
Another example of msg in a signature:
..container:: example-rule
drop tcp $HOME_NET any -> $EXTERNAL_NET any (:example-rule-emphasis:`msg:"ET TROJAN Likely Bot Nick in IRC (USA +..)";` flow:established,to_server; flowbits:isset,is_proto_irc; content:"NICK "; pcre:"/NICK .*USA.*[0-9]{3,}/i"; reference:url,doc.emergingthreats.net/2008124; classtype:trojan-activity; sid:2008124; rev:2;)
In this example the red, bold-faced part is the msg.
In this example the red, bold-faced part is the msg.
..note:: The following characters must be escaped inside the msg:
..note:: The following characters must be escaped inside the msg:
@ -44,7 +50,9 @@ The format of sid is:
Example of sid in a signature:
Example of sid in a signature:
..image:: meta/sid.png
..container:: example-rule
drop tcp $HOME_NET any -> $EXTERNAL_NET any (msg:"ET TROJAN Likely Bot Nick in IRC (USA +..)"; flow:established,to_server; flowbits:isset,is_proto_irc; content:"NICK "; pcre:"/NICK .*USA.*[0-9]{3,}/i"; reference:url,doc.emergingthreats.net/2008124; classtype:trojan-activity; :example-rule-emphasis:`sid:2008124;` rev:2;)
In this example the red, bold-faced part is the sid.
In this example the red, bold-faced part is the sid.
@ -65,7 +73,9 @@ of all keywords.*
Example of rev in a signature:
Example of rev in a signature:
..image:: meta/rev.png
..container:: example-rule
drop tcp $HOME_NET any -> $EXTERNAL_NET any (msg:"ET TROJAN Likely Bot Nick in IRC (USA +..)"; flow:established,to_server; flowbits:isset,is_proto_irc; content:"NICK "; pcre:"/NICK .*USA.*[0-9]{3,}/i"; reference:url,doc.emergingthreats.net/2008124; classtype:trojan-activity; sid:2008124; :example-rule-emphasis:`rev:2;`)
In this example the red, bold-faced part is the rev.
In this example the red, bold-faced part is the rev.
@ -80,7 +90,10 @@ the alert.
Example of gid in a signature:
Example of gid in a signature:
..image:: meta/gid.png
..container:: example-rule
10/15/09-03:30:10.219671 [**] [:example-rule-emphasis:`1`:2008124:2] ET TROJAN Likely Bot Nick in IRC (USA +..) [**] [Classification: A Network Trojan was Detected]
Ralph Broenink
8 years ago
committed by
Victor Julien
