localhost 1.3.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 42bb902395ea685a7f1d14530439871920afb46b852aa9f6c3bbb8b66d07176a
-  data.tar.gz: 2b63d1af2999cd2ebca0f706bb626654cf765953fbbe1a0a6d4c3b6985482b50
+  metadata.gz: 35cad25f5ec79874e21312d5b70e4ffbf8ed616f3b8140a0f22dd6d0e1aa292b
+  data.tar.gz: 0e34a06090414bdd734c7b5ef094fab8a10a6c3286f0bf737e7a9f93a5d0b87a
 SHA512:
-  metadata.gz: f27728bc1e1593af0db04c176bd99c878958aa662d6902649d6d5cb617034269e641a61d201255be7f8a859a08b3015980b56f28672dc301547f7aa3c6c96fa8
-  data.tar.gz: 66ad2882eef6927aaf6da87280931a81f5928d2cf72bb92a6a10451721465a08b9d51f52a01a1d97847a7019c634499c2cb068ed19401d1e8e713452ec633156
+  metadata.gz: d6d2aa039d439e2e4e38f506335b5d72b80ffcf316886d85c86ecd1780547b156c97ddc060c93c0a9f67543bceb2d28535dde9ed955f28664a95508297433c19
+  data.tar.gz: 0142e748e4d118144d455bef736c2c545f18275f7c4503d118a58d239b20c13ba1c0aa3f0339d244eebd3ce30f42565f1d02246c5dc4f73f6698188c2cc1427a

checksums.yaml.gz.sig

@@ -1,2 +1,4 @@
-*X�ygs����Ki��⻃�/���D\y'q��n��Y������`�<�G�VL9��+e�2i�i��2´F�k��B���2-�60"gǨ,cT����HM>��Ђ�=	CmP���_1�Dk�v`md$C�W�˗12�q �I8U��&�I~��P�"��i��D��=�_�غE��)���
4���n��%��s���%�r�r9�7�e��{��_ 4˯�{��T3j
-pP�MVJ0�`sE>y��l�9K�S�5���������‚2��"μ���f������繞���*�L��8d�LO�o��퐝7�Š���n���y���u�GrA�1�d��蓀�b�ӑ�zR�៝�x�_ݿ���6xÇ��9����:.*|�a�
+���4�i�
+(��>sE�y;<XYΌh�`��6�P	I!8�S(�7�ۘפ��:(�8[fd?]�����Mg���#�uK���bC@_
+�"�K�:�O��7��w��ćMr>V�e�
S��Ȗ��i3�4�S���@_h)�
+��s�����-n��t0A=�x1[Q!�4(�p�G��gN��Ӳv�[������!h9:po���.L�l�H��W�ØP5L����

data/lib/localhost/authority.rb

@@ -17,13 +17,32 @@ module Localhost
 	class Authority
 		# Where to store the key pair on the filesystem. This is a subdirectory
 		# of $XDG_STATE_HOME, or ~/.local/state/ when that's not defined.
-		def self.path
-			File.expand_path("localhost.rb", ENV.fetch("XDG_STATE_HOME", "~/.local/state"))
+		#
+		# Ensures that the directory to store the certificate exists. If the legacy
+		# directory (~/.localhost/) exists, it is moved into the new XDG Basedir
+		# compliant directory.
+		#
+		# After May 2025, the old_root option may be removed.
+		def self.path(env = ENV, old_root: nil)
+			path = File.expand_path("localhost.rb", env.fetch("XDG_STATE_HOME", "~/.local/state"))
+			
+			unless File.directory?(path)
+				FileUtils.mkdir_p(path, mode: 0700)
+			end
+			
+			# Migrates the legacy dir ~/.localhost/ to the XDG compliant directory
+			old_root ||= File.expand_path("~/.localhost")
+			if File.directory?(old_root)
+				FileUtils.mv(Dir.glob(File.join(old_root, "*")), path, force: true)
+				FileUtils.rmdir(old_root)
+			end
+			
+			return path
 		end
 		
 		# List all certificate authorities in the given directory:
 		def self.list(root = self.path)
-			return to_enum(:list) unless block_given?
+			return to_enum(:list, root) unless block_given?
 			
 			Dir.glob("*.crt", base: root) do |path|
 				name = File.basename(path, ".crt")
@@ -66,10 +85,6 @@ module Localhost
 		
 		BITS = 1024*2
 		
-		def ecdh_key
-			@ecdh_key ||= OpenSSL::PKey::EC.new "prime256v1"
-		end
-		
 		def dh_key
 			@dh_key ||= OpenSSL::PKey::DH.new(BITS)
 		end
@@ -157,8 +172,6 @@ module Localhost
 				
 				if context.respond_to? :ecdh_curves=
 					context.ecdh_curves = 'P-256:P-384:P-521'
-				elsif context.respond_to? :tmp_ecdh_callback=
-					context.tmp_ecdh_callback = proc {self.ecdh_key}
 				end
 				
 				context.set_params(
@@ -180,11 +193,9 @@ module Localhost
 		end
 		
 		def load(path = @root)
-			ensure_authority_path_exists(path)
-			
 			certificate_path = File.join(path, "#{@hostname}.crt")
 			key_path = File.join(path, "#{@hostname}.key")
-						
+			
 			return false unless File.exist?(certificate_path) and File.exist?(key_path)
 			
 			certificate = OpenSSL::X509::Certificate.new(File.read(certificate_path))
@@ -200,8 +211,6 @@ module Localhost
 		end
 		
 		def save(path = @root)
-			ensure_authority_path_exists(path)
-			
 			lockfile_path = File.join(path, "#{@hostname}.lock")
 			
 			File.open(lockfile_path, File::RDWR|File::CREAT, 0644) do |lockfile|
@@ -218,19 +227,5 @@ module Localhost
 				)
 			end
 		end
-		
-		# Ensures that the directory to store the certificate exists. If the legacy
-		# directory (~/.localhost/) exists, it is moved into the new XDG Basedir
-		# compliant directory.
-		def ensure_authority_path_exists(path = @root)
-			old_root = File.expand_path("~/.localhost")
-			
-			if File.directory?(old_root) and not File.directory?(path)
-				# Migrates the legacy dir ~/.localhost/ to the XDG compliant directory
-				File.rename(old_root, path)
-			elsif not File.directory?(path)
-				FileUtils.makedirs(path, mode: 0700)
-			end
-		end
 	end
 end

data/lib/localhost/version.rb

@@ -4,5 +4,5 @@
 # Copyright, 2018-2024, by Samuel Williams.
 
 module Localhost
-	VERSION = "1.3.0"
+	VERSION = "1.3.1"
 end

data/readme.md

@@ -12,7 +12,13 @@ I wanted to provide a server-agnostic way of doing this, primarily because I thi
 
 ## Usage
 
-Please see the [project documentation](https://socketry.github.io/localhost/).
+Please see the [project documentation](https://socketry.github.io/localhost/) for more details.
+
+  - [Getting Started](https://socketry.github.io/localhost/guides/getting-started/index) - This guide explains how to use `localhost` for provisioning local TLS certificates for development.
+
+  - [Browser Configuration](https://socketry.github.io/localhost/guides/browser-configuration/index) - This guide explains how to configure your local browser in order to avoid warnings about insecure self-signed certificates.
+
+  - [Example Server](https://socketry.github.io/localhost/guides/example-server/index) - This guide demonstrates how to use <code class="language-ruby">Localhost::Authority</code> to implement a simple HTTPS client & server.
 
 ## Contributing
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: localhost
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.3.1
 platform: ruby
 authors:
 - Samuel Williams
@@ -46,7 +46,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2024-04-12 00:00:00.000000000 Z
+date: 2024-04-16 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -73,7 +73,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.0'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="