Ruby/yard/0.9.0
YARD is a documentation generation tool for the Ruby programming language.
It enables the user to generate consistent, usable documentation that can be
exported to a number of formats very easily, and also supports extending for
custom Ruby constructs such as custom class level definitions.
https://rubygems.org/gems/yard
MIT
7 Security Vulnerabilities
yard: Possible arbitrary path traversal and file access via yard server
Impact
A path traversal vulnerability was discovered in YARD <= 0.9.41 when using yard server to serve documentation. This bug would allow unsanitized HTTP requests to access arbitrary files on the machine of a yard server host under certain conditions.
The original patch in GHSA-xfhh-rx56-rxcr was incorrectly applied.
Patches
Please upgrade to YARD v0.9.42 immediately if you are relying on yard server to host documentation in any untrusted environments without WEBrick and rely on --docroot.
Workarounds
For users who cannot upgrade, it is possible to perform path sanitization of HTTP requests at your webserver level. WEBrick, for example, can perform such sanitization by default (which you can use via yard server -s webrick), as can certain rules in your webserver configuration.
YARD's default template vulnerable to Cross-site Scripting in generated frames.html
- https://github.com/lsegal/yard/security/advisories/GHSA-8mq4-9jjh-9xrc
- https://github.com/lsegal/yard/commit/2069e2bf08293bda2fcc78f7d0698af6354054be
- https://nvd.nist.gov/vuln/detail/CVE-2024-27285
- https://github.com/advisories/GHSA-8mq4-9jjh-9xrc
- https://github.com/rubysec/ruby-advisory-db/blob/master/gems/yard/CVE-2024-27285.yml
- https://github.com/lsegal/yard/pull/1538
- https://github.com/lsegal/yard/commit/1fcb2d8b316caf8779cfdcf910715e9ab583f0aa
- https://lists.debian.org/debian-lts-announce/2024/03/msg00006.html
- https://lists.fedoraproject.org/archives/list/package-announce@lists.fedoraproject.org/message/MR3Z2E2UIZZ7YOR7R645EVSBGWMB2RGA
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) erb <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) erb <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.
Arbitrary file read vulnerability in yard server
lib/yard/core_ext/file.rb in the server in YARD before 0.9.11 does not block relative paths with an initial ../ sequence, which allows attackers to conduct directory traversal attacks and read arbitrary files.
Potential arbitrary file read vulnerability in yard server
lib/yard/core_ext/file.rb in the server in YARD before 0.9.11 does not block relative paths with an initial ../ sequence, which allows attackers to conduct directory traversal attacks and read arbitrary files.
Arbitrary path traversal and file access via `yard server`
A path traversal vulnerability was discovered in YARD <= 0.9.19 when using yard server to serve documentation. This bug would allow unsanitized HTTP requests to access arbitrary files on the machine of a yard server host under certain conditions.
The issue is resolved in v0.9.20 and later.
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) erb <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) erb <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>
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.
Possible arbitrary path traversal and file access via `yard server`
A path traversal vulnerability was discovered in YARD <= 0.9.19 when using yard server to serve documentation. This bug would allow unsanitized HTTP requests to access arbitrary files on the machine of a yard server host under certain conditions.
98 Other Versions
| Version | License | Security | Released | |
|---|---|---|---|---|
| 0.9.43 | MIT | 2026-04-18 - 06:14 | 16 days | |
| 0.9.42 | MIT | 2026-04-16 - 20:12 | 18 days | |
| 0.9.41 | MIT | 1 | 2026-04-14 - 16:15 | 20 days |
| 0.9.40 | MIT | 1 | 2026-04-13 - 04:00 | 22 days |
| 0.9.39 | MIT | 1 | 2026-04-08 - 16:39 | 26 days |
| 0.9.38 | MIT | 1 | 2025-12-05 - 20:29 | 5 months |
| 0.9.37 | MIT | 1 | 2024-09-04 - 08:51 | over 1 year |
| 0.9.36 | MIT | 1 | 2024-02-29 - 22:19 | about 2 years |
| 0.9.35 | MIT | 3 | 2024-02-28 - 18:12 | about 2 years |
| 0.9.34 | MIT | 3 | 2023-04-12 - 21:27 | about 3 years |
| 0.9.33 | MIT | 3 | 2023-04-12 - 06:23 | about 3 years |
| 0.9.32 | MIT | 3 | 2023-04-09 - 19:25 | about 3 years |
| 0.9.31 | MIT | 3 | 2023-04-09 - 18:22 | about 3 years |
| 0.9.30 | MIT | 3 | 2023-04-09 - 17:17 | about 3 years |
| 0.9.29 | MIT | 3 | 2023-04-08 - 22:02 | about 3 years |
| 0.9.28 | MIT | 3 | 2022-06-01 - 20:20 | almost 4 years |
| 0.9.27 | MIT | 3 | 2021-11-29 - 22:07 | over 4 years |
| 0.9.26 | MIT | 3 | 2020-12-27 - 00:17 | over 5 years |
| 0.9.25 | MIT | 3 | 2020-05-03 - 21:36 | about 6 years |
| 0.9.24 | MIT | 3 | 2020-01-08 - 18:36 | over 6 years |
| 0.9.23 | MIT | 3 | 2020-01-05 - 19:08 | over 6 years |
| 0.9.22 | MIT | 3 | 2019-12-31 - 20:45 | over 6 years |
| 0.9.21 | MIT | 3 | 2019-12-31 - 20:23 | over 6 years |
| 0.9.20 | MIT | 3 | 2019-06-27 - 23:37 | almost 7 years |
| 0.9.19 | MIT | 5 | 2019-04-02 - 01:28 | about 7 years |
| 0.9.18 | MIT | 5 | 2019-01-22 - 02:07 | over 7 years |
| 0.9.17 | MIT | 5 | 2019-01-22 - 02:01 | over 7 years |
| 0.9.16 | MIT | 5 | 2018-08-11 - 20:39 | over 7 years |
| 0.9.15 | MIT | 5 | 2018-07-18 - 05:09 | almost 8 years |
| 0.9.14 | MIT | 5 | 2018-06-03 - 01:44 | almost 8 years |
| 0.9.13 | MIT | 5 | 2018-05-28 - 22:45 | almost 8 years |
| 0.9.12 | MIT | 5 | 2017-11-26 - 20:39 | over 8 years |
| 0.9.11 | MIT | 5 | 2017-11-23 - 21:48 | over 8 years |
| 0.9.10 | MIT | 7 | 2017-11-18 - 21:52 | over 8 years |
| 0.9.9 | MIT | 7 | 2017-04-23 - 22:05 | about 9 years |
| 0.9.8 | MIT | 7 | 2017-01-13 - 19:57 | over 9 years |
| 0.9.7 | MIT | 7 | 2017-01-10 - 00:16 | over 9 years |
| 0.9.6 | MIT | 7 | 2017-01-07 - 19:40 | over 9 years |
| 0.9.5 | MIT | 7 | 2016-07-22 - 23:22 | almost 10 years |
| 0.9.4 | MIT | 7 | 2016-07-21 - 19:06 | almost 10 years |
| 0.9.3 | MIT | 7 | 2016-07-20 - 22:38 | almost 10 years |
| 0.9.2 | MIT | 7 | 2016-07-19 - 21:27 | almost 10 years |
| 0.9.1 | MIT | 7 | 2016-07-18 - 19:00 | almost 10 years |
| 0.9.0 | MIT | 7 | 2016-07-04 - 19:32 | almost 10 years |
| 0.8.7.6 | MIT | 7 | 2014-10-26 - 22:30 | over 11 years |
| 0.8.7.5 | MIT | 7 | 2014-10-26 - 10:40 | over 11 years |
| 0.8.7.4 | MIT | 7 | 2014-03-22 - 21:48 | about 12 years |
| 0.8.7.3 | MIT | 7 | 2013-11-02 - 00:17 | over 12 years |
| 0.8.7.2 | MIT | 7 | 2013-09-19 - 00:31 | over 12 years |
| 0.8.7.1 | MIT | 7 | 2013-09-12 - 00:32 | over 12 years |
