🚨 [security] Update yard 0.9.34 → 0.9.37 (minor)

[depfu]

---

🚨 Your current dependencies have known security vulnerabilities 🚨

This dependency update fixes known security vulnerabilities. Please see the details below and assess their impact carefully. We recommend to merge and deploy this as soon as possible!

---

Here is everything you need to know about this update. Please take a good look at what changed and the test results before merging this pull request.

What changed?

✳️ yard (0.9.34 → 0.9.37) · Repo · Changelog

Security Advisories 🚨

🚨 YARD's default template vulnerable to Cross-site Scripting in generated frames.html

Summary

The "frames.html" file within the Yard Doc's generated documentation is vulnerable to Cross-Site Scripting (XSS) attacks due to inadequate sanitization of user input within the JavaScript segment of the "frames.erb" template file.

Details

The vulnerability stems from mishandling user-controlled data retrieved from the URL hash in the embedded JavaScript code within the "frames.erb" template file. Specifically, the script lacks proper sanitization of the hash data before utilizing it to establish the top-level window's location. This oversight permits an attacker to inject malicious JavaScript payloads through carefully crafted URLs.

Snippet from "frames.erb":
(v0.9.34)

<script type="text/javascript">
  var match = unescape(window.location.hash).match(/^#!(.+)/);
  var name = match ? match[1] : '<%= url_for_main %>';
  name = name.replace(/^(\w+):\/\//, '').replace(/^\/\//, '');
  window.top.location = name;
</script>

(v0.9.35)

<script type="text/javascript">
  var match = decodeURIComponent(window.location.hash).match(/^#!(.+)/);
  var name = match ? match[1] : '<%= url_for_main %>';
  name = name.replace(/^((\w*):)?[\/\\]*/gm, '').trim();
  window.top.location.replace(name)
</script>

PoC (Proof of Concept)

To exploit this vulnerability:

1. Gain access to the generated Yard Doc.
2. Locate and access the "frames.html" file.
3. Construct a URL containing the malicious payload in the hash segment, for instance: #!javascript:xss for v0.9.34, and #:javascript:xss for v0.9.35

Impact

This XSS vulnerability presents a substantial threat by enabling an attacker to execute arbitrary JavaScript code within the user's session context. Potential ramifications include session hijacking, theft of sensitive data, unauthorized access to user accounts, and defacement of websites. Any user visiting the compromised page is susceptible to exploitation. It is critical to promptly address this vulnerability to mitigate potential harm to users and preserve the application's integrity.

Release Notes

0.9.37

• Fix JavaScript errors in --one-file template (#1426)
• Fix heredoc parsing and add support for squiggly heredocs (#1315, #1495)
• Accessibility improvements to the default template (#1501)
• Improved YARD documentation (#1410, #1512, #1516, #1544)
• Fix error when parsing @option tags (#1515)
• Fix issue parsing UTF-8 filenames (#1517)
• Replace OpenStruct with optimized YARD::OpenStruct to avoid ostruct performance warnings (#1545)
• Add support for private attr_* syntax (#1541)
• Remove logger dependency (#1546)

0.9.36

• Further XSS fixes for generated frameset pages (#1538)
• Improve tests for Ruby 3.3 compatibility (#1519, #1531)
• Documentation improvements (#1524)

0.9.35

• Fix possible XSS on generated YARD frameset pages (thanks to @RedYetiDev for finding and patching) (2069e2b).
• Fix errors when using @option on non-method objects (#1508)
• Support Ruby 3.3 changes in Ripper parser (#1510)

Does any of this look wrong? Please let us know.

Commits

See the full diff on Github. The new version differs by 57 commits:

• Update version to 0.9.37
• Update changelog
• Fix styling
• Small visual update
• Fix processing of utf-8 files
• Fix a test and optimize
• Fix issue with defining some openstruct methods
• Replace ostruct with custom version
• Fix test issue with asciidoctor and YARD Logger
• Reorder Logger for documentation
• Remove dependency on logger
• --one-file fixes
• Merge pull request #1516 from ksss/tag-name-nil
• Merge pull request #1495 from dduugg/heredoc-conversion
• Merge pull request #1541 from theodorton/inline-attribute-visibility
• Merge pull request #1501 from mullermp/accessibility
• Support Ruby 3 inline attribute visibility
• Drop Ruby 2.5 as well
• Drop CI for 2.2,2.3,2.4 due to dependency issues
• Merge pull request #1515 from ksss/fix-docsting-parse-error
• Merge pull request #1512 from alvincrespo/docs--readme-link-to-api
• Merge pull request #1544 from jjb/patch-1
• Update README.md
• documentation about markdown providers
• Tag release v0.9.36
• Merge pull request #1538 from RedYetiDev/patch-2
• Fix semicolon
• assign url_for_main to a variable
• Merge pull request #1519 from mtasaka/ruby33_test_fix
• Update frames.erb
• Merge pull request #1524 from frsantos/fix_tuple_docs
• Merge pull request #1531 from rafaelfranca/rm-ruby-3.3
• Tag release v0.9.35
• Prepare changelog
• Update changelog
• Merge pull request from GHSA-8mq4-9jjh-9xrc
• Update frames.erb
• Test with Ruby 3.3
• Fix documentation for order-dependent lists
• TEST: remove invalid yield usage from spec example
• Add doc for Tag#name if no tag name is supplied
• Fix error when docsting is just only `@option`
• Merge pull request #1508 from ksss/non-method-option
• Links YARD::CLI::Yardoc to api reference
• Fix error when `@option` with non-method
• Merge pull request #1510 from MSP-Greg/00-ruby3.3-bom
• Merge pull request #1511 from lsegal/dependabot/github_actions/actions/checkout-4
• Bump actions/checkout from 3 to 4
• Create dependabot.yml
• Parser::SourceParser#convert_encoding - fixup BOM encoding
• Merge pull request #1498 from technicalpickles/patch-1
• Merge pull request #1506 from ksss/base-file-doc
• Base#file might potentially return `nil`.
• Address feedback from AWS accessibility
• Accessibility improvements
• Fix typo in markdown_spec.rb
• Fix heredoc-to-string conversion

---

Depfu will automatically keep this PR conflict-free, as long as you don't add any commits to this branch yourself. You can also trigger a rebase manually by commenting with @depfu rebase.

All Depfu comment commands

@​depfu rebase

Rebases against your default branch and redoes this update

@​depfu recreate

Recreates this PR, overwriting any edits that you've made to it

@​depfu merge

Merges this PR once your tests are passing and conflicts are resolved

@​depfu cancel merge

Cancels automatic merging of this PR

@​depfu close

Closes this PR and deletes the branch

@​depfu reopen

Restores the branch and reopens this PR (if it's closed)

@​depfu pause

Ignores all future updates for this dependency and closes this PR

@​depfu pause [minor|major]

Ignores all future minor/major updates for this dependency and closes this PR

@​depfu resume

Future versions of this dependency will create PRs again (leaves this PR as is)