Project

General

Profile

Actions

Bug #5711

open

runmodes: Suricata does not hint anything about missing runmode

Added by Lukas Sismis over 1 year ago. Updated 2 months ago.

Status:
In Progress
Priority:
Normal
Target version:
Affected Versions:
Effort:
Difficulty:
low
Label:
Beginner, C, Good First Issue

Description

When Suricata is run and capture runmode is missing then Suricata only prints out the help page but provides no clue about missing runmode.

Example of running Suricata:
sudo ./src/suricata -c suricata.yaml -l ./LOGS/ -S /dev/null

Example output:

  Suricata 7.0.0-beta1 (876832765 2022-11-24)
  USAGE: /home/local/suricata/src/.libs/suricata [OPTIONS] [BPF FILTER]              
        -c <path>                            : path to configuration file
        -T                                   : test configuration file (use with -c)
        -i <dev or ip>                       : run in pcap live mode
        -F <bpf filter file>                 : bpf filter file
        -r <path>                            : run in pcap file/offline mode
        -s <path>                            : path to signature file loaded in addition to suricata.yaml settings (optional)
        -S <path>                            : path to signature file loaded exclusively (optional)
        -l <dir>                             : default log directory
        -D                                   : run as daemon   
        -k [all|none]                        : force checksum check (all) or disabled it (none)
        -V                                   : display Suricata version
        -v                                   : be more verbose (use multiple times to increase verbosity)
        --list-app-layer-protos              : list supported app layer protocols
        --list-keywords[=all|csv|<kword>]    : list keywords implemented by the engine
        --list-runmodes                      : list supported runmodes
        --runmode <runmode_id>               : specific runmode modification the engine should run.  The argument
                                               supplied should be the id for the runmode obtained by running
                                               --list-runmodes
        --engine-analysis                    : print reports on analysis of different sections in the engine and exit.
                                               Please have a look at the conf parameter engine-analysis on what reports
                                               can be printed                                                                                                                                                                                                  
        --pidfile <file>                     : write pid to this file                                                                                                                                                                                          
        --init-errors-fatal                  : enable fatal failure on signature init error                                                                                                                                                                    
        --disable-detection                  : disable detection engine                                                                                                                                                                               
        --dump-config                        : show the running configuration
        --dump-features                      : display provided features
        --build-info                         : display build information
        --pcap[=<dev>]                       : run in pcap mode, no value select interfaces from suricata.yaml
        --pcap-file-continuous               : when running in pcap mode with a directory, continue checking directory for pcaps until interrupted
        --pcap-file-delete                   : when running in replay mode (-r with directory or file), will delete pcap files that have been processed when done
        --pcap-file-recursive                : will descend into subdirectories when running in replay mode (-r)
        --pcap-buffer-size                   : size of the pcap buffer value from 0 - 2147483647
        --dpdk                               : run in dpdk mode, uses interfaces from suricata.yaml
        --af-packet[=<dev>]                  : run in af-packet mode, no value select interfaces from suricata.yaml
        --simulate-ips                       : force engine into IPS mode. Useful for QA
        --user <user>                        : run suricata as this user after init
        --group <group>                      : run suricata as this group after init
        --erf-in <path>                      : process an ERF file
        --unix-socket[=<file>]               : use unix socket to control suricata work
        --reject-dev <dev>                   : send reject packets from this interface
        --set name=value                     : set a configuration value
  To run the engine with default configuration on interface eth0 with signature file "signatures.rules", run the command as:
  /home/local/suricata/src/.libs/suricata -c suricata.yaml -s signatures.rules -i eth0


Subtasks 1 (1 open0 closed)

Optimization #6572: runmodes: fix `--list-runmodes` outputNewOISF DevActions
Actions #1

Updated by Comfort Amaechi 6 months ago

Can I claim this issue

Actions #2

Updated by Lukas Sismis 6 months ago

  • Assignee changed from OISF Dev to Comfort Amaechi

It's yours ;)

Actions #3

Updated by Comfort Amaechi 6 months ago

  • Status changed from New to Assigned
Actions #4

Updated by Comfort Amaechi 5 months ago

  • Status changed from Assigned to In Progress
Actions #5

Updated by Comfort Amaechi 5 months ago

  • Status changed from In Progress to In Review
Actions #6

Updated by Juliana Fajardini Reichow 5 months ago

  • Target version changed from TBD to 7.0.3
Actions #7

Updated by Victor Julien 4 months ago

  • Target version changed from 7.0.3 to 8.0.0-beta1
Actions #8

Updated by Juliana Fajardini Reichow 4 months ago

  • Subtask #6572 added
Actions #9

Updated by Juliana Fajardini Reichow 2 months ago

  • Status changed from In Review to In Progress
  • Assignee changed from Comfort Amaechi to Community Ticket

Hi there, according to our guidelines for stale tickets, I'm unassigning this ticket.

Thanks for your interest in our project, and feel free to reach out in case you have time and want to contribute to Suricata again, or if you're still working on this task! :) :)

Refer to:
https://forum.suricata.io/t/important-outreachy-contribution-phase-wrap-up-prs-claimed-tickets-and-more
https://docs.suricata.io/en/latest/devguide/contributing/contribution-process.html#stale-tickets-policy

Actions

Also available in: Atom PDF