signed-graphql v0.2.0

signed-graphql

A cli tool to make GraphQL secure. Make plain query into JWT signed query.

Why

GraphQL is a great tool, but the query is open to public by default. Of course, we should set GraphQL server secure by server-side logic. However, we may not confortable if someone find a security hole and query it.

With signed-graphql, we can verify that our queries is made by specific people, and accept only signed queries.

Install

npm install --save-dev signed-graphql

or if you use yarn:

yarn add -D signed-graphql

Usage

Step 1. Write GraphQL as usual

Assume example-query.js looks like this:

export const getUsers = gql`
  query getUsers {
    id
    name
  }
`

Step 2. Sign GraphQL on build time

Run the following command to sign the graphql queries:

npm run signed-graphql --write --secret foo example-query.js

Note: --secret is required args. Please keep it secret.

Step 3. Verify your queries on runtime

On the server side, verify the query. Node.js (express) example:

const { verify } = require('jsonwebtoken')

// assuming
// req.body.query = 'eyJhbGciOiJIUzI1NiJ9.CiAgcXVlcnkgZ2V0VXNlcnMgewogICAgbmFtZQogICAgZW1haWwKICB9Cg.GRFoVNHpY12mX0UI1y_nCRwGqKST4UkAbx88hZ2Jccg'

app.post('/graphql', (req, res) => {
  const query = verify(req.body.query, 'foo')
  // => '\n  query getUsers {\n    name\n    email\n  }\n'
})

Comparison with Persisted Queries

There is a GraphQL technich called "Persisted Queries". The idea is to create pairs of a hash and a GraphQL query. The main purpose is to improve performance, because hashed string (32-64) is smaller than the actual GraphQL string.

The downside of persisted queries are the lack of flexibility. It requires server side to know the pair of hash/query ahead of time before.

On the other hand, signed-graphql keeps flexibility of front-end and server-side. Since JWT is stateless, we don't have to save anything (other than the JWT secret).

The downside of signed-graphql is performance. You need to verify JWT on every request, which means there is some additional cost on the runtime.

Referenece:

• https://mercurius.dev/#/docs/persisted-queries
• https://www.apollographql.com/docs/apollo-server/performance/apq/

Thanks

Oridinally inspired by: https://itnext.io/graphql-data-hiding-using-apollo-stack-ad1ea92fa85c

TODO

• add unit test
• show console help
• convert to plain for debug/convenience