Class: RuboCop::Cop::Lint::DeprecatedOpenSSLConstant

Inherits:
Base
  • Object
show all
Extended by:
AutoCorrector
Includes:
RangeHelp
Defined in:
lib/rubocop/cop/lint/deprecated_open_ssl_constant.rb

Overview

Algorithmic constants for `OpenSSL::Cipher` and `OpenSSL::Digest` deprecated since OpenSSL version 2.2.0. Prefer passing a string instead.

Examples:


# Example for OpenSSL::Cipher instantiation.

# bad
OpenSSL::Cipher::AES.new(128, :GCM)

# good
OpenSSL::Cipher.new('aes-128-gcm')

# Example for OpenSSL::Digest instantiation.

# bad
OpenSSL::Digest::SHA256.new

# good
OpenSSL::Digest.new('SHA256')

# Example for ::Digest inherited class methods.

# bad
OpenSSL::Digest::SHA256.digest('foo')

# good
OpenSSL::Digest.digest('SHA256', 'foo')

Constant Summary collapse

MSG =
'Use `%<constant>s.%<method>s(%<replacement_args>s)` instead of `%<original>s`.'
NO_ARG_ALGORITHM =
%w[BF DES IDEA RC4].freeze

Constants inherited from Base

Base::RESTRICT_ON_SEND

Instance Attribute Summary

Attributes inherited from Base

#config, #processed_source

Instance Method Summary collapse

Methods included from AutoCorrector

support_autocorrect?

Methods inherited from Base

#add_global_offense, #add_offense, autocorrect_incompatible_with, badge, #callbacks_needed, callbacks_needed, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, #cop_name, cop_name, department, documentation_url, exclude_from_registry, #excluded_file?, #external_dependency_checksum, inherited, #initialize, joining_forces, lint?, match?, #offenses, #on_investigation_end, #on_new_investigation, #on_other_file, #parse, #ready, #relevant_file?, support_autocorrect?, support_multiple_source?, #target_rails_version, #target_ruby_version

Methods included from ExcludeLimit

#exclude_limit

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #correctable?, #disable_uncorrectable?, #safe_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

silence_warnings

Constructor Details

This class inherits a constructor from RuboCop::Cop::Base

Instance Method Details

#algorithm_const(node) ⇒ Object


49
50
51
52
53
54
55
56
# File 'lib/rubocop/cop/lint/deprecated_open_ssl_constant.rb', line 49

def_node_matcher :algorithm_const, <<~PATTERN
  (send
    $(const
      (const
        (const {nil? cbase} :OpenSSL) {:Cipher :Digest})
      _)
    ...)
PATTERN

#on_send(node) ⇒ Object


58
59
60
61
62
63
64
65
# File 'lib/rubocop/cop/lint/deprecated_open_ssl_constant.rb', line 58

def on_send(node)
  return if node.arguments.any? { |arg| arg.variable? || arg.send_type? || arg.const_type? }
  return unless algorithm_const(node)

  message = message(node)

  add_offense(node, message: message) { |corrector| autocorrect(corrector, node) }
end