Don't Leave Your NestJS API Exposed

Don't Leave Your NestJS API Exposed

Sunny Sun lol
  2023-01-05 2023-01-05 00 Created   2023-03-09 19:41:05 2023-03-09 19:41 Updated    1.3k Words  8 Mins  

Using Reflect and the NestJS Undocumented API to Identify Unsecured Endpoints in Unit Tests

It is a given that an API should be secured to prevent potential attacks. However, it is surprising how often simple human mistakes can lead to an API endpoint being unprotected. A recent example of this is the Optus data breach , which was caused by “*an API that did not require authentication to access customer data.*”. This highlights the importance of thorough testing and strict security measures for APIs to prevent such incidents from occurring.

Unprotected API is one of the top OWASP vulnerabilities. It is defined as below:

Modern applications often involve rich client applications and APIs, such as JavaScript in the browser and mobile apps, that connect to an API of some kind. These APIs are often unprotected and contain numerous vulnerabilities.

To avoid unprotected API, the first line of defense is via unit test. In this article, we are going to discuss how to ensure NestJS controllers and Endpoints are protected using the Unit test.

Guards

In NestJS, we use authentication/authorization guards to protect controllers or endpoints. Using Guards, we can ensure only authorized users have access to the API. Below is an example of an authentication Guard.

@Injectable()
export class AuthGuard implements CanActivate {
  canActivate(
    context: ExecutionContext,
  ): boolean | Promise<boolean> | Observable<boolean> {
    const request = context.switchToHttp().getRequest();
    return this.validateRequest(request);
  }

  private validateRequest(request: any) {
    // Authenticate user request to ensure it is authenticated 
    // i.e. validate a token
  }
}

The AuthGuard class contains canActivate method which takes an ExecutionContext object as an argument. The method performs validation to determine whether the request should be allowed.

To apply the AuthGuard to a controller, we can use the @UseGuards decorator

@UseGuards(AuthGuard)
@Controller()
export class AppController {}

If the @UseGuards decorator is accidentally removed, the API will become unprotected and vulnerable to unauthorized access. To ensure that the Guard is properly applied to the controller, we can use unit tests to verify its presence.

To achieve that, we need to use the reflect-metadata library and NestJS undocumented DiscoveryService API. Let’s look at the reflect-metadata library first.

Reflect-MetaData

The reflect-metadata library provides support for the Reflect API, which is part of the ECMAScript specification. We can use it to get metadata at runtime. It is worth noting that NestJS also uses the reflect-metadata under the hood to work with metadata.

The below example demonstrates how to retrieve the Guards metadata from the AppController.

const guards = Reflect.getMetadata('__guards__', AppController);

The getMetaData method takes two arguments:

  • metadataKey: A key used to store and retrieve metadata. In this case, the key is guards, it is used by NestJs to reference the Guards.

  • target: The target object on which the metadata is defined.

with getMetadata method, we can write a simple Unit test to verify the AppController is protected.

   it('should AuthGard be applied to the AppController', async () => {
      const guards = Reflect.getMetadata('__guards__', AppController);
      const guard = new guards[0]();
      expect(guard).toBeInstanceOf(AuthGuard);
    });

If there are multiple controllers in the app, it is possible to write a unit test that covers all of them at once? The answer is positive, but we need to use the NestJS Discovery Service.

Discovery Service

The NestJS discovery service is an undocumented public API. It is important to note that an “undocumented” feature may be subject to change or breakage in the future. While it is a handy feature to use, it is generally best to avoid relying on undocumented features in your app. In my personal opinion, using it in unit test is acceptable as long as you are aware of the risk.

As shown below, using this.discoveryService.getControllers(), we can get a collection of type InstanceWrapper = { metatype, name, instance, … }.

 const controllers = await discoveryService.getControllers({});

To extract the guards metadata from the InstanceWrapper, we can use the getEnhancersMetadata method. In the test below, we loop through each controller and verify that they are protected by the AuthGuard.

    it('should have AuthGard applied for all controllers', async () => {
      const controllers = await discoveryService.getControllers({});
      controllers.map((c) => {
        const guard = c
          .getEnhancersMetadata()
          ?.filter(
            ({ instance }: InstanceWrapper) => instance instanceof AuthGuard,
          );
        expect(guard[0].name).toEqual('AuthGuard');
      });
    });

To achieve a fine level of access control, we can define a RoleGuard and apply it to individual endpoints. We use SetMetadata in the function below to assign metadata with a specific key. SetMetadata is an out-of-box NestJS decorator function.

import { SetMetadata } from '@nestjs/common';

export const Roles = (...roles: string[]) => SetMetadata('roles', roles);

To apply a Roles decorator to an endpoint, we need to pass in a role to the decorator

  @Get()
  @Roles('Admin')
  getAll() {
    return [];
  }

Secure an Endpoint

To detect whether an endpoint is associated with the Roles decorator, we use the getMetadata as below.

      const decorators = Reflect.getMetadata(
        'roles',
        DevController.prototype.getAll,
      );

In a unit test, we can verify whether an endpoint is protected by the roles decorator with a role

    it('should getAll be accessible by Admin role only', () => {
      const decorators = Reflect.getMetadata(
        'roles',
        DevController.prototype.getAll,
      );
      expect(decorators).toContain('Admin');
    });

The Reflect API can be used to get other metadata of the endPoint.

  it('should getHello has correct path and http method', () => {
    const path = Reflect.getMetadata('path', appController.getHello);
    expect(path).toBe('/');
    const method = Reflect.getMetadata('method', appController.getHello);
    expect(method).toBe(RequestMethod.GET);
  });

In this above usage of getMetaData, the keys being used are ‘path’ and ‘method’, which corresponds to the path and HTTP method of the getHello method, respectively.

Bonus Content: Use Discovery Service to dynamically get a list of Services

Discovery service can be a graceful solution to certain problems. For example, in one of my recent NestJS projects, there is a MapperResolver class:

@Injectable()
export class MapperResolver {
  private mapperList: IMapper[];

  constructor(
    private serviceAMapper: ServiceAMapper,
    private serviceBMapper: ServiceBMapper,
    private serviceCMapper: ServiceCMapper,
    private serviceDMapper: ServiceDMapper,
  ) {
    this.mapperList= [
      serviceAMapper,
      serviceBMapper,
      serviceCMapper,
      serviceDMapper
    ];
  }
  public Resolve(serviceType: string):IMapper {
    const mapper = this.mapperList.find(c => c.serviceType=== serviceType);
    if (mapper) {
      return mapper;
    }
    throw new Error(`No Mapper found`);
  }

In the real-world project, there are more than 10 Mapper classes injected into the MapperResolver class constructor, this number continues to grow as new features are added. This has become a maintenance issue.

We can use Discovery Service to solve this problem. As this topic is outside the scope of this article, I will only give a brief description of the solution.

  • create a decorator @ServiceRegister that takes an argument

  • add the decorator to each Mapper class i.e. @ServiceRegister(‘Mapper’)

  • use discoveryService.getProviders() to retrieve all providers and filter out the mapper services using the metadata.

The end result is that we are able to remove all the injected Mapper services in the MapperResolver class. But again, please be careful in using DiscoveryService as it is an undocumented API.

Summary

It’s important to regularly test and monitor the security of your application to ensure that it is secure and reliable. By embedding the security checking into Unit tests, and regularly running these tests, we can catch any issues and fix them before they cause problems in production.

Happy programming!

More content at **PlainEnglish.io . Sign up for our **free weekly newsletter . Follow us on **Twitter **, ***LinkedIn , **YouTube , and **Discord .***

Interested in scaling your software startup? Check out **Circuit .

On this page
Don't Leave Your NestJS API Exposed
  1. Using Reflect and the NestJS Undocumented API to Identify Unsecured Endpoints in Unit Tests
    1. Guards
    2. Reflect-MetaData
    3. Discovery Service
    4. Secure an Endpoint
    5. Bonus Content: Use Discovery Service to dynamically get a list of Services
    6. Summary