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 File SDK, crie um FileProfile. O perfil ou outros objetos adicionados ao perfil executam todas as operações futuras.

Certifique-se de que os seguintes pré-requisitos de código sejam atendidos antes de instanciar um perfil:

  • MipContext: crie MipContext e armazene-o em um objeto acessível ao mip::FileProfile objeto.
  • Delegado de consentimento: ConsentDelegateImpl implementa mip::ConsentDelegate.
  • Registro do aplicativo: registre o aplicativo em Microsoft Entra ID e codifique o ID do cliente de forma fixa no aplicativo ou nos arquivos de configuração.
  • Observador do perfil de arquivo: implemente uma classe que herda de mip::FileProfile::Observer.

Carregar um perfil

Depois de definir ProfileObserver e ConsentDelegateImpl, você pode instanciar mip::FileProfile. A criação do mip::FileProfile objeto requer mip::MipContext e mip::FileProfile::Settings, que armazena todas as informações de configurações sobre o FileProfile.

Parâmetros de FileProfile::Settings

O FileProfile::Settings construtor aceita os cinco parâmetros a seguir:

  • 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 da 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 armazenar o estado ou 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

Ler/gravar configurações de perfil no caminho de armazenamento no disco

O snippet de código a seguir instrui a FileProfile 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

Depois de usar uma das abordagens anteriores, use o padrão promise/future 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 o aplicativo carregar um perfil com êxito, ProfileObserver::OnLoadSuccess, a implementação de mip::FileProfile::Observer::OnLoadSuccess será chamada. O SDK passa o objeto resultante ou o ponteiro de exceção e o contexto, como parâmetros para a função. O contexto é um ponteiro para o std::promise criado para lidar com a operação assíncrona. A função define como valor da promessa o objeto FileProfile passado no primeiro parâmetro. Quando a função principal usa Future.get(), ela pode armazenar o resultado em um novo objeto.

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

Juntando tudo

Depois de implementar os observadores e o delegado de autenticação, você pode carregar totalmente um perfil. O snippet de código a seguir pressupõe que todos os cabeçalhos necessários já estão 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 código carrega o perfil e o armazena no objeto chamado profile.

Próximas Etapas 

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

  • Last updated on