jscas-server v1.0.1

JSCAS

JSCAS provides a Node native implementation of a CAS server. It is extensible via a simple plugin interface, and implements versions 1.0, 2.0, and 3.0 of the protocol. It currently supports the authentication and service validation mechanisms of all three versions; proxy support will be added later.

In general, JSCAS attempts to meet the following goals:

1. Be more easily customizable than the standard reference implementation.
2. Be easily extensible through plugins.
3. "Just work" with a minimal amount of configuration (due the protocol's nature, some configuration is absolutely required).

Protocol compatibility special note: this server will prefer adhering to the latest version of the protocol when supporting all versions would be too cumbersome. For example, the potential redirect on logout. In version 2.0 the service could send a url parameter. In version 3.0, that was deprecated in favor of a service parameter. This server does not recognize the url parameter at all.

Demo

A demonstration deployment of the server, and a sample application, ships with the server. To try it out:

1. Clone the repository: git clone https://github.com/jscas/jscas-server.git
2. Navigate to the directory: cd jscas-server
3. Update hosts file: echo '127.0.0.1 app.example.com cas.example.com' >> /etc/hosts
4. Run docker-compose: docker-compose up
5. Navigate to http://app.example.com:3000 in a web browser

Note: the configuration for this demonstration is not recommended for production. It uses lax cookie settings in order to make it work on Chrome since Chrome doesn't work correctly with local test URLs otherwise.

Install

Via Git

$ git clone https://github.com/jscas/jscas-server
$ cd jscas-server
$ npm install --production
$ npx jscas-server -s > jscas.yaml
$ npm install --production abstract-cache-redis
$ nixconfig_config_home=$(pwd) npx jscas-server

As A Dependency

It is possible to add JSCAS as a dependency of a project. This allows one to create a project that is specifically the configuration for the server instance:

$ mkdir my-cas-server && cd my-cas-server
$ echo "{}" > package.json
$ npm install --save jscas-server

At this point a configuration will be needed. So let's use the included example configuration:

$ npx jscas-server -s > jscas.yaml

This configuration relies on an Redis server being present. So, assuming Redis is already running on the local host (otherwise modify the configuration accordingly):

$ npm install --save abstract-cache-redis

And now, the server is ready to start:

$ NODE_PATH=$(pwd)/node_modules nixconfig_config_home=$pwd npx jscas-server

At this point the server is listening on port 9000 with a very basic, non-production, configuration.

License

MIT License