Microsoft Information Protection SDK - concepten voor profiel- en engineobjecten

Profielen

In de MipContext klasse worden SDK-specifieke instellingen opgeslagen. Het profiel is de hoofdklasse voor alle MIP-labels en beveiligingsspecifieke bewerkingen in de MIP SDK. Voordat u een van de drie API-sets gebruikt, moet de clienttoepassing een profiel maken. Het profiel of andere objecten die aan het profiel zijn toegevoegd , voeren toekomstige bewerkingen uit. Gebruik slechts één profielobject per proces. Het maken van meer dan één kan leiden tot onverwacht gedrag.

De MIP SDK heeft drie typen profielen:

De API die door de verbruikende toepassing wordt gebruikt, bepaalt welke profielklasse moet worden gebruikt.

Het profiel zelf biedt de volgende functionaliteit:

  • Statusopslag: definieert of de status in het geheugen moet worden geladen of op de schijf moet worden bewaard en of de status moet worden versleuteld als deze op schijf wordt bewaard.
  • Toestemmingsgedelegeerde: hiermee wordt de mip::ConsentDelegate gedefinieerd die voor toestemmingbewerkingen wordt gebruikt.
  • Waarnemer van bestandsprofielen: definieert de mip::FileProfile::Observer implementatie die moet worden gebruikt voor asynchrone callbacks voor profielbewerkingen.

Profielinstellingen

  • MipContext: Het MipContext object dat is geïnitialiseerd voor het opslaan van toepassingsgegevens, het statuspad, enzovoort.
  • CacheStorageType: Definieert hoe de status moet worden opgeslagen: In het geheugen, op schijf of op schijf en versleuteld.
  • consentDelegate: Een gedeelde aanwijzer van klasse mip::ConsentDelegate.
  • observer: Een gedeelde aanwijzer naar de profiel-implementatie Observer (in PolicyProfile, ProtectionProfileen FileProfile).
  • applicationInfo: Een mip::ApplicationInfo object. Informatie over de toepassing die de SDK gebruikt en overeenkomt met uw Microsoft Entra toepassingsregistratie-id en -naam.

Motoren

De SDK-engines voor bestand, beleid en beveiliging bieden een interface voor bewerkingen die door een specifieke identiteit worden uitgevoerd. Voeg één engine toe aan het profielobject voor elke gebruiker of service-principal die zich aanmeldt bij de toepassing. U kunt gedelegeerde bewerkingen uitvoeren met behulp van mip::ProtectionSettings de bestands- of beveiligingshandler. Zie de sectie beveiligingsinstellingen in de Concepten van FileHandler voor meer informatie.

De SDK heeft drie engineklassen, één voor elke API. De volgende lijst bevat de engineklassen en enkele van de functies die aan elk zijn gekoppeld:

  • mip::ProtectionEngine
  • mip::PolicyEngine
    • ListSensitivityLabels(): Haalt de lijst met labels voor de geladen engine op.
    • GetSensitivityLabel(): Haalt het label op van bestaande inhoud.
    • ComputeActions(): Opgegeven met een label-id en optionele metagegevens, retourneert de lijst met acties die moeten worden uitgevoerd voor een specifiek item.
  • mip::FileEngine
    • ListSensitivityLabels(): Haalt de lijst met labels voor de geladen engine op.
    • CreateFileHandler(): Hiermee maakt u een mip::FileHandler voor een specifiek bestand of een specifieke stream.

Als u een engine wilt maken, geeft u een specifiek engineinstellingenobject door dat de instellingen bevat voor het type engine dat moet worden gemaakt. Met het instellingenobject kan de ontwikkelaar details opgeven over de engine-id, de implementatie, landinstellingen mip::AuthDelegate , aangepaste instellingen en andere API-specifieke details.

Motorstatussen

Een engine kan een van de volgende twee statussen hebben:

  • CREATED: Gemaakt geeft aan dat de SDK voldoende lokale statusgegevens heeft nadat de vereiste back-endservices zijn aangeroepen.
  • LOADED: De SDK heeft de vereiste gegevensstructuren gebouwd om de engine operationeel te maken.

Een engine moet zowel worden gemaakt als geladen om bewerkingen uit te voeren. De Profile klasse bevat enkele methoden voor enginebeheer: AddEngineAsync, DeleteEngineAsyncen UnloadEngineAsync.

In de volgende tabel worden de mogelijke enginestatussen beschreven en welke methoden die status kunnen wijzigen:

Motorstatus GEEN GEMAAKT GELADEN
GEEN AddEngineAsync
GEMAAKT VerwijderEngineAsync AddEngineAsync
GELADEN VerwijderEngineAsync UnloadEngineAsync

Engine-ID

Elke engine heeft een unieke id, iddie wordt gebruikt in alle enginebeheerbewerkingen. De toepassing kan een id. Als de toepassing er geen biedt, kan de SDK deze genereren. Alle andere eigenschappen van de engine, zoals het e-mailadres in de identiteitsgegevens, zijn opaque gegevens voor de SDK. De SDK voert geen logica uit om andere eigenschappen uniek te houden of andere beperkingen af te dwingen.

Belangrijk

Gebruik een engine-id die uniek is voor de gebruiker en gebruik die engine-id telkens wanneer de gebruiker een bewerking uitvoert met de SDK. Als u geen bestaande, unieke engine-ID voor een gebruiker of een service opgeeft, voert de SDK extra heen-en-weeraanvragen naar de service uit. Deze roundtrips naar services kunnen leiden tot prestatieverlies en snelheidsbeperking.

// Create the FileEngineSettings object
FileEngine::Settings engineSettings(mip::Identity(mUsername), // This will be the engine ID. UPN, email address, or other unique user identifiers are recommended. 
													          mAuthDelegate,            // authDelegate implementation 
													          "",                       // ClientData
													          "en-US",                  // Client Locale
                                    false);                   // Load Sensitive Information Types

Methoden voor enginebeheer

De SDK heeft drie methoden voor enginebeheer: AddEngineAsync, DeleteEngineAsyncen UnloadEngineAsync.

AddEngineAsync

Met deze methode wordt een bestaande engine geladen of wordt er een gemaakt als deze nog niet bestaat in de lokale status.

Als de toepassing geen id in FileEngineSettings opgeeft, genereert AddEngineAsync een nieuwe id. Vervolgens wordt gecontroleerd of er al een engine met die id bestaat in de lokale opslag. Als dat het geval is, wordt die motor geladen. Als de engine niet in de lokale cache bestaat, wordt er een nieuwe engine gemaakt door de benodigde API's en back-endservices aan te roepen.

Als de methode slaagt, wordt de engine in beide gevallen geladen en klaar voor gebruik.

VerwijderEngineAsync

Verwijdert de motor met de opgegeven id. Alle traceringen van de engine worden verwijderd uit de lokale cache.

UnloadEngineAsync

Laadt de in-memory gegevensstructuren van de engine met de opgegeven id uit. De lokale status van deze engine blijft intact en u kunt deze opnieuw laden met AddEngineAsync.

Met deze methode kan de toepassing voorzichtig zijn met geheugengebruik door motoren te lossen die niet snel worden gebruikt.

Volgende stappen 

  • Last updated on