Skip to content
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.

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

[Job Launcher] Decrypt file after downloading #1328

Merged
merged 3 commits into from
Jan 18, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
5 changes: 5 additions & 0 deletions packages/apps/job-launcher/server/src/common/config/env.ts
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,8 @@ export const ConfigNames = {
APIKEY_ITERATIONS: 'APIKEY_ITERATIONS',
APIKEY_KEY_LENGTH: 'APIKEY_KEY_LENGTH',
POSTGRES_LOGGING: 'POSTGRES_LOGGING',
ENCRYPTION_PRIVATE_KEY: 'ENCRYPTION_PRIVATE_KEY',
ENCRYPTION_PASSPHRASE: 'ENCRYPTION_PASSPHRASE',
};

export const envValidator = Joi.object({
Expand Down Expand Up @@ -115,4 +117,7 @@ export const envValidator = Joi.object({
// APIKey
APIKEY_ITERATIONS: Joi.number().default(1000),
APIKEY_KEY_LENGTH: Joi.number().default(64),
// Encryption
ENCRYPTION_PRIVATE_KEY: Joi.string().default(''),
ENCRYPTION_PASSPHRASE: Joi.string().default(''),
});
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
import { ChainId, StorageClient } from '@human-protocol/sdk';
import { ConfigModule, registerAs } from '@nestjs/config';
import { Encryption, StorageClient } from '@human-protocol/sdk';
import { ConfigModule, ConfigService, registerAs } from '@nestjs/config';
import { Test } from '@nestjs/testing';
import {
MOCK_ENCRYPTION_PASSPHRASE,
MOCK_ENCRYPTION_PRIVATE_KEY,
MOCK_FILE_URL,
MOCK_MANIFEST,
MOCK_S3_ACCESS_KEY,
Expand All @@ -21,6 +23,9 @@ jest.mock('@human-protocol/sdk', () => ({
StorageClient: {
downloadFileFromUrl: jest.fn(),
},
Encryption: {
build: jest.fn(),
},
}));

jest.mock('minio', () => {
Expand All @@ -39,10 +44,21 @@ jest.mock('minio', () => {

jest.mock('axios');

describe('Web3Service', () => {
describe('StorageService', () => {
let storageService: StorageService;

beforeAll(async () => {
const mockConfigService: Partial<ConfigService> = {
get: jest.fn((key: string) => {
switch (key) {
case 'ENCRYPTION_PRIVATE_KEY':
return MOCK_ENCRYPTION_PRIVATE_KEY;
case 'ENCRYPTION_PASSPHRASE':
return MOCK_ENCRYPTION_PASSPHRASE;
}
}),
};

const moduleRef = await Test.createTestingModule({
imports: [
ConfigModule.forFeature(
Expand All @@ -56,7 +72,10 @@ describe('Web3Service', () => {
})),
),
],
providers: [StorageService],
providers: [
StorageService,
{ provide: ConfigService, useValue: mockConfigService },
],
}).compile();

storageService = moduleRef.get<StorageService>(StorageService);
Expand Down Expand Up @@ -134,9 +153,36 @@ describe('Web3Service', () => {

StorageClient.downloadFileFromUrl = jest
.fn()
.mockResolvedValueOnce(expectedJobFile);
.mockResolvedValueOnce(JSON.stringify(expectedJobFile));
const solutionsFile = await storageService.download(MOCK_FILE_URL);
expect(solutionsFile).toStrictEqual(expectedJobFile);
});

it('should download the encrypted file correctly', async () => {
const exchangeAddress = '0x1234567890123456789012345678901234567892';
const workerAddress = '0x1234567890123456789012345678901234567891';
const solution = 'test';

const expectedJobFile = {
exchangeAddress,
solutions: [
{
workerAddress,
solution,
},
],
};

StorageClient.downloadFileFromUrl = jest
.fn()
.mockResolvedValueOnce('encrypted');
Encryption.build = jest.fn().mockResolvedValueOnce({
decrypt: jest
.fn()
.mockResolvedValueOnce(JSON.stringify(expectedJobFile)),
});
const solutionsFile = await storageService.download(MOCK_FILE_URL);
expect(solutionsFile).toBe(expectedJobFile);
expect(solutionsFile).toStrictEqual(expectedJobFile);
});

it('should return empty array when file cannot be downloaded', async () => {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,14 +1,15 @@
import { ChainId, StorageClient } from '@human-protocol/sdk';
import { Encryption, StorageClient } from '@human-protocol/sdk';
import { BadRequestException, Inject, Injectable } from '@nestjs/common';
import * as Minio from 'minio';
import { S3ConfigType, s3ConfigKey } from '../../common/config';
import { ConfigNames, S3ConfigType, s3ConfigKey } from '../../common/config';
import crypto from 'crypto';
import { UploadedFile } from '../../common/interfaces/s3';
import { PassThrough } from 'stream';
import axios from 'axios';
import { Logger } from '@nestjs/common';
import { hashStream } from '../../common/utils';
import { CvatManifestDto, FortuneManifestDto } from '../job/job.dto';
import { ConfigService } from '@nestjs/config';

@Injectable()
export class StorageService {
Expand All @@ -17,6 +18,7 @@ export class StorageService {
constructor(
@Inject(s3ConfigKey)
private s3Config: S3ConfigType,
public readonly configService: ConfigService,
) {
this.minioClient = new Minio.Client({
endPoint: this.s3Config.endPoint,
Expand All @@ -34,7 +36,20 @@ export class StorageService {

public async download(url: string): Promise<any> {
try {
return await StorageClient.downloadFileFromUrl(url);
const fileContent = await StorageClient.downloadFileFromUrl(url);
try {
return JSON.parse(fileContent);
} catch {
const encryption = await Encryption.build(
this.configService.get<string>(
ConfigNames.ENCRYPTION_PRIVATE_KEY,
'',
),
this.configService.get<string>(ConfigNames.ENCRYPTION_PASSPHRASE, ''),
);

return JSON.parse(await encryption.decrypt(fileContent));
}
} catch {
return [];
}
Expand Down
7 changes: 5 additions & 2 deletions packages/apps/job-launcher/server/test/constants.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { JobRequestType } from "../src/common/enums/job";
import { FortuneManifestDto } from "../src/modules/job/job.dto";
import { JobRequestType } from '../src/common/enums/job';
import { FortuneManifestDto } from '../src/modules/job/job.dto';

export const MOCK_REQUESTER_TITLE = 'Mock job title';
export const MOCK_REQUESTER_DESCRIPTION = 'Mock job description';
Expand Down Expand Up @@ -65,3 +65,6 @@ export const MOCK_MANIFEST: FortuneManifestDto = {
fundAmount: 10,
requestType: JobRequestType.FORTUNE,
};

export const MOCK_ENCRYPTION_PRIVATE_KEY = 'private_key';
export const MOCK_ENCRYPTION_PASSPHRASE = 'passphrase';