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

* jsoref/spelling-src:
  Spelling src
This commit is contained in:
Tim Wojtulewicz 2022-11-11 12:48:20 -07:00
commit 2739275b88
190 changed files with 439 additions and 433 deletions

View file

@ -91,7 +91,7 @@ public:
/**
* Returns the analyzer instance's internal ID. These IDs are unique
* across all analyzers instantiated and can thus be used to
* indentify a specific instance.
* identify a specific instance.
*/
ID GetID() const { return id; }
@ -125,7 +125,7 @@ public:
/**
* Signals that the analyzer is to skip all further input
* processsing. This won't have an immediate effect internally, but
* processing. This won't have an immediate effect internally, but
* the flag can be queried through Skipping().
*
* @param do_skip If true, further processing will be skipped.
@ -179,10 +179,10 @@ public:
protected:
/**
* Constructor. Only derived classes are meant to be instantiated.
* @param arg_tag the tag definining the analyzer's type.
* @param arg_args an \c AnalyzerArgs (script-layer type) value specifiying
* @param arg_tag the tag defining the analyzer's type.
* @param arg_args an \c AnalyzerArgs (script-layer type) value specifying
* tunable options, if any, related to a particular analyzer type.
* @param arg_file the file to which the the analyzer is being attached.
* @param arg_file the file to which the analyzer is being attached.
*/
Analyzer(zeek::Tag arg_tag, RecordValPtr arg_args, File* arg_file);
@ -191,9 +191,9 @@ protected:
* As this version of the constructor does not receive a name or tag,
* SetAnalyzerTag() must be called before the instance can be used.
*
* @param arg_args an \c AnalyzerArgs (script-layer type) value specifiying
* @param arg_args an \c AnalyzerArgs (script-layer type) value specifying
* tunable options, if any, related to a particular analyzer type.
* @param arg_file the file to which the the analyzer is being attached.
* @param arg_file the file to which the analyzer is being attached.
*/
Analyzer(RecordValPtr arg_args, File* arg_file);

View file

@ -127,7 +127,7 @@ protected:
file_analysis::Analyzer* InstantiateAnalyzer(const zeek::Tag& tag, RecordValPtr args) const;
/**
* Insert an analyzer instance in to the set.
* Insert an analyzer instance into the set.
* @param a an analyzer instance.
* @param key the hash key which represents the analyzer's \c AnalyzerArgs.
*/
@ -135,7 +135,7 @@ protected:
/**
* Remove an analyzer instance from the set.
* @param tag enumarator which specifies type of the analyzer to remove,
* @param tag enumerator which specifies type of the analyzer to remove,
* just used for debugging messages.
* @param key the hash key which represents the analyzer's \c AnalyzerArgs.
*/

View file

@ -41,7 +41,7 @@ public:
* @param factory A factory function to instantiate instances of the
* analyzer's class, which must be derived directly or indirectly
* from file_analysis::Analyzer. This is typically a static \c
* Instatiate() method inside the class that just allocates and
* Instantiate() method inside the class that just allocates and
* returns a new instance.
*
* @param subtype A subtype associated with this component that
@ -90,7 +90,7 @@ public:
protected:
/**
* Overriden from plugin::Component.
* Overridden from plugin::Component.
*/
void DoDescribe(ODesc* d) const override;

View file

@ -156,7 +156,7 @@ public:
/**
* Inform attached analyzers about a gap in file stream.
* @param offset number of bytes in to file at which missing chunk starts.
* @param offset number of bytes into file at which missing chunk starts.
* @param len length in bytes of the missing chunk of file data.
*/
void Gap(uint64_t offset, uint64_t len);

View file

@ -327,7 +327,7 @@ File* Manager::GetFile(const string& file_id, Connection* conn, const zeek::Tag&
rval->ScheduleInactivityTimer();
// Generate file_new after inserting it into manager's mapping
// in case script-layer calls back in to core from the event.
// in case script-layer calls back into core from the event.
rval->FileEvent(file_new);
// Same for file_over_new_connection.
rval->RaiseFileOverNewConnection(conn, is_orig);

View file

@ -48,7 +48,7 @@ public:
~Manager();
/**
* First-stage initializion of the manager. This is called early on
* First-stage initialization of the manager. This is called early on
* during Zeek's initialization, before any scripts are processed.
*/
void InitPreScript();
@ -105,7 +105,7 @@ public:
* This parameter only has any effect for the first DataIn call of each
* file. It is ignored for all subsequent calls.
* @return a unique file ID string which, in certain contexts, may be
* cached and passed back in to a subsequent function call in order
* cached and passed back into a subsequent function call in order
* to avoid costly file handle lookups (which have to go through
* the \c get_file_handle script-layer event). An empty string
* indicates the associate file is not going to be analyzed further.
@ -131,7 +131,7 @@ public:
* disabled.
* This parameter is only used for the first bit of data for each file.
* @return a unique file ID string which, in certain contexts, may be
* cached and passed back in to a subsequent function call in order
* cached and passed back into a subsequent function call in order
* to avoid costly file handle lookups (which have to go through
* the \c get_file_handle script-layer event). An empty string
* indicates the associated file is not going to be analyzed further.
@ -201,7 +201,7 @@ public:
/**
* Signal a gap in the file data stream.
* @param offset number of bytes in to file at which missing chunk starts.
* @param offset number of bytes into file at which missing chunk starts.
* @param len length in bytes of the missing chunk of file data.
* @param tag network protocol over which the file data is transferred.
* @param conn network connection over which the file data is transferred.
@ -210,7 +210,7 @@ public:
* @param precomputed_file_id may be set to a previous return value in order to
* bypass costly file handle lookups.
* @return a unique file ID string which, in certain contexts, may be
* cached and passed back in to a subsequent function call in order
* cached and passed back into a subsequent function call in order
* to avoid costly file handle lookups (which have to go through
* the \c get_file_handle script-layer event). An empty string
* indicates the associate file is not going to be analyzed further.
@ -228,7 +228,7 @@ public:
* @param precomputed_file_id may be set to a previous return value in order to
* bypass costly file handle lookups.
* @return a unique file ID string which, in certain contexts, may be
* cached and passed back in to a subsequent function call in order
* cached and passed back into a subsequent function call in order
* to avoid costly file handle lookups (which have to go through
* the \c get_file_handle script-layer event). An empty string
* indicates the associate file is not going to be analyzed further.
@ -290,7 +290,7 @@ public:
File* LookupFile(const std::string& file_id) const;
/**
* Queue attachment of an analzer to the file identifier. Multiple
* Queue attachment of an analyzer to the file identifier. Multiple
* analyzers of a given type can be attached per file identifier at a time
* as long as the arguments differ.
* @param file_id the file identifier/hash.
@ -319,8 +319,8 @@ public:
/**
* Instantiates a new file analyzer instance for the file.
* @param tag The file analyzer's tag.
* @param args The file analzer argument/option values.
* @param f The file analzer is to be associated with.
* @param args The file analyzer argument/option values.
* @param f The file analyzer is to be associated with.
* @return The new analyzer instance or null if tag is invalid.
*/
Analyzer* InstantiateAnalyzer(const Tag& tag, RecordValPtr args, File* f) const;
@ -330,7 +330,7 @@ public:
* chunk of data.
* @param data A chunk of bytes to match magic MIME signatures against.
* @param len The number of bytes in \a data.
* @param rval An optional pre-existing structure in which to insert
* @param rval An optional preexisting structure in which to insert
* new matches. If it's a null pointer, an object is
* allocated and returned from the method.
* @return Set of all matching file magic signatures, which may be

View file

@ -42,7 +42,7 @@ public:
* @param args the \c AnalyzerArgs value which represents the analyzer.
* @param file the file to which the analyzer will be attached.
* @return the new DataEvent analyzer instance or a null pointer if
* no "chunk_event" or "stream_event" field was specfied in \a args.
* no "chunk_event" or "stream_event" field was specified in \a args.
*/
static file_analysis::Analyzer* Instantiate(RecordValPtr args, file_analysis::File* file);

View file

@ -34,7 +34,7 @@ public:
/**
* Finalizes the hash and raises a "file_hash" event.
* @return always false so analyze will be deteched from file.
* @return always false so analyze will be detached from file.
*/
bool EndOfFile() override;

View file

@ -164,7 +164,7 @@ RecordValPtr X509::ParseCertificate(X509Val* cert_val, file_analysis::File* f)
// we only read 255 bytes because byte 256 is always 0.
// if the string is longer than 255, that will be our null-termination,
// otherwhise i2t does null-terminate.
// otherwise i2t does null-terminate.
ASN1_OBJECT* algorithm;
X509_PUBKEY_get0_param(&algorithm, NULL, NULL, NULL, X509_get_X509_PUBKEY(ssl_cert));
if ( ! i2t_ASN1_OBJECT(buf, 255, algorithm) )
@ -280,7 +280,7 @@ X509_STORE* X509::GetRootStore(TableVal* root_certs)
X509_free(x);
}
// Save the newly constructed certificate store into the cacheing map.
// Save the newly constructed certificate store into the caching map.
x509_stores[root_certs] = ctx;
return ctx;

View file

@ -193,7 +193,7 @@ double X509Common::GetTimeFromAsn1(const ASN1_TIME* atime, file_analysis::File*
void X509Common::ParseSignedCertificateTimestamps(X509_EXTENSION* ext)
{
// Ok, signed certificate timestamps are a bit of an odd case out; we don't
// want to use the (basically nonexistant) OpenSSL functionality to parse them.
// want to use the (basically nonexistent) OpenSSL functionality to parse them.
// Instead we have our own, self-written binpac parser to parse just them,
// which we will initialize here and tear down immediately again.

View file

@ -24,7 +24,7 @@ static zeek::RecordValPtr x509_result_record(uint64_t num, const char* reason, z
return rrecord;
}
// get all cretificates starting at the second one (assuming the first one is the host certificate)
// get all certificates starting at the second one (assuming the first one is the host certificate)
STACK_OF(X509)* x509_get_untrusted_stack(zeek::VectorVal* certs_vec)
{
STACK_OF(X509)* untrusted_certs = sk_X509_new_null();
@ -83,7 +83,7 @@ X509* x509_get_ocsp_signer(const STACK_OF(X509)* certs,
return X509_find_by_subject(const_cast<STACK_OF(X509)*>(certs),
const_cast<X509_NAME*>(name));
// Just like OpenSSL, we just support SHA-1 lookups and bail out otherwhise.
// Just like OpenSSL, we just support SHA-1 lookups and bail out otherwise.
if ( key->length != SHA_DIGEST_LENGTH )
return 0;
@ -660,7 +660,7 @@ x509_verify_chainerror:
## This only has to be provided if the SCT was encountered in an X.509
## certificate extension; in that case, it is necessary for validation.
##
## Returns: T if the validation could be performed succesfully, F otherwhise.
## Returns: T if the validation could be performed successfully, F otherwise.
##
## .. zeek:see:: ssl_extension_signed_certificate_timestamp
## x509_ocsp_ext_signed_certificate_timestamp

View file

@ -87,11 +87,11 @@ event ocsp_response_bytes%(f: fa_file, status: string, version: count, responder
##
## revokeTime: Time the certificate was revoked, 0 if not revoked.
##
## revokeTeason: Reason certificate was revoked; empty string if not revoked or not specified.
## revokeReason: Reason certificate was revoked; empty string if not revoked or not specified.
##
## thisUpdate: Time this response was generated.
##
## nextUpdate: Time next response will be ready; 0 if not supploed.
## nextUpdate: Time next response will be ready; 0 if not supplied.
##
## .. zeek:see:: ocsp_request ocsp_request_certificate ocsp_response_status
## ocsp_response_bytes ocsp_extension