= [];
51 |
52 | routes.push( { name: subRoutes.auth, router: authRouter } );
53 | routes.push( { name: subRoutes.info, router: infoRouter } );
54 | routes.push( { name: subRoutes.monitor, router: monitorRouter } );
55 | routes.push( { name: subRoutes.social, router: socialLoginRouter } );
56 | routes.push( { name: subRoutes.twoFactorCode, router: twoFactorCodeRouter } );
57 |
58 | const routeArgs = { routes } as RouteArgs;
59 |
60 | const args = {
61 | app,
62 | ctxArgs,
63 | routeArgs,
64 | assets,
65 | } as MountArgs;
66 |
67 | mountApp(args);
68 | }
69 | }
70 |
--------------------------------------------------------------------------------
/app/route/info.route.ts:
--------------------------------------------------------------------------------
1 | /**
2 | * @description holds info routes
3 | */
4 |
5 | import { authorizedBy, ResponseCode, UserRole, } from '@open-template-hub/common';
6 | import { Request, Response } from 'express';
7 | import Router from 'express-promise-router';
8 | import { InfoController } from '../controller/info.controller';
9 |
10 | const subRoutes = {
11 | root: '/',
12 | me: '/me',
13 | other: '/other'
14 | };
15 |
16 | export const router = Router();
17 | const infoController = new InfoController();
18 |
19 | router.get(
20 | subRoutes.me,
21 | authorizedBy( [ UserRole.ADMIN, UserRole.DEFAULT ] ),
22 | async ( _req: Request, res: Response ) => {
23 | // gets user info
24 | const context = res.locals.ctx;
25 | const response = await infoController.me(
26 | context.postgresql_provider,
27 | context.token
28 | );
29 | res.status( ResponseCode.OK ).json( response );
30 | }
31 | );
32 |
33 | router.get(
34 | subRoutes.other,
35 | authorizedBy( [ UserRole.ADMIN ] ),
36 | async ( req: Request, res: Response ) => {
37 | const context = res.locals.ctx;
38 | const response = await infoController.other(
39 | context.postgresql_provider,
40 | req.query.username as string
41 | );
42 | res.status( ResponseCode.OK ).json( response );
43 | }
44 | );
45 |
--------------------------------------------------------------------------------
/app/route/monitor.route.ts:
--------------------------------------------------------------------------------
1 | /**
2 | * @description holds monitor routes
3 | */
4 |
5 | import { ResponseCode } from '@open-template-hub/common';
6 | import { Request, Response } from 'express';
7 | import Router from 'express-promise-router';
8 | import { version } from '../../version';
9 |
10 | const subRoutes = {
11 | root: '/',
12 | alive: '/alive',
13 | };
14 |
15 | export const router = Router();
16 |
17 | router.get( subRoutes.alive, async ( _req: Request, res: Response ) => {
18 | // check system is alive
19 | res.status( ResponseCode.OK ).json( { version } );
20 | } );
21 |
--------------------------------------------------------------------------------
/app/route/social-login.route.ts:
--------------------------------------------------------------------------------
1 | /**
2 | * @description holds social login routes
3 | */
4 |
5 | import { ResponseCode } from '@open-template-hub/common';
6 | import { Request, Response } from 'express';
7 | import Router from 'express-promise-router';
8 | import { SocialLoginController } from '../controller/social-login.controller';
9 |
10 | const subRoutes = {
11 | root: '/',
12 | loginUrl: '/login-url',
13 | login: '/login',
14 | loginWithAccessToken: '/login-with-access-token',
15 | };
16 |
17 | export const publicRoutes = [
18 | subRoutes.loginUrl,
19 | subRoutes.login,
20 | subRoutes.loginWithAccessToken,
21 | ];
22 |
23 | export const router = Router();
24 |
25 | const socialLoginController = new SocialLoginController();
26 |
27 | router.post( subRoutes.loginUrl, async ( req: Request, res: Response ) => {
28 | // gets social login url
29 | const context = res.locals.ctx;
30 | const response = await socialLoginController.loginUrl(
31 | context.postgresql_provider,
32 | req.body
33 | );
34 | res.status( ResponseCode.OK ).json( { loginUrl: response } );
35 | } );
36 |
37 | router.post( subRoutes.login, async ( req: Request, res: Response ) => {
38 | // social login
39 | const context = res.locals.ctx;
40 | const response = await socialLoginController.login(
41 | context.postgresql_provider,
42 | context.message_queue_provider,
43 | req.body
44 | );
45 | res.status( ResponseCode.OK ).json( response );
46 | } );
47 |
48 | router.post(
49 | subRoutes.loginWithAccessToken,
50 | async ( req: Request, res: Response ) => {
51 | // login with access token
52 | const context = res.locals.ctx;
53 | const response = await socialLoginController.loginWithAccessToken(
54 | context.postgresql_provider,
55 | context.message_queue_provider,
56 | req.body
57 | );
58 | res.status( ResponseCode.OK ).json( response );
59 | }
60 | );
61 |
--------------------------------------------------------------------------------
/app/route/two-factor-code.route.ts:
--------------------------------------------------------------------------------
1 | import { authorizedBy, ResponseCode, UserRole, } from '@open-template-hub/common';
2 | import { Request, Response } from 'express';
3 | import Router from 'express-promise-router';
4 | import { TwoFactorCodeController } from '../controller/two-factor.controller';
5 | import { TwoFactorCode } from '../interface/two-factor-code.interface';
6 |
7 | const subRoutes = {
8 | root: '/',
9 | request: '/request',
10 | verify: '/verify',
11 | loginVerify: '/loginVerify',
12 | };
13 |
14 | export const router = Router();
15 |
16 | router.post(
17 | subRoutes.request,
18 | authorizedBy( [ UserRole.ADMIN, UserRole.DEFAULT ] ),
19 | async ( req: Request, res: Response ) => {
20 | const twoFactorCodeController = new TwoFactorCodeController();
21 | const context = res.locals.ctx;
22 |
23 | const response = await twoFactorCodeController.request(
24 | context.postgresql_provider,
25 | context.message_queue_provider,
26 | {
27 | username: context.username,
28 | phoneNumber: req.body.phoneNumber,
29 | languageCode: req.body.languageCode,
30 | } as TwoFactorCode
31 | );
32 |
33 | res.status( ResponseCode.OK ).json( response );
34 | }
35 | );
36 |
37 | router.post(
38 | subRoutes.verify,
39 | authorizedBy( [ UserRole.ADMIN, UserRole.DEFAULT ] ),
40 | async ( req: Request, res: Response ) => {
41 | const twoFactorCodeController = new TwoFactorCodeController();
42 | const context = res.locals.ctx;
43 |
44 | await twoFactorCodeController.verify(
45 | context.postgresql_provider,
46 | context.username,
47 | req.body.code
48 | );
49 |
50 | res.status( ResponseCode.OK ).json( {} );
51 | }
52 | );
53 |
54 | router.post( subRoutes.loginVerify, async ( req: Request, res: Response ) => {
55 | const twoFactorCodeController = new TwoFactorCodeController();
56 | const context = res.locals.ctx;
57 |
58 | const loginVerifyResponse = await twoFactorCodeController.loginVerify(
59 | context.postgresql_provider,
60 | req.body.code,
61 | req.body.preAuthToken
62 | );
63 |
64 | return res.status( ResponseCode.OK ).json( loginVerifyResponse );
65 | } );
66 |
--------------------------------------------------------------------------------
/assets/requests/auth-requests.rest:
--------------------------------------------------------------------------------
1 | ### Sign Up
2 | POST http://localhost:4001/auth/signup
3 | Content-Type: application/json
4 |
5 | {
6 | "username": "username",
7 | "password": "password",
8 | "email": "email@email.com",
9 | "languageCode": "en"
10 | }
11 |
12 | ### Login
13 | POST http://localhost:4001/auth/login
14 | Content-Type: application/json
15 |
16 | {
17 | "username": "username",
18 | "password": "password"
19 | }
20 |
21 | ### Logout (Remove refresh token)
22 | POST http://localhost:4001/auth/logout
23 | Content-Type: application/json
24 |
25 | {
26 | "token": "token"
27 | }
28 |
29 | ### Refresh Token
30 | POST http://localhost:4001/auth/token
31 | Content-Type: application/json
32 |
33 | {
34 | "token": "token"
35 | }
36 |
37 | ### Verify Token
38 | GET http://localhost:4001/auth/verify?token=token
39 |
40 | ### Forget Password
41 | POST http://localhost:4001/auth/forget-password
42 | Content-Type: application/json
43 |
44 | {
45 | "username": "username",
46 | "languageCode": "en"
47 | }
48 |
49 | ### Reset Password
50 | POST http://localhost:4001/auth/reset-password
51 | Content-Type: application/json
52 |
53 | {
54 | "username": "username",
55 | "password": "password",
56 | "token": "token"
57 | }
58 |
59 | ### Delete User
60 | DELETE http://localhost:4001/auth/user?username=username
61 | Content-Type: application/json
62 | Authorization: Bearer token
63 |
64 | ### Get users
65 | GET http://localhost:4001/auth/users
66 | Content-Type: application/json
67 | Authorization: Bearer token
68 |
--------------------------------------------------------------------------------
/assets/requests/info-requests.rest:
--------------------------------------------------------------------------------
1 | ### Who am I
2 | GET http://localhost:4001/info/me
3 | Content-Type: application/json
4 | Authorization: Bearer token
5 |
6 | ### Get other user info (ADMIN)
7 | GET http://localhost:4001/info/other?username=mert
8 | Content-Type: application/json
9 | Authorization: Bearer token
10 |
--------------------------------------------------------------------------------
/assets/requests/monitor-requests.rest:
--------------------------------------------------------------------------------
1 | ### Is server alive
2 | GET http://localhost:4001/monitor/alive
3 | Content-Type: application/json
4 |
--------------------------------------------------------------------------------
/assets/requests/social-login-requests.rest:
--------------------------------------------------------------------------------
1 | ### Get Social Login URL
2 | POST http://localhost:4001/social/login-url
3 | Content-Type: application/json
4 |
5 | {
6 | "key": "GITHUB"
7 | }
8 |
9 | ### Social Login
10 | POST http://localhost:4001/social/login
11 | Content-Type: application/json
12 |
13 | {
14 | "key": "GITHUB",
15 | "code": "code",
16 | "state": "state"
17 | }
18 |
19 | ### Social Login With Access token
20 | POST http://localhost:4001/social/login-with-access-token
21 | Content-Type: application/json
22 |
23 | {
24 | "key": "GITHUB",
25 | "accessToken": "",
26 | "tokenType": "Bearer"
27 | }
28 |
--------------------------------------------------------------------------------
/assets/requests/team-requests.rest:
--------------------------------------------------------------------------------
1 | ### Team Create
2 | POST http://localhost:4001/team
3 | Content-Type: application/json
4 | Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6Im1lcnQiLCJyb2xlIjoiQURNSU4iLCJ0ZWFtcyI6W3siX2lkIjoiNjNiNGExOWExY2U1ODdmMzI3NGMyNTM0IiwidGVhbV9pZCI6IjYzYjRhMTlhMWNlNTg3ZjMyNzRjMjUzMyIsIm5hbWUiOiJPcGVuIFRlbXBsYXRlIEh1YiIsInBheWxvYWQiOnsid2Vic2l0ZSI6Im9wZW50ZW1wbGF0ZWh1Yi5jb20ifSwiY3JlYXRvciI6ImZ1cmthbiIsIndyaXRlcnMiOlt7InVzZXJuYW1lIjoicmVtb2tsaWZ5IiwiZW1haWwiOiJyZW1va2xpZnlAZ21haWwuY29tIiwiaXNWZXJpZmllZCI6dHJ1ZSwicGF5bG9hZCI6eyJpbnZpdGF0aW9uRGF0ZSI6MTY3Mjc4MjI1ODg3MX19LHsidXNlcm5hbWUiOiJtZXJ0IiwiZW1haWwiOiJtZXJ0c2FyYWNAeWFuZGV4LmNvbSIsImlzVmVyaWZpZWQiOmZhbHNlLCJwYXlsb2FkIjp7Imludml0YXRpb25EYXRlIjoxNjcyNzg0OTA0NDc3fX1dLCJyZWFkZXJzIjpbeyJ1c2VybmFtZSI6ImtlcmltYWxwIiwiZW1haWwiOiJrZXJpbWFscG1yQGdtYWlsLmNvbSIsImlzVmVyaWZpZWQiOnRydWUsInBheWxvYWQiOnsiaW52aXRhdGlvbkRhdGUiOjE2NzI3ODM4Nzk2NDR9fSx7InVzZXJuYW1lIjoiZXl1cnRheSIsImVtYWlsIjoiZXl1cnRheXNAZ21haWwuY29tIiwiaXNWZXJpZmllZCI6ZmFsc2UsInBheWxvYWQiOnsiaW52aXRhdGlvbkRhdGUiOjE2NzI3ODQ5NzM4NzB9fSx7InVzZXJuYW1lIjoidWxhcyIsImVtYWlsIjoidWxhc2FyZGFidXJha0BnbWFpbC5jb20iLCJpc1ZlcmlmaWVkIjpmYWxzZSwicGF5bG9hZCI6eyJpbnZpdGF0aW9uRGF0ZSI6MTY3Mjc4NDk5Mzg2OX19XSwiX192IjowfSx7Il9pZCI6IjYzYjRhZDE5MWNlNTg3ZjMyNzRjMjVmOCIsInRlYW1faWQiOiI2M2I0YWQxOTFjZTU4N2YzMjc0YzI1ZjciLCJuYW1lIjoiUmVtb3RlIElubiIsInBheWxvYWQiOnsid2Vic2l0ZSI6ImxpbmtlZGluLmNvbS9jb21wYW55L3JlbW90ZS1pbm4ifSwiY3JlYXRvciI6ImZ1cmthbiIsIndyaXRlcnMiOlt7InVzZXJuYW1lIjoidWxhcyIsImVtYWlsIjoidWxhc2FyZGFidXJha0BnbWFpbC5jb20iLCJpc1ZlcmlmaWVkIjpmYWxzZSwicGF5bG9hZCI6eyJpbnZpdGF0aW9uRGF0ZSI6MTY3Mjc4NTE5OTMyM319LHsidXNlcm5hbWUiOiJyZW1va2xpZnkiLCJlbWFpbCI6InJlbW9rbGlmeUBnbWFpbC5jb20iLCJpc1ZlcmlmaWVkIjpmYWxzZSwicGF5bG9hZCI6eyJpbnZpdGF0aW9uRGF0ZSI6MTY3Mjc4NTIzMjAyM319LHsidXNlcm5hbWUiOiJtZXJ0IiwiZW1haWwiOiJtZXJ0c2FyYWNAeWFuZGV4LmNvbSIsImlzVmVyaWZpZWQiOmZhbHNlLCJwYXlsb2FkIjp7Imludml0YXRpb25EYXRlIjoxNjcyNzg1MzUyNjIzfX1dLCJyZWFkZXJzIjpbXSwiX192IjowfV0sImlhdCI6MTY3MzEyNTAxMCwiZXhwIjoxNjczMTI4NjEwfQ.-j9J7mQ_mz0O5mAlbrPN0lEG0via37LvDls2XUQIpSQ
5 |
6 | {
7 | "name": "Test Team",
8 | "payload": {
9 | "website": "https://opentemplatehub.com"
10 | }
11 | }
12 |
13 | ### Verify team
14 | POST http://localhost:4001/team/verify
15 | Content-Type: application/json
16 | Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6Im1lcnQyIiwicm9sZSI6IkRFRkFVTFQiLCJ0ZWFtcyI6W3siX2lkIjoiNjNiOWUwOGMwMDg1MTJmYzRkOTQ4ZTRhIiwidGVhbV9pZCI6IjYzYjllMDhjMDA4NTEyZmM0ZDk0OGU0OSIsIm5hbWUiOiJUZXN0IFRlYW0iLCJwYXlsb2FkIjp7IndlYnNpdGUiOiJodHRwczovL29wZW50ZW1wbGF0ZWh1Yi5jb20ifSwiY3JlYXRvciI6Im1lcnQiLCJ3cml0ZXJzIjpbXSwicmVhZGVycyI6W3sidXNlcm5hbWUiOiJtZXJ0MiIsImVtYWlsIjoibWVydGxzYXJhY0BnbWFpbC5jb20iLCJpc1ZlcmlmaWVkIjpmYWxzZSwicGF5bG9hZCI6eyJpbnZpdGF0aW9uRGF0ZSI6MTY3MzEzNTg0NjEwMn19XSwiX192IjowfV0sImlhdCI6MTY3MzEzNjY1MiwiZXhwIjoxNjczMTQwMjUyfQ.-PKaXu-O35mPIKSunUS-fZxQ-mQLk-2rgpjOGdIi2AQ
17 |
18 | {
19 | "verifyToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6Im1lcnRsc2FyYWNAZ21haWwuY29tIiwidGVhbSI6eyJpZCI6IjYzYjllMDhjMDA4NTEyZmM0ZDk0OGU0OSIsInJvbGUiOiJyZWFkZXJzIn0sImlhdCI6MTY3MzEzNTg0NiwiZXhwIjoxNjczOTk5ODQ2fQ.ZsGwB_B74AC2nzk7MQxYdtBvywOOZGP3DaW6di2q440"
20 | }
21 |
22 | ### Add Writer
23 | POST http://localhost:4001/team/writer
24 | Content-Type: application/json
25 | Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6Im1lcnQiLCJyb2xlIjoiQURNSU4iLCJ0ZWFtcyI6W3siX2lkIjoiNjNiNGExOWExY2U1ODdmMzI3NGMyNTM0IiwidGVhbV9pZCI6IjYzYjRhMTlhMWNlNTg3ZjMyNzRjMjUzMyIsIm5hbWUiOiJPcGVuIFRlbXBsYXRlIEh1YiIsInBheWxvYWQiOnsid2Vic2l0ZSI6Im9wZW50ZW1wbGF0ZWh1Yi5jb20ifSwiY3JlYXRvciI6ImZ1cmthbiIsIndyaXRlcnMiOlt7InVzZXJuYW1lIjoicmVtb2tsaWZ5IiwiZW1haWwiOiJyZW1va2xpZnlAZ21haWwuY29tIiwiaXNWZXJpZmllZCI6dHJ1ZSwicGF5bG9hZCI6eyJpbnZpdGF0aW9uRGF0ZSI6MTY3Mjc4MjI1ODg3MX19LHsidXNlcm5hbWUiOiJtZXJ0IiwiZW1haWwiOiJtZXJ0c2FyYWNAeWFuZGV4LmNvbSIsImlzVmVyaWZpZWQiOmZhbHNlLCJwYXlsb2FkIjp7Imludml0YXRpb25EYXRlIjoxNjcyNzg0OTA0NDc3fX1dLCJyZWFkZXJzIjpbeyJ1c2VybmFtZSI6ImtlcmltYWxwIiwiZW1haWwiOiJrZXJpbWFscG1yQGdtYWlsLmNvbSIsImlzVmVyaWZpZWQiOnRydWUsInBheWxvYWQiOnsiaW52aXRhdGlvbkRhdGUiOjE2NzI3ODM4Nzk2NDR9fSx7InVzZXJuYW1lIjoiZXl1cnRheSIsImVtYWlsIjoiZXl1cnRheXNAZ21haWwuY29tIiwiaXNWZXJpZmllZCI6ZmFsc2UsInBheWxvYWQiOnsiaW52aXRhdGlvbkRhdGUiOjE2NzI3ODQ5NzM4NzB9fSx7InVzZXJuYW1lIjoidWxhcyIsImVtYWlsIjoidWxhc2FyZGFidXJha0BnbWFpbC5jb20iLCJpc1ZlcmlmaWVkIjpmYWxzZSwicGF5bG9hZCI6eyJpbnZpdGF0aW9uRGF0ZSI6MTY3Mjc4NDk5Mzg2OX19XSwiX192IjowfSx7Il9pZCI6IjYzYjRhZDE5MWNlNTg3ZjMyNzRjMjVmOCIsInRlYW1faWQiOiI2M2I0YWQxOTFjZTU4N2YzMjc0YzI1ZjciLCJuYW1lIjoiUmVtb3RlIElubiIsInBheWxvYWQiOnsid2Vic2l0ZSI6ImxpbmtlZGluLmNvbS9jb21wYW55L3JlbW90ZS1pbm4ifSwiY3JlYXRvciI6ImZ1cmthbiIsIndyaXRlcnMiOlt7InVzZXJuYW1lIjoidWxhcyIsImVtYWlsIjoidWxhc2FyZGFidXJha0BnbWFpbC5jb20iLCJpc1ZlcmlmaWVkIjpmYWxzZSwicGF5bG9hZCI6eyJpbnZpdGF0aW9uRGF0ZSI6MTY3Mjc4NTE5OTMyM319LHsidXNlcm5hbWUiOiJyZW1va2xpZnkiLCJlbWFpbCI6InJlbW9rbGlmeUBnbWFpbC5jb20iLCJpc1ZlcmlmaWVkIjpmYWxzZSwicGF5bG9hZCI6eyJpbnZpdGF0aW9uRGF0ZSI6MTY3Mjc4NTIzMjAyM319LHsidXNlcm5hbWUiOiJtZXJ0IiwiZW1haWwiOiJtZXJ0c2FyYWNAeWFuZGV4LmNvbSIsImlzVmVyaWZpZWQiOmZhbHNlLCJwYXlsb2FkIjp7Imludml0YXRpb25EYXRlIjoxNjcyNzg1MzUyNjIzfX1dLCJyZWFkZXJzIjpbXSwiX192IjowfSx7Il9pZCI6IjYzYjllMDhjMDA4NTEyZmM0ZDk0OGU0YSIsInRlYW1faWQiOiI2M2I5ZTA4YzAwODUxMmZjNGQ5NDhlNDkiLCJuYW1lIjoiVGVzdCBUZWFtIiwicGF5bG9hZCI6eyJ3ZWJzaXRlIjoiaHR0cHM6Ly9vcGVudGVtcGxhdGVodWIuY29tIn0sImNyZWF0b3IiOiJtZXJ0Iiwid3JpdGVycyI6W10sInJlYWRlcnMiOltdLCJfX3YiOjB9XSwiaWF0IjoxNjczMTI5OTY2LCJleHAiOjE2NzMxMzM1NjZ9.WxwQnDEMeZA8Dety06P8A3YDbWO4wQpg5pdUGWUMppQ
26 |
27 | {
28 | "teamId": "63b9e08c008512fc4d948e49",
29 | "writerUsername": "mert2",
30 | "origin": "https://localhost:4000"
31 | }
32 |
33 | ### Add Reader
34 | POST http://localhost:4001/team/reader
35 | Content-Type: application/json
36 | Origin: http://localhost:4000.com
37 | Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6Im1lcnQiLCJyb2xlIjoiQURNSU4iLCJ0ZWFtcyI6W3siX2lkIjoiNjNiNGExOWExY2U1ODdmMzI3NGMyNTM0IiwidGVhbV9pZCI6IjYzYjRhMTlhMWNlNTg3ZjMyNzRjMjUzMyIsIm5hbWUiOiJPcGVuIFRlbXBsYXRlIEh1YiIsInBheWxvYWQiOnsid2Vic2l0ZSI6Im9wZW50ZW1wbGF0ZWh1Yi5jb20ifSwiY3JlYXRvciI6ImZ1cmthbiIsIndyaXRlcnMiOlt7InVzZXJuYW1lIjoicmVtb2tsaWZ5IiwiZW1haWwiOiJyZW1va2xpZnlAZ21haWwuY29tIiwiaXNWZXJpZmllZCI6dHJ1ZSwicGF5bG9hZCI6eyJpbnZpdGF0aW9uRGF0ZSI6MTY3Mjc4MjI1ODg3MX19LHsidXNlcm5hbWUiOiJtZXJ0IiwiZW1haWwiOiJtZXJ0c2FyYWNAeWFuZGV4LmNvbSIsImlzVmVyaWZpZWQiOmZhbHNlLCJwYXlsb2FkIjp7Imludml0YXRpb25EYXRlIjoxNjcyNzg0OTA0NDc3fX1dLCJyZWFkZXJzIjpbeyJ1c2VybmFtZSI6ImtlcmltYWxwIiwiZW1haWwiOiJrZXJpbWFscG1yQGdtYWlsLmNvbSIsImlzVmVyaWZpZWQiOnRydWUsInBheWxvYWQiOnsiaW52aXRhdGlvbkRhdGUiOjE2NzI3ODM4Nzk2NDR9fSx7InVzZXJuYW1lIjoiZXl1cnRheSIsImVtYWlsIjoiZXl1cnRheXNAZ21haWwuY29tIiwiaXNWZXJpZmllZCI6ZmFsc2UsInBheWxvYWQiOnsiaW52aXRhdGlvbkRhdGUiOjE2NzI3ODQ5NzM4NzB9fSx7InVzZXJuYW1lIjoidWxhcyIsImVtYWlsIjoidWxhc2FyZGFidXJha0BnbWFpbC5jb20iLCJpc1ZlcmlmaWVkIjpmYWxzZSwicGF5bG9hZCI6eyJpbnZpdGF0aW9uRGF0ZSI6MTY3Mjc4NDk5Mzg2OX19XSwiX192IjowfSx7Il9pZCI6IjYzYjRhZDE5MWNlNTg3ZjMyNzRjMjVmOCIsInRlYW1faWQiOiI2M2I0YWQxOTFjZTU4N2YzMjc0YzI1ZjciLCJuYW1lIjoiUmVtb3RlIElubiIsInBheWxvYWQiOnsid2Vic2l0ZSI6ImxpbmtlZGluLmNvbS9jb21wYW55L3JlbW90ZS1pbm4ifSwiY3JlYXRvciI6ImZ1cmthbiIsIndyaXRlcnMiOlt7InVzZXJuYW1lIjoidWxhcyIsImVtYWlsIjoidWxhc2FyZGFidXJha0BnbWFpbC5jb20iLCJpc1ZlcmlmaWVkIjpmYWxzZSwicGF5bG9hZCI6eyJpbnZpdGF0aW9uRGF0ZSI6MTY3Mjc4NTE5OTMyM319LHsidXNlcm5hbWUiOiJyZW1va2xpZnkiLCJlbWFpbCI6InJlbW9rbGlmeUBnbWFpbC5jb20iLCJpc1ZlcmlmaWVkIjpmYWxzZSwicGF5bG9hZCI6eyJpbnZpdGF0aW9uRGF0ZSI6MTY3Mjc4NTIzMjAyM319LHsidXNlcm5hbWUiOiJtZXJ0IiwiZW1haWwiOiJtZXJ0c2FyYWNAeWFuZGV4LmNvbSIsImlzVmVyaWZpZWQiOmZhbHNlLCJwYXlsb2FkIjp7Imludml0YXRpb25EYXRlIjoxNjcyNzg1MzUyNjIzfX1dLCJyZWFkZXJzIjpbXSwiX192IjowfSx7Il9pZCI6IjYzYjllMDhjMDA4NTEyZmM0ZDk0OGU0YSIsInRlYW1faWQiOiI2M2I5ZTA4YzAwODUxMmZjNGQ5NDhlNDkiLCJuYW1lIjoiVGVzdCBUZWFtIiwicGF5bG9hZCI6eyJ3ZWJzaXRlIjoiaHR0cHM6Ly9vcGVudGVtcGxhdGVodWIuY29tIn0sImNyZWF0b3IiOiJtZXJ0Iiwid3JpdGVycyI6W10sInJlYWRlcnMiOltdLCJfX3YiOjB9XSwiaWF0IjoxNjczMTM0MTUxLCJleHAiOjE2NzMxMzc3NTF9.G7KzTY0nghxH0bFB3UlRrj0m4VuHTXIgjVU9SldlstU
38 |
39 | {
40 | "teamId": "63b9e08c008512fc4d948e49",
41 | "readerEmail": "mertlsarac@gmail.com"
42 | }
43 |
44 | ### Get Teams
45 | GET http://localhost:4001/team?teamId=63b9e08c008512fc4d948e49
46 | Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6Im1lcnQyIiwicm9sZSI6IkRFRkFVTFQiLCJ0ZWFtcyI6W3siX2lkIjoiNjNiOWUwOGMwMDg1MTJmYzRkOTQ4ZTRhIiwidGVhbV9pZCI6IjYzYjllMDhjMDA4NTEyZmM0ZDk0OGU0OSIsIm5hbWUiOiJUZXN0IFRlYW0iLCJwYXlsb2FkIjp7IndlYnNpdGUiOiJodHRwczovL29wZW50ZW1wbGF0ZWh1Yi5jb20ifSwiY3JlYXRvciI6Im1lcnQiLCJ3cml0ZXJzIjpbXSwicmVhZGVycyI6W3sidXNlcm5hbWUiOiJtZXJ0MiIsImVtYWlsIjoibWVydGxzYXJhY0BnbWFpbC5jb20iLCJpc1ZlcmlmaWVkIjp0cnVlLCJwYXlsb2FkIjp7Imludml0YXRpb25EYXRlIjoxNjczMTM1ODQ2MTAyfX1dLCJfX3YiOjB9XSwiaWF0IjoxNjczMTg1MDUyLCJleHAiOjE2NzMxODg2NTJ9.APH9FYlNQy0tgtrPryLcVM0fEBGc5RKQlSAKQuK7U80
--------------------------------------------------------------------------------
/assets/requests/two-factor-requests.rest:
--------------------------------------------------------------------------------
1 | ### Request
2 | POST http://localhost:4001/2fa/request
3 | Content-Type: application/json
4 | Authorization: Bearer token
5 |
6 | {
7 | "phoneNumber": "+1111111",
8 | "languageCode": "en"
9 | }
10 |
11 | ### Verify
12 | POST http://localhost:4001/2fa/verify
13 | Content-Type: application/json
14 | Authorization: Bearer token
15 |
16 | {
17 | "code": "95680"
18 | }
19 |
--------------------------------------------------------------------------------
/assets/sql/preload.tables.psql:
--------------------------------------------------------------------------------
1 | SELECT pg_terminate_backend(pid)
2 | FROM pg_stat_activity
3 | WHERE application_name ILIKE ('AuthServer%') AND state NOT LIKE 'active' AND pid <> pg_backend_pid();
4 |
5 | create TABLE IF NOT EXISTS users
6 | (
7 | username text NOT NULL PRIMARY KEY,
8 | password text NOT NULL,
9 | email text UNIQUE,
10 | verified boolean DEFAULT FALSE,
11 | role text,
12 | phone_number text,
13 | two_factor_enabled boolean DEFAULT FALSE
14 | );
15 |
16 | create TABLE IF NOT EXISTS tokens
17 | (
18 | token text NOT NULL,
19 | expire_date date
20 | );
21 |
22 | create TABLE IF NOT EXISTS social_logins
23 | (
24 | social_login_key text NOT NULL UNIQUE,
25 | developer_notes text
26 | );
27 |
28 | create TABLE IF NOT EXISTS oauth_v1_config_params
29 | (
30 | social_login_key text NOT NULL UNIQUE,
31 | client_id text NOT NULL,
32 | client_secret text NOT NULL,
33 | redirect_uri text NOT NULL,
34 | login_uri text NOT NULL,
35 | access_token_uri text NOT NULL,
36 | access_token_query_param_field_path text NOT NULL,
37 | user_data_uri text NOT NULL,
38 | external_user_id_query_param_field_path text NOT NULL,
39 | external_user_email_query_param_field_path text,
40 | external_username_query_param_field_path text,
41 | request_token_uri text NOT NULL,
42 | access_token_request_method text NOT NULL
43 | );
44 |
45 | create TABLE IF NOT EXISTS oauth_v2_config_params
46 | (
47 | social_login_key text NOT NULL UNIQUE,
48 | client_id text NOT NULL,
49 | client_secret text NOT NULL,
50 | redirect_uri text NOT NULL,
51 | login_uri text NOT NULL,
52 | access_token_uri text NOT NULL,
53 | access_token_json_field_path text NOT NULL,
54 | user_data_uri text NOT NULL,
55 | external_user_id_json_field_path text NOT NULL,
56 | external_user_email_json_field_path text,
57 | external_username_json_field_path text,
58 | token_type_json_field_path text,
59 | requested_with_auth_header boolean NOT NULL,
60 | access_token_request_method text NOT NULL
61 | );
62 |
63 | create TABLE IF NOT EXISTS social_login_mappings
64 | (
65 | social_login_key text NOT NULL,
66 | username text NOT NULL,
67 | external_user_id text NOT NULL,
68 | external_username text,
69 | external_user_email text
70 | );
71 |
72 | create TABLE IF NOT EXISTS two_factor_auth_codes
73 | (
74 | username text NOT NULL,
75 | phone_number text NOT NULL,
76 | code text NOT NULL,
77 | expiry text NOT NULL
78 | );
79 |
--------------------------------------------------------------------------------
/assets/test-results/postman-dark.html:
--------------------------------------------------------------------------------
1 | Using htmlextra version 1.20.1
2 | Created the htmlextra report.
3 |
--------------------------------------------------------------------------------
/assets/tests/regression-tests/postman/README.md:
--------------------------------------------------------------------------------
1 | # POSTMAN REGRESSION TESTS
2 |
3 | ## Prerequisite
4 |
5 | Please check README.md to get more information to configure environment
6 |
7 | ## Configuration
8 |
9 | * Import **auth-server-regression.postman_environment.json** as environment to Postman
10 |
11 | * Import **auth-server-regression.postman_collection.json** as collection to Postman
12 |
13 | * Update imported environment variables and run collection on Postman
14 |
--------------------------------------------------------------------------------
/assets/tests/regression-tests/postman/auth-server-regression.postman_collection.json:
--------------------------------------------------------------------------------
1 | {
2 | "info": {
3 | "_postman_id": "54e9576b-ca26-407e-b195-2c4b6e95b36f",
4 | "name": "auth-server-regression",
5 | "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
6 | },
7 | "item": [
8 | {
9 | "name": "Auth",
10 | "item": [
11 | {
12 | "name": "Sign Up",
13 | "item": [
14 | {
15 | "name": "Sign Up Success [201]",
16 | "event": [
17 | {
18 | "listen": "test",
19 | "script": {
20 | "exec": [
21 | "const responseEncryptionSecret = pm.environment.get(\"response-encryption-secret\");\r",
22 | "const encrypted = pm.response.json();\r",
23 | "const decrypted = CryptoJS.RC4.decrypt(\r",
24 | " encrypted,\r",
25 | " responseEncryptionSecret\r",
26 | " ).toString(CryptoJS.enc.Utf8);\r",
27 | "\r",
28 | "const decryptedJson = JSON.parse(decrypted);\r",
29 | "console.log(decryptedJson);\r",
30 | "\r",
31 | "pm.test(\"Response code is CREATED\", function () {\r",
32 | " pm.response.to.have.status(201);\r",
33 | "});\r",
34 | "\r",
35 | "var autoVerifyEnabled = pm.environment.get(\"auto-verify-enabled\");\r",
36 | "\r",
37 | "if (autoVerifyEnabled) {\r",
38 | " pm.test(\"Response contains Access Token\", function () {\r",
39 | " pm.expect(decrypted).to.include('accessToken');\r",
40 | " pm.environment.set(\"access-token\", decryptedJson.accessToken);\r",
41 | " });\r",
42 | "\r",
43 | " pm.test(\"Response contains Refresh Token\", function () {\r",
44 | " pm.expect(decrypted).to.include('refreshToken');\r",
45 | " pm.environment.set(\"refresh-token\", decryptedJson.refreshToken);\r",
46 | " });\r",
47 | "} else {\r",
48 | " pm.test(\"Response contains Created User Email\", function () {\r",
49 | " pm.expect(decrypted).to.include('email');\r",
50 | " });\r",
51 | "}\r",
52 | ""
53 | ],
54 | "type": "text/javascript"
55 | }
56 | },
57 | {
58 | "listen": "prerequest",
59 | "script": {
60 | "exec": [
61 | ""
62 | ],
63 | "type": "text/javascript"
64 | }
65 | }
66 | ],
67 | "request": {
68 | "method": "POST",
69 | "header": [],
70 | "body": {
71 | "mode": "raw",
72 | "raw": "{\r\n \"username\": \"{{username}}\",\r\n \"password\": \"{{password}}\",\r\n \"email\": \"{{email}}\"\r\n}",
73 | "options": {
74 | "raw": {
75 | "language": "json"
76 | }
77 | }
78 | },
79 | "url": {
80 | "raw": "{{uri}}/auth/signup",
81 | "host": [
82 | "{{uri}}"
83 | ],
84 | "path": [
85 | "auth",
86 | "signup"
87 | ]
88 | }
89 | },
90 | "response": []
91 | }
92 | ]
93 | },
94 | {
95 | "name": "Sign In",
96 | "item": [
97 | {
98 | "name": "Sign In By Username Success [200]",
99 | "event": [
100 | {
101 | "listen": "test",
102 | "script": {
103 | "exec": [
104 | "const responseEncryptionSecret = pm.environment.get(\"response-encryption-secret\");\r",
105 | "const encrypted = pm.response.json();\r",
106 | "const decrypted = CryptoJS.RC4.decrypt(\r",
107 | " encrypted,\r",
108 | " responseEncryptionSecret\r",
109 | " ).toString(CryptoJS.enc.Utf8);\r",
110 | "\r",
111 | "const decryptedJson = JSON.parse(decrypted);\r",
112 | "console.log(decryptedJson);\r",
113 | "\r",
114 | "var autoVerifyEnabled = pm.environment.get(\"auto-verify-enabled\");\r",
115 | "\r",
116 | "if (autoVerifyEnabled) {\r",
117 | " pm.test(\"Response code is OK\", function () {\r",
118 | " pm.response.to.have.status(200);\r",
119 | " });\r",
120 | "\r",
121 | " pm.test(\"Response contains Access Token\", function () {\r",
122 | " pm.expect(decrypted).to.include('accessToken');\r",
123 | " pm.environment.set(\"access-token\", decryptedJson.accessToken);\r",
124 | " });\r",
125 | "\r",
126 | " pm.test(\"Response contains Refresh Token\", function () {\r",
127 | " pm.expect(decrypted).to.include('refreshToken');\r",
128 | " pm.environment.set(\"refresh-token\", decryptedJson.refreshToken);\r",
129 | " });\r",
130 | "} else {\r",
131 | " pm.test(\"Response code is OK\", function () {\r",
132 | " pm.response.to.have.status(403);\r",
133 | " });\r",
134 | "\r",
135 | " pm.test(\"Response contains Error Message\", function () {\r",
136 | " pm.expect(decrypted).to.include('message');\r",
137 | " });\r",
138 | "}"
139 | ],
140 | "type": "text/javascript"
141 | }
142 | }
143 | ],
144 | "request": {
145 | "method": "POST",
146 | "header": [],
147 | "body": {
148 | "mode": "raw",
149 | "raw": "{\r\n \"username\": \"{{username}}\",\r\n \"password\": \"{{password}}\"\r\n}",
150 | "options": {
151 | "raw": {
152 | "language": "json"
153 | }
154 | }
155 | },
156 | "url": {
157 | "raw": "{{uri}}/auth/login",
158 | "host": [
159 | "{{uri}}"
160 | ],
161 | "path": [
162 | "auth",
163 | "login"
164 | ]
165 | }
166 | },
167 | "response": []
168 | },
169 | {
170 | "name": "Sign In By Email Success [200]",
171 | "event": [
172 | {
173 | "listen": "test",
174 | "script": {
175 | "exec": [
176 | "const responseEncryptionSecret = pm.environment.get(\"response-encryption-secret\");\r",
177 | "const encrypted = pm.response.json();\r",
178 | "const decrypted = CryptoJS.RC4.decrypt(\r",
179 | " encrypted,\r",
180 | " responseEncryptionSecret\r",
181 | " ).toString(CryptoJS.enc.Utf8);\r",
182 | "\r",
183 | "const decryptedJson = JSON.parse(decrypted);\r",
184 | "console.log(decryptedJson);\r",
185 | "\r",
186 | "var autoVerifyEnabled = pm.environment.get(\"auto-verify-enabled\");\r",
187 | "\r",
188 | "if (autoVerifyEnabled) {\r",
189 | " pm.test(\"Response code is OK\", function () {\r",
190 | " pm.response.to.have.status(200);\r",
191 | " });\r",
192 | "\r",
193 | " pm.test(\"Response contains Access Token\", function () {\r",
194 | " pm.expect(decrypted).to.include('accessToken');\r",
195 | " pm.environment.set(\"access-token\", decryptedJson.accessToken);\r",
196 | " });\r",
197 | "\r",
198 | " pm.test(\"Response contains Refresh Token\", function () {\r",
199 | " pm.expect(decrypted).to.include('refreshToken');\r",
200 | " pm.environment.set(\"refresh-token\", decryptedJson.refreshToken);\r",
201 | " });\r",
202 | "} else {\r",
203 | " pm.test(\"Response code is OK\", function () {\r",
204 | " pm.response.to.have.status(403);\r",
205 | " });\r",
206 | "\r",
207 | " pm.test(\"Response contains Error Message\", function () {\r",
208 | " pm.expect(decrypted).to.include('message');\r",
209 | " });\r",
210 | "}"
211 | ],
212 | "type": "text/javascript"
213 | }
214 | }
215 | ],
216 | "request": {
217 | "method": "POST",
218 | "header": [],
219 | "body": {
220 | "mode": "raw",
221 | "raw": "{\r\n \"email\": \"{{email}}\",\r\n \"password\": \"{{password}}\"\r\n}",
222 | "options": {
223 | "raw": {
224 | "language": "json"
225 | }
226 | }
227 | },
228 | "url": {
229 | "raw": "{{uri}}/auth/login",
230 | "host": [
231 | "{{uri}}"
232 | ],
233 | "path": [
234 | "auth",
235 | "login"
236 | ]
237 | }
238 | },
239 | "response": []
240 | },
241 | {
242 | "name": "Sign In Failure [400]",
243 | "event": [
244 | {
245 | "listen": "test",
246 | "script": {
247 | "exec": [
248 | "const responseEncryptionSecret = pm.environment.get(\"response-encryption-secret\");\r",
249 | "const encrypted = pm.response.json();\r",
250 | "const decrypted = CryptoJS.RC4.decrypt(\r",
251 | " encrypted,\r",
252 | " responseEncryptionSecret\r",
253 | " ).toString(CryptoJS.enc.Utf8);\r",
254 | "\r",
255 | "const decryptedJson = JSON.parse(decrypted);\r",
256 | "console.log(decryptedJson);\r",
257 | "\r",
258 | "pm.test(\"Response code is Bad Request\", function () {\r",
259 | " pm.response.to.have.status(400);\r",
260 | "});\r",
261 | "\r",
262 | "pm.test(\"Response contains Error Message\", function () {\r",
263 | " pm.expect(decrypted).to.include('message');\r",
264 | "});"
265 | ],
266 | "type": "text/javascript"
267 | }
268 | }
269 | ],
270 | "request": {
271 | "method": "POST",
272 | "header": [],
273 | "body": {
274 | "mode": "raw",
275 | "raw": "{\r\n \"password\": \"{{password}}\"\r\n}",
276 | "options": {
277 | "raw": {
278 | "language": "json"
279 | }
280 | }
281 | },
282 | "url": {
283 | "raw": "{{uri}}/auth/login",
284 | "host": [
285 | "{{uri}}"
286 | ],
287 | "path": [
288 | "auth",
289 | "login"
290 | ]
291 | }
292 | },
293 | "response": []
294 | },
295 | {
296 | "name": "Request New Token Success [200]",
297 | "event": [
298 | {
299 | "listen": "test",
300 | "script": {
301 | "exec": [
302 | "const responseEncryptionSecret = pm.environment.get(\"response-encryption-secret\");\r",
303 | "const encrypted = pm.response.json();\r",
304 | "const decrypted = CryptoJS.RC4.decrypt(\r",
305 | " encrypted,\r",
306 | " responseEncryptionSecret\r",
307 | " ).toString(CryptoJS.enc.Utf8);\r",
308 | "\r",
309 | "const decryptedJson = JSON.parse(decrypted);\r",
310 | "console.log(decryptedJson);\r",
311 | "\r",
312 | "var autoVerifyEnabled = pm.environment.get(\"auto-verify-enabled\");\r",
313 | "\r",
314 | "if (autoVerifyEnabled) {\r",
315 | " pm.test(\"Response code is OK\", function () {\r",
316 | " pm.response.to.have.status(200);\r",
317 | " });\r",
318 | "\r",
319 | " pm.test(\"Response contains Access Token\", function () {\r",
320 | " pm.expect(decrypted).to.include('accessToken');\r",
321 | " pm.environment.set(\"access-token\", decryptedJson.accessToken);\r",
322 | " });\r",
323 | "\r",
324 | " pm.test(\"Response contains Refresh Token\", function () {\r",
325 | " pm.expect(decrypted).to.include('refreshToken');\r",
326 | " pm.environment.set(\"refresh-token\", decryptedJson.refreshToken);\r",
327 | " });\r",
328 | "} else {\r",
329 | " pm.test(\"Response code is OK\", function () {\r",
330 | " pm.response.to.have.status(401);\r",
331 | " });\r",
332 | "\r",
333 | " pm.test(\"Response contains Error Message\", function () {\r",
334 | " pm.expect(decrypted).to.include('message');\r",
335 | " });\r",
336 | "}"
337 | ],
338 | "type": "text/javascript"
339 | }
340 | }
341 | ],
342 | "request": {
343 | "method": "POST",
344 | "header": [],
345 | "body": {
346 | "mode": "raw",
347 | "raw": "{\r\n \"token\": \"{{refresh-token}}\"\r\n}",
348 | "options": {
349 | "raw": {
350 | "language": "json"
351 | }
352 | }
353 | },
354 | "url": {
355 | "raw": "{{uri}}/auth/token",
356 | "host": [
357 | "{{uri}}"
358 | ],
359 | "path": [
360 | "auth",
361 | "token"
362 | ]
363 | }
364 | },
365 | "response": []
366 | }
367 | ]
368 | },
369 | {
370 | "name": "Password",
371 | "item": [
372 | {
373 | "name": "Forget Password Success [200]",
374 | "event": [
375 | {
376 | "listen": "test",
377 | "script": {
378 | "exec": [
379 | "pm.test(\"Response code is OK\", function () {\r",
380 | " pm.response.to.have.status(204);\r",
381 | "});\r",
382 | ""
383 | ],
384 | "type": "text/javascript"
385 | }
386 | }
387 | ],
388 | "request": {
389 | "method": "POST",
390 | "header": [],
391 | "body": {
392 | "mode": "raw",
393 | "raw": "{\r\n \"username\": \"{{username}}\"\r\n}",
394 | "options": {
395 | "raw": {
396 | "language": "json"
397 | }
398 | }
399 | },
400 | "url": {
401 | "raw": "{{uri}}/auth/forget-password",
402 | "host": [
403 | "{{uri}}"
404 | ],
405 | "path": [
406 | "auth",
407 | "forget-password"
408 | ]
409 | }
410 | },
411 | "response": []
412 | },
413 | {
414 | "name": "Get Reset Password Token Success [200]",
415 | "event": [
416 | {
417 | "listen": "test",
418 | "script": {
419 | "exec": [
420 | "const responseEncryptionSecret = pm.environment.get(\"response-encryption-secret\");\r",
421 | "const encrypted = pm.response.json();\r",
422 | "const decrypted = CryptoJS.RC4.decrypt(\r",
423 | " encrypted,\r",
424 | " responseEncryptionSecret\r",
425 | " ).toString(CryptoJS.enc.Utf8);\r",
426 | "\r",
427 | "const decryptedJson = JSON.parse(decrypted);\r",
428 | "console.log(decryptedJson);\r",
429 | "\r",
430 | "pm.test(\"Response code is OK\", function () {\r",
431 | " pm.response.to.have.status(200);\r",
432 | "});\r",
433 | "\r",
434 | "pm.test(\"Response contains Reset Password Token\", function () {\r",
435 | " pm.expect(decrypted).to.include('resetPasswordToken');\r",
436 | " pm.environment.set(\"reset-password-token\", decryptedJson.resetPasswordToken);\r",
437 | "});"
438 | ],
439 | "type": "text/javascript"
440 | }
441 | }
442 | ],
443 | "request": {
444 | "auth": {
445 | "type": "bearer",
446 | "bearer": [
447 | {
448 | "key": "token",
449 | "value": "{{admin-auth-token}}",
450 | "type": "string"
451 | }
452 | ]
453 | },
454 | "method": "GET",
455 | "header": [],
456 | "url": {
457 | "raw": "{{uri}}/auth/reset-password-token?username={{username}}",
458 | "host": [
459 | "{{uri}}"
460 | ],
461 | "path": [
462 | "auth",
463 | "reset-password-token"
464 | ],
465 | "query": [
466 | {
467 | "key": "username",
468 | "value": "{{username}}"
469 | }
470 | ]
471 | }
472 | },
473 | "response": []
474 | },
475 | {
476 | "name": "Get Reset Password Token Failure [403]",
477 | "event": [
478 | {
479 | "listen": "test",
480 | "script": {
481 | "exec": [
482 | "pm.test(\"Response code is Forbidden\", function () {\r",
483 | " pm.response.to.have.status(403);\r",
484 | "});"
485 | ],
486 | "type": "text/javascript"
487 | }
488 | }
489 | ],
490 | "request": {
491 | "auth": {
492 | "type": "bearer",
493 | "bearer": [
494 | {
495 | "key": "token",
496 | "value": "{{access-token}}",
497 | "type": "string"
498 | }
499 | ]
500 | },
501 | "method": "GET",
502 | "header": [],
503 | "url": {
504 | "raw": "{{uri}}/auth/reset-password-token?username={{username}}",
505 | "host": [
506 | "{{uri}}"
507 | ],
508 | "path": [
509 | "auth",
510 | "reset-password-token"
511 | ],
512 | "query": [
513 | {
514 | "key": "username",
515 | "value": "{{username}}"
516 | }
517 | ]
518 | }
519 | },
520 | "response": []
521 | },
522 | {
523 | "name": "Reset Password Success [200]",
524 | "event": [
525 | {
526 | "listen": "test",
527 | "script": {
528 | "exec": [
529 | "pm.test(\"Response code is OK\", function () {\r",
530 | " pm.response.to.have.status(204);\r",
531 | "});\r",
532 | ""
533 | ],
534 | "type": "text/javascript"
535 | }
536 | }
537 | ],
538 | "request": {
539 | "method": "POST",
540 | "header": [],
541 | "body": {
542 | "mode": "raw",
543 | "raw": "{\r\n \"username\": \"{{username}}\",\r\n \"password\": \"{{changed-password}}\",\r\n \"token\": \"{{reset-password-token}}\"\r\n}",
544 | "options": {
545 | "raw": {
546 | "language": "json"
547 | }
548 | }
549 | },
550 | "url": {
551 | "raw": "{{uri}}/auth/reset-password",
552 | "host": [
553 | "{{uri}}"
554 | ],
555 | "path": [
556 | "auth",
557 | "reset-password"
558 | ]
559 | }
560 | },
561 | "response": []
562 | },
563 | {
564 | "name": "Sign In With Changed Password Success [200]",
565 | "event": [
566 | {
567 | "listen": "test",
568 | "script": {
569 | "exec": [
570 | "const responseEncryptionSecret = pm.environment.get(\"response-encryption-secret\");\r",
571 | "const encrypted = pm.response.json();\r",
572 | "const decrypted = CryptoJS.RC4.decrypt(\r",
573 | " encrypted,\r",
574 | " responseEncryptionSecret\r",
575 | " ).toString(CryptoJS.enc.Utf8);\r",
576 | "\r",
577 | "const decryptedJson = JSON.parse(decrypted);\r",
578 | "console.log(decryptedJson);\r",
579 | "\r",
580 | "pm.test(\"Response code is OK\", function () {\r",
581 | " pm.response.to.have.status(200);\r",
582 | "});\r",
583 | "\r",
584 | "pm.test(\"Response contains Access Token\", function () {\r",
585 | " pm.expect(decrypted).to.include('accessToken');\r",
586 | " pm.environment.set(\"access-token\", decryptedJson.accessToken);\r",
587 | "});\r",
588 | "\r",
589 | "pm.test(\"Response contains Refresh Token\", function () {\r",
590 | " pm.expect(decrypted).to.include('refreshToken');\r",
591 | " pm.environment.set(\"refresh-token\", decryptedJson.refreshToken);\r",
592 | "});"
593 | ],
594 | "type": "text/javascript"
595 | }
596 | }
597 | ],
598 | "request": {
599 | "method": "POST",
600 | "header": [],
601 | "body": {
602 | "mode": "raw",
603 | "raw": "{\r\n \"username\": \"{{username}}\",\r\n \"password\": \"{{changed-password}}\"\r\n}",
604 | "options": {
605 | "raw": {
606 | "language": "json"
607 | }
608 | }
609 | },
610 | "url": {
611 | "raw": "{{uri}}/auth/login",
612 | "host": [
613 | "{{uri}}"
614 | ],
615 | "path": [
616 | "auth",
617 | "login"
618 | ]
619 | }
620 | },
621 | "response": []
622 | }
623 | ]
624 | },
625 | {
626 | "name": "Sign Out",
627 | "item": [
628 | {
629 | "name": "Sign Out Success [204]",
630 | "event": [
631 | {
632 | "listen": "test",
633 | "script": {
634 | "exec": [
635 | "pm.test(\"Response code is No Content\", function () {\r",
636 | " pm.response.to.have.status(204);\r",
637 | "});"
638 | ],
639 | "type": "text/javascript"
640 | }
641 | }
642 | ],
643 | "request": {
644 | "method": "POST",
645 | "header": [],
646 | "body": {
647 | "mode": "raw",
648 | "raw": "{\r\n \"token\": \"{{refresh-token}}\"\r\n}",
649 | "options": {
650 | "raw": {
651 | "language": "json"
652 | }
653 | }
654 | },
655 | "url": {
656 | "raw": "{{uri}}/auth/logout",
657 | "host": [
658 | "{{uri}}"
659 | ],
660 | "path": [
661 | "auth",
662 | "logout"
663 | ]
664 | }
665 | },
666 | "response": []
667 | }
668 | ]
669 | },
670 | {
671 | "name": "Delete",
672 | "item": [
673 | {
674 | "name": "Delete User",
675 | "event": [
676 | {
677 | "listen": "test",
678 | "script": {
679 | "exec": [
680 | "pm.test(\"Response code is OK\", function () {\r",
681 | " pm.response.to.have.status(204);\r",
682 | "});\r",
683 | ""
684 | ],
685 | "type": "text/javascript"
686 | }
687 | }
688 | ],
689 | "request": {
690 | "auth": {
691 | "type": "bearer",
692 | "bearer": [
693 | {
694 | "key": "token",
695 | "value": "{{admin-auth-token}}",
696 | "type": "string"
697 | }
698 | ]
699 | },
700 | "method": "DELETE",
701 | "header": [],
702 | "url": {
703 | "raw": "{{uri}}/auth/user?username={{username}}",
704 | "host": [
705 | "{{uri}}"
706 | ],
707 | "path": [
708 | "auth",
709 | "user"
710 | ],
711 | "query": [
712 | {
713 | "key": "username",
714 | "value": "{{username}}"
715 | }
716 | ]
717 | }
718 | },
719 | "response": []
720 | }
721 | ]
722 | }
723 | ]
724 | }
725 | ]
726 | }
727 |
--------------------------------------------------------------------------------
/assets/tests/regression-tests/postman/auth-server-regression.postman_environment_develop.json:
--------------------------------------------------------------------------------
1 | {
2 | "id": "c326a9c8-6cb1-4f9e-9361-5131bf8636c8",
3 | "name": "auth-server-regression-develop",
4 | "values": [
5 | {
6 | "key": "uri",
7 | "value": "https://oth-auth-server.herokuapp.com",
8 | "enabled": true
9 | },
10 | {
11 | "key": "auto-verify-enabled",
12 | "value": "true",
13 | "enabled": true
14 | },
15 | {
16 | "key": "username",
17 | "value": "postman-regression-develop",
18 | "enabled": true
19 | },
20 | {
21 | "key": "email",
22 | "value": "postman-regression-develop@oth.com",
23 | "enabled": true
24 | },
25 | {
26 | "key": "password",
27 | "value": "password",
28 | "enabled": true
29 | },
30 | {
31 | "key": "changed-password",
32 | "value": "changed-password",
33 | "enabled": true
34 | },
35 | {
36 | "key": "access-token",
37 | "value": "access-token",
38 | "enabled": true
39 | },
40 | {
41 | "key": "refresh-token",
42 | "value": "refresh-token",
43 | "enabled": true
44 | },
45 | {
46 | "key": "reset-password-token",
47 | "value": "reset-password-token",
48 | "enabled": true
49 | }
50 | ],
51 | "_postman_variable_scope": "environment",
52 | "_postman_exported_at": "2021-02-07T20:04:27.694Z",
53 | "_postman_exported_using": "Postman/8.0.4"
54 | }
55 |
--------------------------------------------------------------------------------
/assets/tests/regression-tests/postman/auth-server-regression.postman_environment_local.json:
--------------------------------------------------------------------------------
1 | {
2 | "id": "aad65d89-0bba-4f1b-87b6-a8cb8ddcf099",
3 | "name": "auth-server-regression-local",
4 | "values": [
5 | {
6 | "key": "uri",
7 | "value": "http://localhost:4001",
8 | "enabled": true
9 | },
10 | {
11 | "key": "auto-verify-enabled",
12 | "value": "true",
13 | "enabled": true
14 | },
15 | {
16 | "key": "username",
17 | "value": "postman-regression-local",
18 | "enabled": true
19 | },
20 | {
21 | "key": "email",
22 | "value": "postman-regression-local@oth.com",
23 | "enabled": true
24 | },
25 | {
26 | "key": "password",
27 | "value": "password",
28 | "enabled": true
29 | },
30 | {
31 | "key": "changed-password",
32 | "value": "changed-password",
33 | "enabled": true
34 | },
35 | {
36 | "key": "access-token",
37 | "value": "access-token",
38 | "enabled": true
39 | },
40 | {
41 | "key": "refresh-token",
42 | "value": "refresh-token",
43 | "enabled": true
44 | },
45 | {
46 | "key": "reset-password-token",
47 | "value": "reset-password-token",
48 | "enabled": true
49 | }
50 | ],
51 | "_postman_variable_scope": "environment",
52 | "_postman_exported_at": "2021-02-07T20:04:36.672Z",
53 | "_postman_exported_using": "Postman/8.0.4"
54 | }
55 |
--------------------------------------------------------------------------------
/assets/tests/stress-tests/login.jmx:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 | false
7 | true
8 | true
9 |
10 |
11 |
12 |
13 |
14 |
15 |
16 | continue
17 |
18 | false
19 | -1
20 |
21 | 50
22 | 1
23 | false
24 |
25 |
26 | true
27 |
28 |
29 |
30 | true
31 |
32 |
33 |
34 | false
35 | {
36 | "username": "username",
37 | "password": "password"
38 | }
39 |
40 | =
41 |
42 |
43 |
44 | localhost
45 | 4001
46 | http
47 |
48 | auth/login
49 | POST
50 | true
51 | false
52 | true
53 | false
54 |
55 |
56 |
57 |
58 |
59 |
60 |
61 |
62 | content-type
63 | application/json
64 |
65 |
66 |
67 |
68 |
69 |
70 | false
71 |
72 | saveConfig
73 |
74 |
75 | true
76 | true
77 | true
78 |
79 | true
80 | true
81 | true
82 | true
83 | false
84 | true
85 | true
86 | false
87 | false
88 | false
89 | true
90 | false
91 | false
92 | false
93 | true
94 | 0
95 | true
96 | true
97 | true
98 | true
99 | true
100 | true
101 |
102 |
103 |
104 |
105 |
106 |
107 |
108 |
109 |
110 |
--------------------------------------------------------------------------------
/auth-server.main.ts:
--------------------------------------------------------------------------------
1 | /**
2 | * @description holds server main
3 | */
4 |
5 | import { DebugLogUtil, UsageUtil } from '@open-template-hub/common';
6 | import bodyParser from 'body-parser';
7 | import cors from 'cors';
8 | import dotenv from 'dotenv';
9 | import express from 'express';
10 | import { Routes } from './app/route/index.route';
11 |
12 | const debugLogUtil = new DebugLogUtil();
13 |
14 | const env = dotenv.config();
15 | debugLogUtil.log( env.parsed );
16 |
17 | // express init
18 | const app: express.Application = express();
19 |
20 | // public files
21 | app.use( express.static( 'public' ) );
22 |
23 | // parse application/json
24 | app.use( bodyParser.urlencoded( { extended: false } ) );
25 | app.use( bodyParser.json() );
26 | app.use( cors() );
27 |
28 | // mount routes
29 | Routes.mount( app );
30 |
31 | // listen port
32 | const port: string = process.env.PORT || ( '4001' as string );
33 |
34 | app.listen( port, () => {
35 | console.info( 'Auth Server is running on port', port );
36 |
37 | const usageUtil = new UsageUtil();
38 | const memoryUsage = usageUtil.getMemoryUsage();
39 | console.info( `Startup Memory Usage: ${ memoryUsage.toFixed( 2 ) } MB` );
40 | } );
41 |
--------------------------------------------------------------------------------
/dependency-checker.ts:
--------------------------------------------------------------------------------
1 | const { spawnSync } = require( 'child_process' );
2 | const outdatedCmd = spawnSync( 'npm', [ 'outdated' ] );
3 |
4 | const lines = outdatedCmd.stdout.toString().split( '\n' );
5 |
6 | const columnIndexes = [ 0, 0, 0, 0 ];
7 |
8 | let indexOfDependedBy = -1;
9 |
10 | console.log(
11 | '\n' +
12 | ' \n' +
13 | ' 
\n' +
14 | ' \n' +
15 | '
\n' +
16 | '\n' +
17 | '\n' +
18 | '\n' +
19 | 'Open Template Hub - Auth Server Template v5\n' +
20 | '
\n' +
21 | '(outdated packages)\n' +
22 | '
\n' +
23 | '\n' +
24 | 'Following packages are not updated in the develop branch yet. So, if you want to update outdated packages on your own risk, update the package.json and install dependencies.\n'
25 | );
26 |
27 | for ( const line of lines ) {
28 | if ( line.length === 0 ) {
29 | continue;
30 | }
31 |
32 | if ( lines.indexOf( line ) === 0 ) {
33 | columnIndexes[ 0 ] = line.indexOf( 'Current' );
34 | columnIndexes[ 1 ] = line.indexOf( 'Wanted' ) + 3;
35 | columnIndexes[ 2 ] = line.indexOf( 'Latest' ) + 6;
36 | columnIndexes[ 3 ] = line.indexOf( 'Location' ) + 9;
37 | }
38 |
39 | let modifiedLine = '';
40 |
41 | if ( columnIndexes [ 0 ] >= 0 ) {
42 | const stringParts = line.split( /(\s+)/ );
43 |
44 | modifiedLine += '| ';
45 |
46 | for ( let i = 0; i < stringParts.length; ++i ) {
47 | const part = stringParts[ i ];
48 |
49 | if ( lines.indexOf( line ) === 0 && i < stringParts.length - 1 && stringParts[ i + 1 ] === 'Depended' ) {
50 | indexOfDependedBy = i;
51 | }
52 |
53 | if ( indexOfDependedBy !== -1 && i >= indexOfDependedBy ) {
54 | continue;
55 | }
56 |
57 | if ( part.match( /\s+/ ) ) {
58 | modifiedLine += ' | ';
59 | } else {
60 | modifiedLine += part;
61 | }
62 | }
63 |
64 | modifiedLine += ' |';
65 |
66 | console.log( modifiedLine );
67 | } else {
68 | console.log( modifiedLine );
69 | }
70 |
71 | if ( lines.indexOf( line ) === 0 ) {
72 | console.log( '| --- | --- | --- | --- | --- |' );
73 | }
74 | }
75 |
76 | console.log(
77 | '\n' +
78 | ' | Open Template Hub © 2023 |
\n'
79 | );
80 |
--------------------------------------------------------------------------------
/docs/OUTDATED.md:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
9 | Open Template Hub - Auth Server Template v5
10 |
11 | (outdated packages)
12 |
13 |
14 | Following packages are not updated in the develop branch yet. So, if you want to update outdated packages on your own risk, update the package.json and install dependencies.
15 |
16 | | Package | Current | Wanted | Latest | Location |
17 | | --- | --- | --- | --- | --- |
18 | | @open-template-hub/common | 5.0.10 | 5.0.10 | 5.0.18 | node_modules/@open-template-hub/common |
19 | | @types/express | 4.17.23 | 4.17.23 | 5.0.3 | node_modules/@types/express |
20 | | @types/uuid | 9.0.8 | 9.0.8 | 10.0.0 | node_modules/@types/uuid |
21 | | bcrypt | 5.1.1 | 5.1.1 | 6.0.0 | node_modules/bcrypt |
22 | | body-parser | 1.20.3 | 1.20.3 | 2.2.0 | node_modules/body-parser |
23 | | express | 4.21.2 | 4.21.2 | 5.1.0 | node_modules/express |
24 | | mongoose | 6.13.8 | 6.13.8 | 8.15.1 | node_modules/mongoose |
25 | | nodemon | 2.0.22 | 2.0.22 | 3.1.10 | node_modules/nodemon |
26 | | typescript | 4.9.5 | 4.9.5 | 5.8.3 | node_modules/typescript |
27 | | uuid | 9.0.1 | 9.0.1 | 11.1.0 | node_modules/uuid |
28 |
29 | | Open Template Hub © 2023 |
30 |
31 |
--------------------------------------------------------------------------------
/docs/REGRESSION_TESTS.md:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
9 | Open Template Hub - Auth Server Template v5
10 |
11 | (postman regression tests)
12 |
13 |
14 | ## Prerequisite
15 |
16 | Please check [README.md](../README.md) to get more information to configure environment
17 |
18 | ## Configuration
19 |
20 | * Import **auth-server-regression.postman_environment_local.json** as environment to Postman
21 |
22 | * Import **auth-server-regression.postman_collection.json** as collection to Postman
23 |
24 | * Update imported environment variables and run collection on Postman
25 |
26 | | Open Template Hub © 2023 |
27 |
--------------------------------------------------------------------------------
/docs/SOCIAL_LOGIN.md:
--------------------------------------------------------------------------------
1 |
2 |
3 | 
4 |
5 |
6 |
7 |
8 | Auth Server Template
9 |
10 | (Social Login Configuration Guide)
11 |
12 |
13 | Follow the instructions to be able to use social login meshanism
14 |
15 | ## Social Login Configurations
16 |
17 | This is the list of pre-tested social logins. Configuring only what you need to use is enough.
18 |
19 | 1. [Google](#1-google)
20 | 2. [GitHub](#2-github)
21 | 3. [Facebook](#3-facebook)
22 | 4. [Twitter](#4-twitter)
23 | 5. [LinkedIn](#5-linkedin)
24 | 6. [Reddit](#6-reddit)
25 | 7. [Dribbble](#7-dribbble)
26 | 8. [Twitch](#8-twitch)
27 |
28 | ### 1. Google
29 |
30 | Create your application from **[console.developers.google.com](https://console.developers.google.com)**, fill the fields in the **SQL** below appropriately and run the query.
31 |
32 | ``` sql
33 | INSERT INTO social_logins (social_login_key, developer_notes) VALUES ('GOOGLE', 'https://console.developers.google.com');
34 | INSERT INTO oauth_v2_config_params
35 | (
36 | social_login_key,
37 | client_id,
38 | client_secret,
39 | redirect_uri,
40 | login_uri,
41 | access_token_uri,
42 | access_token_json_field_path,
43 | user_data_uri,
44 | external_user_id_json_field_path,
45 | external_user_email_json_field_path,
46 | external_username_json_field_path,
47 | token_type_json_field_path,
48 | requested_with_auth_header,
49 | access_token_request_method
50 | )
51 | VALUES
52 | (
53 | 'GOOGLE',
54 | ,
55 | ,
56 | ,
57 | 'https://accounts.google.com/o/oauth2/v2/auth?client_id={{0}}&state={{1}}&redirect_uri={{2}}&response_type=code&scope=openid%20profile%20email',
58 | 'https://oauth2.googleapis.com/token?client_id={{0}}&client_secret={{1}}&redirect_uri={{2}}&code={{3}}&grant_type=authorization_code',
59 | 'access_token',
60 | 'https://people.googleapis.com/v1/people/me?personFields=emailAddresses&access_token={{0}}',
61 | 'emailAddresses.0.metadata.source.id',
62 | 'emailAddresses.0.value',
63 | NULL,
64 | NULL,
65 | false,
66 | 'POST'
67 | );
68 | ```
69 |
70 | ### 2. GitHub
71 |
72 | Create your application from **[github.com/settings/developers](https://github.com/settings/developers)**, fill the fields in the **SQL** below appropriately and run the query.
73 |
74 | ``` sql
75 | INSERT INTO social_logins (social_login_key, developer_notes) VALUES ('GITHUB', 'https://github.com/settings/developers');
76 | INSERT INTO oauth_v2_config_params
77 | (
78 | social_login_key,
79 | client_id,
80 | client_secret,
81 | redirect_uri,
82 | login_uri,
83 | access_token_uri,
84 | access_token_json_field_path,
85 | user_data_uri,
86 | external_user_id_json_field_path,
87 | external_user_email_json_field_path,
88 | external_username_json_field_path,
89 | token_type_json_field_path,
90 | requested_with_auth_header,
91 | access_token_request_method
92 | )
93 | VALUES (
94 | 'GITHUB',
95 | ,
96 | ,
97 | ,
98 | 'https://github.com/login/oauth/authorize?client_id={{0}}&state={{1}}&redirect_uri={{2}}',
99 | 'https://github.com/login/oauth/access_token?client_id={{0}}&client_secret={{1}}&redirect_uri={{2}}&code={{3}}',
100 | 'access_token',
101 | 'https://api.github.com/user',
102 | 'id',
103 | 'email',
104 | 'login',
105 | 'token_type',
106 | true,
107 | 'GET'
108 | );
109 | ```
110 |
111 | ### 3. Facebook
112 |
113 | Create your application from **[developers.facebook.com](https://developers.facebook.com)**, fill the fields in the **SQL** below appropriately and run the query.
114 |
115 | ``` sql
116 | INSERT INTO social_logins (social_login_key, developer_notes) VALUES ('FACEBOOK', 'https://developers.facebook.com');
117 | INSERT INTO oauth_v2_config_params
118 | (
119 | social_login_key,
120 | client_id,
121 | client_secret,
122 | redirect_uri,
123 | login_uri,
124 | access_token_uri,
125 | access_token_json_field_path,
126 | user_data_uri,
127 | external_user_id_json_field_path,
128 | external_user_email_json_field_path,
129 | external_username_json_field_path,
130 | token_type_json_field_path,
131 | requested_with_auth_header,
132 | access_token_request_method
133 | )
134 | VALUES
135 | (
136 | 'FACEBOOK',
137 | ,
138 | ,
139 | ,
140 | 'https://www.facebook.com/v6.0/dialog/oauth?client_id={{0}}&redirect_uri={{2}}',
141 | 'https://graph.facebook.com/v6.0/oauth/access_token?client_id={{0}}&client_secret={{1}}&redirect_uri={{2}}&code={{3}}#_=_',
142 | 'access_token',
143 | 'https://graph.facebook.com/me?fields=id,email&access_token={{0}}',
144 | 'id',
145 | 'email',
146 | NULL,
147 | 'token_type',
148 | false,
149 | 'GET'
150 | );
151 | ```
152 |
153 | ### 4. Twitter
154 |
155 | Create your application from **[developer.twitter.com/en/apps](https://developer.twitter.com/en/apps)**, fill the fields in the **SQL** below appropriately and run the query.
156 |
157 | ``` sql
158 | INSERT INTO social_logins (social_login_key, developer_notes) VALUES ('TWITTER', 'https://developer.twitter.com/en/apps');
159 | INSERT INTO oauth_v1_config_params
160 | (
161 | social_login_key,
162 | client_id,
163 | client_secret,
164 | redirect_uri,
165 | login_uri,
166 | access_token_uri,
167 | access_token_query_param_field_path,
168 | user_data_uri,
169 | external_user_id_query_param_field_path,
170 | external_user_email_query_param_field_path,
171 | external_username_query_param_field_path,
172 | request_token_uri,
173 | access_token_request_method
174 | )
175 | VALUES
176 | (
177 | 'TWITTER',
178 | ,
179 | ,
180 | ,
181 | 'https://api.twitter.com/oauth/authenticate?oauth_token={{0}}',
182 | 'https://api.twitter.com/oauth/access_token?oauth_token={{0}}&oauth_verifier={{1}}',
183 | 'oauth_token',
184 | 'https://api.twitter.com/1.1/account/verify_credentials.json',
185 | 'user_id',
186 | NULL,
187 | 'screen_name',
188 | 'https://api.twitter.com/oauth/request_token',
189 | 'POST'
190 | );
191 | ```
192 |
193 | ### 5. LinkedIn
194 |
195 | Create your application from **[linkedin.com/developers/apps](https://linkedin.com/developers/apps)**, fill the fields in the **SQL** below appropriately and run the query.
196 |
197 | ``` sql
198 | INSERT INTO social_logins (social_login_key, developer_notes) VALUES ('LINKEDIN', 'https://linkedin.com/developers/apps');
199 | INSERT INTO oauth_v2_config_params
200 | (
201 | social_login_key,
202 | client_id,
203 | client_secret,
204 | redirect_uri,
205 | login_uri,
206 | access_token_uri,
207 | access_token_json_field_path,
208 | user_data_uri,
209 | external_user_id_json_field_path,
210 | external_user_email_json_field_path,
211 | external_username_json_field_path,
212 | token_type_json_field_path,
213 | requested_with_auth_header,
214 | access_token_request_method
215 | )
216 | VALUES
217 | (
218 | 'LINKEDIN',
219 | ,
220 | ,
221 | ,
222 | 'https://www.linkedin.com/oauth/v2/authorization?client_id={{0}}&state={{1}}&redirect_uri={{2}}&response_type=code&scope=r_liteprofile',
223 | 'https://www.linkedin.com/oauth/v2/accessToken?grant_type=authorization_code&client_id={{0}}&client_secret={{1}}&redirect_uri={{2}}&code={{3}}',
224 | 'access_token',
225 | 'https://api.linkedin.com/v2/me?projection=(id)',
226 | 'id',
227 | NULL,
228 | NULL,
229 | NULL,
230 | true,
231 | 'POST'
232 | );
233 | ```
234 |
235 | ### 6. Reddit
236 |
237 | Create your application from **[reddit.com/prefs/apps](https://reddit.com/prefs/apps)**, fill the fields in the **SQL** below appropriately and run the query.
238 |
239 | ``` sql
240 | INSERT INTO social_logins (social_login_key, developer_notes) VALUES ('REDDIT', 'https://reddit.com/prefs/apps');
241 | INSERT INTO oauth_v2_config_params
242 | (
243 | social_login_key,
244 | client_id,
245 | client_secret,
246 | redirect_uri,
247 | login_uri,
248 | access_token_uri,
249 | access_token_json_field_path,
250 | user_data_uri,
251 | external_user_id_json_field_path,
252 | external_user_email_json_field_path,
253 | external_username_json_field_path,
254 | token_type_json_field_path,
255 | requested_with_auth_header,
256 | access_token_request_method
257 | )
258 | VALUES
259 | (
260 | 'REDDIT',
261 | ,
262 | ,
263 | ,
264 | 'https://old.reddit.com/api/v1/authorize?client_id={{0}}&state={{1}}&redirect_uri={{2}}&response_type=code&scope=identity&duration=temporary',
265 | 'https://{{0}}:{{1}}@www.reddit.com/api/v1/access_token?grant_type=authorization_code&code={{3}}&redirect_uri={{2}}',
266 | 'access_token',
267 | 'https://oauth.reddit.com/api/v1/me',
268 | 'id',
269 | NULL,
270 | 'name',
271 | 'token_type',
272 | true,
273 | 'POST'
274 | );
275 | ```
276 |
277 | ### 7. Dribbble
278 |
279 | Create your application from **[dribbble.com/account/applications](https://dribbble.com/account/applications)**, fill the fields in the **SQL** below appropriately and run the query.
280 |
281 | ``` sql
282 | INSERT INTO social_logins (social_login_key, developer_notes) VALUES ('DRIBBBLE', 'https://dribbble.com/account/applications');
283 | INSERT INTO oauth_v2_config_params
284 | (
285 | social_login_key,
286 | client_id,
287 | client_secret,
288 | redirect_uri,
289 | login_uri,
290 | access_token_uri,
291 | access_token_json_field_path,
292 | user_data_uri,
293 | external_user_id_json_field_path,
294 | external_user_email_json_field_path,
295 | external_username_json_field_path,
296 | token_type_json_field_path,
297 | requested_with_auth_header,
298 | access_token_request_method
299 | )
300 | VALUES
301 | (
302 | 'DRIBBBLE',
303 | ,
304 | ,
305 | ,
306 | 'https://dribbble.com/oauth/authorize?client_id={{0}}&state={{1}}&redirect_uri={{2}}&scope=public',
307 | 'https://dribbble.com/oauth/token?client_id={{0}}&client_secret={{1}}&redirect_uri={{2}}&code={{3}}',
308 | 'access_token',
309 | 'https://api.dribbble.com/v2/user',
310 | 'id',
311 | NULL,
312 | 'login',
313 | 'token_type',
314 | true,
315 | 'POST'
316 | );
317 | ```
318 |
319 | ### 8. Twitch
320 |
321 | Create your application from **[dev.twitch.tv/console/apps](https://dev.twitch.tv/console/apps)**, fill the fields in the **SQL** below appropriately and run the query.
322 |
323 | ``` sql
324 | INSERT INTO social_logins (social_login_key, developer_notes) VALUES ('TWITCH', 'https://dev.twitch.tv/console/apps');
325 | INSERT INTO oauth_v2_config_params
326 | (
327 | social_login_key,
328 | client_id,
329 | client_secret,
330 | redirect_uri,
331 | login_uri,
332 | access_token_uri,
333 | access_token_json_field_path,
334 | user_data_uri,
335 | external_user_id_json_field_path,
336 | external_user_email_json_field_path,
337 | external_username_json_field_path,
338 | token_type_json_field_path,
339 | requested_with_auth_header,
340 | access_token_request_method
341 | )
342 | VALUES
343 | (
344 | 'TWITCH',
345 | ,
346 | ,
347 | ,
348 | 'https://id.twitch.tv/oauth2/authorize?client_id={{0}}&state={{1}}&redirect_uri={{2}}&response_type=code&scope=user_read',
349 | 'https://id.twitch.tv/oauth2/token?client_id={{0}}&client_secret={{1}}&redirect_uri={{2}}&code={{3}}&grant_type=authorization_code',
350 | 'access_token',
351 | 'https://api.twitch.tv/helix/users',
352 | 'data.0.id',
353 | NULL,
354 | 'data.0.login',
355 | 'token_type',
356 | true,
357 | 'POST'
358 | );
359 | ```
360 |
--------------------------------------------------------------------------------
/env.sh:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env bash
2 |
3 | if [ ! -f .env ]; then
4 | echo "Generating .env file.."
5 | touch .env
6 | {
7 | echo "PORT=4001"
8 |
9 | echo "PROJECT=OTH"
10 | echo "MODULE=AuthServer"
11 | echo "ENVIRONMENT=Local"
12 |
13 | echo "CLIENT_URL=http://localhost:4200"
14 | echo "ADMIN_CLIENT_URLS=http://localhost:4202"
15 |
16 | echo "DATABASE_URL={Database Connection Url}"
17 | echo "POSTGRESQL_CONNECTION_LIMIT={Postgresql Connection Limit}"
18 |
19 | echo "CLOUDAMQP_APIKEY={MQ Api Key}"
20 | echo "CLOUDAMQP_URL={MQ Connection Url}"
21 |
22 | echo "AUTH_SERVER_QUEUE_CHANNEL=oth_auth_queue"
23 | echo "ORCHESTRATION_SERVER_QUEUE_CHANNEL=oth_orchestration_queue"
24 |
25 | echo "REDISCLOUD_URL={Redis Connection Url}"
26 | echo "REDIS_CONNECTION_LIMIT={Redis Connection Limit}"
27 |
28 | echo "AUTO_VERIFY=false"
29 |
30 | echo "ACCESS_TOKEN_EXPIRE=1hour"
31 | echo "ACCESS_TOKEN_SECRET={Access Token Secret}"
32 |
33 | echo "REFRESH_TOKEN_EXPIRE=30days"
34 | echo "REFRESH_TOKEN_SECRET={Refresh Token Secret}"
35 |
36 | echo "JOIN_TEAM_TOKEN_EXPIRE=10days"
37 | echo "JOIN_TEAM_TOKEN_SECRET={Join Team Token Secret}"
38 |
39 | echo "RESET_PASSWORD_TOKEN_EXPIRE=1day"
40 | echo "RESET_PASSWORD_TOKEN_SECRET={Reset Token Secret}"
41 |
42 | echo "VERIFICATION_TOKEN_SECRET={Verification Token Secret"
43 |
44 | echo "RESPONSE_ENCRYPTION_SECRET={Response Encryption Secret}"
45 |
46 | echo "PREAUTH_TOKEN_SECRET={Pre Auth Token Secret}"
47 |
48 | echo "TWO_FACTOR_EXPIRE=90"
49 | echo "TWO_FACTOR_CODE_LENGTH=5"
50 | echo "TWO_FACTOR_CODE_TYPE=numeric"
51 | } >>.env
52 | else
53 | echo ".env file already exists. Nothing to do..."
54 | fi
55 |
--------------------------------------------------------------------------------
/environment.ts:
--------------------------------------------------------------------------------
1 | import {
2 | DbArgs,
3 | EnvArgs,
4 | ExtendedArgs,
5 | TokenArgs,
6 | TwoFactorArgs,
7 | } from '@open-template-hub/common';
8 |
9 | export class Environment {
10 | constructor(private _args: EnvArgs = {} as EnvArgs) {
11 | const tokenArgs = {
12 | accessTokenExpire: process.env.ACCESS_TOKEN_EXPIRE,
13 | accessTokenSecret: process.env.ACCESS_TOKEN_SECRET,
14 | refreshTokenExpire: process.env.REFRESH_TOKEN_EXPIRE,
15 | refreshTokenSecret: process.env.REFRESH_TOKEN_SECRET,
16 | joinTeamTokenSecretExpire: process.env.JOIN_TEAM_TOKEN_EXPIRE,
17 | joinTeamTokenSecret: process.env.JOIN_TEAM_TOKEN_SECRET,
18 |
19 | resetPasswordTokenExpire: process.env.RESET_PASSWORD_TOKEN_EXPIRE,
20 | resetPasswordTokenSecret: process.env.RESET_PASSWORD_TOKEN_SECRET,
21 |
22 | responseEncryptionSecret: process.env.RESPONSE_ENCRYPTION_SECRET,
23 |
24 | verificationTokenSecret: process.env.VERIFICATION_TOKEN_SECRET,
25 |
26 | preAuthTokenSecret: process.env.PREAUTH_TOKEN_SECRET,
27 | } as TokenArgs;
28 |
29 | const dbArgs = {
30 | mongoDbConnectionLimit: process.env.MONGODB_CONNECTION_LIMIT,
31 | mongoDbUri: process.env.MONGODB_URI,
32 |
33 | postgresqlUri: process.env.DATABASE_URL,
34 | postgresqlConnectionLimit: process.env.POSTGRESQL_CONNECTION_LIMIT,
35 |
36 | redisUri: process.env.REDISCLOUD_URL,
37 | redisConnectionLimit: process.env.REDIS_CONNECTION_LIMIT,
38 | } as DbArgs;
39 |
40 | const extendedArgs = {
41 | clientUrl: process.env.CLIENT_URL,
42 | } as ExtendedArgs;
43 |
44 | const mqArgs = {
45 | messageQueueConnectionUrl: process.env.CLOUDAMQP_URL,
46 | authServerMessageQueueChannel: process.env.AUTH_SERVER_QUEUE_CHANNEL,
47 | orchestrationServerMessageQueueChannel:
48 | process.env.ORCHESTRATION_SERVER_QUEUE_CHANNEL,
49 | };
50 |
51 | const twoFactorCodeArgs = {
52 | twoFactorCodeExpire: process.env.TWO_FACTOR_EXPIRE,
53 | twoFactorCodeLength: process.env.TWO_FACTOR_CODE_LENGTH,
54 | twoFactorCodeType: process.env.TWO_FACTOR_CODE_TYPE,
55 | } as TwoFactorArgs;
56 |
57 | this._args = {
58 | tokenArgs,
59 | dbArgs,
60 | mqArgs,
61 | extendedArgs,
62 | twoFactorCodeArgs,
63 | } as EnvArgs;
64 | }
65 |
66 | args = () => {
67 | return this._args;
68 | };
69 | }
70 |
--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "auth-server-template",
3 | "description": "Auth Server Template is a generic open-source authentication server that has a simple yet powerful design to connect your business with all OAuth 2.0 and OAuth supporting third-party companies (like Google, Facebook, Twitter, or LinkedIn). It also supports a basic username-password authentication system.",
4 | "version": "5.0.1",
5 | "license": "MIT",
6 | "main": "auth-server.main.ts",
7 | "scripts": {
8 | "start": "node version-generator.ts > ./version.ts && ts-node auth-server.main.ts",
9 | "startLocal": "nodemon --exec DEBUG=* ts-node auth-server.main.ts",
10 | "postmanLocal": "mkdir -p -- ./assets/test-results && touch ./assets/test-results/postman-dark.html && touch ./assets/test-results/postman.html && newman run assets/tests/regression-tests/postman/auth-server-regression.postman_collection.json -e assets/tests/regression-tests/postman/auth-server-regression.postman_environment_local.json -r htmlextra --reporter-htmlextra-export ./assets/test-results/postman.html --reporter-htmlextra-darkTheme > ./assets/test-results/postman-dark.html --env-var $npm_config_adminAuthToken --env-var $npm_config_responseEncryptionSecret",
11 | "postmanDevelop": "mkdir -p -- ./assets/test-results && touch ./assets/test-results/postman-dark.html && touch ./assets/test-results/postman.html && newman run assets/tests/regression-tests/postman/auth-server-regression.postman_collection.json -e assets/tests/regression-tests/postman/auth-server-regression.postman_environment_develop.json -r htmlextra --reporter-htmlextra-export ./assets/test-results/postman.html --reporter-htmlextra-darkTheme > ./assets/test-results/postman-dark.html --env-var $npm_config_adminAuthToken --env-var $npm_config_responseEncryptionSecret",
12 | "outdated": "node dependency-checker.ts > docs/OUTDATED.md"
13 | },
14 | "dependencies": {
15 | "@open-template-hub/common": "5.0.10",
16 | "@types/bcrypt": "^5.0.0",
17 | "@types/capitalize": "^2.0.0",
18 | "@types/cors": "^2.8.13",
19 | "@types/express": "^4.17.15",
20 | "@types/mongoose": "^5.11.97",
21 | "@types/uuid": "^9.0.0",
22 | "axios": "^1.2.2",
23 | "bcrypt": "^5.1.0",
24 | "body-parser": "^1.20.1",
25 | "capitalize": "^2.0.4",
26 | "cors": "^2.8.5",
27 | "crypto": "^1.0.1",
28 | "dotenv": "^16.0.3",
29 | "express": "^4.18.2",
30 | "express-promise-router": "^4.1.1",
31 | "mongoose": "^6.8.3",
32 | "oauth-1.0a": "^2.2.6",
33 | "ts-node": "^10.9.1",
34 | "typescript": "^4.9.4",
35 | "uuid": "^9.0.0"
36 | },
37 | "devDependencies": {
38 | "nodemon": "^2.0.20"
39 | },
40 | "git repository": "https://github.com/open-template-hub/auth-server-template",
41 | "repository": {
42 | "type": "git",
43 | "url": "git+https://github.com/open-template-hub/auth-server-template.git"
44 | },
45 | "keywords": [
46 | "nodejs",
47 | "template",
48 | "oauth",
49 | "oauth2 express",
50 | "authentication",
51 | "server facebook-login",
52 | "twitter-login google-login",
53 | "social-login linkedin-login",
54 | "nodejs-express github-login",
55 | "twitch-login",
56 | "backend",
57 | "rest",
58 | "node",
59 | "nodejs",
60 | "typescript",
61 | "template",
62 | "server template",
63 | "open template hub"
64 | ]
65 | }
66 |
--------------------------------------------------------------------------------
/tsconfig.json:
--------------------------------------------------------------------------------
1 | {
2 | "compilerOptions": {
3 | /* Basic Options */
4 | "target": "es5",
5 | /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */
6 | "module": "commonjs",
7 | /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */
8 | // "lib": [], /* Specify library files to be included in the compilation. */
9 | // "allowJs": true, /* Allow javascript files to be compiled. */
10 | // "checkJs": true, /* Report errors in .js files. */
11 | // "jsx": "preserve", /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
12 | // "declaration": true, /* Generates corresponding '.d.ts' file. */
13 | // "declarationMap": true, /* Generates a sourcemap for each corresponding '.d.ts' file. */
14 | "sourceMap": true,
15 | /* Generates corresponding '.map' file. */
16 | // "outFile": "./", /* Concatenate and emit output to single file. */
17 | "outDir": "out",
18 | /* Redirect output structure to the directory. */
19 | // "rootDir": "./", /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
20 | // "composite": true, /* Enable project compilation */
21 | // "incremental": true, /* Enable incremental compilation */
22 | // "tsBuildInfoFile": "./", /* Specify file to store incremental compilation information */
23 | // "removeComments": true, /* Do not emit comments to output. */
24 | // "noEmit": true, /* Do not emit outputs. */
25 | // "importHelpers": true, /* Import emit helpers from 'tslib'. */
26 | // "downlevelIteration": true, /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
27 | // "isolatedModules": true, /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
28 |
29 | /* Strict Type-Checking Options */
30 | "strict": true,
31 | /* Enable all strict type-checking options. */
32 | "noImplicitAny": true,
33 | /* Raise error on expressions and declarations with an implied 'any' type. */
34 | // "strictNullChecks": true, /* Enable strict null checks. */
35 | // "strictFunctionTypes": true, /* Enable strict checking of function types. */
36 | // "strictBindCallApply": true, /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
37 | // "strictPropertyInitialization": true, /* Enable strict checking of property initialization in classes. */
38 | // "noImplicitThis": true, /* Raise error on 'this' expressions with an implied 'any' type. */
39 | // "alwaysStrict": true, /* Parse in strict mode and emit "use strict" for each source file. */
40 |
41 | /* Additional Checks */
42 | // "noUnusedLocals": true, /* Report errors on unused locals. */
43 | // "noUnusedParameters": true, /* Report errors on unused parameters. */
44 | // "noImplicitReturns": true, /* Report error when not all code paths in function return a value. */
45 | // "noFallthroughCasesInSwitch": true, /* Report errors for fallthrough cases in switch statement. */
46 |
47 | /* Module Resolution Options */
48 | // "moduleResolution": "node", /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
49 | // "baseUrl": "./", /* Base directory to resolve non-absolute module names. */
50 | // "paths": {}, /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
51 | // "rootDirs": [], /* List of root folders whose combined content represents the structure of the project at runtime. */
52 | // "typeRoots": [], /* List of folders to include type definitions from. */
53 | // "types": [], /* Type declaration files to be included in compilation. */
54 | // "allowSyntheticDefaultImports": true, /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
55 | "esModuleInterop": true
56 | /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
57 | // "preserveSymlinks": true, /* Do not resolve the real path of symlinks. */
58 |
59 | /* Source Map Options */
60 | // "sourceRoot": "", /* Specify the location where debugger should locate TypeScript files instead of source locations. */
61 | // "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */
62 | // "inlineSourceMap": true, /* Emit a single file with source maps instead of having a separate file. */
63 | // "inlineSources": true, /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
64 |
65 | /* Experimental Options */
66 | // "experimentalDecorators": true, /* Enables experimental support for ES7 decorators. */
67 | // "emitDecoratorMetadata": true, /* Enables experimental support for emitting type metadata for decorators. */
68 | }
69 | }
70 |
--------------------------------------------------------------------------------
/version-generator.ts:
--------------------------------------------------------------------------------
1 | console.log( 'export const version = \'' + require( './package.json' ).version + '\';' );
2 |
--------------------------------------------------------------------------------
/version.ts:
--------------------------------------------------------------------------------
1 | export const version = '3.0.1';
2 |
--------------------------------------------------------------------------------
