diff --git a/lib/msf/core/exploit/git/lfs.rb b/lib/msf/core/exploit/git/lfs.rb index 7b659c8507..dc4ca9befa 100644 --- a/lib/msf/core/exploit/git/lfs.rb +++ b/lib/msf/core/exploit/git/lfs.rb @@ -14,9 +14,9 @@ size #{obj_data.length} # Generates a Git LFS response to a batch request # - # @param [Rex::Proto::Http::Request] the Git LFS request - # @param [String] the URL of the Git server - # @param [Array] list of objects in Git repo + # @param request [Rex::Proto::Http::Request] The Git LFS request + # @param server_addr [String] The URL of the Git server + # @param repo_objects [Array] The list of objects in the Git repo # # @return [Msf::Exploit::Git::Lfs::Response] def get_batch_response(request, server_addr, repo_objects) @@ -59,8 +59,8 @@ size #{obj_data.length} # Generates a response to a Git LFS object request # - # @param [Rex::Proto::Http::Request] Git client request - # @param [Array] list of objects in Git repository + # @param request [Rex::Proto::Http::Request] Git client request + # @param repo_objects [Array] List of objects in Git repository # # @return [Msf::Exploit::Git::Lfs::Response] def get_requested_obj_response(request, repo_objects) diff --git a/lib/msf/core/module.rb b/lib/msf/core/module.rb index 3bdfefdcb3..fe628a81bf 100644 --- a/lib/msf/core/module.rb +++ b/lib/msf/core/module.rb @@ -184,7 +184,7 @@ module Msf end end - # @param[Constant] One or more Ruby constants + # @param rb_modules [Constant] One or more Ruby constants # @return [void] def register_extensions(*rb_modules) datastore[REPLICANT_EXTENSION_DS_KEY] = [] unless datastore[REPLICANT_EXTENSION_DS_KEY].present? diff --git a/lib/msf/ui/console/module_option_tab_completion.rb b/lib/msf/ui/console/module_option_tab_completion.rb index d2eebd6f1f..20cfeef29d 100644 --- a/lib/msf/ui/console/module_option_tab_completion.rb +++ b/lib/msf/ui/console/module_option_tab_completion.rb @@ -10,10 +10,10 @@ module Msf # # Tab completion for datastore names # - # @param [Msf::DataStore] datastore - # @param str [String] the string currently being typed before tab was hit - # @param words [Array] the previously completed words on the command - # line. `words` is always at least 1 when tab completion has reached this + # @param datastore [Msf::DataStore] + # @param _str [String] the string currently being typed before tab was hit + # @param _words [Array] the previously completed words on the command + # line. `_words` is always at least 1 when tab completion has reached this # stage since the command itself has been completed. def tab_complete_datastore_names(datastore, _str, _words) keys = ( @@ -28,14 +28,14 @@ module Msf # # Tab completion for a module's datastore names # - # @param [Msf::Module] mod + # @param mod [Msf::Module] # @param str [String] the string currently being typed before tab was hit # @param words [Array] the previously completed words on the command # line. `words` is always at least 1 when tab completion has reached this # stage since the command itself has been completed. - def tab_complete_module_datastore_names(mod, _str, _words) + def tab_complete_module_datastore_names(mod, str, words) datastore = mod ? mod.datastore : framework.datastore - keys = tab_complete_datastore_names(datastore, _str, _words) + keys = tab_complete_datastore_names(datastore, str, words) if mod keys = keys.delete_if do |name| diff --git a/lib/rex/parser/net_sarang.rb b/lib/rex/parser/net_sarang.rb index f3a5c991c9..c5a03cdd2e 100644 --- a/lib/rex/parser/net_sarang.rb +++ b/lib/rex/parser/net_sarang.rb @@ -77,12 +77,13 @@ module Rex end end - # parser xsh session file + # Parse xsh session file provided as a string. # - # @param ini [String] - # @return [version, host, port, username, password] - def parser_xsh(file) - ini = Rex::Parser::Ini.from_s(file) + # @param input [String] XSH Session file as a string + # @return [Array] An array containing the version, host, + # port, username, and password obtained from the XSH session file. + def parser_xsh(input) + ini = Rex::Parser::Ini.from_s(input) version = ini['SessionInfo']['Version'] port = ini['CONNECTION']['Port'] host = ini['CONNECTION']['Host'] diff --git a/lib/rex/post/meterpreter/extensions/kiwi/kiwi.rb b/lib/rex/post/meterpreter/extensions/kiwi/kiwi.rb index fa33c38d59..a27e588a08 100644 --- a/lib/rex/post/meterpreter/extensions/kiwi/kiwi.rb +++ b/lib/rex/post/meterpreter/extensions/kiwi/kiwi.rb @@ -396,8 +396,7 @@ class Kiwi < Extension # # Use the given ticket in the current session. # - # @param ticket [String] Content of the Kerberos ticket to use. - # + # @param base64_ticket [String] Content of the Kerberos ticket to use as a Base64 encoded string. # @return [void] # def kerberos_ticket_use(base64_ticket) @@ -418,12 +417,14 @@ class Kiwi < Extension # # Create a new golden kerberos ticket on the target machine and return it. # - # @param opts[:user] [String] Name of the user to create the ticket for. - # @param opts[:domain_name] [String] Domain name. - # @param opts[:domain_sid] [String] SID of the domain. - # @param opts[:krbtgt_hash] [String] The kerberos ticket granting token. - # @param opts[:id] [Integer] ID of the user to grant the token for. - # @param opts[:group_ids] [Array] IDs of the groups to assign to the user + # @param opts [Hash] The options to use when creating a new golden kerberos ticket. + # @option opts [String] :domain_name Domain name. + # @option opts [String] :domain_sid SID of the domain. + # @option opts [Integer] :end_in How long to have the ticket last, in hours. + # @option opts [Array] :group_ids IDs of the groups to assign to the user + # @option opts [Integer] :id ID of the user to grant the token for. + # @option opts [String] :krbtgt_hash The kerberos ticket granting token. + # @option opts [String] :user Name of the user to create the ticket for. # # @return [Array] # diff --git a/lib/rex/proto/kerberos/model/kerberos_flags.rb b/lib/rex/proto/kerberos/model/kerberos_flags.rb index 0e4c04feb7..c255a6fd23 100644 --- a/lib/rex/proto/kerberos/model/kerberos_flags.rb +++ b/lib/rex/proto/kerberos/model/kerberos_flags.rb @@ -53,7 +53,7 @@ module Rex # Override the equality test for KdcOptionFlags. Equality is # always tested against the #value of the KdcOptionFlags. # - # @param [Object] other_object the object to test equality against + # @param other [Object] The object to test equality against # @raise [ArgumentError] if the other object is not either another KdcOptionFlags or a Integer # @return [Boolean] whether the equality test passed def ==(other) diff --git a/tools/exploit/java_deserializer.rb b/tools/exploit/java_deserializer.rb index cac0857577..465c5887fe 100755 --- a/tools/exploit/java_deserializer.rb +++ b/tools/exploit/java_deserializer.rb @@ -61,17 +61,17 @@ class JavaDeserializer private - # @param [String] string to print as status + # @param msg [String] String to print as a status message. def print_status(msg='') $stdout.puts "[*] #{msg}" end - # @param [String] string to print as error + # @param msg [String] String to print as a error message. def print_error(msg='') $stdout.puts "[-] #{msg}" end - # @param [Exception] exception to print + # @param e [Exception] Exception to print def print_exception(e) print_error(e.message) e.backtrace.each do |line|