Description of SSL related options is incomplete/confusing

[yrro]

• insecure_ssl (bool)

Specifies whether an insecure SSL connection is allowed. If set to false, Splunk does not verify an insecure server certificate. This parameter is set to false by default. Ensure parameter ca_file is not configured in order to allow insecure SSL connections when this value is set to true.

The portion in bold would be better written as: "If set to false, the plugin will verify the TLS server certificate presented by Splunk against the CA certificates provided by the ca_file/ca_path options; if verification fails, the connection will fail."

The portion in italics remains a mystery to me. I think it would be best to remove it. Looking at the code I can't see why setting ca_file would override the value of ssl_insecure.

---

ca_file (string)

The path to a file containing a PEM-format CA certificate.

Would be better written as: "The path to a file containing CA cerificates in PEM format. The plugin will verify the TLS server certificate presented by Splunk against the certificates in this file, unless verification is disabled by the ssl_insecure option."

---

ca_path (string)

The path to a directory containing CA certificates in PEM format.

Would be better written as: "The path to a directory containing CA certificates in PEM format. The plugin will verify the TLS server certificate presented by Splunk against the certificates in this file, unless verification is disabled by the ssl_insecure option."

[hvaghani221]

Hey @yrro, thanks for suggesting doc changes. Can you raise PR with suggested doc changes? Any help would be appreciated.

[yrro]

Of course. I made a couple of other README improvements in the linked PR.