Class: Aikido::Zen::Config

Inherits:
Object
  • Object
show all
Defined in:
lib/aikido/zen/config.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Config

Returns a new instance of Config.



142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/aikido/zen/config.rb', line 142

def initialize
  self.disabled = read_boolean_from_env(ENV.fetch("AIKIDO_DISABLED", false))
  self.blocking_mode = read_boolean_from_env(ENV.fetch("AIKIDO_BLOCK", false))
  self.api_timeouts = 10
  self.api_endpoint = ENV.fetch("AIKIDO_ENDPOINT", DEFAULT_AIKIDO_ENDPOINT)
  self.realtime_endpoint = ENV.fetch("AIKIDO_REALTIME_ENDPOINT", DEFAULT_RUNTIME_BASE_URL)
  self.api_token = ENV.fetch("AIKIDO_TOKEN", nil)
  self.polling_interval = 60
  self.initial_heartbeat_delay = 60
  self.json_encoder = DEFAULT_JSON_ENCODER
  self.json_decoder = DEFAULT_JSON_DECODER
  self.debugging = read_boolean_from_env(ENV.fetch("AIKIDO_DEBUG", false))
  self.logger = Logger.new($stdout, progname: "aikido", level: debugging ? Logger::DEBUG : Logger::INFO)
  self.max_performance_samples = 5000
  self.max_compressed_stats = 100
  self.max_outbound_connections = 200
  self.max_users_tracked = 1000
  self.request_builder = Aikido::Zen::Context::RACK_REQUEST_BUILDER
  self.blocked_responder = DEFAULT_BLOCKED_RESPONDER
  self.rate_limited_responder = DEFAULT_RATE_LIMITED_RESPONDER
  self.rate_limiting_discriminator = DEFAULT_RATE_LIMITING_DISCRIMINATOR
  self.server_rate_limit_deadline = 1800 # 30 min
  self.client_rate_limit_period = 3600 # 1 hour
  self.client_rate_limit_max_events = 100
  self.collect_api_schema = read_boolean_from_env(ENV.fetch("AIKIDO_FEATURE_COLLECT_API_SCHEMA", true))
  self.api_schema_max_samples = Integer(ENV.fetch("AIKIDO_MAX_API_DISCOVERY_SAMPLES", 10))
  self.api_schema_collection_max_depth = 20
  self.api_schema_collection_max_properties = 20
  self.imds_allowed_hosts = ["metadata.google.internal", "metadata.goog"]
end

Instance Attribute Details

#api_endpoint ⇒ URI

Returns The HTTP host for the Aikido API. Defaults to https://guard.aikido.dev.

Returns:

  • (URI) —

    The HTTP host for the Aikido API. Defaults to https://guard.aikido.dev.



26
27
28
 
# File 'lib/aikido/zen/config.rb', line 26

def api_endpoint
  @api_endpoint
end

#api_schema_collection_max_depth ⇒ Integer

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns max number of levels deep we want to read a nested strcture for performance reasons.

Returns:

  • (Integer) —

    max number of levels deep we want to read a nested strcture for performance reasons.



110
111
112
 
# File 'lib/aikido/zen/config.rb', line 110

def api_schema_collection_max_depth
  @api_schema_collection_max_depth
end

#api_schema_collection_max_properties ⇒ Integer

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns max number of properties that we want to inspect per level of the structure for performance reasons.

Returns:

  • (Integer) —

    max number of properties that we want to inspect per level of the structure for performance reasons.



115
116
117
 
# File 'lib/aikido/zen/config.rb', line 115

def api_schema_collection_max_properties
  @api_schema_collection_max_properties
end

#api_schema_max_samples ⇒ Integer

Returns max number of requests we sample per endpoint when computing the schema.

Returns:

  • (Integer) —

    max number of requests we sample per endpoint when computing the schema.



105
106
107
 
# File 'lib/aikido/zen/config.rb', line 105

def api_schema_max_samples
  @api_schema_max_samples
end

#api_timeouts ⇒ Hash

Returns HTTP timeouts for communicating with the API.

Returns:

  • (Hash) —

    HTTP timeouts for communicating with the API.



33
34
35
 
# File 'lib/aikido/zen/config.rb', line 33

def api_timeouts
  @api_timeouts
end

#api_token ⇒ String

Returns the token obtained when configuring the Firewall in the Aikido interface.

Returns:

  • (String) —

    the token obtained when configuring the Firewall in the Aikido interface.



37
38
39
 
# File 'lib/aikido/zen/config.rb', line 37

def api_token
  @api_token
end

#blocked_responder ⇒ Proc{(Aikido::Zen::Request, Symbol) => Array(Integer, Hash, #each)}

Returns Rack handler used to respond to requests from IPs, users or others blocked in the Aikido dashboard.

Returns:

  • (Proc{(Aikido::Zen::Request, Symbol) => Array(Integer, Hash, #each)}) —

    Rack handler used to respond to requests from IPs, users or others blocked in the Aikido dashboard.



86
87
88
 
# File 'lib/aikido/zen/config.rb', line 86

def blocked_responder
  @blocked_responder
end

#blocking_mode ⇒ Boolean Also known as: blocking_mode?

Returns whether Aikido should only report infractions or block the request by raising an Exception. Defaults to whether AIKIDO_BLOCK is set to a non-empty value in your environment, or false otherwise.

Returns:

  • (Boolean) —

    whether Aikido should only report infractions or block the request by raising an Exception. Defaults to whether AIKIDO_BLOCK is set to a non-empty value in your environment, or false otherwise.



21
22
23
 
# File 'lib/aikido/zen/config.rb', line 21

def blocking_mode
  @blocking_mode
end

#client_rate_limit_max_events ⇒ Integer

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns max number of events sent during a sliding #client_rate_limit_period window.

Returns:



131
132
133
 
# File 'lib/aikido/zen/config.rb', line 131

def client_rate_limit_max_events
  @client_rate_limit_max_events
end

#client_rate_limit_period ⇒ Integer

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns number of seconds to perform client-side rate limiting of events sent to the server.

Returns:

  • (Integer) —

    number of seconds to perform client-side rate limiting of events sent to the server.



126
127
128
 
# File 'lib/aikido/zen/config.rb', line 126

def client_rate_limit_period
  @client_rate_limit_period
end

#collect_api_schema ⇒ Boolean Also known as: collect_api_schema?

Returns whether Aikido Zen should collect api schemas. Defaults to true. Can be set through AIKIDO_FEATURE_COLLECT_API_SCHEMA environment variable.

Returns:

  • (Boolean) —

    whether Aikido Zen should collect api schemas. Defaults to true. Can be set through AIKIDO_FEATURE_COLLECT_API_SCHEMA environment variable.



100
101
102
 
# File 'lib/aikido/zen/config.rb', line 100

def collect_api_schema
  @collect_api_schema
end

#debugging ⇒ Boolean Also known as: debugging?

Returns is the agent in debugging mode?.

Returns:

  • (Boolean) —

    is the agent in debugging mode?



59
60
61
 
# File 'lib/aikido/zen/config.rb', line 59

def debugging
  @debugging
end

#disabled ⇒ Boolean Also known as: disabled?

Returns whether Aikido should be turned completely off (no intercepting calls to protect the app, no agent process running, no middleware installed). Defaults to false (so, enabled). Can be set via the AIKIDO_DISABLED environment variable.

Returns:

  • (Boolean) —

    whether Aikido should be turned completely off (no intercepting calls to protect the app, no agent process running, no middleware installed). Defaults to false (so, enabled). Can be set via the AIKIDO_DISABLED environment variable.



15
16
17
 
# File 'lib/aikido/zen/config.rb', line 15

def disabled
  @disabled
end

#imds_allowed_hosts ⇒ Array<String>

Returns when checking for stored SSRF attacks, we want to allow known hosts that should be able to resolve to the IMDS service.

Returns:

  • (Array<String>) —

    when checking for stored SSRF attacks, we want to allow known hosts that should be able to resolve to the IMDS service.



140
141
142
 
# File 'lib/aikido/zen/config.rb', line 140

def imds_allowed_hosts
  @imds_allowed_hosts
end

#initial_heartbeat_delay ⇒ Integer

Returns the amount in seconds to wait before sending an initial heartbeat event when the server reports no stats have been sent yet.

Returns:

  • (Integer) —

    the amount in seconds to wait before sending an initial heartbeat event when the server reports no stats have been sent yet.



45
46
47
 
# File 'lib/aikido/zen/config.rb', line 45

def initial_heartbeat_delay
  @initial_heartbeat_delay
end

#json_decoder ⇒ #call

Returns Callable that can be passed a JSON string and parses it into an Object. Defaults to the standard library’s JSON.parse method.

Returns:

  • (#call) —

    Callable that can be passed a JSON string and parses it into an Object. Defaults to the standard library’s JSON.parse method.



53
54
55
 
# File 'lib/aikido/zen/config.rb', line 53

def json_decoder
  @json_decoder
end

#json_encoder ⇒ #call

Returns Callable that can be passed an Object and returns a String of JSON. Defaults to the standard library’s JSON.dump method.

Returns:

  • (#call) —

    Callable that can be passed an Object and returns a String of JSON. Defaults to the standard library’s JSON.dump method.



49
50
51
 
# File 'lib/aikido/zen/config.rb', line 49

def json_encoder
  @json_encoder
end

#logger ⇒ Logger

Returns:

  • (Logger) 


56
57
58
 
# File 'lib/aikido/zen/config.rb', line 56

def logger
  @logger
end

#max_compressed_stats ⇒ Integer

Returns maximum number of compressed performance samples to keep in memory. If we take more than this before reporting them to Aikido, we will discard the oldest samples.

Returns:

  • (Integer) —

    maximum number of compressed performance samples to keep in memory. If we take more than this before reporting them to Aikido, we will discard the oldest samples.



69
70
71
 
# File 'lib/aikido/zen/config.rb', line 69

def max_compressed_stats
  @max_compressed_stats
end

#max_outbound_connections ⇒ Integer

Returns maximum number of connections to outbound hosts to keep in memory in order to report them in the next heartbeat event. If new connections are added to the set before reporting them to Aikido, we will discard the oldest data point.

Returns:

  • (Integer) —

    maximum number of connections to outbound hosts to keep in memory in order to report them in the next heartbeat event. If new connections are added to the set before reporting them to Aikido, we will discard the oldest data point.



75
76
77
 
# File 'lib/aikido/zen/config.rb', line 75

def max_outbound_connections
  @max_outbound_connections
end

#max_performance_samples ⇒ Integer

Returns maximum number of timing measurements to keep in memory before compressing them.

Returns:

  • (Integer) —

    maximum number of timing measurements to keep in memory before compressing them.



64
65
66
 
# File 'lib/aikido/zen/config.rb', line 64

def max_performance_samples
  @max_performance_samples
end

#max_users_tracked ⇒ Integer

Returns maximum number of users tracked via Zen.track_user to share with the Aikido servers on the next heartbeat event. If more unique users (by their ID) are tracked than this number, we will discard the oldest seen users.

Returns:

  • (Integer) —

    maximum number of users tracked via Zen.track_user to share with the Aikido servers on the next heartbeat event. If more unique users (by their ID) are tracked than this number, we will discard the oldest seen users.



81
82
83
 
# File 'lib/aikido/zen/config.rb', line 81

def max_users_tracked
  @max_users_tracked
end

#polling_interval ⇒ Integer

Returns the interval in seconds to poll the runtime API for settings changes. Defaults to evey 60 seconds.

Returns:

  • (Integer) —

    the interval in seconds to poll the runtime API for settings changes. Defaults to evey 60 seconds.



41
42
43
 
# File 'lib/aikido/zen/config.rb', line 41

def polling_interval
  @polling_interval
end

#rate_limited_responder ⇒ Proc{Aikido::Zen::Request => Array(Integer, Hash, #each)}

Returns Rack handler used to respond to requests that have been rate limited.

Returns:

  • (Proc{Aikido::Zen::Request => Array(Integer, Hash, #each)}) —

    Rack handler used to respond to requests that have been rate limited.



90
91
92
 
# File 'lib/aikido/zen/config.rb', line 90

def rate_limited_responder
  @rate_limited_responder
end

#rate_limiting_discriminator ⇒ Proc{Aikido::Zen::Request => String}

Returns a proc that reads information off the current request and returns a String to differentiate different clients. By default this uses the request IP.

Returns:

  • (Proc{Aikido::Zen::Request => String}) —

    a proc that reads information off the current request and returns a String to differentiate different clients. By default this uses the request IP.



95
96
97
 
# File 'lib/aikido/zen/config.rb', line 95

def rate_limiting_discriminator
  @rate_limiting_discriminator
end

#realtime_endpoint ⇒ URI

Returns The HTTP host for the Aikido Runtime API. Defaults to https://runtime.aikido.dev.

Returns:

  • (URI) —

    The HTTP host for the Aikido Runtime API. Defaults to https://runtime.aikido.dev.



30
31
32
 
# File 'lib/aikido/zen/config.rb', line 30

def realtime_endpoint
  @realtime_endpoint
end

#request_builder ⇒ Proc<Hash => Aikido::Zen::Context>

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns callable that takes a Rack-compatible env Hash and returns a Context object with an HTTP request. This is meant to be overridden by each framework adapter.

Returns:

  • (Proc<Hash => Aikido::Zen::Context>) —

    callable that takes a Rack-compatible env Hash and returns a Context object with an HTTP request. This is meant to be overridden by each framework adapter.



121
122
123
 
# File 'lib/aikido/zen/config.rb', line 121

def request_builder
  @request_builder
end

#server_rate_limit_deadline ⇒ Integer

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns number of seconds to wait before sending an event after the server returns a 429 response.

Returns:

  • (Integer) —

    number of seconds to wait before sending an event after the server returns a 429 response.



136
137
138
 
# File 'lib/aikido/zen/config.rb', line 136

def server_rate_limit_deadline
  @server_rate_limit_deadline
end