https://github.com/thinkjs/think-session-jwt

JsonWebToken for ThinkJS 3.x.
https://github.com/thinkjs/think-session-jwt

Last synced: 2 months ago
JSON representation

JsonWebToken for ThinkJS 3.x.

• Host: GitHub
• URL: https://github.com/thinkjs/think-session-jwt
• Owner: thinkjs
• License: mit
• Created: 2017-08-17T11:05:05.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2023-03-02T12:55:33.000Z (almost 2 years ago)
• Last Synced: 2024-10-03T19:15:35.322Z (3 months ago)
• Language: JavaScript
• Size: 1.1 MB
• Stars: 11
• Watchers: 12
• Forks: 1
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• think-awesome - think-session-jwt

README

        
# think-session-jwt

JsonWebToken to store session for ThinkJS 3.x base on [node-jsonwebtoken](https://github.com/auth0/node-jsonwebtoken)

[![Build Status](https://travis-ci.org/thinkjs/think-session-jwt.svg?branch=master)](https://travis-ci.org/thinkjs/think-session-jwt)

[![Coverage Status](https://coveralls.io/repos/github/thinkjs/think-session-jwt/badge.svg?branch=master)](https://coveralls.io/github/thinkjs/think-session-jwt?branch=master)

[![npm version](https://badge.fury.io/js/think-session-jwt.svg)](https://badge.fury.io/js/think-session-jwt)

## Install

```bash

npm install think-session-jwt --save

```

## Quick Start

```js

const JWTSession = require('think-session-jwt');

exports.session = {

  type: 'jwt',

  common: {

    cookie: {

      name: 'thinkjs',

    }

  },

  jwt: {

    handle: JWTSession,

    secret: 'secret', // secret is reqired

    tokenType: 'cookie', // ['query', 'body', 'header', 'cookie'], 'cookie' is default

    tokenName: 'jwt', // if tokenType not 'cookie', this will be token name, 'jwt' is default

    sign: {

      // sign options is not required

    },

    verify: {

      // verify options is not required

    },

    verifyCallback: any => any, // default verify fail callback

  }

}

```

1. session数据从token中获取，通过配置tokenType指定token来源；

2. 设置session数据后会返回token字符串；

3. 配置`verifyCallback`函数，验证失败时返回该函数运行的结果；

### Sign and verify options

使用[node-jsonwebtoken](https://github.com/auth0/node-jsonwebtoken)的配置。