Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/f0rmiga/sessiongate
⚡️A Redis module that provides session management.
https://github.com/f0rmiga/sessiongate
redis redis-module session session-management session-manager session-store sessionmanager sessions sessionstorage sessionstore
Last synced: 13 days ago
JSON representation
⚡️A Redis module that provides session management.
- Host: GitHub
- URL: https://github.com/f0rmiga/sessiongate
- Owner: f0rmiga
- License: mit
- Created: 2017-03-01T09:41:53.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-02-25T03:27:19.000Z (over 1 year ago)
- Last Synced: 2024-05-22T15:32:59.273Z (6 months ago)
- Topics: redis, redis-module, session, session-management, session-manager, session-store, sessionmanager, sessions, sessionstorage, sessionstore
- Language: C
- Homepage:
- Size: 86.9 KB
- Stars: 53
- Watchers: 7
- Forks: 4
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://circleci.com/gh/f0rmiga/sessiongate/tree/master)
[](https://app.fossa.com/projects/git%2Bgithub.com%2Ff0rmiga%2Fsessiongate?ref=badge_large)
# Session Gate
Session Gate is a Redis module to ease session management using tokens. This module does NOT do user
management, don't get confused. In the real world, most of the sessions are related to a user but do
your crazy logic to manage the users the way you want.
## How it works
This module provides creation and administration of sessions using tokens. Each session can have
more than one payload and those payloads can be accessed individually. A single instance of Redis
loaded with this module can handle sessions from multiple applications.
Redis is a high performance, in-memory data structure store. This module is built on top of it,
meaning this module operates in a very similar way Redis itself operates.
To access this module, any Redis compatible driver can be used. The commands to operate this module
are exposed like any other Redis command.
To know more about Redis modules, follow this [link](http://antirez.com/news/106).
## How to build
The module is written in C and uses Bazel to build. Bazel manages all the dependencies. :D
The dependencies are:
- [Redis Modules SDK](https://github.com/RedisLabs/RedisModulesSDK)
- [Sodium crypto library (libsodium)](https://download.libsodium.org/doc/)
### Building on Linux/OS X
Run:
```txt
bazel build //:sessiongate.so
```
### Building on Windows
¯\\\_(ツ)\_/¯
### Building the Docker image
On Linux, Docker is necessary only if you want to load the built image into the daemon (which is
almost always the case). On OS X and Windows, Docker is always required to be installed.
On Linux, simply run `bazel run //:sessiongate_image`. It will build and load the image.
On OS X and Windows, run the script `./build_and_load_image_with_docker.sh`, which uses Docker in
Docker for building the module and appending it as a layer on top of the Redis image.
## How to run tests
Tests are located under `tests/` directory and are written in Python. You should have Python 2.7+
installed in order to run the tests. Run:
```txt
bazel test //...
```
For verbose tests run:
```txt
bazel test --test_output=all //...
```
## Loading the module for use
The module can be loaded in Redis 4+. The most convenient way to do that is by passing --loadmodule
parameter when starting the Redis server:
```txt
redis-server --loadmodule
```
For example, starting Redis open to the world and the Session Gate loaded:
```txt
redis-server --protected-mode no --loadmodule $(pwd)/bazel-bin/sessiongate.so
```
Just make sure to pass the right `sessiongate.so` path value to the --loadmodule parameter.
## Commands
### Start a session
Command: `SESSIONGATE.START `
- `` is the secret string used by the HMAC algorithm to generate the token signature.
- `` is the positive integer that represents the seconds that the session will live. If set to
0, the session expires immediately.
#### Example
```txt
SESSIONGATE.START 'qwerty' 300
```
Returns: a token that is used to manage the session.
### Set a session TTL
Command: `SESSIONGATE.EXPIRE `
- `` is the secret string used by the HMAC algorithm to verify the token signature.
- `` is the token returned by the START command.
- `` is the positive integer that represents the seconds that the session will live. If set to
0, the session expires immediately.
#### Example
```txt
SESSIONGATE.EXPIRE 'qwerty' 300
```
Returns: OK.
### Set a session payload
Command: `SESSIONGATE.PSET `
- `` is the secret string used by the HMAC algorithm to verify the token signature.
- `` is the token returned by the START command.
- `` is the payload name that is used to identify the payload data.
- `` is the payload data. It can be any string, for example, a JSON stringified
object.
#### Example
```txt
SESSIONGATE.PSET 'qwerty' 'user' '{"name":"John Doe"}'
```
Returns: OK.
### Get a session payload
Command: `SESSIONGATE.PGET `
- `` is the secret string used by the HMAC algorithm to verify the token signature.
- `` is the token returned by the START command.
- `` is the payload name that is used to retrieve the payload data.
#### Example
```txt
SESSIONGATE.PGET 'qwerty' 'user'
```
Returns: a string containing the payload data.
### Delete a session payload
Command: `SESSIONGATE.PDEL `
- `` is the secret string used by the HMAC algorithm to verify the token signature.
- `` is the token returned by the START command.
- `` is the payload name that is used to identify the payload data being deleted.
#### Example
```txt
SESSIONGATE.PDEL 'qwerty' 'user'
```
Returns: OK.
### End a session
Command: `SESSIONGATE.END `
- `` is the secret string used by the HMAC algorithm to verify the token signature.
- `` is the token returned by the START command.
#### Example
```txt
SESSIONGATE.END 'qwerty'
```
Returns: OK.
## Specific language drivers
Here is a list of drivers implemented in specific languages to ease the use of the SessionGate
module:
### Go
https://github.com/f0rmiga/sessiongate-go