-
Notifications
You must be signed in to change notification settings - Fork 2.4k
fix(security): replace unsafe Function constructor with secure expres… #638
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -53,6 +53,7 @@ jobs: | |
prompt | ||
knowledge | ||
plugin | ||
security | ||
middleware | ||
model | ||
database | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,109 @@ | ||
/* | ||
* Copyright 2025 coze-dev Authors | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"); | ||
* you may not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* | ||
* http://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, | ||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
* See the License for the specific language governing permissions and | ||
* limitations under the License. | ||
*/ | ||
|
||
import 'reflect-metadata'; | ||
import { ContextKeyService, ContextKey } from '../context-key-service'; | ||
|
||
describe('ContextKeyService', () => { | ||
let service: ContextKeyService; | ||
|
||
beforeEach(() => { | ||
service = new ContextKeyService(); | ||
}); | ||
|
||
describe('basic functionality', () => { | ||
it('should set and get context values', () => { | ||
service.setContext('testKey', true); | ||
expect(service.getContext<boolean>('testKey')).toBe(true); | ||
}); | ||
|
||
it('should have default editorFocus context', () => { | ||
expect(service.getContext<boolean>(ContextKey.editorFocus)).toBe(true); | ||
}); | ||
}); | ||
|
||
describe('expression matching', () => { | ||
beforeEach(() => { | ||
service.setContext('active', true); | ||
service.setContext('visible', false); | ||
}); | ||
|
||
it('should match simple boolean expressions', () => { | ||
expect(service.match('active')).toBe(true); | ||
expect(service.match('visible')).toBe(false); | ||
}); | ||
|
||
it('should match complex boolean expressions', () => { | ||
expect(service.match('active && visible')).toBe(false); | ||
expect(service.match('active || visible')).toBe(true); | ||
expect(service.match('!visible')).toBe(true); | ||
}); | ||
|
||
it('should handle unknown context keys safely', () => { | ||
expect(service.match('unknownKey')).toBe(false); | ||
expect(service.match('active && unknownKey')).toBe(false); | ||
}); | ||
}); | ||
|
||
describe('security', () => { | ||
it('should reject malicious expressions', () => { | ||
const maliciousExpressions = [ | ||
'alert("xss")', | ||
'console.log("test")', | ||
'process.exit(0)', | ||
'require("fs")', | ||
'new Function("alert(1)")()', | ||
'eval("1+1")', | ||
'window.location = "evil.com"', | ||
'document.createElement("script")', | ||
'(() => { alert(1); })()', | ||
'active; alert(1)', | ||
]; | ||
|
||
maliciousExpressions.forEach(expr => { | ||
expect(service.match(expr)).toBe(false); | ||
}); | ||
}); | ||
|
||
it('should only allow safe boolean operations', () => { | ||
service.setContext('key1', true); | ||
service.setContext('key2', false); | ||
|
||
const safeExpressions = [ | ||
'key1', | ||
'key1 && key2', | ||
'key1 || key2', | ||
'!key1', | ||
'key1 == key2', | ||
'key1 != key2', | ||
'key1 === key2', | ||
'key1 !== key2', | ||
]; | ||
|
||
safeExpressions.forEach(expr => { | ||
expect(() => service.match(expr)).not.toThrow(); | ||
}); | ||
}); | ||
|
||
it('should handle edge cases gracefully', () => { | ||
expect(service.match('')).toBe(false); | ||
expect(service.match(' ')).toBe(false); | ||
expect(service.match('123')).toBe(false); | ||
expect(service.match('true')).toBe(true); // 'true' is a boolean literal | ||
expect(service.match('false')).toBe(false); // 'false' is a boolean literal | ||
}); | ||
}); | ||
}); |
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -52,10 +52,64 @@ export class ContextKeyService implements ContextMatcher { | |||||
} | ||||||
|
||||||
public match(expression: string): boolean { | ||||||
const keys = Array.from(this._contextKeys.keys()); | ||||||
const func = new Function(...keys, `return ${expression};`); | ||||||
const res = func(...keys.map(k => this._contextKeys.get(k))); | ||||||
try { | ||||||
return this.evaluateExpression(expression); | ||||||
} catch (error) { | ||||||
console.warn('Invalid context expression:', expression, error); | ||||||
return false; | ||||||
} | ||||||
} | ||||||
|
||||||
private evaluateExpression(expression: string): boolean { | ||||||
const sanitizedExpression = expression.trim(); | ||||||
|
||||||
// Allow only safe boolean expressions with context keys | ||||||
const safeExpressionPattern = | ||||||
/^!?[a-zA-Z_$][a-zA-Z0-9_$]*(\s*(&&|\|\||==|!=|===|!==)\s*!?[a-zA-Z_$][a-zA-Z0-9_$]*)*$/; | ||||||
|
||||||
if (!safeExpressionPattern.test(sanitizedExpression)) { | ||||||
throw new Error('Unsafe expression detected'); | ||||||
} | ||||||
|
||||||
// Parse and evaluate the expression safely | ||||||
return this.safeEvaluate(sanitizedExpression); | ||||||
} | ||||||
|
||||||
private safeEvaluate(expression: string): boolean { | ||||||
// Replace context keys with their actual values | ||||||
let executableExpression = expression; | ||||||
|
||||||
// Track which keys have been replaced to avoid replacing them again | ||||||
const replacedKeys = new Set<string>(); | ||||||
|
||||||
for (const [key, value] of this._contextKeys) { | ||||||
const regex = new RegExp(`\\b${key}\\b`, 'g'); | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Creating a new RegExp with user-controlled input (key) without escaping could be vulnerable to ReDoS attacks if context keys contain special regex characters. Use a regex escape function or a more secure string replacement method.
Suggested change
Copilot uses AI. Check for mistakes. Positive FeedbackNegative Feedback |
||||||
// Convert all values to boolean string representation | ||||||
const boolValue = Boolean(value); | ||||||
if (executableExpression.includes(key)) { | ||||||
executableExpression = executableExpression.replace( | ||||||
regex, | ||||||
String(boolValue), | ||||||
); | ||||||
replacedKeys.add(key); | ||||||
} | ||||||
} | ||||||
|
||||||
// Now evaluate the boolean expression safely | ||||||
// Only allow basic boolean operations | ||||||
try { | ||||||
// Remove any remaining unrecognized identifiers (replace with false) | ||||||
// But don't replace 'true' or 'false' literals | ||||||
executableExpression = executableExpression.replace( | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The regex replacement pattern could incorrectly replace parts of 'true' or 'false' if they appear as substrings in longer identifiers. For example, 'falsehood' would become 'false_hood' which could cause unexpected behavior. Copilot uses AI. Check for mistakes. Positive FeedbackNegative Feedback |
||||||
/\b(?!true|false)[a-zA-Z_$][a-zA-Z0-9_$]*\b/g, | ||||||
'false', | ||||||
); | ||||||
|
||||||
return res; | ||||||
// eslint-disable-next-line no-eval -- Safe after sanitization | ||||||
return Boolean(eval(executableExpression)); | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Using eval() is still a security risk even after sanitization. Consider implementing a proper expression parser instead of relying on eval(). The current regex validation may not catch all edge cases that could bypass the sanitization. Copilot uses AI. Check for mistakes. Positive FeedbackNegative Feedback |
||||||
} catch (error) { | ||||||
console.warn('Expression evaluation failed:', error); | ||||||
return false; | ||||||
} | ||||||
} | ||||||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The regex pattern allows unlimited chaining of operators which could potentially create complex expressions that bypass security checks. Consider limiting the depth or complexity of expressions to prevent potential DoS attacks through regex complexity.
Copilot uses AI. Check for mistakes.