BayunCoreSDK Python Programming Guide
  • 1. Introduction
  • 2. Getting Started
  • 3. Installing Bayun Library
  • 4. Authenticating with Bayun
  • 5. BayunCoreSDK Operations
    • 5.1 Lock/Unlock File
    • 5.2 Lock/Unlock Text
    • 5.3 Lock/Unlock Binary Data
  • 6. Groups
    • 6.1 Create Group
    • 6.2 Get My Groups
    • 6.3 Join Public Group
    • 6.4 Get Unjoined Public Groups
    • 6.5 Get Group By Id
    • 6.6 Add Group Member
    • 6.7 Remove Group Member
    • 6.8 Leave Group
    • 6.9 Delete Group
  • 7. Run the Application
Powered by GitBook
On this page
  • 5.1.1 Lock File
  • 5.1.2 Lock File with encryption-policy
  • 5.1.3 Unlock File

Was this helpful?

  1. 5. BayunCoreSDK Operations

5.1 Lock/Unlock File

Previous5. BayunCoreSDK OperationsNext5.2 Lock/Unlock Text

Last updated 4 years ago

Was this helpful?

5.1.1 Lock File

The lockFile function of BayunCore class locks a file with default encryption-policy dictated by server settings.

The function takes the following parameters :

  • sessionId : Unique SessionId which is received in the authenticate function response.

  • filePath : File path to be locked.

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

lockedFilePath = bayunCore.lockFile("<sessionId>", <"filePath">)

5.1.2 Lock File with encryption-policy

The lockFile function with encryption-policy as an optional parameter locks file with the encryption key dictated by the policy. The function takes the following parameters :

  • sessionId : Unique SessionId which is received in the authenticate function response.

  • filePath : File path to be locked.

  • encryptionPolicy : determines the key for locking.

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

  • groupId : GroupId is required if encryptionPolicy is BayunEncryptionPolicyGroup.

If encryption-policy is other than BayunEncryptionPolicyGroup then groupId should be empty string.

from BayunCore import BayunEncryptionPolicy
from BayunCore import BayunKeyGenerationPolicy

encryptionPolicy = BayunEncryptionPolicy.Company
keyGenerationPolicy = BayunKeyGenerationPolicy.Static
filePath = "<file path>"
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 authenticate function response.

  • filePath : File path to be unlocked.

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

unlockedFilePath = bayunCore.unlockFile("<sessionId>","<filePath>")
BayunEncryptionPolicy
BayunKeyGenerationPolicy