Pengesahan dengan Kerani dalam Aplikasi Pelayan NestJS

pengenalan

Artikel ini menyediakan panduan langkah demi langkah yang komprehensif untuk melaksanakan pengesahan dan kebenaran dalam aplikasi hujung belakang NestJS dengan Kerani.

Apa itu Kerani?

Kerani ialah platform komprehensif yang menawarkan antara muka pengguna boleh terbenam, API fleksibel dan papan pemuka yang intuitif dan mantap untuk pengesahan dan pengurusan pengguna yang lancar. Ia merangkumi segala-galanya daripada pengurusan sesi dan pengesahan berbilang faktor kepada log masuk sosial, pautan ajaib, e-mel atau kod laluan sekali SMS dan banyak lagi.

Kenapa guna Clerk?

Keperluan pengesahan dan keselamatan, arah aliran dan amalan terbaik sentiasa berkembang kerana perlindungan data dan privasi semakin penting. Dengan memunggah tanggungjawab ini kepada penyedia perkhidmatan khusus, anda boleh menumpukan pada membina ciri teras aplikasi anda dan menghantar lebih cepat.

Platform seperti Kerani wujud untuk melaksanakan tugas keselamatan ini untuk anda.

Prasyarat

• Pengetahuan asas skrip Taip
• Kebiasaan dengan NestJS Fundamentals
• Pemahaman konsep pengesahan pada bahagian belakang
• Menjalankan Nod 18 atau terkini

---

Persediaan projek

Projek ini memerlukan projek NestJS baharu atau sedia ada, akaun dan aplikasi Kerani serta perpustakaan seperti Pasport, Strategi Pasport dan SDK hujung belakang Kerani.

Mencipta projek NestJS

Anda boleh menyediakan projek NestJS baharu dengan mudah menggunakan Nest CLI. Dengan mana-mana pengurus pakej yang anda suka, jalankan arahan berikut untuk membuat aplikasi Nest baharu:

$ pnpm add -g @nestjs/cli
$ nest new clerk-auth

Lihat dokumentasi NestJS untuk mendapatkan butiran lanjut.

Menyediakan akaun dan aplikasi Kerani anda

Jika anda belum memilikinya, buat akaun Kerani dan sediakan aplikasi baharu dalam papan pemuka Kerani. Anda boleh bermula di tapak web Kerani.

Memasang perpustakaan yang diperlukan

Perpustakaan yang diperlukan untuk projek ini boleh dipasang dengan arahan ini:

$ pnpm add @clerk/backend @nestjs/config @nestjs/passport passport passport-custom

Konfigurasi persekitaran

Buat fail .env dalam direktori akar projek anda untuk mengurus pembolehubah bagi persekitaran, pengeluaran, pembangunan atau pementasan yang berbeza.

Tambahkan pembolehubah berikut, menggantikan ruang letak dengan kunci sebenar yang diperoleh daripada papan pemuka akaun Kerani anda.

# .env

CLERK_PUBLISHABLE_KEY=YOUR_PUBLISHABLE_KEY
CLERK_SECRET_KEY=YOUR_SECRET_KEY

Untuk mengakses pembolehubah persekitaran di seluruh aplikasi menggunakan ConfigService, import ConfigModule ke dalam akar AppModule.

// src/app.module.ts

import { Module } from '@nestjs/common';
import { ConfigModule } from '@nestjs/config';

@Module({
  imports: [
    ConfigModule.forRoot({
      isGlobal: true,
    }),
  ],
})
export class AppModule {}

---

Mengintegrasikan Kerani dalam NestJS

Bahagian ini menerangkan cara untuk menyepadukan dan menggunakan SDK hujung belakang Kerani dalam projek NestJS anda.

Mewujudkan pembekal pelanggan Kerani

Mendaftarkan pelanggan Kerani sebagai pembekal menjadikannya boleh disuntik ke dalam kelas menggunakan penghias, membolehkan ia digunakan di mana-mana sahaja diperlukan di seluruh pangkalan kod, seperti yang ditunjukkan dalam bahagian yang akan datang.

$ pnpm add -g @nestjs/cli
$ nest new clerk-auth

Mendaftar ClerkClientProvider dalam AppModule

Seterusnya, anda perlu mendaftarkan penyedia dengan Nest untuk mendayakan suntikan pergantungan.

$ pnpm add @clerk/backend @nestjs/config @nestjs/passport passport passport-custom

---

Menggunakan Pasport dengan JWT Keluaran Kerani

Kerani mengeluarkan token JWT apabila pengguna mendaftar atau log masuk melalui halaman dihoskan Kerani atau apl bahagian hadapan. Token ini kemudiannya dihantar sebagai token pembawa dalam pengepala Kebenaran permintaan yang dibuat kepada aplikasi hujung belakang NestJS.

Mencipta Strategi Kerani

Dalam NestJS, Pasport ialah cara yang disyorkan untuk melaksanakan strategi pengesahan. Anda akan membuat strategi Kerani tersuai yang mengesahkan token dengan pelanggan Kerani.

# .env

CLERK_PUBLISHABLE_KEY=YOUR_PUBLISHABLE_KEY
CLERK_SECRET_KEY=YOUR_SECRET_KEY

Kaedah validate() mengembalikan data pengguna yang NestJS lampirkan secara automatik pada request.user.

Mencipta Modul Pengesahan

Buat AuthModule yang menyediakan strategi Kerani dan disepadukan dengan PassportModule. Kemudian, daftarkan AuthModule dalam AppModule.

// src/app.module.ts

import { Module } from '@nestjs/common';
import { ConfigModule } from '@nestjs/config';

@Module({
  imports: [
    ConfigModule.forRoot({
      isGlobal: true,
    }),
  ],
})
export class AppModule {}

// src/providers/clerk-client.provider.ts

import { createClerkClient } from '@clerk/backend';
import { ConfigService } from '@nestjs/config';

export const ClerkClientProvider = {
  provide: 'ClerkClient',
  useFactory: (configService: ConfigService) => {
    return createClerkClient({
      publishableKey: configService.get('CLERK_PUBLISHABLE_KEY'),
      secretKey: configService.get('CLERK_SECRET_KEY'),
    });
  },
  inject: [ConfigService],
};

---

Melaksanakan perlindungan laluan

Laluan yang dilindungi ialah laluan yang memerlukan pengguna disahkan sebelum mereka boleh mengaksesnya.

Mencipta pengawal pengesahan Kerani

Pengawal menentukan sama ada permintaan khusus perlu diproses oleh pengendali laluan berdasarkan keadaan masa jalan tertentu.

Jika anda ingin melindungi semua laluan dalam aplikasi anda secara lalai, anda perlu mengambil langkah berikut:

1. Buat penghias Awam untuk menandakan laluan yang sepatutnya boleh diakses tanpa pengesahan.
2. Laksanakan ClerkAuthGuard untuk menyekat akses kepada laluan yang dilindungi, membenarkan hanya pengguna yang disahkan untuk meneruskan.

// src/app.module.ts

import { Module } from '@nestjs/common';
import { ConfigModule } from '@nestjs/config';
import { ClerkClientProvider } from 'src/providers/clerk-client.provider';

@Module({
  imports: [
    ConfigModule.forRoot({
      isGlobal: true,
    }),
  ],
  providers: [ClerkClientProvider],
})
export class AppModule {}

// src/auth/clerk.strategy.ts

import { User, verifyToken } from '@clerk/backend';
import { Injectable, Injectable, UnauthorizedException } from '@nestjs/common';
import { ConfigService } from '@nestjs/config';
import { PassportStrategy } from '@nestjs/passport';
import { Strategy } from 'passport-custom';
import { UsersService } from 'src/users/users.service';
import { Request } from 'express';
import { ClerkClient } from '@clerk/backend';

@Injectable()
export class ClerkStrategy extends PassportStrategy(Strategy, 'clerk') {
  constructor(
    @Inject('ClerkClient')
    private readonly clerkClient: ClerkClient,
    private readonly configService: ConfigService,
  ) {
    super();
  }

  async validate(req: Request): Promise<user> {
    const token = req.headers.authorization?.split(' ').pop();

    if (!token) {
      throw new UnauthorizedException('No token provided');
    }

    try {
      const tokenPayload = await verifyToken(token, {
        secretKey: this.configService.get('CLERK_SECRET_KEY'),
      });

      const user = await this.clerkClient.users.getUser(tokenPayload.sub);

      return user;
    } catch (error) {
      console.error(error);
      throw new UnauthorizedException('Invalid token');
    }
  }
}

</user>

Mendayakan pengesahan secara global

Memandangkan kebanyakan titik akhir anda akan dilindungi secara lalai, anda boleh mengkonfigurasi pengawal pengesahan sebagai pengawal global.

// src/auth/auth.module.ts

import { Module } from '@nestjs/common';
import { ClerkStrategy } from './clerk.strategy';
import { PassportModule } from '@nestjs/passport';
import { ClerkClientProvider } from 'src/providers/clerk-client.provider';
import { ConfigModule } from '@nestjs/config';

@Module({
  imports: [PassportModule, ConfigModule],
  providers: [ClerkStrategy, ClerkClientProvider],
  exports: [PassportModule],
})
export class AuthModule {}

Menentukan Laluan Terlindung dan Awam

Dalam dua pengawal ini, penghias Awam digunakan dalam AppController untuk menetapkan laluan sebagai awam. Sebaliknya, tiada penghias diperlukan dalam AuthController untuk menentukan laluan sebagai dilindungi, kerana pengawal pengesahan digunakan secara global secara lalai.

// src/app.module.ts

import { Module } from '@nestjs/common';
import { ConfigModule } from '@nestjs/config';
import { ClerkClientProvider } from 'src/providers/clerk-client.provider';
import { AuthModule } from 'src/auth/auth.module';

@Module({
  imports: [
    ConfigModule.forRoot({
      isGlobal: true,
    }),
    AuthModule,
  ],
  providers: [ClerkClientProvider],
})
export class AppModule {}

// src/decorators/public.decorator.ts

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

export const IS_PUBLIC_KEY = 'isPublic';
export const Public = () => SetMetadata(IS_PUBLIC_KEY, true);

Nota: Ingat untuk mendaftarkan AppController dalam AppModule dan AuthController dalam AuthModule.

Kesimpulan

Kerani sebagai platform mengendalikan tanggungjawab pengesahan dan keselamatan, mengikuti aliran terkini dan amalan terbaik. Ini membolehkan anda menumpukan pada membina ciri teras aplikasi anda dan mempercepatkan proses pembangunan anda.

Dalam panduan ini, kami telah merangkumi langkah-langkah untuk melaksanakan pengesahan Kerani, daripada menyediakan projek kepada mendapatkan laluan. Langkah asas ini akan membantu anda memulakan perjalanan anda menerokai kemungkinan dengan platform perkhidmatan pengesahan.

Contoh berfungsi sepenuhnya projek ini disertakan pada penghujung artikel ini.

thedammyking / kerani-sarang-auth

Menggunakan pengesahan Kerani dan pengurusan pengguna dalam aplikasi hujung belakang NestJS

Pengesahan Kerani-NestJS

Menggunakan pengesahan Kerani dan pengurusan pengguna dalam aplikasi hujung belakang NestJS

Apa yang ada di dalam?

Monorepo ini termasuk pakej dan apl berikut:

Apl dan Pakej

• api: apl NestJS

Setiap pakej dan apl adalah 100% TypeScript.

Utiliti

Monorepo ini mempunyai beberapa alatan tambahan yang telah disediakan untuk anda:

• TypeScript untuk semakan jenis statik
• ESLint untuk linting kod
• Lebih cantik untuk pemformatan kod

Lihat di GitHub

Atas ialah kandungan terperinci Pengesahan dengan Kerani dalam Aplikasi Pelayan NestJS. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!