orb_template 0.1.3 → 0.2.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 +45 -0
- data/README.md +17 -1
- data/docs/2026-03-12-security-analysis.md +715 -0
- data/lib/orb/patterns.rb +1 -1
- data/lib/orb/temple/attributes_compiler.rb +1 -1
- data/lib/orb/temple/compiler.rb +1 -1
- data/lib/orb/temple/filters.rb +39 -1
- data/lib/orb/tokenizer2.rb +22 -5
- data/lib/orb/version.rb +1 -1
- metadata +3 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: cce449d0ac0ab86e9a8bec2e22d3016cbd165bec8dc45f13208609acbc621639
|
|
4
|
+
data.tar.gz: cf2eba65f10e960d939f7cc0f32a405a1c5faa29aec05eb73777b4c02f5ba81a
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: f2874e3e0763b2f00fef23dcc43e01b5b4013429cdf61fba6d82db80127cfce92bf9a755a64d56f4f6b355fa38890da58d5dc82ba54fd40d6b7effca47d63895
|
|
7
|
+
data.tar.gz: 1536a650424e03821225cd9b74745457b620d1f539f56c5d0ad66215ada01e4b2b8068f06cc497771f85844fd33781194bf150f1bced6ee9e810f9dbf0c1d492
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,50 @@
|
|
|
1
1
|
## [Unreleased]
|
|
2
2
|
|
|
3
|
+
## [0.2.0] - 2026-03-12
|
|
4
|
+
|
|
5
|
+
### Security
|
|
6
|
+
|
|
7
|
+
- **CRITICAL**: Prevent code injection via `:for` directive by validating enumerator as a Ruby identifier and rejecting semicolons in collection expressions (`lib/orb/temple/filters.rb`)
|
|
8
|
+
- **HIGH**: Escape dynamic attribute expressions to prevent XSS via unescaped attribute values (`lib/orb/temple/attributes_compiler.rb`)
|
|
9
|
+
- **HIGH**: Validate `:with` directive values as valid Ruby identifiers to prevent code injection in component and slot blocks (`lib/orb/temple/filters.rb`)
|
|
10
|
+
- **HIGH**: Validate dynamic HTML tag names against a strict pattern to prevent code injection through crafted tag names (`lib/orb/temple/filters.rb`)
|
|
11
|
+
- **HIGH**: Validate component names as valid Ruby constant paths before interpolation into generated code (`lib/orb/temple/filters.rb`)
|
|
12
|
+
- **HIGH**: Validate slot names as valid Ruby identifiers before interpolation into `with_` method calls (`lib/orb/temple/filters.rb`)
|
|
13
|
+
- **MEDIUM**: Add maximum brace nesting depth (100) in tokenizer to prevent stack overflow / memory exhaustion from deeply nested expressions (`lib/orb/tokenizer2.rb`)
|
|
14
|
+
- **MEDIUM**: Use `String#inspect` instead of `%q[]` for error message interpolation to prevent delimiter escape attacks (`lib/orb/temple/compiler.rb`)
|
|
15
|
+
- **MEDIUM**: Restrict attribute name pattern to valid HTML attribute characters, preventing injection via malformed attribute names (`lib/orb/patterns.rb`)
|
|
16
|
+
- **LOW**: Add maximum template size limit (2MB) to prevent denial-of-service via oversized templates (`lib/orb/tokenizer2.rb`)
|
|
17
|
+
|
|
18
|
+
### Breaking Changes
|
|
19
|
+
|
|
20
|
+
- Component names are now validated against `VALID_COMPONENT_NAME` (`/\A[A-Z]\w*(::[A-Z]\w*)*\z/`). Components with non-standard names will raise `ORB::SyntaxError`.
|
|
21
|
+
|
|
22
|
+
### Documentation
|
|
23
|
+
|
|
24
|
+
- Added security analysis report (`docs/2026-03-12-security-analysis.md`)
|
|
25
|
+
- Updated README with security information
|
|
26
|
+
|
|
27
|
+
## [0.1.3] - 2026-02-06
|
|
28
|
+
|
|
29
|
+
### Fixed
|
|
30
|
+
|
|
31
|
+
- Components with splat attributes incorrectly rendering as plain HTML tags instead of the component
|
|
32
|
+
|
|
33
|
+
## [0.1.2] - 2026-01-30
|
|
34
|
+
|
|
35
|
+
### Added
|
|
36
|
+
|
|
37
|
+
- Support for splat expressions on HTML elements and components
|
|
38
|
+
|
|
39
|
+
### Changed
|
|
40
|
+
|
|
41
|
+
- Improved error display in the Rails web console
|
|
42
|
+
|
|
43
|
+
### Documentation
|
|
44
|
+
|
|
45
|
+
- Spelling and wording corrections in README
|
|
46
|
+
- Fixed code examples in README
|
|
47
|
+
|
|
3
48
|
## [0.1.1] - 2025-11-28
|
|
4
49
|
|
|
5
50
|
### Changed
|
data/README.md
CHANGED
|
@@ -389,6 +389,7 @@ To enable `Tailwindcss` support for ORB, add this to your `settings.json`:
|
|
|
389
389
|
- [x] `:for` directive
|
|
390
390
|
- [x] verbatim tags
|
|
391
391
|
- [x] ensure output safety and proper escaping of output
|
|
392
|
+
- [x] security review and hardening of compilation pipeline
|
|
392
393
|
- [x] track locations (start_line, start_col, end_line, end_col) for Tokens and AST Nodes to support better error output
|
|
393
394
|
- [x] make Lexer, Parser, Compiler robust to malformed input (e.g., unclosed tags)
|
|
394
395
|
- [ ] emit an warning/error when void tags contain children
|
|
@@ -414,8 +415,23 @@ To enable `Tailwindcss` support for ORB, add this to your `settings.json`:
|
|
|
414
415
|
- [ ] support additional directives, for instance, `Turbo` or `Stimulus` specific directives
|
|
415
416
|
- [ ] support additional block constructs
|
|
416
417
|
- [ ] support additional language constructs
|
|
418
|
+
- [ ] replace `OpenStruct`-based `RenderContext` with a `BasicObject` subclass to reduce attack surface
|
|
419
|
+
- [ ] fuzz testing of tokenizer and parser for edge case discovery
|
|
420
|
+
- [ ] Brakeman integration with custom rules to flag unsafe ORB patterns
|
|
421
|
+
- [ ] tighten `TAG_NAME` pattern at the tokenizer level as defense-in-depth
|
|
417
422
|
|
|
418
|
-
|
|
423
|
+
## Security
|
|
424
|
+
|
|
425
|
+
ORB follows the same trust model as ERB, HAML, and SLIM: templates are developer-authored and loaded from the filesystem. **Never construct ORB templates from user input.**
|
|
426
|
+
|
|
427
|
+
The compilation pipeline has been hardened against code injection, XSS, and denial-of-service attacks:
|
|
428
|
+
|
|
429
|
+
- All values interpolated into generated Ruby code (`:for` expressions, `:with` directives, tag names, component names, slot names) are validated against strict patterns before interpolation.
|
|
430
|
+
- Dynamic attribute values (`class={expr}`) are HTML-escaped at render time, matching the escaping behavior of printing expressions (`{{expr}}`).
|
|
431
|
+
- Attribute names are restricted to valid HTML spec characters.
|
|
432
|
+
- Resource limits are enforced: maximum brace nesting depth (100) and maximum template size (2MB).
|
|
433
|
+
|
|
434
|
+
For details, see [`docs/2026-03-12-security-analysis.md`](docs/2026-03-12-security-analysis.md).
|
|
419
435
|
|
|
420
436
|
## Development
|
|
421
437
|
|
|
@@ -0,0 +1,715 @@
|
|
|
1
|
+
# ORB Template Engine -- Security Analysis
|
|
2
|
+
|
|
3
|
+
**Date:** 2026-03-12
|
|
4
|
+
**Version Reviewed:** 0.1.3
|
|
5
|
+
**Scope:** Tokenizer2, Parser, AST Builder, Temple Compiler, Filters, Attributes Compiler, Rails Template Handler
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## Executive Summary
|
|
10
|
+
|
|
11
|
+
ORB is a JSX-inspired template engine for Ruby/Rails that compiles templates to Ruby code via the Temple pipeline. The overall architecture is sound -- it uses Temple's `:escape` mechanism for auto-escaping `{{...}}` output and avoids direct `eval()` of raw user strings. However, this review identified several vulnerabilities ranging from **critical** to **low** severity, many of which mirror historical CVEs in ERB, HAML, and SLIM template engines.
|
|
12
|
+
|
|
13
|
+
The primary risk areas are:
|
|
14
|
+
|
|
15
|
+
- Code injection through directive values and expressions interpolated into generated Ruby code
|
|
16
|
+
- Missing HTML escaping on dynamic attribute values
|
|
17
|
+
- Insufficient validation of tag names, attribute names, and `:for` expressions
|
|
18
|
+
|
|
19
|
+
Note: Like ERB, HAML, and SLIM, ORB executes arbitrary Ruby in template expressions (`{{...}}` and `{%...%}`). This is by design and follows the same trust model -- templates are developer-authored and loaded from the filesystem. This is documented as informational, not as a vulnerability.
|
|
20
|
+
|
|
21
|
+
---
|
|
22
|
+
|
|
23
|
+
## Data Flow Overview
|
|
24
|
+
|
|
25
|
+
```
|
|
26
|
+
ORB Template Source (text)
|
|
27
|
+
|
|
|
28
|
+
v
|
|
29
|
+
[Tokenizer2] lib/orb/tokenizer2.rb -- Lexical analysis via StringScanner
|
|
30
|
+
|
|
|
31
|
+
v
|
|
32
|
+
Token Stream
|
|
33
|
+
|
|
|
34
|
+
v
|
|
35
|
+
[Parser] lib/orb/parser.rb -- Token-to-AST conversion
|
|
36
|
+
|
|
|
37
|
+
v
|
|
38
|
+
AST (Abstract Syntax Tree)
|
|
39
|
+
|
|
|
40
|
+
v
|
|
41
|
+
[Temple::Compiler] lib/orb/temple/compiler.rb -- AST to Temple IR
|
|
42
|
+
|
|
|
43
|
+
v
|
|
44
|
+
[Temple::Filters] lib/orb/temple/filters.rb -- Component/block handling
|
|
45
|
+
|
|
|
46
|
+
v
|
|
47
|
+
[Temple Pipeline] lib/orb/temple/engine.rb -- Escaping, static analysis, optimization
|
|
48
|
+
|
|
|
49
|
+
v
|
|
50
|
+
Generated Ruby Code
|
|
51
|
+
|
|
|
52
|
+
v
|
|
53
|
+
[Rails ActionView] lib/orb/rails_template.rb -- Template handler execution
|
|
54
|
+
|
|
|
55
|
+
v
|
|
56
|
+
HTML Output
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
Security-sensitive boundaries exist at every stage. The most critical are:
|
|
60
|
+
|
|
61
|
+
1. **Tokenizer -> Parser**: What syntax is accepted and how expressions are delimited
|
|
62
|
+
2. **Compiler -> Filters**: How expressions, directives, and attributes are interpolated into Ruby code
|
|
63
|
+
3. **Filters -> Temple Pipeline**: Whether dynamic values are wrapped in escape directives
|
|
64
|
+
4. **Generated Code -> Rails**: What code executes in the view binding
|
|
65
|
+
|
|
66
|
+
---
|
|
67
|
+
|
|
68
|
+
## INFORMATIONAL Findings
|
|
69
|
+
|
|
70
|
+
### INFO-1: Server-Side Template Injection via `{%...%}` Control Expressions
|
|
71
|
+
|
|
72
|
+
**Location:** `lib/orb/temple/compiler.rb:120-123`
|
|
73
|
+
|
|
74
|
+
Control expressions compile directly to `:code` Temple expressions, allowing arbitrary Ruby execution. This is equivalent to ERB's `<% %>`, HAML's `- code`, and SLIM's `- code` -- it is a fundamental feature of any code-executing template language, not a vulnerability in ORB specifically.
|
|
75
|
+
|
|
76
|
+
Templates are authored by developers and loaded from the filesystem via Rails' template resolver, which restricts to the application's view paths. The same trust model applies as with ERB.
|
|
77
|
+
|
|
78
|
+
**Mitigation:** Document that ORB templates must not be constructed from user input (same guidance as ERB). Long-term, consider Brakeman integration to flag unsafe patterns like `ORB::Template.parse(user_string)`.
|
|
79
|
+
|
|
80
|
+
---
|
|
81
|
+
|
|
82
|
+
### INFO-2: Server-Side Template Injection via `{{...}}` Printing Expressions
|
|
83
|
+
|
|
84
|
+
**Location:** `lib/orb/temple/compiler.rb:109`
|
|
85
|
+
|
|
86
|
+
Printing expressions execute arbitrary Ruby in the template binding (output is HTML-escaped). This is equivalent to ERB's `<%= %>`. Same trust model as INFO-1 applies.
|
|
87
|
+
|
|
88
|
+
**Mitigation:** Documentation only. Same as ERB.
|
|
89
|
+
|
|
90
|
+
---
|
|
91
|
+
|
|
92
|
+
### INFO-3: Error Messages Expose Internal Tokenizer State
|
|
93
|
+
|
|
94
|
+
**Location:** `lib/orb/tokenizer2.rb:617`
|
|
95
|
+
|
|
96
|
+
Error messages include internal tokenizer state names (`:printing_expression`, `:control_expression`, etc.). In development mode, this is intentional and helpful for debugging -- the same behavior as ERB, HAML, and SLIM. In production, Rails rescues exceptions and shows a generic error page, so these details are only visible in server logs (which are already privileged).
|
|
97
|
+
|
|
98
|
+
**Mitigation:** Standard Rails error handling. Only a concern if the application is misconfigured to expose exception details in production responses.
|
|
99
|
+
|
|
100
|
+
---
|
|
101
|
+
|
|
102
|
+
## CRITICAL Findings
|
|
103
|
+
|
|
104
|
+
### CRITICAL-1: Code Injection via `:for` Directive Expression Splitting
|
|
105
|
+
|
|
106
|
+
**Location:** `lib/orb/temple/filters.rb:109-116`
|
|
107
|
+
|
|
108
|
+
The `:for` block handler uses a naive `split(' in ')` to separate the iterator variable from the collection:
|
|
109
|
+
|
|
110
|
+
```ruby
|
|
111
|
+
# lib/orb/temple/filters.rb:110-111
|
|
112
|
+
def on_orb_for(expression, content)
|
|
113
|
+
enumerator, collection = expression.split(' in ')
|
|
114
|
+
code = "#{collection}.each do |#{enumerator}|"
|
|
115
|
+
```
|
|
116
|
+
|
|
117
|
+
Both `enumerator` and `collection` are interpolated into a Ruby code string without validation. A crafted `:for` expression can inject arbitrary code:
|
|
118
|
+
|
|
119
|
+
```orb
|
|
120
|
+
{#for x in [1]; system("pwned"); [2]}
|
|
121
|
+
...
|
|
122
|
+
{/for}
|
|
123
|
+
```
|
|
124
|
+
|
|
125
|
+
This generates: `[1]; system("pwned"); [2].each do |x|`
|
|
126
|
+
|
|
127
|
+
The `enumerator` side is also injectable:
|
|
128
|
+
|
|
129
|
+
```orb
|
|
130
|
+
{#for x| ; system("pwned") ; |y in items}
|
|
131
|
+
```
|
|
132
|
+
|
|
133
|
+
**Impact:** Arbitrary code execution via crafted template source.
|
|
134
|
+
|
|
135
|
+
**Recommendation:** Parse and validate the `:for` expression with a strict regex that only allows `variable_name in expression` patterns, where `variable_name` must be a valid Ruby identifier. Additionally, reject semicolons in the collection expression to prevent statement injection.
|
|
136
|
+
|
|
137
|
+
**Mitigation (applied):** In `lib/orb/temple/filters.rb:109-121`, the `on_orb_for` method now uses a strict regex to parse the `:for` expression and rejects semicolons in the collection:
|
|
138
|
+
|
|
139
|
+
```ruby
|
|
140
|
+
# Before
|
|
141
|
+
def on_orb_for(expression, content)
|
|
142
|
+
enumerator, collection = expression.split(' in ')
|
|
143
|
+
code = "#{collection}.each do |#{enumerator}|"
|
|
144
|
+
|
|
145
|
+
# After
|
|
146
|
+
def on_orb_for(expression, content)
|
|
147
|
+
match = expression.match(/\A\s*([a-z_]\w*)\s+in\s+(.+)\z/m)
|
|
148
|
+
raise ORB::SyntaxError.new("Invalid :for expression: enumerator must be a valid Ruby identifier", 0) unless match
|
|
149
|
+
|
|
150
|
+
enumerator, collection = match[1], match[2]
|
|
151
|
+
|
|
152
|
+
if collection.include?(';')
|
|
153
|
+
raise ORB::SyntaxError.new("Invalid :for collection expression: semicolons are not allowed", 0)
|
|
154
|
+
end
|
|
155
|
+
|
|
156
|
+
code = "#{collection}.each do |#{enumerator}|"
|
|
157
|
+
```
|
|
158
|
+
|
|
159
|
+
The enumerator is now validated as a Ruby identifier (`[a-z_]\w*`), preventing pipe-delimiter injection. The collection is checked for semicolons, preventing statement injection. Both attack vectors now raise `ORB::SyntaxError` at compile time. Normal `:for` usage (`{#for item in items}`) is unaffected.
|
|
160
|
+
|
|
161
|
+
**Evidence:** All 4 CRITICAL-1 tests now pass. Full test suite (123 runs) shows 14 expected failures for unmitigated findings, 0 errors, 0 regressions.
|
|
162
|
+
|
|
163
|
+
---
|
|
164
|
+
|
|
165
|
+
## HIGH Findings
|
|
166
|
+
|
|
167
|
+
### HIGH-1: XSS via Unescaped Dynamic Attribute Values
|
|
168
|
+
|
|
169
|
+
**Location:** `lib/orb/temple/attributes_compiler.rb:91-93`
|
|
170
|
+
**Analogous CVEs:** CVE-2017-1002201 (HAML attribute XSS), CVE-2016-6316 (Rails Action View attribute XSS)
|
|
171
|
+
|
|
172
|
+
Dynamic attribute expressions are emitted as `[:dynamic, ...]` without an explicit `[:escape, true, ...]` wrapper:
|
|
173
|
+
|
|
174
|
+
```ruby
|
|
175
|
+
# lib/orb/temple/attributes_compiler.rb:91-93
|
|
176
|
+
elsif attribute.expression?
|
|
177
|
+
[:html, :attr, attribute.name, [:dynamic, attribute.value]]
|
|
178
|
+
end
|
|
179
|
+
```
|
|
180
|
+
|
|
181
|
+
Compare with printing expressions which always use `[:escape, true, [:dynamic, ...]]` (compiler.rb:109).
|
|
182
|
+
|
|
183
|
+
Whether this is safe depends on Temple's downstream `Escapable` filter configuration and how `[:html, :attr, ...]` is processed. If the value is not escaped by the pipeline, an attacker could inject through attribute context:
|
|
184
|
+
|
|
185
|
+
```orb
|
|
186
|
+
<div class={user_input}>
|
|
187
|
+
<!-- if user_input = '"><script>alert(1)</script><div class="' -->
|
|
188
|
+
<!-- renders: <div class=""><script>alert(1)</script><div class=""> -->
|
|
189
|
+
```
|
|
190
|
+
|
|
191
|
+
**Impact:** Cross-site scripting (XSS) if dynamic attribute values are not escaped by the Temple pipeline. Unlike the template-authoring-only findings, this is exploitable at **runtime** through malicious data in any variable used in a dynamic attribute -- no template source compromise required.
|
|
192
|
+
|
|
193
|
+
**Recommendation:** Explicitly wrap dynamic attribute values: `[:html, :attr, attribute.name, [:escape, true, [:dynamic, attribute.value]]]`
|
|
194
|
+
|
|
195
|
+
**Mitigation (applied):** In `lib/orb/temple/attributes_compiler.rb:92`, the `compile_attribute` method now wraps expression attributes with `[:escape, true, ...]`:
|
|
196
|
+
|
|
197
|
+
```ruby
|
|
198
|
+
# Before
|
|
199
|
+
[:html, :attr, attribute.name, [:dynamic, attribute.value]]
|
|
200
|
+
|
|
201
|
+
# After
|
|
202
|
+
[:html, :attr, attribute.name, [:escape, true, [:dynamic, attribute.value]]]
|
|
203
|
+
```
|
|
204
|
+
|
|
205
|
+
This causes Temple's `Escapable` filter to emit `::Temple::Utils.escape_html(...)` around dynamic attribute values, matching the escaping behavior already applied to printing expressions (`{{...}}`). Static and boolean attributes are unaffected. Existing assertions in `test/temple_compiler_test.rb` were updated to expect the new escaped IR.
|
|
206
|
+
|
|
207
|
+
**Evidence:** `test_dynamic_attribute_value_is_escaped` now passes. Full test suite (123 runs) shows no regressions beyond the 18 expected security test failures for unmitigated findings.
|
|
208
|
+
|
|
209
|
+
---
|
|
210
|
+
|
|
211
|
+
### HIGH-2: Code Injection via `:with` Directive in Block Parameters
|
|
212
|
+
|
|
213
|
+
**Location:** `lib/orb/temple/filters.rb:37, 46, 80, 83`
|
|
214
|
+
|
|
215
|
+
The `:with` directive value is used directly as a Ruby block parameter name without validation:
|
|
216
|
+
|
|
217
|
+
```ruby
|
|
218
|
+
# lib/orb/temple/filters.rb:37
|
|
219
|
+
block_name = node.directives.fetch(:with, block_name)
|
|
220
|
+
# ...
|
|
221
|
+
# lib/orb/temple/filters.rb:46
|
|
222
|
+
code = "render #{komponent_name}.new(#{args}) do |#{block_name}|"
|
|
223
|
+
```
|
|
224
|
+
|
|
225
|
+
A crafted `:with` directive can inject code into the block parameter position:
|
|
226
|
+
|
|
227
|
+
```orb
|
|
228
|
+
<MyComponent :with="x| ; system('pwned') ; |y">
|
|
229
|
+
```
|
|
230
|
+
|
|
231
|
+
Generates: `render MyComponent.new() do |x| ; system('pwned') ; |y|`
|
|
232
|
+
|
|
233
|
+
The same vulnerability exists in slot rendering (filters.rb:80-83).
|
|
234
|
+
|
|
235
|
+
**Impact:** Arbitrary code execution via crafted template source.
|
|
236
|
+
|
|
237
|
+
**Recommendation:** Validate that `:with` values match `/\A[a-z_][a-zA-Z0-9_]*\z/` (valid Ruby identifier).
|
|
238
|
+
|
|
239
|
+
**Mitigation (applied):** In `lib/orb/temple/filters.rb`, both `on_orb_component` and `on_orb_slot` now validate the block name after resolving the `:with` directive:
|
|
240
|
+
|
|
241
|
+
```ruby
|
|
242
|
+
block_name = node.directives.fetch(:with, block_name)
|
|
243
|
+
unless block_name.match?(/\A[a-z_]\w*\z/)
|
|
244
|
+
raise ORB::SyntaxError.new("Invalid :with directive value: must be a valid Ruby identifier", 0)
|
|
245
|
+
end
|
|
246
|
+
```
|
|
247
|
+
|
|
248
|
+
This validation applies to both explicit `:with` values and the auto-generated default block names, providing defense-in-depth against malicious tag/slot names that produce invalid default identifiers (also catches HIGH-4 and HIGH-5 attack vectors as a side effect).
|
|
249
|
+
|
|
250
|
+
**Evidence:** `test_with_directive_component_injection_is_rejected` and `test_with_directive_slot_injection_is_rejected` now pass. Full test suite (86 non-security runs) shows no regressions.
|
|
251
|
+
|
|
252
|
+
---
|
|
253
|
+
|
|
254
|
+
### HIGH-3: Unsafe Tag Name Interpolation in Dynamic Tags
|
|
255
|
+
|
|
256
|
+
**Location:** `lib/orb/temple/filters.rb:130`
|
|
257
|
+
|
|
258
|
+
```ruby
|
|
259
|
+
code = "content_tag('#{node.tag}', #{splats}) do"
|
|
260
|
+
```
|
|
261
|
+
|
|
262
|
+
The tag name is interpolated into a single-quoted Ruby string. The `TAG_NAME` pattern (`[^\s>/=$]+` in patterns.rb:6) allows single quotes, semicolons, and parentheses. Since spaces are not allowed in tag names, the injection must be crafted without spaces:
|
|
263
|
+
|
|
264
|
+
```orb
|
|
265
|
+
<div');system(:pwned);content_tag('x **{attrs}>content</div');system(:pwned);content_tag('x>
|
|
266
|
+
```
|
|
267
|
+
|
|
268
|
+
This generates:
|
|
269
|
+
|
|
270
|
+
```ruby
|
|
271
|
+
content_tag('div');system(:pwned);content_tag('x', **attrs) do
|
|
272
|
+
```
|
|
273
|
+
|
|
274
|
+
**Impact:** Arbitrary code execution via crafted tag name in templates using splat attributes.
|
|
275
|
+
|
|
276
|
+
**Recommendation:** Validate tag names against a strict pattern (alphanumeric, hyphens, dots, colons only) before interpolating into generated code.
|
|
277
|
+
|
|
278
|
+
**Mitigation (applied):** In `lib/orb/temple/filters.rb`, a `VALID_HTML_TAG_NAME` constant (`/\A[a-zA-Z][a-zA-Z0-9-]*\z/`) is declared and checked in `on_orb_dynamic` before the tag name is interpolated:
|
|
279
|
+
|
|
280
|
+
```ruby
|
|
281
|
+
VALID_HTML_TAG_NAME = /\A[a-zA-Z][a-zA-Z0-9-]*\z/
|
|
282
|
+
|
|
283
|
+
# In on_orb_dynamic, HTML tag branch:
|
|
284
|
+
unless node.tag.match?(VALID_HTML_TAG_NAME)
|
|
285
|
+
raise ORB::SyntaxError.new("Invalid tag name: #{node.tag.inspect}", 0)
|
|
286
|
+
end
|
|
287
|
+
```
|
|
288
|
+
|
|
289
|
+
This allows standard HTML tags (`div`, `h1`, `my-element`) but rejects quotes, semicolons, parentheses, and other characters that could break out of the generated string literal. Components and slots are dispatched before this branch and are not affected.
|
|
290
|
+
|
|
291
|
+
**Evidence:** `test_dynamic_tag_name_injection_is_rejected` and `test_dynamic_tag_name_with_quote_is_rejected` now pass. Full test suite (86 non-security runs) shows no regressions.
|
|
292
|
+
|
|
293
|
+
---
|
|
294
|
+
|
|
295
|
+
### HIGH-4: Unvalidated Component Name Used as Ruby Constant
|
|
296
|
+
|
|
297
|
+
**Location:** `lib/orb/temple/filters.rb:32-34`
|
|
298
|
+
|
|
299
|
+
```ruby
|
|
300
|
+
name = node.tag.gsub('.', '::')
|
|
301
|
+
komponent = ORB.lookup_component(name)
|
|
302
|
+
komponent_name = komponent || name # Falls back to raw tag name
|
|
303
|
+
```
|
|
304
|
+
|
|
305
|
+
If a component is not found via `lookup_component`, the raw tag name (with `.` replaced by `::`) is used directly in a `render` call:
|
|
306
|
+
|
|
307
|
+
```ruby
|
|
308
|
+
code = "render #{komponent_name}.new(#{args}) do |#{block_name}|"
|
|
309
|
+
```
|
|
310
|
+
|
|
311
|
+
This can be exploited to call arbitrary methods by leveraging the `.new()` chain. The `TAG_NAME` pattern allows parentheses, so a component name like `Kernel.exit(1)` generates:
|
|
312
|
+
|
|
313
|
+
```ruby
|
|
314
|
+
render Kernel::exit(1).new() do |...|
|
|
315
|
+
```
|
|
316
|
+
|
|
317
|
+
`Kernel::exit(1)` executes immediately (terminating the process) before `.new()` is ever reached.
|
|
318
|
+
|
|
319
|
+
**Impact:** Arbitrary method calls on any Ruby constant reachable in the namespace. Process termination, code execution, or other side effects depending on the target class/method.
|
|
320
|
+
|
|
321
|
+
**Recommendation:** Validate that resolved component names only contain expected characters (`A-Z`, `a-z`, `0-9`, `::`) and optionally maintain an allowlist of component namespaces.
|
|
322
|
+
|
|
323
|
+
**Mitigation (applied):** In `lib/orb/temple/filters.rb`, a `VALID_COMPONENT_NAME` constant (`/\A[A-Z]\w*(::[A-Z]\w*)*\z/`) is declared and checked in `on_orb_component` after name resolution:
|
|
324
|
+
|
|
325
|
+
```ruby
|
|
326
|
+
VALID_COMPONENT_NAME = /\A[A-Z]\w*(::[A-Z]\w*)*\z/
|
|
327
|
+
|
|
328
|
+
# In on_orb_component:
|
|
329
|
+
komponent_name = komponent || name
|
|
330
|
+
unless komponent_name.match?(VALID_COMPONENT_NAME)
|
|
331
|
+
raise ORB::SyntaxError.new("Invalid component name: #{komponent_name.inspect}", 0)
|
|
332
|
+
end
|
|
333
|
+
```
|
|
334
|
+
|
|
335
|
+
This allows `Card`, `Demo::Card`, `UI::Forms::Input` but rejects names containing parentheses, semicolons, or lowercase-starting segments. The validation runs on the *resolved* name (after `lookup_component`), covering both the lookup result and the raw fallback.
|
|
336
|
+
|
|
337
|
+
**Breaking change:** Templates using `<Foo::bar>` style slot syntax will now raise a `SyntaxError`. The canonical slot syntax `<Foo:Bar>` should be used instead.
|
|
338
|
+
|
|
339
|
+
**Evidence:** `test_component_name_method_call_injection_is_rejected` and `test_component_name_semicolon_injection_is_rejected` pass (now with proper validation, not just the HIGH-2 side effect). The `:with` bypass is also blocked. Full test suite (86 non-security runs) shows no regressions.
|
|
340
|
+
|
|
341
|
+
---
|
|
342
|
+
|
|
343
|
+
### HIGH-5: Code Injection via Unvalidated Slot Names
|
|
344
|
+
|
|
345
|
+
**Location:** `lib/orb/temple/filters.rb:78-83`
|
|
346
|
+
|
|
347
|
+
Slot names are derived from the tag name portion after `:` (e.g. `Card:Header` -> slot `header`) and interpolated into a method call without validation:
|
|
348
|
+
|
|
349
|
+
```ruby
|
|
350
|
+
# lib/orb/temple/filters.rb:78-83
|
|
351
|
+
slot_name = node.slot # tag.split(':').last.underscore
|
|
352
|
+
code = "#{parent_name}.with_#{slot_name}(#{args}) do |#{block_name}|"
|
|
353
|
+
```
|
|
354
|
+
|
|
355
|
+
The `TAG_NAME` pattern (`[^\s>/=$]+`) allows semicolons, parentheses, and other characters that are not valid in Ruby method names. A crafted slot name can inject arbitrary code:
|
|
356
|
+
|
|
357
|
+
```orb
|
|
358
|
+
<Card><Card:Foo();system(1);x>content</Card:Foo();system(1);x></Card>
|
|
359
|
+
```
|
|
360
|
+
|
|
361
|
+
This generates:
|
|
362
|
+
|
|
363
|
+
```ruby
|
|
364
|
+
__orb__card.with_foo();system(1);x() do |__orb__foo();system(1);x|
|
|
365
|
+
```
|
|
366
|
+
|
|
367
|
+
The `with_foo()` call closes normally, then `system(1)` executes, then `x()` begins a new expression that absorbs the rest of the generated code.
|
|
368
|
+
|
|
369
|
+
**Impact:** Arbitrary code execution via crafted template source.
|
|
370
|
+
|
|
371
|
+
**Recommendation:** Validate slot names against a strict pattern (valid Ruby identifier: `/\A[a-z_][a-zA-Z0-9_]*\z/`) after extraction from the tag name.
|
|
372
|
+
|
|
373
|
+
**Mitigation (applied):** In `lib/orb/temple/filters.rb`, a `VALID_SLOT_NAME` constant (`/\A[a-z_]\w*\z/`) is declared and checked in `on_orb_slot` after extracting the slot name:
|
|
374
|
+
|
|
375
|
+
```ruby
|
|
376
|
+
VALID_SLOT_NAME = /\A[a-z_]\w*\z/
|
|
377
|
+
|
|
378
|
+
# In on_orb_slot:
|
|
379
|
+
slot_name = node.slot
|
|
380
|
+
unless slot_name.match?(VALID_SLOT_NAME)
|
|
381
|
+
raise ORB::SyntaxError.new("Invalid slot name: #{slot_name.inspect}", 0)
|
|
382
|
+
end
|
|
383
|
+
```
|
|
384
|
+
|
|
385
|
+
This allows `header`, `side_bar`, `footer_content` but rejects parentheses, semicolons, and anything that isn't a plain Ruby identifier. The validation is independent of the HIGH-2 `:with` check, so it cannot be bypassed by supplying a valid `:with` directive.
|
|
386
|
+
|
|
387
|
+
**Evidence:** `test_slot_name_semicolon_injection_is_rejected` and `test_slot_name_with_parens_is_rejected` pass. The `:with` bypass is also blocked. Full test suite (86 non-security runs) shows no regressions.
|
|
388
|
+
|
|
389
|
+
---
|
|
390
|
+
|
|
391
|
+
## MEDIUM Findings
|
|
392
|
+
|
|
393
|
+
### MEDIUM-1: Denial of Service via Unbounded Brace Nesting
|
|
394
|
+
|
|
395
|
+
**Location:** `lib/orb/tokenizer2.rb:260-284`
|
|
396
|
+
|
|
397
|
+
The brace-tracking mechanism (`@braces` array) has no depth limit. A malicious template with deeply nested braces consumes unbounded memory:
|
|
398
|
+
|
|
399
|
+
```
|
|
400
|
+
{{ {{{{{{{{{{{...millions of opening braces...}}}}}}}}}}} }}
|
|
401
|
+
```
|
|
402
|
+
|
|
403
|
+
**Impact:** Memory exhaustion, denial of service.
|
|
404
|
+
|
|
405
|
+
**Recommendation:** Enforce a maximum nesting depth (e.g., 100 levels) and raise a `SyntaxError` when exceeded.
|
|
406
|
+
|
|
407
|
+
**Mitigation (applied):** In `lib/orb/tokenizer2.rb`, a `MAX_BRACE_DEPTH` constant (100) is declared and enforced via a `push_brace` helper that replaces all direct `@braces << "{"` calls:
|
|
408
|
+
|
|
409
|
+
```ruby
|
|
410
|
+
MAX_BRACE_DEPTH = 100
|
|
411
|
+
|
|
412
|
+
def push_brace
|
|
413
|
+
if @braces.length >= MAX_BRACE_DEPTH
|
|
414
|
+
raise ORB::SyntaxError.new("Maximum brace nesting depth (#{MAX_BRACE_DEPTH}) exceeded", @line)
|
|
415
|
+
end
|
|
416
|
+
@braces << "{"
|
|
417
|
+
end
|
|
418
|
+
```
|
|
419
|
+
|
|
420
|
+
All 5 brace-push sites in the tokenizer (`next_in_attribute_value_expression`, `next_in_splat_attribute_expression`, `next_in_block_open_content`, `next_in_printing_expression`, `next_in_control_expression`) now call `push_brace` instead of pushing directly. Moderate nesting (e.g., nested hashes) works fine; only pathological depths are rejected.
|
|
421
|
+
|
|
422
|
+
**Evidence:** `test_deeply_nested_braces_in_expression_raises_error` and `test_deeply_nested_braces_in_attribute_raises_error` now pass. `test_moderate_brace_nesting_works` remains green. Full test suite (86 non-security runs) shows no regressions.
|
|
423
|
+
|
|
424
|
+
---
|
|
425
|
+
|
|
426
|
+
### MEDIUM-2: OpenStruct-based RenderContext Exposes Introspection
|
|
427
|
+
|
|
428
|
+
**Location:** `lib/orb/render_context.rb:26`
|
|
429
|
+
|
|
430
|
+
```ruby
|
|
431
|
+
OpenStruct.new(@assigns).instance_eval { binding }
|
|
432
|
+
```
|
|
433
|
+
|
|
434
|
+
`OpenStruct` inherits from `Object`, exposing all `Object` methods to template expressions:
|
|
435
|
+
|
|
436
|
+
```
|
|
437
|
+
{{ self.class }} # => OpenStruct
|
|
438
|
+
{{ self.class.ancestors }} # => full class hierarchy
|
|
439
|
+
{{ instance_variable_get(:@table) }} # => all assigns as hash
|
|
440
|
+
{{ self.methods.sort }} # => available methods
|
|
441
|
+
{{ self.send(:system, "id") }} # => command execution via send
|
|
442
|
+
```
|
|
443
|
+
|
|
444
|
+
**Impact:** Template expressions (in the standalone `Template` class path) can introspect and exploit the full Ruby object model.
|
|
445
|
+
|
|
446
|
+
**Recommendation:** Use a `BasicObject` subclass instead of `OpenStruct` to minimize the available attack surface. Only expose explicitly allowed methods.
|
|
447
|
+
|
|
448
|
+
---
|
|
449
|
+
|
|
450
|
+
### MEDIUM-3: `runtime_error` String Delimiter Breakout
|
|
451
|
+
|
|
452
|
+
**Location:** `lib/orb/temple/compiler.rb:199`
|
|
453
|
+
|
|
454
|
+
```ruby
|
|
455
|
+
temple << [:code, %[raise ORB::Error.new(%q[#{error.message}], #{error.line.inspect})]]
|
|
456
|
+
```
|
|
457
|
+
|
|
458
|
+
Error messages are interpolated into a `%q[...]` string literal. The `%q[]` delimiter uses square brackets, meaning an error message containing `]` would prematurely close the string, potentially allowing code injection via crafted error messages.
|
|
459
|
+
|
|
460
|
+
**Impact:** If an attacker can trigger a specific error message containing `]`, the generated code could be malformed or injectable.
|
|
461
|
+
|
|
462
|
+
**Recommendation:** Use a delimiter that cannot appear in error messages (e.g., `%q{...}` with brace counting, or properly escape the content), or use `String#inspect` to safely serialize the message.
|
|
463
|
+
|
|
464
|
+
**Mitigation (applied):** In `lib/orb/temple/compiler.rb:199`, replaced `%q[#{error.message}]` with `#{error.message.inspect}`:
|
|
465
|
+
|
|
466
|
+
```ruby
|
|
467
|
+
# Before
|
|
468
|
+
temple << [:code, %[raise ORB::Error.new(%q[#{error.message}], #{error.line.inspect})]]
|
|
469
|
+
|
|
470
|
+
# After
|
|
471
|
+
temple << [:code, "raise ORB::Error.new(#{error.message.inspect}, #{error.line.inspect})"]
|
|
472
|
+
```
|
|
473
|
+
|
|
474
|
+
`String#inspect` produces a properly escaped double-quoted Ruby string literal. Any `]`, `"`, `\`, or other special characters are escaped, making delimiter breakout impossible. The generated code is always a single valid `raise` statement.
|
|
475
|
+
|
|
476
|
+
**Evidence:** `test_runtime_error_with_bracket_produces_valid_ruby` and `test_runtime_error_code_injection_is_rejected` now pass. Full test suite (86 non-security runs) shows no regressions.
|
|
477
|
+
|
|
478
|
+
---
|
|
479
|
+
|
|
480
|
+
### MEDIUM-4: Attribute Name Injection
|
|
481
|
+
|
|
482
|
+
**Location:** `lib/orb/patterns.rb:7`
|
|
483
|
+
|
|
484
|
+
```ruby
|
|
485
|
+
ATTRIBUTE_NAME = %r{[^\s>/=]+}
|
|
486
|
+
```
|
|
487
|
+
|
|
488
|
+
This pattern allows nearly any character in attribute names, including:
|
|
489
|
+
|
|
490
|
+
- Event handlers: `onclick`, `onmouseover`, `onfocus`
|
|
491
|
+
- Quote characters: `"`, `'` (could break attribute context)
|
|
492
|
+
- Backticks, semicolons, and other special characters
|
|
493
|
+
|
|
494
|
+
**Analogous CVE:** CVE-2017-1002201 (HAML attribute injection via unescaped characters)
|
|
495
|
+
|
|
496
|
+
While ORB templates are typically authored by developers (not end users), the permissive pattern means:
|
|
497
|
+
|
|
498
|
+
1. No compile-time validation catches typos that could be security-relevant
|
|
499
|
+
2. If attribute names ever come from dynamic sources (e.g., splat attributes), injection is possible
|
|
500
|
+
|
|
501
|
+
**Recommendation:** Restrict `ATTRIBUTE_NAME` to valid HTML attribute characters: `/[a-zA-Z_:][-a-zA-Z0-9_:.]*` per the HTML spec, or at minimum disallow quotes and backticks.
|
|
502
|
+
|
|
503
|
+
**Mitigation (applied):** In `lib/orb/patterns.rb:7`, replaced the permissive pattern with a strict HTML-spec-compliant one:
|
|
504
|
+
|
|
505
|
+
```ruby
|
|
506
|
+
# Before
|
|
507
|
+
ATTRIBUTE_NAME = %r{[^\s>/=]+}
|
|
508
|
+
|
|
509
|
+
# After
|
|
510
|
+
ATTRIBUTE_NAME = %r{[a-zA-Z_:][-a-zA-Z0-9_:.]*}
|
|
511
|
+
```
|
|
512
|
+
|
|
513
|
+
This allows standard attribute names (`class`, `data-value`, `aria-label`, `xml:lang`) and ORB directives (`:for`, `:with`) while rejecting quotes, backticks, semicolons, and other characters that could break HTML attribute context. Invalid characters in attribute position are now silently ignored by the tokenizer (the scanner won't match them as attribute names).
|
|
514
|
+
|
|
515
|
+
**Evidence:** `test_attribute_name_with_single_quote_is_rejected`, `test_attribute_name_with_backtick_is_rejected`, and `test_attribute_name_with_double_quote_is_rejected` all pass. `test_valid_attribute_names_compile_correctly` remains green. Full test suite (86 non-security runs) shows no regressions.
|
|
516
|
+
|
|
517
|
+
---
|
|
518
|
+
|
|
519
|
+
## LOW Findings
|
|
520
|
+
|
|
521
|
+
### LOW-1: Verbatim Mode Bypasses All Processing
|
|
522
|
+
|
|
523
|
+
**Location:** `lib/orb/tokenizer2.rb:146-152`
|
|
524
|
+
|
|
525
|
+
The `$>` closing syntax enables verbatim mode, where content passes through without any processing or escaping:
|
|
526
|
+
|
|
527
|
+
```orb
|
|
528
|
+
<script$>
|
|
529
|
+
var x = "user controlled data here passes through raw";
|
|
530
|
+
</script>
|
|
531
|
+
```
|
|
532
|
+
|
|
533
|
+
This is intentional behavior for `<script>` and `<style>` tags, but developers unfamiliar with ORB may not realize that verbatim content is never escaped.
|
|
534
|
+
|
|
535
|
+
**Recommendation:** Document this behavior clearly. Consider requiring an explicit opt-in rather than a syntactic marker.
|
|
536
|
+
|
|
537
|
+
---
|
|
538
|
+
|
|
539
|
+
### LOW-2: Public Comments Pass Content as Static (Unescaped)
|
|
540
|
+
|
|
541
|
+
**Location:** `lib/orb/temple/compiler.rb:155`
|
|
542
|
+
|
|
543
|
+
```ruby
|
|
544
|
+
def transform_public_comment_node(node, _context)
|
|
545
|
+
[:html, :comment, [:static, node.text]]
|
|
546
|
+
end
|
|
547
|
+
```
|
|
548
|
+
|
|
549
|
+
Comment text is emitted as `[:static, ...]`. If comment content somehow contains `-->`, it could break out of the HTML comment context. However, since the tokenizer terminates comment parsing at `-->`, the text content would not contain this sequence under normal operation.
|
|
550
|
+
|
|
551
|
+
**Impact:** Minimal under current tokenizer behavior. Only relevant if the tokenizer is bypassed or modified.
|
|
552
|
+
|
|
553
|
+
---
|
|
554
|
+
|
|
555
|
+
### LOW-3: No Template Size Limit
|
|
556
|
+
|
|
557
|
+
**Location:** `lib/orb/tokenizer2.rb:26-27`
|
|
558
|
+
|
|
559
|
+
```ruby
|
|
560
|
+
def initialize(source, options = {})
|
|
561
|
+
@source = StringScanner.new(source)
|
|
562
|
+
```
|
|
563
|
+
|
|
564
|
+
There is no limit on template source size. An extremely large template could cause excessive memory usage and CPU consumption during tokenization.
|
|
565
|
+
|
|
566
|
+
**Recommendation:** Consider enforcing a configurable maximum template size.
|
|
567
|
+
|
|
568
|
+
**Mitigation (applied):** In `lib/orb/tokenizer2.rb`, a `MAX_TEMPLATE_SIZE` constant (2MB) is declared and checked at the start of `tokenize`:
|
|
569
|
+
|
|
570
|
+
```ruby
|
|
571
|
+
MAX_TEMPLATE_SIZE = 2 * 1024 * 1024 # 2MB
|
|
572
|
+
|
|
573
|
+
def tokenize
|
|
574
|
+
if @source.string.bytesize > MAX_TEMPLATE_SIZE
|
|
575
|
+
raise ORB::SyntaxError.new("Template exceeds maximum size (#{MAX_TEMPLATE_SIZE} bytes)", 0)
|
|
576
|
+
end
|
|
577
|
+
# ...
|
|
578
|
+
```
|
|
579
|
+
|
|
580
|
+
2MB is generous for any real template while preventing abuse. Templates exceeding this limit are rejected before any scanning begins.
|
|
581
|
+
|
|
582
|
+
**Evidence:** `test_large_template_has_size_limit` now passes. `test_normal_sized_template_works` remains green. Full test suite (86 non-security runs) shows no regressions.
|
|
583
|
+
|
|
584
|
+
---
|
|
585
|
+
|
|
586
|
+
### LOW-4: Potential ReDoS in Block Detection Regex
|
|
587
|
+
|
|
588
|
+
**Location:** `lib/orb/ast/printing_expression_node.rb:7`
|
|
589
|
+
|
|
590
|
+
```ruby
|
|
591
|
+
BLOCK_RE = /\A(if|unless)\b|\bdo\s*(\|[^|]*\|)?\s*$/
|
|
592
|
+
```
|
|
593
|
+
|
|
594
|
+
The `\s*` quantifiers combined with `$` could cause quadratic backtracking on inputs with many trailing whitespace characters followed by a non-matching character. The practical impact is limited because expression values are typically short.
|
|
595
|
+
|
|
596
|
+
**Recommendation:** Use possessive quantifiers or atomic groups if available: `\s*+` or `(?>\\s*)`.
|
|
597
|
+
|
|
598
|
+
---
|
|
599
|
+
|
|
600
|
+
## Comparison with Historical CVEs
|
|
601
|
+
|
|
602
|
+
| CVE | Engine | Vulnerability | ORB Applicability |
|
|
603
|
+
|-----|--------|--------------|-------------------|
|
|
604
|
+
| **CVE-2016-0752** | ERB/Rails | SSTI via dynamic `render` with user input | **Informational** -- `{%...%}` and `{{...}}` allow arbitrary Ruby execution, same as ERB (INFO-1, INFO-2) |
|
|
605
|
+
| **CVE-2017-1002201** | HAML | XSS via unescaped apostrophes in attributes | **Applicable** -- dynamic attribute values may lack escaping (HIGH-1); attribute names allow quotes (MEDIUM-4) |
|
|
606
|
+
| **CVE-2016-6316** | Rails/HAML | XSS in `html_safe` attribute values in tag helpers | **Partially applicable** -- interaction with `use_html_safe: true` option and Temple escaping pipeline needs verification (HIGH-1) |
|
|
607
|
+
| **CVE-2019-5418** | Rails | Path traversal via `render file:` with user input | **Not applicable** -- ORB does not support file includes or partial rendering by path |
|
|
608
|
+
| **CVE-2021-32818** | haml-coffee | RCE via configuration parameter pollution | **Not applicable** -- different architecture, no user-accessible configuration |
|
|
609
|
+
| SLIM XSS (Sqreen) | SLIM | XSS through `==` unescaped output and attribute injection | **Partially applicable** -- ORB's `{%...%}` is analogous to SLIM's `==` (no output escaping for control expressions) |
|
|
610
|
+
|
|
611
|
+
---
|
|
612
|
+
|
|
613
|
+
## Recommendations (Priority Order)
|
|
614
|
+
|
|
615
|
+
### Immediate (Before Public Release)
|
|
616
|
+
|
|
617
|
+
1. **Document SSTI risk** -- Add a Security section to README warning that ORB templates must never be constructed from user input. This is the single most important action.
|
|
618
|
+
|
|
619
|
+
2. **Escape dynamic attribute values** -- In `attributes_compiler.rb:91-93`, wrap dynamic attribute values:
|
|
620
|
+
```ruby
|
|
621
|
+
[:html, :attr, attribute.name, [:escape, true, [:dynamic, attribute.value]]]
|
|
622
|
+
```
|
|
623
|
+
|
|
624
|
+
3. **Validate `:for` expression syntax** -- Replace `split(' in ')` with a strict parser:
|
|
625
|
+
```ruby
|
|
626
|
+
match = expression.match(/\A\s*([a-z_]\w*)\s+in\s+(.+)\z/m)
|
|
627
|
+
raise CompilerError, "Invalid :for expression" unless match
|
|
628
|
+
enumerator, collection = match[1], match[2]
|
|
629
|
+
```
|
|
630
|
+
|
|
631
|
+
4. **Validate `:with` directive values** -- Ensure block parameter names are valid Ruby identifiers:
|
|
632
|
+
```ruby
|
|
633
|
+
unless block_name.match?(/\A[a-z_]\w*\z/)
|
|
634
|
+
raise CompilerError, "Invalid :with value: must be a valid identifier"
|
|
635
|
+
end
|
|
636
|
+
```
|
|
637
|
+
|
|
638
|
+
5. **Validate tag names before code interpolation** -- In `filters.rb`, validate before string interpolation:
|
|
639
|
+
```ruby
|
|
640
|
+
unless node.tag.match?(/\A[a-zA-Z][a-zA-Z0-9._:-]*\z/)
|
|
641
|
+
raise CompilerError, "Invalid tag name: #{node.tag}"
|
|
642
|
+
end
|
|
643
|
+
```
|
|
644
|
+
|
|
645
|
+
6. **Validate slot names** -- After extracting the slot name from the tag, validate it is a valid Ruby identifier:
|
|
646
|
+
```ruby
|
|
647
|
+
unless slot_name.match?(/\A[a-z_][a-zA-Z0-9_]*\z/)
|
|
648
|
+
raise CompilerError, "Invalid slot name: #{slot_name}"
|
|
649
|
+
end
|
|
650
|
+
```
|
|
651
|
+
|
|
652
|
+
### Short Term
|
|
653
|
+
|
|
654
|
+
7. **Fix `runtime_error` string delimiter** -- Use `String#inspect` for safe serialization of error messages.
|
|
655
|
+
|
|
656
|
+
8. **Add brace nesting depth limit** -- Cap at a reasonable depth (e.g., 100) in the tokenizer.
|
|
657
|
+
|
|
658
|
+
9. **Restrict `ATTRIBUTE_NAME` pattern** -- Use `/[a-zA-Z_:][-a-zA-Z0-9_:.]*` or similar.
|
|
659
|
+
|
|
660
|
+
### Long Term
|
|
661
|
+
|
|
662
|
+
10. **Consider a restricted execution mode** -- A "safe mode" that limits available methods in template expressions, similar to Liquid's approach.
|
|
663
|
+
|
|
664
|
+
11. **Integrate with Brakeman** -- Add ORB-specific checks for common vulnerability patterns.
|
|
665
|
+
|
|
666
|
+
12. **Replace `OpenStruct` in `RenderContext`** -- Use a `BasicObject` subclass to minimize attack surface for standalone template rendering.
|
|
667
|
+
|
|
668
|
+
13. **Add template size and complexity limits** -- Configurable maximums for source size, nesting depth, and expression count.
|
|
669
|
+
|
|
670
|
+
---
|
|
671
|
+
|
|
672
|
+
## Test Coverage
|
|
673
|
+
|
|
674
|
+
All findings are covered by regression tests in `test/security_test.rb`. Tests are written to **fail** until the corresponding fix is applied, then pass once mitigated.
|
|
675
|
+
|
|
676
|
+
| Finding | Test(s) | Status |
|
|
677
|
+
|---------|---------|--------|
|
|
678
|
+
| **CRITICAL-1** (:for injection) | `test_for_collection_injection_is_rejected`, `test_for_collection_injection_absent_from_temple_ir`, `test_for_enumerator_injection_is_rejected`, `test_for_directive_attribute_injection_is_rejected` | PASSING (4) -- mitigated |
|
|
679
|
+
| **HIGH-1** (attribute XSS) | `test_dynamic_attribute_value_is_escaped` | PASSING (1) -- mitigated |
|
|
680
|
+
| **HIGH-2** (:with injection) | `test_with_directive_component_injection_is_rejected`, `test_with_directive_slot_injection_is_rejected` | PASSING (2) -- mitigated |
|
|
681
|
+
| **HIGH-3** (tag name injection) | `test_dynamic_tag_name_injection_is_rejected`, `test_dynamic_tag_name_with_quote_is_rejected` | PASSING (2) -- mitigated |
|
|
682
|
+
| **HIGH-4** (component name injection) | `test_component_name_method_call_injection_is_rejected`, `test_component_name_semicolon_injection_is_rejected` | PASSING (2) -- mitigated |
|
|
683
|
+
| **HIGH-5** (slot name injection) | `test_slot_name_semicolon_injection_is_rejected`, `test_slot_name_with_parens_is_rejected` | PASSING (2) -- mitigated |
|
|
684
|
+
| **MEDIUM-1** (brace nesting DoS) | `test_deeply_nested_braces_in_expression_raises_error`, `test_deeply_nested_braces_in_attribute_raises_error` | PASSING (2) -- mitigated |
|
|
685
|
+
| **MEDIUM-3** (runtime_error breakout) | `test_runtime_error_with_bracket_produces_valid_ruby`, `test_runtime_error_code_injection_is_rejected` | PASSING (2) -- mitigated |
|
|
686
|
+
| **MEDIUM-4** (attribute name injection) | `test_attribute_name_with_single_quote_is_rejected`, `test_attribute_name_with_backtick_is_rejected` | PASSING (2) -- mitigated |
|
|
687
|
+
| **LOW-1** (verbatim bypass) | `test_verbatim_mode_does_not_process_expressions`, `test_verbatim_mode_passes_html_through_raw` | PASSING (2) |
|
|
688
|
+
| **LOW-2** (comment delimiter) | `test_comment_content_terminates_at_closing_delimiter` | PASSING (1) |
|
|
689
|
+
| **LOW-3** (no size limit) | `test_large_template_has_size_limit` | PASSING (1) -- mitigated |
|
|
690
|
+
| **LOW-4** (ReDoS) | `test_block_regex_handles_pathological_input` | PASSING (1) |
|
|
691
|
+
|
|
692
|
+
Baseline tests (expected to always pass): `test_printing_expression_is_escaped_baseline`, `test_static_attribute_value_needs_no_runtime_escape`, `test_with_directive_normal_usage_compiles_correctly`, `test_dynamic_tag_normal_usage_compiles_correctly`, `test_component_name_dotted_namespace_compiles_correctly`, `test_slot_normal_usage_compiles_correctly`, `test_moderate_brace_nesting_works`, `test_runtime_error_normal_message_compiles_correctly`, `test_valid_attribute_names_compile_correctly`, `test_normal_sized_template_works`, `test_for_block_normal_usage_compiles_correctly`, `test_for_directive_normal_usage_compiles_correctly`.
|
|
693
|
+
|
|
694
|
+
**Totals: 37 tests, 0 failing, 37 passing (all mitigated).**
|
|
695
|
+
|
|
696
|
+
When mitigations are applied, each finding's failing tests should turn green while all baseline tests remain passing.
|
|
697
|
+
|
|
698
|
+
---
|
|
699
|
+
|
|
700
|
+
## Methodology
|
|
701
|
+
|
|
702
|
+
This review was conducted through manual source code analysis of all files in the compilation pipeline:
|
|
703
|
+
|
|
704
|
+
- `lib/orb/patterns.rb` -- Regex patterns (attack surface definition)
|
|
705
|
+
- `lib/orb/tokenizer2.rb` -- Lexical analysis (input parsing)
|
|
706
|
+
- `lib/orb/parser.rb` -- Syntax analysis (AST construction)
|
|
707
|
+
- `lib/orb/ast/*.rb` -- AST node definitions (data model)
|
|
708
|
+
- `lib/orb/temple/compiler.rb` -- AST to Temple IR (code generation)
|
|
709
|
+
- `lib/orb/temple/filters.rb` -- Temple filters (component/block handling)
|
|
710
|
+
- `lib/orb/temple/attributes_compiler.rb` -- Attribute compilation
|
|
711
|
+
- `lib/orb/temple/engine.rb` -- Temple pipeline configuration
|
|
712
|
+
- `lib/orb/rails_template.rb` -- Rails integration
|
|
713
|
+
- `lib/orb/render_context.rb` -- Template execution context
|
|
714
|
+
|
|
715
|
+
Reference CVEs and advisories for ERB, HAML, and SLIM were consulted to identify analogous vulnerability patterns. The review focused on the data flow from template source through tokenization, parsing, AST construction, code generation, and execution.
|
data/lib/orb/patterns.rb
CHANGED
|
@@ -4,7 +4,7 @@ module ORB
|
|
|
4
4
|
module Patterns
|
|
5
5
|
SPACE_CHARS = /\s/
|
|
6
6
|
TAG_NAME = %r{[^\s>/=$]+}
|
|
7
|
-
ATTRIBUTE_NAME = %r{[
|
|
7
|
+
ATTRIBUTE_NAME = %r{[a-zA-Z_:][-a-zA-Z0-9_:.]*}
|
|
8
8
|
UNQUOTED_VALUE_INVALID_CHARS = /["'=<`]/
|
|
9
9
|
UNQUOTED_VALUE = %r{[^\s/>]+}
|
|
10
10
|
BLOCK_NAME_CHARS = /[^\s}]+/
|
|
@@ -89,7 +89,7 @@ module ORB
|
|
|
89
89
|
elsif attribute.bool?
|
|
90
90
|
[:html, :attr, attribute.name, [:dynamic, "nil"]]
|
|
91
91
|
elsif attribute.expression?
|
|
92
|
-
[:html, :attr, attribute.name, [:dynamic, attribute.value]]
|
|
92
|
+
[:html, :attr, attribute.name, [:escape, true, [:dynamic, attribute.value]]]
|
|
93
93
|
end
|
|
94
94
|
end
|
|
95
95
|
|
data/lib/orb/temple/compiler.rb
CHANGED
|
@@ -196,7 +196,7 @@ module ORB
|
|
|
196
196
|
def runtime_error(error)
|
|
197
197
|
[:multi].tap do |temple|
|
|
198
198
|
(error.line - 1).times { temple << [:newline] } if error.line
|
|
199
|
-
temple << [:code,
|
|
199
|
+
temple << [:code, "raise ORB::Error.new(#{error.message.inspect}, #{error.line.inspect})"]
|
|
200
200
|
end
|
|
201
201
|
end
|
|
202
202
|
end
|
data/lib/orb/temple/filters.rb
CHANGED
|
@@ -3,6 +3,19 @@
|
|
|
3
3
|
module ORB
|
|
4
4
|
module Temple
|
|
5
5
|
class Filters < ::Temple::Filter
|
|
6
|
+
# Valid HTML tag names: starts with a letter, followed by letters, digits, or hyphens.
|
|
7
|
+
# Used to validate dynamic tag names before interpolation into generated Ruby code.
|
|
8
|
+
VALID_HTML_TAG_NAME = /\A[a-zA-Z][a-zA-Z0-9-]*\z/
|
|
9
|
+
|
|
10
|
+
# Valid Ruby constant path: one or more segments like Foo, Foo::Bar, Foo::Bar::Baz.
|
|
11
|
+
# Each segment starts with an uppercase letter followed by word characters.
|
|
12
|
+
# Used to validate component names before interpolation into generated Ruby code.
|
|
13
|
+
VALID_COMPONENT_NAME = /\A[A-Z]\w*(::[A-Z]\w*)*\z/
|
|
14
|
+
|
|
15
|
+
# Valid Ruby identifier for use as a method name suffix in with_[name] slot calls.
|
|
16
|
+
# Used to validate slot names before interpolation into generated Ruby code.
|
|
17
|
+
VALID_SLOT_NAME = /\A[a-z_]\w*\z/
|
|
18
|
+
|
|
6
19
|
def initialize(options = {})
|
|
7
20
|
@options = options
|
|
8
21
|
@attributes_compiler = AttributesCompiler.new
|
|
@@ -32,9 +45,15 @@ module ORB
|
|
|
32
45
|
name = node.tag.gsub('.', '::')
|
|
33
46
|
komponent = ORB.lookup_component(name)
|
|
34
47
|
komponent_name = komponent || name
|
|
48
|
+
unless komponent_name.match?(VALID_COMPONENT_NAME)
|
|
49
|
+
raise ORB::SyntaxError.new("Invalid component name: #{komponent_name.inspect}", 0)
|
|
50
|
+
end
|
|
35
51
|
|
|
36
52
|
block_name = "__orb__#{komponent_name.rpartition('::').last.underscore}"
|
|
37
53
|
block_name = node.directives.fetch(:with, block_name)
|
|
54
|
+
unless block_name.match?(/\A[a-z_]\w*\z/)
|
|
55
|
+
raise ORB::SyntaxError.new("Invalid :with directive value: must be a valid Ruby identifier", 0)
|
|
56
|
+
end
|
|
38
57
|
|
|
39
58
|
# We need to compile the attributes into a set of captures and a set of arguments
|
|
40
59
|
# since arguments passed to the view component constructor may be defined as
|
|
@@ -76,8 +95,14 @@ module ORB
|
|
|
76
95
|
|
|
77
96
|
# Prepare the slot name, parent name, and block name
|
|
78
97
|
slot_name = node.slot
|
|
98
|
+
unless slot_name.match?(VALID_SLOT_NAME)
|
|
99
|
+
raise ORB::SyntaxError.new("Invalid slot name: #{slot_name.inspect}", 0)
|
|
100
|
+
end
|
|
79
101
|
parent_name = "__orb__#{node.component.underscore}"
|
|
80
102
|
block_name = node.directives.fetch(:with, "__orb__#{slot_name}")
|
|
103
|
+
unless block_name.match?(/\A[a-z_]\w*\z/)
|
|
104
|
+
raise ORB::SyntaxError.new("Invalid :with directive value: must be a valid Ruby identifier", 0)
|
|
105
|
+
end
|
|
81
106
|
|
|
82
107
|
# Construct the code to call the slot on the parent component
|
|
83
108
|
code = "#{parent_name}.with_#{slot_name}(#{args}) do |#{block_name}|"
|
|
@@ -107,7 +132,17 @@ module ORB
|
|
|
107
132
|
# @param [Array] content The content to be rendered for each iteration
|
|
108
133
|
# @return [Array] compiled Temple expression
|
|
109
134
|
def on_orb_for(expression, content)
|
|
110
|
-
|
|
135
|
+
match = expression.match(/\A\s*([a-z_]\w*)\s+in\s+(.+)\z/m)
|
|
136
|
+
raise ORB::SyntaxError.new("Invalid :for expression: enumerator must be a valid Ruby identifier", 0) unless match
|
|
137
|
+
|
|
138
|
+
enumerator, collection = match[1], match[2]
|
|
139
|
+
|
|
140
|
+
# Reject semicolons in the collection expression to prevent statement injection.
|
|
141
|
+
# Legitimate complex expressions should be assigned in a {%...%} block first.
|
|
142
|
+
if collection.include?(';')
|
|
143
|
+
raise ORB::SyntaxError.new("Invalid :for collection expression: semicolons are not allowed", 0)
|
|
144
|
+
end
|
|
145
|
+
|
|
111
146
|
code = "#{collection}.each do |#{enumerator}|"
|
|
112
147
|
|
|
113
148
|
[:multi,
|
|
@@ -125,6 +160,9 @@ module ORB
|
|
|
125
160
|
on_orb_slot(node, content)
|
|
126
161
|
else
|
|
127
162
|
# It's a dynamic HTML tag
|
|
163
|
+
unless node.tag.match?(VALID_HTML_TAG_NAME)
|
|
164
|
+
raise ORB::SyntaxError.new("Invalid tag name: #{node.tag.inspect}", 0)
|
|
165
|
+
end
|
|
128
166
|
tmp = unique_name
|
|
129
167
|
splats = @attributes_compiler.compile_splat_attributes(node.splat_attributes)
|
|
130
168
|
code = "content_tag('#{node.tag}', #{splats}) do"
|
data/lib/orb/tokenizer2.rb
CHANGED
|
@@ -18,6 +18,12 @@ module ORB
|
|
|
18
18
|
# Tags that should be ignored
|
|
19
19
|
IGNORED_BODY_TAGS = %w[script style].freeze
|
|
20
20
|
|
|
21
|
+
# Maximum allowed brace nesting depth to prevent memory exhaustion
|
|
22
|
+
MAX_BRACE_DEPTH = 100
|
|
23
|
+
|
|
24
|
+
# Maximum allowed template source size in bytes (2MB)
|
|
25
|
+
MAX_TEMPLATE_SIZE = 2 * 1024 * 1024
|
|
26
|
+
|
|
21
27
|
# Tags that are self-closing by HTML5 spec
|
|
22
28
|
VOID_ELEMENTS = %w[area base br col command embed hr img input keygen link meta param source track wbr].freeze
|
|
23
29
|
|
|
@@ -41,6 +47,10 @@ module ORB
|
|
|
41
47
|
|
|
42
48
|
# Main Entry
|
|
43
49
|
def tokenize
|
|
50
|
+
if @source.string.bytesize > MAX_TEMPLATE_SIZE
|
|
51
|
+
raise ORB::SyntaxError.new("Template exceeds maximum size (#{MAX_TEMPLATE_SIZE} bytes)", 0)
|
|
52
|
+
end
|
|
53
|
+
|
|
44
54
|
next_token until @source.eos?
|
|
45
55
|
|
|
46
56
|
# Consume remaining buffer
|
|
@@ -260,7 +270,7 @@ module ORB
|
|
|
260
270
|
# Read next token in :attribute_value_expression state
|
|
261
271
|
def next_in_attribute_value_expression
|
|
262
272
|
if @source.scan(BRACE_OPEN)
|
|
263
|
-
|
|
273
|
+
push_brace
|
|
264
274
|
buffer_matched
|
|
265
275
|
move_by_matched
|
|
266
276
|
elsif @source.scan(BRACE_CLOSE)
|
|
@@ -286,7 +296,7 @@ module ORB
|
|
|
286
296
|
# Read next token in :splat_attribute_expression state
|
|
287
297
|
def next_in_splat_attribute_expression
|
|
288
298
|
if @source.scan(BRACE_OPEN)
|
|
289
|
-
|
|
299
|
+
push_brace
|
|
290
300
|
buffer_matched
|
|
291
301
|
move_by_matched
|
|
292
302
|
elsif @source.scan(BRACE_CLOSE)
|
|
@@ -385,7 +395,7 @@ module ORB
|
|
|
385
395
|
# Read block expression until closing brace
|
|
386
396
|
def next_in_block_open_content
|
|
387
397
|
if @source.scan(BRACE_OPEN)
|
|
388
|
-
|
|
398
|
+
push_brace
|
|
389
399
|
buffer_matched
|
|
390
400
|
move_by_matched
|
|
391
401
|
elsif @source.scan(BRACE_CLOSE)
|
|
@@ -437,7 +447,7 @@ module ORB
|
|
|
437
447
|
move_by_matched
|
|
438
448
|
transition_to(:initial)
|
|
439
449
|
elsif @source.scan(BRACE_OPEN)
|
|
440
|
-
|
|
450
|
+
push_brace
|
|
441
451
|
buffer_matched
|
|
442
452
|
move_by_matched
|
|
443
453
|
elsif @source.scan(BRACE_CLOSE)
|
|
@@ -462,7 +472,7 @@ module ORB
|
|
|
462
472
|
move_by_matched
|
|
463
473
|
transition_to(:initial)
|
|
464
474
|
elsif @source.scan(BRACE_OPEN)
|
|
465
|
-
|
|
475
|
+
push_brace
|
|
466
476
|
buffer_matched
|
|
467
477
|
move_by_matched
|
|
468
478
|
elsif @source.scan(BRACE_CLOSE)
|
|
@@ -537,6 +547,13 @@ module ORB
|
|
|
537
547
|
@braces = []
|
|
538
548
|
end
|
|
539
549
|
|
|
550
|
+
def push_brace
|
|
551
|
+
if @braces.length >= MAX_BRACE_DEPTH
|
|
552
|
+
raise ORB::SyntaxError.new("Maximum brace nesting depth (#{MAX_BRACE_DEPTH}) exceeded", @line)
|
|
553
|
+
end
|
|
554
|
+
@braces << "{"
|
|
555
|
+
end
|
|
556
|
+
|
|
540
557
|
# Moves the cursor
|
|
541
558
|
def move(line, column)
|
|
542
559
|
@line = line
|
data/lib/orb/version.rb
CHANGED
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: orb_template
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.
|
|
4
|
+
version: 0.2.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- KUY.io Inc.
|
|
@@ -39,6 +39,7 @@ files:
|
|
|
39
39
|
- Makefile
|
|
40
40
|
- README.md
|
|
41
41
|
- Rakefile
|
|
42
|
+
- docs/2026-03-12-security-analysis.md
|
|
42
43
|
- lib/orb.rb
|
|
43
44
|
- lib/orb/ast.rb
|
|
44
45
|
- lib/orb/ast/abstract_node.rb
|
|
@@ -98,7 +99,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
98
99
|
- !ruby/object:Gem::Version
|
|
99
100
|
version: '0'
|
|
100
101
|
requirements: []
|
|
101
|
-
rubygems_version:
|
|
102
|
+
rubygems_version: 4.0.6
|
|
102
103
|
specification_version: 4
|
|
103
104
|
summary: The ORB template language for Ruby.
|
|
104
105
|
test_files: []
|