Generate docs

Author: zeek-bot

script-reference/autogenerated-protocol-analyzer-index.rst

@@ -10834,7 +10834,7 @@ Events
    :param len: The length of the encrypted data.
 
 .. zeek:id:: rdp_connect_request
-   :source-code: base/protocols/rdp/main.zeek 165 170
+   :source-code: base/protocols/rdp/main.zeek 166 171
 
    :Type: :zeek:type:`event` (c: :zeek:type:`connection`, cookie: :zeek:type:`string`, flags: :zeek:type:`count`)
    :Type: :zeek:type:`event` (c: :zeek:type:`connection`, cookie: :zeek:type:`string`)
@@ -10851,7 +10851,7 @@ Events
    :param flags: The flags set by the client.
 
 .. zeek:id:: rdp_negotiation_response
-   :source-code: base/protocols/rdp/main.zeek 172 177
+   :source-code: base/protocols/rdp/main.zeek 173 178
 
    :Type: :zeek:type:`event` (c: :zeek:type:`connection`, security_protocol: :zeek:type:`count`, flags: :zeek:type:`count`)
    :Type: :zeek:type:`event` (c: :zeek:type:`connection`, security_protocol: :zeek:type:`count`)
@@ -10868,7 +10868,7 @@ Events
    :param flags: The flags set by the server.
 
 .. zeek:id:: rdp_negotiation_failure
-   :source-code: base/protocols/rdp/main.zeek 179 184
+   :source-code: base/protocols/rdp/main.zeek 180 185
 
    :Type: :zeek:type:`event` (c: :zeek:type:`connection`, failure_code: :zeek:type:`count`, flags: :zeek:type:`count`)
    :Type: :zeek:type:`event` (c: :zeek:type:`connection`, failure_code: :zeek:type:`count`)
@@ -10885,7 +10885,7 @@ Events
    :param flags: The flags set by the server.
 
 .. zeek:id:: rdp_client_core_data
-   :source-code: base/protocols/rdp/main.zeek 186 212
+   :source-code: base/protocols/rdp/main.zeek 187 213
 
    :Type: :zeek:type:`event` (c: :zeek:type:`connection`, data: :zeek:type:`RDP::ClientCoreData`)
 
@@ -10911,7 +10911,7 @@ Events
    :param data: The data contained in the client security data structure.
 
 .. zeek:id:: rdp_client_network_data
-   :source-code: base/protocols/rdp/main.zeek 214 227
+   :source-code: base/protocols/rdp/main.zeek 215 228
 
    :Type: :zeek:type:`event` (c: :zeek:type:`connection`, channels: :zeek:type:`RDP::ClientChannelList`)
 
@@ -10937,7 +10937,7 @@ Events
    :param data: The data contained in the client security data structure.
 
 .. zeek:id:: rdp_gcc_server_create_response
-   :source-code: base/protocols/rdp/main.zeek 229 234
+   :source-code: base/protocols/rdp/main.zeek 230 235
 
    :Type: :zeek:type:`event` (c: :zeek:type:`connection`, result: :zeek:type:`count`)
 
@@ -10950,7 +10950,7 @@ Events
    :param result: The 8-bit integer representing the GCC Conference Create Response result.
 
 .. zeek:id:: rdp_server_security
-   :source-code: base/protocols/rdp/main.zeek 236 242
+   :source-code: base/protocols/rdp/main.zeek 237 243
 
    :Type: :zeek:type:`event` (c: :zeek:type:`connection`, encryption_method: :zeek:type:`count`, encryption_level: :zeek:type:`count`)
 
@@ -10966,7 +10966,7 @@ Events
    :param encryption_level: The 32-bit integer representing the encryption level used in the connection.
 
 .. zeek:id:: rdp_server_certificate
-   :source-code: base/protocols/rdp/main.zeek 244 256
+   :source-code: base/protocols/rdp/main.zeek 245 257
 
    :Type: :zeek:type:`event` (c: :zeek:type:`connection`, cert_type: :zeek:type:`count`, permanently_issued: :zeek:type:`bool`)
 
@@ -10984,7 +10984,7 @@ Events
    :param permanently_issued: Value will be true is the certificate(s) is permanent on the server.
 
 .. zeek:id:: rdp_begin_encryption
-   :source-code: base/protocols/rdp/main.zeek 258 268
+   :source-code: base/protocols/rdp/main.zeek 259 269
 
    :Type: :zeek:type:`event` (c: :zeek:type:`connection`, security_protocol: :zeek:type:`count`)
 

scripts/base/bif/plugins/Zeek_RDP.events.bif.zeek.rst

@@ -36,7 +36,7 @@ Detailed Interface
 Events
 ######
 .. zeek:id:: rdp_begin_encryption
-   :source-code: base/protocols/rdp/main.zeek 258 268
+   :source-code: base/protocols/rdp/main.zeek 259 269
 
    :Type: :zeek:type:`event` (c: :zeek:type:`connection`, security_protocol: :zeek:type:`count`)
 
@@ -62,7 +62,7 @@ Events
    :param data: The data contained in the client security data structure.
 
 .. zeek:id:: rdp_client_core_data
-   :source-code: base/protocols/rdp/main.zeek 186 212
+   :source-code: base/protocols/rdp/main.zeek 187 213
 
    :Type: :zeek:type:`event` (c: :zeek:type:`connection`, data: :zeek:type:`RDP::ClientCoreData`)
 
@@ -75,7 +75,7 @@ Events
    :param data: The data contained in the client core data structure.
 
 .. zeek:id:: rdp_client_network_data
-   :source-code: base/protocols/rdp/main.zeek 214 227
+   :source-code: base/protocols/rdp/main.zeek 215 228
 
    :Type: :zeek:type:`event` (c: :zeek:type:`connection`, channels: :zeek:type:`RDP::ClientChannelList`)
 
@@ -101,7 +101,7 @@ Events
    :param data: The data contained in the client security data structure.
 
 .. zeek:id:: rdp_connect_request
-   :source-code: base/protocols/rdp/main.zeek 165 170
+   :source-code: base/protocols/rdp/main.zeek 166 171
 
    :Type: :zeek:type:`event` (c: :zeek:type:`connection`, cookie: :zeek:type:`string`, flags: :zeek:type:`count`)
    :Type: :zeek:type:`event` (c: :zeek:type:`connection`, cookie: :zeek:type:`string`)
@@ -118,7 +118,7 @@ Events
    :param flags: The flags set by the client.
 
 .. zeek:id:: rdp_gcc_server_create_response
-   :source-code: base/protocols/rdp/main.zeek 229 234
+   :source-code: base/protocols/rdp/main.zeek 230 235
 
    :Type: :zeek:type:`event` (c: :zeek:type:`connection`, result: :zeek:type:`count`)
 
@@ -147,7 +147,7 @@ Events
    :param len: The length of the encrypted data.
 
 .. zeek:id:: rdp_negotiation_failure
-   :source-code: base/protocols/rdp/main.zeek 179 184
+   :source-code: base/protocols/rdp/main.zeek 180 185
 
    :Type: :zeek:type:`event` (c: :zeek:type:`connection`, failure_code: :zeek:type:`count`, flags: :zeek:type:`count`)
    :Type: :zeek:type:`event` (c: :zeek:type:`connection`, failure_code: :zeek:type:`count`)
@@ -164,7 +164,7 @@ Events
    :param flags: The flags set by the server.
 
 .. zeek:id:: rdp_negotiation_response
-   :source-code: base/protocols/rdp/main.zeek 172 177
+   :source-code: base/protocols/rdp/main.zeek 173 178
 
    :Type: :zeek:type:`event` (c: :zeek:type:`connection`, security_protocol: :zeek:type:`count`, flags: :zeek:type:`count`)
    :Type: :zeek:type:`event` (c: :zeek:type:`connection`, security_protocol: :zeek:type:`count`)
@@ -181,7 +181,7 @@ Events
    :param flags: The flags set by the server.
 
 .. zeek:id:: rdp_server_certificate
-   :source-code: base/protocols/rdp/main.zeek 244 256
+   :source-code: base/protocols/rdp/main.zeek 245 257
 
    :Type: :zeek:type:`event` (c: :zeek:type:`connection`, cert_type: :zeek:type:`count`, permanently_issued: :zeek:type:`bool`)
 
@@ -199,7 +199,7 @@ Events
    :param permanently_issued: Value will be true is the certificate(s) is permanent on the server.
 
 .. zeek:id:: rdp_server_security
-   :source-code: base/protocols/rdp/main.zeek 236 242
+   :source-code: base/protocols/rdp/main.zeek 237 243
 
    :Type: :zeek:type:`event` (c: :zeek:type:`connection`, encryption_method: :zeek:type:`count`, encryption_level: :zeek:type:`count`)
 

scripts/base/protocols/rdp/main.zeek.rst

@@ -70,7 +70,7 @@ Detailed Interface
 Runtime Options
 ###############
 .. zeek:id:: RDP::disable_analyzer_after_detection
-   :source-code: base/protocols/rdp/main.zeek 66 66
+   :source-code: base/protocols/rdp/main.zeek 67 67
 
    :Type: :zeek:type:`bool`
    :Attributes: :zeek:attr:`&redef`
@@ -80,7 +80,7 @@ Runtime Options
    continuing to process encrypted traffic.
 
 .. zeek:id:: RDP::rdp_check_interval
-   :source-code: base/protocols/rdp/main.zeek 70 70
+   :source-code: base/protocols/rdp/main.zeek 71 71
 
    :Type: :zeek:type:`interval`
    :Attributes: :zeek:attr:`&redef`
@@ -92,7 +92,7 @@ Runtime Options
 Types
 #####
 .. zeek:type:: RDP::Info
-   :source-code: base/protocols/rdp/main.zeek 13 62
+   :source-code: base/protocols/rdp/main.zeek 13 63
 
    :Type: :zeek:type:`record`
 
@@ -115,7 +115,8 @@ Types
    .. zeek:field:: cookie :zeek:type:`string` :zeek:attr:`&log` :zeek:attr:`&optional`
 
       Cookie value used by the client machine.
-      This is typically a username.
+      This is typically a username, but note that it will often
+      be truncated on the wire, to a maximum of 9 characters.
 
 
    .. zeek:field:: result :zeek:type:`string` :zeek:attr:`&log` :zeek:attr:`&optional`
@@ -223,7 +224,7 @@ Types
 Events
 ######
 .. zeek:id:: RDP::log_rdp
-   :source-code: base/protocols/rdp/main.zeek 74 74
+   :source-code: base/protocols/rdp/main.zeek 75 75
 
    :Type: :zeek:type:`event` (rec: :zeek:type:`RDP::Info`)
 
@@ -233,7 +234,7 @@ Events
 Hooks
 #####
 .. zeek:id:: RDP::finalize_rdp
-   :source-code: base/protocols/rdp/main.zeek 295 302
+   :source-code: base/protocols/rdp/main.zeek 296 303
 
    :Type: :zeek:type:`Conn::RemovalHook`