Authorization middleware for graphql-serverless. Add inline authorization straight into your GraphQl schema.
Authorization middleware for graphql-serverless. Add inline authorization straight into the GraphQl schema to restrict access to certain fields based on the user’s rights. graphql-serverless allows to deploy GraphQL apis (including an optional GraphiQL interface) to the most popular serverless platforms:
Decorate your fields with something similar to this in your GraphQl schema:
type Product {
id: ID!
@auth
name: String!
shortDescription: String
}
Then define a rule similar to this one:
{
authenticationFields: field => field.metadata && field.metadata.name == 'auth'
}
If the user is not authenticated (more about this below), then a GraphQl query similar to this:
{
products(id:2) {
id
name
}
}
will return an HTTP response with status 200 similar to this:
{
"data": {
"products": [
{
"id": "2"
}
]
},
"warnings": [
{
"message": "Access denied for certain fields. The current response is incomplete.",
"path": [
"products.name"
]
}
]
}
TIP - It is also possible to configure the middleware to nullify the
name
field rather than omitting it (refer to section Returningnull
Rather Than Removing Fields). This is usually rather important client libraries using caching like the apollo-client which would break otherwise.
npm install graphql-authorize --save
An example will worth a thousand words. Follow those steps:
npm init
npm install graphql-s2s graphql-serverless graphql-authorize webfunc lodash --save
Create a new index.js
as follow:
const graphqlAuth = require('graphql-authorize')
const { getSchemaAST, transpileSchema } = require('graphql-s2s').graphqls2s
const { graphqlHandler } = require('graphql-serverless')
const { app } = require('webfunc')
const { makeExecutableSchema } = require('graphql-tools')
const _ = require('lodash')
// STEP 1. Mock some data for this demo.
const productMocks = [
{ id: 1, name: 'Product A', shortDescription: 'First product.', owner: 'Marc Stratfield' },
{ id: 2, name: 'Product B', shortDescription: 'Second product.', owner: 'Nic Dao' }]
const variantMocks = [
{ id: 1, name: 'Variant A', shortDescription: 'First variant.' },
{ id: 2, name: 'Variant B', shortDescription: 'Second variant.' }]
// STEP 2. Creating a basic GraphQl Schema augmented with some non-standard authorizaion metadata
// thanks to the 'graphql-s2s' package (https://github.com/nicolasdao/graphql-s2s).
const schema = `
type Product {
id: ID!
@auth
name: String!
shortDescription: String
owner: String
}
type Variant {
id: ID!
name: String!
shortDescription: String
}
type Query {
products(id: Int): [Product]
variants(id: Int): [Variant]
}
`
const productResolver = {
Query: {
products(root, { id }, context) {
const results = id ? productMocks.filter(p => p.id == id) : productMocks
if (results.length > 0)
return results
else
throw new Error(`Product with id ${id} does not exist.`)
}
}
}
const variantResolver = {
Query: {
variants(root, { id }, context) {
const results = id ? variantMocks.filter(p => p.id == id) : variantMocks
if (results.length > 0)
return results
else
throw new Error(`Variant with id ${id} does not exist.`)
}
}
}
// STEP 3. Transpiling our schema on steroid to a standard schema using the 'transpileSchema'
// function from the 'graphql-s2s' package (https://github.com/nicolasdao/graphql-s2s).
const executableSchema = makeExecutableSchema({
typeDefs: transpileSchema(schema),
resolvers: _.merge(productResolver, variantResolver)
})
// STEP 4. Creating the Express-like middleware that will define the authorization rules that will give
// access or not to certain fields.
const schemaAST = getSchemaAST(schema)
const authorize = graphqlAuth(
// AST of the Graphql schema augmented with metadata
schemaAST,
// Function that must terminate by a call to the 'next' callback with 2 required arguments:
// @param {Object} err Potential error object useful for identifying the source of the
// authentication failure.
// @param {Object} user If this object exists, then the authentication based on data contained
// in the 'req' object is successfull, otherwise it is not.
(req, res, next) => {
// This example below simulates a situation where all request will always be
// unauthenticated.
const err = null
const user = null
next(err, user)
},
// Defines the authentication rules, i.e. the rule on each field that determines
// whether that field requires authentication.
{
authenticationFields: field => field.metadata && field.metadata.name.indexOf('auth') == 0
})
// STEP 5. Creating a GraphQL and a GraphiQl endpoint
const graphqlOptions = {
schema: executableSchema,
graphiql: {
endpoint: '/graphiql'
}
}
app.all(['/', '/graphiql'], authorize, graphqlHandler(graphqlOptions))
// STEP 5. Starting the server
app.listen(4000)
Run node index.js
http://localhost:4000/graphiql
Execute a query similar to this in graphiql:
{
products(id:2) {
id
name
}
}
Because we’ve hardcoded that all requests are unauthenticated (ref. STEP 4. user = null
), this request above will yield the following result HTTP 200 response:
{
"data": {
"products": [
{
"id": "2"
}
]
},
"warnings": [
{
"message": "Access denied for certain fields. The current response is incomplete.",
"path": [
"products.name"
]
}
]
}
NOTICE that you’re not forced to use the metadata
@auth
to defined what field is restricted to authenticated user. You can do what ever you want. We just thought it made sense based on our own experience.TIP - It is also possible to configure the middleware to nullify the
name
field rather than omitting it (refer to section Returningnull
Rather Than Removing Fields). This is usually rather important client libraries using caching like the apollo-client which would break otherwise.
In the previous example, we introduced how to restrict access to unauthenticated users. Now we’ll see how we can restrict access based on roles of authenticated users.
In STEP 2, updates the schema as follow:
type Product {
id: ID!
@auth
name: String!
shortDescription: String
@auth(admin)
owner: String
}
In STEP 4, update the code as follow:
const authorize = graphqlAuth(
schemaAST,
(req, res, next) => {
const err = null
const user = { role: 'standard' }
next(err, user)
},
{
authenticationFields: field => field.metadata && field.metadata.name.indexOf('auth') == 0,
authorizationFields: (field, user) =>
field.metadata &&
((field.metadata.name == 'auth' && !field.metadata.body) || field.metadata.name == 'auth' && field.metadata.body == `(${user.role})`)
})
The code above restricts the access to the Product.owner
field to user with an admin
role. For the sake of this demo, all requests are now being hardcoded so that the user is authenticated (i.e. the user
object exists) and its role is standard
.
The following request:
{
products(id:2) {
id
name
owner
}
}
will now return:
{
"data": {
"products": [
{
"id": "2",
"name": "Product B"
}
]
},
"warnings": [
{
"message": "Access denied for certain fields. The current response is incomplete.",
"path": [
"products.owner"
]
}
]
}
As you can see, now that the request is authenticated, the name
field is accessible, but because the user’s role is standard
rather tha admin, the owner
property is not accessible.
Update the role above to admin
and see what happens.
null
Rather Than Removing FieldsThe previous examples have demonstrated fields not being returned when the request is either not authenticated or lacking the adequate rights. However, this behavior might break some client libraries like the apollo-client which expect the schema of the response to conform to the request schema. To allow support for such use cases, it is possible to nullify fields rather than removing them, thanks to the nullifyUnauthorizedFields
property:
const authorize = graphqlAuth(
schemaAST,
(req, res, next) => {
const err = null
const user = { role: 'standard' }
next(err, user)
},
{
authenticationFields: field => field.metadata && field.metadata.name.indexOf('auth') == 0,
authorizationFields: (field, user) =>
field.metadata &&
((field.metadata.name == 'auth' && !field.metadata.body) || field.metadata.name == 'auth' && field.metadata.body == `(${user.role})`),
nullifyUnauthorizedFields: true
})
So far, all previous examples have demonstrated partial response being returned in case of missing authentication or missing rights. However, one other desired behavior could to fail completely with an HTTP 403 forbidden. This can be done using the partialAccess
property.
const authorize = graphqlAuth(
schemaAST,
(req, res, next) => {
const err = null
const user = { role: 'standard' }
next(err, user)
},
{
authenticationFields: field => field.metadata && field.metadata.name.indexOf('auth') == 0,
authorizationFields: (field, user) =>
field.metadata &&
((field.metadata.name == 'auth' && !field.metadata.body) || field.metadata.name == 'auth' && field.metadata.body == `(${user.role})`),
nullifyUnauthorizedFields: true,
partialAccess: false
})
We are Neap, an Australian Technology consultancy powering the startup ecosystem in Sydney. We simply love building Tech and also meeting new people, so don’t hesitate to connect with us at https://neap.co.
Our other open-sourced projects:
Copyright (c) 2018, Neap Pty Ltd.
All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL NEAP PTY LTD BE LIABLE FOR ANY
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.