SDK de Proteção de Informações da Microsoft - Conceitos de perfis de SDK de ficheiros

O perfil é a classe raiz para todas as operações no MIP SDK. Antes de usar qualquer funcionalidade do SDK de ficheiros, crie um FileProfile. O perfil ou outros objetos adicionados ao perfil realizam todas as operações futuras.

Cumpra os seguintes pré-requisitos de código antes de criar um perfil:

  • MipContext: Crie-o MipContext e armazene-o num objeto acessível ao mip::FileProfile objeto.
  • Delegado de consentimento: ConsentDelegateImpl implementa mip::ConsentDelegate.
  • Registo da aplicação: Registe a aplicação no Microsoft Entra ID e codifica o ID do cliente diretamente nos ficheiros da aplicação ou de configuração.
  • Observador de perfil de ficheiro: Implementar uma classe que herda mip::FileProfile::Observer.

Carregar um perfil

Depois de definir ProfileObserver e ConsentDelegateImpl, pode-se instanciar mip::FileProfile. Criar o mip::FileProfile objeto requer mip::MipContext e mip::FileProfile::Settings, que armazena toda a informação de definições sobre o FileProfile.

Parâmetros de FileProfile::Settings

O FileProfile::Settings construtor aceita os seguintes cinco parâmetros:

  • std::shared_ptr<MipContext>: O mip::MipContext objeto 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, ProtectionProfilee FileProfile).

Os exemplos seguintes mostram como criar o profileSettings objeto usando armazenamento local apenas para armazenamento de estado ou em memória.

Armazenar estado apenas 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 a partir do caminho de armazenamento no disco

O seguinte excerto de código instrui o FileProfile a armazenar todos os dados de estado da aplicação 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 qualquer uma das abordagens anteriores, use o padrão de 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 a aplicação carregar com sucesso um perfil, ProfileObserver::OnLoadSuccess, a implementação de mip::FileProfile::Observer::OnLoadSuccess, é chamada. O SDK passa o objeto resultante ou o apontador de exceção, e o contexto, como parâmetros para a função. O contexto é um ponteiro para o std::promise criado para processar a operação assíncrona. A função define o valor da promessa ao objeto FileProfile passado para o primeiro parâmetro. Quando a função principal usa Future.get(), pode armazenar o resultado num 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, pode carregar um perfil na totalidade. O seguinte excerto de código assume 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 armazena-o no objeto chamado profile.

Passos seguintes

Agora que o perfil foi adicionado, o passo seguinte é adicionar um motor ao perfil.