https://github.com/codetrial/egg-token

Egg.js middleware that uses encrypted token to authenticate.
https://github.com/codetrial/egg-token

authentication egg egg-plugin koa middleware token-based-authentication

Last synced: 3 months ago
JSON representation

Egg.js middleware that uses encrypted token to authenticate.

• Host: GitHub
• URL: https://github.com/codetrial/egg-token
• Owner: codetrial
• License: mit
• Created: 2018-12-17T15:19:21.000Z (about 6 years ago)
• Default Branch: develop
• Last Pushed: 2018-12-23T16:53:10.000Z (about 6 years ago)
• Last Synced: 2024-08-10T06:13:19.606Z (6 months ago)
• Topics: authentication, egg, egg-plugin, koa, middleware, token-based-authentication
• Language: JavaScript
• Homepage: https://codetrial.github.io/egg-token
• Size: 67.4 KB
• Stars: 9
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# egg-token

Egg.js middleware that uses encrypted token to authenticate.

[![License](https://img.shields.io/github/license/codetrial/egg-token.svg)](https://github.com/codetrial/egg-token)

[![Version](https://img.shields.io/npm/v/egg-token.svg)](https://www.npmjs.com/package/egg-token)

[![codecov](https://codecov.io/gh/codetrial/egg-token/branch/develop/graph/badge.svg)](https://codecov.io/gh/codetrial/egg-token)

[![TravisCI](https://travis-ci.org/codetrial/egg-token.svg?branch=develop)](https://travis-ci.org/codetrial/egg-token)

## Install

```bash

npm i egg-token

# or

yarn add egg-token

```

## Usage

```js

// {app_root}/config/plugin.js

exports.token = {

  enable: true,

  package: 'egg-token'

};

```

## Configuration

```js

// {app_root}/config/config.default.js

exports.middleware = ['token'];

exports.token = {

  type: 'md5',

  apps: {

    felixpy: {

      secret: 'XnMib79vzwP01gtr',

      expires: 30000

    },

    codetrial: {

      secret: 'mi9yNGT6zwrqMv8z',

      expires: 30000

    }

  }

};

```

`type` is the algorithm that can be used to generate hash digests.

See [crypto.createHash](https://nodejs.org/api/crypto.html#crypto_crypto_createhash_algorithm_options) for more detail.

Each key of `apps` is the application's code, `secret` is used to generate token and `expires` is the validity period of the token.

The way to generate tokens is as follows:

```js

const ts = Date.now();

const md5Value = md5(`${APP_CODE}:${ts}:${APP_SECRET}`);

const token = base64Encode(`${APP_CODE}:${ts}:${md5Value}`);

```

## Example

This is an example of using axios to request an api:

```js

const crypto = require('crypto');

const axios = require('axios');

const hash = crypto.createHash('md5');

const APP_CODE = 'felixpy';

const APP_SECRET = 'XnMib79vzwP01gtr';

const ts = Date.now();

const md5Value = hash.update(`${APP_CODE}:${ts}:${APP_SECRET}`).digest('hex');

const token = Buffer.from(`${APP_CODE}:${ts}:${md5Value}`).toString('base64');

axios.get('/url/to/your/egg/service', {

  headers: {

    'egg-api-token': token

  }

});

```

## License

[MIT](http://opensource.org/licenses/MIT)

Copyright (c) 2018 - present, Felix Yang