Module: OverSIP::TLS

Extended by:
Logger
Defined in:
lib/oversip/tls.rb

Constant Summary collapse

TLS_PEM_CHAIN_REGEXP = 
/-{5}BEGIN CERTIFICATE-{5}\n.*?-{5}END CERTIFICATE-{5}\n/m

Class Method Summary collapse

Methods included from Logger

close, fg_system_msg2str, init_logger_mq, load_methods, log_id, syslog_system_msg2str, syslog_user_msg2str

Class Method Details

.get_sip_identities(cert) ⇒ Object 



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
 
# File 'lib/oversip/tls.rb', line 127

def self.get_sip_identities cert
  return []  unless cert

  verify_subjectAltName_DNS = true
  verify_CN = true
  subjectAltName_URI_sip_entries = []
  subjectAltName_DNS_entries = []
  sip_identities = {}

  cert.extensions.each do |ext|
    next if ext.oid != "subjectAltName"
    verify_CN = false

    ext.value.split(/,\s+/).each do |name|
      if /^URI:sip:([^@]*)/i =~ name
        verify_subjectAltName_DNS = false
        subjectAltName_URI_sip_entries << $1.downcase
      elsif verify_subjectAltName_DNS && /^DNS:(.*)/i =~ name
        subjectAltName_DNS_entries << $1.downcase
      end
    end
  end

  unless verify_CN
    unless verify_subjectAltName_DNS
      subjectAltName_URI_sip_entries.each {|domain| sip_identities[domain] = true}
    else
      subjectAltName_DNS_entries.each {|domain| sip_identities[domain] = true}
    end

  else
    cert.subject.to_a.each do |oid, value|
      if oid == "CN"
        sip_identities[value.downcase] = true
        break
      end
    end
  end

  # Return an array with the SIP identities (domains) in the certificate.
  return sip_identities.keys
end

.module_init ⇒ Object 



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
 
# File 'lib/oversip/tls.rb', line 12

def self.module_init
  configuration = ::OverSIP.configuration
  if configuration[:tls][:public_cert] and configuration[:tls][:private_cert]
    log_system_info "TLS enabled"
    ::OverSIP.tls_public_cert = configuration[:tls][:public_cert]
    ::OverSIP.tls_private_cert = configuration[:tls][:private_cert]
  else
    log_system_info "TLS disabled"
    return
  end

  if (ca_dir = configuration[:tls][:ca_dir])
    @store = ::OpenSSL::X509::Store.new
    num_certs_added = 0

    ::Dir.chdir ca_dir
    ca_files = ::Dir["*"]
    ca_files.select! { |ca_file| ::File.file?(ca_file) and ::File.readable?(ca_file) }
    ca_files.each do |ca_file|
      log_system_info "inspecting CA file '#{ca_file}'..."

      ca_file_content = ::File.read(ca_file)
      unless ca_file_content.valid_encoding?
        log_system_error "ignoring '#{ca_file}', invalid symbols found"
        next
      end

      pems = ca_file_content.scan(TLS_PEM_CHAIN_REGEXP).flatten
      num_pems = pems.size

      if num_pems == 0
        log_system_warn "'#{ca_file}': no public certificates found"
        next
      end
      log_system_info "'#{ca_file}': #{num_pems} public certificates found"

      now = ::Time.now
      certs = []
      pems.each do |pem|
        begin
          certs << ::OpenSSL::X509::Certificate.new(pem)
        rescue => e
          log_system_error "ignoring invalid X509 certificate: #{e.message} (#{e.class})"
          num_pems -= 1
        end
      end

      certs.reject! { |cert| cert.not_after < now }
      if certs.size != num_pems
        log_system_info "'#{ca_file}': ignoring #{num_pems - certs.size} expired certificates"
      end

      certs.each do |cert|
        begin
          @store.add_cert cert
          num_certs_added += 1
        # This occurs when a certificate is repeated.
        rescue ::OpenSSL::X509::StoreError => e
          log_system_warn "'#{ca_file}': ignoring certificate: #{e.message} (#{e.class})"
        end
      end
    end

    if num_certs_added == 0
      log_system_notice "zero public certificates found in '#{ca_dir}' directory, disabling TLS validation"
      @store = nil
    end
    log_system_info "#{num_certs_added} public certificates available for TLS validation"
  end

end

.validate(pems) ⇒ Object

Return an array with the result of the TLS certificate validation as follows:

cert, validated, tls_error, tls_error_string

where:

  • cert: the ::OpenSSL::X509::Certificate instance of the first PEM provided by

    the peer, nil otherwise.

  • validated: true if the given certificate(s) have been validated, false otherwise

    and nil if no certificate is provided by peer or no CA's were configured
for TLS validation.

  • tls_error: OpenSSL validation error code (Fixnum) in case of validation error.

  • tls_error_string: OpenSSL validation error string in case of validation error.



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
 
# File 'lib/oversip/tls.rb', line 95

def self.validate pems
  return nil, nil, nil, "no CAs provided, validation disabled"  unless @store
  return nil, false, nil, "no certificate provided by peer"  unless pems.any?

  pem = pems.pop
  intermediate_pems = pems

  begin
    cert = ::OpenSSL::X509::Certificate.new pem

    if intermediate_pems and intermediate_pems.any?
      intermediate_certs = []
      intermediate_pems.each do |pem|
        intermediate_certs << ::OpenSSL::X509::Certificate.new(pem)
      end
    else
      intermediate_certs = nil
    end

    if @store.verify cert, intermediate_certs
      return cert, true
    else
      return cert, false, @store.error, @store.error_string
    end

  rescue => e
    log_system_error "exception validating a certificate: #{e.class}: #{e.message}"
    return nil, false, e.class, e.message
  end
end