Skip to content
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.

Sign up for GitHub

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

feat: implement enableAcceptJsonRequest API #497

Merged
merged 1 commit into from
Jan 23, 2025
Merged

feat: implement enableAcceptJsonRequest API #497

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
27 changes: 24 additions & 3 deletions src/coreEnforcer.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@ export class CoreEnforcer {
protected autoSave = true;
protected autoBuildRoleLinks = true;
protected autoNotifyWatcher = true;
protected acceptJsonRequest = false;
protected fs?: FileSystem;

/**
Expand Down Expand Up @@ -351,6 +352,15 @@ export class CoreEnforcer {
this.autoNotifyWatcher = enable;
}

/**
* enableAcceptJsonRequest determines whether to attempt parsing request args as JSON
*
* @param enable whether to attempt parsing request args as JSON
*/
public enableAcceptJsonRequest(enable: boolean): void {
this.acceptJsonRequest = enable;
}

/**
* enableAutoBuildRoleLinks controls whether to save a policy rule
* automatically to the adapter when it is added or removed.
Expand Down Expand Up @@ -477,9 +487,20 @@ export class CoreEnforcer {
throw new Error(`invalid request size: expected ${rTokensLen}, got ${rvals.length}, rvals: ${rvals}"`);
}

rTokens.forEach((token, j) => {
parameters[token] = rvals[j];
});
if (this.acceptJsonRequest) {
// Attempt to parse each request parameter as JSON; continue with string if failed
rTokens.forEach((token, j) => {
try {
parameters[token] = JSON.parse(rvals[j]);
} catch {
parameters[token] = rvals[j];
}
});
} else {
rTokens.forEach((token, j) => {
parameters[token] = rvals[j];
});
}

p?.tokens.forEach((token, j) => {
parameters[token] = p?.policy[i][j];
Expand Down
32 changes: 32 additions & 0 deletions test/enforcer.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -560,6 +560,10 @@ class TestSub {
this.Name = name;
this.Age = age;
}

toJSONString(): string {
return JSON.stringify(this);
}
}

test('test ABAC Scaling', async () => {
Expand Down Expand Up @@ -837,3 +841,31 @@ test('TestEnforceWithMatcher', async () => {
expect(await e.enforceWithMatcher(m2, 'data2_admin', 'data1', 'read')).toBe(true);
expect(await e.enforceWithMatcher(m2, 'data2_admin', 'data1', 'write')).toBe(true);
});

test('TestEnforceWithEnableAcceptJsonRequest', async () => {
const e = await newEnforcer('examples/abac_rule_model.conf', 'examples/abac_rule_policy.csv');
e.enableAcceptJsonRequest(true);

const sub1 = new TestSub('alice', 16).toJSONString();
const sub2 = new TestSub('alice', 20).toJSONString();
const sub3 = new TestSub('alice', 65).toJSONString();

await testEnforce(e, sub1, '/data1', 'read', false);
await testEnforce(e, sub1, '/data2', 'read', false);
await testEnforce(e, sub1, '/data1', 'write', false);
await testEnforce(e, sub1, '/data2', 'write', true);
await testEnforce(e, sub2, '/data1', 'read', true);
await testEnforce(e, sub2, '/data2', 'read', false);
await testEnforce(e, sub2, '/data1', 'write', false);
await testEnforce(e, sub2, '/data2', 'write', true);
await testEnforce(e, sub3, '/data1', 'read', true);
await testEnforce(e, sub3, '/data2', 'read', false);
await testEnforce(e, sub3, '/data1', 'write', false);
await testEnforce(e, sub3, '/data2', 'write', false);

e.enableAcceptJsonRequest(false);
await testEnforce(e, sub1, '/data2', 'write', false);
await testEnforce(e, sub2, '/data1', 'read', false);
await testEnforce(e, sub2, '/data2', 'write', false);
await testEnforce(e, sub3, '/data1', 'read', false);
});
Loading