secupdater 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5bc574d1914c88ba5bb0c0624e0be6be31af1797d27beafa08edd8ea558cf7e4
+  data.tar.gz: 19900eeb514d8dbd6572a8d7f80ee678a7564361302e253f99d219f5603ffc2b
+SHA512:
+  metadata.gz: b156d7d68800aee0a99556b14ecfd8932aedb4e62b8afc4d6c40f49473a3907d809e4c7100ed565b07e825e30ffabb840c960862cd6b71dbb239326aa95a7788
+  data.tar.gz: 21c55f8f8f74c4e8589529bcf93a70832e1b4ec09e456b494c44ec66a8a7e002359c3a8a9fcc310d3c0669e568f166db6b969d2eec0ef83d83562a176b64caad

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.tool-versions

@@ -0,0 +1 @@
+ruby 4.0.6

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2026-10-20
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 Ben Anderson
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,39 @@
+# Secupdater
+
+TODO: Delete this and the text below, and describe your gem
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/secupdater`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/secupdater.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/bin/secupdater

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/secupdater'
+
+Secupdater::CLI.run

data/lib/secupdater/cli.rb

@@ -0,0 +1,44 @@
+require "dry/cli"
+
+module Secupdater
+  module CLI
+    def self.run
+      Dry::CLI.new(Commands).call
+    end
+    
+    module Commands
+      extend Dry::CLI::Registry
+
+      class Run < Dry::CLI::Command
+        option :ecosystem, values: ["rubygems"], required: true, desc: "Ecosystem to run checks for"
+
+        option :verbose, type: :boolean, default: false
+        option :debug, type: :boolean, default: false
+
+        argument :advisories, required: true, desc: "Advisory file generated from (for example) bundle audit --output json"
+
+        def call(ecosystem:, advisories:, verbose:, debug:)
+          log_level = if debug then :debug elsif verbose then :info else :warn end
+          results = Runner.new(ecosystem: ecosystem, log_level: log_level, publisher: publisher).call(advisories)
+
+          exit(1) if results.value?(:failed)
+        rescue Secupdater::Error => e
+          err.puts e.message
+          exit(1)
+        end
+
+        private
+
+        def publisher
+          return unless ENV["SECUPDATER_GITLAB_TOKEN"]
+
+          Publisher::Gitlab.new(ENV["SECUPDATER_GITLAB_TOKEN"], ENV.fetch("CI_PROJECT_ID"), ENV.fetch("CI_DEFAULT_BRANCH"))
+        rescue KeyError => e
+          raise Secupdater::Error, "SECUPDATER_GITLAB_TOKEN is set but #{e.key} isn't"
+        end
+      end
+
+      register "run", Run
+    end
+  end
+end

data/lib/secupdater/ecosystem/rubygems.rb

@@ -0,0 +1,70 @@
+require "open3"
+require "json"
+require "bundler"
+
+module Secupdater
+  class Ecosystem
+    class Rubygems < Secupdater::Ecosystem
+      def self.ecosystem_name = "RubyGems"
+
+      def manifest_paths = ["Gemfile.lock"]
+
+      def snapshot
+        Bundler::LockfileParser.new(Bundler.read_file("Gemfile.lock"))
+          .specs
+          .to_h { [it.name, DependencySpec.new(it.name, it.platform.to_s, it.version)] }
+      end
+
+      def diff_snapshot(a, b)
+        (a.keys | b.keys).filter_map do |gem|
+          next if a[gem] == b[gem]
+
+          spec = a[gem] || b[gem]
+
+          DependencySpecDiff.new(
+            spec,
+            a[gem]&.version,
+            b[gem]&.version,
+          )
+        end
+      end
+
+      def run_update(names, level)
+        output, status = Open3.capture2e("bundle", "update", *Array(names), "--conservative", "--#{level}", "--strict")
+
+        unless status.success?
+          raise Secupdater::UpdateCommandFailed.new(
+            "bundle update command returned #{status.exitstatus}",
+            status.exitstatus,
+            output
+          )
+        end
+      end
+
+      def parse_advisories(io)
+        raw_report = JSON.parse(io.read)
+
+        raw_report["results"].filter_map do |result|
+          next unless result["type"] == "unpatched_gem"
+
+          advisory = result["advisory"]
+
+          advisory_id = ["cve", "osvdb", "ghsa"].filter_map do
+            if advisory[it]
+              "#{it}/#{advisory[it]}"
+            end
+          end.join("-")
+          advisory_id = advisory["id"] if advisory_id.empty?
+
+          SecurityAdvisory.new(result["gem"]["name"], advisory_id, advisory["patched_versions"])
+        end
+      end
+
+      def satisfies_requirement?(version, requirement)
+        req = Gem::Requirement.create(requirement.split(/,\s*/))
+        ver = Gem::Version.create(version)
+        req.satisfied_by?(ver)
+      end
+    end
+  end
+end

data/lib/secupdater/ecosystem.rb

@@ -0,0 +1,43 @@
+module Secupdater
+  class Ecosystem
+    def self.ecosystem_name = raise NotImplementedError
+    def ecosystem_name = self.class.ecosystem_name
+
+    def manifest_paths = raise NotImplementedError
+    def run_update(names, level) = raise NotImplementedError
+    def snapshot = raise NotImplementedError
+    def diff_snapshot = raise NotImplementedError
+    def parse_advisories(io) = raise NotImplementedError
+    def satisfies_requirement?(version, requirement) = raise NotImplementedError
+
+    def update_levels = [:patch, :minor, :major]
+
+    def self.resolve(name)
+      klass = self.subclasses.detect { it.ecosystem_name.downcase == name.downcase }
+      raise Secupdater::Error, "Unknown ecosystem: #{name}" unless klass
+      klass.new
+    end
+
+    def try_update(names, level:)
+      before = read_manifests
+      run_update(names, level)
+      after = read_manifests
+
+      manifest_paths.filter_map do |path|
+        next if before[path] == after[path]
+
+        type = if before[path].nil? then "create" elsif after[path].nil? then "delete" else "update" end
+        FileChange.new(path, type, after[path], before[path])
+      end
+    end
+
+    private
+
+    def read_manifests
+      manifest_paths.to_h { [it, File.exist?(it) ? File.read(it) : nil] }
+    end
+  end
+end
+
+require_relative "ecosystem/rubygems"
+

data/lib/secupdater/publisher/gitlab.rb

@@ -0,0 +1,67 @@
+require "net/http"
+require "json"
+
+module Secupdater
+  class Publisher
+    class Gitlab < Secupdater::Publisher
+      attr_reader :access_token, :project_id, :target_branch
+
+      def initialize(access_token, project_id, target_branch)
+        @access_token = access_token
+        @project_id = project_id
+        @target_branch = target_branch
+      end
+
+      def run
+        Net::HTTP.start("gitlab.com", 443, use_ssl: true) do |http|
+          return if merge_request_exists?(http)
+
+          data = {
+            branch: reference,
+            start_branch: target_branch,
+            commit_message: title,
+            actions: changes.map { { action: it.type, file_path: it.filename, content: it.content }.compact }
+          }
+
+          request(http, Net::HTTP::Post, "repository/commits", data)
+
+          data = {
+            source_branch: reference,
+            target_branch: target_branch,
+            title: title,
+            description: description,
+            remove_source_branch: true,
+            labels: []
+          }
+
+          request(http, Net::HTTP::Post, "merge_requests", data)
+        end
+      end
+
+      private
+
+      def merge_request_exists?(http)
+        query = URI.encode_www_form(source_branch: reference, state: "opened")
+        res = request(http, Net::HTTP::Get, "merge_requests?#{query}")
+        JSON.parse(res.body).any?
+      end
+
+      def request(http, type, path, data = nil)
+        req = type.new(
+          "/api/v4/projects/#{URI.encode_www_form_component(project_id)}/#{path}",
+          "PRIVATE-TOKEN" => access_token,
+          "Content-Type" => "application/json"
+        )
+        req.body = data.to_json if data
+
+        res = http.request(req)
+
+        unless res.is_a?(Net::HTTPSuccess)
+          raise Secupdater::Error, "GitLab #{req.method} #{req.path} returned #{res.code}: #{res.body}"
+        end
+
+        res
+      end
+    end
+  end
+end

data/lib/secupdater/publisher.rb

@@ -0,0 +1,39 @@
+module Secupdater
+  class Publisher
+    attr_reader :ecosystem, :bump, :advisories, :changes
+
+    def initialize = raise NotImplementedError
+    def run = raise NotImplementedError
+
+    def call(ecosystem, dependency_bump, advisories, changes)
+      @ecosystem = ecosystem
+      @bump = dependency_bump
+      @advisories = advisories
+      @changes = changes
+
+      run
+    end
+
+    def reference = "security/#{bump.dependency.name}-#{bump.to}"
+
+    def title = "Upgrade #{ecosystem.ecosystem_name} dependency #{bump.dependency.name} to version #{bump.to}"
+
+    def description
+      heading = "Upgrade #{ecosystem.ecosystem_name} dependency #{bump.dependency.name} to version #{bump.to} to address the following security advisories:"
+      items = advisories.map { "* #{it.report_id}" }.join("\n")
+      "#{heading}\n\n#{items}\n"
+    end
+    
+    private
+    def pluralize(count, singular, plural = nil)
+      if count == 1
+        "#{count} #{singular}"
+      elsif plural
+        "#{count} #{plural}"
+      else
+        "#{count} #{singular}s"
+      end
+    end
+  end
+
+end

data/lib/secupdater/runner.rb

@@ -0,0 +1,16 @@
+module Secupdater
+  class Runner
+    def initialize(ecosystem:, log_level: :warn, publisher: nil)
+      @ecosystem = Secupdater::Ecosystem.resolve(ecosystem)
+      @logger = Secupdater.build_logger(log_level: log_level)
+      @publisher = publisher
+    end
+
+    def call(advisories_path)
+      raise Secupdater::Error, "Cannot open #{advisories_path}" unless File.file?(advisories_path)
+
+      advisories = File.open(advisories_path) { @ecosystem.parse_advisories(it) }
+      Update.new(@logger, @ecosystem, publisher: @publisher).call(advisories)
+    end
+  end
+end

data/lib/secupdater/update.rb

@@ -0,0 +1,85 @@
+module Secupdater
+  class Update
+    attr_reader :logger, :ecosystem, :publisher, :original
+
+    def initialize(logger, ecosystem, publisher: nil)
+      @logger = logger
+      @ecosystem = ecosystem
+      @publisher = publisher
+    end
+
+    def call(advisories)
+      @original = ecosystem.snapshot
+
+      deps_needing_checking = advisories.group_by { it.name }
+
+      missing = deps_needing_checking.keys - original.keys
+      raise Secupdater::Error, "Advisories for dependencies not in the lockfile: #{missing.join(', ')}" if missing.any?
+
+      deps_needing_checking.to_h do |name, dep_advisories|
+        [name, update_dependency(original[name], dep_advisories)]
+      end
+    end
+
+    def update_dependency(dep, advisories)
+      logger.info("starting update for #{dep.name}, #{advisories.length} advisories")
+
+      status = message = nil
+
+      ecosystem.update_levels.each do |level|
+        status, message = attempt_update(dep, advisories, level)
+        return status unless message
+
+        logger.debug "#{level} update: #{message}"
+      end
+
+      if status == :failed
+        logger.error message
+      else
+        logger.warn message
+      end
+
+      status
+    end
+
+    private
+
+    def attempt_update(dep, advisories, level)
+      file_changes = ecosystem.try_update(dep.name, level:)
+      bump = ecosystem.diff_snapshot(original, ecosystem.snapshot).detect { it.dependency.name == dep.name }
+
+      return [:unchanged, "#{dep.name} didn't update (stuck at #{dep.version})"] unless bump
+
+      resolved = advisories.all? do |advisory|
+        advisory.patched_versions.any? { ecosystem.satisfies_requirement?(bump.to, it) }
+      end
+
+      unless resolved
+        return [:unresolved, "#{dep.name} didn't update to a version that resolves the security warnings (went from #{bump.from} to #{bump.to})"]
+      end
+
+      advisories.each do |advisory|
+        logger.info "upgrading #{dep.name} from #{bump.from} to #{bump.to} (#{level}) would resolve #{advisory}"
+      end
+
+      return [:resolved, nil] unless publisher
+
+      publisher.call(ecosystem, bump, advisories, file_changes)
+      [:published, nil]
+    rescue Secupdater::UpdateCommandFailed => e
+      [:failed, "#{dep.name}: #{e.message}\n#{e.output}"]
+    ensure
+      restore(file_changes)
+    end
+
+    def restore(file_changes)
+      file_changes&.each do |change|
+        if change.original_content
+          File.write(change.filename, change.original_content)
+        else
+          File.delete(change.filename)
+        end
+      end
+    end
+  end
+end

data/lib/secupdater/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Secupdater
+  VERSION = "0.1.0"
+end

data/lib/secupdater.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require "dry/logger"
+
+require_relative "secupdater/version"
+require_relative "secupdater/cli"
+require_relative "secupdater/ecosystem"
+require_relative "secupdater/runner"
+require_relative "secupdater/update"
+require_relative "secupdater/publisher"
+require_relative "secupdater/publisher/gitlab"
+
+module Secupdater
+  SecurityAdvisory = Struct.new(:name, :report_id, :patched_versions) do
+    def to_s
+      "#{name} #{report_id}"
+    end
+  end
+
+  DependencySpec = Struct.new(:name, :meta, :version)
+  DependencySpecDiff = Struct.new(:dependency, :from, :to)
+  FileChange = Struct.new(:filename, :type, :content, :original_content)
+
+  class Error < StandardError; end
+
+  class UpdateCommandFailed < Error
+    attr_reader :output, :exit_code
+
+    def initialize(message = nil, exit_code = nil, output = nil)
+      super(message)
+      @exit_code = exit_code
+      @output = output
+    end
+  end
+
+  def self.build_logger(log_level: :warn)
+    Dry.Logger(
+      :secupdater,
+      template: "[%<severity>s] %<message>s",
+      level: log_level
+    )
+  end
+end

data/sig/secupdater.rbs

@@ -0,0 +1,4 @@
+module Secupdater
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

data/spec/e2e/secupdater_spec.rb

@@ -0,0 +1,112 @@
+require "secupdater"
+require "fileutils"
+require "stringio"
+require "tmpdir"
+
+RSpec.describe "secupdater end to end" do
+  let(:out) { StringIO.new }
+  let(:err) { StringIO.new }
+  let(:env) { {} }
+
+  def lockfile(css_parser_version)
+    <<~LOCKFILE
+      GEM
+        remote: https://rubygems.org/
+        specs:
+          css_parser (#{css_parser_version})
+
+      PLATFORMS
+        ruby
+
+      DEPENDENCIES
+        css_parser
+
+      BUNDLED WITH
+         2.5.0
+    LOCKFILE
+  end
+
+  let(:report) do
+    {
+      results: [
+        {
+          type: "unpatched_gem",
+          gem: { name: "css_parser", version: "1.0.0" },
+          advisory: { id: "CVE-2024-0001", cve: "2024-0001", patched_versions: [">= 1.1.0"] }
+        }
+      ]
+    }
+  end
+
+  def run_cli(*arguments)
+    Dry::CLI.new(Secupdater::CLI::Commands).call(arguments: ["run", "--ecosystem=rubygems", *arguments, "audit.json"], out: out, err: err)
+  end
+
+  around do |example|
+    original_env = ENV.to_h
+
+    Dir.mktmpdir do |dir|
+      Dir.chdir(dir) do
+        File.write("Gemfile.lock", lockfile("1.0.0"))
+        File.write("Gemfile.lock.after", lockfile("1.1.0"))
+        File.write("audit.json", report.to_json)
+
+        FileUtils.mkdir("bin")
+        File.write("bin/bundle", "#!/bin/sh\ncp Gemfile.lock.after Gemfile.lock\n")
+        File.chmod(0o755, "bin/bundle")
+
+        ENV.delete("SECUPDATER_GITLAB_TOKEN")
+        ENV.update(env.merge("PATH" => "#{dir}/bin:#{ENV['PATH']}"))
+        example.run
+      end
+    end
+  ensure
+    ENV.replace(original_env)
+  end
+
+  context "fixture project + bundle-audit JSON + fake bundle command that swaps in an 'after' lockfile + WebMock'd GitLab" do
+    let(:env) { { "SECUPDATER_GITLAB_TOKEN" => "token", "CI_PROJECT_ID" => "123", "CI_DEFAULT_BRANCH" => "main" } }
+
+    let!(:find_mr_stub) do
+      stub_request(:get, %r{\Ahttps://gitlab.com/api/v4/projects/123/merge_requests\?})
+        .to_return(status: 200, body: "[]")
+    end
+
+    let!(:create_commit_stub) do
+      stub_request(:post, "https://gitlab.com/api/v4/projects/123/repository/commits")
+        .with(body: hash_including(
+          branch: "security/css_parser-1.1.0",
+          actions: [{ action: "update", file_path: "Gemfile.lock", content: lockfile("1.1.0") }]
+        ))
+        .to_return(status: 201, body: "{}")
+    end
+
+    let!(:create_mr_stub) do
+      stub_request(:post, "https://gitlab.com/api/v4/projects/123/merge_requests")
+        .with(body: hash_including(source_branch: "security/css_parser-1.1.0", target_branch: "main"))
+        .to_return(status: 201, body: "{}")
+    end
+
+    it "exits 0, commits the new Gemfile.lock and opens one MR per vulnerable gem" do
+      expect { run_cli }.not_to raise_error
+
+      expect(find_mr_stub).to have_been_requested.once
+      expect(create_commit_stub).to have_been_requested.once
+      expect(create_mr_stub).to have_been_requested.once
+      expect(File.read("Gemfile.lock")).to eq(lockfile("1.0.0"))
+    end
+  end
+
+  context "same fixture project without GitLab configuration (dry run)" do
+    it "exits 0, reports what would be updated and makes no HTTP requests" do
+      expect { run_cli("--verbose") }.to output(/css_parser from 1\.0\.0 to 1\.1\.0 \(patch\) would resolve/).to_stdout
+
+      expect(a_request(:any, //)).not_to have_been_made
+      expect(File.read("Gemfile.lock")).to eq(lockfile("1.0.0"))
+    end
+  end
+
+  context "real bundle update --local against fixture vendor/cache gems", :integration do
+    it "bumps the gem in Gemfile.lock"
+  end
+end