Fixed typos in command line help text and readme

README.md

@@ -80,28 +80,28 @@ All options:
 
 ```
 gocanary is a honeytoken/canary collector daemon that listens for http/https/dns requests.
-Alerts will be generated when a predefined haystack is detected.
+Alerts will be generated when a predefined haystack/honeytoken is detected.
 
 Usage:
   gocanary [flags]
 
 Flags:
-      --autocert-domain stringArray   Enable let's encrypt autocertificate (multiple accepted), https-cert and http-key will be ignored
+      --autocert-domain stringArray   Enable let's encrypt autocertificates (multiple accepted), https-cert and http-key will be ignored
   -b, --bind-address string           Ip address to bind servers to
       --cache-dir string              Writable directory for holding up autocertificates (default "./cache")
   -c, --canary-file string            File where canaries are defined (default "canary.yaml")
       --dns-answer-with string        IP address to give as an answer to DNS request matching a canary, if empty NXDOMAIN
-      --dns-not-answer                Do not answer with any response
+      --dns-not-answer                Do not answer with any response, not even NXDOMAIN
       --domain stringArray            Only respond to this domain (multiple accepted)
       --enable-dns                    Enable DNS listeners (tcp and udp) (default true)
-      --enable-hardening              Enable hardening measures (default true)
+      --enable-hardening              Enable extra hardening measures (default true)
       --enable-http                   Enable HTTP listener (default true)
       --enable-https                  Enable HTTPS listener
       --enable-syslog                 Enable logging to syslog
   -h, --help                          help for gocanary
       --http-port uint16              Port for http server (default 80)
-      --https-cert string             File contained the certificate in PEM format (default "cert.pem")
-      --https-key string              File contained the certificate key in PEM format (default "cert.key")
+      --https-cert string             File containing the certificate in PEM format (default "cert.pem")
+      --https-key string              File containing the certificate key in PEM format (default "cert.key")
       --https-port uint16             Port for https server (default 443)
   -s, --slack-hook string             Webhook for alerts
       --slack-silence uint16          Wait this many seconds between each slack alert (default 1)

configtools.go

@@ -70,17 +70,17 @@ func init() {
 	gocanaryCmd.PersistentFlags().Uint16Var(&httpsPort, "https-port", 443, "Port for https server")
 	//autocert?
 	gocanaryCmd.PersistentFlags().StringVar(&dnsAnswerWith, "dns-answer-with", "", "IP address to give as an answer to DNS request matching a canary, if empty NXDOMAIN")
-	gocanaryCmd.PersistentFlags().BoolVar(&dnsNotAnswer, "dns-not-answer", false, "Do not answer with any response")
-	gocanaryCmd.PersistentFlags().StringVar(&httpsCert, "https-cert", "cert.pem", "File contained the certificate in PEM format")
-	gocanaryCmd.PersistentFlags().StringVar(&httpsKey, "https-key", "cert.key", "File contained the certificate key in PEM format")
+	gocanaryCmd.PersistentFlags().BoolVar(&dnsNotAnswer, "dns-not-answer", false, "Do not answer with any response, not even NXDOMAIN")
+	gocanaryCmd.PersistentFlags().StringVar(&httpsCert, "https-cert", "cert.pem", "File containing the certificate in PEM format")
+	gocanaryCmd.PersistentFlags().StringVar(&httpsKey, "https-key", "cert.key", "File containing the certificate key in PEM format")
 	gocanaryCmd.PersistentFlags().StringVar(&cacheDir, "cache-dir", "./cache", "Writable directory for holding up autocertificates")
 	gocanaryCmd.PersistentFlags().BoolVar(&httpsEnabled, "enable-https", false, "Enable HTTPS listener")
 	gocanaryCmd.PersistentFlags().BoolVar(&httpEnabled, "enable-http", true, "Enable HTTP listener")
 	gocanaryCmd.PersistentFlags().BoolVar(&dnsEnabled, "enable-dns", true, "Enable DNS listeners (tcp and udp)")
 	gocanaryCmd.PersistentFlags().BoolVar(&syslogEnabled, "enable-syslog", false, "Enable logging to syslog")
-	gocanaryCmd.PersistentFlags().BoolVar(&hardeningEnabled, "enable-hardening", true, "Enable hardening measures")
+	gocanaryCmd.PersistentFlags().BoolVar(&hardeningEnabled, "enable-hardening", true, "Enable extra hardening measures")
 	gocanaryCmd.PersistentFlags().StringArrayVar(&domains, "domain", []string{}, "Only respond to this domain (multiple accepted)")
-	gocanaryCmd.PersistentFlags().StringArrayVar(&autocertDomains, "autocert-domain", []string{}, "Enable let's encrypt autocertificate (multiple accepted), https-cert and http-key will be ignored")
+	gocanaryCmd.PersistentFlags().StringArrayVar(&autocertDomains, "autocert-domain", []string{}, "Enable let's encrypt autocertificates (multiple accepted), https-cert and http-key will be ignored")
 
 	exePath, err := os.Executable()
 	if err != nil {
@@ -95,7 +95,7 @@ var gocanaryCmd = &cobra.Command{
 	Version: version,
 	Short:   "gocanary is a honeytoken/canary collector implementing multiple listeners like http/https/dns",
 	Long: `gocanary is a honeytoken/canary collector daemon that listens for http/https/dns requests.
-Alerts will be generated when a predefined haystack is detected.`,
+Alerts will be generated when a predefined haystack/honeytoken is detected.`,
 	PersistentPreRunE: initializeConfig,
 	Run:               runCanary,
 }