Class: HTTPI::Auth::SSL

Inherits:
Object
  • Object
show all
Defined in:
lib/httpi/auth/ssl.rb

Overview

HTTPI::Auth::SSL

Provides SSL client authentication.

Constant Summary collapse

VERIFY_MODES =
[:none, :peer, :fail_if_no_peer_cert, :client_once]
CERT_TYPES =
[:pem, :der]
SSL_VERSIONS =
if ssl_context.const_defined? :METHODS_MAP
  ssl_context.const_get(:METHODS_MAP).keys
else
  ssl_context::METHODS.reject { |method| method.match(/server|client/) }
end.sort.reverse
MIN_MAX_VERSIONS =

Returns OpenSSL::SSL::*_VERSION values for min_version and max_version

OpenSSL::SSL.constants.select{|constant| constant =~/_VERSION$/}.map{|version| version.to_s.gsub(/_VERSION$/,'').to_sym}.reverse

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#ca_certObject

Returns an OpenSSL::X509::Certificate for the ca_cert_file.


135
136
137
# File 'lib/httpi/auth/ssl.rb', line 135

def ca_cert
  @ca_cert ||= OpenSSL::X509::Certificate.new File.read(ca_cert_file)
end

#ca_cert_fileObject

Accessor for the cacert file to validate SSL certificates.


43
44
45
# File 'lib/httpi/auth/ssl.rb', line 43

def ca_cert_file
  @ca_cert_file
end

#ca_cert_pathObject

Accessor for the ca_path to validate SSL certificates.


46
47
48
# File 'lib/httpi/auth/ssl.rb', line 46

def ca_cert_path
  @ca_cert_path
end

#certObject

Returns an OpenSSL::X509::Certificate for the cert_file.


127
128
129
# File 'lib/httpi/auth/ssl.rb', line 127

def cert
  @cert ||= (OpenSSL::X509::Certificate.new File.read(cert_file) if cert_file)
end

#cert_fileObject

Accessor for the cert file to validate SSL connections.


40
41
42
# File 'lib/httpi/auth/ssl.rb', line 40

def cert_file
  @cert_file
end

#cert_keyObject

Returns an OpenSSL::PKey subclass (usually OpenSSL::PKey::RSA) for the cert_key_file.


143
144
145
# File 'lib/httpi/auth/ssl.rb', line 143

def cert_key
  @cert_key ||= (OpenSSL::PKey.read(File.read(cert_key_file), cert_key_password) if cert_key_file)
end

#cert_key_fileObject

Accessor for the cert key file to validate SSL certificates.


34
35
36
# File 'lib/httpi/auth/ssl.rb', line 34

def cert_key_file
  @cert_key_file
end

#cert_key_passwordObject

Accessor for the cert key password to validate SSL certificates.


37
38
39
# File 'lib/httpi/auth/ssl.rb', line 37

def cert_key_password
  @cert_key_password
end

#cert_storeObject

Certificate store holds trusted CA certificates used to verify peer certificates.


49
50
51
# File 'lib/httpi/auth/ssl.rb', line 49

def cert_store
  @cert_store
end

Instance Method Details

#cert_typeObject

Returns the cert type to validate SSL certificates PEM|DER.


52
53
54
# File 'lib/httpi/auth/ssl.rb', line 52

def cert_type
  @cert_type ||= :pem
end

#cert_type=(type) ⇒ Object

Sets the cert type to validate SSL certificates PEM|DER.


57
58
59
60
61
62
63
64
# File 'lib/httpi/auth/ssl.rb', line 57

def cert_type=(type)
  unless CERT_TYPES.include? type
    raise ArgumentError, "Invalid SSL cert type #{type.inspect}\n" +
                         "Please specify one of #{CERT_TYPES.inspect}"
  end

  @cert_type = type
end

#max_versionObject

Returns the SSL min_version number. Defaults to nil (auto-negotiate).


112
113
114
# File 'lib/httpi/auth/ssl.rb', line 112

def max_version
  @max_version ||= nil
end

#max_version=(version) ⇒ Object

Sets the SSL min_version number. Expects one of HTTPI::Auth::SSL::MIN_MAX_VERSIONS.


117
118
119
120
121
122
123
124
# File 'lib/httpi/auth/ssl.rb', line 117

def max_version=(version)
  unless MIN_MAX_VERSIONS.include? version
    raise ArgumentError, "Invalid SSL max_version #{version.inspect}\n" +
                         "Please specify one of #{MIN_MAX_VERSIONS.inspect}"
  end

  @max_version = version
end

#min_versionObject

Returns the SSL min_version number. Defaults to nil (auto-negotiate).


97
98
99
# File 'lib/httpi/auth/ssl.rb', line 97

def min_version
  @min_version ||= nil
end

#min_version=(version) ⇒ Object

Sets the SSL min_version number. Expects one of HTTPI::Auth::SSL::MIN_MAX_VERSIONS.


102
103
104
105
106
107
108
109
# File 'lib/httpi/auth/ssl.rb', line 102

def min_version=(version)
  unless MIN_MAX_VERSIONS.include? version
    raise ArgumentError, "Invalid SSL min_version #{version.inspect}\n" +
                         "Please specify one of #{MIN_MAX_VERSIONS.inspect}"
  end

  @min_version = version
end

#openssl_verify_modeObject

Returns the SSL verify mode as a OpenSSL::SSL::VERIFY_* constant.


151
152
153
154
155
156
157
158
# File 'lib/httpi/auth/ssl.rb', line 151

def openssl_verify_mode
  case verify_mode
    when :none                 then OpenSSL::SSL::VERIFY_NONE
    when :peer                 then OpenSSL::SSL::VERIFY_PEER
    when :fail_if_no_peer_cert then OpenSSL::SSL::VERIFY_FAIL_IF_NO_PEER_CERT
    when :client_once          then OpenSSL::SSL::VERIFY_CLIENT_ONCE
  end
end

#present?Boolean

Returns whether SSL configuration is present.

Returns:

  • (Boolean)

27
28
29
30
31
# File 'lib/httpi/auth/ssl.rb', line 27

def present?
  (verify_mode == :none) || (cert && cert_key) || ca_cert_file
rescue TypeError, Errno::ENOENT
  false
end

#ssl_versionObject

Returns the SSL version number. Defaults to nil (auto-negotiate).


82
83
84
# File 'lib/httpi/auth/ssl.rb', line 82

def ssl_version
  @ssl_version ||= nil
end

#ssl_version=(version) ⇒ Object

Sets the SSL version number. Expects one of HTTPI::Auth::SSL::SSL_VERSIONS.


87
88
89
90
91
92
93
94
# File 'lib/httpi/auth/ssl.rb', line 87

def ssl_version=(version)
  unless SSL_VERSIONS.include? version
    raise ArgumentError, "Invalid SSL version #{version.inspect}\n" +
                         "Please specify one of #{SSL_VERSIONS.inspect}"
  end

  @ssl_version = version
end

#verify_modeObject

Returns the SSL verify mode. Defaults to :peer.


67
68
69
# File 'lib/httpi/auth/ssl.rb', line 67

def verify_mode
  @verify_mode ||= :peer
end

#verify_mode=(mode) ⇒ Object

Sets the SSL verify mode. Expects one of HTTPI::Auth::SSL::VERIFY_MODES.


72
73
74
75
76
77
78
79
# File 'lib/httpi/auth/ssl.rb', line 72

def verify_mode=(mode)
  unless VERIFY_MODES.include? mode
    raise ArgumentError, "Invalid SSL verify mode #{mode.inspect}\n" +
                         "Please specify one of #{VERIFY_MODES.inspect}"
  end

  @verify_mode = mode
end