still_active 1.5.0 → 2.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +57 -0
- data/README.md +97 -12
- data/lib/helpers/activity_helper.rb +34 -9
- data/lib/helpers/alternatives_helper.rb +42 -0
- data/lib/helpers/bundler_helper.rb +87 -26
- data/lib/helpers/catalog_index.rb +101 -0
- data/lib/helpers/cyclonedx_helper.rb +24 -8
- data/lib/helpers/diff_markdown_helper.rb +15 -12
- data/lib/helpers/http_helper.rb +101 -14
- data/lib/helpers/lockfile_dependency_parser.rb +99 -0
- data/lib/helpers/lockfile_indexer.rb +3 -0
- data/lib/helpers/markdown_escape.rb +58 -0
- data/lib/helpers/markdown_helper.rb +37 -4
- data/lib/helpers/ruby_helper.rb +5 -4
- data/lib/helpers/sarif_helper.rb +60 -26
- data/lib/helpers/summary_helper.rb +48 -0
- data/lib/helpers/terminal_helper.rb +45 -18
- data/lib/helpers/version_helper.rb +7 -1
- data/lib/still_active/artifactory_client.rb +166 -0
- data/lib/still_active/cli.rb +89 -18
- data/lib/still_active/config.rb +35 -3
- data/lib/still_active/config_file.rb +180 -0
- data/lib/still_active/deps_dev_client.rb +27 -6
- data/lib/still_active/diff.rb +59 -2
- data/lib/still_active/forgejo_client.rb +50 -0
- data/lib/still_active/github_client.rb +126 -0
- data/lib/still_active/gitlab_client.rb +15 -20
- data/lib/still_active/options.rb +15 -5
- data/lib/still_active/repository.rb +12 -4
- data/lib/still_active/sarif/rules.rb +2 -2
- data/lib/still_active/suppressions.rb +142 -0
- data/lib/still_active/version.rb +1 -1
- data/lib/still_active/workflow.rb +130 -55
- data/still_active.gemspec +14 -8
- metadata +23 -10
|
@@ -55,7 +55,7 @@ module StillActive
|
|
|
55
55
|
component = { "type" => "library", "name" => name }
|
|
56
56
|
component["version"] = version if version
|
|
57
57
|
component["bom-ref"] = bom_ref(name, data)
|
|
58
|
-
component["purl"] = purl(name, version
|
|
58
|
+
component["purl"] = purl(name, version, data[:source_type]) if version
|
|
59
59
|
component["licenses"] = licenses(data[:license]) if data[:license]
|
|
60
60
|
if data[:repository_url]
|
|
61
61
|
component["externalReferences"] = [{ "type" => "vcs", "url" => data[:repository_url] }]
|
|
@@ -67,13 +67,19 @@ module StillActive
|
|
|
67
67
|
|
|
68
68
|
def bom_ref(name, data)
|
|
69
69
|
version = data[:version_used]
|
|
70
|
-
return purl(name, version
|
|
70
|
+
return purl(name, version, data[:source_type]) if version
|
|
71
71
|
|
|
72
|
-
"#{data[:source_type]}-source:#{name}
|
|
72
|
+
"#{data[:source_type]}-source:#{name}@unknown"
|
|
73
73
|
end
|
|
74
74
|
|
|
75
|
-
|
|
76
|
-
|
|
75
|
+
# Datadog SCA (and strict CycloneDX consumers) hard-reject a versioned
|
|
76
|
+
# library component with no purl, so every gem with a version needs one.
|
|
77
|
+
# A path gem is local and not on rubygems, so it gets pkg:generic to avoid
|
|
78
|
+
# false-matching a public gem of the same name; git/rubygems-sourced gems
|
|
79
|
+
# get pkg:gem so a fork still matches the upstream gem's advisories.
|
|
80
|
+
def purl(name, version, source_type)
|
|
81
|
+
type = source_type == :path ? "generic" : "gem"
|
|
82
|
+
"pkg:#{type}/#{name}@#{version}"
|
|
77
83
|
end
|
|
78
84
|
|
|
79
85
|
# VersionHelper joins multiple SPDX ids with ", " for terminal/markdown
|
|
@@ -93,12 +99,22 @@ module StillActive
|
|
|
93
99
|
}.filter_map { |name, value| { "name" => name, "value" => value } unless value.nil? }
|
|
94
100
|
end
|
|
95
101
|
|
|
102
|
+
# The Ruby interpreter. CycloneDX's "platform" type fits semantically, but
|
|
103
|
+
# nothing consumes it and strict SCA validators (Datadog) only accept
|
|
104
|
+
# "library" + a purl. We follow Syft's convention for an unmanaged runtime:
|
|
105
|
+
# type "library", purl pkg:generic/ruby@<ver>, plus a CPE — the CPE is what
|
|
106
|
+
# actually lets a matcher (NVD/Grype) hit interpreter CVEs, since no purl
|
|
107
|
+
# type maps the Ruby runtime in OSV. The EOL/libyear signals stay as
|
|
108
|
+
# still_active properties.
|
|
96
109
|
def ruby_component(ruby_info)
|
|
110
|
+
version = ruby_info[:version]
|
|
97
111
|
{
|
|
98
|
-
"type" => "
|
|
112
|
+
"type" => "library",
|
|
99
113
|
"name" => "ruby",
|
|
100
|
-
"version" =>
|
|
101
|
-
"bom-ref" => "
|
|
114
|
+
"version" => version,
|
|
115
|
+
"bom-ref" => "pkg:generic/ruby@#{version}",
|
|
116
|
+
"purl" => "pkg:generic/ruby@#{version}",
|
|
117
|
+
"cpe" => "cpe:2.3:a:ruby-lang:ruby:#{version}:*:*:*:*:*:*:*",
|
|
102
118
|
"properties" => [
|
|
103
119
|
{ "name" => "still_active:eol", "value" => boolean_property(ruby_info[:eol]) },
|
|
104
120
|
{ "name" => "still_active:libyear", "value" => ruby_info[:libyear]&.to_s },
|
|
@@ -1,5 +1,7 @@
|
|
|
1
1
|
# frozen_string_literal: true
|
|
2
2
|
|
|
3
|
+
require_relative "markdown_escape"
|
|
4
|
+
|
|
3
5
|
module StillActive
|
|
4
6
|
# Renders a StillActive::Diff::Result as PR-comment-friendly markdown.
|
|
5
7
|
# Section taxonomy mirrors GitHub's dependency-review-action so reviewers
|
|
@@ -49,7 +51,7 @@ module StillActive
|
|
|
49
51
|
def regressions_section(regressions)
|
|
50
52
|
return "" if regressions.empty?
|
|
51
53
|
|
|
52
|
-
lines = regressions.map { |r| "- **#{r.kind}**
|
|
54
|
+
lines = regressions.map { |r| "- **#{r.kind}** #{MarkdownEscape.code_span(r.gem)} — #{MarkdownEscape.inline(r.detail)}" }
|
|
53
55
|
section("Regressions (CI-failable)", lines)
|
|
54
56
|
end
|
|
55
57
|
|
|
@@ -63,7 +65,7 @@ module StillActive
|
|
|
63
65
|
def removed_section(removed)
|
|
64
66
|
return "" if removed.empty?
|
|
65
67
|
|
|
66
|
-
lines = removed.map { |r| "-
|
|
68
|
+
lines = removed.map { |r| "- #{MarkdownEscape.code_span(r.name)} (was #{MarkdownEscape.inline((r.data || {})["version_used"] || "?")})" }
|
|
67
69
|
section("Removed", lines)
|
|
68
70
|
end
|
|
69
71
|
|
|
@@ -88,9 +90,9 @@ module StillActive
|
|
|
88
90
|
lines = []
|
|
89
91
|
if ruby[:version_changed]
|
|
90
92
|
eol_suffix = ruby[:newly_eol] ? " (now EOL)" : ""
|
|
91
|
-
lines << "- Ruby
|
|
93
|
+
lines << "- Ruby #{MarkdownEscape.code_span(ruby[:from])} → #{MarkdownEscape.code_span(ruby[:to])}#{eol_suffix}"
|
|
92
94
|
elsif ruby[:newly_eol]
|
|
93
|
-
lines << "- Ruby
|
|
95
|
+
lines << "- Ruby #{MarkdownEscape.code_span(ruby[:to])} is now EOL"
|
|
94
96
|
end
|
|
95
97
|
section("Ruby", lines)
|
|
96
98
|
end
|
|
@@ -108,30 +110,31 @@ module StillActive
|
|
|
108
110
|
(data["archived"] ? "archived" : nil),
|
|
109
111
|
data["libyear"] && "#{data["libyear"]}y behind",
|
|
110
112
|
].compact
|
|
111
|
-
"
|
|
113
|
+
"#{MarkdownEscape.code_span(added.name)} (#{MarkdownEscape.inline(bits.join(", "))})"
|
|
112
114
|
end
|
|
113
115
|
|
|
114
116
|
def format_bump(bump)
|
|
115
117
|
label = BUMP_KIND_LABELS[bump.kind]
|
|
116
118
|
suffix = label ? " (#{label})" : ""
|
|
117
|
-
"-
|
|
119
|
+
"- #{MarkdownEscape.code_span(bump.name)} #{MarkdownEscape.inline(bump.before_version)} → #{MarkdownEscape.inline(bump.after_version)}#{suffix}"
|
|
118
120
|
end
|
|
119
121
|
|
|
120
122
|
def format_signal_change_lines(sc)
|
|
123
|
+
name = MarkdownEscape.code_span(sc.name)
|
|
121
124
|
sc.changes.filter_map do |ch|
|
|
122
125
|
case ch[:kind]
|
|
123
126
|
when :archived
|
|
124
|
-
"-
|
|
127
|
+
"- #{name} — archived (false → true)"
|
|
125
128
|
when :new_vulnerability
|
|
126
|
-
ids = Array(ch[:ids]).join(", ")
|
|
127
|
-
"-
|
|
129
|
+
ids = MarkdownEscape.inline(Array(ch[:ids]).join(", "))
|
|
130
|
+
"- #{name} — new vulnerability (#{MarkdownEscape.inline(ch[:from])} → #{MarkdownEscape.inline(ch[:to])}#{" — #{ids}" unless ids.empty?})"
|
|
128
131
|
when :scorecard_dropped
|
|
129
132
|
note = ch[:crossed_good] ? " (crossed 7.0)" : ""
|
|
130
|
-
"-
|
|
133
|
+
"- #{name} — scorecard #{MarkdownEscape.inline(ch[:from])} → #{MarkdownEscape.inline(ch[:to])}#{note}"
|
|
131
134
|
when :version_yanked
|
|
132
|
-
"-
|
|
135
|
+
"- #{name} — version yanked from rubygems"
|
|
133
136
|
when :libyear_worsened
|
|
134
|
-
"-
|
|
137
|
+
"- #{name} — libyear #{MarkdownEscape.inline(ch[:from])} → #{MarkdownEscape.inline(ch[:to])} (+#{ch[:delta]}y; same pinned version)"
|
|
135
138
|
end
|
|
136
139
|
end
|
|
137
140
|
end
|
data/lib/helpers/http_helper.rb
CHANGED
|
@@ -5,8 +5,15 @@ require "json"
|
|
|
5
5
|
|
|
6
6
|
module StillActive
|
|
7
7
|
module HttpHelper
|
|
8
|
-
TRUSTED_HOSTS = ["github.com", "gitlab.com", "api.deps.dev", "endoflife.date", "rubygems.pkg.github.com"].freeze
|
|
8
|
+
TRUSTED_HOSTS = ["github.com", "gitlab.com", "codeberg.org", "api.deps.dev", "endoflife.date", "rubygems.pkg.github.com"].freeze
|
|
9
9
|
MAX_REDIRECTS = 3
|
|
10
|
+
# Ceiling on a single response body. These are metadata endpoints (version
|
|
11
|
+
# lists, scorecards, advisories); legitimate responses are well under this.
|
|
12
|
+
# A source URL is lockfile-derived and a `*.jfrog.io` host is attacker-
|
|
13
|
+
# registerable, so without a cap a hostile or broken source could stream a
|
|
14
|
+
# multi-GB body and OOM the process. 16 MiB leaves generous headroom for a
|
|
15
|
+
# gem with thousands of versions while bounding worst-case memory.
|
|
16
|
+
MAX_BODY_BYTES = 16 * 1024 * 1024
|
|
10
17
|
|
|
11
18
|
extend self
|
|
12
19
|
|
|
@@ -15,35 +22,74 @@ module StillActive
|
|
|
15
22
|
uri.path = path
|
|
16
23
|
uri.query = URI.encode_www_form(params) unless params.empty?
|
|
17
24
|
|
|
25
|
+
request_json(uri, headers) { |target| Net::HTTP::Get.new(target) }
|
|
26
|
+
end
|
|
27
|
+
|
|
28
|
+
def post_json(base_uri, path, body:, headers: {})
|
|
29
|
+
uri = base_uri.dup
|
|
30
|
+
uri.path = path
|
|
31
|
+
|
|
32
|
+
request_json(uri, headers) do |target|
|
|
33
|
+
request = Net::HTTP::Post.new(target)
|
|
34
|
+
request.body = body
|
|
35
|
+
request
|
|
36
|
+
end
|
|
37
|
+
end
|
|
38
|
+
|
|
39
|
+
private
|
|
40
|
+
|
|
41
|
+
# Two URIs share an origin when scheme, host, and port all match. URI fills
|
|
42
|
+
# in the default port (443 for https), so the bare and explicit forms of the
|
|
43
|
+
# same origin compare equal.
|
|
44
|
+
def same_origin?(a, b)
|
|
45
|
+
a.scheme == b.scheme && a.host == b.host && a.port == b.port
|
|
46
|
+
end
|
|
47
|
+
|
|
48
|
+
# Runs the request, following up to MAX_REDIRECTS trusted-host redirects,
|
|
49
|
+
# and returns the parsed JSON (or nil). The block is yielded each URI and
|
|
50
|
+
# returns the request object, so GET and POST share the redirect/auth/cap
|
|
51
|
+
# logic.
|
|
52
|
+
def request_json(uri, headers)
|
|
18
53
|
MAX_REDIRECTS.times do
|
|
19
54
|
http = Net::HTTP.new(uri.host, uri.port)
|
|
20
55
|
http.use_ssl = true
|
|
21
56
|
http.open_timeout = 10
|
|
22
57
|
http.read_timeout = 10
|
|
23
58
|
|
|
24
|
-
request =
|
|
59
|
+
request = yield(uri)
|
|
25
60
|
headers.each { |key, value| request[key] = value }
|
|
26
61
|
|
|
27
|
-
|
|
62
|
+
outcome, payload = perform(http, request, uri)
|
|
63
|
+
case outcome
|
|
64
|
+
when :done
|
|
65
|
+
return payload
|
|
66
|
+
when :stop
|
|
67
|
+
return
|
|
68
|
+
when :redirect
|
|
69
|
+
location = payload["Location"]
|
|
70
|
+
if location.nil? || location.empty?
|
|
71
|
+
$stderr.puts("warning: #{uri.host}#{uri.path} returned HTTP #{payload.code} with no Location header")
|
|
72
|
+
return
|
|
73
|
+
end
|
|
28
74
|
|
|
29
|
-
|
|
30
|
-
redirect_uri = uri + response["Location"]
|
|
75
|
+
redirect_uri = uri + location
|
|
31
76
|
unless TRUSTED_HOSTS.include?(redirect_uri.host)
|
|
32
77
|
$stderr.puts("warning: #{uri.host}#{uri.path} redirected to untrusted host #{redirect_uri.host}, skipping")
|
|
33
78
|
return
|
|
34
79
|
end
|
|
80
|
+
# We dial every request over TLS (use_ssl = true). A redirect that
|
|
81
|
+
# downgrades to http is either a misconfiguration or a downgrade
|
|
82
|
+
# attempt; refuse it rather than silently dialing http-over-TLS.
|
|
83
|
+
unless redirect_uri.scheme == "https"
|
|
84
|
+
$stderr.puts("warning: #{uri.host}#{uri.path} redirected to non-https #{redirect_uri.scheme} target, skipping")
|
|
85
|
+
return
|
|
86
|
+
end
|
|
35
87
|
$stderr.puts("warning: #{uri.host}#{uri.path} redirected to #{redirect_uri.host}#{redirect_uri.path} (stale metadata?)")
|
|
36
|
-
|
|
88
|
+
# Auth is scoped to an origin (scheme + host + port), not just a host:
|
|
89
|
+
# a different port is a different service and must not inherit the token.
|
|
90
|
+
headers = {} unless same_origin?(uri, redirect_uri)
|
|
37
91
|
uri = redirect_uri
|
|
38
|
-
next
|
|
39
|
-
end
|
|
40
|
-
|
|
41
|
-
unless response.is_a?(Net::HTTPSuccess)
|
|
42
|
-
$stderr.puts("warning: #{uri.host}#{uri.path} returned HTTP #{response.code}") unless response.is_a?(Net::HTTPNotFound)
|
|
43
|
-
return
|
|
44
92
|
end
|
|
45
|
-
|
|
46
|
-
return JSON.parse(response.body)
|
|
47
93
|
end
|
|
48
94
|
|
|
49
95
|
$stderr.puts("warning: #{uri.host}#{uri.path} too many redirects")
|
|
@@ -54,6 +100,47 @@ module StillActive
|
|
|
54
100
|
rescue JSON::ParserError => e
|
|
55
101
|
$stderr.puts("warning: #{uri.host}#{uri.path} returned invalid JSON: #{e.message}")
|
|
56
102
|
nil
|
|
103
|
+
rescue URI::InvalidURIError => e
|
|
104
|
+
$stderr.puts("warning: #{uri.host}#{uri.path} returned an invalid redirect Location: #{e.message}")
|
|
105
|
+
nil
|
|
106
|
+
end
|
|
107
|
+
|
|
108
|
+
# Issues the request in streaming form so the body is read against a size
|
|
109
|
+
# cap rather than buffered whole. Returns one of:
|
|
110
|
+
# [:redirect, response] a 3xx, for the caller to follow
|
|
111
|
+
# [:stop, nil] non-success (warns unless 404), or body over cap
|
|
112
|
+
# [:done, parsed] a 2xx with parsed JSON
|
|
113
|
+
# Redirect and non-success bodies are never read: returning from the block
|
|
114
|
+
# unwinds through Net::HTTP, which closes the connection without draining
|
|
115
|
+
# the body, so a huge error/redirect body can't OOM us either.
|
|
116
|
+
def perform(http, request, uri)
|
|
117
|
+
http.request(request) do |response|
|
|
118
|
+
return [:redirect, response] if response.is_a?(Net::HTTPRedirection)
|
|
119
|
+
|
|
120
|
+
unless response.is_a?(Net::HTTPSuccess)
|
|
121
|
+
$stderr.puts("warning: #{uri.host}#{uri.path} returned HTTP #{response.code}") unless response.is_a?(Net::HTTPNotFound)
|
|
122
|
+
return [:stop, nil]
|
|
123
|
+
end
|
|
124
|
+
|
|
125
|
+
body = read_capped_body(response, uri)
|
|
126
|
+
return [:stop, nil] if body.nil?
|
|
127
|
+
|
|
128
|
+
return [:done, JSON.parse(body)]
|
|
129
|
+
end
|
|
130
|
+
end
|
|
131
|
+
|
|
132
|
+
# Reads the body in chunks, abandoning the read (returns nil) as soon as it
|
|
133
|
+
# exceeds MAX_BODY_BYTES so an oversized body is never fully materialized.
|
|
134
|
+
def read_capped_body(response, uri)
|
|
135
|
+
body = +""
|
|
136
|
+
response.read_body do |chunk|
|
|
137
|
+
body << chunk
|
|
138
|
+
if body.bytesize > MAX_BODY_BYTES
|
|
139
|
+
$stderr.puts("warning: #{uri.host}#{uri.path} response exceeded #{MAX_BODY_BYTES} bytes, skipping")
|
|
140
|
+
return nil
|
|
141
|
+
end
|
|
142
|
+
end
|
|
143
|
+
body
|
|
57
144
|
end
|
|
58
145
|
end
|
|
59
146
|
end
|
|
@@ -0,0 +1,99 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module StillActive
|
|
4
|
+
# Side-effect-free Gemfile.lock parser: extracts each top-level dependency's
|
|
5
|
+
# name, version, and source (type + URI) straight from the lockfile text.
|
|
6
|
+
#
|
|
7
|
+
# We deliberately do NOT load the Gemfile (evaluating it is arbitrary code
|
|
8
|
+
# execution when the audited project is untrusted, e.g. CI on a pull request)
|
|
9
|
+
# and do NOT use Bundler::LockfileParser. The latter is not side-effect-free:
|
|
10
|
+
# a `PLUGIN SOURCE` block runs `Bundler::Plugin.from_lock` at parse time,
|
|
11
|
+
# which resolves against the on-disk plugin registry and can raise or activate
|
|
12
|
+
# an installed plugin. (Bundler's own `@gemfile_parse` guard that neutralizes
|
|
13
|
+
# this is set only inside `Bundler::Plugin.gemfile_install`, never for a
|
|
14
|
+
# standalone parse.) This mirrors what OSV-Scanner and Trivy do for the same
|
|
15
|
+
# threat model, and what `LockfileIndexer` already does here. Refs #37.
|
|
16
|
+
module LockfileDependencyParser
|
|
17
|
+
extend self
|
|
18
|
+
|
|
19
|
+
# `dependencies` holds the names listed under this spec in the lockfile (its
|
|
20
|
+
# resolved runtime deps). For a local path gem (a gemspec project or engine)
|
|
21
|
+
# these are the gems it ships, which Bundler does not surface in the
|
|
22
|
+
# DEPENDENCIES section, so they are what #41 needs to reach.
|
|
23
|
+
Spec = Struct.new(:name, :version, :source_type, :source_uri, :dependencies, keyword_init: true)
|
|
24
|
+
|
|
25
|
+
# Lockfile source blocks and the source_type each maps to. PLUGIN SOURCE is
|
|
26
|
+
# recognized as a block (so its lines are consumed as inert data, not
|
|
27
|
+
# mis-read as specs) but yields no auditable gems.
|
|
28
|
+
SOURCE_TYPES = { "GEM" => :rubygems, "GIT" => :git, "PATH" => :path }.freeze
|
|
29
|
+
PLUGIN_SOURCE = "PLUGIN SOURCE"
|
|
30
|
+
|
|
31
|
+
# A section header sits at column 0; Bundler emits them in SCREAMING form.
|
|
32
|
+
SECTION_HEADER = /\A[A-Z]/
|
|
33
|
+
# A top-level spec is indented exactly 4 spaces: ` name (1.2.3)` or, for a
|
|
34
|
+
# platform gem, ` name (1.2.3-x86_64-linux)`. Nested deps (6 spaces) and
|
|
35
|
+
# the `specs:`/`remote:` option lines (2 spaces) do not match. We do NOT
|
|
36
|
+
# anchor the end of the line: Bundler's grammar allows an optional trailing
|
|
37
|
+
# checksum on a spec line, and an audit tool must never silently drop a gem
|
|
38
|
+
# because of unexpected trailing content (that would be a false-negative
|
|
39
|
+
# evasion on a hand-crafted lockfile).
|
|
40
|
+
SPEC_LINE = /\A {4}(\S+) \(([^-)]+)(?:-[^)]*)?\)/
|
|
41
|
+
REMOTE_LINE = /\A {2}remote: (.+)\z/
|
|
42
|
+
# A spec's nested runtime dep is indented exactly 6 spaces: ` name` or
|
|
43
|
+
# ` name (~> 1.0)`.
|
|
44
|
+
NESTED_DEP_LINE = /\A {6}([^\s(!]+)/
|
|
45
|
+
# A DEPENDENCIES entry is indented 2 spaces: ` name`, ` name (~> 1.0)`, or
|
|
46
|
+
# ` name!` (the `!` marks a pinned git/path source).
|
|
47
|
+
DEPENDENCY_LINE = /\A {2}([^\s(!]+)/
|
|
48
|
+
|
|
49
|
+
# Parses lockfile text into { specs:, direct:, plugin_source? }.
|
|
50
|
+
# `specs` is every locked top-level spec (a Spec per gem); `direct` is the
|
|
51
|
+
# names from the DEPENDENCIES section; `plugin_source?` flags that a
|
|
52
|
+
# PLUGIN SOURCE block was present (and skipped).
|
|
53
|
+
def parse(content)
|
|
54
|
+
# A hand-edited or re-encoded lockfile can carry a leading UTF-8 BOM.
|
|
55
|
+
# Section headers anchor at column 0 (\A), so a BOM glued to "GEM" would
|
|
56
|
+
# drop the entire first block: a silent false-negative, the exact evasion
|
|
57
|
+
# this parser is written to avoid.
|
|
58
|
+
content = content.delete_prefix("")
|
|
59
|
+
specs = []
|
|
60
|
+
direct = []
|
|
61
|
+
section = nil
|
|
62
|
+
source_type = nil
|
|
63
|
+
remote = nil
|
|
64
|
+
current_spec = nil
|
|
65
|
+
plugin_source = false
|
|
66
|
+
|
|
67
|
+
content.each_line do |raw|
|
|
68
|
+
line = raw.chomp
|
|
69
|
+
|
|
70
|
+
if line.match?(SECTION_HEADER)
|
|
71
|
+
section = line
|
|
72
|
+
source_type = SOURCE_TYPES[line]
|
|
73
|
+
remote = nil
|
|
74
|
+
current_spec = nil
|
|
75
|
+
plugin_source ||= (line == PLUGIN_SOURCE)
|
|
76
|
+
next
|
|
77
|
+
end
|
|
78
|
+
|
|
79
|
+
case section
|
|
80
|
+
when "GEM", "GIT", "PATH"
|
|
81
|
+
if (m = REMOTE_LINE.match(line))
|
|
82
|
+
remote ||= m[1] # first remote wins, matching Bundler's remotes.first
|
|
83
|
+
elsif (m = SPEC_LINE.match(line))
|
|
84
|
+
current_spec = Spec.new(name: m[1], version: m[2], source_type: source_type, source_uri: remote, dependencies: [])
|
|
85
|
+
specs << current_spec
|
|
86
|
+
elsif current_spec && (m = NESTED_DEP_LINE.match(line))
|
|
87
|
+
current_spec.dependencies << m[1]
|
|
88
|
+
end
|
|
89
|
+
when "DEPENDENCIES"
|
|
90
|
+
if (m = DEPENDENCY_LINE.match(line))
|
|
91
|
+
direct << m[1]
|
|
92
|
+
end
|
|
93
|
+
end
|
|
94
|
+
end
|
|
95
|
+
|
|
96
|
+
{ specs: specs, direct: direct, plugin_source?: plugin_source }
|
|
97
|
+
end
|
|
98
|
+
end
|
|
99
|
+
end
|
|
@@ -24,6 +24,9 @@ module StillActive
|
|
|
24
24
|
# top-level entry wins. Lines outside GEM/GIT/PATH/PLUGIN SOURCE blocks
|
|
25
25
|
# are ignored.
|
|
26
26
|
def gem_line_index(content)
|
|
27
|
+
# Strip a leading UTF-8 BOM so a "GEM" first line still matches the
|
|
28
|
+
# column-0 block header; otherwise every gem falls back to line 1.
|
|
29
|
+
content = content.delete_prefix("")
|
|
27
30
|
index = {}
|
|
28
31
|
in_block = false
|
|
29
32
|
content.each_line.with_index(1) do |line, lineno|
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module StillActive
|
|
4
|
+
# Escaping for untrusted metadata (gem names, licences, versions, repo URLs,
|
|
5
|
+
# advisory ids) rendered into GitHub-Flavored Markdown. These values come
|
|
6
|
+
# from registry/repo metadata, a Gemfile/lockfile, a --baseline file, or
|
|
7
|
+
# --gems input, so they can contain markdown-structural characters. Centralised
|
|
8
|
+
# so the table renderer (MarkdownHelper) and the diff renderer
|
|
9
|
+
# (DiffMarkdownHelper) can't drift apart on what's safe.
|
|
10
|
+
module MarkdownEscape
|
|
11
|
+
extend self
|
|
12
|
+
|
|
13
|
+
# Table cell: a literal "|" or newline would forge columns or break the row.
|
|
14
|
+
# Backslash is escaped first so it can't escape a following delimiter.
|
|
15
|
+
def cell(text)
|
|
16
|
+
return text if text.nil?
|
|
17
|
+
|
|
18
|
+
text.to_s.gsub(/[\\|\r\n]/, "\\" => "\\\\", "|" => "\\|", "\r" => " ", "\n" => " ")
|
|
19
|
+
end
|
|
20
|
+
|
|
21
|
+
# Link text additionally must not contain "[" or "]", which could forge or
|
|
22
|
+
# truncate the link.
|
|
23
|
+
def link_text(text)
|
|
24
|
+
return text if text.nil?
|
|
25
|
+
|
|
26
|
+
cell(text).gsub(/[\[\]]/, "[" => "\\[", "]" => "\\]")
|
|
27
|
+
end
|
|
28
|
+
|
|
29
|
+
# Link destination: percent-encode the characters that would break out of a
|
|
30
|
+
# "(...)" destination or the table row. Lossless for legitimate http(s) URLs.
|
|
31
|
+
def url(value)
|
|
32
|
+
return value if value.nil?
|
|
33
|
+
|
|
34
|
+
value.to_s.gsub(/[|() \t\r\n]/, "|" => "%7C", "(" => "%28", ")" => "%29", " " => "%20", "\t" => "%09", "\r" => "%0D", "\n" => "%0A")
|
|
35
|
+
end
|
|
36
|
+
|
|
37
|
+
# Inline (non-table) free text in a bullet list: neutralise newlines (which
|
|
38
|
+
# would break the list) and brackets/backslash (which could forge a link).
|
|
39
|
+
def inline(text)
|
|
40
|
+
return text if text.nil?
|
|
41
|
+
|
|
42
|
+
text.to_s.gsub(/[\\\[\]\r\n]/, "\\" => "\\\\", "[" => "\\[", "]" => "\\]", "\r" => " ", "\n" => " ")
|
|
43
|
+
end
|
|
44
|
+
|
|
45
|
+
# Wrap arbitrary text in an inline code span safely. A backtick in the text
|
|
46
|
+
# would otherwise close the span early, so use a backtick fence longer than
|
|
47
|
+
# the longest run in the content (and pad when it starts/ends with one), per
|
|
48
|
+
# the GFM code-span rules. Newlines collapse to spaces.
|
|
49
|
+
def code_span(text)
|
|
50
|
+
content = text.to_s.tr("\r\n", " ")
|
|
51
|
+
return "`#{content}`" unless content.include?("`")
|
|
52
|
+
|
|
53
|
+
fence = "`" * (content.scan(/`+/).map(&:length).max + 1)
|
|
54
|
+
pad = content.start_with?("`") || content.end_with?("`") ? " " : ""
|
|
55
|
+
"#{fence}#{pad}#{content}#{pad}#{fence}"
|
|
56
|
+
end
|
|
57
|
+
end
|
|
58
|
+
end
|
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
# frozen_string_literal: true
|
|
2
2
|
|
|
3
|
+
require_relative "markdown_escape"
|
|
3
4
|
require_relative "vulnerability_helper"
|
|
5
|
+
require_relative "activity_helper"
|
|
4
6
|
|
|
5
7
|
module StillActive
|
|
6
8
|
module MarkdownHelper
|
|
@@ -84,8 +86,38 @@ module StillActive
|
|
|
84
86
|
"| #{cells.join(" | ")} |"
|
|
85
87
|
end
|
|
86
88
|
|
|
89
|
+
def alternatives_section(result)
|
|
90
|
+
flagged = result.select do |_name, data|
|
|
91
|
+
data[:alternatives] && !data[:alternatives].empty?
|
|
92
|
+
end
|
|
93
|
+
return "" if flagged.empty?
|
|
94
|
+
|
|
95
|
+
lines = ["", "**Alternatives** (Ruby Toolbox leads, verify fit):"]
|
|
96
|
+
flagged.each { |name, data| lines << "- #{MarkdownEscape.code_span(name)}: #{MarkdownEscape.inline(data[:alternatives].join(", "))}" }
|
|
97
|
+
lines.join("\n")
|
|
98
|
+
end
|
|
99
|
+
|
|
100
|
+
# Flagged transitive gems can't be swapped directly; name the direct
|
|
101
|
+
# dependency that pulls each one in so the finding becomes actionable (#60).
|
|
102
|
+
def transitive_section(result)
|
|
103
|
+
flagged = result.select do |_name, data|
|
|
104
|
+
data[:direct] == false && Array(data[:dependency_path]).length >= 2 && transitive_flagged?(data)
|
|
105
|
+
end
|
|
106
|
+
return "" if flagged.empty?
|
|
107
|
+
|
|
108
|
+
lines = ["", "**Transitive findings** (pulled in by a direct dependency):"]
|
|
109
|
+
flagged.each do |name, data|
|
|
110
|
+
lines << "- #{MarkdownEscape.code_span(name)} via #{MarkdownEscape.code_span(data[:dependency_path].first)}"
|
|
111
|
+
end
|
|
112
|
+
lines.join("\n")
|
|
113
|
+
end
|
|
114
|
+
|
|
87
115
|
private
|
|
88
116
|
|
|
117
|
+
def transitive_flagged?(data)
|
|
118
|
+
[:archived, :critical].include?(ActivityHelper.activity_level(data)) || data[:vulnerability_count].to_i.positive?
|
|
119
|
+
end
|
|
120
|
+
|
|
89
121
|
def version_with_date(text:, url:, date:)
|
|
90
122
|
version_part = markdown_url(text: text, url: url)
|
|
91
123
|
return if version_part.nil?
|
|
@@ -117,7 +149,7 @@ module StillActive
|
|
|
117
149
|
def format_license(license)
|
|
118
150
|
return "-" if license.nil? || license.empty?
|
|
119
151
|
|
|
120
|
-
license
|
|
152
|
+
MarkdownEscape.cell(license)
|
|
121
153
|
end
|
|
122
154
|
|
|
123
155
|
def format_vulns(data)
|
|
@@ -130,14 +162,15 @@ module StillActive
|
|
|
130
162
|
ids = vulnerabilities.flat_map { |v| [v[:id], *v[:aliases]] }.compact.uniq.first(3)
|
|
131
163
|
|
|
132
164
|
parts = [severity ? "#{count} (#{severity})" : count.to_s]
|
|
133
|
-
parts << ids.join(", ") unless ids.empty?
|
|
165
|
+
parts << MarkdownEscape.cell(ids.join(", ")) unless ids.empty?
|
|
134
166
|
parts.join(" ")
|
|
135
167
|
end
|
|
136
168
|
|
|
137
169
|
def markdown_url(text:, url:)
|
|
138
|
-
|
|
170
|
+
safe_text = MarkdownEscape.link_text(text)
|
|
171
|
+
return safe_text if url.nil?
|
|
139
172
|
|
|
140
|
-
"[#{
|
|
173
|
+
"[#{safe_text}](#{MarkdownEscape.url(url)})"
|
|
141
174
|
end
|
|
142
175
|
|
|
143
176
|
def year_month(time_object)
|
data/lib/helpers/ruby_helper.rb
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
# frozen_string_literal: true
|
|
2
2
|
|
|
3
3
|
require "time"
|
|
4
|
+
require_relative "bundler_helper"
|
|
4
5
|
require_relative "http_helper"
|
|
5
6
|
require_relative "libyear_helper"
|
|
6
7
|
|
|
@@ -48,10 +49,10 @@ module StillActive
|
|
|
48
49
|
end
|
|
49
50
|
|
|
50
51
|
def lockfile_ruby_version
|
|
51
|
-
gemfile
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
lockfile_path =
|
|
52
|
+
# Use the configured gemfile (honours --gemfile) rather than the ambient
|
|
53
|
+
# BUNDLE_GEMFILE, which only happened to work when BundlerHelper set it as
|
|
54
|
+
# a side-effect. Refs #42.
|
|
55
|
+
lockfile_path = BundlerHelper.lockfile_path_for(File.expand_path(StillActive.config.gemfile_path))
|
|
55
56
|
return unless File.exist?(lockfile_path)
|
|
56
57
|
|
|
57
58
|
content = File.read(lockfile_path)
|