feat(event_handler): mutualTLS Security Scheme for OpenAPI

[Sector95]

Issue number: #5483

Summary

Changes

The OpenAPI 3.1 spec supports mutualTLS as an additional security scheme, this PR adds the relevant models and documentation to enable support of that scheme in the framework.

User experience

Currently there is no easy way to specify an mTLS security scheme using the framework. This change would enable a user to specify it in the same as other schemes, like OAuth2 and HTTPBearer types.

app = APIGatewayRestResolver(enable_validation=True)
app.enable_swagger(
    security_schemes={
        'mTLS': MutualTLS(description='mTLS Authentication')
    }
)

Checklist

If your change doesn't seem to apply, please leave them unchecked.

• Meet tenets criteria
• I have performed a self-review of this change
• Changes have been tested
• Changes are documented
• PR title follows conventional commit semantics

Acknowledgment

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.

[boring-cyborg]

Thanks a lot for your first contribution! Please check out our contributing guidelines and don't hesitate to ask whatever you need.
In the meantime, check out the #python channel on our Powertools for AWS Lambda Discord: Invite link

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.16%. Comparing base (3988469) to head (13edad9).
Report is 1 commits behind head on develop.

Additional details and impacted files

@@           Coverage Diff            @@
##           develop    #5484   +/-   ##
========================================
  Coverage    96.15%   96.16%           
========================================
  Files          229      229           
  Lines        10807    10810    +3     
  Branches      2007     2007           
========================================
+ Hits         10392    10395    +3     
  Misses         327      327           
  Partials        88       88           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

[leandrodamascena]

Thanks a lot @Sector95! Approved!

[Sector95]

Thanks a lot @Sector95! Approved!

No problem! Looks like it needs another reviewer since you committed to the branch though.

[leandrodamascena]

Thanks a lot @Sector95! Approved!

No problem! Looks like it needs another reviewer since you committed to the branch though.

Yeah! @anafalcao will approve this soon!

Just to explain: I just added a new test to increase code coverage and make sure we're not missing anything. To be honest, it was just to control my OCD with tests lol.

[boring-cyborg]

Awesome work, congrats on your first merged pull request and thank you for helping improve everyone's experience!