# egg-full-jwt

[![NPM version][npm-image]][npm-url]
[![build status][travis-image]][travis-url]
[![Test coverage][codecov-image]][codecov-url]
[![David deps][david-image]][david-url]
[![Known Vulnerabilities][snyk-image]][snyk-url]
[![npm download][download-image]][download-url]

[npm-image]: https://img.shields.io/npm/v/egg-full-jwt.svg?style=flat-square
[npm-url]: https://npmjs.org/package/egg-full-jwt
[travis-image]: https://img.shields.io/travis/eggjs/egg-full-jwt.svg?style=flat-square
[travis-url]: https://travis-ci.org/eggjs/egg-full-jwt
[codecov-image]: https://img.shields.io/codecov/c/github/eggjs/egg-full-jwt.svg?style=flat-square
[codecov-url]: https://codecov.io/github/eggjs/egg-full-jwt?branch=master
[david-image]: https://img.shields.io/david/eggjs/egg-full-jwt.svg?style=flat-square
[david-url]: https://david-dm.org/eggjs/egg-full-jwt
[snyk-image]: https://snyk.io/test/npm/egg-full-jwt/badge.svg?style=flat-square
[snyk-url]: https://snyk.io/test/npm/egg-full-jwt
[download-image]: https://img.shields.io/npm/dm/egg-full-jwt.svg?style=flat-square
[download-url]: https://npmjs.org/package/egg-full-jwt

<!--
Description here.
-->

## 依赖

> jsonwebtoken@8.4.0

## 安装

```bash
$ npm i egg-full-jwt --save
```

## 使用

```js
// config/plugin.js
exports.fullJwt = {
  enable: true,
  package: 'egg-full-jwt',
};
```

## 配置

```js
// {app_root}/config/config.default.js
exports.fullJwt = {
  secret: '你的密钥', // 密钥
  exp: 3600, // 有效时间，默认为 3600秒
};
```

请到 [config/config.default.js](config/config.default.js) 查看详细配置项说明。

## 示例

```js
'use strict';

// 登录的时候设置 jwt token 到 cookie 中
// 访问首页的时候，判断 jwt token 是否有效，可以进一步验证 userId 是否是有效值

module.exports = app => {
  class HomeController extends app.Controller {
    // /login?userId=10001
    async login() {
      // password check ...

      const { userId } = this.ctx.query;

      const token = await app.fullJwt.sign({ userId });

      // cookies
      this.ctx.cookies.set('token', token, {
        maxAge: 24 * 3600 * 1000 * 1,
        httpOnly: true,
      });

      this.ctx.body = 'login success';
    }

    async index() {
      const token = this.ctx.cookies.get('token');

      if (!token) {
        this.ctx.redirect('/login');
      }

      const { userId } = await app.fullJwt.verify(token);

      if (!userId) {
        this.ctx.redirect('/login');
      }

      this.ctx.body = 'hello World';
    }
  }
  return HomeController;
};
```

## License

[MIT](LICENSE)