From 80e6830dece8b76cde55cfc84f34b8a1ab3c90d1 Mon Sep 17 00:00:00 2001 From: Jason Ish Date: Fri, 4 Dec 2015 12:04:46 -0600 Subject: [PATCH] doc: restructure directory layout --- doc/sphinx/index.rst | 2 +- .../{ => rules}/adding-your-own-rules.rst | 0 doc/sphinx/{ => rules}/dnp3-keywords.rst | 0 doc/sphinx/{ => rules}/dns-keywords.rst | 0 .../{ => rules}/dns-keywords/dns_query.png | Bin .../{ => rules}/fast-pattern-explained.rst | 0 doc/sphinx/{ => rules}/fast-pattern.rst | 0 .../{ => rules}/fast-pattern/fast_pattern.png | Bin doc/sphinx/{ => rules}/file-keywords.rst | 0 doc/sphinx/{ => rules}/flow-keywords.rst | 0 .../{ => rules}/flow-keywords/Flow1.png | Bin .../{ => rules}/flow-keywords/Flow2.png | Bin .../{ => rules}/flow-keywords/Flowbit_3.png | Bin doc/sphinx/{ => rules}/flowint.rst | 0 doc/sphinx/{ => rules}/header-keywords.rst | 0 .../header-keywords/ICMP_type_code.png | Bin .../header-keywords/ICMP_types.png | Bin .../{ => rules}/header-keywords/Window.png | Bin .../header-keywords/Wireshark_ack.png | Bin .../header-keywords/Wireshark_seq.png | Bin .../{ => rules}/header-keywords/ack.png | Bin .../{ => rules}/header-keywords/fragbits.png | Bin .../header-keywords/fragoffset.png | Bin .../{ => rules}/header-keywords/icmp_id.png | Bin .../{ => rules}/header-keywords/icmp_seq.png | Bin .../{ => rules}/header-keywords/icmp_type.png | Bin .../{ => rules}/header-keywords/icode.png | Bin doc/sphinx/{ => rules}/header-keywords/id.png | Bin .../{ => rules}/header-keywords/ip_proto.png | Bin .../{ => rules}/header-keywords/ipopts.png | Bin .../header-keywords/ipopts_rule.png | Bin .../{ => rules}/header-keywords/sameip.png | Bin .../{ => rules}/header-keywords/seq.png | Bin .../{ => rules}/header-keywords/ttl.png | Bin doc/sphinx/{ => rules}/http-keywords.rst | 0 .../http-keywords/Legenda_rules.png | Bin .../{ => rules}/http-keywords/client_body.png | Bin .../http-keywords/client_body1.png | Bin .../{ => rules}/http-keywords/cookie.png | Bin .../{ => rules}/http-keywords/cookie1.png | Bin .../http-keywords/fast_pattern.png | Bin .../{ => rules}/http-keywords/file_data.png | Bin .../{ => rules}/http-keywords/header.png | Bin .../{ => rules}/http-keywords/header1.png | Bin .../http-keywords/http_server_body.png | Bin .../{ => rules}/http-keywords/http_uri.png | Bin .../{ => rules}/http-keywords/method.png | Bin .../{ => rules}/http-keywords/method1.png | Bin .../{ => rules}/http-keywords/method2.png | Bin .../{ => rules}/http-keywords/request.png | Bin .../{ => rules}/http-keywords/request2.png | Bin .../{ => rules}/http-keywords/response1.png | Bin .../{ => rules}/http-keywords/stat-code1.png | Bin .../{ => rules}/http-keywords/stat_code.png | Bin .../{ => rules}/http-keywords/stat_msg.png | Bin .../{ => rules}/http-keywords/stat_msg_1.png | Bin doc/sphinx/{ => rules}/http-keywords/uri.png | Bin doc/sphinx/{ => rules}/http-keywords/uri1.png | Bin .../{ => rules}/http-keywords/uricontent.png | Bin .../{ => rules}/http-keywords/uricontent1.png | Bin .../{ => rules}/http-keywords/urilen.png | Bin .../{ => rules}/http-keywords/urilen1.png | Bin .../{ => rules}/http-keywords/user_agent.png | Bin .../http-keywords/user_agent_match.png | Bin doc/sphinx/{rules.rst => rules/index.rst} | 3 +-- .../{rules-intro.rst => rules/intro.rst} | 18 +++++++++--------- doc/sphinx/rules/{ => intro}/Dest_port.png | Bin doc/sphinx/rules/{ => intro}/Direction.png | Bin doc/sphinx/rules/{ => intro}/Source-port.png | Bin doc/sphinx/rules/{ => intro}/Source.png | Bin doc/sphinx/rules/{ => intro}/TCP-session.png | Bin doc/sphinx/rules/{ => intro}/action.png | Bin doc/sphinx/rules/{ => intro}/destination.png | Bin doc/sphinx/rules/{ => intro}/intro_sig.png | Bin doc/sphinx/rules/{ => intro}/protocol.png | Bin doc/sphinx/{ => rules}/live-rule-swap.rst | 0 doc/sphinx/{ => rules}/meta.rst | 0 .../{ => rules}/meta/classification.png | Bin doc/sphinx/{ => rules}/meta/classtype.png | Bin doc/sphinx/{ => rules}/meta/gid.png | Bin doc/sphinx/{ => rules}/meta/msg.png | Bin doc/sphinx/{ => rules}/meta/reference.png | Bin doc/sphinx/{ => rules}/meta/rev.png | Bin doc/sphinx/{ => rules}/meta/sid.png | Bin doc/sphinx/{ => rules}/modbus-keyword.rst | 0 doc/sphinx/{ => rules}/normalized-buffers.rst | 0 .../normalized-buffers/normalization1.png | Bin doc/sphinx/{ => rules}/payload-keywords.rst | 0 .../payload-keywords/Legenda_rules.png | Bin .../{ => rules}/payload-keywords/content.png | Bin .../{ => rules}/payload-keywords/content2.png | Bin .../{ => rules}/payload-keywords/content3.png | Bin .../{ => rules}/payload-keywords/content4.png | Bin .../{ => rules}/payload-keywords/content5.png | Bin .../{ => rules}/payload-keywords/content6.png | Bin .../{ => rules}/payload-keywords/distance.png | Bin .../payload-keywords/distance1.png | Bin .../payload-keywords/distance3.png | Bin .../payload-keywords/distance4.png | Bin .../payload-keywords/distance5.png | Bin .../{ => rules}/payload-keywords/dsize.png | Bin .../payload-keywords/isdataat1.png | Bin .../{ => rules}/payload-keywords/replace.png | Bin .../{ => rules}/payload-keywords/replace1.png | Bin .../{ => rules}/payload-keywords/rpc.png | Bin .../{ => rules}/payload-keywords/within1.png | Bin .../{ => rules}/payload-keywords/within2.png | Bin .../payload-keywords/within_distance.png | Bin .../payload-keywords/within_distance2.png | Bin doc/sphinx/{ => rules}/pcre.rst | 0 doc/sphinx/{ => rules}/pcre/pcre.png | Bin doc/sphinx/{ => rules}/pcre/pcre3.png | Bin doc/sphinx/{ => rules}/pcre/pcre4.png | Bin doc/sphinx/{ => rules}/pcre/pcre5.png | Bin doc/sphinx/{ => rules}/pcre/pcre6.png | Bin doc/sphinx/{ => rules}/rule-lua-scripting.rst | 0 doc/sphinx/{ => rules}/rule-profiling.rst | 0 doc/sphinx/{ => rules}/thresholding.rst | 0 doc/sphinx/{ => rules}/tls-keywords.rst | 0 119 files changed, 11 insertions(+), 12 deletions(-) rename doc/sphinx/{ => rules}/adding-your-own-rules.rst (100%) rename doc/sphinx/{ => rules}/dnp3-keywords.rst (100%) rename doc/sphinx/{ => rules}/dns-keywords.rst (100%) rename doc/sphinx/{ => rules}/dns-keywords/dns_query.png (100%) rename doc/sphinx/{ => rules}/fast-pattern-explained.rst (100%) rename doc/sphinx/{ => rules}/fast-pattern.rst (100%) rename doc/sphinx/{ => rules}/fast-pattern/fast_pattern.png (100%) rename doc/sphinx/{ => rules}/file-keywords.rst (100%) rename doc/sphinx/{ => rules}/flow-keywords.rst (100%) rename doc/sphinx/{ => rules}/flow-keywords/Flow1.png (100%) rename doc/sphinx/{ => rules}/flow-keywords/Flow2.png (100%) rename doc/sphinx/{ => rules}/flow-keywords/Flowbit_3.png (100%) rename doc/sphinx/{ => rules}/flowint.rst (100%) rename doc/sphinx/{ => rules}/header-keywords.rst (100%) rename doc/sphinx/{ => rules}/header-keywords/ICMP_type_code.png (100%) rename doc/sphinx/{ => rules}/header-keywords/ICMP_types.png (100%) rename doc/sphinx/{ => rules}/header-keywords/Window.png (100%) rename doc/sphinx/{ => rules}/header-keywords/Wireshark_ack.png (100%) rename doc/sphinx/{ => rules}/header-keywords/Wireshark_seq.png (100%) rename doc/sphinx/{ => rules}/header-keywords/ack.png (100%) rename doc/sphinx/{ => rules}/header-keywords/fragbits.png (100%) rename doc/sphinx/{ => rules}/header-keywords/fragoffset.png (100%) rename doc/sphinx/{ => rules}/header-keywords/icmp_id.png (100%) rename doc/sphinx/{ => rules}/header-keywords/icmp_seq.png (100%) rename doc/sphinx/{ => rules}/header-keywords/icmp_type.png (100%) rename doc/sphinx/{ => rules}/header-keywords/icode.png (100%) rename doc/sphinx/{ => rules}/header-keywords/id.png (100%) rename doc/sphinx/{ => rules}/header-keywords/ip_proto.png (100%) rename doc/sphinx/{ => rules}/header-keywords/ipopts.png (100%) rename doc/sphinx/{ => rules}/header-keywords/ipopts_rule.png (100%) rename doc/sphinx/{ => rules}/header-keywords/sameip.png (100%) rename doc/sphinx/{ => rules}/header-keywords/seq.png (100%) rename doc/sphinx/{ => rules}/header-keywords/ttl.png (100%) rename doc/sphinx/{ => rules}/http-keywords.rst (100%) rename doc/sphinx/{ => rules}/http-keywords/Legenda_rules.png (100%) rename doc/sphinx/{ => rules}/http-keywords/client_body.png (100%) rename doc/sphinx/{ => rules}/http-keywords/client_body1.png (100%) rename doc/sphinx/{ => rules}/http-keywords/cookie.png (100%) rename doc/sphinx/{ => rules}/http-keywords/cookie1.png (100%) rename doc/sphinx/{ => rules}/http-keywords/fast_pattern.png (100%) rename doc/sphinx/{ => rules}/http-keywords/file_data.png (100%) rename doc/sphinx/{ => rules}/http-keywords/header.png (100%) rename doc/sphinx/{ => rules}/http-keywords/header1.png (100%) rename doc/sphinx/{ => rules}/http-keywords/http_server_body.png (100%) rename doc/sphinx/{ => rules}/http-keywords/http_uri.png (100%) rename doc/sphinx/{ => rules}/http-keywords/method.png (100%) rename doc/sphinx/{ => rules}/http-keywords/method1.png (100%) rename doc/sphinx/{ => rules}/http-keywords/method2.png (100%) rename doc/sphinx/{ => rules}/http-keywords/request.png (100%) rename doc/sphinx/{ => rules}/http-keywords/request2.png (100%) rename doc/sphinx/{ => rules}/http-keywords/response1.png (100%) rename doc/sphinx/{ => rules}/http-keywords/stat-code1.png (100%) rename doc/sphinx/{ => rules}/http-keywords/stat_code.png (100%) rename doc/sphinx/{ => rules}/http-keywords/stat_msg.png (100%) rename doc/sphinx/{ => rules}/http-keywords/stat_msg_1.png (100%) rename doc/sphinx/{ => rules}/http-keywords/uri.png (100%) rename doc/sphinx/{ => rules}/http-keywords/uri1.png (100%) rename doc/sphinx/{ => rules}/http-keywords/uricontent.png (100%) rename doc/sphinx/{ => rules}/http-keywords/uricontent1.png (100%) rename doc/sphinx/{ => rules}/http-keywords/urilen.png (100%) rename doc/sphinx/{ => rules}/http-keywords/urilen1.png (100%) rename doc/sphinx/{ => rules}/http-keywords/user_agent.png (100%) rename doc/sphinx/{ => rules}/http-keywords/user_agent_match.png (100%) rename doc/sphinx/{rules.rst => rules/index.rst} (95%) rename doc/sphinx/{rules-intro.rst => rules/intro.rst} (94%) rename doc/sphinx/rules/{ => intro}/Dest_port.png (100%) rename doc/sphinx/rules/{ => intro}/Direction.png (100%) rename doc/sphinx/rules/{ => intro}/Source-port.png (100%) rename doc/sphinx/rules/{ => intro}/Source.png (100%) rename doc/sphinx/rules/{ => intro}/TCP-session.png (100%) rename doc/sphinx/rules/{ => intro}/action.png (100%) rename doc/sphinx/rules/{ => intro}/destination.png (100%) rename doc/sphinx/rules/{ => intro}/intro_sig.png (100%) rename doc/sphinx/rules/{ => intro}/protocol.png (100%) rename doc/sphinx/{ => rules}/live-rule-swap.rst (100%) rename doc/sphinx/{ => rules}/meta.rst (100%) rename doc/sphinx/{ => rules}/meta/classification.png (100%) rename doc/sphinx/{ => rules}/meta/classtype.png (100%) rename doc/sphinx/{ => rules}/meta/gid.png (100%) rename doc/sphinx/{ => rules}/meta/msg.png (100%) rename doc/sphinx/{ => rules}/meta/reference.png (100%) rename doc/sphinx/{ => rules}/meta/rev.png (100%) rename doc/sphinx/{ => rules}/meta/sid.png (100%) rename doc/sphinx/{ => rules}/modbus-keyword.rst (100%) rename doc/sphinx/{ => rules}/normalized-buffers.rst (100%) rename doc/sphinx/{ => rules}/normalized-buffers/normalization1.png (100%) rename doc/sphinx/{ => rules}/payload-keywords.rst (100%) rename doc/sphinx/{ => rules}/payload-keywords/Legenda_rules.png (100%) rename doc/sphinx/{ => rules}/payload-keywords/content.png (100%) rename doc/sphinx/{ => rules}/payload-keywords/content2.png (100%) rename doc/sphinx/{ => rules}/payload-keywords/content3.png (100%) rename doc/sphinx/{ => rules}/payload-keywords/content4.png (100%) rename doc/sphinx/{ => rules}/payload-keywords/content5.png (100%) rename doc/sphinx/{ => rules}/payload-keywords/content6.png (100%) rename doc/sphinx/{ => rules}/payload-keywords/distance.png (100%) rename doc/sphinx/{ => rules}/payload-keywords/distance1.png (100%) rename doc/sphinx/{ => rules}/payload-keywords/distance3.png (100%) rename doc/sphinx/{ => rules}/payload-keywords/distance4.png (100%) rename doc/sphinx/{ => rules}/payload-keywords/distance5.png (100%) rename doc/sphinx/{ => rules}/payload-keywords/dsize.png (100%) rename doc/sphinx/{ => rules}/payload-keywords/isdataat1.png (100%) rename doc/sphinx/{ => rules}/payload-keywords/replace.png (100%) rename doc/sphinx/{ => rules}/payload-keywords/replace1.png (100%) rename doc/sphinx/{ => rules}/payload-keywords/rpc.png (100%) rename doc/sphinx/{ => rules}/payload-keywords/within1.png (100%) rename doc/sphinx/{ => rules}/payload-keywords/within2.png (100%) rename doc/sphinx/{ => rules}/payload-keywords/within_distance.png (100%) rename doc/sphinx/{ => rules}/payload-keywords/within_distance2.png (100%) rename doc/sphinx/{ => rules}/pcre.rst (100%) rename doc/sphinx/{ => rules}/pcre/pcre.png (100%) rename doc/sphinx/{ => rules}/pcre/pcre3.png (100%) rename doc/sphinx/{ => rules}/pcre/pcre4.png (100%) rename doc/sphinx/{ => rules}/pcre/pcre5.png (100%) rename doc/sphinx/{ => rules}/pcre/pcre6.png (100%) rename doc/sphinx/{ => rules}/rule-lua-scripting.rst (100%) rename doc/sphinx/{ => rules}/rule-profiling.rst (100%) rename doc/sphinx/{ => rules}/thresholding.rst (100%) rename doc/sphinx/{ => rules}/tls-keywords.rst (100%) diff --git a/doc/sphinx/index.rst b/doc/sphinx/index.rst index 40581d2bce..9c75ba6521 100644 --- a/doc/sphinx/index.rst +++ b/doc/sphinx/index.rst @@ -6,4 +6,4 @@ Suricata User Guide :titlesonly: what-is-suricata - rules + rules/index.rst diff --git a/doc/sphinx/adding-your-own-rules.rst b/doc/sphinx/rules/adding-your-own-rules.rst similarity index 100% rename from doc/sphinx/adding-your-own-rules.rst rename to doc/sphinx/rules/adding-your-own-rules.rst diff --git a/doc/sphinx/dnp3-keywords.rst b/doc/sphinx/rules/dnp3-keywords.rst similarity index 100% rename from doc/sphinx/dnp3-keywords.rst rename to doc/sphinx/rules/dnp3-keywords.rst diff --git a/doc/sphinx/dns-keywords.rst b/doc/sphinx/rules/dns-keywords.rst similarity index 100% rename from doc/sphinx/dns-keywords.rst rename to doc/sphinx/rules/dns-keywords.rst diff --git a/doc/sphinx/dns-keywords/dns_query.png b/doc/sphinx/rules/dns-keywords/dns_query.png similarity index 100% rename from doc/sphinx/dns-keywords/dns_query.png rename to doc/sphinx/rules/dns-keywords/dns_query.png diff --git a/doc/sphinx/fast-pattern-explained.rst b/doc/sphinx/rules/fast-pattern-explained.rst similarity index 100% rename from doc/sphinx/fast-pattern-explained.rst rename to doc/sphinx/rules/fast-pattern-explained.rst diff --git a/doc/sphinx/fast-pattern.rst b/doc/sphinx/rules/fast-pattern.rst similarity index 100% rename from doc/sphinx/fast-pattern.rst rename to doc/sphinx/rules/fast-pattern.rst diff --git a/doc/sphinx/fast-pattern/fast_pattern.png b/doc/sphinx/rules/fast-pattern/fast_pattern.png similarity index 100% rename from doc/sphinx/fast-pattern/fast_pattern.png rename to doc/sphinx/rules/fast-pattern/fast_pattern.png diff --git a/doc/sphinx/file-keywords.rst b/doc/sphinx/rules/file-keywords.rst similarity index 100% rename from doc/sphinx/file-keywords.rst rename to doc/sphinx/rules/file-keywords.rst diff --git a/doc/sphinx/flow-keywords.rst b/doc/sphinx/rules/flow-keywords.rst similarity index 100% rename from doc/sphinx/flow-keywords.rst rename to doc/sphinx/rules/flow-keywords.rst diff --git a/doc/sphinx/flow-keywords/Flow1.png b/doc/sphinx/rules/flow-keywords/Flow1.png similarity index 100% rename from doc/sphinx/flow-keywords/Flow1.png rename to doc/sphinx/rules/flow-keywords/Flow1.png diff --git a/doc/sphinx/flow-keywords/Flow2.png b/doc/sphinx/rules/flow-keywords/Flow2.png similarity index 100% rename from doc/sphinx/flow-keywords/Flow2.png rename to doc/sphinx/rules/flow-keywords/Flow2.png diff --git a/doc/sphinx/flow-keywords/Flowbit_3.png b/doc/sphinx/rules/flow-keywords/Flowbit_3.png similarity index 100% rename from doc/sphinx/flow-keywords/Flowbit_3.png rename to doc/sphinx/rules/flow-keywords/Flowbit_3.png diff --git a/doc/sphinx/flowint.rst b/doc/sphinx/rules/flowint.rst similarity index 100% rename from doc/sphinx/flowint.rst rename to doc/sphinx/rules/flowint.rst diff --git a/doc/sphinx/header-keywords.rst b/doc/sphinx/rules/header-keywords.rst similarity index 100% rename from doc/sphinx/header-keywords.rst rename to doc/sphinx/rules/header-keywords.rst diff --git a/doc/sphinx/header-keywords/ICMP_type_code.png b/doc/sphinx/rules/header-keywords/ICMP_type_code.png similarity index 100% rename from doc/sphinx/header-keywords/ICMP_type_code.png rename to doc/sphinx/rules/header-keywords/ICMP_type_code.png diff --git a/doc/sphinx/header-keywords/ICMP_types.png b/doc/sphinx/rules/header-keywords/ICMP_types.png similarity index 100% rename from doc/sphinx/header-keywords/ICMP_types.png rename to doc/sphinx/rules/header-keywords/ICMP_types.png diff --git a/doc/sphinx/header-keywords/Window.png b/doc/sphinx/rules/header-keywords/Window.png similarity index 100% rename from doc/sphinx/header-keywords/Window.png rename to doc/sphinx/rules/header-keywords/Window.png diff --git a/doc/sphinx/header-keywords/Wireshark_ack.png b/doc/sphinx/rules/header-keywords/Wireshark_ack.png similarity index 100% rename from doc/sphinx/header-keywords/Wireshark_ack.png rename to doc/sphinx/rules/header-keywords/Wireshark_ack.png diff --git a/doc/sphinx/header-keywords/Wireshark_seq.png b/doc/sphinx/rules/header-keywords/Wireshark_seq.png similarity index 100% rename from doc/sphinx/header-keywords/Wireshark_seq.png rename to doc/sphinx/rules/header-keywords/Wireshark_seq.png diff --git a/doc/sphinx/header-keywords/ack.png b/doc/sphinx/rules/header-keywords/ack.png similarity index 100% rename from doc/sphinx/header-keywords/ack.png rename to doc/sphinx/rules/header-keywords/ack.png diff --git a/doc/sphinx/header-keywords/fragbits.png b/doc/sphinx/rules/header-keywords/fragbits.png similarity index 100% rename from doc/sphinx/header-keywords/fragbits.png rename to doc/sphinx/rules/header-keywords/fragbits.png diff --git a/doc/sphinx/header-keywords/fragoffset.png b/doc/sphinx/rules/header-keywords/fragoffset.png similarity index 100% rename from doc/sphinx/header-keywords/fragoffset.png rename to doc/sphinx/rules/header-keywords/fragoffset.png diff --git a/doc/sphinx/header-keywords/icmp_id.png b/doc/sphinx/rules/header-keywords/icmp_id.png similarity index 100% rename from doc/sphinx/header-keywords/icmp_id.png rename to doc/sphinx/rules/header-keywords/icmp_id.png diff --git a/doc/sphinx/header-keywords/icmp_seq.png b/doc/sphinx/rules/header-keywords/icmp_seq.png similarity index 100% rename from doc/sphinx/header-keywords/icmp_seq.png rename to doc/sphinx/rules/header-keywords/icmp_seq.png diff --git a/doc/sphinx/header-keywords/icmp_type.png b/doc/sphinx/rules/header-keywords/icmp_type.png similarity index 100% rename from doc/sphinx/header-keywords/icmp_type.png rename to doc/sphinx/rules/header-keywords/icmp_type.png diff --git a/doc/sphinx/header-keywords/icode.png b/doc/sphinx/rules/header-keywords/icode.png similarity index 100% rename from doc/sphinx/header-keywords/icode.png rename to doc/sphinx/rules/header-keywords/icode.png diff --git a/doc/sphinx/header-keywords/id.png b/doc/sphinx/rules/header-keywords/id.png similarity index 100% rename from doc/sphinx/header-keywords/id.png rename to doc/sphinx/rules/header-keywords/id.png diff --git a/doc/sphinx/header-keywords/ip_proto.png b/doc/sphinx/rules/header-keywords/ip_proto.png similarity index 100% rename from doc/sphinx/header-keywords/ip_proto.png rename to doc/sphinx/rules/header-keywords/ip_proto.png diff --git a/doc/sphinx/header-keywords/ipopts.png b/doc/sphinx/rules/header-keywords/ipopts.png similarity index 100% rename from doc/sphinx/header-keywords/ipopts.png rename to doc/sphinx/rules/header-keywords/ipopts.png diff --git a/doc/sphinx/header-keywords/ipopts_rule.png b/doc/sphinx/rules/header-keywords/ipopts_rule.png similarity index 100% rename from doc/sphinx/header-keywords/ipopts_rule.png rename to doc/sphinx/rules/header-keywords/ipopts_rule.png diff --git a/doc/sphinx/header-keywords/sameip.png b/doc/sphinx/rules/header-keywords/sameip.png similarity index 100% rename from doc/sphinx/header-keywords/sameip.png rename to doc/sphinx/rules/header-keywords/sameip.png diff --git a/doc/sphinx/header-keywords/seq.png b/doc/sphinx/rules/header-keywords/seq.png similarity index 100% rename from doc/sphinx/header-keywords/seq.png rename to doc/sphinx/rules/header-keywords/seq.png diff --git a/doc/sphinx/header-keywords/ttl.png b/doc/sphinx/rules/header-keywords/ttl.png similarity index 100% rename from doc/sphinx/header-keywords/ttl.png rename to doc/sphinx/rules/header-keywords/ttl.png diff --git a/doc/sphinx/http-keywords.rst b/doc/sphinx/rules/http-keywords.rst similarity index 100% rename from doc/sphinx/http-keywords.rst rename to doc/sphinx/rules/http-keywords.rst diff --git a/doc/sphinx/http-keywords/Legenda_rules.png b/doc/sphinx/rules/http-keywords/Legenda_rules.png similarity index 100% rename from doc/sphinx/http-keywords/Legenda_rules.png rename to doc/sphinx/rules/http-keywords/Legenda_rules.png diff --git a/doc/sphinx/http-keywords/client_body.png b/doc/sphinx/rules/http-keywords/client_body.png similarity index 100% rename from doc/sphinx/http-keywords/client_body.png rename to doc/sphinx/rules/http-keywords/client_body.png diff --git a/doc/sphinx/http-keywords/client_body1.png b/doc/sphinx/rules/http-keywords/client_body1.png similarity index 100% rename from doc/sphinx/http-keywords/client_body1.png rename to doc/sphinx/rules/http-keywords/client_body1.png diff --git a/doc/sphinx/http-keywords/cookie.png b/doc/sphinx/rules/http-keywords/cookie.png similarity index 100% rename from doc/sphinx/http-keywords/cookie.png rename to doc/sphinx/rules/http-keywords/cookie.png diff --git a/doc/sphinx/http-keywords/cookie1.png b/doc/sphinx/rules/http-keywords/cookie1.png similarity index 100% rename from doc/sphinx/http-keywords/cookie1.png rename to doc/sphinx/rules/http-keywords/cookie1.png diff --git a/doc/sphinx/http-keywords/fast_pattern.png b/doc/sphinx/rules/http-keywords/fast_pattern.png similarity index 100% rename from doc/sphinx/http-keywords/fast_pattern.png rename to doc/sphinx/rules/http-keywords/fast_pattern.png diff --git a/doc/sphinx/http-keywords/file_data.png b/doc/sphinx/rules/http-keywords/file_data.png similarity index 100% rename from doc/sphinx/http-keywords/file_data.png rename to doc/sphinx/rules/http-keywords/file_data.png diff --git a/doc/sphinx/http-keywords/header.png b/doc/sphinx/rules/http-keywords/header.png similarity index 100% rename from doc/sphinx/http-keywords/header.png rename to doc/sphinx/rules/http-keywords/header.png diff --git a/doc/sphinx/http-keywords/header1.png b/doc/sphinx/rules/http-keywords/header1.png similarity index 100% rename from doc/sphinx/http-keywords/header1.png rename to doc/sphinx/rules/http-keywords/header1.png diff --git a/doc/sphinx/http-keywords/http_server_body.png b/doc/sphinx/rules/http-keywords/http_server_body.png similarity index 100% rename from doc/sphinx/http-keywords/http_server_body.png rename to doc/sphinx/rules/http-keywords/http_server_body.png diff --git a/doc/sphinx/http-keywords/http_uri.png b/doc/sphinx/rules/http-keywords/http_uri.png similarity index 100% rename from doc/sphinx/http-keywords/http_uri.png rename to doc/sphinx/rules/http-keywords/http_uri.png diff --git a/doc/sphinx/http-keywords/method.png b/doc/sphinx/rules/http-keywords/method.png similarity index 100% rename from doc/sphinx/http-keywords/method.png rename to doc/sphinx/rules/http-keywords/method.png diff --git a/doc/sphinx/http-keywords/method1.png b/doc/sphinx/rules/http-keywords/method1.png similarity index 100% rename from doc/sphinx/http-keywords/method1.png rename to doc/sphinx/rules/http-keywords/method1.png diff --git a/doc/sphinx/http-keywords/method2.png b/doc/sphinx/rules/http-keywords/method2.png similarity index 100% rename from doc/sphinx/http-keywords/method2.png rename to doc/sphinx/rules/http-keywords/method2.png diff --git a/doc/sphinx/http-keywords/request.png b/doc/sphinx/rules/http-keywords/request.png similarity index 100% rename from doc/sphinx/http-keywords/request.png rename to doc/sphinx/rules/http-keywords/request.png diff --git a/doc/sphinx/http-keywords/request2.png b/doc/sphinx/rules/http-keywords/request2.png similarity index 100% rename from doc/sphinx/http-keywords/request2.png rename to doc/sphinx/rules/http-keywords/request2.png diff --git a/doc/sphinx/http-keywords/response1.png b/doc/sphinx/rules/http-keywords/response1.png similarity index 100% rename from doc/sphinx/http-keywords/response1.png rename to doc/sphinx/rules/http-keywords/response1.png diff --git a/doc/sphinx/http-keywords/stat-code1.png b/doc/sphinx/rules/http-keywords/stat-code1.png similarity index 100% rename from doc/sphinx/http-keywords/stat-code1.png rename to doc/sphinx/rules/http-keywords/stat-code1.png diff --git a/doc/sphinx/http-keywords/stat_code.png b/doc/sphinx/rules/http-keywords/stat_code.png similarity index 100% rename from doc/sphinx/http-keywords/stat_code.png rename to doc/sphinx/rules/http-keywords/stat_code.png diff --git a/doc/sphinx/http-keywords/stat_msg.png b/doc/sphinx/rules/http-keywords/stat_msg.png similarity index 100% rename from doc/sphinx/http-keywords/stat_msg.png rename to doc/sphinx/rules/http-keywords/stat_msg.png diff --git a/doc/sphinx/http-keywords/stat_msg_1.png b/doc/sphinx/rules/http-keywords/stat_msg_1.png similarity index 100% rename from doc/sphinx/http-keywords/stat_msg_1.png rename to doc/sphinx/rules/http-keywords/stat_msg_1.png diff --git a/doc/sphinx/http-keywords/uri.png b/doc/sphinx/rules/http-keywords/uri.png similarity index 100% rename from doc/sphinx/http-keywords/uri.png rename to doc/sphinx/rules/http-keywords/uri.png diff --git a/doc/sphinx/http-keywords/uri1.png b/doc/sphinx/rules/http-keywords/uri1.png similarity index 100% rename from doc/sphinx/http-keywords/uri1.png rename to doc/sphinx/rules/http-keywords/uri1.png diff --git a/doc/sphinx/http-keywords/uricontent.png b/doc/sphinx/rules/http-keywords/uricontent.png similarity index 100% rename from doc/sphinx/http-keywords/uricontent.png rename to doc/sphinx/rules/http-keywords/uricontent.png diff --git a/doc/sphinx/http-keywords/uricontent1.png b/doc/sphinx/rules/http-keywords/uricontent1.png similarity index 100% rename from doc/sphinx/http-keywords/uricontent1.png rename to doc/sphinx/rules/http-keywords/uricontent1.png diff --git a/doc/sphinx/http-keywords/urilen.png b/doc/sphinx/rules/http-keywords/urilen.png similarity index 100% rename from doc/sphinx/http-keywords/urilen.png rename to doc/sphinx/rules/http-keywords/urilen.png diff --git a/doc/sphinx/http-keywords/urilen1.png b/doc/sphinx/rules/http-keywords/urilen1.png similarity index 100% rename from doc/sphinx/http-keywords/urilen1.png rename to doc/sphinx/rules/http-keywords/urilen1.png diff --git a/doc/sphinx/http-keywords/user_agent.png b/doc/sphinx/rules/http-keywords/user_agent.png similarity index 100% rename from doc/sphinx/http-keywords/user_agent.png rename to doc/sphinx/rules/http-keywords/user_agent.png diff --git a/doc/sphinx/http-keywords/user_agent_match.png b/doc/sphinx/rules/http-keywords/user_agent_match.png similarity index 100% rename from doc/sphinx/http-keywords/user_agent_match.png rename to doc/sphinx/rules/http-keywords/user_agent_match.png diff --git a/doc/sphinx/rules.rst b/doc/sphinx/rules/index.rst similarity index 95% rename from doc/sphinx/rules.rst rename to doc/sphinx/rules/index.rst index 8b5f5e95ee..6f73db0cf6 100644 --- a/doc/sphinx/rules.rst +++ b/doc/sphinx/rules/index.rst @@ -3,7 +3,7 @@ Suricata Rules .. toctree:: - rules-intro + intro meta header-keywords payload-keywords @@ -21,4 +21,3 @@ Suricata Rules rule-profiling modbus-keyword dnp3-keywords - diff --git a/doc/sphinx/rules-intro.rst b/doc/sphinx/rules/intro.rst similarity index 94% rename from doc/sphinx/rules-intro.rst rename to doc/sphinx/rules/intro.rst index 960da6994a..e834c31e59 100644 --- a/doc/sphinx/rules-intro.rst +++ b/doc/sphinx/rules/intro.rst @@ -17,7 +17,7 @@ A rule/signature consists of the following: Example of a signature: -.. image:: rules/intro_sig.png +.. image:: intro/intro_sig.png Action ------ @@ -27,7 +27,7 @@ For more information read 'Action Order' in the Example: -.. image:: rules/action.png +.. image:: intro/action.png In this example the red, bold-faced part is the action. @@ -45,7 +45,7 @@ match if it concerns http-traffic. Example: -.. image:: rules/protocol.png +.. image:: intro/protocol.png In this example the red, bold-faced part is the protocol. @@ -83,11 +83,11 @@ You can not write a signature using EXTERNAL_NET because it stands for Example of source and destination in a signature: -.. image:: rules/Source.png +.. image:: intro/Source.png The red, bold-faced part is the source. -.. image:: rules/destination.png +.. image:: intro/destination.png The red, bold-faced part is the destination. @@ -120,10 +120,10 @@ Example:: Example of ports in a signature: -.. image:: rules/Source-port.png +.. image:: intro/Source-port.png -.. image:: rules/Dest_port.png +.. image:: intro/Dest_port.png In this example, the red, bold-faced part is the port. @@ -145,14 +145,14 @@ Example:: Example 1 tcp-session -.. image:: rules/TCP-session.png +.. image:: intro/TCP-session.png In this example there will only be a match if the signature has the same order/direction as the payload. Example of direction in a signature: -.. image:: rules/Direction.png +.. image:: intro/Direction.png In this example the red, bold-faced part is the direction. diff --git a/doc/sphinx/rules/Dest_port.png b/doc/sphinx/rules/intro/Dest_port.png similarity index 100% rename from doc/sphinx/rules/Dest_port.png rename to doc/sphinx/rules/intro/Dest_port.png diff --git a/doc/sphinx/rules/Direction.png b/doc/sphinx/rules/intro/Direction.png similarity index 100% rename from doc/sphinx/rules/Direction.png rename to doc/sphinx/rules/intro/Direction.png diff --git a/doc/sphinx/rules/Source-port.png b/doc/sphinx/rules/intro/Source-port.png similarity index 100% rename from doc/sphinx/rules/Source-port.png rename to doc/sphinx/rules/intro/Source-port.png diff --git a/doc/sphinx/rules/Source.png b/doc/sphinx/rules/intro/Source.png similarity index 100% rename from doc/sphinx/rules/Source.png rename to doc/sphinx/rules/intro/Source.png diff --git a/doc/sphinx/rules/TCP-session.png b/doc/sphinx/rules/intro/TCP-session.png similarity index 100% rename from doc/sphinx/rules/TCP-session.png rename to doc/sphinx/rules/intro/TCP-session.png diff --git a/doc/sphinx/rules/action.png b/doc/sphinx/rules/intro/action.png similarity index 100% rename from doc/sphinx/rules/action.png rename to doc/sphinx/rules/intro/action.png diff --git a/doc/sphinx/rules/destination.png b/doc/sphinx/rules/intro/destination.png similarity index 100% rename from doc/sphinx/rules/destination.png rename to doc/sphinx/rules/intro/destination.png diff --git a/doc/sphinx/rules/intro_sig.png b/doc/sphinx/rules/intro/intro_sig.png similarity index 100% rename from doc/sphinx/rules/intro_sig.png rename to doc/sphinx/rules/intro/intro_sig.png diff --git a/doc/sphinx/rules/protocol.png b/doc/sphinx/rules/intro/protocol.png similarity index 100% rename from doc/sphinx/rules/protocol.png rename to doc/sphinx/rules/intro/protocol.png diff --git a/doc/sphinx/live-rule-swap.rst b/doc/sphinx/rules/live-rule-swap.rst similarity index 100% rename from doc/sphinx/live-rule-swap.rst rename to doc/sphinx/rules/live-rule-swap.rst diff --git a/doc/sphinx/meta.rst b/doc/sphinx/rules/meta.rst similarity index 100% rename from doc/sphinx/meta.rst rename to doc/sphinx/rules/meta.rst diff --git a/doc/sphinx/meta/classification.png b/doc/sphinx/rules/meta/classification.png similarity index 100% rename from doc/sphinx/meta/classification.png rename to doc/sphinx/rules/meta/classification.png diff --git a/doc/sphinx/meta/classtype.png b/doc/sphinx/rules/meta/classtype.png similarity index 100% rename from doc/sphinx/meta/classtype.png rename to doc/sphinx/rules/meta/classtype.png diff --git a/doc/sphinx/meta/gid.png b/doc/sphinx/rules/meta/gid.png similarity index 100% rename from doc/sphinx/meta/gid.png rename to doc/sphinx/rules/meta/gid.png diff --git a/doc/sphinx/meta/msg.png b/doc/sphinx/rules/meta/msg.png similarity index 100% rename from doc/sphinx/meta/msg.png rename to doc/sphinx/rules/meta/msg.png diff --git a/doc/sphinx/meta/reference.png b/doc/sphinx/rules/meta/reference.png similarity index 100% rename from doc/sphinx/meta/reference.png rename to doc/sphinx/rules/meta/reference.png diff --git a/doc/sphinx/meta/rev.png b/doc/sphinx/rules/meta/rev.png similarity index 100% rename from doc/sphinx/meta/rev.png rename to doc/sphinx/rules/meta/rev.png diff --git a/doc/sphinx/meta/sid.png b/doc/sphinx/rules/meta/sid.png similarity index 100% rename from doc/sphinx/meta/sid.png rename to doc/sphinx/rules/meta/sid.png diff --git a/doc/sphinx/modbus-keyword.rst b/doc/sphinx/rules/modbus-keyword.rst similarity index 100% rename from doc/sphinx/modbus-keyword.rst rename to doc/sphinx/rules/modbus-keyword.rst diff --git a/doc/sphinx/normalized-buffers.rst b/doc/sphinx/rules/normalized-buffers.rst similarity index 100% rename from doc/sphinx/normalized-buffers.rst rename to doc/sphinx/rules/normalized-buffers.rst diff --git a/doc/sphinx/normalized-buffers/normalization1.png b/doc/sphinx/rules/normalized-buffers/normalization1.png similarity index 100% rename from doc/sphinx/normalized-buffers/normalization1.png rename to doc/sphinx/rules/normalized-buffers/normalization1.png diff --git a/doc/sphinx/payload-keywords.rst b/doc/sphinx/rules/payload-keywords.rst similarity index 100% rename from doc/sphinx/payload-keywords.rst rename to doc/sphinx/rules/payload-keywords.rst diff --git a/doc/sphinx/payload-keywords/Legenda_rules.png b/doc/sphinx/rules/payload-keywords/Legenda_rules.png similarity index 100% rename from doc/sphinx/payload-keywords/Legenda_rules.png rename to doc/sphinx/rules/payload-keywords/Legenda_rules.png diff --git a/doc/sphinx/payload-keywords/content.png b/doc/sphinx/rules/payload-keywords/content.png similarity index 100% rename from doc/sphinx/payload-keywords/content.png rename to doc/sphinx/rules/payload-keywords/content.png diff --git a/doc/sphinx/payload-keywords/content2.png b/doc/sphinx/rules/payload-keywords/content2.png similarity index 100% rename from doc/sphinx/payload-keywords/content2.png rename to doc/sphinx/rules/payload-keywords/content2.png diff --git a/doc/sphinx/payload-keywords/content3.png b/doc/sphinx/rules/payload-keywords/content3.png similarity index 100% rename from doc/sphinx/payload-keywords/content3.png rename to doc/sphinx/rules/payload-keywords/content3.png diff --git a/doc/sphinx/payload-keywords/content4.png b/doc/sphinx/rules/payload-keywords/content4.png similarity index 100% rename from doc/sphinx/payload-keywords/content4.png rename to doc/sphinx/rules/payload-keywords/content4.png diff --git a/doc/sphinx/payload-keywords/content5.png b/doc/sphinx/rules/payload-keywords/content5.png similarity index 100% rename from doc/sphinx/payload-keywords/content5.png rename to doc/sphinx/rules/payload-keywords/content5.png diff --git a/doc/sphinx/payload-keywords/content6.png b/doc/sphinx/rules/payload-keywords/content6.png similarity index 100% rename from doc/sphinx/payload-keywords/content6.png rename to doc/sphinx/rules/payload-keywords/content6.png diff --git a/doc/sphinx/payload-keywords/distance.png b/doc/sphinx/rules/payload-keywords/distance.png similarity index 100% rename from doc/sphinx/payload-keywords/distance.png rename to doc/sphinx/rules/payload-keywords/distance.png diff --git a/doc/sphinx/payload-keywords/distance1.png b/doc/sphinx/rules/payload-keywords/distance1.png similarity index 100% rename from doc/sphinx/payload-keywords/distance1.png rename to doc/sphinx/rules/payload-keywords/distance1.png diff --git a/doc/sphinx/payload-keywords/distance3.png b/doc/sphinx/rules/payload-keywords/distance3.png similarity index 100% rename from doc/sphinx/payload-keywords/distance3.png rename to doc/sphinx/rules/payload-keywords/distance3.png diff --git a/doc/sphinx/payload-keywords/distance4.png b/doc/sphinx/rules/payload-keywords/distance4.png similarity index 100% rename from doc/sphinx/payload-keywords/distance4.png rename to doc/sphinx/rules/payload-keywords/distance4.png diff --git a/doc/sphinx/payload-keywords/distance5.png b/doc/sphinx/rules/payload-keywords/distance5.png similarity index 100% rename from doc/sphinx/payload-keywords/distance5.png rename to doc/sphinx/rules/payload-keywords/distance5.png diff --git a/doc/sphinx/payload-keywords/dsize.png b/doc/sphinx/rules/payload-keywords/dsize.png similarity index 100% rename from doc/sphinx/payload-keywords/dsize.png rename to doc/sphinx/rules/payload-keywords/dsize.png diff --git a/doc/sphinx/payload-keywords/isdataat1.png b/doc/sphinx/rules/payload-keywords/isdataat1.png similarity index 100% rename from doc/sphinx/payload-keywords/isdataat1.png rename to doc/sphinx/rules/payload-keywords/isdataat1.png diff --git a/doc/sphinx/payload-keywords/replace.png b/doc/sphinx/rules/payload-keywords/replace.png similarity index 100% rename from doc/sphinx/payload-keywords/replace.png rename to doc/sphinx/rules/payload-keywords/replace.png diff --git a/doc/sphinx/payload-keywords/replace1.png b/doc/sphinx/rules/payload-keywords/replace1.png similarity index 100% rename from doc/sphinx/payload-keywords/replace1.png rename to doc/sphinx/rules/payload-keywords/replace1.png diff --git a/doc/sphinx/payload-keywords/rpc.png b/doc/sphinx/rules/payload-keywords/rpc.png similarity index 100% rename from doc/sphinx/payload-keywords/rpc.png rename to doc/sphinx/rules/payload-keywords/rpc.png diff --git a/doc/sphinx/payload-keywords/within1.png b/doc/sphinx/rules/payload-keywords/within1.png similarity index 100% rename from doc/sphinx/payload-keywords/within1.png rename to doc/sphinx/rules/payload-keywords/within1.png diff --git a/doc/sphinx/payload-keywords/within2.png b/doc/sphinx/rules/payload-keywords/within2.png similarity index 100% rename from doc/sphinx/payload-keywords/within2.png rename to doc/sphinx/rules/payload-keywords/within2.png diff --git a/doc/sphinx/payload-keywords/within_distance.png b/doc/sphinx/rules/payload-keywords/within_distance.png similarity index 100% rename from doc/sphinx/payload-keywords/within_distance.png rename to doc/sphinx/rules/payload-keywords/within_distance.png diff --git a/doc/sphinx/payload-keywords/within_distance2.png b/doc/sphinx/rules/payload-keywords/within_distance2.png similarity index 100% rename from doc/sphinx/payload-keywords/within_distance2.png rename to doc/sphinx/rules/payload-keywords/within_distance2.png diff --git a/doc/sphinx/pcre.rst b/doc/sphinx/rules/pcre.rst similarity index 100% rename from doc/sphinx/pcre.rst rename to doc/sphinx/rules/pcre.rst diff --git a/doc/sphinx/pcre/pcre.png b/doc/sphinx/rules/pcre/pcre.png similarity index 100% rename from doc/sphinx/pcre/pcre.png rename to doc/sphinx/rules/pcre/pcre.png diff --git a/doc/sphinx/pcre/pcre3.png b/doc/sphinx/rules/pcre/pcre3.png similarity index 100% rename from doc/sphinx/pcre/pcre3.png rename to doc/sphinx/rules/pcre/pcre3.png diff --git a/doc/sphinx/pcre/pcre4.png b/doc/sphinx/rules/pcre/pcre4.png similarity index 100% rename from doc/sphinx/pcre/pcre4.png rename to doc/sphinx/rules/pcre/pcre4.png diff --git a/doc/sphinx/pcre/pcre5.png b/doc/sphinx/rules/pcre/pcre5.png similarity index 100% rename from doc/sphinx/pcre/pcre5.png rename to doc/sphinx/rules/pcre/pcre5.png diff --git a/doc/sphinx/pcre/pcre6.png b/doc/sphinx/rules/pcre/pcre6.png similarity index 100% rename from doc/sphinx/pcre/pcre6.png rename to doc/sphinx/rules/pcre/pcre6.png diff --git a/doc/sphinx/rule-lua-scripting.rst b/doc/sphinx/rules/rule-lua-scripting.rst similarity index 100% rename from doc/sphinx/rule-lua-scripting.rst rename to doc/sphinx/rules/rule-lua-scripting.rst diff --git a/doc/sphinx/rule-profiling.rst b/doc/sphinx/rules/rule-profiling.rst similarity index 100% rename from doc/sphinx/rule-profiling.rst rename to doc/sphinx/rules/rule-profiling.rst diff --git a/doc/sphinx/thresholding.rst b/doc/sphinx/rules/thresholding.rst similarity index 100% rename from doc/sphinx/thresholding.rst rename to doc/sphinx/rules/thresholding.rst diff --git a/doc/sphinx/tls-keywords.rst b/doc/sphinx/rules/tls-keywords.rst similarity index 100% rename from doc/sphinx/tls-keywords.rst rename to doc/sphinx/rules/tls-keywords.rst