Utility class

Pakiet:
@microsoft/agents-a365-runtime

Klasa narzędzi zapewniająca metody pomocnicze dla operacji środowiska uruchomieniowego agenta.

Metody

getAgentIdFromToken(string)

OSTRZEŻENIE: BRAK WERYFIKACJI PODPISU — ta metoda używa metody jwt.decode(), która nie weryfikuje podpisu tokenu. Oświadczenia tokenu mogą być fałszowane przez złośliwych podmiotów. Ta metoda jest odpowiednia tylko do celów rejestrowania, analizy i diagnostyki. Nie używaj zwracanej wartości do podejmowania decyzji dotyczących autoryzacji, kontroli dostępu lub zabezpieczeń.

Dekoduje token i pobiera najlepszy dostępny identyfikator agenta. Sprawdza oświadczenia w kolejności priorytetu: xms_par_app_azp (identyfikator strategii agenta) > appid > azp.

Uwaga: zwraca pusty ciąg dla pustych/brakujących tokenów (w przeciwieństwie do getAppIdFromToken , który zwraca domyślny identyfikator GUID). Umożliwia to obiektom wywołującym pomijanie nagłówków, gdy identyfikator nie jest dostępny.
GetAppIdFromToken(string)

OSTRZEŻENIE: BRAK WERYFIKACJI PODPISU — ta metoda używa metody jwt.decode(), która nie weryfikuje podpisu tokenu. Oświadczenia tokenu mogą być fałszowane przez złośliwych podmiotów. Ta metoda jest odpowiednia tylko do celów rejestrowania, analizy i diagnostyki. Nie używaj zwracanej wartości do podejmowania decyzji dotyczących autoryzacji, kontroli dostępu lub zabezpieczeń.

Dekoduje bieżący token i pobiera identyfikator aplikacji (appid lub azp claim).

Uwaga: zwraca domyślny identyfikator GUID ('000000000-0000-0000-0000-00000000000000) dla pustych tokenów w celu zapewnienia zgodności z poprzednimi elementami, które oczekują prawidłowego identyfikatora GUID. W przypadku identyfikacji agenta, gdzie preferowany jest pusty ciąg, użyj polecenia getAgentIdFromToken.
getApplicationName()

Pobiera nazwę aplikacji ze zmiennej środowiskowej npm_package_name lub package.json. Wynik package.json jest buforowany w czasie ładowania modułu, aby uniknąć synchronizacji we/wy podczas żądań.
GetUserAgentHeader(string)

Generuje ciąg nagłówka User-Agent zawierający wersję zestawu SDK, typ systemu operacyjnego, wersję Node.js i orkiestrator.
ResolveAgentIdentity(TurnContext, string)

Rozpoznaje tożsamość agenta z kontekstu kolei lub tokenu uwierzytelniania.

Szczegóły metody

getAgentIdFromToken(string)

OSTRZEŻENIE: BRAK WERYFIKACJI PODPISU — ta metoda używa metody jwt.decode(), która nie weryfikuje podpisu tokenu. Oświadczenia tokenu mogą być fałszowane przez złośliwych podmiotów. Ta metoda jest odpowiednia tylko do celów rejestrowania, analizy i diagnostyki. Nie używaj zwracanej wartości do podejmowania decyzji dotyczących autoryzacji, kontroli dostępu lub zabezpieczeń.

Dekoduje token i pobiera najlepszy dostępny identyfikator agenta. Sprawdza oświadczenia w kolejności priorytetu: xms_par_app_azp (identyfikator strategii agenta) > appid > azp.

Uwaga: zwraca pusty ciąg dla pustych/brakujących tokenów (w przeciwieństwie do getAppIdFromToken , który zwraca domyślny identyfikator GUID). Umożliwia to obiektom wywołującym pomijanie nagłówków, gdy identyfikator nie jest dostępny.

static function getAgentIdFromToken(token: string): string

Parametry

token

string

Token JWT do dekodowania

Zwraca

string

Identyfikator agenta (GUID) lub pusty ciąg, jeśli nie znaleziono lub token jest pusty

GetAppIdFromToken(string)

OSTRZEŻENIE: BRAK WERYFIKACJI PODPISU — ta metoda używa metody jwt.decode(), która nie weryfikuje podpisu tokenu. Oświadczenia tokenu mogą być fałszowane przez złośliwych podmiotów. Ta metoda jest odpowiednia tylko do celów rejestrowania, analizy i diagnostyki. Nie używaj zwracanej wartości do podejmowania decyzji dotyczących autoryzacji, kontroli dostępu lub zabezpieczeń.

Dekoduje bieżący token i pobiera identyfikator aplikacji (appid lub azp claim).

Uwaga: zwraca domyślny identyfikator GUID ('000000000-0000-0000-0000-00000000000000) dla pustych tokenów w celu zapewnienia zgodności z poprzednimi elementami, które oczekują prawidłowego identyfikatora GUID. W przypadku identyfikacji agenta, gdzie preferowany jest pusty ciąg, użyj polecenia getAgentIdFromToken.

static function GetAppIdFromToken(token: string): string

Parametry

token

string

Token do dekodowania

Zwraca

string

AppId lub domyślny identyfikator GUID dla pustego tokenu lub pusty ciąg, jeśli dekodowanie nie powiedzie się

getApplicationName()

Pobiera nazwę aplikacji ze zmiennej środowiskowej npm_package_name lub package.json. Wynik package.json jest buforowany w czasie ładowania modułu, aby uniknąć synchronizacji we/wy podczas żądań.

static function getApplicationName(): undefined | string

Zwraca

undefined | string

Nazwa aplikacji lub niezdefiniowana, jeśli nie jest dostępna.

GetUserAgentHeader(string)

Generuje ciąg nagłówka User-Agent zawierający wersję zestawu SDK, typ systemu operacyjnego, wersję Node.js i orkiestrator.

static function GetUserAgentHeader(orchestrator?: string): string

Parametry

orchestrator

string

Opcjonalny identyfikator orkiestratora do uwzględnienia w ciągu User-Agent.

Zwraca

string

Sformatowany ciąg nagłówka User-Agent.

ResolveAgentIdentity(TurnContext, string)

Rozpoznaje tożsamość agenta z kontekstu kolei lub tokenu uwierzytelniania.

static function ResolveAgentIdentity(context: TurnContext, authToken: string): string

Parametry

context
TurnContext

Włącz kontekst kolei.

authToken

string

Token uwierzytelniania, jeśli jest dostępny.

Zwraca

string

Tożsamość agenta (identyfikator aplikacji)