Giter Club home page Giter Club logo

serverless-custom-auth-plugin's Introduction

Serverless AWS Custom Auth Plugin - deprecated

=============================

A serverless plugin that adds the possibility to configure AWS_IAM or Cognito Auth for your API Gateway endpoints and 'Invoke with caller credentials'. The reason why we made this plugin is because by the default serverless will generate a random authorizer name from the Cognito User Pool, there is no way to configure Authorizer ID or specify a name of new authorizer to be created if not exist.

Note: Serverless v1.0.0 or higher is required.

Installation

Add the plugin to your package.json's devDependencies and to the plugins array in your serverless.yml file. After installation the plugin will automatically hook into the deployment process.

npm install serverless-custom-auth-plugin --save-dev
plugins:
  - other plugins
  - serverless-custom-auth-plugin

Usage

First, you will need to add your custom Authorizer with a friendly name

XXXAuthorizer:
  Type: AWS::ApiGateway::Authorizer
  Properties:
    AuthorizerUri:
      Ref: CognitoUserPoolXXX
    IdentitySource: method.request.header.Authorization
    Name: Friendly Name of this authorizer
    ProviderARNs:
      - Ref: CognitoUserPoolXXX
    RestApiId:
      Ref: ApiGatewayRestApi
    Type: COGNITO_USER_POOLS

and configure your event

myFunc:
  handler: myFunc.get
  name: ${self:provider.stage}-myFunc-get-item
  memorySize: 128
  events:
    - http:
      method: GET
      path: api-path
      cors: true 
      invokeWithCallerCredentials: true
      useIAMAuth: true // Use IAM auth
      useCognitoAuth: true // Or, we can use Cognito Auth
      authorizerId:
        Ref: XXXAuthorizer // Your authorizer resource in serverless.yml

License

MIT

serverless-custom-auth-plugin's People

Contributors

hoang-innomize avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.