Microsoft 信息保护 SDK - 文件 SDK 配置文件概念

配置文件是 MIP SDK 中所有操作的根类。 在使用任何文件 SDK 功能之前,必须创建 ,以后的所有操作都将由配置文件或添加到配置文件的其他 FileProfile 对象执行。 FileProfile

在尝试实例化配置文件之前,应满足一些代码先决条件:

  • MipContext 已创建并存储在对象可访问的对象 mip::FileProfile 中。
  • ConsentDelegateImpl 实现 mip::ConsentDelegate
  • 应用程序已注册到 Azure Active Directory客户端 ID 硬编码到应用程序或配置文件中。
  • 已正确 mip::FileProfile::Observer 实现继承的类。

加载配置文件

现在 ProfileObserver ,可以使用 ConsentDelegateImpl 定义的 、 mip::FileProfile 和 进行实例化。 创建 对象需要 [ ] 具有 和 来存储有关 mip::FileProfilemip::MipContextmip::FileProfile::Settings 的所有设置信息 FileProfile

FileProfile::设置 参数

构造函数 FileProfile::Settings 接受下面列出的五个参数:

  • std::shared_ptr<MipContext>mip::MipContext 已初始化以存储应用程序信息、状态路径等的对象。
  • mip::CacheStorageType:定义如何存储状态:在内存中、磁盘上或磁盘上并加密。
  • std::shared_ptr<mip::ConsentDelegate>:类的共享指针 mip::ConsentDelegate
  • std::shared_ptr<mip::FileProfile::Observer> observer:指向 、 和 (ObserverPolicyProfileProtectionProfile 中的配置文件实现 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

从磁盘上的存储路径读取/写入配置文件设置

以下代码 snip 将指示 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::OnLoadSuccessmip::FileProfile::Observer::OnLoadSuccess 我们的 实现。 生成的对象或异常指针以及上下文作为参数传入函数。 上下文是指向为 std::promise 处理异步操作而创建的 的指针。 函数只需将 promise 的值设置到为第一个参数传入的 FileProfile 对象。 当 main 函数使用 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

下一步

添加配置文件后,下一步是将引擎添加到配置文件。