API Key Manager

TsgcWSAPIKeyManager — sgcWebSockets サーバーが発行する API キーのライフサイクル全体を管理します。生成、ハッシュ化、検証、ローテーション、失効、監査をすべて 1 つのコンポーネントで行います。

TsgcWSAPIKeyManager

API キーバリデーター。TsgcWebSocketHTTPServer(または HTTP-API サーバー)に接続するだけで、すべての受信接続が単一のイベント経由でキーストアに照合されます。

コンポーネントクラス

TsgcWSAPIKeyManager

プロトコル

サーバーサイドのアドミッション制御。

プラットフォーム

Windows, macOS, Linux, iOS, Android

エディション

Professional / Enterprise

コンポーネントを配置してプロパティを設定し、実行する

OnAPIKeyAuthenticate をフックし、サーバーにアタッチするだけで完了です。

uses
  sgcWebSocket, sgcWebSocket_Server, sgcAPIKeyManager;

var
  Keys: TsgcWSAPIKeyManager;
  WSServer: TsgcWebSocketHTTPServer;
begin
  Keys := TsgcWSAPIKeyManager.Create(nil);
  Keys.OnAPIKeyAuthenticate := DoAuth;

  WSServer := TsgcWebSocketHTTPServer.Create(nil);
  WSServer.Port := 80;
  WSServer.APIKeyManager := Keys;
  WSServer.Active := True;
end;

procedure TForm1.DoAuth(Sender: TObject;
  const aKey: string; var Authenticated: Boolean);
begin
  Authenticated := IsValidKey(aKey);
end;

主な機能

公開プロパティ 10 件、メソッド 26 件、イベント 7 件(コンポーネントリファレンスより)。

コア

プロパティ:Enabled

生成

プロパティ:GenerationHashing

ストレージ

プロパティ:Storage

認可

プロパティ:ScopesValidationExpiration

保護

プロパティ:RateLimit

監査

プロパティ:Audit

ドキュメントとデモ

コンポーネントリファレンスへのディープリンク、すぐに実行可能なデモプロジェクト、そして体験版のダウンロードはこちらです。

デモプロジェクト — 01.WebSocket\10.APIKeyManager すぐに実行可能なサンプルプロジェクトです。sgcWebSockets パッケージに同梱されています。下記より体験版をダウンロードしてください。
技術ドキュメント (PDF) 本コンポーネントのみを対象とした機能解説、クイックスタート、Delphi および C++ Builder のコードサンプル、一次資料への参照を収録しています。
ユーザーマニュアル (PDF) ライブラリ内のすべてのコンポーネントを網羅した総合マニュアルです。

本番グレードの API キーを発行する

体験版をダウンロードして、sgcWebSockets サーバーに API キー管理を追加しましょう。