Skip to content

add support for IAM authorizers #41

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

Merged
merged 5 commits into from
Dec 15, 2023
Merged

add support for IAM authorizers #41

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
44f4766
add support for IAM authorizers
sebsto Dec 14, 2023
8c603b8
swiftformat
sebsto Dec 15, 2023
bb8ea06
fix soundness check in docker compose
sebsto Dec 15, 2023
d728f73
add support for cognito identities inside IAM authentication block
sebsto Dec 15, 2023
6b7c2b4
fix formatting issues / soundness checks
sebsto Dec 15, 2023
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
22 changes: 21 additions & 1 deletion Sources/AWSLambdaEvents/APIGateway+V2.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,25 @@ public struct APIGatewayV2Request: Codable {
public let scopes: [String]?
}

public let jwt: JWT
public let jwt: JWT?

// `IAM` contains AWS IAM authorizer information for the request context.
public struct IAM: Codable {
public struct CognitoIdentity: Codable {
public let amr: [String]?
public let identityId: String?
public let identityPoolId: String?
}
public let accessKey: String?
public let accountId: String?
public let callerId: String?
public let cognitoIdentity: CognitoIdentity?
public let principalOrgId: String?
public let userArn: String?
public let userId: String?
}

public let iam: IAM?
}

public let accountId: String
Expand Down Expand Up @@ -113,5 +131,7 @@ extension APIGatewayV2Request.Context: Sendable {}
extension APIGatewayV2Request.Context.HTTP: Sendable {}
extension APIGatewayV2Request.Context.Authorizer: Sendable {}
extension APIGatewayV2Request.Context.Authorizer.JWT: Sendable {}
extension APIGatewayV2Request.Context.Authorizer.IAM: Sendable {}
extension APIGatewayV2Request.Context.Authorizer.IAM.CognitoIdentity: Sendable {}
extension APIGatewayV2Response: Sendable {}
#endif
159 changes: 159 additions & 0 deletions Tests/AWSLambdaEventsTests/APIGateway+V2IAMTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,159 @@
//===----------------------------------------------------------------------===//
//
// This source file is part of the SwiftAWSLambdaRuntime open source project
//
// Copyright (c) 2017-2020 Apple Inc. and the SwiftAWSLambdaRuntime project authors
// Licensed under Apache License v2.0
//
// See LICENSE.txt for license information
// See CONTRIBUTORS.txt for the list of SwiftAWSLambdaRuntime project authors
//
// SPDX-License-Identifier: Apache-2.0
//
//===----------------------------------------------------------------------===//

@testable import AWSLambdaEvents
import XCTest

class APIGatewayV2IAMTests: XCTestCase {
static let getEventWithIAM = """
{
"version": "2.0",
"routeKey": "$default",
"rawPath": "/hello",
"rawQueryString": "",
"headers": {
"accept": "*/*",
"authorization": "AWS4-HMAC-SHA256 Credential=ASIA-redacted/us-east-1/execute-api/aws4_request, SignedHeaders=host;x-amz-date;x-amz-security-token, Signature=289b5fcef3d1156f019cc1140cb5565cc052880a5a0d5586c753e3e3c75556f9",
"content-length": "0",
"host": "74bxj8iqjc.execute-api.us-east-1.amazonaws.com",
"user-agent": "curl/8.4.0",
"x-amz-date": "20231214T203121Z",
"x-amz-security-token": "IQoJb3JpZ2luX2VjEO3//////////-redacted",
"x-amzn-trace-id": "Root=1-657b6619-3222de40051925dd66e1fd72",
"x-forwarded-for": "191.95.150.52",
"x-forwarded-port": "443",
"x-forwarded-proto": "https"
},
"requestContext": {
"accountId": "012345678912",
"apiId": "74bxj8iqjc",
"authorizer": {
"iam": {
"accessKey": "ASIA-redacted",
"accountId": "012345678912",
"callerId": "AIDA-redacted",
"cognitoIdentity": null,
"principalOrgId": "aws:PrincipalOrgID",
"userArn": "arn:aws:iam::012345678912:user/sst",
"userId": "AIDA-redacted"
}
},
"domainName": "74bxj8iqjc.execute-api.us-east-1.amazonaws.com",
"domainPrefix": "74bxj8iqjc",
"http": {
"method": "GET",
"path": "/liveness",
"protocol": "HTTP/1.1",
"sourceIp": "191.95.150.52",
"userAgent": "curl/8.4.0"
},
"requestId": "P8zkDiQ8oAMEJsQ=",
"routeKey": "$default",
"stage": "$default",
"time": "14/Dec/2023:20:31:21 +0000",
"timeEpoch": 1702585881671
},
"isBase64Encoded": false
}
"""

static let getEventWithIAMAndCognito = """
{
"version": "2.0",
"routeKey": "$default",
"rawPath": "/hello",
"rawQueryString": "",
"headers": {
"accept": "*/*",
"authorization": "AWS4-HMAC-SHA256 Credential=ASIA-redacted/us-east-1/execute-api/aws4_request, SignedHeaders=host;x-amz-date;x-amz-security-token, Signature=289b5fcef3d1156f019cc1140cb5565cc052880a5a0d5586c753e3e3c75556f9",
"content-length": "0",
"host": "74bxj8iqjc.execute-api.us-east-1.amazonaws.com",
"user-agent": "curl/8.4.0",
"x-amz-date": "20231214T203121Z",
"x-amz-security-token": "IQoJb3JpZ2luX2VjEO3//////////-redacted",
"x-amzn-trace-id": "Root=1-657b6619-3222de40051925dd66e1fd72",
"x-forwarded-for": "191.95.150.52",
"x-forwarded-port": "443",
"x-forwarded-proto": "https"
},
"requestContext": {
"accountId": "012345678912",
"apiId": "74bxj8iqjc",
"authorizer": {
"iam": {
"accessKey": "ASIA-redacted",
"accountId": "012345678912",
"callerId": "AROA-redacted:CognitoIdentityCredentials",
"cognitoIdentity": {
"amr": [
"authenticated",
"cognito-idp.us-east-1.amazonaws.com/us-east-1_ABCD",
"cognito-idp.us-east-1.amazonaws.com/us-east-1_ABCD:CognitoSignIn:04611e3d--redacted"
],
"identityId": "us-east-1:68bc0ecd-9d5e--redacted",
"identityPoolId": "us-east-1:e8b526df--redacted"
},
"principalOrgId": "aws:PrincipalOrgID",
"userArn": "arn:aws:sts::012345678912:assumed-role/authRole/CognitoIdentityCredentials",
"userId": "AROA-redacted:CognitoIdentityCredentials"
}
},
"domainName": "74bxj8iqjc.execute-api.us-east-1.amazonaws.com",
"domainPrefix": "74bxj8iqjc",
"http": {
"method": "GET",
"path": "/liveness",
"protocol": "HTTP/1.1",
"sourceIp": "191.95.150.52",
"userAgent": "curl/8.4.0"
},
"requestId": "P8zkDiQ8oAMEJsQ=",
"routeKey": "$default",
"stage": "$default",
"time": "14/Dec/2023:20:31:21 +0000",
"timeEpoch": 1702585881671
},
"isBase64Encoded": false
}
"""
// MARK: - Request -

// MARK: Decoding

func testRequestDecodingGetRequestWithIAM() {
let data = APIGatewayV2IAMTests.getEventWithIAM.data(using: .utf8)!
var req: APIGatewayV2Request?
XCTAssertNoThrow(req = try JSONDecoder().decode(APIGatewayV2Request.self, from: data))

XCTAssertEqual(req?.rawPath, "/hello")
XCTAssertEqual(req?.context.authorizer?.iam?.accessKey, "ASIA-redacted")
XCTAssertEqual(req?.context.authorizer?.iam?.accountId, "012345678912")
XCTAssertNil(req?.body)
}
func testRequestDecodingGetRequestWithIAMWithCognito() {
let data = APIGatewayV2IAMTests.getEventWithIAMAndCognito.data(using: .utf8)!
var req: APIGatewayV2Request?
XCTAssertNoThrow(req = try JSONDecoder().decode(APIGatewayV2Request.self, from: data))

XCTAssertEqual(req?.rawPath, "/hello")
XCTAssertEqual(req?.context.authorizer?.iam?.accessKey, "ASIA-redacted")
XCTAssertEqual(req?.context.authorizer?.iam?.accountId, "012345678912")

// test the cognito identity part
XCTAssertEqual(req?.context.authorizer?.iam?.cognitoIdentity?.identityId, "us-east-1:68bc0ecd-9d5e--redacted")
XCTAssertEqual(req?.context.authorizer?.iam?.cognitoIdentity?.amr?.count, 3)

XCTAssertNil(req?.body)
}
}
2 changes: 2 additions & 0 deletions Tests/AWSLambdaEventsTests/APIGateway+V2Tests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,8 @@ class APIGatewayV2Tests: XCTestCase {
XCTAssertEqual(req?.queryStringParameters?.count, 1)
XCTAssertEqual(req?.rawQueryString, "foo=bar")
XCTAssertEqual(req?.headers.count, 8)
XCTAssertEqual(req?.context.authorizer?.jwt?.claims?["aud"], "customers")

XCTAssertNil(req?.body)
}
}
3 changes: 3 additions & 0 deletions docker/docker-compose.al2.56.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@ services:
args:
swift_version: "5.6"

soundness:
image: swift-aws-lambda-events:al2-5.6

test:
image: swift-aws-lambda-events:al2-5.6

Expand Down
3 changes: 3 additions & 0 deletions docker/docker-compose.al2.57.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@ services:
args:
swift_version: "5.7"

soundness:
image: swift-aws-lambda-events:al2-5.7

test:
image: swift-aws-lambda-events:al2-5.7

Expand Down
3 changes: 3 additions & 0 deletions docker/docker-compose.al2.58.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@ services:
args:
swift_version: "5.8"

soundness:
image: swift-aws-lambda-events:al2-5.8

test:
image: swift-aws-lambda-events:al2-5.8

Expand Down
3 changes: 3 additions & 0 deletions docker/docker-compose.al2.59.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@ services:
args:
base_image: "swiftlang/swift:nightly-5.9-amazonlinux2"

soundness:
image: swift-aws-lambda-events:al2-5.9

test:
image: swift-aws-lambda-events:al2-5.9

Expand Down
3 changes: 3 additions & 0 deletions docker/docker-compose.al2.main.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@ services:
args:
base_image: "swiftlang/swift:nightly-main-amazonlinux2"

soundness:
image: swift-aws-lambda-events:al2-main

test:
image: swift-aws-lambda-events:al2-main

Expand Down