Hitelesítő bővítmény

Szimulálja a hitelesítést és az engedélyezést API-kulcsok vagy OAuth2 használatával.

Beépülő modulpéldány definíciója

{
  "name": "AuthPlugin",
  "enabled": true,
  "pluginPath": "~appFolder/plugins/DevProxy.Plugins.dll",
  "configSection": "auth"
}

Konfigurációs példa: API-kulcs

{
  "auth": {
    "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v1.0.0/authplugin.schema.json",
    "type": "apiKey",
    "apiKey": {
      "parameters": [
        {
          "in": "header",
          "name": "x-api-key"
        },
        {
          "in": "query",
          "name": "code"
        }
      ],
      "allowedKeys": [
        "1234"
      ]
    }
  }
}

Konfigurációs példa: OAuth2

{
  "auth": {
    "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v1.0.0/authplugin.schema.json",
    "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
    }
  }
}

Konfigurációs tulajdonságok

Tulajdonság	Leírás	Kötelező
type	A Dev Proxy által használandó hitelesítés és engedélyezés típusa. Engedélyezett értékek: apiKey, oauth2	Igen
apiKey	Az API-kulcsok hitelesítésének és engedélyezésének konfigurálása.	Igen, mikor type van apiKey
oauth2	Az OAuth2 hitelesítésének és engedélyezésének konfigurálása.	Igen, mikor type van oauth2

API-kulcs konfigurációs tulajdonságai

Tulajdonság	Leírás	Kötelező
allowedKeys	Az engedélyezett API-kulcsok listája.	Igen
parameters	Az API-kulcsot tartalmazó paraméterek listája.	Igen

Paraméterkonfiguráció tulajdonságai

Tulajdonság	Leírás	Kötelező
in	Ahol a paraméter várhatóan megtalálható. Engedélyezett értékek: header, query, cookie	Igen
name	A paraméter neve.	Igen

OAuth2 konfigurációs tulajdonságok

Tulajdonság	Leírás	Kötelező
metadataUrl	Az OpenID Connect metaadat-dokumentumÁNAK URL-címe.	Igen
allowedApplications	Az engedélyezett alkalmazásazonosítók listája. Hagyja üresen annak az alkalmazásnak (appid vagy azp jogcímnek) az érvényesítését, amelyhez a jogkivonatot kibocsátják.	Nem
allowedAudiences	Az engedélyezett célközönségek listája. Hagyja üresen, hogy ne érvényesítse azt a célközönséget (aud jogcímet), amelyhez a jogkivonatot kibocsátják.	Nem
allowedPrincipals	Az engedélyezett tagok listája. Hagyja üresen, hogy ne érvényesítse azt a tagot (oid jogcímet), amelyhez a jogkivonatot kibocsátják.	Nem
allowedTenants	Az engedélyezett bérlők listája. Hagyja üresen, hogy ne érvényesítse azt a bérlőt (tid jogcímet), amelyhez a jogkivonatot kibocsátják.	Nem
issuer	Engedélyezett tokenkibocsátó. Hagyja üresen a jogkivonat kiállítójának érvényesítését.	Nem
roles	Az engedélyezett szerepkörök listája. Hagyja üresen a jogkivonat szerepköreinek (roles jogcímének) érvényesítését.	Nem
scopes	Az engedélyezett hatókörök listája. Hagyja üresen, hogy ne érvényesítse a hatóköröket (scp jogcímet) a jogkivonaton.	Nem
validateLifetime	Állítsa be úgy, hogy false letiltsa a jogkivonat élettartamának érvényesítését. Alapértelmezett true.	Nem
validateSigningKey	Állítsa úgy, hogy false letiltsa a jogkivonat-aláírás érvényesítését. Alapértelmezett true	Nem

Parancssori beállítások

Egyik sem