Debug mode enabled-f5-all

Debug mode enabled-f5-all
0

Debug mode enabled-f5-all

Vendor: f5

OS: all

Description:
Indeni will alert if one of the debug mechanisms on a device is enabled when the default is for it to be disabled.

Remediation Steps:
Turn off the debug as soon as possible.

How does this work?
This alert logs into the F5 unit via iControl REST and retrieves the status of the tm.rstcause.log flag.

Why is this important?
Setting the tm.rstcause.log flag would make the F5 device generate TCP RST log entries in the /var/log/ltm log file. However, if there is a very high amount being sent this has an impact on performance and could also fill up available disk space. Thus, leaving the setting on by mistake could result in problems later on.

Without Indeni how would you find this?
An administrator would be able to see if the flag is on by logging into the device through SSH, entering TMSH and issuing the command “list sys db tm.rstcause.log”.

f5-rest-mgmt-tm-sys-db-rstcause-log

name: f5-rest-mgmt-tm-sys-db-rstcause-log
description: Determine if the debug value tm.rstcause.log is set
type: monitoring
monitoring_interval: 30 minutes
requires:
    vendor: f5
    product: load-balancer
    rest-api: 'true'
comments:
    debug-status:
        why: |
            Setting the tm.rstcause.log flag would make the F5 device generate TCP RST log entries in the /var/log/ltm log file. However, if there is a very high amount being sent this has an impact on performance and could also fill up available disk space. Thus, leaving the setting on by mistake could result in problems later on.
        how: |
            This alert logs into the F5 unit via iControl REST and retrieves the status of the tm.rstcause.log flag.
        without-indeni: |
            An administrator would be able to see if the flag is on by logging into the device through SSH, entering TMSH and issuing the command "list sys db tm.rstcause.log".
        can-with-snmp: false
        can-with-syslog: false
steps:
-   run:
        type: HTTP
        command: /mgmt/tm/sys/db/tm.rstcause.log?$select=value
    parse:
        type: JSON
        file: rest-mgmt-tm-sys-db-rstcause-log.parser.1.json.yaml

cross_vendor_debug_on

// Deprecation warning : Scala template-based rules are deprecated. Please use YAML format rules instead.

package com.indeni.server.rules.library.templatebased.crossvendor

import com.indeni.server.rules.RuleContext
import com.indeni.server.rules.library.templates.StateDownTemplateRule
import com.indeni.server.rules.RemediationStepCondition

/**
  *
  */
case class cross_vendor_debug_on() extends StateDownTemplateRule(
  ruleName = "cross_vendor_debug_on",
  ruleFriendlyName = "All Devices: Debug mode enabled",
  ruleDescription = "Indeni will alert if one of the debug mechanisms on a device is enabled when the default is for it to be disabled.",
  metricName = "debug-status",
  applicableMetricTag = "name",
  alertIfDown = false,
  alertItemsHeader = "Debugs Enabled",
  alertDescription = "One or more debug flags or components is enabled. Leaving debug on for too long may result in performance issues.",
  baseRemediationText = "Turn off the debug as soon as possible.",
  itemSpecificDescription = Seq(
    "^watchdog$".r -> "In the event of a system lock-up, the watchdog process ensures that the BIG-IP system restarts and fails over. In order to force the BIG-IP system to produce a core file for diagnostic purposes, administrators must disable the watchdog process to allow the core file to be written to disk before the system restarts. Re-enable the watchdog.",
    "^mcpd-force-reload$".r -> "If /service/mcpd/forceload exists any reboot would take longer than usual. In case of an outage together with a degraded cluster this could mean increased downtime in case a cluster member is restarted.",
    "^tm\\.rstcause\\.log$".r -> "Enabling RST cause logging uses additional system resources when connections are reset. This can be used for additional traction by an attacked performing a DDOS attack. This is not recommended to leave enabled unless it is for troubleshooting purposes.",
    "^tm\\.rstcause\\.pkt$".r -> "Enabling RST cause information in the packet payload may disclose details about your environment to a potential attacker. This is not recommended to leave enabled unless it is for troubleshooting purposes.",
    "^tcpdump$".r -> "Packet sniffer, useful for troubleshooting network issues. Left on it can result in performance issues.",
    ".*".r -> ""
  )
)(
  RemediationStepCondition.VENDOR_F5 -> "Follow the applicable remediation steps. mcpd-force-reload: Delete the file /service/mcpd/forceload (https://support.f5.com/csp/article/K13030), tm.rstcause.log: https://support.f5.com/csp/article/K13223, tm.rstcause.pkt: https://support.f5.com/csp/article/K13223 ",
  RemediationStepCondition.VENDOR_CP -> "If the above list includes kernel debugging, run \"fw ctl debug 0\" to clear the debugs.",
  RemediationStepCondition.VENDOR_PANOS -> "Log into the device using SSH, type \"debug \" and then begin typing the items listed above. Usually the last term in the command can be replaced with a \"show\" or something similar to identify the current settings.\nFor a list of debug commands and purpose, refer to this table: https://indeni.atlassian.net/wiki/spaces/IKP/pages/536117271/Palo+Alto+Networks+Debugs+Cheat+Sheet",
  RemediationStepCondition.VENDOR_CISCO ->
    """|
      |1. Use the "show debug" NX-OS command to display the current debug status and the "undebug all" command to disable all debugging.""".stripMargin
)