Skip to content

#389 - Added Relay verification route #394

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 30, 2023
Merged

#389 - Added Relay verification route #394

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9503105
#389 - Added Relay verification route
petruki Apr 30, 2023
625a59f
Fixed code smell
petruki Apr 30, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 48 additions & 0 deletions requests/Switcher API.postman_collection.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3793,6 +3793,54 @@
},
"response": []
},
{
"name": "Config - Relay - Verify",
"request": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{url}}/config/relay/verify/:config?code=",
"host": [
"{{url}}"
],
"path": [
"config",
"relay",
"verify",
":config"
],
"query": [
{
"key": "code",
"value": ""
}
],
"variable": [
{
"key": "config",
"value": "5e0eceb66f4f994eac9007b2"
}
]
}
},
"response": []
},
{
"name": "Config - Read Relay Specs",
"request": {
Expand Down
29 changes: 29 additions & 0 deletions src/api-docs/paths/path-config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -302,6 +302,35 @@ export default {
}
}
},
'/config/relay/verify/{id}': {
patch: {
tags: ['Config'],
description: 'Verify Config Relay ownership based on given verification code',
security: [{ bearerAuth: [] }],
parameters: [
pathParameter('id', 'Config ID', true),
queryParameter('code', 'Verification code', true, 'string')
],
responses: {
'200': {
description: 'Config Relay verification code generated',
content: {
'application/json': {
schema: {
type: 'object',
properties: {
status: {
type: 'string',
description: 'Return verification status [verified/failed]'
}
}
}
}
}
}
}
}
},
'/config/spec/relay': {
get: {
tags: ['Config'],
Expand Down
12 changes: 12 additions & 0 deletions src/routers/config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -219,6 +219,18 @@ router.patch('/config/relay/verificationCode/:id', auth, [
}
});

router.patch('/config/relay/verify/:id', auth, [
check('id').isMongoId(),
query('code').isAscii()
], validate, async (req, res) => {
try {
const result = await Services.verifyRelay(req.params.id, req.query.code, req.admin);
res.send({ status: result });
} catch (e) {
responseException(res, e, 500);
}
});

router.get('/config/spec/relay', auth, (_req, res) => {
res.send(relayOptions());
});
Expand Down
20 changes: 15 additions & 5 deletions src/services/config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import mongoose from 'mongoose';
import { randomBytes } from 'crypto';
import { randomUUID } from 'crypto';
import { response } from './common';
import { Config } from '../models/config';
import { formatInput, verifyOwnership, checkEnvironmentStatusRemoval } from '../helpers';
Expand Down Expand Up @@ -265,12 +265,22 @@ export async function getRelayVerificationCode(id, admin) {
let config = await getConfigById(id);
config = await verifyOwnership(admin, config, config.domain, ActionTypes.UPDATE, RouterTypes.CONFIG);

const buffer = randomBytes(32);
const code = Buffer.from(buffer).toString('base64');

config.updatedBy = admin.email;
config.relay.verification_code = code;
config.relay.verification_code = randomUUID();
config.relay.verified = false;

return config.save();
}

export async function verifyRelay(id, code, admin) {
let config = await getConfigById(id);
config = await verifyOwnership(admin, config, config.domain, ActionTypes.UPDATE, RouterTypes.CONFIG);

if (!config.relay.verified && Object.is(config.relay.verification_code, code)) {
config.relay.verified = true;
await config.save();
return 'verified';
}

return 'failed';
}
65 changes: 64 additions & 1 deletion tests/config.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -987,13 +987,76 @@ describe('Testing relay association', () => {
expect(response.body.code).not.toBe(undefined);
});

test('CONFIG_SUITE - Should NOT generate verification code', async () => {
test('CONFIG_SUITE - Should NOT generate verification code - Config not found', async () => {
await request(app)
.patch(`/config/relay/verificationCode/${new mongoose.Types.ObjectId()}`)
.set('Authorization', `Bearer ${adminMasterAccountToken}`)
.send(bodyRelayProd).expect(404);
});

test('CONFIG_SUITE - Should verify code', async () => {
// Given
// Request verification code
let response = await request(app)
.patch(`/config/relay/verificationCode/${configId1}`)
.set('Authorization', `Bearer ${adminMasterAccountToken}`)
.send().expect(200);

// Test
response = await request(app)
.patch(`/config/relay/verify/${configId1}?code=${response.body.code}`)
.set('Authorization', `Bearer ${adminMasterAccountToken}`)
.send().expect(200);

expect(response.body.status).toBe('verified');
});

test('CONFIG_SUITE - Should NOT verify code - Config not found', async () => {
// Given
// Request verification code
const response = await request(app)
.patch(`/config/relay/verificationCode/${configId1}`)
.set('Authorization', `Bearer ${adminMasterAccountToken}`)
.send().expect(200);

// Test
await request(app)
.patch(`/config/relay/verify/${new mongoose.Types.ObjectId()}?code=${response.body.code}`)
.set('Authorization', `Bearer ${adminMasterAccountToken}`)
.send().expect(404);
});

test('CONFIG_SUITE - Should NOT verify code - Invalid code', async () => {
await request(app)
.patch(`/config/relay/verify/${configId1}?code=`)
.set('Authorization', `Bearer ${adminMasterAccountToken}`)
.send().expect(422);
});

test('CONFIG_SUITE - Should NOT verify code - Relay already verified', async () => {
// Given
// Request verification code
let response = await request(app)
.patch(`/config/relay/verificationCode/${configId1}`)
.set('Authorization', `Bearer ${adminMasterAccountToken}`)
.send().expect(200);

// That
// Is already verified
await request(app)
.patch(`/config/relay/verify/${configId1}?code=${response.body.code}`)
.set('Authorization', `Bearer ${adminMasterAccountToken}`)
.send().expect(200);

// Test
response = await request(app)
.patch(`/config/relay/verify/${configId1}?code=${response.body.code}`)
.set('Authorization', `Bearer ${adminMasterAccountToken}`)
.send().expect(200);

expect(response.body.status).toBe('failed');
});

});

describe('Testing disable metrics', () => {
Expand Down