Skip to content

fix: improve validation on extension attribute #502

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

Merged
merged 2 commits into from
Jun 22, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions src/event/spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,11 @@ export function validateCloudEvent<T>(event: CloudEventV1<T>): boolean {
} else {
return false;
}
// attribute names must all be lowercase
// attribute names must all be [a-z|0-9]
const validation = /^[a-z0-9]+$/;
for (const key in event) {
if (key !== key.toLowerCase()) {
throw new ValidationError(`invalid attribute name: ${key}`);
if (validation.test(key) === false && key !== "data_base64") {
throw new ValidationError(`invalid attribute name: "${key}"`);
}
}
return true;
Expand Down
2 changes: 1 addition & 1 deletion test/integration/kafka_tests.ts
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ describe("Kafka transport", () => {
expect(event.LUNCH).to.equal("tacos");
expect(function () {
event.validate();
}).to.throw("invalid attribute name: LUNCH");
}).to.throw("invalid attribute name: \"LUNCH\"");
});

it("Can detect CloudEvent binary Messages with weird versions", () => {
Expand Down
18 changes: 16 additions & 2 deletions test/integration/message_test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,21 @@ const imageData = new Uint32Array(fs.readFileSync(path.join(process.cwd(), "test
const image_base64 = asBase64(imageData);

describe("HTTP transport", () => {

it("validates extension attribute names for incoming messages", () => {
// create a new Message
const msg: Message = {
headers: {
"ce-id": "213",
"ce-source": "test",
"ce-type": "test",
"ce-bad-extension": "value"
},
body: undefined
};
const evt = HTTP.toEvent(msg) as CloudEvent;
expect(() => evt.validate()).to.throw(TypeError);
});

it("Includes extensions in binary mode when type is 'boolean' with a false value", () => {
const evt = new CloudEvent({ source: "test", type: "test", extboolean: false });
expect(evt.hasOwnProperty("extboolean")).to.equal(true);
Expand Down Expand Up @@ -129,7 +143,7 @@ describe("HTTP transport", () => {
expect(event.LUNCH).to.equal("tacos");
expect(function () {
event.validate();
}).to.throw("invalid attribute name: LUNCH");
}).to.throw("invalid attribute name: \"LUNCH\"");
});

it("Can detect CloudEvent binary Messages with weird versions", () => {
Expand Down
2 changes: 1 addition & 1 deletion test/integration/mqtt_tests.ts
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ describe("MQTT transport", () => {
expect(event.LUNCH).to.equal("tacos");
expect(function () {
event.validate();
}).to.throw("invalid attribute name: LUNCH");
}).to.throw("invalid attribute name: \"LUNCH\"");
});

it("Can detect CloudEvent binary Messages with weird versions", () => {
Expand Down
10 changes: 10 additions & 0 deletions test/integration/spec_1_tests.ts
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,16 @@ describe("CloudEvents Spec v1.0", () => {
it("should be ok when the type is an string converted from an object", () => {
expect(cloudevent.cloneWith({ objectextension: JSON.stringify({ some: "object" }) }).validate()).to.equal(true);
});

it("should only allow a-z|0-9 in the attribute names", () => {
const testCases = [
"an extension", "an_extension", "an-extension", "an.extension", "an+extension"
];
testCases.forEach((testCase) => {
const evt = cloudevent.cloneWith({ [testCase]: "a value"}, false);
expect(() => evt.validate()).to.throw(ValidationError);
});
});
});

describe("The Constraints check", () => {
Expand Down