Class: RuboCop::Cop::Gemspec::RequireMFA

Inherits:
Base
  • Object
show all
Extended by:
AutoCorrector
Includes:
RuboCop::Cop::GemspecHelp
Defined in:
lib/rubocop/cop/gemspec/require_mfa.rb

Overview

Requires a gemspec to have ‘rubygems_mfa_required` metadata set.

This setting tells RubyGems that MFA (Multi-Factor Authentication) is required for accounts to be able perform privileged operations, such as (see RubyGems’ documentation for the full list of privileged operations):

  • ‘gem push`

  • ‘gem yank`

  • ‘gem owner –add/remove`

  • adding or removing owners using gem ownership page

This helps make your gem more secure, as users can be more confident that gem updates were pushed by maintainers.

Examples:

# bad
Gem::Specification.new do |spec|
  # no `rubygems_mfa_required` metadata specified
end

# good
Gem::Specification.new do |spec|
  spec.metadata = {
    'rubygems_mfa_required' => 'true'
  }
end

# good
Gem::Specification.new do |spec|
  spec.metadata['rubygems_mfa_required'] = 'true'
end

# bad
Gem::Specification.new do |spec|
  spec.metadata = {
    'rubygems_mfa_required' => 'false'
  }
end

# good
Gem::Specification.new do |spec|
  spec.metadata = {
    'rubygems_mfa_required' => 'true'
  }
end

# bad
Gem::Specification.new do |spec|
  spec.metadata['rubygems_mfa_required'] = 'false'
end

# good
Gem::Specification.new do |spec|
  spec.metadata['rubygems_mfa_required'] = 'true'
end

Constant Summary collapse

MSG = 
"`metadata['rubygems_mfa_required']` must be set to `'true'`."

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 included from RuboCop::Cop::GemspecHelp

#assignment_method_declarations, #gem_specification, #gem_specification?, #indexed_assignment_method_declarations, #match_block_variable_name?

Methods inherited from Base

#active_support_extensions_enabled?, #add_global_offense, #add_offense, #always_autocorrect?, autocorrect_incompatible_with, badge, #begin_investigation, #callbacks_needed, callbacks_needed, #config_to_allow_offenses, #config_to_allow_offenses=, #contextual_autocorrect?, #cop_config, #cop_name, cop_name, department, documentation_url, exclude_from_registry, #excluded_file?, #external_dependency_checksum, inherited, #initialize, #inspect, joining_forces, lint?, match?, #message, #offenses, #on_investigation_end, #on_new_investigation, #on_other_file, #parse, #parser_engine, #ready, #relevant_file?, requires_gem, #string_literals_frozen_by_default?, support_autocorrect?, support_multiple_source?, #target_gem_version, #target_rails_version, #target_ruby_version

Methods included from ExcludeLimit

#exclude_limit

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #autocorrect_with_disable_uncorrectable?, #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

#metadata(node) ⇒ Object 



70
71
72
73
74
75
 
# File 'lib/rubocop/cop/gemspec/require_mfa.rb', line 70

def_node_matcher :metadata, <<~PATTERN
  `{
    (send _ :metadata= $_)
    (send (send _ :metadata) :[]= (str "rubygems_mfa_required") $_)
  }
PATTERN

#metadata_assignment(node) ⇒ Object 



78
79
80
81
82
83
 
# File 'lib/rubocop/cop/gemspec/require_mfa.rb', line 78

def_node_search :metadata_assignment, <<~PATTERN
  `{
    (send _ :metadata= _)
    (send (send _ :metadata) :[]= (str _) _)
  }
PATTERN

#on_block(node) ⇒ Object

rubocop:disable Metrics/MethodLength, InternalAffairs/NumblockHandler



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/rubocop/cop/gemspec/require_mfa.rb', line 95

def on_block(node) # rubocop:disable Metrics/MethodLength, InternalAffairs/NumblockHandler
  gem_specification(node) do |block_var|
    metadata_value = metadata(node)
    mfa_value = mfa_value(metadata_value)

    if mfa_value
      unless true_string?(mfa_value)
        add_offense(mfa_value) do |corrector|
          change_value(corrector, mfa_value)
        end
      end
    else
      add_offense(node) do |corrector|
        autocorrect(corrector, node, block_var, metadata_value)
      end
    end
  end
end

#rubygems_mfa_required(node) ⇒ Object 



86
87
88
 
# File 'lib/rubocop/cop/gemspec/require_mfa.rb', line 86

def_node_search :rubygems_mfa_required, <<~PATTERN
  (pair (str "rubygems_mfa_required") $_)
PATTERN

#true_string?(node) ⇒ Object 



91
92
93
 
# File 'lib/rubocop/cop/gemspec/require_mfa.rb', line 91

def_node_matcher :true_string?, <<~PATTERN
  (str "true")
PATTERN