Megosztás:

ApiCenter Minimális Jogosultságok Bővítmény

Ellenőrzi, hogy az alkalmazás minimális engedélyekkel hívja-e meg az API-kat. A megadott Azure API Center-példány API-adatait használja.

Képernyőkép egy parancssorról, amelyen a Dev Proxy ellenőrzi, hogy a rögzített API-kérések minimális API-engedélyeket használnak-e jogkivonatokkal.

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

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

Példa konfigurációra

{
  "apiCenterMinimalPermissionsPlugin": {
    "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v1.0.0/apicenterminimalpermissionsplugin.schema.json",
    "subscriptionId": "aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e",
    "resourceGroupName": "resource-group-name",
    "serviceName": "apic-instance",
    "workspaceName": "default"
  }
}

Konfigurációs tulajdonságok

Tulajdonság Leírás Alapértelmezett
resourceGroupName Annak az erőforráscsoportnak a neve, amelyben az Azure API Center található. Egyik sem
serviceName Annak az Azure API Center-példánynak a neve, amellyel a Dev Proxynak ellenőriznie kell, hogy az alkalmazásban használt API-k regisztrálva vannak-e. Egyik sem
subscriptionId Annak az Azure-előfizetésnek az azonosítója, ahol az Azure API Center-példány található. Egyik sem
workspace A használni kívánt Azure API Center-munkaterület neve. default
schemeName A minimális engedélyek meghatározásához használt biztonságiséma-definíció neve. Ha nincs megadva, a beépülő modul beolvassa a specifikáció első oauth2 sémájának adatait Egyik sem

Parancssori beállítások

Egyik sem

Megjegyzések

A ApiCenterMinimalPermissionsPlugin beépülő modul ellenőrzi, hogy az alkalmazás minimális engedélyekkel hívja-e meg az API-kat. Az engedélyek ellenőrzéséhez a beépülő modul a megadott Azure API Center-példányban regisztrált API-k adatait használja.

Csatlakozás az Azure API Centerhez

Az Azure API Centerhez való csatlakozáshoz a beépülő modul Azure-hitelesítő adatokat használ (ebben a sorrendben):

  • Környezet
  • Számítási feladatok identitása
  • Felügyelt identitás
  • Visual Studio
  • Visual Studio Code
  • Azure CLI (Az Azure parancssori felülete)
  • Azure PowerShell
  • Azure Developer CLI

Ha a beépülő modul nem tud hozzáférési jogkivonatot lekérni az Azure eléréséhez, hibaüzenet jelenik meg, és a Dev Proxy letiltja. Jelentkezzen be az Azure-ba ezen eszközök bármelyikével, és indítsa újra a Dev Proxyt a ApiCenterMinimalPermissionsPlugin beépülő modul használatához.

Ha dev proxyt használ a CI/CD-folyamatokban, környezeti változókként átadhatja a subscriptionId, resourceGroupName, serviceNameés workspaceName tulajdonságok értékeit. Környezeti változók használatához használja az érték nevét egy előtaggal @, például:

{
  "apiCenterMinimalPermissionsPlugin": {
    "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v1.0.0/apicenterminimalpermissionsplugin.schema.json",
    "subscriptionId": "@AZURE_SUBSCRIPTION_ID",
    "resourceGroupName": "@AZURE_RESOURCE_GROUP_NAME",
    "serviceName": "@AZURE_APIC_INSTANCE_NAME",
    "workspaceName": "@AZURE_APIC_WORKSPACE_NAME"
  }
}

Ebben a példában a ApiCenterMinimalPermissionsPlugin beépülő modul a subscriptionIdresourceGroupNameserviceName, workspaceNameAZURE_SUBSCRIPTION_IDés AZURE_RESOURCE_GROUP_NAMEAZURE_APIC_INSTANCE_NAME a környezeti változók értékeire állítja be a AZURE_APIC_WORKSPACE_NAMEtulajdonságokat.

API-engedélyek definiálása

A ApiCenterMinimalPermissionsPlugin beépülő modul támogatja az OAuth-engedélyek ellenőrzését az Azure API Centerben regisztrált OAuthtal védett API-khoz. A beépülő modul az API Center információi alapján kiszámítja az alkalmazásban használt API-k meghívásához szükséges minimális engedélyeket. Ezután a beépülő modul összehasonlítja a JSON webes jogkivonatban (JWT) használt engedélyeket a Dev Proxy által rögzített kérésekhez szükséges minimálisan szükséges hatókörökhöz.

Az API-k engedélyeinek meghatározásához adja meg őket az API OpenAPI-definíciójában. Az alábbi példa bemutatja, hogyan definiálhat engedélyeket egy API-hoz egy OpenAPI-definícióban:

{
  "openapi": "3.0.1",
  "info": {
    "title": "Northwind API",
    "description": "Northwind API",
    "version": "v1.0"
  },
  "servers": [
    {
      "url": "https://api.northwind.com"
    }
  ],
  "components": {
    "securitySchemes": {
      "OAuth2": {
        "type": "oauth2",
        "flows": {
          "authorizationCode": {
            "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
            "tokenUrl": "https://login.microsoftonline.com/common/oauth2/token",
            "scopes": {
              "customer.read": "Grants access to ready customer info",
              "customer.readwrite": "Grants access to read and write customer info"
            }
          }
        }
      }
    },
    "schemas": {
      "Customer": {
        "type": "object",
        // [...] trimmed for brevity
      }
    }
  },
  "paths": {
    "/customers/{customers-id}": {
      "description": "Provides operations to manage a customer",
      "get": {
        "summary": "Get customer by ID",
        "operationId": "getCustomerById",
        "security": [
          {
            "OAuth2": [
              "customer.read"
            ]
          },
          {
            "OAuth2": [
              "customer.readwrite"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json; charset=utf-8": {
                "schema": {
                  "$ref": "#/components/schemas/Customer"
                }
              }
            }
          }
        }
      },
      "patch": {
        "summary": "Update customer by ID",
        "operationId": "updateCustomerById",
        "security": [
          {
            "OAuth2": [
              "customer.readwrite"
            ]
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Customer"
              }
            }
          }
        },
        "responses": {
          "204": {
            "description": "No Content"
          }
        }
      },
      "parameters": [
        {
          "name": "customers-id",
          "in": "path",
          "required": true,
          "schema": {
            "type": "string"
          }
        }
      ]
    }
  },
  "x-ms-generated-by": {
    "toolName": "Dev Proxy",
    "toolVersion": "0.27.0"
  }
}

A vonatkozó rész az a securitySchemes szakasz, amelyben az API által használt OAuth-hatóköröket határozza meg. Ezután minden művelethez be kell foglalnia a szükséges hatóköröket a security szakaszba.

További információ

Következő lépés

Annak ellenőrzése, hogy az alkalmazásom minimális engedélyekkel hív-e API-kat

  • Last updated on