diff --git a/plugins/notifications/email/email.yaml b/plugins/notifications/email/email.yaml index fa9798062..212362015 100644 --- a/plugins/notifications/email/email.yaml +++ b/plugins/notifications/email/email.yaml @@ -1,35 +1,38 @@ -# Don't change this -type: email +type: email # Don't change +name: email_default # Must match the registered plugin in the profile -name: email_default # this must match with the registered plugin in the profile -log_level: info # Options include: trace, debug, info, warn, error, off +# One of "trace", "debug", "info", "warn", "error", "off" +log_level: info -format: | # This template receives list of models.Alert objects +# group_wait: # Time to wait collecting alerts before relaying a message to this plugin, eg "30s" +# group_threshold: # Amount of alerts that triggers a message before has expired, eg "10" +# max_retry: # Number of attempts to relay messages to plugins in case of error +timeout: 20s # Time to wait for response from the plugin before considering the attempt a failure, eg "10s" + +#------------------------- +# plugin-specific options + +# The following template receives a list of models.Alert objects +# The output goes in the email message body +format: | {{range . -}} {{$alert := . -}} {{range .Decisions -}} - {{.Value}} will get {{.Type}} for next {{.Duration}} for triggering {{.Scenario}} on machine {{$alert.MachineID}}. Shodan + {{.Value}} will get {{.Type}} for next {{.Duration}} for triggering {{.Scenario}} on machine {{$alert.MachineID}}. Shodan {{end -}} {{end -}} -smtp_host: # eg value smtp.gmail.com -smtp_username: #Replace this with your actual username -smtp_password: #Replace this with your actual password -smtp_port: # Common values are any of [25, 465, 587, 2525] -auth_type: # Valid choices are either of "none", "crammd5", "login", "plain" -sender_email: # eg: foo@gmail.com -email_subject: CrowdSec Notification -receiver_emails: - # - email1@gmail.com - # - email2@gmail.com -encryption_type: ssltls # eg valid choices are either "ssltls" or "none" +smtp_host: # example: smtp.gmail.com +smtp_username: # Replace with your actual username +smtp_password: # Replace with your actual password +smtp_port: # Common values are any of [25, 465, 587, 2525] +auth_type: # Valid choices are "none", "crammd5", "login", "plain" +sender_email: # example: foo@gmail.com +email_subject: "CrowdSec Notification" +receiver_emails: +# - email1@gmail.com +# - email2@gmail.com +# One of "ssltls", "none" +encryption_type: ssltls - -# group_wait: # duration to wait collecting alerts before sending to this plugin, eg "30s" - -# group_threshold: # if alerts exceed this, then the plugin will be sent the message. eg "10" - -# max_retry: # number of tries to attempt to send message to plugins in case of error. - -timeout: 20s # duration to wait for response from plugin before considering this attempt a failure. eg "10s" diff --git a/plugins/notifications/http/http.yaml b/plugins/notifications/http/http.yaml index 92dfaaaea..8c93487b0 100644 --- a/plugins/notifications/http/http.yaml +++ b/plugins/notifications/http/http.yaml @@ -1,25 +1,30 @@ -# Don't change this -type: http +type: http # Don't change +name: http_default # Must match the registered plugin in the profile -name: http_default # this must match with the registered plugin in the profile -log_level: info # Options include: trace, debug, info, warn, error, off +# One of "trace", "debug", "info", "warn", "error", "off" +log_level: info -format: | # This template receives list of models.Alert objects. The request body would contain this. +# group_wait: # Time to wait collecting alerts before relaying a message to this plugin, eg "30s" +# group_threshold: # Amount of alerts that triggers a message before has expired, eg "10" +# max_retry: # Number of attempts to relay messages to plugins in case of error +# timeout: # Time to wait for response from the plugin before considering the attempt a failure, eg "10s" + +#------------------------- +# plugin-specific options + +# The following template receives a list of models.Alert objects +# The output goes in the http request body +format: | {{.|toJson}} -url: # plugin will make requests to this url. Eg value https://www.example.com/ +# The plugin will make requests to this url, eg: https://www.example.com/ +url: -method: POST # eg either of "POST", "GET", "PUT" and other http verbs is valid value. +# Any of the http verbs: "POST", "GET", "PUT"... +method: POST # headers: # Authorization: token 0x64312313 -# skip_tls_verification: # either true or false. Default is false +# skip_tls_verification: # true or false. Default is false -# group_wait: # duration to wait collecting alerts before sending to this plugin, eg "30s" - -# group_threshold: # if alerts exceed this, then the plugin will be sent the message. eg "10" - -# max_retry: # number of tries to attempt to send message to plugins in case of error. - -# timeout: # duration to wait for response from plugin before considering this attempt a failure. eg "10s" diff --git a/plugins/notifications/slack/slack.yaml b/plugins/notifications/slack/slack.yaml index 732119354..69c5cece0 100644 --- a/plugins/notifications/slack/slack.yaml +++ b/plugins/notifications/slack/slack.yaml @@ -1,10 +1,20 @@ -# Don't change this -type: slack +type: slack # Don't change +name: slack_default # Must match the registered plugin in the profile -name: slack_default # this must match with the registered plugin in the profile -log_level: info # Options include: trace, debug, info, warn, error, off +# One of "trace", "debug", "info", "warn", "error", "off" +log_level: info -format: | # This template receives list of models.Alert objects +# group_wait: # Time to wait collecting alerts before relaying a message to this plugin, eg "30s" +# group_threshold: # Amount of alerts that triggers a message before has expired, eg "10" +# max_retry: # Number of attempts to relay messages to plugins in case of error +# timeout: # Time to wait for response from the plugin before considering the attempt a failure, eg "10s" + +#------------------------- +# plugin-specific options + +# The following template receives a list of models.Alert objects +# The output goes in the slack message +format: | {{range . -}} {{$alert := . -}} {{range .Decisions -}} @@ -18,10 +28,3 @@ format: | # This template receives list of models.Alert objects webhook: -# group_wait: # duration to wait collecting alerts before sending to this plugin, eg "30s" - -# group_threshold: # if alerts exceed this, then the plugin will be sent the message. eg "10" - -# max_retry: # number of tries to attempt to send message to plugins in case of error. - -# timeout: # duration to wait for response from plugin before considering this attempt a failure. eg "10s" diff --git a/plugins/notifications/splunk/splunk.yaml b/plugins/notifications/splunk/splunk.yaml index ad8b2335e..9cc871843 100644 --- a/plugins/notifications/splunk/splunk.yaml +++ b/plugins/notifications/splunk/splunk.yaml @@ -1,20 +1,21 @@ -# Don't change this -type: splunk +type: splunk # Don't change +name: splunk_default # Must match the registered plugin in the profile -name: splunk_default # this must match with the registered plugin in the profile -log_level: info # Options include: trace, debug, info, warn, error, off +# One of "trace", "debug", "info", "warn", "error", "off" +log_level: info -format: | # This template receives list of models.Alert objects +# group_wait: # Time to wait collecting alerts before relaying a message to this plugin, eg "30s" +# group_threshold: # Amount of alerts that triggers a message before has expired, eg "10" +# max_retry: # Number of attempts to relay messages to plugins in case of error +# timeout: # Time to wait for response from the plugin before considering the attempt a failure, eg "10s" + +#------------------------- +# plugin-specific options + +# The following template receives a list of models.Alert objects +# The output goes in the splunk notification +format: | {{.|toJson}} url: token: - - -# group_wait: # duration to wait collecting alerts before sending to this plugin, eg "30s" - -# group_threshold: # if alerts exceed this, then the plugin will be sent the message. eg "10" - -# max_retry: # number of tries to attempt to send message to plugins in case of error. - -# timeout: # duration to wait for response from plugin before considering this attempt a failure. eg "10s"