Skip to content

Experimental: graphql armor #528

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

Draft
mnaamani wants to merge 2 commits into
base: update-nodejs
Choose a base branch
from
Draft

Experimental: graphql armor #528

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
0196bf8
feat(wip): wip
mnaamani Sep 20, 2023
b9f61e3
Merge branch 'update-nodejs' into graphql-armor
mnaamani Sep 20, 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
60 changes: 53 additions & 7 deletions packages/hydra-cli/src/templates/graphql-server/src/index.ts.mst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ import { buildServerSchema, getServer } from './server';
import { queryTemplates } from './queryTemplates';
import { createProcessorStateApp } from './processorStateApp';

import { EnvelopArmor } from "@escape.tech/graphql-armor";

class CustomNamingStrategy extends SnakeNamingStrategy {
constructor() {
super();
Expand All @@ -20,9 +22,44 @@ class CustomNamingStrategy extends SnakeNamingStrategy {
}
}

async function bootstrap() {
function getArmorConfig() {
if (process.env.GRAPHQL_ENABLE_PROTECTION === 'true') {
const armor = new EnvelopArmor({
blockFieldSuggestion: {
enabled: false,
},
maxDepth: {
enabled: true,
n: 3,
},
maxAliases: {
enabled: true,
n: 5,
},
//characterLimit: {
// enabled: true,
// maxLength: 1000,
//},
maxDirectives: {
enabled: true,
n: 0,
},
});

const config = armor.protect();
const { plugins } = config;
Logger.info(`Enabling GraphQL Armor with ${plugins.length} plugins.`);
return config
} else {
return {};
}
}

function prepareServer() {
loadConfig();

const armor = getArmorConfig();

const server = getServer(
{
playgroundConfig: {
Expand All @@ -32,28 +69,37 @@ async function bootstrap() {
subscriptionEndpoint: process.env.GRAPHQL_PLAYGROUND_SUBSCRIPTION_ENDPOINT || undefined,
queryTemplates,
},
...armor,
},
{
namingStrategy: new CustomNamingStrategy(),
maxQueryExecutionTime: 1000,
logging: [process.env.WARTHOG_DB_LOGGING || 'error'],
extra: {
poolSize: 10,
//cache: {
//
//}
},
}
);

// Create database tables. Warthog migrate command does not support CustomNamingStrategy thats why
// we have this code
return server;
}

async function bootstrap() {
const server = prepareServer();

const syncDatabase: string | undefined = process.env.SYNC;
if (syncDatabase === 'true') {
await server.establishDBConnection();
process.exit(0);
}

await buildServerSchema(server);
await server.start();
const processorStateApp = createProcessorStateApp(process.env.PROCESSOR_HOST || 'localhost');
await processorStateApp.listen(
parseInt(process.env.PROCESSOR_STATE_APP_PORT || '8082'),
'0.0.0.0'
);
processorStateApp.listen(parseInt(process.env.PROCESSOR_STATE_APP_PORT || '8082'), '0.0.0.0');
}

bootstrap().catch((error: Error) => {
Expand Down
3 changes: 2 additions & 1 deletion packages/hydra-cli/src/templates/scaffold/package.json.mst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,8 @@
"dependencies": {
"tslib": "^2.0.0",
"@types/bn.js": "^5.1.0",
"bn.js": "^5.1.2"
"bn.js": "^5.1.2",
"@escape.tech/graphql-armor": "^2.3.1"
},
"devDependencies": {
"@joystream/hydra-cli": "{{{hydraVersion}}}",
Expand Down