Udostępnij za pośrednictwem


AuthPlugin

Symuluje uwierzytelnianie i autoryzację przy użyciu kluczy interfejsu API lub protokołu OAuth2.

Zrzut ekranu przedstawiający wiersz polecenia z serwerem proxy deweloperów symulującym uwierzytelnianie przy użyciu klucza interfejsu API w funkcji platformy Azure uruchomionej lokalnie.

Definicja wystąpienia wtyczki

{
  "name": "AuthPlugin",
  "enabled": true,
  "pluginPath": "~appFolder/plugins/dev-proxy-plugins.dll",
  "configSection": "auth"
}

Przykład konfiguracji: klucz interfejsu API

{
  "auth": {
    "type": "apiKey",
    "apiKey": {
      "parameters": [
        {
          "in": "header",
          "name": "x-api-key"
        },
        {
          "in": "query",
          "name": "code"
        }
      ],
      "allowedKeys": [
        "1234"
      ]
    }
  }
}

Przykład konfiguracji: OAuth2

{
  "auth": {
    "type": "oauth2",
    "oauth2": {
      "metadataUrl": "https://login.microsoftonline.com/organizations/v2.0/.well-known/openid-configuration",
      "allowedApplications": [
        "00000000-0000-0000-0000-000000000000"
      ],
      "allowedAudiences": [
        "00000000-0000-0000-0000-000000000000"
      ],
      "allowedPrincipals": [
        "00000000-0000-0000-0000-000000000000"
      ],
      "allowedTenants":[
        "00000000-0000-0000-0000-000000000000"
      ],
      "issuer": "https://login.microsoftonline.com/ffffffff-eeee-dddd-cccc-bbbbbbbbbbb0/v2.0",
      "scopes": [
        "Posts.Read"
      ],
      "validateLifetime": true,
      "validateSigningKey": true
    }
  }
}

Właściwości konfiguracji

Właściwości Opis Wymagania
type Typ uwierzytelniania i autoryzacji, którego powinien używać serwer proxy deweloperów. Dozwolone wartości: apiKey, oauth2 Tak
apiKey Konfiguracja uwierzytelniania i autoryzacji klucza interfejsu API. Tak, gdy type jest apiKey
oauth2 Konfiguracja uwierzytelniania i autoryzacji OAuth2. Tak, gdy type jest oauth2

Właściwości konfiguracji klucza interfejsu API

Właściwości Opis Wymagania
allowedKeys Lista dozwolonych kluczy interfejsu API. Tak
parameters Lista parametrów zawierających klucz interfejsu API. Tak

Właściwości konfiguracji parametrów

Właściwości Opis Wymagania
in Gdzie powinien zostać znaleziony parametr. Dozwolone wartości: header, , querycookie Tak
name Nazwa parametru. Tak

Właściwości konfiguracji protokołu OAuth2

Właściwości Opis Wymagania
metadataUrl Adres URL dokumentu metadanych OpenID Connect. Tak
allowedApplications Lista dozwolonych identyfikatorów aplikacji. Pozostaw wartość pustą, aby nie zweryfikować aplikacji (appid lub azp oświadczenia), dla której wystawiono token. Nie.
allowedAudiences Lista dozwolonych odbiorców. Pozostaw wartość pustą, aby nie weryfikować odbiorców (aud oświadczenia), dla których wystawiono token. Nie.
allowedPrincipals Lista dozwolonych podmiotów zabezpieczeń. Pozostaw wartość pustą, aby nie weryfikować podmiotu zabezpieczeń (oid oświadczenia), dla którego wystawiono token. Nie.
allowedTenants Lista dozwolonych dzierżaw. Pozostaw wartość pustą, aby nie weryfikować dzierżawy (tid oświadczenia), dla której wystawiono token. Nie.
issuer Dozwolony wystawca tokenu. Pozostaw wartość pustą, aby nie weryfikować wystawcy tokenu. Nie.
roles Lista dozwolonych ról. Pozostaw wartość pustą, aby nie weryfikować ról (roles oświadczenia) w tokenie. Nie.
scopes Lista dozwolonych zakresów. Pozostaw wartość pustą, aby nie weryfikować zakresów (scp oświadczenia) w tokenie. Nie.
validateLifetime Ustaw wartość na , aby false wyłączyć weryfikowanie okresu istnienia tokenu. Wartość domyślna true. Nie.
validateSigningKey Ustaw wartość na wartość , aby false wyłączyć weryfikowanie podpisu tokenu. Domyślny true Nie.

Opcje wiersza polecenia

Brak