Plugin pro autentizaci

Simuluje ověřování a autorizaci pomocí klíčů rozhraní API nebo OAuth2.

Příklad konfigurace: Klíč rozhraní API

{
  "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v2.0.0/rc.schema.json",
  "plugins": [
    {
      "name": "AuthPlugin",
      "enabled": true,
      "pluginPath": "~appFolder/plugins/DevProxy.Plugins.dll",
      "configSection": "auth"
    }
  ],
  "auth": {
    "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v2.0.0/authplugin.schema.json",
    "type": "apiKey",
    "apiKey": {
      "parameters": [
        {
          "in": "header",
          "name": "x-api-key"
        },
        {
          "in": "query",
          "name": "code"
        }
      ],
      "allowedKeys": [
        "1234"
      ]
    }
  }
}

Příklad konfigurace: OAuth2

{
  "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v2.0.0/rc.schema.json",
  "plugins": [
    {
      "name": "AuthPlugin",
      "enabled": true,
      "pluginPath": "~appFolder/plugins/DevProxy.Plugins.dll",
      "configSection": "auth"
    }
  ],
  "auth": {
    "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v2.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
    }
  }
}

Vlastnosti konfigurace

Vlastnost	Popis	Povinní účastníci
type	Typ ověřování a autorizace, které by měl používat dev proxy server. Povolené hodnoty: apiKey, oauth2	Ano
apiKey	Konfigurace pro ověřování a autorizaci klíče rozhraní API	Ano, kdy type je apiKey
oauth2	Konfigurace pro ověřování a autorizaci OAuth2	Ano, kdy type je oauth2

Vlastnosti konfigurace klíče rozhraní API

Vlastnost	Popis	Povinní účastníci
allowedKeys	Seznam povolených klíčů rozhraní API	Ano
parameters	Seznam parametrů, které obsahují klíč rozhraní API	Ano

Vlastnosti konfigurace parametrů

Vlastnost	Popis	Povinní účastníci
in	Kde se očekává nalezení parametru. Povolené hodnoty: header, querycookie	Ano
name	Název parametru.	Ano

Vlastnosti konfigurace OAuth2

Vlastnost	Popis	Povinní účastníci
metadataUrl	Adresa URL dokumentu metadat OpenID Connect	Ano
allowedApplications	Seznam POVOLENÝch ID aplikací Nechte prázdnou, abyste neověřili aplikaci (appid nebo azp deklaraci identity), pro kterou je token vystavený.	Ne
allowedAudiences	Seznam povolených cílových skupin Ponechte prázdné, abyste neověřili cílovou skupinu (aud deklaraci identity), pro kterou je token vystavený.	Ne
allowedPrincipals	Seznam povolených objektů zabezpečení Ponechte prázdné, aby se neověřil objekt zabezpečení (oid deklarace identity), pro který je token vystavený.	Ne
allowedTenants	Seznam povolených tenantů Nechejte prázdné, abyste neověřili tenanta (tid deklaraci identity), pro kterého je token vystavený.	Ne
issuer	Povolený vystavitel tokenu Ponechte prázdné, abyste neověřili vystavitele tokenu.	Ne
roles	Seznam povolených rolí Ponechte prázdné, aby se neověřily role (roles deklarace identity) v tokenu.	Ne
scopes	Seznam povolených oborů Ponechte prázdné, abyste neověřili obory (scp deklarace identity) tokenu.	Ne
validateLifetime	Nastavte na zakázání false ověřování životnosti tokenu. Výchozí hodnota true.	Ne
validateSigningKey	Nastavte na zakázání false ověřování podpisu tokenu. Výchozí true	Ne

Možnosti příkazového řádku

Žádné