Encryption API for Unreal SDK

You can use PubNub's functionality via Blueprints or directly in C++ code.

• In Blueprints, the whole SDK is managed by a subsystem, so start by calling the Pubnub Subsystem node.

• In a C++ project, you have to add a dependency to PubnubLibrary:

  1. In your IDE, navigate to Source/_{YourProject}_/_{YourProject}_.Build.cs and add a dependency to PubnubLibrary.

     PrivateDependencyModuleNames.AddRange(new string[] { "PubnubLibrary" });
     

  2. Compile the code and run the project.

• In C++, you can use the PubNub SDK as any other Game Instance Subsystem.

  #include "Kismet/GameplayStatics.h"
  #include "PubnubSubsystem.h"
  
  
  UGameInstance* GameInstance = UGameplayStatics::GetGameInstance(this);
  UPubnubSubsystem* PubnubSubsystem = GameInstance->GetSubsystem<UPubnubSubsystem>();
  

  PubnubSubsystem now allows you to call all PubNub SDK functions, for example:

  PubnubSubsystem->SubscribeToChannel("MyChannel");
  

Usage in Blueprints and C++

PubNub Unreal SDK includes message encryption. This documentation covers crypto module configuration and utility methods for encrypting and decrypting messages using both legacy 128-bit and enhanced 256-bit AES-CBC encryption.

For general SDK configuration and initialization, refer to the Configuration page.

Configuration​

The crypto system in Unreal SDK consists of three main components:

1. Cryptors (IPubnubCryptorInterface), which are individual encryption algorithms (AES, Legacy)
2. Provider interface (UPubnubCryptoModule), which is the top-level interface used by PubNub subsystem.
3. Crypto module (IPubnubCryptoProviderInterface), which manages multiple cryptors with automatic algorithm selection.

To configure the cryptoModule to encrypt all messages, you can use the following methods in the Unreal SDK:

Set crypto module​

PubnubSubsystem->SetCryptoModule(CryptoModule)

Sample code​

To set crypto module and configure AES encryption/decryption for all messages:

Actor.h​