https://github.com/jessety/simple-hmac-auth-koa

Koa middleware for creating APIs that implement hmac signatures
https://github.com/jessety/simple-hmac-auth-koa

api-security hmac-authentication koa koa-middleware request-signatures request-signing simple-hmac-auth

Last synced: about 1 month ago
JSON representation

Koa middleware for creating APIs that implement hmac signatures

• Host: GitHub
• URL: https://github.com/jessety/simple-hmac-auth-koa
• Owner: jessety
• License: mit
• Created: 2019-05-31T18:51:25.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2022-08-21T21:43:16.000Z (about 2 years ago)
• Last Synced: 2024-10-01T02:21:20.463Z (about 1 month ago)
• Topics: api-security, hmac-authentication, koa, koa-middleware, request-signatures, request-signing, simple-hmac-auth
• Language: TypeScript
• Homepage: https://npmjs.com/package/simple-hmac-auth-koa
• Size: 81.1 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# simple-hmac-auth-koa

Koa middleware for creating APIs that implement [simple-hmac-auth](https://github.com/jessety/simple-hmac-auth).

[![ci](https://github.com/jessety/simple-hmac-auth-koa/workflows/ci/badge.svg)](https://github.com/jessety/simple-hmac-auth-koa/actions)

[![coverage](https://codecov.io/gh/jessety/simple-hmac-auth-koa/branch/main/graph/badge.svg?token=HK2X2I5673)](https://codecov.io/gh/jessety/simple-hmac-auth-koa)

[![npm](https://img.shields.io/npm/v/simple-hmac-auth-koa.svg)](https://www.npmjs.com/package/simple-hmac-auth-koa)

[![license](https://img.shields.io/github/license/jessety/simple-hmac-auth-koa.svg)](https://github.com/jessety/simple-hmac-auth-koa/blob/master/LICENSE)

## Usage

Instantiating the middleware requires a function that can return a secret for a given API key.

If a request fails authentication, it will throw a `401` error.

The `simple-hmac-auth` authentication protocol requires the raw body of a request to validate it. `simple-hmac-auth-koa` leverages `koa-bodyparser` to parse body data. However, because the body parser only supports `json`, `form` and `text` input, this project is currently limited to those inputs as well.

```javascript

import Koa from 'koa';

import Router from 'koa-router';

import auth from 'simple-hmac-auth-koa';

```

```javascript

const app = new Koa();

// Enable authentication

app.use(auth({

  secretForKey: async apiKey => {

    // Return the correct secret for the given API key

    return 'SECRET';

  }

}));

// Route incoming requests

const router = new Router();

router.all('/', ctx => {

  ctx.body = 'Request successful.';

});

app.use(router.routes());

app.use(router.allowedMethods());

// Listen

app.listen(8000);

```

## License

MIT © Jesse Youngblood