SudoSOS Back-end API / GEWIS / GewisAuthenticationController

Class: GewisAuthenticationController

The GEWIS authentication controller is responsible for:

• Verifying user authentications.
• Handing out json web tokens.

Extends

• BaseController

Constructors

Constructor

new GewisAuthenticationController(
   options, 
   tokenHandler, 
   gewiswebSecret): GewisAuthenticationController;

Creates a new authentication controller instance.

Parameters

Parameter	Type	Description
options	BaseControllerOptions	The options passed to the base controller.
tokenHandler	TokenHandler	The token handler for creating signed tokens.
gewiswebSecret	string	The shared JWT secret with gewisweb.

Returns

GewisAuthenticationController

Overrides

BaseController.constructor

Properties

Property	Modifier	Type	Description	Inherited from
roleManager	protected	RoleManager	A reference to the role manager passed in the base controller options.	BaseController.roleManager
specification	public	SwaggerSpecification	A reference to the swagger specification passed in the base controller options.	BaseController.specification

Methods

getGEWISWebPublic()

getGEWISWebPublic(req, res): Promise<void>;

GET /authentication/gewisweb

Parameters

Parameter	Type
req	Request
res	Response

Returns

Promise<void>

200 - Public key

Operation Id

getGEWISWebPublic

Tags

authenticate - Operations of authentication controller

---

getPolicy()

getPolicy(): Policy;

Gets the policy defined by child classes. This policy includes all routes that the controller accepts, the authorization middleware, and the final handler function for every route.

Returns

Policy

The policy of this controller.

Overrides

BaseController.getPolicy

---

getRouter()

getRouter(): Router;

Returns

Router

the router used by this controller.

Inherited from

BaseController.getRouter

---

gewiswebLogin()

gewiswebLogin(req, res): Promise<void>;

POST /authentication/gewisweb

Parameters

Parameter	Type
req	Request
res	Response

Returns

Promise<void>

200 - The created json web token.

Operation Id

gewisWebAuthentication

Tags

authenticate - Operations of authentication controller

---

ldapLogin()

ldapLogin(req, res): Promise<void>;

POST /authentication/GEWIS/LDAP

Parameters

Parameter	Type
req	Request
res	Response

Returns

Promise<void>

200 - The created json web token.

Operation Id

gewisLDAPAuthentication

Tags

authenticate - Operations of authentication controller