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(events): add VPC Lattice request/response types #521

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

feat(events): add VPC Lattice request/response types #521

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
de2a65f
feat(events): add VPC Lattice request/response types
nmoutschen Sep 27, 2023
055323f
fix: add isBase64Encoded for VPCLatticeRequestV2
nmoutschen Sep 27, 2023
9465179
fix: fix lints
nmoutschen Sep 27, 2023
85a847f
Merge branch 'main' into vpc-lattice-events
bmoffatt Oct 26, 2023
f3eddf5
Update vpclattice.go per linter
bmoffatt Nov 30, 2023
1848e40
Merge branch 'main' into vpc-lattice-events
bmoffatt Dec 2, 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
10 changes: 10 additions & 0 deletions events/testdata/vpclattice-response.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"isBase64Encoded": true,
"statusCode": 200,
"statusDescription": "200 OK",
"headers": {
"set-cookie": "cookies",
"content-type": "application/json"
},
"body": "BODY"
}
16 changes: 16 additions & 0 deletions events/testdata/vpclattice-v1-request.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
{
"raw_path": "/",
"method": "POST",
"headers": {
"accept-encoding": "gzip, br, deflate",
"accept": "application/json",
"content-length": "4",
"content-type": "application/json",
"host": "some-host.vpc-lattice-svcs.us-east-1.on.aws",
"x-forwarded-for": "1.2.3.4,2.3.4.5",
"x-forwarded-port": "443"
},
"query_string_parameters": {},
"body": "BODY",
"is_base64_encoded": true
}
42 changes: 42 additions & 0 deletions events/testdata/vpclattice-v2-request.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
{
"version": "2.0",
"path": "/",
"method": "POST",
"headers": {
"accept": [
"application/json"
],
"x-forwarded-port": [
"443"
],
"x-forwarded-for": [
"1.2.3.4,2.3.4.5"
],
"host": [
"some-host.vpc-lattice-svcs.us-east-1.on.aws"
],
"content-type": [
"application/json"
],
"content-length": [
"4"
],
"accept-encoding": [
"gzip, br, deflate"
]
},
"body": "BODY",
"requestContext": {
"serviceNetworkArn": "arn:aws:vpc-lattice:us-east-1:12346789012:servicenetwork/sn-0db8ae434454b4422",
"serviceArn": "arn:aws:vpc-lattice:us-east-1:12346789012:service/svc-0db8ae434454b4422",
"targetGroupArn": "arn:aws:vpc-lattice:us-east-1:12346789012:targetgroup/tg-0db8ae434454b4422",
"identity": {
"sourceVpcArn": "arn:aws:ec2:us-east-1:12346789012:vpc/vpc-0db8ae434454b4422",
"type": "AWS_IAM",
"principal": "arn:aws:sts::12346789012:assumed-role/IAM_ROLE/SESSION_NAME",
"sessionName": "SESSION_NAME"
},
"region": "us-east-1",
"timeEpoch": "1695799509392227"
}
}
49 changes: 49 additions & 0 deletions events/vpclattice.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
package events

// VPCLatticeRequestV1 contains data coming from AWS VPC Lattice
type VPCLatticeRequestV1 struct {
RawPath string `json:"raw_path"`
Method string `json:"method"`
Headers map[string]string `json:"headers"`
QueryStringParameters map[string]string `json:"query_string_parameters"`
Body string `json:"body"`
IsBase64Encoded bool `json:"is_base64_encoded,omitempty"`
}

// VPCLatticeRequestV2 contains data coming from AWS VPC Lattice
type VPCLatticeRequestV2 struct {
Version string `json:"version"`
Path string `json:"path"`
Method string `json:"method"`
Headers map[string][]string `json:"headers"`
Body string `json:"body"`
RequestContext VPCLatticeRequestContext `json:"requestContext"`
IsBase64Encoded bool `json:"isBase64Encoded,omitempty"`
}

// VPCLatticeRequestContext contains metadata about the incoming request
type VPCLatticeRequestContext struct {
ServiceNetworkARN string `json:"serviceNetworkArn"`
ServiceARN string `json:"serviceArn"`
TargetGroupARN string `json:"targetGroupArn"`
Identity *VPCLatticeRequestIdentity `json:"identity,omitempty"`
Region string `json:"region"`
TimeEpoch string `json:"timeEpoch"`
bmoffatt marked this conversation as resolved.
Show resolved Hide resolved
}

// VpcLatticeRequestIdentity contains information about the caller
type VPCLatticeRequestIdentity struct {
SourceVPCARN string `json:"sourceVpcArn"`
Type string `json:"type"`
Principal string `json:"principal"`
SessionName string `json:"sessionName"`
}

Comment on lines +34 to +41
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

reviewing - https://docs.aws.amazon.com/vpc-lattice/latest/ug/lambda-functions.html#receive-event-from-service

missing identity fields

principalOrgID – The ID of the organization for the authenticated principal. Present only if AWS authentication is successful.

x509IssuerOu – The issuer (OU).

x509SanDns – The subject alternative name (DNS).

x509SanNameCn – The issuer alternative name (Name/CN).

x509SanUri – The subject alternative name (URI).

x509SubjectCn – The subject name (CN).

// VPCLatticeResponse contains the response to be returned to VPC Lattice
type VPCLatticeResponse struct {
IsBase64Encoded bool `json:"isBase64Encoded,omitempty"`
StatusCode int `json:"statusCode"`
StatusDescription string `json:"statusDescription,omitempty"`
Headers map[string]string `json:"headers"`
Body string `json:"body"`
}
86 changes: 86 additions & 0 deletions events/vpclattice_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
package events

import (
"encoding/json"
"io/ioutil"
"testing"

"github.com/aws/aws-lambda-go/events/test"
"github.com/stretchr/testify/assert"
)

func TestVPCLatticeRequestV1Marshalling(t *testing.T) {

// read json from file
inputJSON, err := ioutil.ReadFile("./testdata/vpclattice-v1-request.json")
if err != nil {
t.Errorf("could not open test file. details: %v", err)
}

// de-serialize into Go object
var inputEvent VPCLatticeRequestV1
if err := json.Unmarshal(inputJSON, &inputEvent); err != nil {
t.Errorf("could not unmarshal event. details: %v", err)
}

// serialize to json
outputJSON, err := json.Marshal(inputEvent)
if err != nil {
t.Errorf("could not marshal event. details: %v", err)
}

assert.JSONEq(t, string(inputJSON), string(outputJSON))
}

func TestVPCLatticeRequestV1MalformedJson(t *testing.T) {
test.TestMalformedJson(t, VPCLatticeRequestV1{})
}

func TestVPCLatticeRequestV2Marshalling(t *testing.T) {

// read json from file
inputJSON, err := ioutil.ReadFile("./testdata/vpclattice-v2-request.json")
if err != nil {
t.Errorf("could not open test file. details: %v", err)
}

// de-serialize into Go object
var inputEvent VPCLatticeRequestV2
if err := json.Unmarshal(inputJSON, &inputEvent); err != nil {
t.Errorf("could not unmarshal event. details: %v", err)
}

// serialize to json
outputJSON, err := json.Marshal(inputEvent)
if err != nil {
t.Errorf("could not marshal event. details: %v", err)
}

assert.JSONEq(t, string(inputJSON), string(outputJSON))
}

func TestVPCLatticeRequestV2MalformedJson(t *testing.T) {
test.TestMalformedJson(t, VPCLatticeRequestV2{})
}

func TestVPCLatticeResponse(t *testing.T) {
// read json from file
inputJSON, err := ioutil.ReadFile("./testdata/vpclattice-response.json")
if err != nil {
t.Errorf("could not open test file. details: %v", err)
}

// de-serialize into Go object
var inputEvent VPCLatticeResponse
if err := json.Unmarshal(inputJSON, &inputEvent); err != nil {
t.Errorf("could not unmarshal event. details: %v", err)
}

// serialize to json
outputJSON, err := json.Marshal(inputEvent)
if err != nil {
t.Errorf("could not marshal event. details: %v", err)
}

assert.JSONEq(t, string(inputJSON), string(outputJSON))
}