AWS API Gateway custom Authorizer strange showing error
This error will occur if you use event.methodArn
as a resource for generated policy and share an authorizer between different functions, because of how policy caching works. For provided token it caches a policy across an entire API, it will be the same cache entry for all methods and resources within the same API and stage (if they share the same authorizer).
For example, when making a request to GET /users
, ARN will look something like this:
arn:aws:execute-api:us-1:abc:123/prod/GET/users
Next call to any endpoint with the same authentication token will use a cached policy, which was created on the first call to GET /users
. The problem with that cached policy is that it's resource only allows a single particular resource arn: ... /prod/GET/users
, any other resource will be rejected.
Depending on how much do you want to limit policy permissions, you can either mention every possible resource when creating a policy
{
"principalId": "user",
"policyDocument": {
"Statement": [
{
"Action": "execute-api:Invoke",
"Effect": "Allow",
"Resource": [
"arn:aws:execute-api:us-1:abc:123/prod/GET/v1/users",
"arn:aws:execute-api:us-1:abc:123/prod/POST/v1/users",
"arn:aws:execute-api:us-1:abc:123/prod/GET/v1/orders"
]
}
],
"Version": "2012-10-17"
}
}
or use wildcards
"Resource": "arn:aws:execute-api:us-1:abc:123/prod/*/v?/*"
or even
"Resource": "*"
You can use policy variables for some advanced templates.
It is also possible to use a blacklist approach by allowing everything using wildcards and then denying specific resources in another policy statement.
Sources:
- AWS forums: API Gateway issue about custom authorizers
- AWS docs: IAM Policy resource field
This could be fixed in two ways that are described in buggy's answer: https://forum.serverless.com/t/rest-api-with-custom-authorizer-how-are-you-dealing-with-authorization-and-policy-cache/3310
Short version:
- Set custom authorizer policy resource as "*"
- Or (if you are ok with no caching) set TTL for custom authorizer to 0
See the answer by Michael for more details
In the your custom policy build code use, the node js module aws-auth-policy The Nodejs part you can use ,
AuthPolicy.prototype.allowAllMethods = function () {
addMethod.call(this, "allow", "*", "*", null);
}
In the code
const AuthPolicy = require('aws-auth-policy');
const policy = new AuthPolicy(principalId, awsAccountId, apiOptions);
// policy.allowMethod(method, resource);
policy.allowAllMethods();
const authResponse = policy.build();