TsgcWebSocketHTTPServerEvents › OnAuthentication

OnAuthentication Event

Wywoływane, gdy uwierzytelnianie jest włączone, co umożliwia aplikacji sprawdzenie nazwy użytkownika i hasła oraz zaakceptowanie lub odrzucenie połączenia.

Składnia

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

Wartość domyślna

Uwagi

OnAuthentication jest wywoływane za każdym razem, gdy serwer odbiera żądanie uwierzytelnienia od klienta, pod warunkiem że Authentication.Enabled ma wartość True i metoda uwierzytelniania jest jednym z wbudowanych schematów (Basic, Session, URL). Parametry aUser i aPassword zawierają dane uwierzytelniające dostarczone przez klienta; należy ustawić Authenticated na True, aby zaakceptować połączenie, lub na False, aby je odrzucić. Gdy dane uwierzytelniające nie są walidowane tutaj, używana jest wbudowana lista AuthUsers jako opcja zastępcza. W przypadku niestandardowych schematów nierozpoznanych przez komponent (na przykład tokenów JWT Bearer) należy zamiast tego użyć OnUnknownAuthentication. Zdarzenie dotyczy zarówno aktualizacji WebSocket, jak i zwykłych żądań HTTP.

Przykład


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

Powrót do Zdarzeń