hydra-client-wrapper

This library is a wrapper around the Ory Hydra client - @ory/client. It provides :

• OryOidcModule: a module to interact with the Ory Hydra Oidc (public) API
• OryOAuth2Module: a module to interact with the Ory Hydra OAuth2 (admin) API

Install

1npm install @getlarge/hydra-client-wrapper

Usage

Import the module in your app:

1import {
2  OryIdentitiesModule,
3  OryFrontendModule,
4} from '@getlarge/kratos-client-wrapper';
5import { Module } from '@nestjs/common';
6
7@Module({
8  imports: [
9    OryIdentitiesModule.forRoot({
10      basePath: 'http://localhost:4434',
11      accessToken: 'my-access-token',
12    }),
13    OryFrontendModule.forRootAsync({
14      useFactory: () => ({
15        baseUrl: 'http://localhost:4433',
16      }),
17    }),
18  ],
19})
20export class YourModule {}

Inject the service in your provider:

1import { OryOAuth2Service } from '@getlarge/hydra-client-wrapper';
2import { Injectable } from '@nestjs/common';
3
4@Injectable()
5export class YourService {
6  constructor(private readonly oryOAuth2Service: OryOAuth2Service) {}
7
8  async createClient(ownerId: string, scope = 'offline') {
9    return this.oryOAuth2Service.createOAuth2Client({
10      oAuth2Client: {
11        grant_types: ['client_credentials'],
12        access_token_strategy: 'opaque',
13        owner: ownerId,
14        scope,
15      },
16    });
17  }
18}

Use the Guard to protect your routes:

1import { OryOAuth2AuthenticationGuard } from '@getlarge/hydra-client-wrapper';
2import { Controller, Get, Logger, UseGuards } from '@nestjs/common';
3
4@Controller()
5export class YourController {
6  @UseGuards(
7    OryOAuth2AuthenticationGuard({
8      async postValidationHook(ctx, token) {
9        const req = ctx.switchToHttp().getRequest();
10        if (!token.client_id) {
11          throw new Error('Client ID not found in token');
12        }
13        const { data: client } = await this.oryService.getOAuth2Client({
14          id: token.client_id,
15        });
16        req.client = client;
17      },
18      accessTokenResolver: (ctx) =>
19        ctx
20          .switchToHttp()
21          .getRequest()
22          ?.headers?.authorization?.replace('Bearer ', ''),
23    })
24  )
25  @Get()
26  async get() {
27    return 'Hello World';
28  }
29}

Development

Building

Run nx build hydra-client-wrapper to build the library.

Running unit tests

Run nx test hydra-client-wrapper to execute the unit tests via Jest.