Github

Implement github authentication in your NestJS application.

Prerequisites#

The library requires you to install few peer dependencies

npm install @nestjs/passport passport reflect-metadata --save

yarn add @nestjs/passport passport reflect-metadata

Install#

npm install @nestjs-hybrid-auth/github --save

yarn add @nestjs-hybrid-auth/github

How To Use?#

The package exports mainly a dynamic module and guard. The module should be imported in your app.module.ts and guards should be used on the route handlers of any controller.

Example Code For app.module.ts#

Simple static configuration#

Want to jump directly to the available options?

If you just want to provide the static values or have them handy, pass them as options to the forRoot static method like below. The options object is type of GithubAuthModuleOptions.

import { GithubAuthModule } from '@nestjs-hybrid-auth/github';
@Module({  imports: [    GithubAuthModule.forRoot({      clientID: process.env.CLIENT_ID,      clientSecret: process.env.CLIENT_SECRET,      callbackURL: process.env.CALLBACK_URL,    }),  ],  controllers: [AppController],  providers: [AppService],})export class AppModule {}

`useFactory` to get the ConfigService injected.#

If you want to make use of nest's ConfigModule to get the auth configuration for a provider from .env config files, use forRootAsync static method. The options to this method are typeof GithubAuthModuleAsyncOptions which accepts a useFactory property. useFactory is a function which gets the instances injected whatever has been provided in inject array. You can use those instances to prepare and return the actual GithubAuthModuleOptions object. ConfigService can be one of them as per your choice.

import { GithubAuthModule } from '@nestjs-hybrid-auth/github';
@Module({  imports: [    ConfigModule.forRoot({      isGlobal: true,      cache: true,      expandVariables: true,    }),    GithubAuthModule.forRootAsync({      imports: [ConfigModule],      inject: [ConfigService],      useFactory: (configService: ConfigService) => ({        clientID: configService.get('GITHUB_CLIENT_ID'),        clientSecret: configService.get('GITHUB_CLIENT_SECRET'),        callbackURL: configService.get('GITHUB_CALLBACK_URL'),      }),    }),  ],  controllers: [AppController],  providers: [AppService],})export class AppModule {}

Use `useClass` to get your auth config from a class#

If the useFactory makes your app module bloated with a lot of boilerplate code, you can useClass to provide an existing config provider class. The class must implement GithubAuthModuleOptionsFactory interface and createModuleOptions method. This method should return GithubAuthModuleOptions object. Similar to useFactory, whatever you provide in inject array, it will get injected in the constructor of your class. Follow the example:

hybrid-auth.config.ts

import { ConfigService } from '@nestjs/config';import {  GithubAuthModuleOptions,  GithubAuthModuleOptionsFactory,} from '@nestjs-hybrid-auth/github';
@Injectable()class GithubAuthConfig implements GithubAuthModuleOptionsFactory {  constructor(private configService: ConfigService) {}
  createModuleOptions(): GithubAuthModuleOptions {    return {      clientKey: this.configService.get('GITHUB_CLIENT_ID'),      clientSecret: this.configService.get('GITHUB_CLIENT_SECRET'),      callbackURL: this.configService.get('GITHUB_CALLBACK_URL'),    };  }}

app.module.ts

import { GithubAuthModule } from '@nestjs-hybrid-auth/github';
@Module({  imports: [    ConfigModule.forRoot({      isGlobal: true,      cache: true,      expandVariables: true,    }),    GithubAuthModule.forRootAsync({      imports: [ConfigModule],      inject: [ConfigService],      useClass: GithubAuthConfig,    }),  ],  controllers: [AppController],  providers: [AppService],})export class AppModule {}

Example Code For Controller#

Once you have setup the module properly in module file, its time to configure your route handlers to make the user properly redirected to appropriate identity provider's login page. @nestjs-hybrid-auth/github provides a guard and result interface to make it enabled.

Each route will have two variants. One is to redirect to social login page and the other is to collect the response such as access/refresh tokens and user profile etc. The result will be attached to Request object's hybridAuthResult property as shown in the example below.

app.controller.ts#

import { UseGithubAuth, GithubAuthResult } from '@nestjs-hybrid-auth/github';
@Controller()export class AppController {  constructor(private readonly appService: AppService) {}
  @UseGithubAuth()  @Get('auth/github')  loginWithGithub() {    return 'Login with Github';  }
  @UseGithubAuth()  @Get('auth/github-login/callback')  githubCallback(@Request() req): Partial<GithubAuthResult> {    const result: GithubAuthResult = req.hybridAuthResult;    return {      accessToken: result.accessToken,      refreshToken: result.refreshToken,      profile: result.profile,    };  }}

Exports#

@nestjs-hybrid-auth/github exports various decorators, interfaces and methods.

UseGithubAuth#

UseGithubAuth is NestJS Guard which hijacks your nest request and redirects users to the appropriate login page of your configured identity provider (github in this case). The same guard can be used on callback route also as shown in the example above. In the callback route handler, the req: Request object will have a property hybridAuthResult which is an object of type GithubAuthResult.

@UseGithubAuth(options: GithubAuthGuardOptions)@Get('auth/github')loginWithGithub() {  return 'Login with Github';}

GithubAuthGuardOptions#

This is a simple object to be passed into UseGithubAuth guard as shown in example above if you want to pass some extra parameters to query the github result. It can be left empty for default result.

GithubAuthModule#

This is the dynamic module which must be imported in your app's main module with forRoot or forRootAsync static methods whichever suits your need. Both will return a NestJS dynamic module.

interface GithubAuthModule {  forRoot(options: GithubAuthModuleOptions): DynamicModule;  forRootAsync(options: GithubAuthModuleAsyncOptions): DynamicModule;}

GithubAuthModuleOptions#

If you are configuring your module with forRoot static method, pass in the module options given below. They can be called the github passport strategy options also.

interface GithubAuthModuleOptions {  authorizationURL?: string | undefined;  tokenURL?: string | undefined;  clientID: string;  clientSecret: string;  callbackURL?: string | undefined;  customHeaders?: OutgoingHttpHeaders | undefined;  scope?: string | string[] | undefined;  scopeSeparator?: string | undefined;  sessionKey?: string | undefined;  store?: oauth2.StateStore | undefined;  state?: string | undefined;  userAgent?: string | undefined;  userProfileURL?: string | undefined;}

GithubAuthModuleAsyncOptions#

If you want to configure the GithubAuthModule dynamically having the config or other services injected, pass in async options in the forRootAsync static method. Please refer to the example above for useFactory and useClass properties.

interface GithubAuthModuleAsyncOptions {  useExisting?: Type<GithubAuthModuleOptionsFactory>;  useClass?: Type<GithubAuthModuleOptionsFactory>;  useFactory?: (    ...args: any[]  ) => Promise<GithubAuthModuleOptions> | GithubAuthModuleOptions;  inject?: any[];}

GithubAuthModuleOptionsFactory#

interface GithubAuthModuleOptionsFactory {  createModuleOptions():    | Promise<GithubAuthModuleOptions>    | GithubAuthModuleOptions;}

Have Issues?#

If you still have trouble setting up the workflow properly, please file an issue at Issues page.

Maintainers#

Manish Jangir