Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fibjs/fib-session
Session middleware for fibjs
https://github.com/fibjs/fib-session
Last synced: 3 months ago
JSON representation
Session middleware for fibjs
- Host: GitHub
- URL: https://github.com/fibjs/fib-session
- Owner: fibjs
- License: mit
- Created: 2017-05-04T07:45:44.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-07-10T18:07:42.000Z (4 months ago)
- Last Synced: 2024-07-10T21:41:02.732Z (4 months ago)
- Language: JavaScript
- Homepage:
- Size: 93.8 KB
- Stars: 2
- Watchers: 2
- Forks: 9
- Open Issues: 0
-
Metadata Files:
- Readme: Readme.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome - fib-session - Session middleware for fibjs. (Packages / Server App)
README
# fib-session
[](https://www.npmjs.org/package/fib-session)
[](https://travis-ci.org/fibjs/fib-session)
[](https://ci.appveyor.com/project/richardo2016/fib-session)
Session middleware for fibjs
## Install
```sh
npm install fib-session [--save]
```
## Test
```sh
npm run ci
```
## Creating a cookie-based session middleware
```js
var Session = require('fib-session')
var session = new Session(conn, opts);
var srv = new http.Server(8000, [
session.cookie_filter, // use session ID via cookie
{
// routers
'^/foo$': (r) => {
var v = r.session.v;
},
...
}
]);
```
## Creating a api session middleware
```js
var Session = require('fib-session')
var session = new Session(conn, opts);
var srv = new http.Server(8000, [
session.api_filter, // use api session filter
{
// routers
'^/foo$': (r) => {
var v = r.session.v;
},
'^/get-token$': session.api_token
}
]);
```
*Both kv options and sesion options are in the same object.*
kv-store options
| options | default | object/Map | LruCache | LevelDB | Redis | MongoDB | SQLite/MySQL |
|----------------------|---------|------------|----------|---------|-------|---------|--------------|
| table_name | "kvs" | x | x | x | √ | √ | √ |
| key_name | "k" | x | x | x | x | √ | √ |
| value_name | "v" | x | x | x | x | √ | √ |
| key_size | 32 | x | x | x | x | x | √ |
| value_size | 256 | x | x | x | x | x | √ |
| cleanup_interval(ms) | 60000 | x | x | x | x | x | √ |
| timeout(ms) | 0 | x | √ | x | √ | √ | √ |
| prefix | "" | √ | √ | √ | √ | √ | √ |
| cache | false | √ | √ | √ | √ | √ | √ |
| cache_size | 65536 | √ | √ | √ | √ | √ | √ |
| cache_timeout(ms) | 60000 | √ | √ | √ | √ | √ | √ |
session options
| options | default | |
|---------------------------|--------------------|--------------------------------------------------------------------------------------------------|
| session_cache_size | 65536 | max number of session in cache |
| session_cache_timeout(ms) | 900000 | clear session objects which is not operated for a period of time from buffer, default 15 minutes |
| session_cache_delay | 100 | time delay for write session to persistent storage |
| session_id_name | "sessionID" | |
- session cache is used to keep session consistency among http requires.
- the timeout of session cache must be larger than its delay
- The client-side has only the session ID. The session is operated on the server-side.
## Methods
### session.setup()
setup the backend database.
### v = session.cookie_filter
returns a cookie-based session filter.
### session.api_filter
returns a header-based session filter.
### session.api_token
returns an api handler that gets a new session ID.
JSON Web Token(JWT)
---
options
| options | default | |
|---------------------------|---------|-------------------------------------------|
| session_jwt_algo | null | see jws.ALGORITHMS in fib-jws |
| session_jwt_key | null | sign key. see in fib-jws |
- see fib-jws https://github.com/fibjs/fib-jws
- set session_jwt_algo and session_jwt_key to enable JWT
```javascript
// session_jwt_algo is encryption algorithms in fib-jws
// session_jwt_key is to verify the signature.
var session = new Session(conn, { session_jwt_algo: 'HS256', session_jwt_key: verify_key })
```
## Methods
### session.setTokenCookie
- set the JSON Web Token in cookie
- sign_key for signature, may be different from session_jwt_key, depending on the algorithm.
- according to JSON Web Token specification, one user session can only be called setTokenCookie once for set user session info. The second will throw an exception: new Error('Can't modify the JSON Web Token')
- default value r.session={}
```javascript
// sign user info: { id: 12345, name: "Frank" }, and set the cookie
// r is request
session.setTokenCookie(r, { id: 12345, name: "Frank" }, sign_key)
```
### session.getToken
- get token for api filter mode, see session.api_filter
```javascript
session.getToken ({ id: 12345, name: "Frank" }, sign_key)
```