• Stars
    star
    135
  • Rank 269,297 (Top 6 %)
  • Language
    Go
  • License
    Apache License 2.0
  • Created over 4 years ago
  • Updated 11 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Go HTTP router library for AWS API Gateway-invoked Lambda Functions

lmdrouter

Build Status

Go HTTP router library for AWS API Gateway-invoked Lambda Functions

Table of Contents

Overview

lmdrouter is a simple-to-use library for writing AWS Lambda functions in Go that listen to events of type API Gateway Proxy Request. It allows creating a lambda function that can match requests based on their URI, just like an HTTP server would.

The library provides an interface not unlike the standard net/http.Mux type or community libraries such as httprouter and chi.

Use Case

When building large cloud-native applications, there's a certain balance to strike when it comes to deployment of APIs. On one side of the scale, each API endpoint has its own lambda function. This provides the greatest flexibility, but is extremely difficult to maintain. On the other side of the scale, there can be one lambda function for the entire API. This provides the least flexibility, but is the easiest to maintain. Both are probably not a good idea.

With lmdrouter, one can create small lambda functions for different aspects of the API. For example, if your application model contains multiple domains (e.g. articles, authors, topics, etc…), you can create one lambda function for each domain, and deploy these independently (e.g. everything below "/api/articles" is one lambda function, everything below "/api/authors" is another function). This is also useful for applications where different teams are in charge of different parts of the API.

Features

  • Supports all HTTP methods.
  • Supports middleware at a global and per-resource level.
  • Supports path parameters with a simple ":" format (e.g. "/posts/:id").
  • Provides ability to automatically "unmarshal" an API Gateway request to an arbitrary Go struct, with data coming from the request path, the query string, the headers and the request body (only JSON requests are currently supported).
  • Provides ability to automatically "marshal" responses of any type to an API Gateway response (only JSON responses are currently generated).
  • Implements net/http.Handler for running locally or as a simple HTTP server.

Installation

go get github.com/aquasecurity/lmdrouter

Usage

lmdrouter is meant to be used inside Go Lambda functions.

package main

import (
    "github.com/aws/aws-lambda-go/lambda"
    "github.com/aquasecurity/lmdrouter"
)

var router *lmdrouter.Router

func init() {
    router = lmdrouter.NewRouter("/api", loggerMiddleware, authMiddleware)
    router.Route("GET", "/", listSomethings)
    router.Route("POST", "/", postSomething, someOtherMiddleware)
    router.Route("GET", "/:id", getSomething)
    router.Route("PUT", "/:id", updateSomething)
    router.Route("DELETE", "/:id", deleteSomething)
}

func main() {
    lambda.Start(router.Handler)
}

// the rest of the code is a redacted example, it will probably reside in a
// separate package inside your project

type listSomethingsInput struct {
    ID                string   `lambda:"path.id"`                // a path parameter declared as :id
    ShowSomething     bool     `lambda:"query.show_something"`   // a query parameter named "show_something"
    AcceptedLanguages []string `lambda:"header.Accept-Language"` // a multi-value header parameter
}

type postSomethingInput struct {
    Title   string    `json:"title"`
    Date    time.Time `json:"date"`
}

func listSomethings(ctx context.Context, req events.APIGatewayProxyRequest) (
    res events.APIGatewayProxyResponse,
    err error,
) {
    // parse input from request and path parameters
    var input listSomethingsInput
    err = lmdrouter.UnmarshalRequest(req, false, &input)
    if err != nil {
        return lmdrouter.HandleError(err)
    }

    // call some business logic that generates an output struct
    // ...

    return lmdrouter.MarshalResponse(http.StatusOK, nil, output)
}

func postSomethings(ctx context.Context, req events.APIGatewayProxyRequest) (
    res events.APIGatewayProxyResponse,
    err error,
) {
    // parse input from request body
    var input postSomethingsInput
    err = lmdrouter.UnmarshalRequest(req, true, &input)
    if err != nil {
        return lmdrouter.HandleError(err)
    }

    // call some business logic that generates an output struct
    // ...

    return lmdrouter.MarshalResponse(http.StatusCreated, nil, output)
}

func loggerMiddleware(next lmdrouter.Handler) lmdrouter.Handler {
    return func(ctx context.Context, req events.APIGatewayProxyRequest) (
        res events.APIGatewayProxyResponse,
        err error,
    ) {
        // [LEVEL] [METHOD PATH] [CODE] EXTRA
        format := "[%s] [%s %s] [%d] %s"
    	level := "INF"
    	var code int
    	var extra string

    	res, err = next(ctx, req)
    	if err != nil {
    	    level = "ERR"
    	    code = http.StatusInternalServerError
    	    extra = " " + err.Error()
    	} else {
    	    code = res.StatusCode
    	    if code >= 400 {
    	        level = "ERR"
    	    }
        }

        log.Printf(format, level, req.HTTPMethod, req.Path, code, extra)

        return res, err
    }
}

Note that for requests with a body (e.g. POST, PUT, PATCH), the struct types of your inputs can contain parameters from all sources: path parameters, query string parameters, request headers and the JSON body. Anything that doesn't have a lambda struct tag is taken from the body. Regular json tags can be used for that.

Static Compilation for AWS Lambda

To ensure Lambda applications using lmdrouter (or any Lambda applications written in Go, for that matter) will properly work in AWS's Go runtime, make sure to compile your applications statically. You can either disable CGO completely using CGO_ENABLED=0, or use the following build flags:

go build -tags netgo -ldflags "-s -w"

License

This library is distributed under the terms of the Apache License 2.0.

More Repositories

1

trivy

Find vulnerabilities, misconfigurations, secrets, SBOM in containers, Kubernetes, code repositories, clouds and more
Go
22,757
star
2

tfsec

Tfsec is now part of Trivy
Go
6,659
star
3

kube-bench

Checks whether Kubernetes is deployed according to security best practices as defined in the CIS Kubernetes Benchmark
Go
5,935
star
4

kube-hunter

Hunt for security weaknesses in Kubernetes clusters
Python
4,709
star
5

tracee

Linux Runtime Security and Forensics using eBPF
Go
3,601
star
6

cloudsploit

Cloud Security Posture Management (CSPM)
JavaScript
3,304
star
7

starboard

Moved to https://github.com/aquasecurity/trivy-operator
Go
1,346
star
8

trivy-operator

Kubernetes-native security toolkit
Go
1,249
star
9

microscanner

Scan your container images for package vulnerabilities with Aqua Security
Dockerfile
856
star
10

kubectl-who-can

Show who has RBAC permissions to perform actions on different resources in Kubernetes
Go
810
star
11

trivy-action

Runs Trivy as GitHub action to scan your Docker container image for vulnerabilities
Shell
807
star
12

libbpfgo

eBPF library for Go. Powered by libbpf.
Go
731
star
13

chain-bench

An open-source tool for auditing your software supply chain stack for security compliance based on a new CIS Software Supply Chain benchmark.
Go
725
star
14

cloud-security-remediation-guides

Security Remediation Guides
698
star
15

vuln-list

NVD, Ubuntu, Alpine
408
star
16

btfhub

BTFhub, in collaboration with the BTFhub Archive repository, supplies BTF files for all published kernels that lack native support for embedded BTF. This joint effort ensures that even kernels without built-in BTF support can effectively leverage the benefits of eBPF programs, promoting compatibility across various kernel versions.
Go
386
star
17

esquery

An idiomatic Go query builder for ElasticSearch
Go
305
star
18

traceeshark

Deep Linux runtime visibility meets Wireshark
C
244
star
19

trivy-db

Go
224
star
20

kube-query

[EXPERIMENTAL] Extend osquery to report on Kubernetes
Go
223
star
21

harbor-scanner-trivy

Use Trivy as a plug-in vulnerability scanner in the Harbor registry
Go
218
star
22

defsec

Trivy's misconfiguration scanning engine
Go
213
star
23

postee

Simple message routing system that receives input messages through a webhook interface and can enforce actions using predefined outputs via integrations.
Go
201
star
24

fanal

Static Analysis Library for Containers
Go
200
star
25

cloudsec-icons

A collection of cloud security icons ☁️🔒
Go
186
star
26

docker-bench

Checks whether Docker is deployed according to security best practices as defined in the CIS Docker Benchmark
Go
179
star
27

vuln-list-update

Go
173
star
28

manifesto

Use Manifesto to store and query metadata for container images.
Go
164
star
29

tfsec-pr-commenter-action

Add comments to pull requests where tfsec checks have failed
Go
164
star
30

linux-bench

Checks whether a Linux server according to security best practices as defined in the CIS Distribution-Independent Linux Benchmark
Go
152
star
31

go-dep-parser

Dependency Parser for Multiple Programming Languages
Go
144
star
32

appshield

Security configuration checks for popular cloud native applications and infrastructure.
Open Policy Agent
118
star
33

starboard-lens-extension

Lens extension for viewing Starboard security information
TypeScript
117
star
34

trivy-vscode-extension

A VS Code Extension for Trivy
TypeScript
116
star
35

btfhub-archive

The BTFhub Archive repository provides BTF files for those published kernels that lack native support for embedded BTF, thereby enhancing the versatility of eBPF programs across different kernel versions.
94
star
36

aqua-helm

Helm Charts For Installing Aqua Security Components
Mustache
86
star
37

table

🧮 Tables for terminals, in Go.
Go
81
star
38

tracee-action

Protect GitHub Actions with Tracee
Open Policy Agent
78
star
39

cfsec

Static analysis for CloudFormation templates to identify common misconfiguration
Go
58
star
40

starboard-octant-plugin

Octant plugin for viewing Starboard security information
Go
57
star
41

deployments

All Aqua deployments options and aquactl configuration
Shell
56
star
42

tfsec-sarif-action

Shell
52
star
43

tfsec-action

Vanilla GitHub action to run tfsec
Shell
52
star
44

trivy-azure-pipelines-task

An Azure Pipelines Task for trivy
TypeScript
46
star
45

community

Aqua Security's open source community
40
star
46

trivy-operator-lens-extension

https://github.com/aquasecurity/trivy-operator
TypeScript
37
star
47

terraform-provider-aquasec

Go
35
star
48

go-version

A Go library for parsing and verifying versions and version constraints.
Go
35
star
49

harbor-scanner-aqua

Aqua Enterprise scanner as a plug-in vulnerability scanner in the Harbor registry
Go
35
star
50

aqua-operator

The aqua-operator is a group of controllers that runs within a Kubernetes or Openshift cluster that provides a means to deploy and manage Aqua Security cluster and Components.
Go
34
star
51

trivy-checks

Go
34
star
52

trivy-java-db

Go
30
star
53

vscode-tfsec

vscode extension for tfsec
TypeScript
30
star
54

trivy-kubernetes

Trivy kubernetes library
Go
29
star
55

trivy-plugin-kubectl

A Trivy plugin that scans the images of a kubernetes resource
Shell
25
star
56

trivy-docker-extension

Docker Desktop Extension for Trivy
TypeScript
20
star
57

trivy-plugin-referrer

Trivy plugin for OCI referrers
Go
20
star
58

trivy-enforcer

[EXPERIMENTAL] Kubernetes Operator for Image Assurance
Go
20
star
59

chain-bench-action

Shell
19
star
60

aqua-aws

The repository not supported any more. Please use this one https://github.com/aquasecurity/deployments
HCL
18
star
61

trivy-pipe

Bitbucket Pipe for running Trivy in a Pipeline
Shell
17
star
62

starboard-operator

The Starboard Operator has moved to the main Starboard repo, and this one is being retired
Go
16
star
63

windows-bench

Checks whether a Windows server according to security best practices as defined in the CIS Distribution-Independent Windows Benchmark
Go
16
star
64

saas-terraform-connection

Terraform modules for CloudSploit Scanner
HCL
14
star
65

trivy-ci-test

Dockerfile
14
star
66

vexhub

13
star
67

saas-api-samples

Sample code snippets for consuming the CloudSploit API
JavaScript
13
star
68

helm-charts

Aqua Open Source Helm Chart Repository
13
star
69

circleci-orb-microscanner

Enables scanning of docker builds in CircleCi for OS package vulnerabilities.
Dockerfile
13
star
70

vim-trivy

Vim Plugin for Trivy
Vim Script
13
star
71

vim-tfsec

List your tfsec issues in the QuickFix window with this plugin.
Vim Script
12
star
72

trivy-aws

Go
11
star
73

trivy-plugin-aqua

Makefile
11
star
74

go-git-pr-commenter

library for adding comments to git PRs
Go
11
star
75

binfinder

Find binary files not installed through package manager
Go
11
star
76

trivy-sarif-demo

JavaScript
9
star
77

cloud-metadata

Common metadata repository for CSPM and TFSec checks
Go
9
star
78

tracee-test-kernels

Kernels for testing tracee CO-RE feature
C
9
star
79

bench-common

Common code for hardening benchmarks
Go
9
star
80

trivy-repo

deb/rpm repository for Trivy
9
star
81

aws-security-hub-plugin

Aqua Security AWS Security Hub plugin
9
star
82

tracee-tester

This is a spin-off from Tracee project responsible for generating the docker image that tests open-source signatures.
Shell
9
star
83

gobard

Unofficial Golang API for Bard Chat.
Go
8
star
84

aqua-dash

Sample Aqua CSP dashboard
Vue
8
star
85

trivy-iac

Go
7
star
86

scan-cve-2018-8115

Python
7
star
87

amazon-eks-devsecops

PHP
7
star
88

pipeline-enforcer-action

TypeScript
7
star
89

intellij-trivy

Trivy Plugin for the JetBrains family of IDEs
Java
7
star
90

go-pep440-version

A golang library for parsing PEP 440 compliant Python versions
Go
7
star
91

tfsec-azure-pipelines-task

An Azure DevOps Task for tfsec
TypeScript
7
star
92

build-security-action

GitHub Action for Aqua Build Security
Shell
7
star
93

go-npm-version

A golang library for parsing npm versions
Go
6
star
94

saas-integrations

CloudSploit third-party integrations
JavaScript
6
star
95

trivy-plugin-attest

Publish SBOM attestation
Go
6
star
96

k8s-node-collector

Go
6
star
97

secfixes-tracker

Forked from https://gitlab.alpinelinux.org/kaniini/secfixes-tracker
Python
6
star
98

trivy-module-wordpress

Trivy example module for WordPress
Go
5
star
99

reportgen

PDF reports for Aqua CSP image and host vulnerabilities
Go
5
star
100

vuln-list-nvd

NVD
5
star