Class: Itsi::Server

Inherits:
Object
  • Object
show all
Extended by:
RackInterface, RouteTester, SchedulerInterface
Defined in:
lib/itsi/server.rb,
lib/itsi/passfile.rb,
lib/itsi/server/config.rb,
lib/itsi/server/version.rb,
lib/itsi/server/config/dsl.rb,
lib/itsi/server/route_tester.rb,
lib/itsi/server/config/option.rb,
lib/itsi/server/rack_interface.rb,
lib/itsi/server/typed_handlers.rb,
lib/itsi/server/config/middleware.rb,
lib/itsi/server/config/known_paths.rb,
lib/itsi/server/config/options/bind.rb,
lib/itsi/server/config/typed_struct.rb,
lib/itsi/server/grpc/grpc_interface.rb,
lib/itsi/server/scheduler_interface.rb,
lib/itsi/server/config/options/watch.rb,
lib/itsi/server/config/config_helpers.rb,
lib/itsi/server/config/middleware/csp.rb,
lib/itsi/server/config/middleware/run.rb,
lib/itsi/server/config/options/writev.rb,
lib/itsi/server/config/middleware/cors.rb,
lib/itsi/server/config/middleware/etag.rb,
lib/itsi/server/config/middleware/grpc.rb,
lib/itsi/server/config/options/include.rb,
lib/itsi/server/config/options/nodelay.rb,
lib/itsi/server/config/options/preload.rb,
lib/itsi/server/config/options/threads.rb,
lib/itsi/server/config/options/workers.rb,
lib/itsi/server/config/middleware/proxy.rb,
lib/itsi/server/config/options/daemonize.rb,
lib/itsi/server/config/options/log_level.rb,
lib/itsi/server/config/options/log_format.rb,
lib/itsi/server/config/options/log_target.rb,
lib/itsi/server/config/options/reuse_port.rb,
lib/itsi/server/config/middleware/auth_jwt.rb,
lib/itsi/server/config/middleware/location.rb,
lib/itsi/server/config/middleware/max_body.rb,
lib/itsi/server/config/middleware/redirect.rb,
lib/itsi/server/config/options/stream_body.rb,
lib/itsi/server/config/middleware/deny_list.rb,
lib/itsi/server/typed_handlers/param_parser.rb,
lib/itsi/server/config/middleware/allow_list.rb,
lib/itsi/server/config/middleware/auth_basic.rb,
lib/itsi/server/config/middleware/rate_limit.rb,
lib/itsi/server/config/options/reuse_address.rb,
lib/itsi/server/typed_handlers/source_parser.rb,
lib/itsi/server/config/middleware/compression.rb,
lib/itsi/server/config/middleware/rackup_file.rb,
lib/itsi/server/config/options/listen_backlog.rb,
lib/itsi/server/config/options/pipeline_flush.rb,
lib/itsi/server/config/middleware/auth_api_key.rb,
lib/itsi/server/config/middleware/endpoint/get.rb,
lib/itsi/server/config/middleware/endpoint/put.rb,
lib/itsi/server/config/middleware/log_requests.rb,
lib/itsi/server/config/middleware/token_source.rb,
lib/itsi/server/config/options/fiber_scheduler.rb,
lib/itsi/server/config/options/request_timeout.rb,
lib/itsi/server/config/middleware/cache_control.rb,
lib/itsi/server/config/middleware/cidr_to_regex.rb,
lib/itsi/server/config/middleware/endpoint/post.rb,
lib/itsi/server/config/middleware/static_assets.rb,
lib/itsi/server/config/options/hooks/after_fork.rb,
lib/itsi/server/config/options/pin_worker_cores.rb,
lib/itsi/server/config/options/recv_buffer_size.rb,
lib/itsi/server/config/options/send_buffer_size.rb,
lib/itsi/server/config/options/shutdown_timeout.rb,
lib/itsi/server/config/middleware/endpoint/patch.rb,
lib/itsi/server/config/middleware/error_response.rb,
lib/itsi/server/config/options/hooks/after_start.rb,
lib/itsi/server/config/options/hooks/before_fork.rb,
lib/itsi/server/config/options/scheduler_threads.rb,
lib/itsi/server/config/middleware/endpoint/delete.rb,
lib/itsi/server/config/middleware/request_headers.rb,
lib/itsi/server/config/middleware/static_response.rb,
lib/itsi/server/config/options/auto_reload_config.rb,
lib/itsi/server/config/options/log_target_filters.rb,
lib/itsi/server/config/middleware/rate_limit_store.rb,
lib/itsi/server/config/middleware/response_headers.rb,
lib/itsi/server/config/options/header_read_timeout.rb,
lib/itsi/server/config/options/worker_memory_limit.rb,
lib/itsi/server/config/middleware/endpoint/endpoint.rb,
lib/itsi/server/config/options/hooks/before_restart.rb,
lib/itsi/server/config/options/hooks/before_shutdown.rb,
lib/itsi/server/config/options/multithreaded_reactor.rb,
lib/itsi/server/config/middleware/endpoint/controller.rb,
lib/itsi/server/config/options/redirect_http_to_https.rb,
lib/itsi/server/config/middleware/intrusion_protection.rb,
lib/itsi/server/config/options/oob_gc_responses_threshold.rb,
lib/itsi/server/config/options/hooks/after_memory_limit_reached.rb,
lib/itsi/server/config/options/ruby_thread_request_backlog_size.rb

Defined Under Namespace

Modules: CidrToRegex, Config, KnownPaths, Passfile, RackInterface, RouteTester, SchedulerInterface, TypedHandlers Classes: GrpcInterface

Constant Summary collapse

VERSION = 
"0.2.17"

Class Method Summary collapse

Methods included from RackInterface

call, for, respond, streaming_body?

Methods included from SchedulerInterface

schedule, start_scheduler_loop

Methods included from RouteTester

expand_tokens, explode_route_pattern, format_mw, parse_alternation, parse_expression, print_route

Class Method Details

.add_worker ⇒ Object 



224
225
226
227
228
 
# File 'lib/itsi/server.rb', line 224

def add_worker
  return unless (pid = get_pid)

  Process.kill(:TTIN, pid)
end

.get_pid(warn = true) ⇒ Object 



99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/itsi/server.rb', line 99

def get_pid(warn = true)
  pid = File.read(Itsi::Server::Config.pid_file_path).to_i
  if Process.kill(0, pid)
    pid
  else
    warn ? puts("No server running") : nil
    nil
  end
rescue StandardError
  warn ? puts("No server running") : nil
  nil
end

.init ⇒ Object 



116
117
118
 
# File 'lib/itsi/server.rb', line 116

def init
  Config.write_default
end

.load_route_middleware_stack(cli_params) ⇒ Object 



243
244
245
246
247
248
249
250
251
252
 
# File 'lib/itsi/server.rb', line 243

def load_route_middleware_stack(cli_params)
  middleware, errors = Config.build_config(cli_params,
                                           Itsi::Server::Config.config_file_path(cli_params[:config_file_path]))
  if errors.any?
    puts errors
    []
  else
    middleware["middleware_loader"][]
  end
end

.passfile(options, subcmd) ⇒ Object 



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/itsi/server.rb', line 132

def passfile(options, subcmd)
  filename = options[:passfile]
  unless filename || subcmd == "echo"
    puts "Error: passfile not set. Use --passfile option to provide a path to a file containing hashed credentials."
    puts "This file contains hashed credentials and should not be included in source control without additional protection."
    exit(1)
  end
  algorithm = options.fetch(:algorithm, "sha256")

  unless %w[sha256 sha512 bcrypt argon2 none].include?(algorithm)
    puts "Invalid algorithm"
    exit(1)
  end

  case subcmd
  when "add", "echo"
    Passfile.send(subcmd, filename, algorithm)
  when "remove", "list"
    Passfile.send(subcmd, filename)
  else
    puts "Valid subcommands are: add | remove | list"
    exit(0)
  end
end

.reload ⇒ Object 



120
121
122
123
124
 
# File 'lib/itsi/server.rb', line 120

def reload
  return unless (pid = get_pid)

  Process.kill(:HUP, pid)
end

.remove_worker ⇒ Object 



230
231
232
233
234
 
# File 'lib/itsi/server.rb', line 230

def remove_worker
  return unless (pid = get_pid)

  Process.kill(:TTOU, pid)
end

.restart ⇒ Object 



126
127
128
129
130
 
# File 'lib/itsi/server.rb', line 126

def restart
  return unless (pid = get_pid)

  Process.kill(:USR1, pid)
end

.routes(cli_params = {}) ⇒ Object 



265
266
267
268
269
270
271
272
273
 
# File 'lib/itsi/server.rb', line 265

def routes(cli_params = {})
  load_route_middleware_stack(cli_params).first.each do |stack|
    routes = explode_route_pattern(stack["route"].source)
    routes.each do |route|
      print_route(route, stack)
    end
  end
  puts "─" * 76
end

.running? ⇒ Boolean

Returns:

  • (Boolean) 


31
32
33
 
# File 'lib/itsi/server.rb', line 31

def running?
  @running && !@running.empty?
end

.save_or_print(filename, content, options) ⇒ Object 



173
174
175
176
177
178
179
180
181
182
 
# File 'lib/itsi/server.rb', line 173

def save_or_print(filename, content, options)
  if options[:save_dir]
    FileUtils.mkdir_p(options[:save_dir])
    path = unique_path(options[:save_dir], filename)
    File.write(path, content)
    puts "Written to #{path}"
  else
    puts content
  end
end

.secret(options) ⇒ Object 



184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/itsi/server.rb', line 184

def secret(options)
  require "openssl"
  require "base64"

  puts "Enter algorithm (one of: HS256, HS384, HS512, RS256, RS384, RS512, PS256, PS384, PS512, ES256, ES384):"
  alg = $stdin.gets.chomp.upcase

  case alg
  when /^HS(\d+)$/
    bits = ::Regexp.last_match(1).to_i
    bytes = bits / 8
    key = SecureRandom.random_bytes(bytes)
    pem = Base64.strict_encode64(key)
    content = "=== HMAC #{bits}-bit Secret (base64) ===\n#{pem}\n"
    save_or_print("hmac_#{bits}_secret.txt", content, options)

  when /^RS/, /^PS/
    rsa = OpenSSL::PKey::RSA.new(2048)
    priv = rsa.to_pem
    pub  = rsa.public_key.to_pem
    save_or_print("rsa_private.pem", "=== RSA Private Key ===\n#{priv}", options)
    save_or_print("rsa_public.pem",  "=== RSA Public Key ===\n#{pub}", options)

  when "ES256", "ES384"
    curve = (alg == "ES256" ? "prime256v1" : "secp384r1")
    ec = OpenSSL::PKey::EC.new(curve)
    ec.generate_key
    priv = ec.to_pem
    pub_ec = ec.dup
    pub_ec.private_key = nil
    pub = pub_ec.to_pem
    save_or_print("ecdsa_private.pem", "=== ECDSA Private Key ===\n#{priv}", options)
    save_or_print("ecdsa_public.pem",  "=== ECDSA Public Key ===\n#{pub}", options)

  else
    warn "Unsupported algorithm: #{alg}"
    exit 1
  end
end

.start(cli_params, background: false, &blk) ⇒ Object Also known as: serve 



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/itsi/server.rb', line 42

def start(cli_params, background: false, &blk)
  itsi_file = Itsi::Server::Config.config_file_path(cli_params[:config_file])
  Itsi.log_debug "Constructing server #{cli_params}: #{itsi_file}"
  server = new(cli_params, itsi_file, blk)
  previous_handler = Signal.trap(:INT, :DEFAULT)
  run = lambda do
    @running ||= []
    @running << server

    if cli_params[:daemonize]
      Itsi.log_info("Itsi is running in the background. Writing pid to #{Itsi::Server::Config.pid_file_path}")
      Itsi.log_info("To stop Itsi, run 'itsi stop' from this directory.")
      Process.daemon(true, false)
    end
    write_pid

    Itsi.log_info "Starting Itsi..."
    server.start
    @running.delete(server)
    Signal.trap(:INT, previous_handler)
    server
  end
  background ? [server, Thread.new(&run)] : run[]
rescue Exception => e # rubocop:disable Lint/RescueException
  Itsi.log_error e.message
end

.start_in_background_thread(cli_params = {}, &blk) ⇒ Object 



35
36
37
38
39
40
 
# File 'lib/itsi/server.rb', line 35

def start_in_background_thread(cli_params = {}, &blk)
  @background_threads ||= []
  server, background_thread = start(cli_params, background: true, &blk)
  @background_threads << background_thread
  server
end

.static(cli_params) ⇒ Object 



69
70
71
 
# File 'lib/itsi/server.rb', line 69

def static(cli_params)
  start(cli_params.merge(static: true))
end

.status ⇒ Object 



236
237
238
239
240
241
 
# File 'lib/itsi/server.rb', line 236

def status
  return unless (pid = get_pid)

  Itsi.log_info("Itsi running on #{pid}")
  Process.kill(:USR2, pid)
end

.stop ⇒ Object 



73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/itsi/server.rb', line 73

def stop
  return unless (pid = get_pid)

  Process.kill(:INT, pid)
  i = 0
  while i < 10
    sleep 0.25
    unless get_pid(false)
      puts "Itsi stopped"
      break
    end
    i += 1
  end
end

.stop_background_threads ⇒ Object 



88
89
90
91
92
93
 
# File 'lib/itsi/server.rb', line 88

def stop_background_threads
  @running && @running.each(&:stop)
  @background_threads&.each(&:join)
  @background_threads = []
  @running = []
end

.test ⇒ Object 



112
113
114
 
# File 'lib/itsi/server.rb', line 112

def test
  Itsi::Server::Config.test!({})
end

.test_route(cli_params, route_str) ⇒ Object 



254
255
256
257
258
259
260
261
262
263
 
# File 'lib/itsi/server.rb', line 254

def test_route(cli_params, route_str)
  matched_route = load_route_middleware_stack(cli_params).find do |route|
    route["route"] =~ route_str
  end
  if matched_route
    print_route(route_str, matched_route)
  else
    puts "No matching route found"
  end
end

.unique_path(dir, filename) ⇒ Object 



157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/itsi/server.rb', line 157

def unique_path(dir, filename)
  base = File.basename(filename, ".*")
  ext  = File.extname(filename)
  candidate = File.join(dir, filename)
  return candidate unless File.exist?(candidate)

  i = 1
  loop do
    new_name = "#{base}_#{i}#{ext}"
    candidate = File.join(dir, new_name)
    return candidate unless File.exist?(candidate)

    i += 1
  end
end

.write_pid ⇒ Object 



95
96
97
 
# File 'lib/itsi/server.rb', line 95

def write_pid
  File.write(Itsi::Server::Config.pid_file_path, Process.pid)
end