1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 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 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 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 172 173 174 175 176 177 178 179 180 181 182 183 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 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264
|
# frozen_string_literal: true
# Released under the MIT License.
# Copyright, 2018-2026, by Samuel Williams.
# Copyright, 2019, by Richard S. Leung.
# Copyright, 2021, by Akshay Birajdar.
# Copyright, 2021, by Ye Lin Aung.
# Copyright, 2023, by Antonio Terceiro.
# Copyright, 2023, by Yuuji Yaginuma.
# Copyright, 2024, by Colin Shea.
# Copyright, 2024, by Aurel Branzeanu.
require "fileutils"
require "openssl"
require_relative "state"
require_relative "issuer"
module Localhost
# Represents a single public/private key pair for a given hostname.
class Authority
# @returns [String] The path to the directory containing the certificate authorities.
def self.path
State.path
end
# List all certificate authorities in the given directory.
#
# @parameter path [String] The path to the directory containing the certificate authorities.
# @yields [Authority] Each certificate authority in the directory.
def self.list(path = State.path)
return to_enum(:list, path) unless block_given?
Dir.glob("*.crt", base: path) do |certificate_path|
hostname = File.basename(certificate_path, ".crt")
authority = self.new(hostname, path: path)
if authority.load
yield authority
end
end
end
# Fetch (load or create) a certificate with the given hostname.
# See {#initialize} for the format of the arguments.
def self.fetch(*arguments, **options)
authority = self.new(*arguments, **options)
unless authority.load
authority.save
end
return authority
end
# Create an authority forn the given hostname.
# @parameter hostname [String] The common name to use for the certificate.
# @parameter path [String] The path path for loading and saving the certificate.
def initialize(hostname = "localhost", path: State.path, issuer: Issuer.fetch)
@path = path
@hostname = hostname
@issuer = issuer
@subject = nil
@key = nil
@certificate = nil
@store = nil
end
attr :issuer
# The hostname of the certificate authority.
attr :hostname
BITS = 1024*2
# @returns [OpenSSL::PKey::DH] A Diffie-Hellman key suitable for secure key exchange.
def dh_key
@dh_key ||= OpenSSL::PKey::DH.new(BITS)
end
# @returns [String] The path to the private key.
def key_path
File.join(@path, "#{@hostname}.key")
end
# @returns [String] The path to the public certificate.
def certificate_path
File.join(@path, "#{@hostname}.crt")
end
# @returns [OpenSSL::PKey::RSA] The private key.
def key
@key ||= OpenSSL::PKey::RSA.new(BITS)
end
# Set the private key.
#
# @parameter key [OpenSSL::PKey::RSA] The private key.
def key= key
@key = key
end
# @returns [OpenSSL::X509::Name] The subject name for the certificate.
def subject
@subject ||= OpenSSL::X509::Name.parse("/O=localhost.rb/CN=#{@hostname}")
end
# Set the subject name for the certificate.
#
# @parameter subject [OpenSSL::X509::Name] The subject name.
def subject= subject
@subject = subject
end
# Generates a self-signed certificate if one does not already exist for the given hostname.
#
# @returns [OpenSSL::X509::Certificate] A self-signed certificate.
def certificate
issuer = @issuer || self
@certificate ||= OpenSSL::X509::Certificate.new.tap do |certificate|
certificate.subject = self.subject
certificate.issuer = issuer.subject
certificate.public_key = self.key.public_key
certificate.serial = Time.now.to_i
certificate.version = 2
certificate.not_before = Time.now
certificate.not_after = Time.now + (3600 * 24 * 365)
extension_factory = OpenSSL::X509::ExtensionFactory.new
extension_factory.subject_certificate = certificate
extension_factory.issuer_certificate = @issuer&.certificate || certificate
certificate.add_extension extension_factory.create_extension("basicConstraints", "CA:FALSE", true)
certificate.add_extension extension_factory.create_extension("subjectKeyIdentifier", "hash")
certificate.add_extension extension_factory.create_extension("subjectAltName", "DNS: #{@hostname}")
certificate.add_extension extension_factory.create_extension("authorityKeyIdentifier", "keyid:always,issuer:always")
certificate.sign issuer.key, OpenSSL::Digest::SHA256.new
end
end
# The certificate store which is used for validating the server certificate.
#
# @returns [OpenSSL::X509::Store] The certificate store with the issuer certificate.
def store
@store ||= OpenSSL::X509::Store.new.tap do |store|
if @issuer
store.add_cert(@issuer.certificate)
else
store.add_cert(self.certificate)
end
end
end
SERVER_CIPHERS = "EECDH+CHACHA20:EECDH+AES128:RSA+AES128:EECDH+AES256:RSA+AES256:EECDH+3DES:RSA+3DES:!MD5".freeze
# @returns [OpenSSL::SSL::SSLContext] An context suitable for implementing a secure server.
def server_context(*arguments)
OpenSSL::SSL::SSLContext.new(*arguments).tap do |context|
context.key = self.key
context.cert = self.certificate
if @issuer
context.extra_chain_cert = [@issuer.certificate]
end
context.session_id_context = "localhost"
if context.respond_to? :tmp_dh_callback=
context.tmp_dh_callback = proc{self.dh_key}
end
if context.respond_to? :ecdh_curves=
context.ecdh_curves = "P-256:P-384:P-521"
end
context.set_params(
ciphers: SERVER_CIPHERS,
verify_mode: OpenSSL::SSL::VERIFY_NONE,
)
end
end
# @returns [OpenSSL::SSL::SSLContext] An context suitable for connecting to a secure server using this authority.
def client_context(*args)
OpenSSL::SSL::SSLContext.new(*args).tap do |context|
context.cert_store = self.store
context.set_params(
verify_mode: OpenSSL::SSL::VERIFY_PEER,
)
end
end
# Load the certificate and key from the given path.
#
# @parameter path [String] The path to the certificate and key.
# @returns [Boolean] Whether the certificate and key were successfully loaded.
def load(path = @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))
key = OpenSSL::PKey::RSA.new(File.read(key_path))
# Certificates with old version need to be regenerated.
return false if certificate.version < 2
@certificate = certificate
@key = key
return true
end
# Save the certificate and key to the given path.
#
# @parameter path [String] The path to save the certificate and key.
def save(path = @path)
lockfile_path = File.join(path, "#{@hostname}.lock")
File.open(lockfile_path, File::RDWR|File::CREAT, 0644) do |lockfile|
lockfile.flock(File::LOCK_EX)
File.write(
File.join(path, "#{@hostname}.crt"),
self.certificate.to_pem
)
File.write(
File.join(path, "#{@hostname}.key"),
self.key.to_pem
)
end
return true
end
# @returns A hash representation of the authority's certificate details.
def to_h
{
hostname: @hostname,
certificate_path: certificate_path,
key_path: key_path,
expires_at: certificate.not_after,
}
end
def as_json(...)
self.to_h
end
def to_json(...)
self.as_json.to_json(...)
end
end
end
|