Awesome
Serverless Resource Policy
Creates a whitelist for IP or CIDR addresses accessing a serverless application, using serverless resource policies. This enables you to allow requests only from the IP or CIDR addresses you specify.
Private and Public Stages
CIDR and IP addresses are whitelisted by stages.
privateStages
: Private to whitelisted CIDR and IP addresses. In the example below, ourdev
andstaging
stages areprivateStages
, so only those CIDR and IP addresses can accessdev
andstaging
.publicStages
: No whitelisting necessary. These stages are public to all CIDR and IP addresses.
How to Use
- Install in your serverless application:
npm install --save serverless-resource-policy
- In your
serverless.yml
file, add theserverless-resource-plugin
, for example:plugins: - serverless-resource-policy
- Within the
provider
block, add astage
variable:provider: stage: ${opt:stage, 'dev'}
- Within a
custom
block, add:custom: serverless-resource-policy: stage: ${self:provider.stage} privateStages: - dev - staging publicStages: - production netblocks: - 123.45.67.890/30 - 987.65.432.109
The
netblocks
object will contain the list of whitelisted IPs.
Full Example
# serverless.yml
service: my-service-name
plugins:
- serverless-resource-policy
provider:
stage: ${opt:stage, 'dev'}
custom:
serverless-resource-policy:
stage: ${self:provider.stage}
privateStages:
- dev
- staging
publicStages:
- production
netblocks:
- 123.45.67.890/30
- 987.65.432.109
Contributing
Currently maintained by the lovely folks on HubSpot's Web Team, but we need your help. Please feel free to submit pull requests to add new functionality.