defaultMethodOptions should be selectively applied to CORS OPTIONS method

[whimzyLive]

Tl;DR

defaultMethodOptions should exclude options method by default or at least have an option to do that.

Read More

LambdaRestApi has defaultMethodOption, when it is specified, it gets applied to all methods for given api resource. which is awesome but doesn't work when CORS is involved.

Take this simple example,
where I want all the methods to require x-api-key api key so I specify

defaultMethodOption: {
  apiKeyRequired: true
}

On top of this I also want CORS to be enabled on all api resources so in LambdaRestApi I also specify this

defaultCorsPreflightOptions : {
  ... cors options 
} 

Because of defaultCorsPreflightOptions an additional method will be created for all my resources to support CORS but because defaultMethodOption applies on all methods, options will also have apiKeyRequired , which it shouldn't.

Environment

• CLI Version : 1.38
• Framework Version: 1.38
• Node.js Version: 12 -->
• OS :
• Language (Version): TypeScript (3.8.3) -->

This is 🐛 Bug Report

[nija-at]

Thanks for filing this issue @whimzyLive.

The 'OPTIONS' method created as part of CORS preflight setup will have to be adjusted such that only properties in defaultMethodOptions that apply in the CORS context are filtered.

For the time being, you should be able to work around this using escape hatches.

[asterikx]

I stumbled across this too.

For now, I have removed the API key requirement from the RestApi and added it to each resource instead. This isn't ideal though.

[whimzyLive]

@asterikx until issue is resolved correctly, you can use cdk escape hatches as also suggested by @nija-at.

For my case I did

    const corsMethods = this.apiV1.methods.filter(
      method => method.httpMethod === 'OPTIONS'
    );
    corsMethods.forEach(method => {
      const cfnMethod = method.node.defaultChild as CfnMethod;
      cfnMethod.addPropertyOverride('ApiKeyRequired', false);
      cfnMethod.addPropertyOverride('AuthorizationType', 'NONE');
      cfnMethod.addPropertyDeletionOverride('AuthorizerId');
    });

[asterikx]

@whimzyLive thanks for sharing! I wasn't sure how to do this.

[mhart]

There are extra issues with this and proxy support AFAICT. For example, using LambdaRestApi:

const api = new apigateway.LambdaRestApi(stack, 'DummyApi', {
  handler,
  defaultMethodOptions: { authorizationType: apigateway.AuthorizationType.IAM },
  defaultCorsPreflightOptions: { allowOrigins: apigateway.Cors.ALL_ORIGINS },
})

api.methods.filter(m => m.httpMethod === 'OPTIONS')
  .forEach(m => m.node.defaultChild.addPropertyOverride('AuthorizationType', 'NONE'))

This works in so much as the OPTIONS methods are changed correctly in the CFN output to not use auth – but I still get 403s when sending OPTIONS requests – and I believe (although happy to be wrong) it's because the auth on the ANY methods from the proxy is overriding the (lack of) auth on the OPTIONS methods on the same resources.

EDIT: this was wrong. I believe the root cause is that the CDK is failing to see the addPropertyOverride changes when calculating the hash for the Deployment – so when the CloudFormation stack is updated after adding overrides, the deployment appears not to have changed, and so CloudFormation doesn't deploy the auth changes (because CloudFormation has no auto-deploy mechanism)

I'm guessing addPropertyOverride changes are out of scope for determining the deployment hash? If not, I'll file a separate issue for that. But definitely something people should be aware of – you'll need to trigger the deployment to change some other way to get the stack to update.

EDIT2: Added an issue for this over at #9086

[mhart]

I guess this is akin to the AddDefaultAuthorizerToCorsPreflight property in SAM

[mhart]

Another related issue here (if not exactly the same): #906 (comment)

[whimzyLive]

@mhart I am using lambdaRestApi with above workaround and all options are working fine. Only difference is: I am using it with custom Authorizer instead of IAM Authorizer. If you could share a part of your synthesised template that contains AWS::ApiGateway::Method I might be able to help.

[mhart]

Like I said, I'm pretty sure the generated CFN is actually right – I mean, it's removed the auth from OPTIONS – the problem is that (I suspect) the auth on the ANY method is overriding the non-auth on the OPTIONS method.

Anyway, here are the generated AWS::ApiGateway::Methods:

EDIT: Updated – I only had the two proxy methods in before, now have all four (two proxy + two root):

{
    "DummyApiOPTIONSA607B51F": {
      "Type": "AWS::ApiGateway::Method",
      "Properties": {
        "HttpMethod": "OPTIONS",
        "ResourceId": {
          "Fn::GetAtt": [
            "DummyApi80F1E171",
            "RootResourceId"
          ]
        },
        "RestApiId": {
          "Ref": "DummyApi80F1E171"
        },
        "AuthorizationType": "NONE",
        "Integration": {
          "IntegrationResponses": [
            {
              "ResponseParameters": {
                "method.response.header.Access-Control-Allow-Headers": "'Content-Type,X-Amz-Date,Authorization,X-Api-Key,X-Amz-Security-Token,X-Amz-User-Agent'",
                "method.response.header.Access-Control-Allow-Origin": "'*'",
                "method.response.header.Access-Control-Allow-Methods": "'OPTIONS,GET,PUT,POST,DELETE,PATCH,HEAD'"
              },
              "StatusCode": "204"
            }
          ],
          "RequestTemplates": {
            "application/json": "{ statusCode: 200 }"
          },
          "Type": "MOCK"
        },
        "MethodResponses": [
          {
            "ResponseParameters": {
              "method.response.header.Access-Control-Allow-Headers": true,
              "method.response.header.Access-Control-Allow-Origin": true,
              "method.response.header.Access-Control-Allow-Methods": true
            },
            "StatusCode": "204"
          }
        ]
      }
    },
    "DummyApiproxyOPTIONSC056BEDA": {
      "Type": "AWS::ApiGateway::Method",
      "Properties": {
        "HttpMethod": "OPTIONS",
        "ResourceId": {
          "Ref": "DummyApiproxy55B1C1CD"
        },
        "RestApiId": {
          "Ref": "DummyApi80F1E171"
        },
        "AuthorizationType": "NONE",
        "Integration": {
          "IntegrationResponses": [
            {
              "ResponseParameters": {
                "method.response.header.Access-Control-Allow-Headers": "'Content-Type,X-Amz-Date,Authorization,X-Api-Key,X-Amz-Security-Token,X-Amz-User-Agent'",
                "method.response.header.Access-Control-Allow-Origin": "'*'",
                "method.response.header.Access-Control-Allow-Methods": "'OPTIONS,GET,PUT,POST,DELETE,PATCH,HEAD'"
              },
              "StatusCode": "204"
            }
          ],
          "RequestTemplates": {
            "application/json": "{ statusCode: 200 }"
          },
          "Type": "MOCK"
        },
        "MethodResponses": [
          {
            "ResponseParameters": {
              "method.response.header.Access-Control-Allow-Headers": true,
              "method.response.header.Access-Control-Allow-Origin": true,
              "method.response.header.Access-Control-Allow-Methods": true
            },
            "StatusCode": "204"
          }
        ]
      }
    },
    "DummyApiproxyANY1EBD4910": {
      "Type": "AWS::ApiGateway::Method",
      "Properties": {
        "HttpMethod": "ANY",
        "ResourceId": {
          "Ref": "DummyApiproxy55B1C1CD"
        },
        "RestApiId": {
          "Ref": "DummyApi80F1E171"
        },
        "AuthorizationType": "AWS_IAM",
        "Integration": {
          "IntegrationHttpMethod": "POST",
          "Type": "AWS_PROXY",
          "Uri": {
            "Fn::Join": [
              "",
              [
                "arn:",
                {
                  "Ref": "AWS::Partition"
                },
                ":apigateway:",
                {
                  "Ref": "AWS::Region"
                },
                ":lambda:path/2015-03-31/functions/",
                {
                  "Fn::GetAtt": [
                    "DummyFunction3BB5AE03",
                    "Arn"
                  ]
                },
                "/invocations"
              ]
            ]
          }
        }
      }
    },
    "DummyApiANYCEB66499": {
      "Type": "AWS::ApiGateway::Method",
      "Properties": {
        "HttpMethod": "ANY",
        "ResourceId": {
          "Fn::GetAtt": [
            "DummyApi80F1E171",
            "RootResourceId"
          ]
        },
        "RestApiId": {
          "Ref": "DummyApi80F1E171"
        },
        "AuthorizationType": "AWS_IAM",
        "Integration": {
          "IntegrationHttpMethod": "POST",
          "Type": "AWS_PROXY",
          "Uri": {
            "Fn::Join": [
              "",
              [
                "arn:",
                {
                  "Ref": "AWS::Partition"
                },
                ":apigateway:",
                {
                  "Ref": "AWS::Region"
                },
                ":lambda:path/2015-03-31/functions/",
                {
                  "Fn::GetAtt": [
                    "DummyFunction3BB5AE03",
                    "Arn"
                  ]
                },
                "/invocations"
              ]
            ]
          }
        }
      }
    }
  }
}

[whimzyLive]

@mhart Okay I see you are using Lambda proxy integration in particular. For Lambda proxy
your backend is responsible for returning the Access-Control-Allow-Origin and Access-Control-Allow-Headers headers, because a proxy integration doesn't return an integration response. - from docs

This is mentioned here, under Enabling CORS support for Lambda or HTTP proxy integrations.

[mhart]

That doesn't make sense – the 403 happens before the Lambda is even invoked.

[whimzyLive]

This was the last thing I could think of. If you are getting 403 on options itself then we might have had different issue. Let me know if you find out something.

[mhart]

Found the issue – it was a complicated scenario with CFN stack updates and CDK deployment hashes not being updated. More info in the updated comment here: #8615 (comment)

[jimfum]

I also have the above issue and have come up with the same CfnMethod workaround. Couldn't believe there isn't anything better, anything official without Cfn and that maybe defaultMethodOptions isn't popular enough(?).

SAM has a solution for it though AddDefaultAuthorizerToCorsPreflight (https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-api-apiauth.html).

[leantorres73]

I also have the above issue and have come up with the same CfnMethod workaround. Couldn't believe there isn't anything better, anything official without Cfn and that maybe defaultMethodOptions isn't popular enough(?).

SAM has a solution for it though AddDefaultAuthorizerToCorsPreflight (https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-api-apiauth.html).

and how did you fix it? I'm having issues also

[jimfum]

Something like the below in TypeScript. Omitting referenced variables but hope it's clear.

const api = new apiGateway.LambdaRestApi(
  this,
  "ABCD",
  {
    restApiName: apiName,
    handler: mainFunc,
    domainName: {
      domainName: apiDomain,
      certificate,
    },
    defaultCorsPreflightOptions: {
      allowOrigins: corsAllowedOrigins,
    },
    defaultMethodOptions: { authorizer: authorizer },
  }
);

api.methods
  .filter((method) => method.httpMethod === "OPTIONS")
  .forEach((method) => {
    const methodCfn = method.node.defaultChild as apiGateway.CfnMethod;
    methodCfn.authorizationType = apiGateway.AuthorizationType.NONE;
    methodCfn.authorizerId = undefined;
  });

[github-actions]

This issue has received a significant amount of attention so we are automatically upgrading its priority. A member of the community will see the re-prioritization and provide an update on the issue.

[github-actions]

⚠️COMMENT VISIBILITY WARNING⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.

[markcarroll]

@corymhall please re-open. See comment in #22402 (comment)