-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
/
context.cr
528 lines (471 loc) · 19.7 KB
/
context.cr
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
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
require "uri/punycode"
require "log"
# An `SSL::Context` represents a generic secure socket protocol configuration.
#
# For both server and client applications exist more specialized subclassses
# `SSL::Context::Server` and `SSL::Context::Client` which need to be instantiated
# appropriately.
abstract class OpenSSL::SSL::Context
# :nodoc:
def self.default_method
{% if LibSSL.has_method?(:tls_method) %}
LibSSL.tls_method
{% else %}
LibSSL.sslv23_method
{% end %}
end
class Client < Context
@hostname : String?
# Generates a new TLS client context with sane defaults for a client connection.
#
# Defaults to `TLS_method` or `SSLv23_method` (depending on OpenSSL version)
# which tells OpenSSL to negotiate the TLS or SSL protocol with the remote
# endpoint.
#
# Don't change the method unless you must restrict a specific protocol to be
# used (eg: TLSv1.2) and nothing else. You should specify options to disable
# specific protocols, yet allow to negotiate from various other ones. For
# example the following snippet will enable the TLSv1, TLSv1.1 and TLSv1.2
# protocols but disable the deprecated SSLv2 and SSLv3 protocols:
#
# ```
# require "openssl"
#
# context = OpenSSL::SSL::Context::Client.new
# context.add_options(OpenSSL::SSL::Options::NO_SSL_V2 | OpenSSL::SSL::Options::NO_SSL_V3)
# ```
#
# It uses `CIPHERS_OLD` compatibility level by default.
def initialize(method : LibSSL::SSLMethod = Context.default_method)
super(method)
self.verify_mode = OpenSSL::SSL::VerifyMode::PEER
{% if LibSSL.has_method?(:x509_verify_param_lookup) %}
self.default_verify_param = "ssl_server"
{% end %}
self.ciphers = CIPHERS_OLD
end
# Returns a new TLS client context with only the given method set.
#
# For everything else this uses the defaults of your OpenSSL.
# Use this only if undoing the defaults that `new` sets is too much hassle.
def self.insecure(method : LibSSL::SSLMethod = Context.default_method) : self
super(method)
end
# Configures a client context from a hash-like interface.
#
# ```
# require "openssl"
#
# context = OpenSSL::SSL::Context::Client.from_hash({"key" => "private.key", "cert" => "certificate.crt", "ca" => "ca.pem"})
# ```
#
# Params:
#
# * `key` *(required)*: Path to private key file. See `#private_key=`.
# * `cert` *(required)*: Path to the file containing the public certificate chain. See `#certificate_chain=`.
# * `verify_mode`: Either `peer`, `force-peer`, `none` or empty (default: `peer`). See `verify_mode=`.
# * `ca`: Path to a file containing the CA certificate chain or a directory containing all CA certificates.
# See `#ca_certificates=` and `#ca_certificates_path=`, respectively.
# Required if `verify_mode` is `peer`, `force-peer` or empty.
def self.from_hash(params) : self
super(params)
end
# Wraps the original certificate verification to also validate the
# hostname against the certificate configured Subject Alternate
# Names or Common Name.
#
# Required for OpenSSL <= 1.0.1 only.
protected def set_cert_verify_callback(hostname : String)
# Sanitize the hostname with PunyCode
hostname = URI::Punycode.to_ascii hostname
# Keep a reference so the GC doesn't collect it after sending it to C land
@hostname = hostname
LibSSL.ssl_ctx_set_cert_verify_callback(@handle, ->(x509_ctx, arg) {
if LibCrypto.x509_verify_cert(x509_ctx) != 0
cert = LibCrypto.x509_store_ctx_get_current_cert(x509_ctx)
HostnameValidation.validate_hostname(arg.as(String), cert) == HostnameValidation::Result::MatchFound ? 1 : 0
else
0
end
}, hostname.as(Void*))
end
private def alpn_protocol=(protocol : Bytes)
{% if LibSSL.has_method?(:ssl_ctx_set_alpn_protos) %}
LibSSL.ssl_ctx_set_alpn_protos(@handle, protocol, protocol.size)
{% else %}
raise NotImplementedError.new("LibSSL.ssl_ctx_set_alpn_protos")
{% end %}
end
end
class Server < Context
# Generates a new TLS server context with sane defaults for a server connection.
#
# Defaults to `TLS_method` or `SSLv23_method` (depending on OpenSSL version)
# which tells OpenSSL to negotiate the TLS or SSL protocol with the remote
# endpoint.
#
# Don't change the method unless you must restrict a specific protocol to be
# used (eg: TLSv1.2) and nothing else. You should specify options to disable
# specific protocols, yet allow to negotiate from various other ones. For
# example the following snippet will enable the TLSv1, TLSv1.1 and TLSv1.2
# protocols but disable the deprecated SSLv2 and SSLv3 protocols:
#
# ```
# context = OpenSSL::SSL::Context::Server.new
# context.add_options(OpenSSL::SSL::Options::NO_SSL_V2 | OpenSSL::SSL::Options::NO_SSL_V3)
# ```
#
# It uses `CIPHERS_INTERMEDIATE` compatibility level by default.
def initialize(method : LibSSL::SSLMethod = Context.default_method)
super(method)
add_options(OpenSSL::SSL::Options::CIPHER_SERVER_PREFERENCE)
{% if LibSSL.has_method?(:x509_verify_param_lookup) %}
self.default_verify_param = "ssl_client"
{% end %}
set_tmp_ecdh_key(curve: LibCrypto::NID_X9_62_prime256v1)
self.ciphers = CIPHERS_INTERMEDIATE
end
# Returns a new TLS server context with only the given method set.
#
# For everything else this uses the defaults of your OpenSSL.
# Use this only if undoing the defaults that `new` sets is too much hassle.
def self.insecure(method : LibSSL::SSLMethod = Context.default_method) : self
super(method)
end
# Configures a server from a hash-like interface.
#
# ```
# require "openssl"
#
# context = OpenSSL::SSL::Context::Client.from_hash({"key" => "private.key", "cert" => "certificate.crt", "ca" => "ca.pem"})
# ```
#
# Params:
#
# * `key` *(required)*: Path to private key file. See `#private_key=`.
# * `cert` *(required)*: Path to the file containing the public certificate chain. See `#certificate_chain=`.
# * `verify_mode`: Either `peer`, `force-peer`, `none` or empty (default: `none`). See `verify_mode=`.
# * `ca`: Path to a file containing the CA certificate chain or a directory containing all CA certificates.
# See `#ca_certificates=` and `#ca_certificates_path=`, respectively.
# Required if `verify_mode` is `peer` or `force-peer`.
def self.from_hash(params) : self
super(params)
end
# Disables all session ticket generation for this context.
# Tickets are used to resume earlier sessions more quickly,
# but in TLS 1.3 if the client connects, sends data, and closes the connection
# unidirectionally, the server connects, then sends a ticket
# after the connect handshake, the ticket send can fail with Broken Pipe.
# So if you have that kind of behavior (clients that never read) call this method.
def disable_session_resume_tickets : Nil
add_options(OpenSSL::SSL::Options::NO_TICKET) # TLS v1.2 and below
{% if LibSSL.has_method?(:ssl_ctx_set_num_tickets) %}
ret = LibSSL.ssl_ctx_set_num_tickets(self, 0) # TLS v1.3
raise OpenSSL::Error.new("SSL_CTX_set_num_tickets") if ret != 1
{% end %}
end
private def alpn_protocol=(protocol : Bytes)
{% if LibSSL.has_method?(:ssl_ctx_set_alpn_select_cb) %}
alpn_cb = ->(ssl : LibSSL::SSL, o : LibC::Char**, olen : LibC::Char*, i : LibC::Char*, ilen : LibC::Int, data : Void*) {
proto = Box(Bytes).unbox(data)
ret = LibSSL.ssl_select_next_proto(o, olen, proto, 2, i, ilen)
if ret != LibSSL::OPENSSL_NPN_NEGOTIATED
LibSSL::SSL_TLSEXT_ERR_NOACK
else
LibSSL::SSL_TLSEXT_ERR_OK
end
}
@alpn_protocol = alpn_protocol = Box.box(protocol)
LibSSL.ssl_ctx_set_alpn_select_cb(@handle, alpn_cb, alpn_protocol)
{% else %}
raise NotImplementedError.new("LibSSL.ssl_ctx_set_alpn_select_cb")
{% end %}
end
end
protected def initialize(method : LibSSL::SSLMethod)
@handle = LibSSL.ssl_ctx_new(method)
raise OpenSSL::Error.new("SSL_CTX_new") if @handle.null?
set_default_verify_paths
add_options(OpenSSL::SSL::Options.flags(
ALL,
NO_SSL_V2,
NO_SSL_V3,
NO_TLS_V1,
NO_TLS_V1_1,
NO_SESSION_RESUMPTION_ON_RENEGOTIATION,
SINGLE_ECDH_USE,
SINGLE_DH_USE
))
{% if compare_versions(LibSSL::OPENSSL_VERSION, "1.1.0") >= 0 %}
add_options(OpenSSL::SSL::Options::NO_RENEGOTIATION)
{% end %}
add_modes(OpenSSL::SSL::Modes.flags(AUTO_RETRY, RELEASE_BUFFERS))
end
# Overriding initialize or new in the child classes as public methods,
# makes it either impossible to access the parent versions or makes the parent
# versions public too. So to provide insecure in the child classes, we need
# a second constructor that we call from there without getting the
# overridden ones of the childs.
protected def _initialize_insecure(method : LibSSL::SSLMethod)
@handle = LibSSL.ssl_ctx_new(method)
raise OpenSSL::Error.new("SSL_CTX_new") if @handle.null?
end
protected def self.insecure(method : LibSSL::SSLMethod)
obj = allocate
obj._initialize_insecure(method)
GC.add_finalizer(obj)
obj
end
def finalize
LibSSL.ssl_ctx_free(@handle)
end
# Sets the default paths for `ca_certificates=` and `ca_certificates_path=`.
def set_default_verify_paths
LibSSL.ssl_ctx_set_default_verify_paths(@handle)
end
# Sets the path to a file containing all CA certificates, in PEM format, used to
# validate the peers certificate.
def ca_certificates=(file_path : String)
ret = LibSSL.ssl_ctx_load_verify_locations(@handle, file_path, nil)
raise OpenSSL::Error.new("SSL_CTX_load_verify_locations") unless ret == 1
end
# Sets the path to a directory containing all CA certificates used to
# validate the peers certificate. The certificates should be in PEM format
# and the `c_rehash(1)` utility must have been run in the directory.
def ca_certificates_path=(dir_path : String)
ret = LibSSL.ssl_ctx_load_verify_locations(@handle, nil, dir_path)
raise OpenSSL::Error.new("SSL_CTX_load_verify_locations") unless ret == 1
end
# Specify the path to the certificate chain file to use. In server mode this
# is presented to the client, in client mode this used as client certificate.
def certificate_chain=(file_path : String)
ret = LibSSL.ssl_ctx_use_certificate_chain_file(@handle, file_path)
raise OpenSSL::Error.new("SSL_CTX_use_certificate_chain_file") unless ret == 1
end
# Specify the path to the private key to use. The key must in PEM format.
# The key must correspond to the entity certificate set by `certificate_chain=`.
def private_key=(file_path : String)
ret = LibSSL.ssl_ctx_use_privatekey_file(@handle, file_path, LibSSL::SSLFileType::PEM)
raise OpenSSL::Error.new("SSL_CTX_use_PrivateKey_file") unless ret == 1
end
# Specify a list of TLS ciphers to use or discard.
#
# This affects only TLSv1.2 and below. See `#security_level=` for some
# sensible system configuration.
def ciphers=(ciphers : String)
ret = LibSSL.ssl_ctx_set_cipher_list(@handle, ciphers)
raise OpenSSL::Error.new("SSL_CTX_set_cipher_list") if ret == 0
ciphers
end
# Specify a list of TLS cipher suites to use or discard.
#
# See `#security_level=` for some sensible system configuration.
def cipher_suites=(cipher_suites : String)
{% if LibSSL.has_method?(:ssl_ctx_set_ciphersuites) %}
ret = LibSSL.ssl_ctx_set_ciphersuites(@handle, cipher_suites)
raise OpenSSL::Error.new("SSL_CTX_set_ciphersuites") if ret == 0
{% else %}
Log.warn { "SSL_CTX_set_ciphersuites not supported" }
{% end %}
cipher_suites
end
# Sets the current ciphers and ciphers suites to **modern** compatibility level as per Mozilla
# recommendations. See `CIPHERS_MODERN` and `CIPHER_SUITES_MODERN`. See `#security_level=` for some
# sensible system configuration.
def set_modern_ciphers
{% if LibSSL.has_method?(:ssl_ctx_set_ciphersuites) %}
self.cipher_suites = CIPHER_SUITES_MODERN
{% else %}
self.ciphers = CIPHERS_MODERN
{% end %}
end
# Sets the current ciphers and ciphers suites to **intermediate** compatibility level as per Mozilla
# recommendations. See `CIPHERS_INTERMEDIATE` and `CIPHER_SUITES_INTERMEDIATE`. See `#security_level=` for some
# sensible system configuration.
def set_intermediate_ciphers
{% if LibSSL.has_method?(:ssl_ctx_set_ciphersuites) %}
self.cipher_suites = CIPHER_SUITES_INTERMEDIATE
{% else %}
self.ciphers = CIPHERS_INTERMEDIATE
{% end %}
end
# Sets the current ciphers and ciphers suites to **old** compatibility level as per Mozilla
# recommendations. See `CIPHERS_OLD` and `CIPHER_SUITES_OLD`. See `#security_level=` for some
# sensible system configuration.
def set_old_ciphers
{% if LibSSL.has_method?(:ssl_ctx_set_ciphersuites) %}
self.cipher_suites = CIPHER_SUITES_OLD
{% else %}
self.ciphers = CIPHERS_OLD
{% end %}
end
# Returns the security level used by this TLS context.
def security_level : Int32
{% if LibSSL.has_method?(:ssl_ctx_get_security_level) %}
LibSSL.ssl_ctx_get_security_level(@handle)
{% else %}
Log.warn { "SSL_CTX_get_security_level not supported" }
0
{% end %}
end
# Sets the security level used by this TLS context. The default system
# security level might disable some ciphers.
#
# * https://www.openssl.org/docs/man1.1.1/man3/SSL_CTX_set_security_level.html
# * https://wiki.debian.org/ContinuousIntegration/TriagingTips/openssl-1.1.1
def security_level=(value : Int32)
{% if LibSSL.has_method?(:ssl_ctx_set_security_level) %}
LibSSL.ssl_ctx_set_security_level(@handle, value)
{% else %}
Log.warn { "SSL_CTX_set_security_level not supported" }
{% end %}
value
end
# Adds a temporary ECDH key curve to the TLS context. This is required to
# enable the EECDH cipher suites. By default the prime256 curve will be used.
def set_tmp_ecdh_key(curve = LibCrypto::NID_X9_62_prime256v1) : Nil
key = LibCrypto.ec_key_new_by_curve_name(curve)
raise OpenSSL::Error.new("ec_key_new_by_curve_name") if key.null?
LibSSL.ssl_ctx_ctrl(@handle, LibSSL::SSL_CTRL_SET_TMP_ECDH, 0, key)
LibCrypto.ec_key_free(key)
end
# Returns the current modes set on the TLS context.
def modes : LibSSL::Modes
OpenSSL::SSL::Modes.new LibSSL.ssl_ctx_ctrl(@handle, LibSSL::SSL_CTRL_MODE, 0, nil)
end
# Adds modes to the TLS context.
def add_modes(mode : OpenSSL::SSL::Modes)
OpenSSL::SSL::Modes.new LibSSL.ssl_ctx_ctrl(@handle, LibSSL::SSL_CTRL_MODE, mode, nil)
end
# Removes modes from the TLS context.
def remove_modes(mode : OpenSSL::SSL::Modes)
OpenSSL::SSL::Modes.new LibSSL.ssl_ctx_ctrl(@handle, LibSSL::SSL_CTRL_CLEAR_MODE, mode, nil)
end
# Returns the current options set on the TLS context.
def options : LibSSL::Options
opts = {% if LibSSL.has_method?(:ssl_ctx_get_options) %}
LibSSL.ssl_ctx_get_options(@handle)
{% else %}
LibSSL.ssl_ctx_ctrl(@handle, LibSSL::SSL_CTRL_OPTIONS, 0, nil)
{% end %}
OpenSSL::SSL::Options.new(opts)
end
# Adds options to the TLS context.
#
# Example:
# ```
# context.add_options(
# OpenSSL::SSL::Options::ALL | # various workarounds
# OpenSSL::SSL::Options::NO_SSL_V2 | # disable overly deprecated SSLv2
# OpenSSL::SSL::Options::NO_SSL_V3 # disable deprecated SSLv3
# )
# ```
def add_options(options : OpenSSL::SSL::Options)
opts = {% if LibSSL.has_method?(:ssl_ctx_set_options) %}
LibSSL.ssl_ctx_set_options(@handle, options)
{% else %}
LibSSL.ssl_ctx_ctrl(@handle, LibSSL::SSL_CTRL_OPTIONS, options, nil)
{% end %}
OpenSSL::SSL::Options.new(opts)
end
# Removes options from the TLS context.
#
# Example:
# ```
# context.remove_options(OpenSSL::SSL::Options::NO_SSL_V3)
# ```
def remove_options(options : OpenSSL::SSL::Options)
opts = {% if LibSSL.has_method?(:ssl_ctx_clear_options) %}
LibSSL.ssl_ctx_clear_options(@handle, options)
{% else %}
LibSSL.ssl_ctx_ctrl(@handle, LibSSL::SSL_CTRL_CLEAR_OPTIONS, options, nil)
{% end %}
OpenSSL::SSL::Options.new(opts)
end
# Returns the current verify mode. See the `SSL_CTX_set_verify(3)` manpage for more details.
def verify_mode : LibSSL::VerifyMode
LibSSL.ssl_ctx_get_verify_mode(@handle)
end
# Sets the verify mode. See the `SSL_CTX_set_verify(3)` manpage for more details.
def verify_mode=(mode : OpenSSL::SSL::VerifyMode)
LibSSL.ssl_ctx_set_verify(@handle, mode, nil)
end
@alpn_protocol : Pointer(Void)?
# Specifies an ALPN protocol to negotiate with the remote endpoint. This is
# required to negotiate HTTP/2 with browsers, since browser vendors decided
# not to implement HTTP/2 over insecure connections.
#
# Example:
# ```
# context.alpn_protocol = "h2"
# ```
def alpn_protocol=(protocol : String)
proto = Bytes.new(protocol.bytesize + 1)
proto[0] = protocol.bytesize.to_u8
protocol.to_slice.copy_to(proto.to_unsafe + 1, protocol.bytesize)
self.alpn_protocol = proto
end
# Sets this context verify param to the default one of the given name.
#
# Depending on the OpenSSL version, the available defaults are
# `default`, `pkcs7`, `smime_sign`, `ssl_client` and `ssl_server`.
def default_verify_param=(name : String)
{% if LibSSL.has_method?(:x509_verify_param_lookup) %}
param = LibCrypto.x509_verify_param_lookup(name)
raise ArgumentError.new("#{name} is an unsupported default verify param") unless param
ret = LibSSL.ssl_ctx_set1_param(@handle, param)
raise OpenSSL::Error.new("SSL_CTX_set1_param") unless ret == 1
{% else %}
raise NotImplementedError.new("LibSSL.x509_verify_param_lookup")
{% end %}
end
# Sets the given `OpenSSL::SSL::X509VerifyFlags` in this context, additionally to
# the already set ones.
def add_x509_verify_flags(flags : OpenSSL::SSL::X509VerifyFlags)
{% if LibSSL.has_method?(:x509_verify_param_set_flags) %}
param = LibSSL.ssl_ctx_get0_param(@handle)
ret = LibCrypto.x509_verify_param_set_flags(param, flags)
raise OpenSSL::Error.new("X509_VERIFY_PARAM_set_flags)") unless ret == 1
{% else %}
raise NotImplementedError.new("LibSSL.x509_verify_param_set_flags")
{% end %}
end
def to_unsafe
@handle
end
private def self.from_hash(params)
context = new
if key = params["key"]?
context.private_key = key
else
raise ArgumentError.new("Invalid SSL context: missing private key ('key=')")
end
if cert = params["cert"]?
context.certificate_chain = cert
else
raise ArgumentError.new("Invalid SSL context: missing certificate ('cert=')")
end
case verify_mode = params["verify_mode"]?
when "peer"
context.verify_mode = OpenSSL::SSL::VerifyMode::PEER
when "force-peer"
context.verify_mode = OpenSSL::SSL::VerifyMode::PEER | OpenSSL::SSL::VerifyMode::FAIL_IF_NO_PEER_CERT
when "none"
context.verify_mode = OpenSSL::SSL::VerifyMode::NONE
when nil
# use default
else
raise ArgumentError.new("Invalid SSL context: unknown verify mode #{verify_mode.inspect}")
end
if ca = params["ca"]?
if File.directory?(ca)
context.ca_certificates_path = ca
else
context.ca_certificates = ca
end
elsif context.verify_mode.peer? || context.verify_mode.fail_if_no_peer_cert?
raise ArgumentError.new("Invalid SSL context: missing CA certificate ('ca=')")
end
context
end
end