ruby_easy_rsa 0.10.0.pre.5 → 0.10.0.pre.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 82569f3b7d0745a7856894d4788c3f1f8d57352a1653b31b490e0d0ae8f0b527
-  data.tar.gz: 6ea48e38a2fc6d7547d71a740ab96996149a3e1587be57794a9b67402824ec51
+  metadata.gz: fcb178c3cc51693c50831b26b5a7ead27c2930ff13ed9dd937619d06644e5729
+  data.tar.gz: 2f9834bef0711d28b65067428b0551bec015d4e55ff41950aa7ac52c3715894f
 SHA512:
-  metadata.gz: ee7239a999da93126d2c5d586a29ee8da816920c33c9de9bf7066bc3553d39682ea4613f7e2997f87f329aee02db0d4f66aebb05a9a8ae4ee29377b1dc011058
-  data.tar.gz: 48d2d078c25df81ec5d01018e67c056c7ea4925a165055b58d8b2baf13905df6eaf7bd372b8ff38f7b3e65b0ddae9c86808f3603d4f05fd51e79e1ee0143c922
+  metadata.gz: eac992afcb2beba9a54714d7f38d2fd7eedc20136e61f5e0f66c3199bd5a89c916a9f0e4fc672b4e4cdb480657d8c18852553708ec84bd75f4fc0c227a0299bd
+  data.tar.gz: 9daa2b0ddfacadf12c675e80ca0adcb8abf656844e715868a3d8d82e57bc17ec33179d559d63ad0ba34c87e512f3186a3defd47eb5661f5d8089341b3536402f

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in ruby_fly.gemspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ruby_easy_rsa (0.10.0.pre.5)
+    ruby_easy_rsa (0.10.0.pre.8)
       lino (~> 3.0)
 
 GEM
@@ -14,9 +14,11 @@ GEM
       tzinfo (~> 2.0)
     addressable (2.8.0)
       public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.2)
     colored2 (3.1.2)
     concurrent-ruby (1.1.9)
     diff-lcs (1.5.0)
+    docile (1.4.0)
     excon (0.92.0)
     faraday (1.10.0)
       faraday-em_http (~> 1.0)
@@ -55,7 +57,11 @@ GEM
       faraday (>= 0.9)
       sawyer (~> 0.8.0, >= 0.5.3)
     open4 (1.3.4)
+    parallel (1.22.1)
+    parser (3.1.1.0)
+      ast (~> 2.4.1)
     public_suffix (4.0.6)
+    rainbow (3.1.1)
     rake (13.0.6)
     rake_circle_ci (0.9.0)
       colored2 (~> 3.1)
@@ -77,6 +83,8 @@ GEM
       colored2 (~> 3.1)
       rake_factory (~> 0.23)
       sshkey (~> 2.0)
+    regexp_parser (2.2.1)
+    rexml (3.2.5)
     rspec (3.11.0)
       rspec-core (~> 3.11.0)
       rspec-expectations (~> 3.11.0)
@@ -90,15 +98,38 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.11.0)
     rspec-support (3.11.0)
+    rubocop (1.27.0)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.16.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.16.0)
+      parser (>= 3.1.1.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.9.0)
+      rubocop (~> 1.19)
+    ruby-progressbar (1.11.0)
     ruby2_keywords (0.0.5)
     ruby_gpg2 (0.8.0)
       lino (>= 1.5)
     sawyer (0.8.2)
       addressable (>= 2.3.5)
       faraday (> 0.8, < 2.0)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
     sshkey (2.0.0)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
+    unicode-display_width (2.1.0)
 
 PLATFORMS
   arm64-darwin-21
@@ -113,7 +144,11 @@ DEPENDENCIES
   rake_gpg
   rake_ssh
   rspec
+  rubocop
+  rubocop-rake
+  rubocop-rspec
   ruby_easy_rsa!
+  simplecov
 
 BUNDLED WITH
-   2.3.9
+   2.3.11

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2020 InfraBlocks
+Copyright (c) 2022 InfraBlocks Maintainers
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'yaml'
 require 'rake_circle_ci'
 require 'rake_github'
@@ -5,17 +7,26 @@ require 'rake_ssh'
 require 'rake_gpg'
 require 'securerandom'
 require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
 
-task :default => :spec
-
-RSpec::Core::RakeTask.new(:spec)
+task default: %i[
+  library:fix
+  test:unit
+]
 
 namespace :encryption do
+  namespace :directory do
+    desc 'Ensure CI secrets directory exists.'
+    task :ensure do
+      FileUtils.mkdir_p('config/secrets/ci')
+    end
+  end
+
   namespace :passphrase do
-    task :generate do
-      File.open('config/secrets/ci/encryption.passphrase', 'w') do |f|
-        f.write(SecureRandom.base64(36))
-      end
+    desc 'Generate encryption passphrase used by CI.'
+    task generate: ['directory:ensure'] do
+      File.write('config/secrets/ci/encryption.passphrase',
+                 SecureRandom.base64(36))
     end
   end
 end
@@ -23,85 +34,111 @@ end
 namespace :keys do
   namespace :deploy do
     RakeSSH.define_key_tasks(
-        path: 'config/secrets/ci/',
-        comment: 'maintainers@infrablocks.io')
+      path: 'config/secrets/ci/',
+      comment: 'maintainers@infrablocks.io'
+    )
   end
 
   namespace :gpg do
     RakeGPG.define_generate_key_task(
-        output_directory: 'config/secrets/ci',
-        name_prefix: 'gpg',
-        owner_name: 'InfraBlocks Maintainers',
-        owner_email: 'maintainers@infrablocks.io',
-        owner_comment: 'ruby_easy_rsa CI Key')
+      output_directory: 'config/secrets/ci',
+      name_prefix: 'gpg',
+      owner_name: 'InfraBlocks Maintainers',
+      owner_email: 'maintainers@infrablocks.io',
+      owner_comment: 'ruby_easy_rsa CI Key'
+    )
   end
 end
 
+namespace :secrets do
+  desc 'Regenerate all generatable secrets.'
+  task regenerate: %w[
+    encryption:passphrase:generate
+    keys:deploy:generate
+    keys:gpg:generate
+  ]
+end
+
+RuboCop::RakeTask.new
+
+namespace :library do
+  desc 'Run all checks of the library'
+  task check: [:rubocop]
+
+  desc 'Attempt to automatically fix issues with the library'
+  task fix: [:'rubocop:auto_correct']
+end
+
+namespace :test do
+  RSpec::Core::RakeTask.new(:unit)
+end
+
 RakeCircleCI.define_project_tasks(
-    namespace: :circle_ci,
-    project_slug: 'github/infrablocks/ruby_easy_rsa'
+  namespace: :circle_ci,
+  project_slug: 'github/infrablocks/ruby_easy_rsa'
 ) do |t|
   circle_ci_config =
-      YAML.load_file('config/secrets/circle_ci/config.yaml')
+    YAML.load_file('config/secrets/circle_ci/config.yaml')
 
-  t.api_token = circle_ci_config["circle_ci_api_token"]
+  t.api_token = circle_ci_config['circle_ci_api_token']
   t.environment_variables = {
-      ENCRYPTION_PASSPHRASE:
-          File.read('config/secrets/ci/encryption.passphrase')
-              .chomp
+    ENCRYPTION_PASSPHRASE:
+        File.read('config/secrets/ci/encryption.passphrase')
+            .chomp
   }
   t.checkout_keys = []
   t.ssh_keys = [
-      {
-          hostname: "github.com",
-          private_key: File.read('config/secrets/ci/ssh.private')
-      }
+    {
+      hostname: 'github.com',
+      private_key: File.read('config/secrets/ci/ssh.private')
+    }
   ]
 end
 
 RakeGithub.define_repository_tasks(
-    namespace: :github,
-    repository: 'infrablocks/ruby_easy_rsa',
+  namespace: :github,
+  repository: 'infrablocks/ruby_easy_rsa'
 ) do |t, args|
   github_config =
-      YAML.load_file('config/secrets/github/config.yaml')
+    YAML.load_file('config/secrets/github/config.yaml')
 
-  t.access_token = github_config["github_personal_access_token"]
+  t.access_token = github_config['github_personal_access_token']
   t.deploy_keys = [
-      {
-          title: 'CircleCI',
-          public_key: File.read('config/secrets/ci/ssh.public')
-      }
+    {
+      title: 'CircleCI',
+      public_key: File.read('config/secrets/ci/ssh.public')
+    }
   ]
   t.branch_name = args.branch_name
   t.commit_message = args.commit_message
 end
 
 namespace :pipeline do
-  task :prepare => [
-      :'circle_ci:project:follow',
-      :'circle_ci:env_vars:ensure',
-      :'circle_ci:checkout_keys:ensure',
-      :'circle_ci:ssh_keys:ensure',
-      :'github:deploy_keys:ensure'
+  desc 'Prepare CircleCI Pipeline'
+  task prepare: %i[
+    circle_ci:project:follow
+    circle_ci:env_vars:ensure
+    circle_ci:checkout_keys:ensure
+    circle_ci:ssh_keys:ensure
+    github:deploy_keys:ensure
   ]
 end
 
 namespace :version do
-  desc "Bump version for specified type (pre, major, minor, patch)"
+  desc 'Bump version for specified type (pre, major, minor, patch)'
   task :bump, [:type] do |_, args|
     bump_version_for(args.type)
   end
 end
 
-desc "Release gem"
+desc 'Release gem'
 task :release do
-  sh "gem release --tag --push"
+  sh 'gem release --tag --push'
 end
 
 def bump_version_for(version_type)
-  sh "gem bump --version #{version_type} " +
-      "&& bundle install " +
-      "&& export LAST_MESSAGE=\"$(git log -1 --pretty=%B)\" " +
-      "&& git commit -a --amend -m \"${LAST_MESSAGE} [ci skip]\""
+  sh "gem bump --version #{version_type} " \
+     '&& bundle install ' \
+     '&& export LAST_MESSAGE="$(git log -1 --pretty=%B)" ' \
+     '&& git commit -a --amend -m "${LAST_MESSAGE} [ci skip]"'
 end

data/lib/ruby_easy_rsa/commands/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'lino'
 
 module RubyEasyRSA
@@ -14,42 +16,38 @@ module RubyEasyRSA
       end
 
       def stdout
-        STDOUT
+        $stdout
       end
 
       def stderr
-        STDERR
+        $stderr
       end
 
       def execute(opts = {})
-        builder = instantiate_builder
-
         do_before(opts)
-        builder = configure_command(builder, opts)
-        builder
-            .build
-            .execute(
-                stdin: stdin,
-                stdout: stdout,
-                stderr: stderr)
+        configure_command(instantiate_builder, opts)
+          .build
+          .execute(
+            stdin: stdin,
+            stdout: stdout,
+            stderr: stderr
+          )
         do_after(opts)
       end
 
       def instantiate_builder
         Lino::CommandLineBuilder
-            .for_command(binary)
-            .with_option_separator('=')
+          .for_command(binary)
+          .with_option_separator('=')
       end
 
-      def do_before(opts)
-      end
+      def do_before(_); end
 
-      def configure_command(builder, opts)
+      def configure_command(builder, _opts)
         builder
       end
 
-      def do_after(opts)
-      end
+      def do_after(_); end
     end
   end
 end

data/lib/ruby_easy_rsa/commands/build_ca.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'lino'
 
 require_relative 'base'
@@ -19,8 +21,7 @@ module RubyEasyRSA
 
         builder = builder.with_subcommand('build-ca')
         builder = builder.with_argument('subca') if sub_ca
-        builder = super(builder, opts)
-        builder
+        super(builder, opts)
       end
     end
   end

data/lib/ruby_easy_rsa/commands/build_client_full.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'lino'
 
 require_relative 'base'
@@ -29,8 +31,7 @@ module RubyEasyRSA
 
         builder = builder.with_subcommand('build-client-full')
         builder = builder.with_argument(filename_base)
-        builder = super(builder, opts)
-        builder
+        super(builder, opts)
       end
     end
   end

data/lib/ruby_easy_rsa/commands/build_client_server_full.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'lino'
 
 require_relative 'base'
@@ -29,8 +31,7 @@ module RubyEasyRSA
 
         builder = builder.with_subcommand('build-clientServer-full')
         builder = builder.with_argument(filename_base)
-        builder = super(builder, opts)
-        builder
+        super(builder, opts)
       end
     end
   end

data/lib/ruby_easy_rsa/commands/build_server_full.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'lino'
 
 require_relative 'base'
@@ -29,8 +31,7 @@ module RubyEasyRSA
 
         builder = builder.with_subcommand('build-server-full')
         builder = builder.with_argument(filename_base)
-        builder = super(builder, opts)
-        builder
+        super(builder, opts)
       end
     end
   end

data/lib/ruby_easy_rsa/commands/export_p12.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'lino'
 
 require_relative 'base'

data/lib/ruby_easy_rsa/commands/export_p7.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'lino'
 
 require_relative 'base'

data/lib/ruby_easy_rsa/commands/gen_crl.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'lino'
 
 require_relative 'base'
@@ -12,8 +14,7 @@ module RubyEasyRSA
 
       def configure_command(builder, opts)
         builder = builder.with_subcommand('gen-crl')
-        builder = super(builder, opts)
-        builder
+        super(builder, opts)
       end
     end
   end

data/lib/ruby_easy_rsa/commands/gen_dh.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'lino'
 
 require_relative 'base'
@@ -12,8 +14,7 @@ module RubyEasyRSA
 
       def configure_command(builder, opts)
         builder = super(builder, opts)
-        builder = builder.with_subcommand('gen-dh')
-        builder
+        builder.with_subcommand('gen-dh')
       end
     end
   end

data/lib/ruby_easy_rsa/commands/gen_req.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'lino'
 
 require_relative 'base'
@@ -21,8 +23,7 @@ module RubyEasyRSA
 
         builder = builder.with_subcommand('gen-req')
         builder = builder.with_argument(filename_base)
-        builder = super(builder, opts)
-        builder
+        super(builder, opts)
       end
     end
   end

data/lib/ruby_easy_rsa/commands/import_req.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'lino'
 
 require_relative 'base'
@@ -17,8 +19,7 @@ module RubyEasyRSA
         builder = super(builder, opts)
         builder = builder.with_subcommand('import-req')
         builder = builder.with_argument(request_file)
-        builder = builder.with_argument(filename_base)
-        builder
+        builder.with_argument(filename_base)
       end
     end
   end

data/lib/ruby_easy_rsa/commands/init_pki.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'lino'
 
 require_relative 'base'

data/lib/ruby_easy_rsa/commands/mixins/algorithm_config.rb

@@ -1,19 +1,40 @@
+# frozen_string_literal: true
+
 module RubyEasyRSA
   module Commands
     module Mixins
       module AlgorithmConfig
+        # rubocop:disable Style/RedundantAssignment
         def configure_command(builder, opts)
-          algorithm = opts[:algorithm]
-          curve = opts[:curve]
-          ec_directory = opts[:ec_directory]
-
           builder = super(builder, opts)
-          builder = builder.with_environment_variable(
-              'EASYRSA_EC_DIR', ec_directory) if ec_directory
-          builder = builder.with_option('--use-algo', algorithm) if algorithm
-          builder = builder.with_option('--curve', curve) if curve
+          builder = with_ec_directory(builder, opts[:ec_directory])
+          builder = with_algorithm(builder, opts[:algorithm])
+          builder = with_curve(builder, opts[:curve])
           builder
         end
+        # rubocop:enable Style/RedundantAssignment
+
+        private
+
+        def with_ec_directory(builder, ec_directory)
+          return builder unless ec_directory
+
+          builder.with_environment_variable(
+            'EASYRSA_EC_DIR', ec_directory
+          )
+        end
+
+        def with_algorithm(builder, algorithm)
+          return builder unless algorithm
+
+          builder.with_option('--use-algo', algorithm)
+        end
+
+        def with_curve(builder, curve)
+          return builder unless curve
+
+          builder.with_option('--curve', curve)
+        end
       end
     end
   end

data/lib/ruby_easy_rsa/commands/mixins/copy_extensions_config.rb

@@ -1,14 +1,24 @@
+# frozen_string_literal: true
+
 module RubyEasyRSA
   module Commands
     module Mixins
       module CopyExtensionsConfig
+        # rubocop:disable Style/RedundantAssignment
         def configure_command(builder, opts)
-          copy_extensions = opts[:copy_extensions]
-
           builder = super(builder, opts)
-          builder = builder.with_flag('--copy-ext') if copy_extensions
+          builder = with_copy_extensions(builder, opts[:copy_extensions])
           builder
         end
+        # rubocop:enable Style/RedundantAssignment
+
+        private
+
+        def with_copy_extensions(builder, copy_extensions)
+          return builder unless copy_extensions
+
+          builder.with_flag('--copy-ext')
+        end
       end
     end
   end

data/lib/ruby_easy_rsa/commands/mixins/encrypt_key_config.rb

@@ -1,14 +1,28 @@
+# frozen_string_literal: true
+
 module RubyEasyRSA
   module Commands
     module Mixins
       module EncryptKeyConfig
+        # rubocop:disable Style/RedundantAssignment
         def configure_command(builder, opts)
-          encrypt_key = opts[:encrypt_key].nil? ? true : opts[:encrypt_key]
-
           builder = super(builder, opts)
-          builder = builder.with_argument('nopass') unless encrypt_key
+          builder = with_encrypt_key(builder, encrypt_key(opts))
           builder
         end
+        # rubocop:enable Style/RedundantAssignment
+
+        private
+
+        def encrypt_key(opts)
+          opts[:encrypt_key].nil? ? true : opts[:encrypt_key]
+        end
+
+        def with_encrypt_key(builder, encrypt_key)
+          return builder if encrypt_key
+
+          builder.with_argument('nopass')
+        end
       end
     end
   end