Sdílet prostřednictvím


Rychlý start: Inicializace klientské aplikace (C#)

V tomto rychlém úvodu se dozvíte, jak implementovat vzorec inicializace klienta pomocí obálky .NET ve službě MIP SDK během běhu.

Poznámka:

Kroky popsané v tomto rychlém startu jsou vyžadovány pro všechny klientské aplikace, které používají obálky MIP .NET File, Policy nebo Protection SDK. Ačkoli tento Rychlý start ukazuje použití sad SDK pro soubory, tento vzor platí i pro klienty používající sady SDK pro zásady a ochranu. Budoucí rychlé zahájení by se mělo provádět sériově, protože každý z nich navazuje na předchozí, a tento je první. Tento kód je určený k předvedení toho, jak začít se sadou MIP SDK a není určený pro produkční použití.

Požadavky

Pokud jste to ještě neudělali, nezapomeňte:

Vytvoření řešení a projektu sady Visual Studio

Nejprve vytvoříme a nakonfigurujeme počáteční řešení a projekt sady Visual Studio, na kterém se sestaví další rychlé starty.

  1. Otevřete Visual Studio 2019 a vyberte nabídku Soubor, Nový, Projekt. V dialogovém okně Nový projekt :

    • V levém podokně v části Nainstalováno, Visual C# vyberte Windows Desktop.

    • V prostředním podokně vyberte Konzolová aplikace (.NET Framework)

    • V dolním podokně odpovídajícím způsobem aktualizujte název projektu, umístění a obsahující název řešení .

    • Po dokončení klikněte na tlačítko OK v pravém dolním rohu.

      Vytvoření řešení sady Visual Studio

  2. Do projektu přidejte balíček NuGet pro sadu MIP File SDK:

    • V Průzkumníku řešení klikněte pravým tlačítkem na uzel projektu (přímo pod horním uzlem nebo uzlem řešení) a vyberte Spravovat balíčky NuGet...:
    • Když se v oblasti záložek skupiny editoru otevře záložka Správce balíčků NuGet:
      • Vyberte Procházet.
      • Do vyhledávacího pole zadejte "Microsoft.InformationProtection".
      • Vyberte balíček Microsoft.InformationProtection.File.
      • Po zobrazení potvrzovací dialogového okna Náhled změn klikněte na Instalovat a potom klikněte na OK.
  3. Opakujte výše uvedené kroky pro přidání balíčku MIP File SDK, ale místo toho do aplikace přidejte Microsoft.Identity.Client.

Implementujte delegáta ověřování

Sada MIP SDK implementuje ověřování pomocí rozšiřitelnosti tříd, který poskytuje mechanismus pro sdílení ověřování s klientskou aplikací. Klient musí získat vhodný přístupový token OAuth2 a poskytnout sadě MIP SDK za běhu.

Teď vytvořte implementaci pro delegáta ověřování rozšířením rozhraní sady SDK Microsoft.InformationProtection.IAuthDelegate a přepsáním/implementací IAuthDelegate.AcquireToken() virtuální funkce. Delegát ověřování je vytvořen a později použit objekty FileProfile a FileEngine.

  1. Klikněte pravým tlačítkem myši na název projektu v sadě Visual Studio a vyberte Přidat a potom třídu.

  2. Do pole Název zadejte AuthDelegateImplementation. Klikněte na tlačítko Přidat.

  3. Přidejte příkazy using pro knihovnu MSAL (Microsoft Authentication Library) a knihovnu MIP:

    using Microsoft.InformationProtection;
    using Microsoft.Identity.Client;
    
  4. Nastavte AuthDelegateImplementation tak, aby dědil Microsoft.InformationProtection.IAuthDelegate, a implementujte privátní proměnnou Microsoft.InformationProtection.ApplicationInfo a konstruktor, který přijímá stejný typ.

    public class AuthDelegateImplementation : IAuthDelegate
    {
       private ApplicationInfo _appInfo;
       // Microsoft Authentication Library IPublicClientApplication
       private IPublicClientApplication _app;
       public AuthDelegateImplementation(ApplicationInfo appInfo)
       {
           _appInfo = appInfo;
       }
    
    }
    

    Objekt ApplicationInfo obsahuje tři vlastnosti. _appInfo.ApplicationId bude použito ve třídě AuthDelegateImplementation k poskytnutí ID klienta autentizační knihovně. ApplicationName a ApplicationVersion zobrazí se v sestavách auditu Microsoft Purview.

  5. Přidejte metodu public string AcquireToken() . V případě potřeby by tato metoda měla přijmout Microsoft.InformationProtection.Identity a tři řetězce: adresa URL autority, identifikátor URI prostředku a nároky. Tyto řetězcové proměnné se předají do knihovny ověřování rozhraním API a neměly by být manipulovány. Zadejte identifikátor GUID tenanta z webu Azure Portal pro vašeho tenanta. Úprava jakýchkoliv řetězců kromě GUID klienta může vést k selhání autentizace.

    public string AcquireToken(Identity identity, string authority, string resource, string claims)
    {
       var authorityUri = new Uri(authority);
       authority = String.Format("https://{0}/{1}", authorityUri.Host, "<Tenant-GUID>");
    
       _app = PublicClientApplicationBuilder.Create(_appInfo.ApplicationId).WithAuthority(authority).WithDefaultRedirectUri().Build();
       var accounts = (_app.GetAccountsAsync()).GetAwaiter().GetResult();
    
       // Append .default to the resource passed in to AcquireToken().
       string[] scopes = new string[] { resource[resource.Length - 1].Equals('/') ? $"{resource}.default" : $"{resource}/.default" };
       var result = _app.AcquireTokenInteractive(scopes).WithAccount(accounts.FirstOrDefault()).WithPrompt(Prompt.SelectAccount)
                  .ExecuteAsync().ConfigureAwait(false).GetAwaiter().GetResult();
    
       return result.AccessToken;
    }
    
    

Nyní vytvořte implementaci delegáta souhlasu tím, že rozšíříte rozhraní sady SDK Microsoft.InformationProtection.IConsentDelegate a přepíšete či implementujete GetUserConsent(). Delegát souhlasu je instancován a později použit objekty File Profile a File Engine. Delegát souhlasu je vybaven adresou služby, s jejímž používáním musí uživatel udělit souhlas v parametru url. Delegát by měl obecně poskytnout určitý tok, který uživateli umožní přijmout nebo odmítnout souhlas s přístupem ke službě. Pro tento rychlý úvod natvrdo zakódovat Consent.Accept.

  1. Pomocí stejné funkce Přidat třídu sady Visual Studio, kterou jsme použili dříve, přidejte do projektu další třídu. Nyní zadejte "ConsentDelegateImplementation" do pole Název třídy.

  2. Teď aktualizujte ConsentDelegateImpl.cs , aby implementovali novou třídu delegáta souhlasu. Přidejte příkaz using pro Microsoft.InformationProtection a nastavte třídu tak, aby dědila IConsentDelegate.

    class ConsentDelegateImplementation : IConsentDelegate
    {
         public Consent GetUserConsent(string url)
         {
              return Consent.Accept;
         }
    }
    
  3. Volitelně se pokuste sestavit řešení, aby se zajistilo, že se zkompiluje bez chyb.

Inicializace spravovaného wrapperu MIP SDK

  1. V Průzkumníku řešení otevřete soubor .cs v projektu, který obsahuje implementaci Main() metody. Výchozí název je stejný jako název projektu, ve kterém se nachází, a který jste zadali při vytváření projektu.

  2. Odeberte vygenerovanou implementaci main().

  3. Spravovaná obálka obsahuje statickou třídu Microsoft.InformationProtection.MIP, která se používá k inicializaci, vytvoření instance MipContext, načítání profilů a uvolnění prostředků. Chcete-li inicializovat obálku pro operace se sadou File SDK, zavolejte MIP.Initialize() a předejte MipComponent.File ke načtení knihoven potřebných pro operace se soubory.

  4. V Main()Program.cs přidejte následující kód a nahraďte< ID> aplikace ID registrace aplikace Microsoft Entra vytvořené dříve.

using System;
using System.Threading.Tasks;
using Microsoft.InformationProtection;
using Microsoft.InformationProtection.Exceptions;
using Microsoft.InformationProtection.File;
using Microsoft.InformationProtection.Protection;

namespace mip_sdk_dotnet_quickstart
{
    class Program
    {
        private const string clientId = "<application-id>";
        private const string appName = "<friendly-name>";

        static void Main(string[] args)
        {
            //Initialize Wrapper for File SDK operations
            MIP.Initialize(MipComponent.File);
            
        }
    }
}

Vytvořte profil souboru a motor.

Jak už bylo zmíněno, objekty profilu a modulu jsou vyžadovány pro klienty sady SDK pomocí rozhraní API MIP. Dokončete programovací část tohoto návodu přidáním kódu pro načtení nativních knihoven DLL, poté vytvořte instanci objektů profilu a enginu.

using System;
using System.Threading.Tasks;
using Microsoft.InformationProtection;
using Microsoft.InformationProtection.File;

namespace mip_sdk_dotnet_quickstart
{
  class Program
  {
       private const string clientId = "<application-id>";
       private const string appName = "<friendly-name>";

       static void Main(string[] args)
       {
            // Initialize Wrapper for File SDK operations.
            MIP.Initialize(MipComponent.File);

            // Create ApplicationInfo, setting the clientID from Microsoft Entra App Registration as the ApplicationId.
            ApplicationInfo appInfo = new ApplicationInfo()
            {
                 ApplicationId = clientId,
                 ApplicationName = appName,
                 ApplicationVersion = "1.0.0"
            };

            // Instantiate the AuthDelegateImpl object, passing in AppInfo.
            AuthDelegateImplementation authDelegate = new AuthDelegateImplementation(appInfo);

            // Create MipConfiguration Object
            MipConfiguration mipConfiguration = new MipConfiguration(appInfo, "mip_data", LogLevel.Trace, false);

            // Create MipContext using Configuration
            MipContext mipContext = MIP.CreateMipContext(mipConfiguration);

            // Initialize and instantiate the File Profile.
            // Create the FileProfileSettings object.
            // Initialize file profile settings to create/use local state.
            var profileSettings = new FileProfileSettings(mipContext,
                                     CacheStorageType.OnDiskEncrypted,
                                     new ConsentDelegateImplementation());

            // Load the Profile async and wait for the result.
            var fileProfile = Task.Run(async () => await MIP.LoadFileProfileAsync(profileSettings)).Result;

            // Create a FileEngineSettings object, then use that to add an engine to the profile.
            // This pattern sets the engine ID to user1@tenant.com, then sets the identity used to create the engine.
            var engineSettings = new FileEngineSettings("user1@tenant.com", authDelegate, "", "en-US");
            engineSettings.Identity = new Identity("user1@tenant.com");

            var fileEngine = Task.Run(async () => await fileProfile.AddEngineAsync(engineSettings)).Result;

            // Application Shutdown
            // handler = null; // This will be used in later quick starts.
            fileEngine = null;
            fileProfile = null;
            mipContext.ShutDown();
            mipContext = null;
       }
  }
}
  1. Zástupné hodnoty ve zdrojovém kódu, do kterého jste vložili, nahraďte následujícími hodnotami:

    Zástupný text Hodnota Příklad
    <ID aplikace> ID aplikace Microsoft Entra přiřazené k aplikaci zaregistrované v nastavení a konfiguraci sady MIP SDK (2 instance). 0edbblll-8773-44de-b87c-b8c6276d41eb
    <uživatelsky přívětivý název> Uživatelsky definovaný popisný název aplikace. Inicializace aplikace
    <Guid tenanta> Tenant-ID pro vašeho tenanta Microsoft Entra TenantID
  2. Teď proveďte finální sestavení aplikace a vyřešte případné chyby. Kód by se měl úspěšně sestavit.

Další kroky

Teď, když je inicializační kód hotový, jste připraveni na další rychlý start, kde začnete používat sady MIP File SDK.