Partilhar via

Configuração baseada em arquivo na autenticação do Serviço de Aplicativo do Azure

  • Artigo

Com a autenticação do Serviço de Aplicativo, as configurações de autenticação podem ser definidas com um arquivo. Talvez seja necessário usar a configuração baseada em arquivo para usar certos recursos de visualização de autenticação/autorização do Serviço de Aplicativo antes que eles sejam expostos por meio das APIs do Azure Resource Manager .

Importante

Lembre-se de que a carga útil do aplicativo e, portanto, esse arquivo, podem se mover entre ambientes, como acontece com os slots. É provável que você queira um registro de aplicativo diferente fixado em cada slot e, nesses casos, você deve continuar a usar o método de configuração padrão em vez de usar o arquivo de configuração.

Habilitando a configuração baseada em arquivo

  1. Crie um novo arquivo JSON para sua configuração na raiz do seu projeto (implantado em C:\home\site\wwwroot em seu aplicativo web / função). Preencha a configuração desejada de acordo com a referência de configuração baseada em arquivo. Se estiver modificando uma configuração existente do authsettings Azure Resource Manager, certifique-se de traduzir as propriedades capturadas na coleção em seu arquivo de configuração.

  2. Modifique a configuração existente, que é capturada nas APIs do Azure Resource Manager em Microsoft.Web/sites/<siteName>/config/authsettingsV2. Para modificá-lo, você pode usar um modelo do Azure Resource Manager ou uma ferramenta como o Azure Resource Explorer. Dentro da coleção authsettingsV2, defina duas propriedades (você pode remover outras):

    1. Definir platform.enabled como "true"
    2. Defina platform.configFilePath como o nome do arquivo (por exemplo, "auth.json")

Nota

O formato varia platform.configFilePath entre plataformas. No Windows, há suporte para caminhos relativos e absolutos. Relativo é recomendado. Para Linux, apenas caminhos absolutos são suportados atualmente, então o valor da configuração deve ser "/home/site/wwwroot/auth.json" ou similar.

Depois de fazer essa atualização de configuração, o conteúdo do arquivo será usado para definir o comportamento da Autenticação/Autorização do Serviço de Aplicativo para esse site. Se desejar retornar à configuração do Azure Resource Manager, você poderá fazê-lo removendo a alteração da configuração platform.configFilePath para null.

Referência do arquivo de configuração

Quaisquer segredos que serão referenciados a partir do seu arquivo de configuração devem ser armazenados como configurações do aplicativo. Você pode nomear as configurações como quiser. Apenas certifique-se de que as referências do arquivo de configuração usam as mesmas chaves.

O seguinte esgota as opções de configuração possíveis dentro do arquivo:

{
    "platform": {
        "enabled": <true|false>
    },
    "globalValidation": {
        "unauthenticatedClientAction": "RedirectToLoginPage|AllowAnonymous|RejectWith401|RejectWith404",
        "redirectToProvider": "<default provider alias>",
        "excludedPaths": [
            "/path1",
            "/path2",
            "/path3/subpath/*"
        ]
    },
    "httpSettings": {
        "requireHttps": <true|false>,
        "routes": {
            "apiPrefix": "<api prefix>"
        },
        "forwardProxy": {
            "convention": "NoProxy|Standard|Custom",
            "customHostHeaderName": "<host header value>",
            "customProtoHeaderName": "<proto header value>"
        }
    },
    "login": {
        "routes": {
            "logoutEndpoint": "<logout endpoint>"
        },
        "tokenStore": {
            "enabled": <true|false>,
            "tokenRefreshExtensionHours": "<double>",
            "fileSystem": {
                "directory": "<directory to store the tokens in if using a file system token store (default)>"
            },
            "azureBlobStorage": {
                "sasUrlSettingName": "<app setting name containing the sas url for the Azure Blob Storage if opting to use that for a token store>"
            }
        },
        "preserveUrlFragmentsForLogins": <true|false>,
        "allowedExternalRedirectUrls": [
            "https://uri1.azurewebsites.net/",
            "https://uri2.azurewebsites.net/",
            "url_scheme_of_your_app://easyauth.callback"
        ],
        "cookieExpiration": {
            "convention": "FixedTime|IdentityDerived",
            "timeToExpiration": "<timespan>"
        },
        "nonce": {
            "validateNonce": <true|false>,
            "nonceExpirationInterval": "<timespan>"
        }
    },
    "identityProviders": {
        "azureActiveDirectory": {
            "enabled": <true|false>,
            "registration": {
                "openIdIssuer": "<issuer url>",
                "clientId": "<app id>",
                "clientSecretSettingName": "APP_SETTING_CONTAINING_AAD_SECRET",
            },
            "login": {
                "loginParameters": [
                    "paramName1=value1",
                    "paramName2=value2"
                ]
            },
            "validation": {
                "allowedAudiences": [
                    "audience1",
                    "audience2"
                ]
            }
        },
        "facebook": {
            "enabled": <true|false>,
            "registration": {
                "appId": "<app id>",
                "appSecretSettingName": "APP_SETTING_CONTAINING_FACEBOOK_SECRET"
            },
            "graphApiVersion": "v3.3",
            "login": {
                "scopes": [
                    "public_profile",
                    "email"
                ]
            },
        },
        "gitHub": {
            "enabled": <true|false>,
            "registration": {
                "clientId": "<client id>",
                "clientSecretSettingName": "APP_SETTING_CONTAINING_GITHUB_SECRET"
            },
            "login": {
                "scopes": [
                    "profile",
                    "email"
                ]
            }
        },
        "google": {
            "enabled": true,
            "registration": {
                "clientId": "<client id>",
                "clientSecretSettingName": "APP_SETTING_CONTAINING_GOOGLE_SECRET"
            },
            "login": {
                "scopes": [
                    "profile",
                    "email"
                ]
            },
            "validation": {
                "allowedAudiences": [
                    "audience1",
                    "audience2"
                ]
            }
        },
        "twitter": {
            "enabled": <true|false>,
            "registration": {
                "consumerKey": "<consumer key>",
                "consumerSecretSettingName": "APP_SETTING_CONTAINING TWITTER_CONSUMER_SECRET"
            }
        },
        "apple": {
            "enabled": <true|false>,
            "registration": {
                "clientId": "<client id>",
                "clientSecretSettingName": "APP_SETTING_CONTAINING_APPLE_SECRET"
            },
            "login": {
                "scopes": [
                    "profile",
                    "email"
                ]
            }
        },
        "openIdConnectProviders": {
            "<providerName>": {
                "enabled": <true|false>,
                "registration": {
                    "clientId": "<client id>",
                    "clientCredential": {
                        "clientSecretSettingName": "<name of app setting containing client secret>"
                    },
                    "openIdConnectConfiguration": {
                        "authorizationEndpoint": "<url specifying authorization endpoint>",
                        "tokenEndpoint": "<url specifying token endpoint>",
                        "issuer": "<url specifying issuer>",
                        "certificationUri": "<url specifying jwks endpoint>",
                        "wellKnownOpenIdConfiguration": "<url specifying .well-known/open-id-configuration endpoint - if this property is set, the other properties of this object are ignored, and authorizationEndpoint, tokenEndpoint, issuer, and certificationUri are set to the corresponding values listed at this endpoint>"
                    }
                },
                "login": {
                    "nameClaimType": "<name of claim containing name>",
                    "scopes": [
                        "openid",
                        "profile",
                        "email"
                    ],
                    "loginParameterNames": [
                        "paramName1=value1",
                        "paramName2=value2"
                    ],
                }
            },
            //...
        }
    }
}

Mais recursos