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.2.1 Lock Text
  • 5.2.2 Lock Text with encryption-policy
  • 5.2.3 Unlock Text

Was this helpful?

  1. 5. BayunCoreSDK Operations

5.2 Lock/Unlock Text

Previous5.1 Lock/Unlock FileNext5.3 Lock/Unlock Binary Data

Last updated 4 years ago

Was this helpful?

5.2.1 Lock Text

The lockText function of BayunCore class locks text 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.

  • plainText : Text to be locked.

lockedText = bayunCore.lockText("<sessionId>", "<plainText>")

5.2.2 Lock Text with encryption-policy

The lockText function with encryption-policy as an optional parameter locks text 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.

  • plainText : Text to be locked.

    • dataType : string

  • 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
lockedText =  bayunCore.lockText("<sessionId>", "<plainText>", encryptionPolicy, keyGenerationPolicy, "<groupId>")

5.2.3 Unlock Text

The unlockText function of BayunCore class unlocks a locked text. The function takes the following parameters :

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

  • lockedText : Text to be unlocked.

    • dataType : string

plainText = bayunCore.unlockText("<sessionId>", "<lockedText>")
BayunEncryptionPolicy
BayunKeyGenerationPolicy