Microsoft Information Protection SDK - Protection SDK profile concepts

Article
2025-04-10

The two examples below show how to create the profileSettings object using local storage for state storage as well as in-memory only.

Load a Profile

Now that the ProtectionProfileObserverImpl is defined, we'll use it to instantiate mip::ProtectionProfile. Creating the mip::ProtectionProfile object requires mip::ProtectionProfile::Settings.

ProtectionProfile::Settings Parameters

std::shared_ptr<MipContext>: The mip::MipContext object that was initialized to store application info, state path, etc.
mip::CacheStorageType: Defines how to store state: In memory, on disk, or on disk and encrypted.
std::shared_ptr<mip::ConsentDelegate>: A shared pointer of class mip::ConsentDelegate.
std::shared_ptr<mip::ProtectionProfile::Observer> observer: A shared pointer to the profile Observer implementation (in PolicyProfile, ProtectionProfile, and FileProfile).

The two examples below show how to create the profileSettings object using local storage for state storage as well as in-memory only.

Store state in memory only

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);

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

Read/write profile settings from storage path on disk

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);

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

Next, use the promise/future pattern to load the ProtectionProfile.

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

If we've loaded a profile, and that operation was successful, ProtectionProfileObserverImpl::OnLoadSuccess, our implementation of mip::ProtectionProfile::Observer::OnLoadSuccess is called. The resulting object or exception pointer, as well as the context, are passed in as parameters to the function. The context is a pointer to the std::promise we created to handle the async operation. The function simply sets the value of the promise to the ProtectionProfile object (context). When the main function uses Future.get(), the result can be stored in a new object.

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

Putting it Together

Having fully implemented the observers and authentication delegate, it's now possible to fully load a profile. The code snip below assumes all necessary headers are already included.

int main()
{
    const string userName = "[email protected]";
    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);

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

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

The end result being that we've successfully loaded the profile and stored in the object called profile.

Next Steps

Now that the profile has been added, the next step is to add an engine to the profile.

Protection engine concepts

Share via