Merge remote-tracking branch 'jsoref/spelling-scripts'

* jsoref/spelling-scripts:
  Spelling fixes: scripts

CHANGES

@@ -1,3 +1,7 @@
+5.2.0-dev.175 | 2022-11-02 16:54:57 -0700
+
+  * Spelling fixes: scripts (Josh Soref)
+
 5.2.0-dev.173 | 2022-11-02 10:45:34 +0100
 
   * GH-2440: parse.y: Traverse AST post parsing to detect break/next

VERSION

@@ -1 +1 @@
-5.2.0-dev.173
+5.2.0-dev.175

scripts/base/files/x509/certificate-event-cache.zeek

@@ -53,7 +53,7 @@ event zeek_init() &priority=5
 hook x509_certificate_cache_replay(f: fa_file, e: X509::Info, sha256: string)
 	{
 	# we encountered a cached cert. The X509 analyzer will skip it. Let's raise all the events that it typically
-	# raises by ourselfes.
+	# raises by ourselves.
 
 	# first - let's checked if it already has an x509 record. That would mean that someone raised the file_hash event
 	# several times for the certificate - in which case we bail out.

scripts/base/files/x509/log-ocsp.zeek

@@ -15,7 +15,7 @@ export {
 		id: string &log;
 		## Hash algorithm used to generate issuerNameHash and issuerKeyHash.
 		hashAlgorithm: string &log;
-		## Hash of the issuer's distingueshed name.
+		## Hash of the issuer's distinguished name.
 		issuerNameHash: string &log;
 		## Hash of the issuer's public key.
 		issuerKeyHash: string &log;

scripts/base/files/x509/main.zeek

@@ -122,7 +122,7 @@ event zeek_init() &priority=5
 	# We use MIME types internally to distinguish between user and CA certificates.
 	# The first certificate in a connection always gets tagged as user-cert, all
 	# following certificates get tagged as CA certificates. Certificates gotten via
-	# other means (e.g. identified from HTTP traffic when they are transfered in plain
+	# other means (e.g. identified from HTTP traffic when they are transferred in plain
 	# text) get tagged as application/pkix-cert.
 	Files::register_for_mime_type(Files::ANALYZER_X509, "application/x-x509-user-cert");
 	Files::register_for_mime_type(Files::ANALYZER_X509, "application/x-x509-ca-cert");

scripts/base/frameworks/broker/main.zeek

@@ -131,7 +131,7 @@ export {
 	## Whether calling :zeek:see:`Broker::peer` will register the Broker
 	## system as an I/O source that will block the process from shutting
 	## down.  For example, set this to false when you are reading pcaps,
-	## but also want to initaiate a Broker peering and still shutdown after
+	## but also want to initiate a Broker peering and still shutdown after
 	## done reading the pcap.
 	option peer_counts_as_iosource = T;
 

scripts/base/frameworks/broker/store.zeek

@@ -157,7 +157,7 @@ export {
 	## Returns: the result of the query.
 	global get: function(h: opaque of Broker::Store, k: any): QueryResult;
 
-	## Insert a key-value pair in to the store, but only if the key does not
+	## Insert a key-value pair into the store, but only if the key does not
 	## already exist.
 	##
 	## h: the handle of the store to modify.
@@ -190,7 +190,7 @@ export {
 	global get_index_from_value: function(h: opaque of Broker::Store,
 	                                      k: any, i: any): QueryResult;
 
-	## Insert a key-value pair in to the store.
+	## Insert a key-value pair into the store.
 	##
 	## h: the handle of the store to modify.
 	##
@@ -351,7 +351,7 @@ export {
 	                     e: interval &default=0sec) : bool;
 
 	## Returns a set with all of a store's keys. The results reflect a snapshot
-	## in time that may diverge from reality soon afterwards.   When acessing
+	## in time that may diverge from reality soon afterwards.   When accessing
 	## any of the element, it may no longer actually be there. The function is
 	## also expensive for large stores, as it copies the complete set.
 	##

scripts/base/frameworks/cluster/pools.zeek

@@ -29,7 +29,7 @@ export {
 		## The maximum number of nodes that may belong to the pool.
 		## If not set, then all available nodes will be added to the pool,
 		## else the cluster framework will automatically limit the pool
-		## membership according to the threshhold.
+		## membership according to the threshold.
 		max_nodes: count &optional;
 		## Whether the pool requires exclusive access to nodes.  If true,
 		## then *max_nodes* nodes will not be assigned to any other pool.

scripts/base/frameworks/config/main.zeek

@@ -15,7 +15,7 @@ export {
 
 	## Represents the data in config.log.
 	type Info: record {
-		## Timestamp at which the configuration change occured.
+		## Timestamp at which the configuration change occurred.
 		ts: time &log;
 		## ID of the value that was changed.
 		id: string &log;

scripts/base/frameworks/files/magic/libmagic.sig

@@ -1,7 +1,7 @@
 # These signatures were semi-automatically generated from libmagic's
 # (~ v5.17) magic database rules that have an associated mime type.
-# After generating, they were all manually reviewed and occassionally
-# needed minor modifications by hand or were just ommited depending on
+# After generating, they were all manually reviewed and occasionally
+# needed minor modifications by hand or were just omitted depending on
 # the complexity of the original magic rules.
 #
 # The instrumented version of the `file` command used to generate these
@@ -1370,7 +1370,7 @@ signature file-magic-auto532 {
 #}
 
 # The use of non-sequential offsets and relational operations made the
-# autogenerated signature incorrrect.
+# autogenerated signature incorrect.
 # >0  belong&,>100 (0x00000064), [""], swap_endian=0
 # >>8  belong&,<3 (0x00000003), [""], swap_endian=0
 # >>>12  belong&,<33 (0x00000021), [""], swap_endian=0

scripts/base/frameworks/logging/main.zeek

@@ -109,7 +109,7 @@ export {
 		path: string;		##< Original path value.
 		open: time;		##< Time when opened.
 		close: time;		##< Time when closed.
-		terminating: bool;	##< True if rotation occured due to Zeek shutting down.
+		terminating: bool;	##< True if rotation occurred due to Zeek shutting down.
 	};
 
 	## The function type for log rotation post processors.
@@ -151,7 +151,7 @@ export {
 		## will generally fail.
 		dir: string &default = default_rotation_dir;
 
-		## A base name to use for the the rotated log.  Log writers may later
+		## A base name to use for the rotated log.  Log writers may later
 		## append a file extension of their choosing to this user-chosen
 		## base (e.g. if using the default ASCII writer and you want
 		## rotated files of the format "foo-<date>.log", then this basename
@@ -579,7 +579,7 @@ export {
 	## log write, prior to iterating over the stream's associated filters.
 	## As with filter-specific hooks, breaking from the hook vetoes writing
 	## of the given log record. Note that filter-level policy hooks still get
-	## invoked after the global hook vetos, but they cannot "un-veto" the write.
+	## invoked after the global hook vetoes, but they cannot "un-veto" the write.
 	global log_stream_policy: Log::StreamPolicyHook;
 }
 
@@ -685,7 +685,7 @@ function Log::rotation_format_func(ri: Log::RotationFmtInfo): Log::RotationPath
 	# The reason for branching here is historical:
 	# the default format path before the intro of Log::rotation_format_func
 	# always separated the path from open-time using a '-', but ASCII's
-	# default postprocessor chose to rename using a '.' separaor.  It also
+	# default postprocessor chose to rename using a '.' separator.  It also
 	# chose a different date format.
 	if ( ri$postprocessor == __default_rotation_postprocessor &&
 	    ri$writer == WRITER_ASCII &&

scripts/base/frameworks/netcontrol/cluster.zeek

@@ -53,7 +53,7 @@ function add_rule(r: Rule) : string
 		return add_rule_impl(r);
 	else
 		{
-		# We sync rule entities accross the cluster, so we
+		# We sync rule entities across the cluster, so we
 		# actually can test if the rule already exists. If yes,
 		# refuse insertion already at the node.
 

scripts/base/frameworks/netcontrol/main.zeek

@@ -55,7 +55,7 @@ export {
 	##
 	## t: How long to whitelist it, with 0 being indefinitely.
 	##
-	## location: An optional string describing whitelist was triddered.
+	## location: An optional string describing whitelist was triggered.
 	##
 	## Returns: The id of the inserted rule on success and zero on failure.
 	global whitelist_address: function(a: addr, t: interval, location: string &default="") : string;
@@ -66,7 +66,7 @@ export {
 	##
 	## t: How long to whitelist it, with 0 being indefinitely.
 	##
-	## location: An optional string describing whitelist was triddered.
+	## location: An optional string describing whitelist was triggered.
 	##
 	## Returns: The id of the inserted rule on success and zero on failure.
 	global whitelist_subnet: function(s: subnet, t: interval, location: string &default="") : string;
@@ -904,7 +904,7 @@ function rule_expire_impl(r: Rule, p: PluginState) &priority=-5 &is_used
 	if ( p$_id in rule$_no_expire_plugins )
 		{
 		# in this case - don't log anything, just remove the plugin from the rule
-		# and cleaup
+		# and cleanup
 		delete rule$_active_plugin_ids[p$_id];
 		delete rule$_no_expire_plugins[p$_id];
 		rule_cleanup(rule);
@@ -1047,7 +1047,7 @@ function rule_error_impl(r: Rule, p: PluginState, msg: string &default="") &is_u
 	else
 		{
 		# error during insertion. Meh. If we are the only plugin, remove the rule again.
-		# Otherwhise - keep it, minus us.
+		# Otherwise - keep it, minus us.
 		delete rule$_plugin_ids[p$_id];
 		if ( |rule$_plugin_ids| == 0 )
 			{

scripts/base/frameworks/netcontrol/plugin.zeek

@@ -54,7 +54,7 @@ export {
 		init: function(state: PluginState) &optional;
 
 		## One-time finalization function called when a plugin is shutdown; no further
-		## functions will be called afterwords.
+		## functions will be called afterwards.
 		done: function(state: PluginState) &optional;
 
 		## Implements the add_rule() operation. If the plugin accepts the rule,
@@ -74,7 +74,7 @@ export {
 	## Table for a plugin to store instance-specific configuration information.
 	##
 	## Note, it would be nicer to pass the Plugin instance to all the below, instead
-	## of this state table. However Zeek's type resolver has trouble with refering to a
+	## of this state table. However Zeek's type resolver has trouble with referring to a
 	## record type from inside itself.
 	redef record PluginState += {
 		## The plugin that the state belongs to. (Defined separately

scripts/base/frameworks/netcontrol/types.zeek

@@ -43,7 +43,7 @@ export {
 		ty: EntityType;			##< Type of entity.
 		conn: conn_id &optional;	##< Used with :zeek:enum:`NetControl::CONNECTION`.
 		flow: Flow &optional;	##< Used with :zeek:enum:`NetControl::FLOW`.
-		ip: subnet &optional;		##< Used with :zeek:enum:`NetControl::ADDRESS` to specifiy a CIDR subnet.
+		ip: subnet &optional;		##< Used with :zeek:enum:`NetControl::ADDRESS` to specify a CIDR subnet.
 		mac: string &optional;		##< Used with :zeek:enum:`NetControl::MAC`.
 	};
 

scripts/base/frameworks/notice/actions/pp-alarms.zeek

@@ -44,7 +44,7 @@ function want_pp() : bool
 		&& (mail_dest != "" || mail_dest_pretty_printed != ""));
 	}
 
-# Opens and intializes the output file.
+# Opens and initializes the output file.
 function pp_open()
 	{
 	if ( pp_alarms_open )

scripts/base/frameworks/notice/main.zeek

@@ -276,7 +276,7 @@ export {
 
 	## This event is generated when a notice begins to be suppressed.
 	##
-	## ts: time indicating then when the notice to be suppressed occured.
+	## ts: time indicating then when the notice to be suppressed occurred.
 	##
 	## suppress_for: length of time that this notice should be suppressed.
 	##
@@ -288,7 +288,7 @@ export {
 	## This is an internal event that is used to broadcast the begin_suppression
 	## event over a cluster.
 	##
-	## ts: time indicating then when the notice to be suppressed occured.
+	## ts: time indicating then when the notice to be suppressed occurred.
 	##
 	## suppress_for: length of time that this notice should be suppressed.
 	##

scripts/base/frameworks/openflow/cluster.zeek

@@ -108,7 +108,7 @@ function unregister_controller(controller: Controller)
 
 function lookup_controller(name: string): vector of Controller
 	{
-	# we only run the on the manager. Otherwhise we don't have a mapping or state -> return empty
+	# we only run the on the manager. Otherwise we don't have a mapping or state -> return empty
 	if ( Cluster::local_node_type() != Cluster::MANAGER )
 		return vector();
 

scripts/base/frameworks/openflow/consts.zeek

@@ -83,7 +83,7 @@ export {
 	const IP_IPIP = 0x04;
 	# Internet Stream Protocol (RFC1190;RFC1819)
 	const IP_ST = 0x05;
-	# Tansmission Control Protocol (RFC793)
+	# Transmission Control Protocol (RFC793)
 	const IP_TCP = 0x06;
 	# Core-based trees (RFC2189)
 	const IP_CBT = 0x07;
@@ -126,7 +126,7 @@ export {
 	const INVALID_COOKIE = 0x7fffffffffffffff;
 	# Openflow physical port definitions
 	## Send the packet out the input port. This
-	## virual port must be explicitly used in
+	## virtual port must be explicitly used in
 	## order to send back out of the input port.
 	const OFPP_IN_PORT = 0xfffffff8;
 	## Perform actions in flow table.

scripts/base/frameworks/openflow/types.zeek

@@ -102,7 +102,7 @@ export {
 		hard_timeout: count &default=0;
 		## Priority level of flow entry.
 		priority: count &default=0;
-		## For OFPFC_DELETE* commands, require matching entried to include
+		## For OFPFC_DELETE* commands, require matching entry to include
 		## this as an output port/group. OFPP_ANY/OFPG_ANY means no restrictions.
 		out_port: count &optional;
 		out_group: count &optional;

scripts/base/frameworks/sumstats/cluster.zeek

@@ -227,7 +227,7 @@ global stats_keys: table[string] of set[Key] &read_expire=1min
 		return 0secs;
 		};
 
-# This variable is maintained by manager nodes to track how many "dones" they
+# This variable is maintained by manager nodes to track how many "nodes" they
 # collected per collection unique id.  Once the number of results for a uid
 # matches the number of peer nodes that results should be coming from, the
 # result is written out and deleted from here.

scripts/base/frameworks/supervisor/control.zeek

@@ -74,7 +74,7 @@ export {
 	##
 	## reqid: an arbitrary string that will be directly echoed in the response
 	##
-	## node: the name of the node to destory or empty string to mean "all
+	## node: the name of the node to destroy or empty string to mean "all
 	##       nodes".
 	global SupervisorControl::destroy_request: event(reqid: string, node: string);