Go を使用して OTP ベースの認証サーバーを構築する: パート 1

はじめる

まず、プロジェクト用に新しいフォルダーを作成し、次のコマンドを使用して Go モジュールを初期化します。

go mod init github.com/vishaaxl/cheershare

プロジェクト構造のセットアップ

まず、次のフォルダー構造で新しい Go プロジェクトをセットアップします。

my-otp-auth-server/
├── cmd/
│   └── api/
│       └── main.go
│       └── user.go
│       └── token.go
├── internal/
│   └── data/
│       ├── models.go
│       └── user.go
│       └── token.go
├── docker-compose.yml
├── go.mod
└── Makefile

次に、docker-compose.yml ファイルを設定します。この構成では、このチュートリアル全体で使用するサービス (PostgreSQL と Redis) を定義します。

Docker Compose を使用したサービスのセットアップ

プロジェクトに必要なサービスを構成することから始めます。バックエンドには次のものが必要です:

• Redis: redis:6 イメージを使用します。このサービスは、安全なアクセスのためのパスワードを構成し、ポート 6379 を公開し、--requirepass フラグを使用してパスワード認証を強制して、Redis アクセスを保護します。

• PostgreSQL: postgres:13 イメージを使用します。このサービスは、デフォルトのユーザー、パスワード、データベースを定義し、通信用にポート 5432 を公開し、耐久性を確保するために名前付きボリューム (postgres_data) でデータを永続化します。

オプション:

• メイン バックエンド サービス: ここで、PostgreSQL と Redis の両方と対話するメイン バックエンド サービスを定義することもできます。

// docker-compose.yml
services:
  postgres:
    image: postgres:13
    container_name: postgres
    environment:
      POSTGRES_USER: postgres
      POSTGRES_PASSWORD: mysecretpassword
      POSTGRES_DB: cheershare
    ports:
      - "5432:5432"
    volumes:
      - postgres_data:/var/lib/postgresql/data

  redis:
    image: redis:6
    container_name: redis
    environment:
      REDIS_PASSWORD: mysecretpassword
    ports:
      - "6379:6379"
    command: ["redis-server", "--requirepass", "mysecretpassword"]

volumes:
  postgres_data:

メインのバックエンド サービス

HTTP リクエストのルーティングと処理には、github.com/julienschmidt/httprouter パッケージを使用します。依存関係をインストールするには、次のコマンドを実行します:

go get github.com/julienschmidt/httprouter

次に、cmd/api/main.go にファイルを作成し、次のコードを貼り付けます。各行の説明はコメントに記載されています:

//  main.go
package main

import (
    "fmt"
    "log"
    "net/http"
    "os"
    "time"

    "github.com/julienschmidt/httprouter"
)

/*
config struct:
- Holds application-wide configuration settings such as:
  - `port`: The port number on which the server will listen.
  - `env`: The current environment (e.g., "development", "production").
*/
type config struct {
    port int
    env  string
}

/*
applications struct:
- Encapsulates the application's dependencies, including:
  - `config`: The application's configuration settings.
  - `logger`: A logger instance to handle log messages.
*/
type applications struct {
    config config
    logger *log.Logger
}

func main() {
    cfg := &config{
        port: 4000,
        env:  "development",
    }

    logger := log.New(os.Stdout, "INFO\t", log.Ldate|log.Ltime)

    app := &applications{
        config: *cfg,
        logger: logger,
    }

    router := httprouter.New()

    router.GET("/", func(w http.ResponseWriter, r *http.Request, _ httprouter.Params) {
        w.WriteHeader(http.StatusOK)
        fmt.Fprintln(w, "Welcome to the Go application!")
    })

    /*
        Initialize the HTTP server
        - Set the server's address to listen on the specified port.
        - Assign the router as the handler.
        - Configure timeouts for idle, read, and write operations.
        - Set up an error logger to capture server errors.
    */
    srv := &http.Server{
        Addr:         fmt.Sprintf(":%d", app.config.port),
        Handler:      router,
        IdleTimeout:  time.Minute,
        ReadTimeout:  10 * time.Second,
        WriteTimeout: 30 * time.Second,
    }

    app.logger.Printf("Starting server on port %d in %s mode", app.config.port, app.config.env)

    err := srv.ListenAndServe()
    if err != nil {
        app.logger.Fatalf("Could not start server: %s", err)
    }
}

現時点では、 go run ./cmd/api を使用してサーバーを起動し、http://localhost:4000 にリクエストを送信することで、セットアップをテストできます。これにより、ウェルカム メッセージが返されます。次に、コア機能を実装するための 3 つの追加ルートを定義します。

1. /send-otp: このルートはユーザーへの OTP の送信を処理します。一意の OTP を生成し、Redis に保存して、ユーザーに配信します。

2. /verify-otp: このルートは、ユーザーが提供した OTP を検証します。 Redis に保存されている値と照合してユーザーの ID を確認します。

3. /login: OTP が検証され、ユーザーが正常に作成されると、このルートはユーザーのログイン機能を処理します。

ただし、続行する前に、電話番号やワンタイム パスワードなどのユーザー情報を保存する方法が必要です。これらの情報は、docker-compose.yml ファイルで前に定義したサービスに接続する必要があります。

ヘルパー関数の定義

ルートを実装する前に、2 つの重要なヘルパー関数を定義しましょう。これらの関数は Redis および PostgreSQL サーバーへの接続を処理し、バックエンドがこれらのサービスと対話できるようにします。

サービスに関する情報を保存するように「config」構造体を変更します。 これらの関数は一目瞭然です。

my-otp-auth-server/
├── cmd/
│   └── api/
│       └── main.go
│       └── user.go
│       └── token.go
├── internal/
│   └── data/
│       ├── models.go
│       └── user.go
│       └── token.go
├── docker-compose.yml
├── go.mod
└── Makefile

docker-compose up -d コマンドでサービスを開始した後、これらの関数を使用して PostgreSQL データベースと Redis サーバーへの接続を確立できます。

次のパートでは、以前に説明したルートの作業を開始します。 main.go ファイルは次のようになります。

// docker-compose.yml
services:
  postgres:
    image: postgres:13
    container_name: postgres
    environment:
      POSTGRES_USER: postgres
      POSTGRES_PASSWORD: mysecretpassword
      POSTGRES_DB: cheershare
    ports:
      - "5432:5432"
    volumes:
      - postgres_data:/var/lib/postgresql/data

  redis:
    image: redis:6
    container_name: redis
    environment:
      REDIS_PASSWORD: mysecretpassword
    ports:
      - "6379:6379"
    command: ["redis-server", "--requirepass", "mysecretpassword"]

volumes:
  postgres_data:

以上がGo を使用して OTP ベースの認証サーバーを構築する: パート 1の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。