GraphQL security best practices - Mini Project: Build & Apply

GraphQL Security Best Practices

📖 Scenario: You are building a GraphQL API for a small online bookstore. You want to make sure your API is secure and protects sensitive data while allowing users to query book information safely.

🎯 Goal: Build a simple GraphQL schema with security best practices such as limiting query depth, validating inputs, and restricting access to sensitive fields.

📋 What You'll Learn

Create a GraphQL schema with types for Book and Query

Add a query called books that returns a list of Book

Add a configuration variable MAX_QUERY_DEPTH set to 3

Implement a query depth validation rule using MAX_QUERY_DEPTH

Add a field secretNote to Book that is only accessible to authenticated users

Add input validation for a search argument in the books query

💡 Why This Matters

🌍 Real World

GraphQL APIs are widely used in web and mobile apps. Securing them protects user data and prevents attacks like denial of service.

💼 Career

Understanding GraphQL security best practices is important for backend developers, API engineers, and security specialists working with modern APIs.

1

Create the GraphQL schema with Book and Query types

Create a GraphQL schema with a Book type that has fields id (ID!), title (String!), and author (String!). Also create a Query type with a books field that returns a list of Book.

GraphQL

type Book {
  id: ID!
  title: String!
  author: String!
}

type Query {
  books: [Book]
}

# Your code here

Hint

Define the Book type with the required fields and the Query type with a books field returning a list of Book.

2

Add a configuration variable for max query depth

Add a configuration variable called MAX_QUERY_DEPTH and set it to 3 to limit the depth of GraphQL queries.

GraphQL

type Book {
  id: ID!
  title: String!
  author: String!
}

type Query {
  books: [Book]
}

const MAX_QUERY_DEPTH = 3
# Your code here

Hint

Define a constant MAX_QUERY_DEPTH and assign it the value 3.

3

Implement query depth validation using MAX_QUERY_DEPTH

Add a query depth validation rule that uses the MAX_QUERY_DEPTH variable to reject queries deeper than 3 levels.

GraphQL

type Book {
  id: ID!
  title: String!
  author: String!
}

type Query {
  books: [Book]
}

const MAX_QUERY_DEPTH = 3

// Add query depth validation rule here
# Your code here

Hint

Use a library like graphql-depth-limit and create a validation rule array using MAX_QUERY_DEPTH.

4

Add secretNote field with access control and input validation

Add a secretNote field to the Book type that returns a String. This field should only be accessible if the user is authenticated. Also, add a search argument of type String to the books query and validate that it is not longer than 20 characters.

GraphQL

type Book {
  id: ID!
  title: String!
  author: String!
  secretNote: String
}

type Query {
  books(search: String): [Book]
}

const MAX_QUERY_DEPTH = 3

const depthLimitRule = require('graphql-depth-limit');

const validationRules = [depthLimitRule(MAX_QUERY_DEPTH)];

// Add resolver logic to check authentication and validate search input
# Your code here

Hint

Add the secretNote field to the Book type and the search argument to the books query. Implement resolver logic to check if the user is authenticated before returning secretNote and validate the length of search.

Practice

1. What is the main purpose of authentication in GraphQL security?

easy

A. To encrypt the data sent between client and server

B. To limit the number of queries a user can make

C. To verify the identity of the user making the request

D. To format the GraphQL schema correctly

Solution

1. Step 1: Understand authentication role

   Authentication checks who the user is before allowing access.

2. Step 2: Differentiate from other security measures

   Limiting queries and encryption are different security aspects, not authentication.

3. Final Answer:

   To verify the identity of the user making the request -> Option C

4. Quick Check:

   Authentication = Verify user identity [OK]

Hint: Authentication means checking who you are [OK]

Common Mistakes:

• Confusing authentication with authorization
• Thinking authentication limits query size
• Mixing authentication with encryption

2. Which of the following is the correct way to limit query complexity in a GraphQL server?

easy

A. Allow unlimited queries and rely on client honesty

B. Use SQL injection to filter queries

C. Disable authentication to speed up queries

D. Use a middleware that calculates query depth and rejects too deep queries

Solution

1. Step 1: Identify query complexity control

   Middleware can analyze query depth and reject overly complex queries to protect the server.

2. Step 2: Eliminate incorrect options

   Allowing unlimited queries or disabling authentication weakens security; SQL injection is an attack, not a defense.

3. Final Answer:

   Use a middleware that calculates query depth and rejects too deep queries -> Option D

4. Quick Check:

   Limit query complexity = Middleware checks depth [OK]

Hint: Middleware can block too complex queries [OK]

Common Mistakes:

• Ignoring query complexity limits
• Confusing SQL injection with security measure
• Disabling authentication to improve speed

3. Given this GraphQL resolver snippet, what will happen if a user without proper role tries to access the data?

const resolver = (parent, args, context) => {
  if (!context.user.roles.includes('admin')) {
    throw new Error('Access denied');
  }
  return getData();
};

medium

A. An error 'Access denied' will be thrown for non-admin users

B. The data will be returned regardless of user role

C. The server will crash due to missing roles

D. The resolver will ignore the role check and return null

Solution

1. Step 1: Analyze role check in resolver

   The code checks if the user roles include 'admin'. If not, it throws an error.

2. Step 2: Understand error handling

   Throwing an error stops execution and returns 'Access denied' to the client.

3. Final Answer:

   An error 'Access denied' will be thrown for non-admin users -> Option A

4. Quick Check:

   Role check fails = Error thrown [OK]

Hint: Throw error if user lacks role [OK]

Common Mistakes:

• Assuming data returns without role check
• Thinking server crashes on missing role
• Believing null is returned instead of error

4. Identify the security issue in this GraphQL server setup:

const server = new ApolloServer({
  typeDefs,
  resolvers,
  context: ({ req }) => ({ user: req.user })
});

// No rate limiting or query complexity checks applied

medium

A. Missing authentication in context setup

B. No rate limiting or query complexity protection

C. Resolvers are not defined

D. Using ApolloServer is insecure

Solution

1. Step 1: Review context and security features

   Context passes user info, so authentication may exist, but no rate limiting or complexity checks are shown.

2. Step 2: Identify missing protections

   Without rate limiting and query complexity checks, server is vulnerable to overload and abuse.

3. Final Answer:

   No rate limiting or query complexity protection -> Option B

4. Quick Check:

   Missing limits = Vulnerable server [OK]

Hint: Always add rate limits and complexity checks [OK]

Common Mistakes:

• Assuming ApolloServer is insecure by default
• Confusing missing resolvers with security issue
• Ignoring rate limiting importance

5. You want to protect your GraphQL API from abuse by limiting both query complexity and request rate. Which combination of methods is best practice?

hard

A. Implement query depth analysis middleware and use a rate limiter like Redis to track requests

B. Only use authentication tokens without any query or rate limits

C. Disable introspection to prevent all queries

D. Allow unlimited queries but log all requests for later review

Solution

1. Step 1: Understand query complexity protection

   Middleware that analyzes query depth helps prevent expensive queries that overload the server.

2. Step 2: Understand rate limiting

   Using a rate limiter like Redis tracks and limits how many requests a user can make in a time window.

3. Step 3: Evaluate other options

   Authentication alone doesn't limit abuse; disabling introspection breaks development; logging alone doesn't prevent abuse.

4. Final Answer:

   Implement query depth analysis middleware and use a rate limiter like Redis to track requests -> Option A

5. Quick Check:

   Combine depth check + rate limiter = Best protection [OK]

Hint: Use middleware plus rate limiter for best security [OK]

Common Mistakes:

• Relying only on authentication
• Disabling introspection breaks tools
• Logging without limiting requests