Public | Automated Build

Last pushed: 5 months ago
Short Description
Short description is empty for this repo.
Full Description

hotrod-auth

LDAP-backed, JSON Web Token (JWT) authentication service.

Overview

Small node JWT authentication service backed by an LDAP directory. Provides the following endpoints:

  • /login - Standard username and password authentication against the LDAP directory. Returns a JWT token
  • /refresh_token - Endpoint called by client apps to periodically renew their JWT token
  • /change_password - Allows users to change password (if supported by underlying LDAP directory)

Setup

  1. Clone this repo

    git clone https://github.com/panoptix-za/hotrod-auth.git
    
  2. Copy the /src/config/local.yml.example to /src/config/local.yml and edit as follows:

    • Replace SIGNING_SECRET value with a strong JWT signing secret
    • Configure the LDAP-* variables with appropriate values for your LDAP setup
  3. In the root folder, run:

    npm install
    npm start
    

License

The MIT License (MIT)

Copyright (c) Panoptix CC

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

Docker Pull Command
Owner
panoptix
Source Repository