TsgcWebSocketHTTPServer › イベント › OnAuthentication

OnAuthentication イベント

認証が有効になっているときに発生し、アプリケーションがユーザーとパスワードを確認して接続を受け入れるか拒否できます。

構文

property OnAuthentication: TsgcWSAuthenticationEvent;
// TsgcWSAuthenticationEvent = procedure(Connection: TsgcWSConnection; aUser, aPassword: String; var Authenticated: Boolean) of object

デフォルト値

—

解説

OnAuthentication は、Authentication.Enabled が True であり、認証メソッドが組み込みスキーム（Basic、Session、URL）のいずれかである場合、サーバーがクライアントから認証リクエストを受信するたびに発生します。aUser および aPassword パラメーターにはクライアントが提供した資格情報が含まれます。接続を承認するには Authenticated を True に、拒否するには False に設定してください。ここで資格情報が検証されない場合、組み込みの AuthUsers リストがフォールバックとして使用されます。コンポーネントが認識しないカスタムスキーム（例えば JWT Bearer トークン）の場合は、代わりに OnUnknownAuthentication を使用してください。このイベントは WebSocket アップグレードとプレーン HTTP リクエストの両方に適用されます。

使用例

procedure OnAuthentication(Connection: TsgcWSConnection; aUser, aPassword: string;
  var Authenticated: Boolean);
begin
  if ((aUser = 'user') and (aPassword = 'secret')) then
    Authenticated := True
  else
    Authenticated := False;
end;

イベントに戻る