]> git.ipfire.org Git - thirdparty/suricata.git/commitdiff
suricatasc: a Rust implementation of suricatasc
authorJason Ish <jason.ish@oisf.net>
Fri, 3 Mar 2023 14:54:07 +0000 (08:54 -0600)
committerVictor Julien <victor@inliniac.net>
Thu, 27 Feb 2025 05:57:45 +0000 (06:57 +0100)
This is a re-implementation of suricatasc program in Rust that
attempts to be a 100% drop-in replacement.

15 files changed:
configure.ac
python/Makefile.am
rust/Cargo.lock.in
rust/Cargo.toml.in
rust/Makefile.am
rust/suricatasc/Cargo.toml.in [new file with mode: 0644]
rust/suricatasc/LICENSE [new file with mode: 0644]
rust/suricatasc/Makefile.am [new file with mode: 0644]
rust/suricatasc/README.md [new file with mode: 0644]
rust/suricatasc/src/main.rs [new file with mode: 0644]
rust/suricatasc/src/unix/client.rs [new file with mode: 0644]
rust/suricatasc/src/unix/commands.rs [new file with mode: 0644]
rust/suricatasc/src/unix/main.rs [new file with mode: 0644]
rust/suricatasc/src/unix/mod.rs [new file with mode: 0644]
rust/suricatasc/src/unix/rustyprompt.rs [new file with mode: 0644]

index 1f989f3eac1e05a75197ce38fd48aac3a78bcf11..3fe429afe12e63ccb13885b2a751280821e1e708 100644 (file)
@@ -2537,6 +2537,7 @@ AM_CONDITIONAL([BUILD_SHARED_LIBRARY], [test "x$enable_shared" = "xyes"] && [tes
 
 AC_CONFIG_FILES(Makefile src/Makefile rust/Makefile rust/Cargo.lock rust/Cargo.toml rust/derive/Cargo.toml rust/.cargo/config.toml)
 AC_CONFIG_FILES(rust/sys/Makefile rust/sys/Cargo.toml)
+AC_CONFIG_FILES(rust/suricatasc/Makefile rust/suricatasc/Cargo.toml)
 AC_CONFIG_FILES(qa/Makefile qa/coccinelle/Makefile)
 AC_CONFIG_FILES(rules/Makefile doc/Makefile doc/userguide/Makefile)
 AC_CONFIG_FILES(contrib/Makefile contrib/file_processor/Makefile contrib/file_processor/Action/Makefile contrib/file_processor/Processor/Makefile)
index b3547192bd14c1cd8dc3b04e0c1c233fd817cf23..968f673376067ec976f97620865bd85bb1a4a915 100644 (file)
@@ -11,9 +11,7 @@ LIBS =        \
                suricata/sc/suricatasc.py \
                suricatasc/__init__.py
 
-BINS = \
-               suricatasc \
-               suricatactl
+BINS =         suricatactl
 
 EXTRA_DIST = $(LIBS) bin suricata/config/defaults.py
 
@@ -38,7 +36,6 @@ install-exec-local:
 
 uninstall-local:
        rm -f $(DESTDIR)$(bindir)/suricatactl
-       rm -f $(DESTDIR)$(bindir)/suricatasc
        rm -rf $(DESTDIR)$(prefix)/lib/suricata/python
 
 clean-local:
index f48fa14081028ff1da92f53a5ad887f9c2e9b006..a867f3966e0d223f5f74c7508a3af364f04f7c52 100644 (file)
@@ -69,9 +69,9 @@ dependencies = [
 
 [[package]]
 name = "allocator-api2"
-version = "0.2.18"
+version = "0.2.21"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "5c6cb57a04249c6480766f7f7cef5467412af1490f8d1e243141daddada3264f"
+checksum = "683d7910e743518b0e34f1186f92494becacb047c7b6bf616c96772180fef923"
 
 [[package]]
 name = "asn1-rs"
@@ -85,7 +85,7 @@ dependencies = [
  "nom",
  "num-traits 0.2.19",
  "rusticata-macros",
- "thiserror 1.0.68",
+ "thiserror 1.0.69",
  "time",
 ]
 
@@ -97,7 +97,7 @@ checksum = "965c2d33e53cb6b267e148a4cb0760bc01f4904c1cd4bb4002a085bb016d1490"
 dependencies = [
  "proc-macro2",
  "quote",
- "syn 2.0.87",
+ "syn 2.0.98",
  "synstructure 0.13.1",
 ]
 
@@ -109,7 +109,7 @@ checksum = "7b18050c2cd6fe86c3a76584ef5e0baf286d038cda203eb6223df2cc413565f7"
 dependencies = [
  "proc-macro2",
  "quote",
- "syn 2.0.87",
+ "syn 2.0.98",
 ]
 
 [[package]]
@@ -135,9 +135,15 @@ dependencies = [
 
 [[package]]
 name = "bitflags"
-version = "1.2.1"
+version = "1.3.2"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "cf1de2fe8c75bc145a2f577add951f8134889b4795d47466a54a5c846d691693"
+checksum = "bef38d45163c2f1dde094a7dfd33ccf595c92905c8f8f4fdc18d06fb1037718a"
+
+[[package]]
+name = "bitflags"
+version = "2.8.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "8f68f53c83ab957f72c32642f3868eec03eb974d1fb82e453128456482613d36"
 
 [[package]]
 name = "block-buffer"
@@ -196,11 +202,61 @@ dependencies = [
  "generic-array",
 ]
 
+[[package]]
+name = "clap"
+version = "4.2.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "6efb5f0a41b5ef5b50c5da28c07609c20091df0c1fc33d418fa2a7e693c2b624"
+dependencies = [
+ "clap_builder",
+ "clap_derive",
+ "once_cell",
+]
+
+[[package]]
+name = "clap_builder"
+version = "4.2.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "671fcaa5debda4b9a84aa7fde49c907c8986c0e6ab927e04217c9cb74e7c8bc9"
+dependencies = [
+ "bitflags 1.3.2",
+ "clap_lex",
+]
+
+[[package]]
+name = "clap_derive"
+version = "4.2.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "3f9644cd56d6b87dbe899ef8b053e331c0637664e9e21a33dfcdc36093f5c5c4"
+dependencies = [
+ "heck",
+ "proc-macro2",
+ "quote",
+ "syn 2.0.98",
+]
+
+[[package]]
+name = "clap_lex"
+version = "0.4.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "8a2dd5a6fe8c6e3502f568a6353e5273bbb15193ad9a89e457b9970798efbea1"
+
+[[package]]
+name = "clipboard-win"
+version = "4.5.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "7191c27c2357d9b7ef96baac1773290d4ca63b24205b82a3fd8a0637afcf0362"
+dependencies = [
+ "error-code",
+ "str-buf",
+ "winapi",
+]
+
 [[package]]
 name = "cpufeatures"
-version = "0.2.14"
+version = "0.2.17"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "608697df725056feaccfa42cffdaeeec3fccc4ffc38358ecd19b243e716a78e0"
+checksum = "59ed5838eebb26a2bb2e58f6d5b5316989ae9d08bab10e0e6d103e656d1b0280"
 dependencies = [
  "libc",
 ]
@@ -244,9 +300,9 @@ dependencies = [
 
 [[package]]
 name = "data-encoding"
-version = "2.6.0"
+version = "2.8.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "e8566979429cf69b49a5c740c60791108e86440e8be149bbea4fe54d2c32d6e2"
+checksum = "575f75dfd25738df5b91b8e43e14d44bda14637a58fae779fd2b064f8bf3e010"
 
 [[package]]
 name = "der-parser"
@@ -282,6 +338,27 @@ dependencies = [
  "subtle",
 ]
 
+[[package]]
+name = "dirs-next"
+version = "2.0.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "b98cf8ebf19c3d1b223e151f99a4f9f0690dca41414773390fc824184ac833e1"
+dependencies = [
+ "cfg-if",
+ "dirs-sys-next",
+]
+
+[[package]]
+name = "dirs-sys-next"
+version = "0.1.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "4ebda144c4fe02d1f7ea1a7d9641b6fc6b580adcfa024ae48797ecdeb6825b4d"
+dependencies = [
+ "libc",
+ "redox_users",
+ "winapi",
+]
+
 [[package]]
 name = "displaydoc"
 version = "0.2.5"
@@ -290,9 +367,15 @@ checksum = "97369cbbc041bc366949bc74d34658d6cda5621039731c6310521892a3a20ae0"
 dependencies = [
  "proc-macro2",
  "quote",
- "syn 2.0.87",
+ "syn 2.0.98",
 ]
 
+[[package]]
+name = "endian-type"
+version = "0.1.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "c34f04666d835ff5d62e058c3995147c06f42fe86ff053337632bca83e42702d"
+
 [[package]]
 name = "enum_primitive"
 version = "0.1.1"
@@ -304,9 +387,29 @@ dependencies = [
 
 [[package]]
 name = "equivalent"
-version = "1.0.1"
+version = "1.0.2"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "5443807d6dff69373d433ab9ef5378ad8df50ca6298caf15de6e52e24aaf54d5"
+checksum = "877a4ace8713b0bcf2a4e7eec82529c029f1d0619886d18145fea96c3ffe5c0f"
+
+[[package]]
+name = "errno"
+version = "0.3.10"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "33d852cb9b869c2a9b3df2f71a3074817f01e1844f839a144f5fcef059a4eb5d"
+dependencies = [
+ "libc",
+ "windows-sys 0.59.0",
+]
+
+[[package]]
+name = "error-code"
+version = "2.3.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "64f18991e7bf11e7ffee451b5318b5c1a73c52d0d0ada6e5a3017c8c1ced6a21"
+dependencies = [
+ "libc",
+ "str-buf",
+]
 
 [[package]]
 name = "failure"
@@ -329,11 +432,22 @@ dependencies = [
  "synstructure 0.12.6",
 ]
 
+[[package]]
+name = "fd-lock"
+version = "3.0.13"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "ef033ed5e9bad94e55838ca0ca906db0e043f517adda0c8b79c7a8c66c93c1b5"
+dependencies = [
+ "cfg-if",
+ "rustix",
+ "windows-sys 0.48.0",
+]
+
 [[package]]
 name = "flate2"
-version = "1.0.34"
+version = "1.0.35"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "a1b589b4dc103969ad3cf85c950899926ec64300a1a46d76c03a6072957036f0"
+checksum = "c936bfdafb507ebbf50b8074c54fa31c5be9a1e7e5f467dd659697041407d07c"
 dependencies = [
  "crc32fast",
  "miniz_oxide",
@@ -341,9 +455,9 @@ dependencies = [
 
 [[package]]
 name = "foldhash"
-version = "0.1.3"
+version = "0.1.4"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "f81ec6369c545a7d40e4589b5597581fa1c441fe1cce96dd1de43159910a36a2"
+checksum = "a0d2fde1f7b3d48b8395d5f2de76c18a528bd6a9cdde438df747bfcba3e05d6f"
 
 [[package]]
 name = "fs_extra"
@@ -384,15 +498,21 @@ dependencies = [
 
 [[package]]
 name = "hashbrown"
-version = "0.15.1"
+version = "0.15.2"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "3a9bfc1af68b1726ea47d3d5109de126281def866b33970e10fbab11b5dafab3"
+checksum = "bf151400ff0baff5465007dd2f3e717f3fe502074ca563069ce3a6629d07b289"
 dependencies = [
  "allocator-api2",
  "equivalent",
  "foldhash",
 ]
 
+[[package]]
+name = "heck"
+version = "0.4.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "95505c38b4572b2d910cecb0281560f54b440a19336cbbcb27bf6ce6adc6f5a8"
+
 [[package]]
 name = "hex"
 version = "0.4.3"
@@ -417,6 +537,16 @@ dependencies = [
  "digest",
 ]
 
+[[package]]
+name = "indexmap"
+version = "2.7.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "8c9c992b02b5b4c94ea26e32fe5bccb7aa7d9f390ab5c1221ff895bc7ea8b652"
+dependencies = [
+ "equivalent",
+ "hashbrown",
+]
+
 [[package]]
 name = "ipsec-parser"
 version = "0.7.0"
@@ -429,9 +559,9 @@ dependencies = [
 
 [[package]]
 name = "itoa"
-version = "1.0.11"
+version = "1.0.14"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "49f1f14873335454500d59611f1cf4a4b0f786f9ac11f4312a78e4cf2566695b"
+checksum = "d75a2a4b1b190afb6f5425f10f6a8f959d2ea0b9c2b1d79553551850539e4674"
 
 [[package]]
 name = "kerberos-parser"
@@ -458,14 +588,36 @@ checksum = "d9fde2bd93cf7db2fdba06379826baee0d5414ea093c8c1946701b5a6df046d3"
 dependencies = [
  "asn1-rs",
  "rusticata-macros",
- "thiserror 2.0.10",
+ "thiserror 2.0.11",
 ]
 
 [[package]]
 name = "libc"
-version = "0.2.161"
+version = "0.2.170"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "875b3680cb2f8f71bdcf9a30f38d48282f5d3c95cbf9b3fa57269bb5d5c06828"
+
+[[package]]
+name = "libredox"
+version = "0.1.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "c0ff37bd590ca25063e35af745c343cb7a0271906fb7b37e4813e8f79f00268d"
+dependencies = [
+ "bitflags 2.8.0",
+ "libc",
+]
+
+[[package]]
+name = "linux-raw-sys"
+version = "0.4.15"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "8e9489c2807c139ffd9c1794f4af0ebe86a828db53ecdc7fea2111d0fed085d1"
+checksum = "d26c52dbd32dccf2d10cac7725f8eae5296885fb5703b261f7d0a0739ec807ab"
+
+[[package]]
+name = "log"
+version = "0.4.26"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "30bde2b3dc3671ae49d8e2e9f044c7c005836e7a023ee57cffa25ab82764bb9e"
 
 [[package]]
 name = "lru"
@@ -510,13 +662,33 @@ checksum = "68354c5c6bd36d73ff3feceb05efa59b6acb7626617f4962be322a825e61f79a"
 
 [[package]]
 name = "miniz_oxide"
-version = "0.8.0"
+version = "0.8.5"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "e2d80299ef12ff69b16a84bb182e3b9df68b5a91574d3d4fa6e41b65deec4df1"
+checksum = "8e3e04debbb59698c15bacbb6d93584a8c0ca9cc3213cb423d31f760d8843ce5"
 dependencies = [
  "adler2",
 ]
 
+[[package]]
+name = "nibble_vec"
+version = "0.1.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "77a5d83df9f36fe23f0c3648c6bbb8b0298bb5f1939c8f2704431371f4b84d43"
+dependencies = [
+ "smallvec",
+]
+
+[[package]]
+name = "nix"
+version = "0.26.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "598beaf3cc6fdd9a5dfb1630c2800c7acd31df7aaf0f565796fba2b53ca1af1b"
+dependencies = [
+ "bitflags 1.3.2",
+ "cfg-if",
+ "libc",
+]
+
 [[package]]
 name = "nom"
 version = "7.1.3"
@@ -618,7 +790,7 @@ checksum = "ed3955f1a9c7c0c15e092f9c887db08b1fc683305fdf6eb6684f22555355e202"
 dependencies = [
  "proc-macro2",
  "quote",
- "syn 2.0.87",
+ "syn 2.0.98",
 ]
 
 [[package]]
@@ -701,6 +873,12 @@ dependencies = [
  "asn1-rs",
 ]
 
+[[package]]
+name = "once_cell"
+version = "1.20.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "945462a4b81e43c4e3ba96bd7b49d834c6f61198356aa858733bc4acf3cbe62e"
+
 [[package]]
 name = "opaque-debug"
 version = "0.3.1"
@@ -778,28 +956,38 @@ version = "1.1.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "1ebace6889caf889b4d3f76becee12e90353f2b8c7d875534a71e5742f8f6f83"
 dependencies = [
- "thiserror 1.0.68",
+ "thiserror 1.0.69",
  "toml",
 ]
 
 [[package]]
 name = "proc-macro2"
-version = "1.0.89"
+version = "1.0.93"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "f139b0662de085916d1fb67d2b4169d1addddda1919e696f3252b740b629986e"
+checksum = "60946a68e5f9d28b0dc1c21bb8a97ee7d018a8b322fa57838ba31cc878e22d99"
 dependencies = [
  "unicode-ident",
 ]
 
 [[package]]
 name = "quote"
-version = "1.0.37"
+version = "1.0.38"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "b5b9d34b8991d19d98081b46eacdd8eb58c6f2b201139f7c5f643cc155a633af"
+checksum = "0e4dccaaaf89514f546c693ddc140f729f958c247918a13380cccc6078391acc"
 dependencies = [
  "proc-macro2",
 ]
 
+[[package]]
+name = "radix_trie"
+version = "0.2.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "c069c179fcdc6a2fe24d8d18305cf085fdbd4f922c041943e203685d6a1c58fd"
+dependencies = [
+ "endian-type",
+ "nibble_vec",
+]
+
 [[package]]
 name = "rand"
 version = "0.8.5"
@@ -830,6 +1018,17 @@ dependencies = [
  "getrandom",
 ]
 
+[[package]]
+name = "redox_users"
+version = "0.4.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "ba009ff324d1fc1b900bd1fdb31564febe58a8ccc8a6fdbb93b543d33b13ca43"
+dependencies = [
+ "getrandom",
+ "libredox",
+ "thiserror 1.0.69",
+]
+
 [[package]]
 name = "regex"
 version = "1.5.6"
@@ -856,11 +1055,64 @@ dependencies = [
  "nom",
 ]
 
+[[package]]
+name = "rustix"
+version = "0.38.44"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "fdb5bc1ae2baa591800df16c9ca78619bf65c0488b41b96ccec5d11220d8c154"
+dependencies = [
+ "bitflags 2.8.0",
+ "errno",
+ "libc",
+ "linux-raw-sys",
+ "windows-sys 0.59.0",
+]
+
 [[package]]
 name = "rustversion"
-version = "1.0.18"
+version = "1.0.19"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "0e819f2bc632f285be6d7cd36e25940d45b2391dd6d9b939e79de557f7014248"
+checksum = "f7c45b9784283f1b2e7fb61b42047c2fd678ef0960d4f6f1eba131594cc369d4"
+
+[[package]]
+name = "rustyline"
+version = "11.0.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "5dfc8644681285d1fb67a467fb3021bfea306b99b4146b166a1fe3ada965eece"
+dependencies = [
+ "bitflags 1.3.2",
+ "cfg-if",
+ "clipboard-win",
+ "dirs-next",
+ "fd-lock",
+ "libc",
+ "log",
+ "memchr",
+ "nix",
+ "radix_trie",
+ "scopeguard",
+ "unicode-segmentation",
+ "unicode-width",
+ "utf8parse",
+ "winapi",
+]
+
+[[package]]
+name = "rustyline-derive"
+version = "0.9.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "5a32af5427251d2e4be14fc151eabe18abb4a7aad5efee7044da9f096c906a43"
+dependencies = [
+ "proc-macro2",
+ "quote",
+ "syn 2.0.98",
+]
+
+[[package]]
+name = "ryu"
+version = "1.0.19"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "6ea1a2d0a644769cc99faa24c3ad26b379b786fe7c36fd3c546254801650e6dd"
 
 [[package]]
 name = "sawp"
@@ -904,24 +1156,43 @@ dependencies = [
  "sawp-flags",
 ]
 
+[[package]]
+name = "scopeguard"
+version = "1.2.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "94143f37725109f92c262ed2cf5e59bce7498c01bcc1502d7b9afe439a4e9f49"
+
 [[package]]
 name = "serde"
-version = "1.0.214"
+version = "1.0.218"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "f55c3193aca71c12ad7890f1785d2b73e1b9f63a0bbc353c08ef26fe03fc56b5"
+checksum = "e8dfc9d19bdbf6d17e22319da49161d5d0108e4188e8b680aef6299eed22df60"
 dependencies = [
  "serde_derive",
 ]
 
 [[package]]
 name = "serde_derive"
-version = "1.0.214"
+version = "1.0.218"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "de523f781f095e28fa605cdce0f8307e451cc0fd14e2eb4cd2e98a355b147766"
+checksum = "f09503e191f4e797cb8aac08e9a4a4695c5edf6a2e70e376d961ddd5c969f82b"
 dependencies = [
  "proc-macro2",
  "quote",
- "syn 2.0.87",
+ "syn 2.0.98",
+]
+
+[[package]]
+name = "serde_json"
+version = "1.0.139"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "44f86c3acccc9c65b153fe1b85a3be07fe5515274ec9f0653b4a0875731c72a6"
+dependencies = [
+ "indexmap",
+ "itoa",
+ "memchr",
+ "ryu",
+ "serde",
 ]
 
 [[package]]
@@ -952,6 +1223,12 @@ version = "0.3.11"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "38b58827f4464d87d377d175e90bf58eb00fd8716ff0a62f80356b5e61555d0d"
 
+[[package]]
+name = "smallvec"
+version = "1.14.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "7fcf8323ef1faaee30a44a340193b1ac6814fd9b7b4e88e9d4519a3e4abe1cfd"
+
 [[package]]
 name = "snmp-parser"
 version = "0.10.0"
@@ -961,9 +1238,15 @@ dependencies = [
  "asn1-rs",
  "nom",
  "rusticata-macros",
- "thiserror 1.0.68",
+ "thiserror 1.0.69",
 ]
 
+[[package]]
+name = "str-buf"
+version = "1.0.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9e08d8363704e6c71fc928674353e6b7c23dcea9d82d7012c8faf2a3a025f8d0"
+
 [[package]]
 name = "subtle"
 version = "2.4.1"
@@ -979,7 +1262,7 @@ dependencies = [
  "asn1-rs",
  "base64",
  "bendy",
- "bitflags",
+ "bitflags 1.3.2",
  "brotli",
  "byteorder",
  "crc",
@@ -1042,6 +1325,18 @@ dependencies = [
 name = "suricata-sys"
 version = "8.0.0-dev"
 
+[[package]]
+name = "suricatasc"
+version = "8.0.0-dev"
+dependencies = [
+ "clap",
+ "rustyline",
+ "rustyline-derive",
+ "serde",
+ "serde_json",
+ "thiserror 1.0.69",
+]
+
 [[package]]
 name = "syn"
 version = "1.0.109"
@@ -1055,9 +1350,9 @@ dependencies = [
 
 [[package]]
 name = "syn"
-version = "2.0.87"
+version = "2.0.98"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "25aa4ce346d03a6dcd68dd8b4010bcb74e54e62c90c573f394c46eae99aba32d"
+checksum = "36147f1a48ae0ec2b5b3bc5b537d267457555a10dc06f3dbc8cb11ba3006d3b1"
 dependencies = [
  "proc-macro2",
  "quote",
@@ -1084,7 +1379,7 @@ checksum = "c8af7666ab7b6390ab78131fb5b0fce11d6b7a6951602017c35fa82800708971"
 dependencies = [
  "proc-macro2",
  "quote",
- "syn 2.0.87",
+ "syn 2.0.98",
 ]
 
 [[package]]
@@ -1105,7 +1400,7 @@ dependencies = [
  "cfg-if",
  "proc-macro2",
  "quote",
- "syn 2.0.87",
+ "syn 2.0.98",
 ]
 
 [[package]]
@@ -1116,55 +1411,55 @@ checksum = "5c89e72a01ed4c579669add59014b9a524d609c0c88c6a585ce37485879f6ffb"
 dependencies = [
  "proc-macro2",
  "quote",
- "syn 2.0.87",
+ "syn 2.0.98",
  "test-case-core",
 ]
 
 [[package]]
 name = "thiserror"
-version = "1.0.68"
+version = "1.0.69"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "02dd99dc800bbb97186339685293e1cc5d9df1f8fae2d0aecd9ff1c77efea892"
+checksum = "b6aaf5339b578ea85b50e080feb250a3e8ae8cfcdff9a461c9ec2904bc923f52"
 dependencies = [
- "thiserror-impl 1.0.68",
+ "thiserror-impl 1.0.69",
 ]
 
 [[package]]
 name = "thiserror"
-version = "2.0.10"
+version = "2.0.11"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "a3ac7f54ca534db81081ef1c1e7f6ea8a3ef428d2fc069097c079443d24124d3"
+checksum = "d452f284b73e6d76dd36758a0c8684b1d5be31f92b89d07fd5822175732206fc"
 dependencies = [
- "thiserror-impl 2.0.10",
+ "thiserror-impl 2.0.11",
 ]
 
 [[package]]
 name = "thiserror-impl"
-version = "1.0.68"
+version = "1.0.69"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "a7c61ec9a6f64d2793d8a45faba21efbe3ced62a886d44c36a009b2b519b4c7e"
+checksum = "4fee6c4efc90059e10f81e6d42c60a18f76588c3d74cb83a0b242a2b6c7504c1"
 dependencies = [
  "proc-macro2",
  "quote",
- "syn 2.0.87",
+ "syn 2.0.98",
 ]
 
 [[package]]
 name = "thiserror-impl"
-version = "2.0.10"
+version = "2.0.11"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "9e9465d30713b56a37ede7185763c3492a91be2f5fa68d958c44e41ab9248beb"
+checksum = "26afc1baea8a989337eeb52b6e72a039780ce45c3edfcc9c5b9d112feeb173c2"
 dependencies = [
  "proc-macro2",
  "quote",
- "syn 2.0.87",
+ "syn 2.0.98",
 ]
 
 [[package]]
 name = "time"
-version = "0.3.36"
+version = "0.3.37"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "5dfd88e563464686c916c7e46e623e520ddc6d79fa6641390f2e3fa86e83e885"
+checksum = "35e7868883861bd0e56d9ac6efcaaca0d6d5d82a2a7ec8209ff492c07cf37b21"
 dependencies = [
  "deranged",
  "itoa",
@@ -1183,9 +1478,9 @@ checksum = "ef927ca75afb808a4d64dd374f00a2adf8d0fcff8e7b184af886c3c87ec4a3f3"
 
 [[package]]
 name = "time-macros"
-version = "0.2.18"
+version = "0.2.19"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "3f252a68540fde3a3877aeea552b832b40ab9a69e318efd078774a01ddee1ccf"
+checksum = "2834e6017e3e5e4b9834939793b282bc03b37a3336245fa820e35e233e2a85de"
 dependencies = [
  "num-conv",
  "time-core",
@@ -1216,15 +1511,27 @@ dependencies = [
 
 [[package]]
 name = "typenum"
-version = "1.17.0"
+version = "1.18.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "42ff0bf0c66b8238c6f3b578df37d0b7848e55df8577b3f74f92a69acceeb825"
+checksum = "1dccffe3ce07af9386bfd29e80c0ab1a8205a2fc34e4bcd40364df902cfa8f3f"
 
 [[package]]
 name = "unicode-ident"
-version = "1.0.13"
+version = "1.0.17"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "00e2473a93778eb0bad35909dff6a10d28e63f792f16ed15e404fca9d5eeedbe"
+
+[[package]]
+name = "unicode-segmentation"
+version = "1.12.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "f6ccf251212114b54433ec949fd6a7841275f9ada20dddd2f29e9ceea4501493"
+
+[[package]]
+name = "unicode-width"
+version = "0.1.14"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "e91b56cd4cadaeb79bbf1a5645f6b4f8dc5bde8834ad5894a8db35fda9efa1fe"
+checksum = "7dd6e30e90baa6f72411720665d41d89b9a3d039dc45b8faea1ddd07f617f6af"
 
 [[package]]
 name = "unicode-xid"
@@ -1242,6 +1549,12 @@ dependencies = [
  "subtle",
 ]
 
+[[package]]
+name = "utf8parse"
+version = "0.2.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "06abde3611657adf66d383f00b093d7faecc7fa57071cce2578660c9f1010821"
+
 [[package]]
 name = "uuid"
 version = "0.8.2"
@@ -1266,6 +1579,167 @@ version = "0.4.3"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "c168940144dd21fd8046987c16a46a33d5fc84eec29ef9dcddc2ac9e31526b7c"
 
+[[package]]
+name = "winapi"
+version = "0.3.9"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "5c839a674fcd7a98952e593242ea400abe93992746761e38641405d28b00f419"
+dependencies = [
+ "winapi-i686-pc-windows-gnu",
+ "winapi-x86_64-pc-windows-gnu",
+]
+
+[[package]]
+name = "winapi-i686-pc-windows-gnu"
+version = "0.4.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "ac3b87c63620426dd9b991e5ce0329eff545bccbbb34f3be09ff6fb6ab51b7b6"
+
+[[package]]
+name = "winapi-x86_64-pc-windows-gnu"
+version = "0.4.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "712e227841d057c1ee1cd2fb22fa7e5a5461ae8e48fa2ca79ec42cfc1931183f"
+
+[[package]]
+name = "windows-sys"
+version = "0.48.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "677d2418bec65e3338edb076e806bc1ec15693c5d0104683f2efe857f61056a9"
+dependencies = [
+ "windows-targets 0.48.5",
+]
+
+[[package]]
+name = "windows-sys"
+version = "0.59.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "1e38bc4d79ed67fd075bcc251a1c39b32a1776bbe92e5bef1f0bf1f8c531853b"
+dependencies = [
+ "windows-targets 0.52.6",
+]
+
+[[package]]
+name = "windows-targets"
+version = "0.48.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9a2fa6e2155d7247be68c096456083145c183cbbbc2764150dda45a87197940c"
+dependencies = [
+ "windows_aarch64_gnullvm 0.48.5",
+ "windows_aarch64_msvc 0.48.5",
+ "windows_i686_gnu 0.48.5",
+ "windows_i686_msvc 0.48.5",
+ "windows_x86_64_gnu 0.48.5",
+ "windows_x86_64_gnullvm 0.48.5",
+ "windows_x86_64_msvc 0.48.5",
+]
+
+[[package]]
+name = "windows-targets"
+version = "0.52.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9b724f72796e036ab90c1021d4780d4d3d648aca59e491e6b98e725b84e99973"
+dependencies = [
+ "windows_aarch64_gnullvm 0.52.6",
+ "windows_aarch64_msvc 0.52.6",
+ "windows_i686_gnu 0.52.6",
+ "windows_i686_gnullvm",
+ "windows_i686_msvc 0.52.6",
+ "windows_x86_64_gnu 0.52.6",
+ "windows_x86_64_gnullvm 0.52.6",
+ "windows_x86_64_msvc 0.52.6",
+]
+
+[[package]]
+name = "windows_aarch64_gnullvm"
+version = "0.48.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "2b38e32f0abccf9987a4e3079dfb67dcd799fb61361e53e2882c3cbaf0d905d8"
+
+[[package]]
+name = "windows_aarch64_gnullvm"
+version = "0.52.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "32a4622180e7a0ec044bb555404c800bc9fd9ec262ec147edd5989ccd0c02cd3"
+
+[[package]]
+name = "windows_aarch64_msvc"
+version = "0.48.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "dc35310971f3b2dbbf3f0690a219f40e2d9afcf64f9ab7cc1be722937c26b4bc"
+
+[[package]]
+name = "windows_aarch64_msvc"
+version = "0.52.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "09ec2a7bb152e2252b53fa7803150007879548bc709c039df7627cabbd05d469"
+
+[[package]]
+name = "windows_i686_gnu"
+version = "0.48.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "a75915e7def60c94dcef72200b9a8e58e5091744960da64ec734a6c6e9b3743e"
+
+[[package]]
+name = "windows_i686_gnu"
+version = "0.52.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "8e9b5ad5ab802e97eb8e295ac6720e509ee4c243f69d781394014ebfe8bbfa0b"
+
+[[package]]
+name = "windows_i686_gnullvm"
+version = "0.52.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "0eee52d38c090b3caa76c563b86c3a4bd71ef1a819287c19d586d7334ae8ed66"
+
+[[package]]
+name = "windows_i686_msvc"
+version = "0.48.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "8f55c233f70c4b27f66c523580f78f1004e8b5a8b659e05a4eb49d4166cca406"
+
+[[package]]
+name = "windows_i686_msvc"
+version = "0.52.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "240948bc05c5e7c6dabba28bf89d89ffce3e303022809e73deaefe4f6ec56c66"
+
+[[package]]
+name = "windows_x86_64_gnu"
+version = "0.48.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "53d40abd2583d23e4718fddf1ebec84dbff8381c07cae67ff7768bbf19c6718e"
+
+[[package]]
+name = "windows_x86_64_gnu"
+version = "0.52.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "147a5c80aabfbf0c7d901cb5895d1de30ef2907eb21fbbab29ca94c5b08b1a78"
+
+[[package]]
+name = "windows_x86_64_gnullvm"
+version = "0.48.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "0b7b52767868a23d5bab768e390dc5f5c55825b6d30b86c844ff2dc7414044cc"
+
+[[package]]
+name = "windows_x86_64_gnullvm"
+version = "0.52.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "24d5b23dc417412679681396f2b49f3de8c1473deb516bd34410872eff51ed0d"
+
+[[package]]
+name = "windows_x86_64_msvc"
+version = "0.48.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "ed94fce61571a4006852b7389a063ab983c02eb1bb37b47f8272ce92d06d9538"
+
+[[package]]
+name = "windows_x86_64_msvc"
+version = "0.52.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "589f6da84c646204747d1270a2a5661ea66ed1cced2631d546fdfb155959f9ec"
+
 [[package]]
 name = "x509-parser"
 version = "0.16.0"
@@ -1279,7 +1753,7 @@ dependencies = [
  "nom",
  "oid-registry",
  "rusticata-macros",
- "thiserror 1.0.68",
+ "thiserror 1.0.69",
  "time",
 ]
 
@@ -1301,5 +1775,5 @@ checksum = "fa4f8080344d4671fb4e831a13ad1e68092748387dfc4f55e356242fae12ce3e"
 dependencies = [
  "proc-macro2",
  "quote",
- "syn 2.0.87",
+ "syn 2.0.98",
 ]
index b01e4c570c4709e6716a23e6fdefa0a2b2c8088c..fd4613b9eac5a65a07a6ca092c61f6a66a0ee4ea 100644 (file)
@@ -7,7 +7,17 @@ edition = "2021"
 rust-version = "1.67.1"
 
 [workspace]
-members = [".", "./derive", "sys"]
+members = [
+    ".",
+    "derive",
+    "suricatasc",
+    "sys",
+]
+
+default-members = [
+    ".",
+    "suricatasc",
+]
 
 [lib]
 crate-type = ["staticlib", "rlib"]
@@ -25,7 +35,7 @@ ja4 = []
 
 [dependencies]
 nom7 = { version="7.0", package="nom" }
-bitflags = "~1.2.1"
+bitflags = "~1.3.2"
 byteorder = "~1.4.2"
 uuid = "~0.8.2"
 crc = "~1.8.1"
index a258003a8af9d966976e2af3cdd45835b40c4cbd..3630fdab8951e929aecd2559aee9f73f26cff6d9 100644 (file)
@@ -1,4 +1,5 @@
-SUBDIRS =      sys
+SUBDIRS =      sys \
+               suricatasc
 
 EXTRA_DIST =   src derive \
                .cargo/config.toml.in \
@@ -8,7 +9,8 @@ EXTRA_DIST =    src derive \
                Cargo.toml Cargo.lock \
                derive/Cargo.toml \
                sys \
-               sys/Cargo.toml
+               sys/Cargo.toml \
+               suricatasc
 
 if !DEBUG
 RELEASE = --release
@@ -50,6 +52,8 @@ CARGO_ENV =   @rustup_home@ \
                SURICATA_LUA_SYS_HEADER_DST="$(abs_top_builddir)/rust/gen"
 endif
 
+CARGO_ENV +=   LOCALSTATEDIR=$(e_localstatedir)
+
 all-local: Cargo.toml
        mkdir -p $(abs_top_builddir)/rust/gen
        cd $(abs_top_srcdir)/rust && \
@@ -66,12 +70,17 @@ all-local: Cargo.toml
        fi
        $(MAKE) gen/rust-bindings.h
 
+install-exec-local:
+       install -d -m 0755 "$(DESTDIR)$(bindir)"
+       install -m 0755 $(RUST_SURICATA_LIBDIR)/suricatasc "$(DESTDIR)$(bindir)/suricatasc"
+
 install-library:
        $(MKDIR_P) "$(DESTDIR)$(libdir)"
        $(INSTALL_DATA) $(RUST_SURICATA_LIB) "$(DESTDIR)$(libdir)"
 
 uninstall-local:
        rm -f "$(DESTDIR)$(libdir)/$(RUST_SURICATA_LIBNAME)"
+       rm -f "$(DESTDIR)$(bindir)/suricatasc"
 
 clean-local:
        rm -rf target gen
diff --git a/rust/suricatasc/Cargo.toml.in b/rust/suricatasc/Cargo.toml.in
new file mode 100644 (file)
index 0000000..0bc495e
--- /dev/null
@@ -0,0 +1,23 @@
+[package]
+name = "suricatasc"
+version = "@PACKAGE_VERSION@"
+edition = "2021"
+license = "GPL-2.0-only"
+description = "Suricata socket control program"
+readme = "README.md"
+
+[[bin]]
+name = "suricatasc"
+
+[dependencies]
+# 4.0 is the newest version that builds with Rust 1.67.1.
+clap = { version = "=4.2.0", default-features = false, features = ["std", "derive", "help", "usage"] }
+
+# Need to pin back for Rust 1.67.1
+rustyline = { version = "=11.0.0" }
+rustyline-derive = { version = "0.9.0" }
+
+thiserror = { version = "1.0.40" }
+
+serde = { version = "1.0.216", default-features = false, features = ["derive"] }
+serde_json = { version = "1.0.133", default-features = false, features = ["preserve_order"] }
diff --git a/rust/suricatasc/LICENSE b/rust/suricatasc/LICENSE
new file mode 100644 (file)
index 0000000..d159169
--- /dev/null
@@ -0,0 +1,339 @@
+                    GNU GENERAL PUBLIC LICENSE
+                       Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+                            Preamble
+
+  The licenses for most software are designed to take away your
+freedom to share and change it.  By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users.  This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it.  (Some other Free Software Foundation software is covered by
+the GNU Lesser General Public License instead.)  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+  To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have.  You must make sure that they, too, receive or can get the
+source code.  And you must show them these terms so they know their
+rights.
+
+  We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+  Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software.  If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+  Finally, any free program is threatened constantly by software
+patents.  We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary.  To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+                    GNU GENERAL PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License.  The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language.  (Hereinafter, translation is included without limitation in
+the term "modification".)  Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope.  The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+  1. You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+  2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+    a) You must cause the modified files to carry prominent notices
+    stating that you changed the files and the date of any change.
+
+    b) You must cause any work that you distribute or publish, that in
+    whole or in part contains or is derived from the Program or any
+    part thereof, to be licensed as a whole at no charge to all third
+    parties under the terms of this License.
+
+    c) If the modified program normally reads commands interactively
+    when run, you must cause it, when started running for such
+    interactive use in the most ordinary way, to print or display an
+    announcement including an appropriate copyright notice and a
+    notice that there is no warranty (or else, saying that you provide
+    a warranty) and that users may redistribute the program under
+    these conditions, and telling the user how to view a copy of this
+    License.  (Exception: if the Program itself is interactive but
+    does not normally print such an announcement, your work based on
+    the Program is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole.  If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works.  But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+  3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+    a) Accompany it with the complete corresponding machine-readable
+    source code, which must be distributed under the terms of Sections
+    1 and 2 above on a medium customarily used for software interchange; or,
+
+    b) Accompany it with a written offer, valid for at least three
+    years, to give any third party, for a charge no more than your
+    cost of physically performing source distribution, a complete
+    machine-readable copy of the corresponding source code, to be
+    distributed under the terms of Sections 1 and 2 above on a medium
+    customarily used for software interchange; or,
+
+    c) Accompany it with the information you received as to the offer
+    to distribute corresponding source code.  (This alternative is
+    allowed only for noncommercial distribution and only if you
+    received the program in object code or executable form with such
+    an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it.  For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable.  However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+  4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License.  Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+  5. You are not required to accept this License, since you have not
+signed it.  However, nothing else grants you permission to modify or
+distribute the Program or its derivative works.  These actions are
+prohibited by law if you do not accept this License.  Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+  6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions.  You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+  7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all.  For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices.  Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+  8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded.  In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+  9. The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number.  If the Program
+specifies a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation.  If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+  10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission.  For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this.  Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+                            NO WARRANTY
+
+  11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+  12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+                     END OF TERMS AND CONDITIONS
+
+            How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License along
+    with this program; if not, write to the Free Software Foundation, Inc.,
+    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+    Gnomovision version 69, Copyright (C) year name of author
+    Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, the commands you use may
+be called something other than `show w' and `show c'; they could even be
+mouse-clicks or menu items--whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary.  Here is a sample; alter the names:
+
+  Yoyodyne, Inc., hereby disclaims all copyright interest in the program
+  `Gnomovision' (which makes passes at compilers) written by James Hacker.
+
+  <signature of Ty Coon>, 1 April 1989
+  Ty Coon, President of Vice
+
+This General Public License does not permit incorporating your program into
+proprietary programs.  If your program is a subroutine library, you may
+consider it more useful to permit linking proprietary applications with the
+library.  If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.
diff --git a/rust/suricatasc/Makefile.am b/rust/suricatasc/Makefile.am
new file mode 100644 (file)
index 0000000..acf00ae
--- /dev/null
@@ -0,0 +1,3 @@
+EXTRA_DIST =   Cargo.toml
+
+all-local: Cargo.toml
diff --git a/rust/suricatasc/README.md b/rust/suricatasc/README.md
new file mode 100644 (file)
index 0000000..a2e62d4
--- /dev/null
@@ -0,0 +1,3 @@
+# suricatasc
+
+A replacement `suricatasc` written in Rust.
diff --git a/rust/suricatasc/src/main.rs b/rust/suricatasc/src/main.rs
new file mode 100644 (file)
index 0000000..884c87c
--- /dev/null
@@ -0,0 +1,15 @@
+// SPDX-FileCopyrightText: Copyright 2023 Open Information Security Foundation
+// SPDX-License-Identifier: GPL-2.0-only
+
+#[cfg(not(target_os = "windows"))]
+mod unix;
+
+#[cfg(not(target_os = "windows"))]
+fn main() -> Result<(), Box<dyn std::error::Error>> {
+    crate::unix::main::main()
+}
+
+#[cfg(target_os = "windows")]
+fn main() {
+    println!("suricatasc is not supported on Windows");
+}
diff --git a/rust/suricatasc/src/unix/client.rs b/rust/suricatasc/src/unix/client.rs
new file mode 100644 (file)
index 0000000..0c2d381
--- /dev/null
@@ -0,0 +1,87 @@
+// SPDX-FileCopyrightText: Copyright 2023 Open Information Security Foundation
+// SPDX-License-Identifier: MIT
+
+use serde::Deserialize;
+use serde::Serialize;
+use serde_json::json;
+use std::io::{BufRead, BufReader, Write};
+use std::os::unix::net::UnixStream;
+use thiserror::Error;
+
+#[derive(Debug, Error)]
+pub enum ClientError {
+    #[error("ioerror: `{0}`")]
+    IoError(#[from] std::io::Error),
+    #[error("serde error: `{0}`")]
+    DeserializeError(#[from] serde_json::Error),
+    #[error("connection closed")]
+    Closed,
+}
+
+pub struct Client {
+    socket: UnixStream,
+
+    // If set, the client will print to stdout the messages sent and
+    // received. Primarily useful when running with the interactive
+    // client in verbose mode.
+    verbose: bool,
+}
+
+impl Client {
+    pub fn connect<T: AsRef<str>>(filename: T, verbose: bool) -> Result<Self, ClientError> {
+        let filename = filename.as_ref().to_string();
+        let socket = UnixStream::connect(filename)?;
+        let mut client = Self { socket, verbose };
+        client.handshake()?;
+        Ok(client)
+    }
+
+    fn handshake(&mut self) -> Result<(), ClientError> {
+        self.send(&json!({"version": "0.2"}))?;
+        self.read().map(serde_json::from_value::<Response>)??;
+        Ok(())
+    }
+
+    pub fn send<T>(&mut self, msg: &T) -> Result<(), std::io::Error>
+    where
+        T: ?Sized + Serialize,
+    {
+        let mut encoded = serde_json::to_string(&msg)?;
+        if self.verbose {
+            println!("SND: {}", &encoded);
+        }
+        encoded.push('\n');
+        self.socket.write_all(encoded.as_bytes())?;
+        Ok(())
+    }
+
+    /// Read a line of data from the client.
+    ///
+    /// An empty line means the server has disconnected.
+    pub fn read_line(&self) -> Result<String, ClientError> {
+        let mut reader = BufReader::new(&self.socket);
+        let mut response = String::new();
+        reader.read_line(&mut response)?;
+        if self.verbose {
+            println!("RCV: {}", response.trim_end());
+        }
+        Ok(response)
+    }
+
+    pub fn read(&self) -> Result<serde_json::Value, ClientError> {
+        let line = self.read_line()?;
+        if line.is_empty() {
+            return Err(ClientError::Closed);
+        }
+        let decoded = serde_json::from_str(&line)?;
+        Ok(decoded)
+    }
+}
+
+#[derive(Debug, Deserialize)]
+pub struct Response {
+    #[serde(rename = "return")]
+    pub status: String,
+    #[serde(default)]
+    pub message: serde_json::Value,
+}
diff --git a/rust/suricatasc/src/unix/commands.rs b/rust/suricatasc/src/unix/commands.rs
new file mode 100644 (file)
index 0000000..707e934
--- /dev/null
@@ -0,0 +1,427 @@
+// SPDX-FileCopyrightText: Copyright 2023 Open Information Security Foundation
+// SPDX-License-Identifier: GPL-2.0-only
+
+use serde::Deserialize;
+use serde_json::json;
+use std::{collections::HashMap, num::ParseIntError, str::FromStr};
+use thiserror::Error;
+
+#[derive(Debug, Error)]
+pub enum CommandParseError {
+    #[error("Unknown command {0}")]
+    UnknownCommand(String),
+    #[error("Failed to parse as number")]
+    ParseIntError(#[from] ParseIntError),
+    #[error("`{0}`")]
+    Other(String),
+}
+
+#[derive(Debug, Copy, Clone, Deserialize)]
+#[serde(rename_all = "lowercase")]
+pub enum ArgType {
+    String,
+    Number,
+    Bool,
+    #[serde(rename = "number[]")]
+    NumberArray,
+}
+
+#[derive(Clone)]
+pub struct Commands {
+    /// The list of parsed command the client knows about.
+    pub commands: HashMap<String, Vec<Argument>>,
+
+    /// A list of commands from the server. This is used to:
+    /// - augment the list of known commands
+    /// - error out on commands not given by Suricata as not all
+    ///   command are valid in all running modes.
+    server_commands: Vec<String>,
+}
+
+impl Commands {
+    pub fn new(server_commands: Vec<String>) -> Self {
+        let mut commands = command_defs().unwrap();
+        for command in &server_commands {
+            if !commands.contains_key(command) {
+                commands.insert(command.to_string(), vec![]);
+            }
+        }
+        Self {
+            commands,
+            server_commands,
+        }
+    }
+
+    pub fn get(&self, command: &str) -> Option<&Vec<Argument>> {
+        self.commands.get(command)
+    }
+
+    pub fn is_valid(&self, command: &str) -> bool {
+        self.server_commands.iter().any(|c| c == command)
+    }
+}
+
+pub struct CommandParser<'a> {
+    pub commands: &'a Commands,
+}
+
+impl<'a> CommandParser<'a> {
+    pub fn new(commands: &'a Commands) -> Self {
+        Self { commands }
+    }
+
+    pub fn parse(&self, input: &str) -> Result<serde_json::Value, CommandParseError> {
+        let parts: Vec<&str> = input.split(' ').map(|s| s.trim()).collect();
+        if parts.is_empty() {
+            return Err(CommandParseError::Other("No command provided".to_string()));
+        }
+        let command = parts[0];
+        let args = &parts[1..];
+
+        let spec = self
+            .commands
+            .get(command)
+            .ok_or(CommandParseError::UnknownCommand(command.to_string()))?;
+
+        if !self.commands.is_valid(command) {
+            return Err(CommandParseError::Other(
+                "Command not valid for current Suricata running-mode".to_string(),
+            ));
+        }
+
+        // Calculate the number of required arguments for better error reporting.
+        let required = spec.iter().filter(|e| e.required).count();
+
+        let mut json_args = HashMap::new();
+
+        for (i, spec) in spec.iter().enumerate() {
+            if let Some(arg) = args.get(i) {
+                let val = match spec.datatype {
+                    ArgType::String => serde_json::Value::String(arg.to_string()),
+                    ArgType::Bool => match *arg {
+                        "true" | "1" => true.into(),
+                        "false" | "0" => false.into(),
+                        _ => {
+                            return Err(CommandParseError::Other(format!(
+                                "Bad argument: value is not a boolean: {}",
+                                arg
+                            )));
+                        }
+                    },
+                    ArgType::Number => {
+                        let number = serde_json::Number::from_str(arg).map_err(|_| {
+                            CommandParseError::Other(format!("Bad argument: not a number: {}", arg))
+                        })?;
+                        serde_json::Value::Number(number)
+                    }
+                    ArgType::NumberArray => {
+                        let mut numbers = vec![];
+                        for arg in &args[i..] {
+                            numbers.push(arg.parse::<u16>()?);
+                        }
+                        let json: serde_json::Value = numbers.into();
+                        dbg!(json);
+                        panic!();
+                    }
+                };
+                json_args.insert(&spec.name, val);
+            } else if spec.required {
+                return Err(CommandParseError::Other(format!(
+                    "Missing arguments: expected at least {}",
+                    required
+                )));
+            }
+        }
+
+        let mut message = json!({ "command": command });
+        if !json_args.is_empty() {
+            message["arguments"] = json!(json_args);
+        }
+
+        Ok(message)
+    }
+}
+
+#[derive(Debug, Deserialize, Clone)]
+pub struct Argument {
+    pub name: String,
+    pub required: bool,
+    #[serde(rename = "type")]
+    pub datatype: ArgType,
+    pub _value: Option<serde_json::Value>,
+}
+
+fn command_defs() -> Result<HashMap<String, Vec<Argument>>, serde_json::Error> {
+    // As found in specs.py.
+    #[rustfmt::skip]
+    let defs = json!({
+       "pcap-file": [
+            {
+               "name": "filename",
+               "required": true,
+               "type": "string",
+            },
+            {
+               "name": "output-dir",
+               "required": true,
+               "type": "string",
+            },
+            {
+               "name": "tenant",
+               "type": "number",
+               "required": false,
+            },
+            {
+               "name": "continuous",
+               "required": false,
+               "type": "bool",
+            },
+            {
+               "name": "delete-when-done",
+               "required": false,
+               "type": "bool",
+            },
+       ],
+       "pcap-file-continuous": [
+            {
+               "name": "filename",
+               "required": true,
+               "type": "string",
+            },
+            {
+               "name": "output-dir",
+               "required": true,
+               "type": "string",
+            },
+            {
+               "name": "continuous",
+               "required": true,
+               "type": "bool",
+               "value": true,
+            },
+            {
+               "name": "tenant",
+               "type": "number",
+               "required": false,
+            },
+            {
+               "name": "delete-when-done",
+               "required": false,
+               "type": "bool",
+            },
+       ],
+       "shutdown": [],
+       "quit": [],
+       "pcap-file-number": [],
+       "pcap-file-list": [],
+       "pcap-file-processed": [],
+       "pcap-interrupt": [],
+       "iface-list": [],
+       "iface-stat": [
+            {
+               "name": "iface",
+               "required": true,
+               "type": "string",
+            },
+       ],
+       "conf-get": [
+            {
+               "name": "variable",
+               "required": true,
+               "type": "string",
+            }
+       ],
+       "unregister-tenant-handler": [
+            {
+               "name": "id",
+               "type": "number",
+               "required": true,
+            },
+            {
+               "name": "htype",
+               "required": true,
+               "type": "string",
+            },
+            {
+               "name": "hargs",
+               "type": "number",
+               "required": false,
+            },
+       ],
+       "register-tenant-handler": [
+            {
+               "name": "id",
+               "type": "number",
+               "required": true,
+            },
+            {
+               "name": "htype",
+               "required": true,
+               "type": "string",
+            },
+            {
+               "name": "hargs",
+               "type": "number[]",
+               "required": false,
+            },
+       ],
+       "unregister-tenant": [
+            {
+               "name": "id",
+               "type": "number",
+               "required": true,
+            },
+       ],
+       "register-tenant": [
+            {
+               "name": "id",
+               "type": "number",
+               "required": true,
+            },
+            {
+               "name": "filename",
+               "required": true,
+               "type": "string",
+            },
+       ],
+       "reload-tenant": [
+            {
+               "name": "id",
+               "type": "number",
+               "required": true,
+            },
+            {
+               "name": "filename",
+               "required": false,
+               "type": "string",
+            },
+       ],
+        "reload-tenants": [],
+       "add-hostbit": [
+            {
+               "name": "ipaddress",
+               "required": true,
+               "type": "string",
+            },
+            {
+               "name": "hostbit",
+               "required": true,
+               "type": "string",
+            },
+            {
+               "name": "expire",
+               "type": "number",
+               "required": true,
+            },
+       ],
+       "remove-hostbit": [
+            {
+               "name": "ipaddress",
+               "required": true,
+               "type": "string",
+            },
+            {
+               "name": "hostbit",
+               "required": true,
+               "type": "string",
+            },
+       ],
+       "list-hostbit": [
+            {
+               "name": "ipaddress",
+               "required": true,
+               "type": "string",
+            },
+       ],
+       "memcap-set": [
+            {
+               "name": "config",
+               "required": true,
+               "type": "string",
+            },
+            {
+               "name": "memcap",
+               "required": true,
+               "type": "string",
+            },
+       ],
+       "memcap-show": [
+            {
+               "name": "config",
+               "required": true,
+               "type": "string",
+            },
+       ],
+       "dataset-add": [
+            {
+               "name": "setname",
+               "required": true,
+               "type": "string",
+            },
+            {
+               "name": "settype",
+               "required": true,
+               "type": "string",
+            },
+            {
+               "name": "datavalue",
+               "required": true,
+               "type": "string",
+            },
+       ],
+       "dataset-remove": [
+            {
+               "name": "setname",
+               "required": true,
+               "type": "string",
+            },
+            {
+               "name": "settype",
+               "required": true,
+               "type": "string",
+            },
+            {
+               "name": "datavalue",
+               "required": true,
+               "type": "string",
+            },
+       ],
+       "get-flow-stats-by-id": [
+            {
+               "name": "flow_id",
+               "type": "number",
+               "required": true,
+            },
+       ],
+       "dataset-clear": [
+            {
+               "name": "setname",
+               "required": true,
+               "type": "string",
+            },
+            {
+               "name": "settype",
+               "required": true,
+               "type": "string",
+            }
+       ],
+       "dataset-lookup": [
+            {
+               "name": "setname",
+               "required": true,
+               "type": "string",
+            },
+            {
+               "name": "settype",
+               "required": true,
+               "type": "string",
+            },
+            {
+               "name": "datavalue",
+               "required": true,
+               "type": "string",
+            },
+       ],
+    });
+    serde_json::from_value(defs)
+}
diff --git a/rust/suricatasc/src/unix/main.rs b/rust/suricatasc/src/unix/main.rs
new file mode 100644 (file)
index 0000000..e1b7aa4
--- /dev/null
@@ -0,0 +1,122 @@
+// SPDX-FileCopyrightText: Copyright 2023 Open Information Security Foundation
+// SPDX-License-Identifier: GPL-2.0-only
+
+use crate::unix::client::{Client, ClientError, Response};
+use crate::unix::commands::CommandParser;
+use crate::unix::commands::Commands;
+use crate::unix::rustyprompt::RustyPrompt;
+use clap::Parser;
+use serde_json::json;
+
+const DEFAULT_SC_PATH: &str = "/var/run/suricata/suricata-command.socket";
+
+#[derive(Parser, Debug)]
+struct Args {
+    /// Enable verbose output
+    #[arg(long, short)]
+    verbose: bool,
+
+    /// Execute command and return JSON
+    #[arg(long, short)]
+    command: Option<String>,
+
+    /// Optional path to Suricata unix socket
+    socket: Option<String>,
+}
+
+pub fn main() -> Result<(), Box<dyn std::error::Error>> {
+    let localstatedir = option_env!("LOCALSTATEDIR");
+
+    let args = Args::parse();
+
+    let socket_filename = if let Some(filename) = args.socket {
+        filename.to_string()
+    } else if let Some(localstatedir) = localstatedir {
+        format!("{localstatedir}/suricata-command.socket")
+    } else {
+        DEFAULT_SC_PATH.to_string()
+    };
+
+    let verbose = args.verbose;
+    if verbose {
+        println!("Using Suricata command socket: {}", &socket_filename);
+    }
+
+    let client = match Client::connect(&socket_filename, verbose) {
+        Ok(client) => client,
+        Err(err) => {
+            eprintln!("Unable to connect socket to {}: {}", &socket_filename, err);
+            std::process::exit(1);
+        }
+    };
+
+    if let Some(command) = args.command {
+        run_batch_command(client, &command)
+    } else {
+        run_interactive(client)
+    }
+}
+
+fn run_interactive(mut client: Client) -> Result<(), Box<dyn std::error::Error>> {
+    client.send(&json!({"command": "command-list"}))?;
+    let response = client.read()?;
+    let server_commands: Vec<String> =
+        serde_json::from_value(response["message"]["commands"].clone())?;
+    println!("Command list: {}, quit", server_commands.join(", "));
+    let commands = Commands::new(server_commands);
+    let command_parser = CommandParser::new(&commands);
+    let mut prompt = RustyPrompt::new(commands.clone());
+
+    while let Some(line) = prompt.readline() {
+        if line.starts_with("quit") {
+            break;
+        }
+        match command_parser.parse(&line) {
+            Ok(command) => match interactive_request_response(&mut client, &command) {
+                Ok(response) => {
+                    let response: Response = serde_json::from_value(response).unwrap();
+                    if response.status == "OK" {
+                        println!("Success:");
+                        println!(
+                            "{}",
+                            serde_json::to_string_pretty(&response.message).unwrap()
+                        );
+                    } else {
+                        println!("Error:");
+                        println!("{}", serde_json::to_string(&response.message).unwrap());
+                    }
+                }
+                Err(err) => {
+                    println!("{}", err);
+                }
+            },
+            Err(err) => {
+                println!("{}", err);
+            }
+        }
+    }
+
+    Ok(())
+}
+
+fn run_batch_command(mut client: Client, command: &str) -> Result<(), Box<dyn std::error::Error>> {
+    client.send(&json!({"command": "command-list"}))?;
+    let response = client.read()?;
+    let server_commands: Vec<String> =
+        serde_json::from_value(response["message"]["commands"].clone())?;
+    let commands = Commands::new(server_commands);
+    let command_parser = CommandParser::new(&commands);
+    let command = command_parser.parse(command)?;
+    client.send(&command)?;
+    let response = client.read()?;
+    println!("{}", serde_json::to_string(&response)?);
+    Ok(())
+}
+
+fn interactive_request_response(
+    client: &mut Client, msg: &serde_json::Value,
+) -> Result<serde_json::Value, ClientError> {
+    client.send(msg)?;
+    let response = client.read()?;
+    Ok(response)
+}
diff --git a/rust/suricatasc/src/unix/mod.rs b/rust/suricatasc/src/unix/mod.rs
new file mode 100644 (file)
index 0000000..f3b9f5b
--- /dev/null
@@ -0,0 +1,4 @@
+pub mod client;
+pub mod commands;
+pub mod main;
+pub mod rustyprompt;
diff --git a/rust/suricatasc/src/unix/rustyprompt.rs b/rust/suricatasc/src/unix/rustyprompt.rs
new file mode 100644 (file)
index 0000000..e0f05f3
--- /dev/null
@@ -0,0 +1,124 @@
+// SPDX-FileCopyrightText: Copyright 2023 Open Information Security Foundation
+// SPDX-License-Identifier: GPL-2.0-only
+
+// A prompt built on Rustyline.
+
+use crate::unix::commands::Commands;
+use rustyline::completion::Completer;
+use rustyline::completion::Pair;
+use rustyline::error::ReadlineError;
+use rustyline::highlight::Highlighter;
+use rustyline::hint::Hinter;
+use rustyline::history::DefaultHistory;
+use rustyline::validate::{self, MatchingBracketValidator, Validator};
+use rustyline::Context;
+use rustyline::{CompletionType, Config, EditMode, Editor};
+use rustyline_derive::Helper;
+
+#[derive(Helper)]
+struct PromptHelper {
+    commands: Commands,
+    validator: MatchingBracketValidator,
+}
+
+impl PromptHelper {
+    fn new(commands: Commands) -> Self {
+        Self {
+            validator: MatchingBracketValidator::new(),
+            commands,
+        }
+    }
+}
+
+impl Hinter for PromptHelper {
+    type Hint = String;
+
+    fn hint(&self, _line: &str, _pos: usize, _ctx: &Context<'_>) -> Option<String> {
+        None
+    }
+}
+
+impl Highlighter for PromptHelper {}
+
+impl Validator for PromptHelper {
+    fn validate(
+        &self, ctx: &mut validate::ValidationContext,
+    ) -> rustyline::Result<validate::ValidationResult> {
+        self.validator.validate(ctx)
+    }
+
+    fn validate_while_typing(&self) -> bool {
+        self.validator.validate_while_typing()
+    }
+}
+
+impl Completer for PromptHelper {
+    type Candidate = Pair;
+    fn complete(
+        &self, line: &str, _pos: usize, _ctx: &Context<'_>,
+    ) -> Result<(usize, Vec<Pair>), ReadlineError> {
+        let mut pairs = vec![];
+        if line.is_empty() {
+            for command in &self.commands.commands {
+                pairs.push(Pair {
+                    display: command.0.to_string(),
+                    replacement: command.0.to_string(),
+                })
+            }
+            return Ok((pairs.len(), pairs));
+        }
+
+        let parts: Vec<&str> = line.split(' ').collect();
+        if parts.len() == 1 {
+            // We're still completing the command name.
+            for name in self.commands.commands.keys() {
+                if name.starts_with(parts[0]) {
+                    pairs.push(Pair {
+                        display: name.to_string(),
+                        replacement: name.to_string(),
+                    })
+                }
+            }
+        }
+
+        Ok((0, pairs))
+    }
+}
+
+pub struct RustyPrompt {
+    rl: Editor<PromptHelper, DefaultHistory>,
+}
+
+impl RustyPrompt {
+    pub fn new(commands: Commands) -> Self {
+        let config = Config::builder()
+            .history_ignore_space(true)
+            .completion_type(CompletionType::List)
+            .edit_mode(EditMode::Emacs)
+            .build();
+        let helper = PromptHelper::new(commands);
+        let mut rl = Editor::with_config(config).unwrap();
+        rl.set_helper(Some(helper));
+        Self { rl }
+    }
+
+    pub fn readline(&mut self) -> Option<String> {
+        loop {
+            let prompt = ">>> ";
+            let readline = self.rl.readline(prompt);
+            match readline {
+                Ok(line) => {
+                    self.rl.add_history_entry(line.as_str()).unwrap();
+                    return Some(line);
+                }
+                Err(ReadlineError::Interrupted) => {
+                    return None;
+                }
+                Err(ReadlineError::Eof) => {
+                    return None;
+                }
+                _ => {}
+            }
+        }
+    }
+}