BayunCoreSDK C++ Programming Guide
  • 1. Introduction
  • 2. Quick Start Guide for Beginners
  • 3. Getting Started
  • 4. Authentication
    • 4.1 Register with Password
    • 4.2 Register without Password
    • 4.3 Login with Password
    • 4.4 Login without Password
    • 4.5 Logout
    • 4.6 Authorization
    • 4.7 Change Password
  • 5. BayunCoreSDK Operations
    • 5.1 Lock/Unlock File
    • 5.2 Lock/Unlock Text
    • 5.3 Lock/Unlock Binary Data
    • 5.4 Get Locking Key
  • 6. Groups
    • 6.1 Create Group
    • 6.2 Get My Groups
    • 6.3 Get Unjoined Public Groups
    • 6.4 Join Public Group
    • 6.5 Get Group By Id
    • 6.6 Add Group Member
    • 6.7 Add Group Members
    • 6.8 Remove Group Member
    • 6.9 Remove Group Members
    • 6.10 Remove Group Members Except List
    • 6.11 Leave Group
    • 6.12 Delete Group
  • 7. Run the sample program
Powered by GitBook
On this page
  • 5.1.1 Lock File
  • 5.1.2 Lock File with Encryption Policy, Key Generation Policy
  • 5.1.3 Unlock File

Was this helpful?

  1. 5. BayunCoreSDK Operations

5.1 Lock/Unlock File

5.1.1 Lock File

The lockFile function of BayunCore class locks a file with default BayunEncryptionPolicy and BayunKeyGenerationPolicy dictated by server settings.

The function takes the following parameters :

  • sessionId : Unique SessionId which is received in the registration/login function response.

  • filePath : Path of the file to be locked.

    • dataType : std::string

The file at the given file path is overwritten with the locked file. If file locking fails original file is not changed.

#include "BayunCore.h"

std::string lockedFilePath = bayunCore->lockFile("<sessionId>", <"filePath">);

5.1.2 Lock File with Encryption Policy, Key Generation Policy

The lockFile function with encryption policy, key generation policy as parameters locks file with the encryption key dictated by the policy. The function takes the following parameters :

  • sessionId : Unique SessionId which is received in the registration/login function response.

  • filePath : Path of the file to be locked.

  • encryptionPolicy : BayunEncryptionPolicy determines the key to be used to generate the lockingKey.

  • keyGenerationPolicy : BayunKeyGenerationPolicy determines the policy to generate the data encryption key.

  • groupId : GroupId is required if encryptionPolicy is BayunEncryptionPolicyGroup.

If encryptionPolicy is other than BayunEncryptionPolicyGroup then groupId should be nil.

#include "BayunCore.h"

Bayun::BayunEncryptionPolicy encryptionPolicy = Bayun::BayunEncryptionPolicy::Company;
Bayun::BayunKeyGenerationPolicy keyGenerationPolicy = Bayun::BayunKeyGenerationPolicy::Envelop;
std::string filePath = "<file path>";
std::string lockedFilePath = bayunCore->lockFile("<sessionId>", filePath, encryptionPolicy, keyGenerationPolicy, "<groupId>");

5.1.3 Unlock File

The unlockFile function of BayunCore class unlocks a locked file. The function takes the following parameters :

  • sessionId : Unique SessionId which is received in the registration/login function response.

  • filePath : Path of the file to be unlocked.

    • dataType : std::string

The file at the given file path is overwritten with the unlocked file.

#include "BayunCore.h"

std::string unlockedFilePath = bayunCore->unlockFile("<sessionId>","<filePath>");
Previous5. BayunCoreSDK OperationsNext5.2 Lock/Unlock Text

Last updated 1 year ago

Was this helpful?