labshare/auth-mysql repository overview

⁠LabShare Auth

LabShare Auth is an authorization and federation service for LabShare applications. It allows applications to use authorization services from various authentication providers using http://passportjs.org/⁠ strategies. LabShare Auth supports the following Oauth authorization flows: Implicit Grant⁠ and Authorization Code Grant⁠. It also supports a Basic Auth flow for applications hosted in SharePoint. For more information on the authorization flows, view documentation⁠.

⁠Requirements

• NodeJS
• LabShare Command⁠
• MySQL (>=5.7.0) or MSSQL

⁠Installation

⁠Without Docker

• Create a local database using your instance of MYSQL or MSSQL
  • Go to the schemas folder⁠.
  • Use schema.sql⁠ for a MySQL server or
  • schema.sql⁠ for a MSSQL server.
• Run npm install in the root of the auth project.
• Create a copy of sample-config.json and rename it to config.json.
• Set up configuration⁠

⁠With Docker

• instructions⁠.

⁠Running auth as a HTTP service

lsc auth start

⁠Running Auth service with live reload

To run the Auth service with file watchers and automatic reloading in a dev environment refer to this documentation⁠.

⁠Configuration for connecting a client application to the auth service

Specify the shell.Auth.Url in the Shell's configuration.

Example:

{
  "shell": {
      "Auth": {
        "Url": "http://localhost:7000/_api"
      }
   }
}

⁠Configuration

Refer to configuration documentation⁠ for additional configuration details.

⁠Tests

Unit: npm test

Integration:

• export MYSQL_PORT=3307
• docker-compose -f docker-compose-test.yml up -d
• npm run build
• lsc auth test

⁠Running a subset of the integration tests

• lsc auth test <path> where <path> is a relative path to an integration test module. Example: lsc auth test api/clients_spec.js

⁠Optional MSSQL test configuration

• export MSSQL_SA_PASSWORD='IntTest!Passw0rd'
• docker build -t labshare/mssql_auth_db ./run/mssql
• docker run --rm -p 1433:1433 -e SA_PASSWORD=${MSSQL_SA_PASSWORD} --name mssql_auth_db labshare/mssql_auth_db
• Wait for MSSQL container to initialize (10-20 seconds)
• docker exec -it mssql_auth_db /opt/mssql-tools/bin/sqlcmd -S localhost -U sa -P ${MSSQL_SA_PASSWORD} -l 30 -d master -i /tmp/schema.sql

⁠Updating the database drivers

• docker-compose -f docker-compose-test.yml down --rmi all
• docker-compose -f docker-compose-test.yml up -d