Aanmelden bij MSAL voor Java

De Microsoft Authentication Library-apps (MSAL) genereren logboekberichten waarmee problemen kunnen worden vastgesteld. Een app kan logboekregistratie met een paar regels code configureren en aangepaste controle hebben over het detailniveau en of persoonlijke en organisatorische gegevens al dan niet worden vastgelegd. U wordt aangeraden een IMPLEMENTATIE van MSAL-logboekregistratie te maken en gebruikers een manier te bieden om logboeken in te dienen wanneer ze verificatieproblemen ondervinden.

Logboekregistratieniveaus

MSAL biedt verschillende niveaus van logboekregistratiedetails:

  • LogAlways: Er wordt geen niveaufiltering uitgevoerd op dit logboekniveau. Logboekberichten van alle niveaus worden vastgelegd.
  • Critical: Logboeken die een onherstelbare toepassing of systeemcrash beschrijven, of een onherstelbare fout waarvoor onmiddellijke aandacht is vereist.
  • Error: Geeft aan dat er iets mis is gegaan en er een fout is gegenereerd. Wordt gebruikt voor foutopsporing en het identificeren van problemen.
  • Warning: Er is niet noodzakelijkerwijs sprake van een fout of storing, maar ze zijn bedoeld voor diagnose en het opsporen van problemen.
  • Informational: MSAL zal gebeurtenissen vastleggen die zijn bedoeld voor informatieve doeleinden, niet noodzakelijkerwijs bedoeld voor foutopsporing.
  • Verbose (Standaard): MSAL registreert de volledige details van het gedrag van de bibliotheek.

Note

Niet alle logboekniveaus zijn beschikbaar voor alle MSAL SDK's.

Persoonlijke en organisatorische gegevens

Standaard legt de MSAL-logboekregistratie geen zeer gevoelige persoonlijke of organisatorische gegevens vast. De bibliotheek biedt de optie om persoonlijke en organisatiegegevens in te schakelen als u dit wilt doen.

In de volgende secties vindt u meer informatie over MSAL-foutenlogboekregistratie voor uw toepassing.

MSAL voor Java logboekregistratie

Met MSAL voor Java kunt u de logboekbibliotheek gebruiken die u al met uw app gebruikt, zolang deze compatibel is met Simple Logging Facade voor Java (SLF4J). MSAL voor Java maakt gebruik van de SLF4J als een eenvoudige abstractie voor verschillende frameworks voor logboekregistratie, zoals java.util.logging, Logback en Log4j. Met SLF4J kan de gebruiker het gewenste logboekregistratieframework op het moment van de implementatie aansluiten en automatisch binden aan Logback tijdens de implementatie. MSAL-logboeken worden naar de console geschreven. In dit artikel wordt beschreven hoe u MSAL4J-logboekregistratie inschakelt met behulp van het logback-framework in een Spring Boot-webtoepassing.

  1. Als u logboekregistratie wilt implementeren, neemt u het logback pakket op in pom.xml.

    <dependency>
    <groupId>ch.qos.logback</groupId>
    <artifactId>logback-classic</artifactId>
    <version>1.2.3</version>
</dependency>

  2. Navigeer naar de map en voeg een bestand toe met de resources naam logback.xmlen voeg de volgende code in. Hiermee worden logboeken toegevoegd aan de console. U kunt de toevoegfunctie class wijzigen om logboeken te schrijven naar een bestand, database of een toevoegprogramma van uw keuze.

    <?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
        </encoder>
    </appender>
    <root level="debug">
        <appender-ref ref="STDOUT" />
    </root>    
</configuration>

  3. Stel de logging.config eigenschap in op de locatie van het logback.xml bestand vóór de hoofdmethode. Navigeer naar MsalWebSampleApplication.java en voeg de volgende code toe aan de MsalWebSampleApplication openbare klasse.

    @SpringBootApplication
public class MsalWebSampleApplication {

    static { System.setProperty("logging.config", "C:\Users\<your path>\src\main\resources\logback.xml"); }
    public static void main(String[] arrgs) {
        // Console.log("main");
        // System.console().printf("Hello");
        // System.out.printf("Hello %s!%n", "World");
        System.out.printf("%s%n", "Hello World");
        SpringApplication.run(MsalWebSampleApplication.class, args);
    }
}

In uw tenant hebt u afzonderlijke app-registraties nodig voor de web-app en de web-API. Volg de stappen in het scenario Een web-app die gebruikers verifieert en web-API's aanroept voor app-registratie en het blootstellen van het web-API-bereik.

Zie de SLF4J-documentatie voor instructies over het binden aan andere frameworks voor logboekregistratie.

Persoonlijke en organisatiegegevens

Standaard legt MSAL geen persoonlijke gegevens of gegevens van organisaties vast en worden deze ook niet gelogd. In het volgende voorbeeld is het vastleggen van persoonlijke of organisatiegegevens standaard uitgeschakeld:

PublicClientApplication app2 = PublicClientApplication.builder(PUBLIC_CLIENT_ID)
        .authority(AUTHORITY)
        .build();

Schakel logregistratie van persoonlijke en organisatorische gegevens in door logPii() in te stellen in de builder voor de clienttoepassing. Als u logboekregistratie van persoonlijke of organisatorische gegevens inschakelt, moet uw app verantwoordelijk zijn voor het veilig verwerken van zeer gevoelige gegevens en het voldoen aan alle wettelijke vereisten.

In het volgende voorbeeld is het registreren van persoonlijke of organisatiegegevens ingeschakeld:

PublicClientApplication app2 = PublicClientApplication.builder(PUBLIC_CLIENT_ID)
        .authority(AUTHORITY)
        .logPii(true)
        .build();

Volgende stappen 

Raadpleeg Microsoft identity platform codevoorbeelden voor meer codevoorbeelden.

  • Last updated on