class DRb::DRbSSLSocket::SSLConfig

SSLConfig 处理建立 DRbSSLSocket 连接所需的 SSL 信息，包括生成 X509 / RSA 密钥对。

此配置的一个实例可以传递给 DRbSSLSocket.new、 DRbSSLSocket.open 和 DRbSSLSocket.open_server

有关更多详细信息，请参阅 DRb::DRbSSLSocket::SSLConfig.new

常量

DEFAULT

SSLConfig 实例的默认值。

有关更多详细信息，请参阅 DRb::DRbSSLSocket::SSLConfig.new

公共类方法

new(config) 点击切换源代码

创建一个新的 DRb::DRbSSLSocket::SSLConfig 实例

DRb::DRbSSLSocket 将接受一个 config Hash 或 SSLConfig 的实例，并为其会话设置证书进行配置。如果希望它生成通用证书，最基本的是提供 :SSLCertName

配置选项¶ ↑

来自 config Hash

:SSLCertificate

OpenSSL::X509::Certificate 的实例。如果未提供此项，则会生成一个通用 X509，并对应一个 :SSLPrivateKey

:SSLPrivateKey

私钥实例，如 OpenSSL::PKey::RSA。此密钥必须是签署 :SSLCertificate 的密钥

:SSLClientCA

OpenSSL::X509::Certificate 或将用作 SSL 上下文中的 ClientCA 的证书数组

:SSLCACertificatePath

CA 证书目录的路径。证书必须为 PEM 格式。

:SSLCACertificateFile

CA 证书文件的路径，为 PEM 格式。

:SSLTmpDhCallback

DH 回调。请参阅 OpenSSL::SSL::SSLContext.tmp_dh_callback

:SSLMinVersion

这是允许的最小 SSL 版本。请参阅 OpenSSL::SSL::SSLContext#min_version=。

:SSLMaxVersion

这是允许的最大 SSL 版本。请参阅 OpenSSL::SSL::SSLContext#max_version=。

:SSLVerifyMode

这是 SSL 验证模式。有关可用模式，请参阅 OpenSSL::SSL::VERIFY_*。默认值为 OpenSSL::SSL::VERIFY_NONE

:SSLVerifyDepth

验证证书链时要遍历的 CA 证书数量。

:SSLVerifyCallback

用于额外验证的回调。请参阅 OpenSSL::SSL::SSLContext.verify_callback

:SSLCertificateStore

用于验证证书的 OpenSSL::X509::Store

:SSLCertName

证书的颁发者名称。生成证书时（如果未提供 :SSLCertificate 和 :SSLPrivateKey），则必须提供此项。此值应为成对的数组

[["C", "Raleigh"], ["ST","North Carolina"],
 ["CN","fqdn.example.com"]]

另请参阅 OpenSSL::X509::Name

:SSLCertComment

用于生成证书的注释。默认值为“Generated by Ruby/OpenSSL”

示例¶ ↑

这些值可以在事后添加，就像 Hash 一样。

require 'drb/ssl'
c = DRb::DRbSSLSocket::SSLConfig.new {}
c[:SSLCertificate] =
  OpenSSL::X509::Certificate.new(File.read('mycert.crt'))
c[:SSLPrivateKey] = OpenSSL::PKey::RSA.new(File.read('mycert.key'))
c[:SSLVerifyMode] = OpenSSL::SSL::VERIFY_PEER
c[:SSLCACertificatePath] = "/etc/ssl/certs/"
c.setup_certificate

或

require 'drb/ssl'
c = DRb::DRbSSLSocket::SSLConfig.new({
        :SSLCertName => [["CN" => DRb::DRbSSLSocket.getservername]]
        })
c.setup_certificate

# File drb-2.2.1/lib/drb/ssl.rb, line 135
def initialize(config)
  @config  = config
  @cert    = config[:SSLCertificate]
  @pkey    = config[:SSLPrivateKey]
  @ssl_ctx = nil
end

公共实例方法

[](key) 点击切换源代码

一种方便的方法，可以像 Hash 一样访问值

# File drb-2.2.1/lib/drb/ssl.rb, line 143
def [](key);
  @config[key] || DEFAULT[key]
end

accept(tcp) 点击切换源代码

使用当前证书配置的上下文接受与 IO tcp 的连接

# File drb-2.2.1/lib/drb/ssl.rb, line 158
def accept(tcp)
  ssl = OpenSSL::SSL::SSLSocket.new(tcp, @ssl_ctx)
  ssl.sync = true
  ssl.accept
  ssl
end

connect(tcp) 点击切换源代码

使用当前证书配置的上下文连接到 IO tcp

# File drb-2.2.1/lib/drb/ssl.rb, line 149
def connect(tcp)
  ssl = ::OpenSSL::SSL::SSLSocket.new(tcp, @ssl_ctx)
  ssl.sync = true
  ssl.connect
  ssl
end

setup_certificate() 点击切换源代码

确保已提供 :SSLCertificate 和 :SSLPrivateKey，或者使用提供的其他参数生成新证书。

# File drb-2.2.1/lib/drb/ssl.rb, line 168
def setup_certificate
  if @cert && @pkey
    return
  end

  rsa = OpenSSL::PKey::RSA.new(2048){|p, n|
    next unless self[:verbose]
    case p
    when 0; $stderr.putc "."  # BN_generate_prime
    when 1; $stderr.putc "+"  # BN_generate_prime
    when 2; $stderr.putc "*"  # searching good prime,
                              # n = #of try,
                              # but also data from BN_generate_prime
    when 3; $stderr.putc "\n" # found good prime, n==0 - p, n==1 - q,
                              # but also data from BN_generate_prime
    else;   $stderr.putc "*"  # BN_generate_prime
    end
  }

  cert = OpenSSL::X509::Certificate.new
  cert.version = 3
  cert.serial = 0
  name = OpenSSL::X509::Name.new(self[:SSLCertName])
  cert.subject = name
  cert.issuer = name
  cert.not_before = Time.now
  cert.not_after = Time.now + (365*24*60*60)
  cert.public_key = rsa.public_key

  ef = OpenSSL::X509::ExtensionFactory.new(nil,cert)
  cert.extensions = [
    ef.create_extension("basicConstraints","CA:FALSE"),
    ef.create_extension("subjectKeyIdentifier", "hash") ]
  ef.issuer_certificate = cert
  cert.add_extension(ef.create_extension("authorityKeyIdentifier",
                                         "keyid:always,issuer:always"))
  if comment = self[:SSLCertComment]
    cert.add_extension(ef.create_extension("nsComment", comment))
  end
  cert.sign(rsa, "SHA256")

  @cert = cert
  @pkey = rsa
end

setup_ssl_context() 点击切换源代码

使用提供的配置参数建立 OpenSSL::SSL::SSLContext。

# File drb-2.2.1/lib/drb/ssl.rb, line 215
def setup_ssl_context
  ctx = ::OpenSSL::SSL::SSLContext.new
  ctx.cert            = @cert
  ctx.key             = @pkey
  ctx.min_version     = self[:SSLMinVersion]
  ctx.max_version     = self[:SSLMaxVersion]
  ctx.client_ca       = self[:SSLClientCA]
  ctx.ca_path         = self[:SSLCACertificatePath]
  ctx.ca_file         = self[:SSLCACertificateFile]
  ctx.tmp_dh_callback = self[:SSLTmpDhCallback]
  ctx.verify_mode     = self[:SSLVerifyMode]
  ctx.verify_depth    = self[:SSLVerifyDepth]
  ctx.verify_callback = self[:SSLVerifyCallback]
  ctx.cert_store      = self[:SSLCertificateStore]
  @ssl_ctx = ctx
end