Megosztás:

MinimalPermissionsPlugin

Észleli a megadott API-műveletek végrehajtásához szükséges minimális engedélyeket. A megadott helyi mappából származó API-információkat 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": "MinimalPermissionsPlugin",
  "enabled": true,
  "pluginPath": "~appFolder/plugins/DevProxy.Plugins.dll",
  "configSection": "minimalPermissionsPlugin"
}

Példa konfigurációra

{
  "minimalPermissionsPlugin": {
    "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v1.0.0/minimalpermissionsplugin.schema.json",
    "apiSpecsFolderPath": "./api-specs"
  }
}

Konfigurációs tulajdonságok

Tulajdonság Leírás Alapértelmezett
apiSpecsFolderPath A mappa relatív vagy abszolút elérési útja API-specifikációkkal Egyik sem
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 MinimalPermissionsPlugin 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 helyi mappában található API-kkal kapcsolatos információkat használja.

API-engedélyek definiálása

A MinimalPermissionsPlugin beépülő modul támogatja az OAuth által védett API-k OAuth-engedélyeinek ellenőrzését. A beépülő modul kiszámítja az alkalmazásban használt API-k meghívásához szükséges minimális engedélyeket a megadott API-specifikációkból származó információk alapján.

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.22.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.

Változók cseréje API-specifikációkban

Egyes API-specifikációk változókat tartalmazhatnak a kiszolgáló URL-címeiben. A változók használata gyakori eljárás különböző környezetek (például fejlesztés, előkészítés, éles környezet), API-verziók vagy bérlők elhelyezésére. A változóval rendelkező URL-címek a következőképpen néznek ki:

openapi: 3.0.4
info:
  title: SharePoint REST API
  description: SharePoint REST API
  version: v1.0
servers:
  - url: https://{tenant}.sharepoint.com
    variables:
      tenant:
        default: contoso

A MinimalPermissionsPlugin beépülő modul támogatja a változók cseréjét az API specifikációinak tartalmában. Egy változó cseréjéhez indítsa el a Dev Proxyt a --env beállítással, és adja meg a változó nevét és értékét. Ha például a változót tenantcontosoa következő paranccsal szeretné lecserélni:

devproxy --env tenant=northwind

Ez a parancs az tenant API-specifikációkban szereplő változót az értékre northwindcseréli. A beépülő modul a lecserélt URL-cím használatával ellenőrzi, hogy az alkalmazás minimális engedélyekkel hívja-e meg az API-kat.

További információ

  • Last updated on