falcon 0.42.3 → 0.44.0

data/lib/falcon/configuration.rb

@@ -1,26 +1,10 @@
 # frozen_string_literal: true
 
-# Copyright, 2018, by Samuel G. D. Williams. <http://www.codeotaku.com>
-# 
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-# 
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-# 
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
+# Released under the MIT License.
+# Copyright, 2019-2024, by Samuel Williams.
+# Copyright, 2019, by Sho Ito.
 
-require 'build/environment'
+require 'async/service'
 
 module Falcon
 	# Manages environments which describes how to host a specific application.
@@ -41,177 +25,79 @@ module Falcon
 	#	end
 	#	~~~
 	#
-	class Configuration
-		# Initialize an empty configuration.
-		def initialize
-			@environments = {}
-		end
-		
-		# The map of named environments.
-		# @attribute [Hash(String, Build::Environment)]
-		attr :environments
-		
-		# Enumerate all environments that have the specified key.
-		# @parameter key [Symbol] Filter environments that don't have this key.
-		def each(key = :authority)
-			return to_enum(key) unless block_given?
-			
-			@environments.each do |name, environment|
-				environment = environment.flatten
-				
-				if environment.include?(key)
-					yield environment
-				end
-			end
-		end
-		
-		# Add the named environment to the configuration.
-		def add(environment)
-			name = environment.name
-			
-			unless name
-				raise ArgumentError, "Environment name is nil #{environment.inspect}"
-			end
-			
-			environment = environment.flatten
-			
-			raise KeyError.new("#{name.inspect} is already set", key: name) if @environments.key?(name)
-			
-			@environments[name] = environment
-		end
-		
+	class Configuration < ::Async::Service::Configuration
 		# Load the specified configuration file. See {Loader#load_file} for more details.
 		def load_file(path)
 			Loader.load_file(self, path)
 		end
 		
 		# The domain specific language for loading configuration files.
-		class Loader
-			# Initialize the loader, attached to a specific configuration instance.
-			# Any environments generated by the loader will be added to the configuration.
-			# @parameter configuration [Configuration]
-			# @parameter root [String] The file-system root path for relative path computations.
-			def initialize(configuration, root = nil)
-				@loaded = {}
-				@configuration = configuration
-				@environments = {}
-				@root = root
-			end
-			
-			# The file-system root path which is injected into the environments as required.
-			# @attribute [String]
-			attr :root
-			
-			# The attached configuration instance.
-			# @attribute [Configuration]
-			attr :configuration
-			
-			# Load the specified file into the given configuration.
-			# @parameter configuration [Configuration]
-			# @oaram path [String] The path to the configuration file, e.g. `falcon.rb`.
-			def self.load_file(configuration, path)
-				path = File.realpath(path)
-				root = File.dirname(path)
-				
-				loader = self.new(configuration, root)
-				
-				loader.instance_eval(File.read(path), path)
-			end
-			
+		class Loader < ::Async::Service::Loader
 			# Load specific features into the current configuration.
 			#
-			# Falcon provides default environments for different purposes. These are included in the gem, in the `environments/` directory. This method loads the code in those files into the current configuration.
-			#
+			# @deprecated Use `require` instead.
 			# @parameter features [Array(Symbol)] The features to load.
 			def load(*features)
 				features.each do |feature|
-					next if @loaded.include?(feature)
-					
 					case feature
 					when Symbol
-						relative_path = File.join(__dir__, "environments", "#{feature}.rb")
-						
-						self.instance_eval(File.read(relative_path), relative_path)
-						
-						@loaded[feature] = relative_path
-					when Module
-						feature.load(self)
-						
-						@loaded[feature] = feature
+						require File.join(__dir__, "environment", "#{feature}.rb")
 					else
 						raise LoadError, "Unsure about how to load #{feature}!"
 					end
 				end
 			end
 			
-			# Add the named environment, with zero or more parent environments, defined using the specified `block`.
-			# @parameter name [String] The name of the environment.
-			# @parameter parents [Array(Symbol)] The names of the parent environments to inherit.
-			# @yields {...} The block that will generate the environment.
-			def environment(name, *parents, &block)
-				raise KeyError.new("#{name} is already set", key: name) if @environments.key?(name)
-				@environments[name] = merge(name, *parents, &block)
-			end
-			
 			# Define a host with the specified name.
 			# Adds `root` and `authority` keys.
+			# @deprecated Use `service` and `include Falcon::Environment::Server` instead.
 			# @parameter name [String] The name of the environment, usually a hostname.
 			def host(name, *parents, &block)
-				environment = merge(name, *parents, &block)
-				
-				environment[:root] = @root
-				environment[:authority] = name
-				
-				@configuration.add(environment.flatten)
+				@configuration.add(
+					merge(*parents, name: name, root: @root, authority: name, &block)
+				)
 			end
 			
 			# Define a proxy with the specified name.
 			# Adds `root` and `authority` keys.
+			# @deprecated Use `service` and `include Falcon::Environment::Proxy` instead.
 			# @parameter name [String] The name of the environment, usually a hostname.
 			def proxy(name, *parents, &block)
-				environment = merge(name, :proxy, *parents, &block)
-				
-				environment[:root] = @root
-				environment[:authority] = name
-				
-				@configuration.add(environment.flatten)
+				@configuration.add(
+					merge(:proxy, *parents, name: name, root: @root, authority: name, &block)
+				)
 			end
 			
 			# Define a rack application with the specified name.
 			# Adds `root` and `authority` keys.
+			# @deprecated Use `service` and `include Falcon::Environment::Rack` instead.
 			# @parameter name [String] The name of the environment, usually a hostname.
 			def rack(name, *parents, &block)
-				environment = merge(name, :rack, *parents, &block)
-				
-				environment[:root] = @root
-				environment[:authority] = name
-				
-				@configuration.add(environment.flatten)
+				@configuration.add(
+					merge(:rack, *parents, name: name, root: @root, authority: name, &block)
+				)
 			end
 			
 			# Define a supervisor instance
-			# Adds `root` key.
+			# @deprecated Use `service` and `include Falcon::Environment::Supervisor` instead.
 			def supervisor(&block)
 				name = File.join(@root, "supervisor")
-				environment = merge(name, :supervisor, &block)
 				
-				environment[:root] = @root
-				
-				@configuration.add(environment.flatten)
+				@configuration.add(
+					merge(:supervisor, name: name, root: @root, &block)
+				)
 			end
 				
 			private
 			
 			# Build a new environment with the specified name and the given parents.
 			# @parameter name [String]
-			# @parameter parents [Array(Build::Environment)]
+			# @parameter parents [Array(Symbol)]
 			# @yields {...} The block that will generate the environment.
-			def merge(name, *parents, &block)
-				environments = parents.map{|name| @environments.fetch(name)}
-				
-				parent = Build::Environment.combine(*environments)
+			def merge(*parents, **initial, &block)
+				facets = parents.map{|parent| Environment::LEGACY_ENVIRONMENTS.fetch(parent)}
 				
-				Build::Environment.new(parent, name: name, &block)
+				::Async::Service::Environment.build(*facets, **initial, &block)
 			end
 		end
 	end

data/lib/falcon/endpoint.rb

@@ -1,24 +1,7 @@
 # frozen_string_literal: true
 
-# Copyright, 2018, by Samuel G. D. Williams. <http://www.codeotaku.com>
-# 
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-# 
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-# 
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
+# Released under the MIT License.
+# Copyright, 2018-2023, by Samuel Williams.
 
 require 'async/http/endpoint'
 require 'localhost/authority'

data/lib/falcon/environment/application.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2019-2024, by Samuel Williams.
+# Copyright, 2020, by Daniel Evans.
+
+require_relative 'server'
+require_relative '../proxy_endpoint'
+
+module Falcon
+	module Environment
+		# Provides an environment for hosting a web application that uses TLS.
+		module Application
+			include Server
+			
+			# The middleware stack for the application.
+			# @returns [Protocol::HTTP::Middleware]
+			def middleware
+				::Protocol::HTTP::Middleware::HelloWorld
+			end
+			
+			# The scheme to use to communicate with the application.
+			# @returns [String]
+			def scheme
+				'https'
+			end
+			
+			# The protocol to use to communicate with the application.
+			#
+			# Typically one of {Async::HTTP::Protocol::HTTP1} or {Async::HTTP::Protocl::HTTP2}.
+			#
+			# @returns [Async::HTTP::Protocol]
+			def protocol
+				Async::HTTP::Protocol::HTTP2
+			end
+			
+			# The IPC path to use for communication with the application.
+			# @returns [String]
+			def ipc_path
+				::File.expand_path("application.ipc", root)
+			end
+			
+			# The endpoint that will be used for communicating with the application server.
+			# @returns [Async::IO::Endpoint]
+			def endpoint
+				::Falcon::ProxyEndpoint.unix(ipc_path,
+					protocol: protocol,
+					scheme: scheme,
+					authority: authority
+				)
+			end
+			
+			# Number of instances to start.
+			# @returns [Integer | nil]
+			def count
+				nil
+			end
+		end
+	end
+end

data/lib/falcon/environment/lets_encrypt_tls.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2020-2024, by Samuel Williams.
+
+require_relative 'tls'
+require_relative '../environment'
+
+module Falcon
+	module Environment
+		# Provides an environment that uses "Lets Encrypt" for TLS.
+		module LetsEncryptTLS
+			# The Lets Encrypt certificate store path.
+			# @parameter [String]
+			def lets_encrypt_root
+				'/etc/letsencrypt/live'
+			end
+			
+			# The public certificate path.
+			# @attribute [String]
+			def ssl_certificate_path
+				File.join(lets_encrypt_root, authority, "fullchain.pem")
+			end
+			
+			# The private key path.
+			# @attribute [String]
+			def ssl_private_key_path
+				File.join(lets_encrypt_root, authority, "privkey.pem")
+			end
+		end
+		
+		LEGACY_ENVIRONMENTS[:tls] = TLS
+	end
+end

data/lib/falcon/environment/proxy.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2019-2024, by Samuel Williams.
+
+require_relative 'server'
+require_relative '../tls'
+require_relative '../middleware/proxy'
+require_relative '../environment'
+
+module Falcon
+	module Environment
+		# Provides an environment for hosting a TLS-capable reverse proxy using SNI.
+		module Proxy
+			include Server
+			
+			# The host that this proxy will receive connections for.
+			def url
+				"https://[::]:443"
+			end
+			
+			# The default SSL session identifier.
+			def tls_session_id
+				"falcon"
+			end
+			
+			# The services we will proxy to.
+			# @returns [Array(Async::Service::Environment)]
+			def environments
+				[]
+			end
+			
+			# The hosts we will proxy to. This is a hash of SNI authority -> evaluator.
+			# @returns [Hash(String, Async::Service::Environment::Evaluator)]
+			def hosts
+				hosts = {}
+				
+				environments.each do |environment|
+					evaluator = environment.evaluator
+					
+					# next unless environment.implements?(Falcon::Environment::Application)
+					if evaluator.key?(:authority) and evaluator.key?(:ssl_context) and evaluator.key?(:endpoint)
+						Console.info(self) {"Proxying #{self.url} to #{evaluator.authority} using #{evaluator.endpoint}"}
+						hosts[evaluator.authority] = evaluator
+						
+						if RUBY_VERSION < '3.1'
+							# Ensure the SSL context is set up before forking - it's buggy on Ruby < 3.1:
+							evaluator.ssl_context
+						end
+					end
+				end
+				
+				return hosts
+			end
+			
+			# Look up the host context for the given hostname, and update the socket hostname if necessary.
+			# @parameter socket [OpenSSL::SSL::SSLSocket] The incoming connection.
+			# @parameter hostname [String] The negotiated hostname.
+			def host_context(socket, hostname)
+				hosts = self.hosts
+				
+				if host = hosts[hostname]
+					Console.logger.debug(self) {"Resolving #{hostname} -> #{host}"}
+					
+					socket.hostname = hostname
+					
+					return host.ssl_context
+				else
+					Console.logger.warn(self, hosts: hosts.keys) {"Unable to resolve #{hostname}!"}
+					
+					return nil
+				end
+			end
+			
+			# Generate an SSL context which delegates to {host_context} to multiplex based on hostname.
+			def ssl_context
+				@server_context ||= OpenSSL::SSL::SSLContext.new.tap do |context|
+					context.servername_cb = Proc.new do |socket, hostname|
+						self.host_context(socket, hostname)
+					end
+					
+					context.session_id_context = @session_id
+					
+					context.ssl_version = :TLSv1_2_server
+					
+					context.set_params(
+						ciphers: ::Falcon::TLS::SERVER_CIPHERS,
+						verify_mode: ::OpenSSL::SSL::VERIFY_NONE,
+					)
+					
+					context.setup
+				end
+			end
+			
+			# The endpoint the server will bind to.
+			def endpoint
+				super.with(
+					ssl_context: self.ssl_context,
+				)
+			end
+			
+			def middleware
+				return Middleware::Proxy.new(Middleware::BadRequest, self.hosts)
+			end
+		end
+		
+		LEGACY_ENVIRONMENTS[:proxy] = Proxy
+	end
+end

data/lib/falcon/environment/rack.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2019-2024, by Samuel Williams.
+
+require_relative 'application'
+require_relative 'rackup'
+require_relative '../environment'
+
+module Falcon
+	module Environment
+		# Provides an environment for hosting a web application that use a Rackup `config.ru` file.
+		module Rack
+			include Application
+			include Rackup
+		end
+		
+		LEGACY_ENVIRONMENTS[:rack] = Rack
+	end
+end

data/lib/falcon/environment/rackup.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2024, by Samuel Williams.
+
+require 'rack/builder'
+require_relative '../server'
+
+module Falcon
+	module Environment
+		# Provides an environment for hosting loading a Rackup `config.ru` file.
+		module Rackup
+			def rackup_path
+				'config.ru'
+			end
+			
+			def rack_app
+				::Rack::Builder.parse_file(rackup_path)
+			end
+			
+			def middleware
+				::Falcon::Server.middleware(rack_app, verbose: verbose, cache: cache)
+			end
+		end
+	end
+end

data/lib/falcon/environment/redirect.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2020-2024, by Samuel Williams.
+
+require_relative 'server'
+require_relative '../middleware/redirect'
+
+module Falcon
+	module Environment
+		# Provides an environment for redirecting insecure web traffic to a secure endpoint.
+		module Redirect
+			include Server
+			
+			def redirect_url
+				"https://[::]:443"
+			end
+			
+			def redirect_endpoint
+				Async::HTTP::Endpoint.parse(redirect_url)
+			end
+			
+			# The services we will redirect to.
+			# @returns [Array(Async::Service::Environment)]
+			def environments
+				[]
+			end
+			
+			def hosts
+				hosts = {}
+				
+				environments.each do |environment|
+					evaluator = environment.evaluator
+					
+					if environment.implements?(Falcon::Environment::Application)
+						Console.info(self) {"Redirecting #{self.url} to #{evaluator.authority}"}
+						hosts[evaluator.authority] = evaluator
+					end
+				end
+				
+				return hosts
+			end
+			
+			# Load the {Middleware::Redirect} application with the specified hosts.
+			def middleware
+				Middleware::Redirect.new(Middleware::NotFound, hosts, redirect_endpoint)
+			end
+		end
+	end
+end

data/lib/falcon/environment/self_signed_tls.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2019-2024, by Samuel Williams.
+
+require 'localhost/authority'
+require_relative 'tls'
+require_relative '../environment'
+
+module Falcon
+	module Environment
+		# Provides an environment that exposes a self-signed TLS certificate using the `localhost` gem.
+		module SelfSignedTLS
+			# The default session identifier for the session cache.
+			# @returns [String]
+			def ssl_session_id
+				"falcon"
+			end
+			
+			# The SSL context to use for incoming connections.
+			# @returns [OpenSSL::SSL::SSLContext]
+			def ssl_context
+				contexts = Localhost::Authority.fetch(authority)
+				
+				contexts.server_context.tap do |context|
+					context.alpn_select_cb = lambda do |protocols|
+						if protocols.include? "h2"
+							return "h2"
+						elsif protocols.include? "http/1.1"
+							return "http/1.1"
+						elsif protocols.include? "http/1.0"
+							return "http/1.0"
+						else
+							return nil
+						end
+					end
+					
+					context.session_id_context = ssl_session_id
+				end
+			end
+		end
+		
+		LEGACY_ENVIRONMENTS[:self_signed_tls] = SelfSignedTLS
+	end
+end

data/lib/falcon/environment/server.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2024, by Samuel Williams.
+
+require 'async/service/generic'
+require 'async/http/endpoint'
+
+require_relative '../service/server'
+require_relative '../server'
+
+module Falcon
+	module Environment
+		# Provides an environment for hosting a web application that uses a Falcon server.
+		module Server
+			# The service class to use for the proxy.
+			# @returns [Class]
+			def service_class
+				Service::Server
+			end
+			
+			# The server authority. Defaults to the server name.
+			# @returns [String]
+			def authority
+				self.name
+			end
+			
+			# Options to use when creating the container.
+			def container_options
+				{restart: true}
+			end
+			
+			# The host that this server will receive connections for.
+			def url
+				"http://[::]:9292"
+			end
+			
+			def timeout
+				nil
+			end
+			
+			# The upstream endpoint that will handle incoming requests.
+			# @returns [Async::HTTP::Endpoint]
+			def endpoint
+				::Async::HTTP::Endpoint.parse(url).with(
+					reuse_address: true,
+					timeout: timeout,
+				)
+			end
+			
+			def verbose
+				false
+			end
+			
+			def cache
+				false
+			end
+			
+			def client_endpoint
+				::Async::HTTP::Endpoint.parse(url)
+			end
+			
+			# Any scripts to preload before starting the server.
+			def preload
+				[]
+			end
+		end
+	end
+end