Compartilhar via


SDK da Proteção de Informações da Microsoft: conceitos do perfil do SDK de arquivo

O perfil é a classe raiz de todas as operações do SDK da PIM. Antes de usar qualquer funcionalidade do SDK de arquivo, um FileProfile deverá ser criado e todas as operações futuras serão executadas pelo perfil ou por outros objetos adicionados ao perfil.

Existem alguns pré-requisitos de código que devem ser atendidos antes da tentativa de criar uma instância para um perfil:

  • MipContext foi criado e armazenado em um objeto acessível ao objeto mip::FileProfile.
  • ConsentDelegateImpl implementa mip::ConsentDelegate.
  • O aplicativo foi registrado no Microsoft Entra ID e a ID do cliente é embutida em código no aplicativo ou nos arquivos de configuração.
  • Uma herança de classe mip::FileProfile::Observer foi adequadamente implementada.

Carregar um perfil

Com o ProfileObserver e o ConsentDelegateImpl, definidos, agora pode ser criada uma instância para o mip::FileProfile. A criação do objeto mip::FileProfile requer que [mip::MipContext] tenha e que mip::FileProfile::Settings armazene todas as informações de configurações sobre o FileProfile.

FileProfile::parâmetros de Configurações

O construtor FileProfile::Settings aceita cinco parâmetros, listados abaixo:

  • std::shared_ptr<MipContext>: o objeto mip::MipContext que foi inicializado para armazenar informações do aplicativo, caminho de estado etc.
  • mip::CacheStorageType: define como armazenar o estado: na memória, no disco ou no disco e criptografado.
  • std::shared_ptr<mip::ConsentDelegate>: um ponteiro compartilhado de classe mip::ConsentDelegate.
  • std::shared_ptr<mip::FileProfile::Observer> observer: um ponteiro compartilhado para a implementação do perfil Observer (em PolicyProfile, ProtectionProfile e FileProfile).

Os exemplos a seguir mostram como criar o objeto profileSettings usando o armazenamento local para armazenamento de estado e somente na memória.

Armazenar estado somente na memória

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

Configurações de perfil de leitura/gravação do caminho de armazenamento em disco

A captura de código a seguir instruirá o FileProfile a armazenar todos os dados de estado do aplicativo em ./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

Carregar o perfil

Usando qualquer um dos detalhes de abordagem acima, use agora o padrão promessa/futuro para carregar o FileProfile.

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

Se tivermos carregado um perfil e essa operação tiver tido êxito, ProfileObserver::OnLoadSuccess, nossa implementação de mip::FileProfile::Observer::OnLoadSuccess será chamada. O objeto resultante ou o ponteiro de exceção, além do contexto, são passados como parâmetros para a função. O contexto é um ponteiro para o std::promise que criamos para manipular a operação assíncrona. A função simplesmente define o valor da promessa para o objeto FileProfile que foi passado para o primeiro parâmetro. Quando a função principal usa Future.get(), o resultado pode ser armazenado em um novo objeto.

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

Juntar as peças

Tendo implementado totalmente os observadores e o representante de autenticação, agora é possível carregar totalmente um perfil. A captura do código abaixo presume que todos os cabeçalhos necessários já estejam incluídos.

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

O resultado final é que carregamos com êxito o perfil e armazenamos no objeto denominado profile.

Próximas etapas

Agora que o perfil foi adicionado, a próxima etapa é adicionar um mecanismo ao perfil.