sso-oauth2-server

npm-template

npm-template

About

A simple server package for npm based on https://github.com/ankur-anand/simple-sso

Usage

index.js

``js
import SsoAuth2Server from '../SsoAuth2Server';
import Logger from '../Logger';
import {Connector, UrlHelper} from 'studip-api';

const STUDIP_AUTH_METHOD = async (body, client_id, scope, query) => {
Logger.log('Authentification: start');
const username = body.username;
const password = body.password;
//auth or throw error
return user;
};

const requiredLoginParams = {
username: 'string',
password: 'password',
};

const redirectMode = true;
const port = 3010;
const route = '/';
const sessionSecret = 'keyboard cat';
const jwtSecret = 'MySuperSecret';
const ssoServer = new SsoAuth2Server(
redirectMode,
port,
route,
sessionSecret,
jwtSecret,
STUDIP_AUTH_METHOD,
requiredLoginParams
);

ssoServer.registerService(
'https://.com',
'',
''
);

ssoServer.start();
`

Routes

You can always see your registered Routes by calling:

`js
ssoServer.getAllRegisteredRoutes();
`

By default the routes will be:

`
LOGIN: localhost//login
AUTH_PARAMS: localhost//authParams
AUTH_PARAMS: localhost//verifytoken
PROFILE: localhost//getProfile
`

Client

A client can now authentificate.

1. Get informations about needed auth Params

`
curl http://yourSSoAuth2ServerDomain:3010/customSubroute/authParams

-->
{
params: {
username: 'string',
password: 'password',
}
}
`

2. Your client know knows what to send as body

`js
let body = {username: 'me', password: 'mycat'};
let url = 'http://yourSSoAuth2ServerDomain:3010/customSubroute/login?';
url += 'client_id=sso_consumer&';
url += 'redirect_uri=&'; //but url encoded
url += 'response_type=code&';
url += 'scope=email firstname lastname&';
url += 'state=';
axios.post(url, body);
``

3. Your client

Contributors

The FireboltCasters