diff --git a/scripts/base/frameworks/files/main.bro b/scripts/base/frameworks/files/main.bro index c1883e037f..3cbb0f644b 100644 --- a/scripts/base/frameworks/files/main.bro +++ b/scripts/base/frameworks/files/main.bro @@ -50,9 +50,9 @@ export { ## Connection UIDS over which the file was transferred. conn_uids: set[string] &log; - ## An identification of the source of the file data. E.g. it may be - ## a network protocol over which it was transferred, or a local file - ## path which was read, or some other input source. + ## An identification of the source of the file data. E.g. it + ## may be a network protocol over which it was transferred, or a + ## local file path which was read, or some other input source. source: string &log &optional; ## A value to represent the depth of this file in relation @@ -79,12 +79,12 @@ export { ## If the source of this file is a network connection, this field ## indicates if the data originated from the local network or not as - ## determined by the configured bro:see:`Site::local_nets`. + ## determined by the configured :bro:see:`Site::local_nets`. local_orig: bool &log &optional; ## If the source of this file is a network connection, this field - ## indicates if the file is being sent by the originator of the connection - ## or the responder. + ## indicates if the file is being sent by the originator of the + ## connection or the responder. is_orig: bool &log &optional; ## Number of bytes provided to the file analysis engine for the file. @@ -116,15 +116,15 @@ export { ## The salt concatenated to unique file handle strings generated by ## :bro:see:`get_file_handle` before hashing them in to a file id ## (the *id* field of :bro:see:`fa_file`). - ## Provided to help mitigate the possiblility of manipulating parts of + ## Provided to help mitigate the possibility of manipulating parts of ## network connections that factor in to the file handle in order to ## generate two handles that would hash to the same file id. const salt = "I recommend changing this." &redef; ## Sets the *timeout_interval* field of :bro:see:`fa_file`, which is ## used to determine the length of inactivity that is allowed for a file - ## before internal state related to it is cleaned up. When used within a - ## :bro:see:`file_timeout` handler, the analysis will delay timing out + ## before internal state related to it is cleaned up. When used within + ## a :bro:see:`file_timeout` handler, the analysis will delay timing out ## again for the period specified by *t*. ## ## f: the file. @@ -167,11 +167,12 @@ export { ## f: the file. ## ## Returns: true if analysis for the given file will be ignored for the - ## rest of it's contents, or false if analysis for the *id* + ## rest of its contents, or false if analysis for the *id* ## isn't currently active. global stop: function(f: fa_file): bool; - ## Translates an file analyzer enum value to a string with the analyzer's name. + ## Translates a file analyzer enum value to a string with the analyzer's + ## name. ## ## tag: The analyzer tag. ## @@ -183,7 +184,7 @@ export { ## ## f: The file to be described. ## - ## Returns a text description regarding metadata of the file. + ## Returns: a text description regarding metadata of the file. global describe: function(f: fa_file): string; type ProtoRegistration: record { @@ -198,7 +199,7 @@ export { &default=function(f: fa_file): string { return ""; }; }; - ## Register callbacks for protocols that work with the Files framework. + ## Register callbacks for protocols that work with the Files framework. ## The callbacks must uniquely identify a file and each protocol can ## only have a single callback registered for it. ## @@ -209,10 +210,10 @@ export { ## Returns: true if the protocol being registered was not previously registered. global register_protocol: function(tag: Analyzer::Tag, reg: ProtoRegistration): bool; - ## Register a callback for file analyzers to use if they need to do some manipulation - ## when they are being added to a file before the core code takes over. This is - ## unlikely to be interesting for users and should only be called by file analyzer - ## authors but it *not required*. + ## Register a callback for file analyzers to use if they need to do some + ## manipulation when they are being added to a file before the core code + ## takes over. This is unlikely to be interesting for users and should + ## only be called by file analyzer authors but is *not required*. ## ## tag: Tag for the file analyzer. ##