Пакет SDK Для Microsoft Information Protection — основные понятия профиля пакета SDK для файлов

Профиль — это корневой класс для всех операций в пакете SDK MIP. Прежде чем использовать какие-либо возможности File SDK, создайте FileProfile. Профиль или другие объекты, добавленные в профиль, выполняют все будущие операции.

Перед созданием экземпляра профиля выполните следующие предварительные требования для кода:

  • MipContext: создайте MipContext и сохраните его в объекте, доступном для mip::FileProfile объекта.
  • Делегат согласия: ConsentDelegateImpl реализует mip::ConsentDelegate.
  • Регистрация приложения. Зарегистрируйте приложение в Microsoft Entra ID и жестко закодируйте идентификатор клиента в файлах приложения или конфигурации.
  • Наблюдатель профиля файла: реализация класса, наследуемого mip::FileProfile::Observer.

Загрузка профиля

После определения ProfileObserver и ConsentDelegateImpl можно создать экземпляр mip::FileProfile. Создание объекта mip::FileProfile требует mip::MipContext и mip::FileProfile::Settings, который хранит всю информацию о параметрах FileProfile.

Параметры FileProfile::Settings

Конструктор FileProfile::Settings принимает следующие пять параметров:

  • std::shared_ptr<MipContext>: объект mip::MipContext, инициализированный для хранения сведений о приложении, пути к состоянию и т. д.
  • mip::CacheStorageType: определяет, как хранить состояние: в памяти, на диске или на диске и зашифрованном.
  • std::shared_ptr<mip::ConsentDelegate>: общий указатель класса mip::ConsentDelegate.
  • std::shared_ptr<mip::FileProfile::Observer> observer: общий указатель на реализацию профиля Observer (в PolicyProfile, ProtectionProfileи FileProfile).

В следующих примерах показано, как создать объект profileSettings с использованием локального хранилища для хранения состояния или исключительно в памяти.

Хранение состояния только в памяти

mip::ApplicationInfo appInfo {clientId, "APP NAME", "1.2.3" };

std::shared_ptr<mip::MipConfiguration> mipConfiguration = std::make_shared<mip::MipConfiguration>(mAppInfo,
			                                                                                      "mip_data",
                                                                                       			  mip::LogLevel::Trace,
                                                                                                  false);

std::shared_ptr<mip::MipContext> mMipContext = mip::MipContext::Create(mipConfiguration);

FileProfile::Settings profileSettings(
    mMipContext,                                  // mipContext object
    mip::CacheStorageType::InMemory,              // use in memory storage
    std::make_shared<ConsentDelegateImpl>(),      // new consent delegate
    std::make_shared<FileProfileObserverImpl>()); // new protection profile observer

Чтение и запись настроек профиля из пути к хранилищу на диске

В следующем фрагменте кода показано FileProfile , как хранить все данные о состоянии приложения в ./mip_app_data.

mip::ApplicationInfo appInfo {clientId, "APP NAME", "1.2.3" };

std::shared_ptr<mip::MipConfiguration> mipConfiguration = std::make_shared<mip::MipConfiguration>(mAppInfo,
				                                                                                  "mip_data",
                                                                                        		  mip::LogLevel::Trace,
                                                                                                  false);

std::shared_ptr<mip::MipContext> mMipContext = mip::MipContext::Create(mipConfiguration);

FileProfile::Settings profileSettings(
    mMipContext,                                   // mipContext object
    mip::CacheStorageType::OnDisk,                 // use on disk storage    
    std::make_shared<ConsentDelegateImpl>(),       // new consent delegate
    std::make_shared<FileProfileObserverImpl>());  // new protection profile observer

Загрузка профиля

После использования любого из описанных выше подходов используйте паттерн promise/future для загрузки FileProfile.

auto profilePromise = std::make_shared<std::promise<std::shared_ptr<FileProfile>>>();
auto profileFuture = profilePromise->get_future();
FileProfile::LoadAsync(profileSettings, profilePromise);

Если приложение успешно загружает профиль, ProfileObserver::OnLoadSuccess, вызывается реализация mip::FileProfile::Observer::OnLoadSuccess. Пакет SDK передает результирующий объект или указатель исключения, а контекст — в качестве параметров функции. Контекст — это указатель на std::promise созданный для обработки асинхронной операции. Функция задает значение обещания объекту FileProfile, переданного для первого параметра. При использовании Future.get()основной функции он может сохранить результат в новом объекте.

//get the future value and store in profile. 
auto profile = profileFuture.get();

Собираем всё вместе

После реализации делегата наблюдателей и проверки подлинности можно полностью загрузить профиль. В следующем фрагменте кода предполагается, что все необходимые заголовки уже включены.

int main()
{
    const string userName = "MyTestUser@contoso.com";
    const string password = "P@ssw0rd!";
    const string clientId = "MyClientId";

    mip::ApplicationInfo appInfo {clientId, "APP NAME", "1.2.3" };

    std::shared_ptr<mip::MipConfiguration> mipConfiguration = std::make_shared<mip::MipConfiguration>(mAppInfo,
				                                                                                      "mip_data",
                                                                                        			  mip::LogLevel::Trace,
                                                                                                      false);

    std::shared_ptr<mip::MipContext> mMipContext = mip::MipContext::Create(mipConfiguration);

    FileProfile::Settings profileSettings(
        mMipContext,                                   // MipContext object
        mip::CacheStorageType::OnDisk,                 // use on disk storage        
        std::make_shared<ConsentDelegateImpl>(),       // new consent delegate
        std::make_shared<FileProfileObserverImpl>());  // new file profile observer

        auto profilePromise = std::make_shared<promise<shared_ptr<FileProfile>>>();
        auto profileFuture = profilePromise->get_future();
        FileProfile::LoadAsync(profileSettings, profilePromise);
        auto profile = profileFuture.get();
}

Код загружает профиль и сохраняет его в вызываемом profileобъекте.

Дальнейшие действия

Теперь, когда профиль добавлен, следующий шаг — добавить модуль в профиль.

  • Last updated on