summaryrefslogtreecommitdiffstats
path: root/python/bin/suricatasc
diff options
context:
space:
mode:
Diffstat (limited to 'python/bin/suricatasc')
-rwxr-xr-xpython/bin/suricatasc100
1 files changed, 100 insertions, 0 deletions
diff --git a/python/bin/suricatasc b/python/bin/suricatasc
new file mode 100755
index 0000000..d090f85
--- /dev/null
+++ b/python/bin/suricatasc
@@ -0,0 +1,100 @@
+#! /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()