Início de sessão no MSAL para Python

As aplicações Biblioteca de Autenticação da Microsoft (MSAL) geram mensagens de registo que podem ajudar a diagnosticar problemas. Uma aplicação pode configurar registos com algumas linhas de código e ter controlo personalizado sobre o nível de detalhe e se os dados pessoais e organizacionais são registados ou não. Recomendamos que crie uma implementação de registo MSAL e forneça uma forma para os utilizadores submeterem registos quando tiverem problemas de autenticação.

Login em MSAL Python foi concebido para usar os mecanismos padrão de logging em Python, por isso todo o teu conhecimento prévio de logging em Python aplica-se ao MSAL Python.

• Por predefinição, o registo em qualquer script em Python está desativado. Se quiseres ativar o registo de debug para TODOS os módulos em todo o teu script Python, usas logging.basicConfig(level=logging.DEBUG).
• A maioria dos registos do MSAL Python já está no nível de depuração, que está desativado por predefinição. Mas se quiseres ativar o registo de depuração para depurar os OUTROS módulos no teu script Python, e portanto quiseres silenciar o MSAL, basta desligar o logger usado pelo MSAL Python: logging.getLogger("msal").setLevel(logging.WARN).
• O MSAL Python não regista Informações Pessoais Identificáveis (PII). Portanto, nem sequer existe uma opção para ativar o registo de PII no MSAL Python. Os programadores de aplicações ainda podiam usar o registo padrão em Python para registar qualquer conteúdo. Ao fazê-lo, a aplicação assume a responsabilidade de lidar com dados altamente sensíveis de forma segura e de cumprir os requisitos regulamentares.

Níveis de registo

O MSAL fornece vários níveis de detalhe de registo:

• LogAlways: Não é feita filtragem de nível neste nível logarítmico. As mensagens de registo de todos os níveis serão registadas.
• Critical: Registos que descrevem uma falha de aplicação ou sistema irrecuperável, ou uma falha catastrófica que requer atenção imediata.
• Error: Indica que algo correu mal e foi gerado um erro. Usado para depuração e identificação de problemas.
• Warning: Não houve necessariamente um erro ou falha, mas destinam-se a diagnósticos e à identificação de problemas.
• Informational: O MSAL regista eventos para fins informativos, não necessariamente para depuração.
• Verbose (Padrão): MSAL regista todos os detalhes do comportamento da biblioteca.

Dados pessoais e organizacionais

Por predefinição, o sistema de registo do MSAL não captura dados pessoais nem organizacionais de elevada sensibilidade. A biblioteca oferece a opção de permitir o registo de dados pessoais e organizacionais, caso assim o decida.

As secções seguintes fornecem mais detalhes sobre o registo de erros MSAL para a sua aplicação.

MSAL para registo em Python

O login em MSAL para Python utiliza o módulo de registo na biblioteca padrão Python. Pode configurar o registo MSAL da seguinte forma (e vê-lo em ação na username_password_sample):

Ativar o registo de depuração para todos os módulos

Por predefinição, o registo em qualquer script em Python está desativado. Se quiseres ativar o verbose logging para todos os módulos Python no teu script, usa logging.basicConfig com um nível delogging.DEBUG:

import logging

logging.basicConfig(level=logging.DEBUG)

Isto imprimirá todas as mensagens de registo atribuídas ao módulo de registo para a saída padrão.

Configurar o nível de registo da MSAL

Pode configurar o nível de registo do fornecedor de registo do MSAL para Python utilizando o método logging.getLogger() com o nome do registador "msal":

import logging

logging.getLogger("msal").setLevel(logging.WARN)

Configurar os registos do MSAL com o Aplicação Azure ADlication Insights

Os logs em Python são dados a um tratador de logs, que por defeito é o StreamHandler. Para enviar registos do MSAL para o Application Insights com uma chave de instrumentação, utilize o AzureLogHandler fornecido pela biblioteca opencensus-ext-azure.

Para instalar, opencensus-ext-azure adicione o pacote opencensus-ext-azure do PyPI às suas dependências ou instale via pip:

pip install opencensus-ext-azure

Depois, altere o handler padrão do "msal" fornecedor de log para uma instância de AzureLogHandler com uma chave de instrumentação definida na APP_INSIGHTS_KEY variável de ambiente:

import logging
import os

from opencensus.ext.azure.log_exporter import AzureLogHandler

APP_INSIGHTS_KEY = os.getenv('APP_INSIGHTS_KEY')

logging.getLogger("msal").addHandler(AzureLogHandler(connection_string='InstrumentationKey={0}'.format(APP_INSIGHTS_KEY)))

Dados pessoais e organizacionais em Python

O MSAL para Python não regista dados pessoais nem dados organizacionais. Não existe qualquer propriedade para ativar ou desativar o registo de dados pessoais ou empresariais.

Pode usar registos padrão em Python para registar o que quiser, mas é responsável por lidar com dados sensíveis de forma segura e cumprir os requisitos regulamentares.

Para mais informações sobre iniciar sessão em Python, consulte Python's Logging: how-to.