Class: Arachni::OptionGroups::RPC

Inherits:
Arachni::OptionGroup show all
Defined in:
lib/arachni/option_groups/rpc.rb

Overview

Holds RPC::Client and RPC::Server options.

Author:

Instance Attribute Summary collapse

Method Summary

Methods inherited from Arachni::OptionGroup

#==, attr_accessor, attributes, #attributes, defaults, #defaults, #hash, #initialize, #merge, set_defaults, #to_h, #to_hash, #to_rpc_data, #update, #validate

Constructor Details

This class inherits a constructor from Arachni::OptionGroup

Instance Attribute Details

#client_max_retriesInteger

Returns Maximum retries for failed RPC calls.

Returns:

  • (Integer)

    Maximum retries for failed RPC calls.

See Also:


69
70
71
# File 'lib/arachni/option_groups/rpc.rb', line 69

def client_max_retries
  @client_max_retries
end

#client_ssl_certificateString

Returns Path to client SSL certificate in PEM format.

Returns:

  • (String)

    Path to client SSL certificate in PEM format.

See Also:


63
64
65
# File 'lib/arachni/option_groups/rpc.rb', line 63

def client_ssl_certificate
  @client_ssl_certificate
end

#client_ssl_private_keyString

Returns Path to a client SSL private key in PEM format.

Returns:

  • (String)

    Path to a client SSL private key in PEM format.

See Also:


57
58
59
# File 'lib/arachni/option_groups/rpc.rb', line 57

def client_ssl_private_key
  @client_ssl_private_key
end

#connection_pool_sizeInteger

Note:

This should be permanently set to 1, otherwise it will cause issues with the scheduling of the workload distribution of multi-Instance scans.

Returns Amount of concurrently open connections for each RPC client.

Returns:

  • (Integer)

    Amount of concurrently open connections for each RPC client.

See Also:


78
79
80
# File 'lib/arachni/option_groups/rpc.rb', line 78

def connection_pool_size
  @connection_pool_size
end

#server_addressString

Returns Hostname or IP address for the RPC server.

Returns:

  • (String)

    Hostname or IP address for the RPC server.

See Also:

  • RPC::Server::Base

26
27
28
# File 'lib/arachni/option_groups/rpc.rb', line 26

def server_address
  @server_address
end

#server_portInteger

Returns RPC server port.

Returns:

  • (Integer)

    RPC server port.

See Also:

  • RPC::Server::Base

32
33
34
# File 'lib/arachni/option_groups/rpc.rb', line 32

def server_port
  @server_port
end

#server_socketString

Returns Path to the UNIX socket to use for RPC communication.

Returns:

  • (String)

    Path to the UNIX socket to use for RPC communication.

See Also:

  • RPC::Server::Base

20
21
22
# File 'lib/arachni/option_groups/rpc.rb', line 20

def server_socket
  @server_socket
end

#server_ssl_certificateString

Returns Path to server SSL certificate in PEM format.

Returns:

  • (String)

    Path to server SSL certificate in PEM format.

See Also:

  • RPC::Server::Base

51
52
53
# File 'lib/arachni/option_groups/rpc.rb', line 51

def server_ssl_certificate
  @server_ssl_certificate
end

#server_ssl_private_keyString

Returns Path to a server SSL private key in PEM format.

Returns:

  • (String)

    Path to a server SSL private key in PEM format.

See Also:

  • RPC::Server::Base

45
46
47
# File 'lib/arachni/option_groups/rpc.rb', line 45

def server_ssl_private_key
  @server_ssl_private_key
end

#ssl_caString

Returns Path to an SSL certificate authority file in PEM format.

Returns:

  • (String)

    Path to an SSL certificate authority file in PEM format.

See Also:


39
40
41
# File 'lib/arachni/option_groups/rpc.rb', line 39

def ssl_ca
  @ssl_ca
end