Partilhar via

AuthPlugin

  • Artigo

Simula autenticação e autorização usando chaves de API ou OAuth2.

Captura de ecrã de uma linha de comandos com Proxy de Desenvolvimento a simular a autenticação utilizando a chave de API numa Função do Azure em execução local.

Definição de instância de plug-in

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

Exemplo de configuração: chave de API

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

Exemplo de configuração: 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/00000000-0000-0000-0000-000000000000/v2.0",
      "scopes": [
        "Posts.Read"
      ],
      "validateLifetime": true,
      "validateSigningKey": true
    }
  }
}

Propriedades de configuração

Property Descrição Obrigatório
type Tipo de autenticação e autorização que o Dev Proxy deve usar. Valores permitidos: apiKey, oauth2 Sim
apiKey Configuração para autenticação e autorização de chave de API. Sim, quando type é apiKey
oauth2 Configuração para autenticação e autorização OAuth2. Sim, quando type é oauth2

Propriedades de configuração de chave de API

Property Descrição Obrigatório
allowedKeys Lista de chaves de API permitidas. Sim
parameters Lista de parâmetros que contêm a chave da API. Sim

Propriedades de configuração de parâmetros

Property Descrição Obrigatório
in Onde se espera que o parâmetro seja encontrado. Valores permitidos: header, query, cookie Sim
name Nome do parâmetro. Sim

Propriedades de configuração do OAuth2

Property Descrição Obrigatório
metadataUrl URL para o documento de metadados do OpenID Connect. Sim
allowedApplications Lista de IDs de aplicativo permitidos. Deixe em branco para não validar o aplicativo (appid ou azp declaração) para o qual o token é emitido. Não
allowedAudiences Lista de públicos permitidos. Deixe em branco para não validar a audiência (aud declaração) para a qual o token é emitido. Não
allowedPrincipals Lista de entidades autorizadas. Deixe em branco para não validar o principal (oid declaração) para o qual o token é emitido. Não
allowedTenants Lista de inquilinos permitidos. Deixe em branco para não validar o inquilino (tid declaração) para o qual o token é emitido. Não
issuer Emissor de token permitido. Deixe em branco para não validar o emissor do token. Não
roles Lista de funções permitidas. Deixe em branco para não validar as funções (roles declaração) no token. Não
scopes Lista de escopos permitidos. Deixe em branco para não validar os escopos (scp declaração) no token. Não
validateLifetime Defina como false para desativar a validação do tempo de vida do token. Padrão true. Não
validateSigningKey Defina como false para desativar a validação da assinatura de token. Inadimplência true Não

Opções de linha de comando

Nenhuma