Iniciar sessão em MSAL para iOS/macOS

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.

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 de log. As mensagens de registo de todos os níveis serão registadas.
• Crítico: Registos que descrevem uma falha de aplicação ou sistema irrecuperável, ou uma falha catastrófica que requer atenção imediata.
• Erro: Indica que algo correu mal e foi gerado um erro. Usado para depuração e identificação de problemas.
• Aviso: Não houve necessariamente um erro ou falha, mas destinam-se a diagnósticos e à identificação de problemas.
• Informativo: O MSAL regista eventos para fins informativos, não necessariamente para depuração.
• Verbose (Predefinição): 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.

/*!
    The LogCallback block for the MSAL logger

    @param  level           The level of the log message
    @param  message         The message being logged
    @param  containsPII     If the message might contain Personally Identifiable Information (PII)
                            this will be true. Log messages possibly containing PII will not be
                            sent to the callback unless PIllLoggingEnabled is set to YES on the
                            logger.

 */
typedef void (^MSALLogCallback)(MSALLogLevel level, NSString *message, BOOL containsPII);

[MSALGlobalConfig.loggerConfig setLogCallback:^(MSALLogLevel level, NSString *message, BOOL containsPII)
    {
        if (!containsPII)
        {
#if DEBUG
            // IMPORTANT: MSAL logs may contain sensitive information. Never output MSAL logs with NSLog, or print, directly unless you're running your application in debug mode. If you're writing MSAL logs to file, you must store the file securely.
            NSLog(@"MSAL log: %@", message);
#endif
        }
    }];

// By default, the `MSALLogger` doesn't capture any PII

// PII will be logged
MSALGlobalConfig.loggerConfig.piiEnabled = YES;

// PII will NOT be logged
MSALGlobalConfig.loggerConfig.piiEnabled = NO;

MSALGlobalConfig.loggerConfig.logLevel = MSALLogLevelVerbose;

/*!
    The LogCallback block for the MSAL logger

    @param  level           The level of the log message
    @param  message         The message being logged
    @param  containsPII     If the message might contain Personally Identifiable Information (PII)
                            this will be true. Log messages possibly containing PII will not be
                            sent to the callback unless PIllLoggingEnabled is set to YES on the
                            logger.

 */
typedef void (^MSALLogCallback)(MSALLogLevel level, NSString *message, BOOL containsPII);

MSALGlobalConfig.loggerConfig.setLogCallback { (level, message, containsPII) in
    if let message = message, !containsPII
    {
#if DEBUG
    // IMPORTANT: MSAL logs may contain sensitive information. Never output MSAL logs with NSLog, or print, directly unless you're running your application in debug mode. If you're writing MSAL logs to file, you must store the file securely.
    print("MSAL log: \(message)")
#endif
    }
}

// By default, the `MSALLogger` doesn't capture any PII

// PII will be logged
MSALGlobalConfig.loggerConfig.piiEnabled = true

// PII will NOT be logged
MSALGlobalConfig.loggerConfig.piiEnabled = false

MSALGlobalConfig.loggerConfig.logLevel = .verbose

Passos seguintes

Para mais exemplos de código, consulte exemplos de código da plataforma de identidades da Microsoft.