diff --git a/.github/workflows/builds.yml b/.github/workflows/builds.yml index 04a2f1d5102c..70630451f966 100644 --- a/.github/workflows/builds.yml +++ b/.github/workflows/builds.yml @@ -3169,7 +3169,7 @@ jobs: windows-msys2-mingw64-libpcap: name: Windows MSYS2 MINGW64 (libpcap) runs-on: windows-latest - needs: [prepare-deps] + needs: [prepare-deps, ubuntu-22-04-dist] defaults: run: shell: msys2 {0} @@ -3194,8 +3194,11 @@ jobs: with: name: prep path: prep - - run: tar xf prep/libhtp.tar.gz - - run: tar xf prep/suricata-update.tar.gz + - name: Download suricata.tar.gz + uses: actions/download-artifact@fa0a91b85d4f404e444e00e005971372dc801d16 + with: + name: dist + - run: tar xvf suricata-*.tar.gz --strip-components=1 - run: tar xf prep/suricata-verify.tar.gz - name: Build run: | diff --git a/.github/workflows/live/afp-ids.sh b/.github/workflows/live/afp-ids.sh index 2af91572bbbd..5cb79b065bf6 100755 --- a/.github/workflows/live/afp-ids.sh +++ b/.github/workflows/live/afp-ids.sh @@ -28,9 +28,14 @@ if [ -f eve.json ]; then rm eve.json fi +if [ -e ./rust/target/release/suricatasc ]; then + SURICATASC=./rust/target/release/suricatasc +else + SURICATASC=./rust/target/debug/suricatasc +fi + RES=0 -export PYTHONPATH=python/ # Get listen interface and "ping" target address IFACE=$(ip r|grep default|awk '{print $5}') echo $IFACE @@ -75,7 +80,7 @@ if [ $CHECK -ne 1 ]; then echo "ERROR alerts count off for sid 222 (datasets)" RES=1 fi -JSON=$(python3 python/bin/suricatasc -v -c "dataset-clear ipv4-list ipv4" /var/run/suricata/suricata-command.socket) +JSON=$(${SURICATASC} -v -c "dataset-clear ipv4-list ipv4" /var/run/suricata/suricata-command.socket) echo $JSON sleep 5 @@ -91,41 +96,41 @@ echo "SURIPID $SURIPID PINGPID $PINGPID" cp .github/workflows/live/icmp2.rules suricata.rules # trigger the reload -JSON=$(python3 python/bin/suricatasc -c "iface-list" /var/run/suricata/suricata-command.socket) +JSON=$(${SURICATASC} -c "iface-list" /var/run/suricata/suricata-command.socket) PIFACE=$(echo $JSON | jq -r .message.ifaces[0]) -JSON=$(python3 python/bin/suricatasc -c "iface-stat $PIFACE") +JSON=$(${SURICATASC} -c "iface-stat $PIFACE") STATSCHECK=$(echo $JSON | jq '.message.pkts > 0') if [ $STATSCHECK = false ]; then echo "ERROR unix socket stats check failed" RES=1 fi -python3 python/bin/suricatasc -c "reload-rules" /var/run/suricata/suricata-command.socket +${SURICATASC} -c "reload-rules" /var/run/suricata/suricata-command.socket -JSON=$(python3 python/bin/suricatasc -c "iface-bypassed-stat" /var/run/suricata/suricata-command.socket) +JSON=$(${SURICATASC} -c "iface-bypassed-stat" /var/run/suricata/suricata-command.socket) echo $JSON -JSON=$(python3 python/bin/suricatasc -c "capture-mode" /var/run/suricata/suricata-command.socket) +JSON=$(${SURICATASC} -c "capture-mode" /var/run/suricata/suricata-command.socket) if [ "$(echo $JSON | jq -r .message)" != "AF_PACKET_DEV" ]; then echo "ERROR unix socket capture mode check failed" RES=1 fi -JSON=$(python3 python/bin/suricatasc -c "dump-counters" /var/run/suricata/suricata-command.socket) +JSON=$(${SURICATASC} -c "dump-counters" /var/run/suricata/suricata-command.socket) STATSCHECK=$(echo $JSON | jq '.message.uptime >= 15') if [ $STATSCHECK = false ]; then echo "ERROR unix socket dump-counters uptime check failed" RES=1 fi -JSON=$(python3 python/bin/suricatasc -c "memcap-list" /var/run/suricata/suricata-command.socket) +JSON=$(${SURICATASC} -c "memcap-list" /var/run/suricata/suricata-command.socket) echo $JSON -JSON=$(python3 python/bin/suricatasc -c "running-mode" /var/run/suricata/suricata-command.socket) +JSON=$(${SURICATASC} -c "running-mode" /var/run/suricata/suricata-command.socket) echo $JSON if [ "$(echo $JSON | jq -r .message)" != "$RUNMODE" ]; then echo "ERROR unix socket runmode check failed" RES=1 fi -JSON=$(python3 python/bin/suricatasc -c "version" /var/run/suricata/suricata-command.socket) +JSON=$(${SURICATASC} -c "version" /var/run/suricata/suricata-command.socket) echo $JSON -JSON=$(python3 python/bin/suricatasc -c "uptime" /var/run/suricata/suricata-command.socket) +JSON=$(${SURICATASC} -c "uptime" /var/run/suricata/suricata-command.socket) echo $JSON STATSCHECK=$(echo $JSON | jq '.message >= 15') if [ $STATSCHECK = false ]; then @@ -133,7 +138,7 @@ if [ $STATSCHECK = false ]; then RES=1 fi sleep 15 -JSON=$(python3 python/bin/suricatasc -c "add-hostbit $GW test 60" /var/run/suricata/suricata-command.socket) +JSON=$(${SURICATASC} -c "add-hostbit $GW test 60" /var/run/suricata/suricata-command.socket) echo $JSON sleep 15 @@ -148,17 +153,17 @@ if [ $SID2CHECK = false ]; then echo "ERROR no alerts for sid 2" RES=1 fi -JSON=$(python3 python/bin/suricatasc -c "list-hostbit $GW" /var/run/suricata/suricata-command.socket) +JSON=$(${SURICATASC} -c "list-hostbit $GW" /var/run/suricata/suricata-command.socket) CHECK=$(echo $JSON|jq -r .message.hostbits[0].name) if [ "$CHECK" != "test" ]; then echo "ERROR hostbit listing failed" RES=1 fi -JSON=$(python3 python/bin/suricatasc -c "remove-hostbit $GW test" /var/run/suricata/suricata-command.socket) +JSON=$(${SURICATASC} -c "remove-hostbit $GW test" /var/run/suricata/suricata-command.socket) kill -INT $PINGPID wait $PINGPID -python3 python/bin/suricatasc -c "shutdown" /var/run/suricata/suricata-command.socket +${SURICATASC} -c "shutdown" /var/run/suricata/suricata-command.socket wait $SURIPID echo "done: $RES" diff --git a/.github/workflows/live/dpdk.sh b/.github/workflows/live/dpdk.sh index fab36cb0c12f..f11a69631b2d 100755 --- a/.github/workflows/live/dpdk.sh +++ b/.github/workflows/live/dpdk.sh @@ -21,6 +21,12 @@ if [ -f eve.json ]; then rm eve.json fi +if [ -e ./rust/target/release/suricatasc ]; then + SURICATASC=./rust/target/release/suricatasc +else + SURICATASC=./rust/target/debug/suricatasc +fi + RES=0 # set first rule file @@ -47,8 +53,7 @@ echo "SURIPID $SURIPID" cp .github/workflows/live/icmp2.rules suricata.rules # trigger the reload -export PYTHONPATH=python/ -python3 python/bin/suricatasc -c "reload-rules" /var/run/suricata/suricata-command.socket +${SURICATASC} -c "reload-rules" /var/run/suricata/suricata-command.socket sleep 15 @@ -59,7 +64,7 @@ if [ $STATSCHECK = false ]; then RES=1 fi -python3 python/bin/suricatasc -c "shutdown" /var/run/suricata/suricata-command.socket +${SURICATASC} -c "shutdown" /var/run/suricata/suricata-command.socket wait $SURIPID echo "done: $RES" diff --git a/.github/workflows/live/pcap.sh b/.github/workflows/live/pcap.sh index 24119d8af686..f671e5bb5061 100755 --- a/.github/workflows/live/pcap.sh +++ b/.github/workflows/live/pcap.sh @@ -26,6 +26,12 @@ if [ -f eve.json ]; then rm eve.json fi +if [ -e ./rust/target/release/suricatasc ]; then + SURICATASC=./rust/target/release/suricatasc +else + SURICATASC=./rust/target/debug/suricatasc +fi + RES=0 export PYTHONPATH=python/ @@ -65,7 +71,7 @@ if [ $CHECK -ne 1 ]; then echo "ERROR alerts count off for sid 222 (datasets)" RES=1 fi -JSON=$(python3 python/bin/suricatasc -v -c "dataset-clear ipv4-list ipv4" /var/run/suricata/suricata-command.socket) +JSON=$(${SURICATASC} -v -c "dataset-clear ipv4-list ipv4" /var/run/suricata/suricata-command.socket) echo $JSON sleep 5 @@ -75,7 +81,7 @@ if [ $CHECK -ne 2 ]; then RES=1 fi -JSON=$(python3 python/bin/suricatasc -c "dataset-add ipv6-list ip 192.168.1.1" /var/run/suricata/suricata-command.socket) +JSON=$(${SURICATASC} -c "dataset-add ipv6-list ip 192.168.1.1" /var/run/suricata/suricata-command.socket) echo $JSON if [ "$(echo $JSON | jq -r .message)" != "data added" ]; then echo "ERROR unix socket dataset add failed" @@ -83,7 +89,7 @@ if [ "$(echo $JSON | jq -r .message)" != "data added" ]; then fi # look it up in IPv4 in IPv6 notation -JSON=$(python3 python/bin/suricatasc -c "dataset-lookup ipv6-list ip ::ffff:c0a8:0101" /var/run/suricata/suricata-command.socket) +JSON=$(${SURICATASC} -c "dataset-lookup ipv6-list ip ::ffff:c0a8:0101" /var/run/suricata/suricata-command.socket) echo $JSON if [ "$(echo $JSON | jq -r .message)" != "item found in set" ]; then echo "ERROR unix socket dataset lookup failed" @@ -91,7 +97,7 @@ if [ "$(echo $JSON | jq -r .message)" != "item found in set" ]; then fi # fail to add junk -JSON=$(python3 python/bin/suricatasc -c "dataset-add ipv6-list ip ::ffff:c0a8:0z0z" /var/run/suricata/suricata-command.socket) +JSON=$(${SURICATASC} -c "dataset-add ipv6-list ip ::ffff:c0a8:0z0z" /var/run/suricata/suricata-command.socket) echo $JSON if [ "$(echo $JSON | jq -r .message)" != "failed to add data" ]; then echo "ERROR unix socket dataset added junk" @@ -104,41 +110,41 @@ echo "SURIPID $SURIPID PINGPID $PINGPID" cp .github/workflows/live/icmp2.rules suricata.rules # trigger the reload -JSON=$(python3 python/bin/suricatasc -c "iface-list" /var/run/suricata/suricata-command.socket) +JSON=$(${SURICATASC} -c "iface-list" /var/run/suricata/suricata-command.socket) PIFACE=$(echo $JSON | jq -r .message.ifaces[0]) -JSON=$(python3 python/bin/suricatasc -c "iface-stat $PIFACE") +JSON=$(${SURICATASC} -c "iface-stat $PIFACE") STATSCHECK=$(echo $JSON | jq '.message.pkts > 0') if [ $STATSCHECK = false ]; then echo "ERROR unix socket stats check failed" RES=1 fi -python3 python/bin/suricatasc -c "reload-rules" /var/run/suricata/suricata-command.socket +${SURICATASC} -c "reload-rules" /var/run/suricata/suricata-command.socket -JSON=$(python3 python/bin/suricatasc -c "iface-bypassed-stat" /var/run/suricata/suricata-command.socket) +JSON=$(${SURICATASC} -c "iface-bypassed-stat" /var/run/suricata/suricata-command.socket) echo $JSON -JSON=$(python3 python/bin/suricatasc -c "capture-mode" /var/run/suricata/suricata-command.socket) +JSON=$(${SURICATASC} -c "capture-mode" /var/run/suricata/suricata-command.socket) if [ "$(echo $JSON | jq -r .message)" != "PCAP_DEV" ]; then echo "ERROR unix socket capture mode check failed" RES=1 fi -JSON=$(python3 python/bin/suricatasc -c "dump-counters" /var/run/suricata/suricata-command.socket) +JSON=$(${SURICATASC} -c "dump-counters" /var/run/suricata/suricata-command.socket) STATSCHECK=$(echo $JSON | jq '.message.uptime >= 15') if [ $STATSCHECK = false ]; then echo "ERROR unix socket dump-counters uptime check failed" RES=1 fi -JSON=$(python3 python/bin/suricatasc -c "memcap-list" /var/run/suricata/suricata-command.socket) +JSON=$(${SURICATASC} -c "memcap-list" /var/run/suricata/suricata-command.socket) echo $JSON -JSON=$(python3 python/bin/suricatasc -c "running-mode" /var/run/suricata/suricata-command.socket) +JSON=$(${SURICATASC} -c "running-mode" /var/run/suricata/suricata-command.socket) echo $JSON if [ "$(echo $JSON | jq -r .message)" != "$RUNMODE" ]; then echo "ERROR unix socket runmode check failed" RES=1 fi -JSON=$(python3 python/bin/suricatasc -c "version" /var/run/suricata/suricata-command.socket) +JSON=$(${SURICATASC} -c "version" /var/run/suricata/suricata-command.socket) echo $JSON -JSON=$(python3 python/bin/suricatasc -c "uptime" /var/run/suricata/suricata-command.socket) +JSON=$(${SURICATASC} -c "uptime" /var/run/suricata/suricata-command.socket) echo $JSON STATSCHECK=$(echo $JSON | jq '.message >= 15') if [ $STATSCHECK = false ]; then @@ -146,7 +152,7 @@ if [ $STATSCHECK = false ]; then RES=1 fi sleep 15 -JSON=$(python3 python/bin/suricatasc -c "add-hostbit $GW test 60" /var/run/suricata/suricata-command.socket) +JSON=$(${SURICATASC} -c "add-hostbit $GW test 60" /var/run/suricata/suricata-command.socket) echo $JSON sleep 15 @@ -161,17 +167,17 @@ if [ $SID2CHECK = false ]; then echo "ERROR no alerts for sid 2" RES=1 fi -JSON=$(python3 python/bin/suricatasc -c "list-hostbit $GW" /var/run/suricata/suricata-command.socket) +JSON=$(${SURICATASC} -c "list-hostbit $GW" /var/run/suricata/suricata-command.socket) CHECK=$(echo $JSON|jq -r .message.hostbits[0].name) if [ "$CHECK" != "test" ]; then echo "ERROR hostbit listing failed" RES=1 fi -JSON=$(python3 python/bin/suricatasc -c "remove-hostbit $GW test" /var/run/suricata/suricata-command.socket) +JSON=$(${SURICATASC} -c "remove-hostbit $GW test" /var/run/suricata/suricata-command.socket) kill -INT $PINGPID wait $PINGPID -python3 python/bin/suricatasc -c "shutdown" /var/run/suricata/suricata-command.socket +${SURICATASC} -c "shutdown" /var/run/suricata/suricata-command.socket wait $SURIPID echo "done: $RES" diff --git a/configure.ac b/configure.ac index ca964d9039a0..06fd1f340303 100644 --- a/configure.ac +++ b/configure.ac @@ -2516,6 +2516,8 @@ AC_SUBST(enable_non_bundled_htp) AM_CONDITIONAL([BUILD_SHARED_LIBRARY], [test "x$enable_shared" = "xyes"] && [test "x$can_build_shared_library" = "xyes"]) 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/suricatactl/Makefile rust/suricatactl/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) diff --git a/python/Makefile.am b/python/Makefile.am index b3547192bd14..32bf43f825a8 100644 --- a/python/Makefile.am +++ b/python/Makefile.am @@ -1,44 +1,17 @@ LIBS = \ suricata/__init__.py \ - suricata/config/__init__.py \ - suricata/ctl/__init__.py \ - suricata/ctl/filestore.py \ - suricata/ctl/loghandler.py \ - suricata/ctl/main.py \ - suricata/ctl/test_filestore.py \ - suricata/sc/__init__.py \ - suricata/sc/specs.py \ - suricata/sc/suricatasc.py \ - suricatasc/__init__.py + suricata/config/__init__.py -BINS = \ - suricatasc \ - suricatactl - -EXTRA_DIST = $(LIBS) bin suricata/config/defaults.py +EXTRA_DIST = $(LIBS) suricata/config/defaults.py if HAVE_PYTHON install-exec-local: install -d -m 0755 "$(DESTDIR)$(prefix)/lib/suricata/python/suricata/config" - install -d -m 0755 "$(DESTDIR)$(prefix)/lib/suricata/python/suricata/ctl" - install -d -m 0755 "$(DESTDIR)$(prefix)/lib/suricata/python/suricata/sc" - install -d -m 0755 "$(DESTDIR)$(prefix)/lib/suricata/python/suricatasc" - install -d -m 0755 "$(DESTDIR)$(prefix)/bin" - for src in $(LIBS); do \ - install -m 0644 $(srcdir)/$$src "$(DESTDIR)$(prefix)/lib/suricata/python/$$src"; \ - done install suricata/config/defaults.py \ "$(DESTDIR)$(prefix)/lib/suricata/python/suricata/config/defaults.py" - for bin in $(BINS); do \ - cat "$(srcdir)/bin/$$bin" | \ - sed -e "1 s,.*,#"'!'" ${HAVE_PYTHON}," > "${DESTDIR}$(bindir)/$$bin"; \ - chmod 0755 "$(DESTDIR)$(bindir)/$$bin"; \ - done uninstall-local: - rm -f $(DESTDIR)$(bindir)/suricatactl - rm -f $(DESTDIR)$(bindir)/suricatasc rm -rf $(DESTDIR)$(prefix)/lib/suricata/python clean-local: diff --git a/python/bin/suricatactl b/python/bin/suricatactl deleted file mode 100755 index 27805891e34d..000000000000 --- a/python/bin/suricatactl +++ /dev/null @@ -1,39 +0,0 @@ -#! /usr/bin/env python -# -# Copyright (C) 2017-2022 Open Information Security Foundation -# -# You can copy, redistribute or modify this Program under the terms of -# the GNU General Public License version 2 as published by the Free -# Software Foundation. -# -# 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 -# version 2 along with this program; if not, write to the Free Software -# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA -# 02110-1301, USA. - -import sys -import os -import site - -exec_dir = os.path.dirname(__file__) - -if os.path.exists(os.path.join(exec_dir, "..", "suricata", "ctl", "main.py")): - # Looks like we're running from the development directory. - sys.path.insert(0, ".") -else: - # Check if the Python modules are installed in the Suricata installation - # prefix. - version_info = sys.version_info - pyver = "%d.%d" % (version_info.major, version_info.minor) - path = os.path.realpath(os.path.join( - exec_dir, "..", "lib", "suricata", "python", "suricata")) - if os.path.exists(path): - sys.path.insert(0, os.path.dirname(path)) - -from suricata.ctl.main import main -sys.exit(main()) diff --git a/python/bin/suricatasc b/python/bin/suricatasc deleted file mode 100755 index d090f856f54d..000000000000 --- a/python/bin/suricatasc +++ /dev/null @@ -1,100 +0,0 @@ -#! /usr/bin/env python -# -# Copyright(C) 2013-2023 Open Information Security Foundation -# -# 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, version 2 of the License. -# -# 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. - -from __future__ import print_function - -import sys -import os -import argparse - -# Find the Python libdir. -exec_dir = os.path.dirname(__file__) -if os.path.exists(os.path.join(exec_dir, "..", "suricata", "ctl", "main.py")): - # Looks like we're running from the development directory. - sys.path.insert(0, ".") -else: - # Check if the Python modules are installed in the Suricata installation - # prefix. - version_info = sys.version_info - pyver = "%d.%d" % (version_info.major, version_info.minor) - path = os.path.realpath(os.path.join( - exec_dir, "..", "lib", "suricata", "python", "suricata")) - if os.path.exists(path): - sys.path.insert(0, os.path.dirname(path)) - -from suricata.sc import * - -try: - from suricata.config import defaults - has_defaults = True -except: - has_defaults = False - -parser = argparse.ArgumentParser(prog='suricatasc', description='Client for Suricata unix socket') -parser.add_argument('-v', '--verbose', action='store_const', const=True, help='verbose output (including JSON dump)') -parser.add_argument('-c', '--command', default=None, help='execute on single command and return JSON') -parser.add_argument('socket', metavar='socket', nargs='?', help='socket file to connect to', default=None) -args = parser.parse_args() - -if args.socket != None: - SOCKET_PATH = args.socket -elif has_defaults: - SOCKET_PATH = os.path.join(defaults.localstatedir, "suricata-command.socket") -else: - print("Unable to determine path to suricata-command.socket.", file=sys.stderr) - sys.exit(1) - -sc = SuricataSC(SOCKET_PATH, verbose=args.verbose) -try: - sc.connect() -except SuricataNetException as err: - print("Unable to connect to socket %s: %s" % (SOCKET_PATH, err), file=sys.stderr) - sys.exit(1) -except SuricataReturnException as err: - print("Unable to negotiate version with server: %s" % (err), file=sys.stderr) - sys.exit(1) - -if args.command: - try: - (command, arguments) = sc.parse_command(args.command) - except SuricataCommandException as err: - print(err.value) - sys.exit(1) - try: - res = sc.send_command(command, arguments) - except (SuricataCommandException, SuricataReturnException) as err: - print(err.value) - sys.exit(1) - print(json.dumps(res)) - sc.close() - if res['return'] == 'OK': - sys.exit(0) - else: - sys.exit(1) - -try: - sc.interactive() -except SuricataNetException as err: - print("Communication error: %s" % (err)) - sys.exit(1) -except SuricataReturnException as err: - print("Invalid return from server: %s" % (err)) - sys.exit(1) - -print("[+] Quit command client") - -sc.close() diff --git a/python/suricata/ctl/__init__.py b/python/suricata/ctl/__init__.py deleted file mode 100644 index e69de29bb2d1..000000000000 diff --git a/python/suricata/ctl/filestore.py b/python/suricata/ctl/filestore.py deleted file mode 100644 index 2901f597e2f9..000000000000 --- a/python/suricata/ctl/filestore.py +++ /dev/null @@ -1,129 +0,0 @@ -# Copyright (C) 2018 Open Information Security Foundation -# -# You can copy, redistribute or modify this Program under the terms of -# the GNU General Public License version 2 as published by the Free -# Software Foundation. - -# 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 -# version 2 along with this program; if not, write to the Free Software -# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA -# 02110-1301, USA. - -from __future__ import print_function - -import sys -import os -import os.path -import time -import re -import logging - -logger = logging.getLogger("filestore") - - -class InvalidAgeFormatError(Exception): - pass - - -def register_args(parser): - subparser = parser.add_subparsers(help="sub-command help") - prune_parser = subparser.add_parser("prune", - help="Remove files in specified directory older than specified age") - required_args = prune_parser.add_argument_group("required arguments") - required_args.add_argument("-d", "--directory", - help="filestore directory", required=True) - required_args.add_argument("--age", - help="prune files older than age, units: s, m, h, d") - prune_parser.add_argument( - "-n", "--dry-run", action="store_true", default=False, - help="only print what would happen") - prune_parser.add_argument( - "-v", "--verbose", action="store_true", - default=False, help="increase verbosity") - prune_parser.add_argument( - "-q", "--quiet", action="store_true", default=False, - help="be quiet, log warnings and errors only") - prune_parser.set_defaults(func=prune) - - -def is_fileinfo(path): - return path.endswith(".json") - - -def parse_age(age): - matched_age = re.match(r"(\d+)\s*(\w+)", age) - if not matched_age: - raise InvalidAgeFormatError(age) - val = int(matched_age.group(1)) - unit = matched_age.group(2) - ts_units = ["s", "m", "h", "d"] - try: - idx = ts_units.index(unit) - except ValueError: - raise InvalidAgeFormatError("bad unit: %s" % (unit)) - multiplier = 60 ** idx if idx != 3 else 24 * 60 ** 2 - return val * multiplier - - -def get_filesize(path): - return os.stat(path).st_size - - -def remove_file(path, dry_run): - size = 0 - size += get_filesize(path) - if not dry_run: - os.unlink(path) - return size - - -def set_logger_level(args): - if args.verbose: - logger.setLevel(logging.DEBUG) - if args.quiet: - logger.setLevel(logging.WARNING) - - -def perform_sanity_checks(args): - set_logger_level(args) - err_msg = { - "directory": "filestore directory must be provided", - "age": "no age provided, nothing to do", - } - for val, msg in err_msg.items(): - if not getattr(args, val): - print("Error: {}".format(msg), file=sys.stderr) - sys.exit(1) - required_dirs = ["tmp", "00", "ff"] - for required_dir in required_dirs: - if not os.path.exists(os.path.join(args.directory, required_dir)): - logger.error("Provided directory is not a filestore directory") - sys.exit(1) - - -def prune(args): - perform_sanity_checks(args) - age = parse_age(args.age) - now = time.time() - size = 0 - count = 0 - - for dirpath, dirnames, filenames in os.walk(args.directory, topdown=True): - # Do not go into the tmp directory. - if "tmp" in dirnames: - dirnames.remove("tmp") - for filename in filenames: - path = os.path.join(dirpath, filename) - mtime = os.path.getmtime(path) - this_age = now - mtime - if this_age > age: - logger.debug("Deleting %s; age=%ds", path, this_age) - size += remove_file(path, args.dry_run) - count += 1 - logger.info("Removed %d files; %d bytes.", count, size) - return 0 diff --git a/python/suricata/ctl/loghandler.py b/python/suricata/ctl/loghandler.py deleted file mode 100644 index 553b896fd1de..000000000000 --- a/python/suricata/ctl/loghandler.py +++ /dev/null @@ -1,81 +0,0 @@ -# Copyright (C) 2017 Open Information Security Foundation -# Copyright (c) 2016 Jason Ish -# -# You can copy, redistribute or modify this Program under the terms of -# the GNU General Public License version 2 as published by the Free -# Software Foundation. -# -# 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 -# version 2 along with this program; if not, write to the Free Software -# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA -# 02110-1301, USA. - -import logging -import time - -GREEN = "\x1b[32m" -BLUE = "\x1b[34m" -REDB = "\x1b[1;31m" -YELLOW = "\x1b[33m" -RED = "\x1b[31m" -YELLOWB = "\x1b[1;33m" -ORANGE = "\x1b[38;5;208m" -RESET = "\x1b[0m" - -# A list of secrets that will be replaced in the log output. -secrets = {} - -def add_secret(secret, replacement): - """Register a secret to be masked. The secret will be replaced with: - - """ - secrets[str(secret)] = str(replacement) - -class SuriColourLogHandler(logging.StreamHandler): - """An alternative stream log handler that logs with Suricata inspired - log colours.""" - - @staticmethod - def format_time(record): - local_time = time.localtime(record.created) - formatted_time = "%d/%d/%d -- %02d:%02d:%02d" % (local_time.tm_mday, - local_time.tm_mon, - local_time.tm_year, - local_time.tm_hour, - local_time.tm_min, - local_time.tm_sec) - return "%s" % (formatted_time) - - def emit(self, record): - - if record.levelname == "ERROR": - level_prefix = REDB - message_prefix = REDB - elif record.levelname == "WARNING": - level_prefix = ORANGE - message_prefix = ORANGE - else: - level_prefix = YELLOW - message_prefix = "" - - self.stream.write("%s%s%s - <%s%s%s> -- %s%s%s\n" % ( - GREEN, - self.format_time(record), - RESET, - level_prefix, - record.levelname.title(), - RESET, - message_prefix, - self.mask_secrets(record.getMessage()), - RESET)) - - @staticmethod - def mask_secrets(msg): - for secret in secrets: - msg = msg.replace(secret, "<%s>" % secrets[secret]) - return msg diff --git a/python/suricata/ctl/main.py b/python/suricata/ctl/main.py deleted file mode 100644 index d51a5be61e1c..000000000000 --- a/python/suricata/ctl/main.py +++ /dev/null @@ -1,46 +0,0 @@ -# Copyright (C) 2018 Open Information Security Foundation -# -# You can copy, redistribute or modify this Program under the terms of -# the GNU General Public License version 2 as published by the Free -# Software Foundation. - -# 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 -# version 2 along with this program; if not, write to the Free Software -# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA -# 02110-1301, USA. - -import sys -import os -import argparse -import logging - -from suricata.ctl import filestore, loghandler - -def init_logger(): - """ Initialize logging, use colour if on a tty. """ - if os.isatty(sys.stderr.fileno()): - logger = logging.getLogger() - logger.setLevel(level=logging.INFO) - logger.addHandler(loghandler.SuriColourLogHandler()) - else: - logging.basicConfig( - level=logging.INFO, - format="%(asctime)s - <%(levelname)s> - %(message)s") - -def main(): - init_logger() - parser = argparse.ArgumentParser() - subparsers = parser.add_subparsers(help='sub-command help') - fs_parser = subparsers.add_parser("filestore", help="Filestore related commands") - filestore.register_args(parser=fs_parser) - args = parser.parse_args() - try: - func = args.func - except AttributeError: - parser.error("too few arguments") - func(args) diff --git a/python/suricata/ctl/test_filestore.py b/python/suricata/ctl/test_filestore.py deleted file mode 100644 index 3bac1c6feb0f..000000000000 --- a/python/suricata/ctl/test_filestore.py +++ /dev/null @@ -1,18 +0,0 @@ -from __future__ import print_function - -import unittest - -from suricata.ctl import filestore - -class PruneTestCase(unittest.TestCase): - - def test_parse_age(self): - self.assertEqual(filestore.parse_age("1s"), 1) - self.assertEqual(filestore.parse_age("1m"), 60) - self.assertEqual(filestore.parse_age("1h"), 3600) - self.assertEqual(filestore.parse_age("1d"), 86400) - - with self.assertRaises(filestore.InvalidAgeFormatError): - filestore.parse_age("1") - with self.assertRaises(filestore.InvalidAgeFormatError): - filestore.parse_age("1y") diff --git a/python/suricata/sc/__init__.py b/python/suricata/sc/__init__.py deleted file mode 100644 index 976e1fc21756..000000000000 --- a/python/suricata/sc/__init__.py +++ /dev/null @@ -1 +0,0 @@ -from suricata.sc.suricatasc import * diff --git a/python/suricata/sc/specs.py b/python/suricata/sc/specs.py deleted file mode 100644 index c7e045873303..000000000000 --- a/python/suricata/sc/specs.py +++ /dev/null @@ -1,228 +0,0 @@ -argsd = { - "pcap-file": [ - { - "name": "filename", - "required": 1, - }, - { - "name": "output-dir", - "required": 1, - }, - { - "name": "tenant", - "type": int, - "required": 0, - }, - { - "name": "continuous", - "required": 0, - }, - { - "name": "delete-when-done", - "required": 0, - }, - ], - "pcap-file-continuous": [ - { - "name": "filename", - "required": 1, - }, - { - "name": "output-dir", - "required": 1, - }, - { - "name": "continuous", - "val": True, - "required": 1, - }, - { - "name": "tenant", - "type": int, - "required": 0, - }, - { - "name": "delete-when-done", - "required": 0, - }, - ], - "iface-stat": [ - { - "name": "iface", - "required": 1, - }, - ], - "conf-get": [ - { - "name": "variable", - "required": 1, - } - ], - "unregister-tenant-handler": [ - { - "name": "id", - "type": int, - "required": 1, - }, - { - "name": "htype", - "required": 1, - }, - { - "name": "hargs", - "type": int, - "required": 0, - }, - ], - "register-tenant-handler": [ - { - "name": "id", - "type": int, - "required": 1, - }, - { - "name": "htype", - "required": 1, - }, - { - "name": "hargs", - "type": int, - "required": 0, - }, - ], - "unregister-tenant": [ - { - "name": "id", - "type": int, - "required": 1, - }, - ], - "register-tenant": [ - { - "name": "id", - "type": int, - "required": 1, - }, - { - "name": "filename", - "required": 1, - }, - ], - "reload-tenant": [ - { - "name": "id", - "type": int, - "required": 1, - }, - { - "name": "filename", - "required": 0, - }, - ], - "add-hostbit": [ - { - "name": "ipaddress", - "required": 1, - }, - { - "name": "hostbit", - "required": 1, - }, - { - "name": "expire", - "type": int, - "required": 1, - }, - ], - "remove-hostbit": [ - { - "name": "ipaddress", - "required": 1, - }, - { - "name": "hostbit", - "required": 1, - }, - ], - "list-hostbit": [ - { - "name": "ipaddress", - "required": 1, - }, - ], - "memcap-set": [ - { - "name": "config", - "required": 1, - }, - { - "name": "memcap", - "required": 1, - }, - ], - "memcap-show": [ - { - "name": "config", - "required": 1, - }, - ], - "dataset-add": [ - { - "name": "setname", - "required": 1, - }, - { - "name": "settype", - "required": 1, - }, - { - "name": "datavalue", - "required": 1, - }, - ], - "dataset-remove": [ - { - "name": "setname", - "required": 1, - }, - { - "name": "settype", - "required": 1, - }, - { - "name": "datavalue", - "required": 1, - }, - ], - "get-flow-stats-by-id": [ - { - "name": "flow_id", - "type": int, - "required": 1, - }, - ], - "dataset-clear": [ - { - "name": "setname", - "required": 1, - }, - { - "name": "settype", - "required": 1, - } - ], - "dataset-lookup": [ - { - "name": "setname", - "required": 1, - }, - { - "name": "settype", - "required": 1, - }, - { - "name": "datavalue", - "required": 1, - }, - ], - } diff --git a/python/suricata/sc/suricatasc.py b/python/suricata/sc/suricatasc.py deleted file mode 100644 index fc07037c3d22..000000000000 --- a/python/suricata/sc/suricatasc.py +++ /dev/null @@ -1,293 +0,0 @@ -# Copyright(C) 2012-2023 Open Information Security Foundation - -# 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, version 2 of the License. -# -# 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. - -try: - import simplejson as json -except ImportError: - import json -import readline -import select -import sys -from socket import AF_UNIX, error, socket -from inspect import currentframe - -from suricata.sc.specs import argsd - -SURICATASC_VERSION = "1.0" -VERSION = "0.2" -INC_SIZE = 1024 - - -def get_linenumber(): - cf = currentframe() - return cf.f_back.f_lineno - - -class SuricataException(Exception): - """ - Generic class for suricatasc exception - """ - def __init__(self, value): - super(SuricataException, self).__init__(value) - self.value = value - - def __str__(self): - return str(self.value) - - -class SuricataNetException(SuricataException): - """ - Exception raised when a network error occurs - """ - - -class SuricataCommandException(SuricataException): - """ - Exception raised when the command is incorrect - """ - - -class SuricataReturnException(SuricataException): - """ - Exception raised when return message is incorrect - """ - - -class SuricataCompleter: - def __init__(self, words): - self.words = words - self.generator = None - - def complete(self, text): - for word in self.words: - if word.startswith(text): - yield word - - def __call__(self, text, state): - if state == 0: - self.generator = self.complete(text) - try: - return next(self.generator) - except StopIteration: - return None - - -class SuricataSC: - def __init__(self, sck_path, verbose=False): - self.basic_commands = [ - "shutdown", - "quit", - "pcap-file-number", - "pcap-file-list", - "pcap-last-processed", - "pcap-interrupt", - "iface-list", - "reload-tenants", - ] - self.fn_commands = [ - "pcap-file", - "pcap-file-continuous", - "iface-stat", - "conf-get", - "unregister-tenant-handler", - "register-tenant-handler", - "unregister-tenant", - "register-tenant", - "reload-tenant", - "add-hostbit", - "remove-hostbit", - "list-hostbit", - "memcap-set", - "memcap-show", - "dataset-add", - "dataset-remove", - "get-flow-stats-by-id", - "dataset-clear", - "dataset-lookup", - ] - self.cmd_list = self.basic_commands + self.fn_commands - self.sck_path = sck_path - self.verbose = verbose - self.socket = socket(AF_UNIX) - - def json_recv(self): - cmdret = None - data = "" - while True: - if sys.version < '3': - received = self.socket.recv(INC_SIZE) - else: - received = self.socket.recv(INC_SIZE).decode('iso-8859-1') - - if not received: - break - - data += received - if data.endswith('\n'): - cmdret = json.loads(data) - break - return cmdret - - def send_command(self, command, arguments=None): - if command not in self.cmd_list and command != 'command-list': - raise SuricataCommandException("L{}: Command not found: {}".format(get_linenumber(), command)) - - cmdmsg = {} - cmdmsg['command'] = command - if arguments: - cmdmsg['arguments'] = arguments - if self.verbose: - print("SND: " + json.dumps(cmdmsg)) - cmdmsg_str = json.dumps(cmdmsg) + "\n" - if sys.version < '3': - self.socket.send(cmdmsg_str) - else: - self.socket.send(bytes(cmdmsg_str, 'iso-8859-1')) - - ready = select.select([self.socket], [], [], 600) - if ready[0]: - cmdret = self.json_recv() - else: - cmdret = None - if not cmdret: - raise SuricataReturnException("L{}: Unable to get message from server".format(get_linenumber)) - - if self.verbose: - print("RCV: "+ json.dumps(cmdret)) - - return cmdret - - def connect(self): - try: - if self.socket is None: - self.socket = socket(AF_UNIX) - self.socket.connect(self.sck_path) - except error as err: - raise SuricataNetException("L{}: {}".format(get_linenumber(), err)) - - self.socket.settimeout(10) - #send version - if self.verbose: - print("SND: " + json.dumps({"version": VERSION})) - if sys.version < '3': - self.socket.send(json.dumps({"version": VERSION})) - else: - self.socket.send(bytes(json.dumps({"version": VERSION}), 'iso-8859-1')) - - ready = select.select([self.socket], [], [], 600) - if ready[0]: - cmdret = self.json_recv() - else: - cmdret = None - - if not cmdret: - raise SuricataReturnException("L{}: Unable to get message from server".format(get_linenumber())) - - if self.verbose: - print("RCV: "+ json.dumps(cmdret)) - - if cmdret["return"] == "NOK": - raise SuricataReturnException("L{}: Error: {}".format(get_linenumber(), cmdret["message"])) - - cmdret = self.send_command("command-list") - - # we silently ignore NOK as this means server is old - if cmdret["return"] == "OK": - self.cmd_list = cmdret["message"]["commands"] - self.cmd_list.append("quit") - - def close(self): - self.socket.close() - self.socket = None - - def execute(self, command): - full_cmd = command.split() - cmd = full_cmd[0] - cmd_specs = argsd[cmd] - required_args_count = len([d["required"] for d in cmd_specs if d["required"] and not "val" in d]) - arguments = dict() - for c, spec in enumerate(cmd_specs, 1): - spec_type = str if "type" not in spec else spec["type"] - if spec["required"]: - if spec.get("val"): - arguments[spec["name"]] = spec_type(spec["val"]) - continue - try: - arguments[spec["name"]] = spec_type(full_cmd[c]) - except IndexError: - phrase = " at least" if required_args_count != len(cmd_specs) else "" - msg = "Missing arguments: expected{} {}".format(phrase, required_args_count) - raise SuricataCommandException("L{}: {}".format(get_linenumber(), msg)) - except ValueError as ve: - raise SuricataCommandException("L{}: Erroneous arguments: {}".format(get_linenumber(), ve)) - elif c < len(full_cmd): - arguments[spec["name"]] = spec_type(full_cmd[c]) - return cmd, arguments - - def parse_command(self, command): - arguments = None - cmd = command.split()[0] if command else None - if cmd in self.cmd_list: - if cmd in self.fn_commands: - cmd, arguments = getattr(self, "execute")(command=command) - else: - raise SuricataCommandException("L{}: Unknown command: {}".format(get_linenumber(), command)) - return cmd, arguments - - def interactive(self): - print("Command list: " + ", ".join(self.cmd_list)) - try: - readline.set_completer(SuricataCompleter(self.cmd_list)) - readline.set_completer_delims(";") - readline.parse_and_bind('tab: complete') - while True: - if sys.version < '3': - command = raw_input(">>> ").strip() - else: - command = input(">>> ").strip() - if command == "quit": - break - if len(command.strip()) == 0: - continue - try: - cmd, arguments = self.parse_command(command) - except SuricataCommandException as err: - print(err) - continue - try: - cmdret = self.send_command(cmd, arguments) - except IOError as err: - # try to reconnect and resend command - print("Connection lost, trying to reconnect") - try: - self.close() - self.connect() - except (SuricataNetException, SuricataReturnException) as err: - print(err.value) - continue - cmdret = self.send_command(cmd, arguments) - except (SuricataCommandException, SuricataReturnException) as err: - print("An exception occured: " + str(err.value)) - continue - #decode json message - if cmdret["return"] == "NOK": - print("Error:") - print(json.dumps(cmdret["message"], sort_keys=True, indent=4, separators=(',', ': '))) - else: - print("Success:") - print(json.dumps(cmdret["message"], sort_keys=True, indent=4, separators=(',', ': '))) - except KeyboardInterrupt: - print("[!] Interrupted") - sys.exit(0) diff --git a/python/suricatasc/__init__.py b/python/suricatasc/__init__.py deleted file mode 100644 index 28689843ca6c..000000000000 --- a/python/suricatasc/__init__.py +++ /dev/null @@ -1 +0,0 @@ -from suricata.sc import * diff --git a/qa/unix.sh b/qa/unix.sh index deb6a9de79d3..15aa16c9c373 100755 --- a/qa/unix.sh +++ b/qa/unix.sh @@ -20,7 +20,8 @@ VERBOSE="" UnixCommand () { COMMAND=$1 - PYTHONPATH=python/ python3 python/bin/suricatasc -c "${COMMAND}" ${USOCKET} + #PYTHONPATH=python/ python3 python/bin/suricatasc -c "${COMMAND}" ${USOCKET} + ./rust/target/release/suricatasc -c "${COMMAND}" ${USOCKET} } Start () { diff --git a/rust/Cargo.toml.in b/rust/Cargo.toml.in index 8fad5fee77e3..8c80498261ad 100644 --- a/rust/Cargo.toml.in +++ b/rust/Cargo.toml.in @@ -7,7 +7,17 @@ edition = "2021" rust-version = "1.67.1" [workspace] -members = [".", "./derive"] +members = [ + ".", + "derive", + "suricatactl", + "suricatasc", +] +default-members = [ + ".", + "suricatactl", + "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" diff --git a/rust/Makefile.am b/rust/Makefile.am index a47a1c15342d..deedcb9c2813 100644 --- a/rust/Makefile.am +++ b/rust/Makefile.am @@ -1,10 +1,15 @@ +SUBDIRS = suricatasc \ + suricatactl + EXTRA_DIST = src derive \ .cargo/config.toml.in \ cbindgen.toml \ dist/rust-bindings.h \ vendor \ Cargo.toml Cargo.lock \ - derive/Cargo.toml + derive/Cargo.toml \ + suricatasc \ + suricatactl if !DEBUG RELEASE = --release @@ -46,6 +51,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 && \ @@ -62,12 +69,19 @@ 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 -m 0755 $(RUST_SURICATA_LIBDIR)/suricatactl "$(DESTDIR)$(bindir)/suricatactl" + 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" + rm -f "$(DESTDIR)$(bindir)/suricatactl" clean-local: rm -rf target gen diff --git a/rust/suricatactl/Cargo.toml.in b/rust/suricatactl/Cargo.toml.in new file mode 100644 index 000000000000..b0364ee1cd1d --- /dev/null +++ b/rust/suricatactl/Cargo.toml.in @@ -0,0 +1,16 @@ +[package] +name = "suricatactl" +version = "@PACKAGE_VERSION@" +edition = "2021" +license = "GPL-2.0-only" + +[[bin]] +name = "suricatactl" + +[dependencies] +regex = "~1.5.5" +tracing = "0.1" +tracing-subscriber = "0.3" + +# 4.0 is the newest version that builds with Rust 1.67.1. +clap = { version = "=4.2.0", features = ["derive"] } diff --git a/rust/suricatactl/Makefile.am b/rust/suricatactl/Makefile.am new file mode 100644 index 000000000000..acf00aeb6850 --- /dev/null +++ b/rust/suricatactl/Makefile.am @@ -0,0 +1,3 @@ +EXTRA_DIST = Cargo.toml + +all-local: Cargo.toml diff --git a/rust/suricatactl/src/filestore/mod.rs b/rust/suricatactl/src/filestore/mod.rs new file mode 100644 index 000000000000..1169eed1d278 --- /dev/null +++ b/rust/suricatactl/src/filestore/mod.rs @@ -0,0 +1,4 @@ +// SPDX-FileCopyrightText: Copyright 2023 Open Information Security Foundation +// SPDX-License-Identifier: GPL-2.0-only + +pub(crate) mod prune; diff --git a/rust/suricatactl/src/filestore/prune.rs b/rust/suricatactl/src/filestore/prune.rs new file mode 100644 index 000000000000..d4289d82867c --- /dev/null +++ b/rust/suricatactl/src/filestore/prune.rs @@ -0,0 +1,116 @@ +// SPDX-FileCopyrightText: Copyright 2023 Open Information Security Foundation +// SPDX-License-Identifier: GPL-2.0-only + +use std::path::{Path, PathBuf}; +use tracing::{debug, error, info}; + +use crate::FilestorePruneArgs; + +pub(crate) fn prune(args: FilestorePruneArgs) -> Result<(), Box> { + let age = parse_age(&args.age)?; + info!("Pruning files older than {} seconds", age); + + let mut total_bytes = 0; + let mut file_count = 0; + + let mut stack = vec![PathBuf::from(&args.directory)]; + while let Some(dir) = stack.pop() { + for entry in std::fs::read_dir(dir)? { + let path = entry?.path(); + if path.is_dir() { + stack.push(path); + } else { + match FileInfo::from_path(&path) { + Ok(info) => { + if info.age > age { + debug!("Deleting {:?}", path); + file_count += 1; + total_bytes += info.size; + if !args.dry_run { + if let Err(err) = std::fs::remove_file(&path) { + error!("Failed to delete {}: {}", path.display(), err); + } + } + } + } + Err(err) => { + error!( + "Failed to get last modified time of file {}: {}", + path.display(), + err + ); + } + } + } + } + } + + info!("Removed {} files; {} bytes", file_count, total_bytes); + + Ok(()) +} + +struct FileInfo { + age: u64, + size: u64, +} + +impl FileInfo { + fn from_path(path: &Path) -> Result> { + let metadata = path.metadata()?; + let age = metadata.modified()?.elapsed()?.as_secs(); + Ok(Self { + age, + size: metadata.len(), + }) + } +} + +/// Given input like "1s", "1m", "1h" or "1d" return the number of +/// seconds +fn parse_age(age: &str) -> Result { + // Use a regex to separate the value from the unit. + let re = regex::Regex::new(r"^(\d+)([smhd])$").unwrap(); + let caps = re.captures(age).ok_or_else(|| { + format!( + "Invalid age: {}. Must be a number followed by one of s, m, h, d", + age + ) + })?; + let value = caps + .get(1) + .unwrap() + .as_str() + .parse::() + .map_err(|e| format!("Invalid age: {}: {}", age, e))?; + let unit = caps.get(2).unwrap().as_str(); + + match unit { + "s" => Ok(value), + "m" => Ok(value * 60), + "h" => Ok(value * 60 * 60), + "d" => Ok(value * 60 * 60 * 24), + _ => unreachable!(), + } +} + +#[cfg(test)] +mod test { + use super::*; + + #[test] + fn test_parse_age() { + assert!(parse_age("1").is_err()); + assert!(parse_age("s").is_err()); + assert!(parse_age("1a").is_err()); + + // Valid tests + assert_eq!(parse_age("1s").unwrap(), 1); + assert_eq!(parse_age("3s").unwrap(), 3); + assert_eq!(parse_age("1m").unwrap(), 60); + assert_eq!(parse_age("3m").unwrap(), 180); + assert_eq!(parse_age("3h").unwrap(), 10800); + assert_eq!(parse_age("1d").unwrap(), 86400); + assert_eq!(parse_age("3d").unwrap(), 86400 * 3); + } +} diff --git a/rust/suricatactl/src/main.rs b/rust/suricatactl/src/main.rs new file mode 100644 index 000000000000..54e6f6441375 --- /dev/null +++ b/rust/suricatactl/src/main.rs @@ -0,0 +1,72 @@ +// SPDX-FileCopyrightText: Copyright 2023 Open Information Security Foundation +// SPDX-License-Identifier: GPL-2.0-only + +use clap::Parser; +use clap::Subcommand; +use tracing::Level; + +mod filestore; + +#[derive(Parser, Debug)] +struct Cli { + #[arg(long, short, global = true, action = clap::ArgAction::Count)] + verbose: u8, + + #[arg( + long, + short, + global = true, + help = "Quiet mode, only warnings and errors will be logged" + )] + quiet: bool, + + #[command(subcommand)] + command: Commands, +} + +#[derive(Subcommand, Debug)] +enum Commands { + /// Filestore management commands + Filestore(FilestoreCommand), +} + +#[derive(Parser, Debug)] +struct FilestoreCommand { + #[command(subcommand)] + command: FilestoreCommands, +} + +#[derive(Subcommand, Debug)] +enum FilestoreCommands { + /// Remove files by age + Prune(FilestorePruneArgs), +} + +#[derive(Parser, Debug)] +struct FilestorePruneArgs { + #[arg(long, short = 'n', help = "only print what would happen")] + dry_run: bool, + #[arg(long, short, help = "file-store directory")] + directory: String, + #[arg(long, help = "prune files older than age, units: s, m, h, d")] + age: String, +} + +fn main() -> Result<(), Box> { + let cli = Cli::parse(); + + let log_level = if cli.quiet { + Level::WARN + } else if cli.verbose > 0 { + Level::DEBUG + } else { + Level::INFO + }; + tracing_subscriber::fmt().with_max_level(log_level).init(); + + match cli.command { + Commands::Filestore(filestore) => match filestore.command { + FilestoreCommands::Prune(args) => crate::filestore::prune::prune(args), + }, + } +} diff --git a/rust/suricatasc/Cargo.toml.in b/rust/suricatasc/Cargo.toml.in new file mode 100644 index 000000000000..5f1bfc8b8073 --- /dev/null +++ b/rust/suricatasc/Cargo.toml.in @@ -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", features = ["derive"] } + +# 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 index 000000000000..d159169d1050 --- /dev/null +++ b/rust/suricatasc/LICENSE @@ -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. + + + Copyright (C) + + 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. + + , 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 index 000000000000..acf00aeb6850 --- /dev/null +++ b/rust/suricatasc/Makefile.am @@ -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 index 000000000000..a2e62d470cd7 --- /dev/null +++ b/rust/suricatasc/README.md @@ -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 index 000000000000..884c87c2ea32 --- /dev/null +++ b/rust/suricatasc/src/main.rs @@ -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> { + 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 index 000000000000..0c2d381d2fdd --- /dev/null +++ b/rust/suricatasc/src/unix/client.rs @@ -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>(filename: T, verbose: bool) -> Result { + 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::)??; + Ok(()) + } + + pub fn send(&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 { + 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 { + 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 index 000000000000..707e934c8f68 --- /dev/null +++ b/rust/suricatasc/src/unix/commands.rs @@ -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>, + + /// 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, +} + +impl Commands { + pub fn new(server_commands: Vec) -> 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> { + 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 { + 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::()?); + } + 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, +} + +fn command_defs() -> Result>, 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 index 000000000000..e1b7aa45aa25 --- /dev/null +++ b/rust/suricatasc/src/unix/main.rs @@ -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, + + /// Optional path to Suricata unix socket + socket: Option, +} + +pub fn main() -> Result<(), Box> { + 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> { + client.send(&json!({"command": "command-list"}))?; + let response = client.read()?; + let server_commands: Vec = + 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> { + client.send(&json!({"command": "command-list"}))?; + let response = client.read()?; + let server_commands: Vec = + 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 { + 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 index 000000000000..f3b9f5b13b1c --- /dev/null +++ b/rust/suricatasc/src/unix/mod.rs @@ -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 index 000000000000..e0f05f3f43dc --- /dev/null +++ b/rust/suricatasc/src/unix/rustyprompt.rs @@ -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 { + None + } +} + +impl Highlighter for PromptHelper {} + +impl Validator for PromptHelper { + fn validate( + &self, ctx: &mut validate::ValidationContext, + ) -> rustyline::Result { + 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), 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, +} + +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 { + 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; + } + _ => {} + } + } + } +}