Client SDK Version 1.8.1
Ionic Security client SDK for Python users
Public Member Functions | List of all members
ionicsdk.secretshare.SecretSharePersistor Class Reference

Secret Share persistor implementation. More...

Inheritance diagram for ionicsdk.secretshare.SecretSharePersistor:

Public Member Functions

def __init__ (self, secretsharedata)
 
def SetFilePath (self, filePath)
 Sets the encrypted secret share file path. More...
 
def GetKey (self)
 Generate (first call) or Retrieve (subsequent calls) a key. More...
 

Detailed Description

Secret Share persistor implementation.

This class uses a SecretShareData object to populate data. (See SecretShareData)

DO NOT use the provided SecretShareData class alone. You must subclass the provided class and add a GetData() and GetBuckets() method.

A secret share persistor allows a user to generate and recover a key based on groups of key-value data of which only a threshold amount of each group must match in order to recover the key.

NOTE: The secret share persistor will query the SecretShareData each time a key is requested.

Constructor & Destructor Documentation

◆ __init__()

def ionicsdk.secretshare.SecretSharePersistor.__init__ (   self,
  secretsharedata 
)

Initializes a Secret Share persistor from a secret share data object.

Parameters
secretsharedata(SecretShareData) A reference to a SecretShareData implementation object.

Member Function Documentation

◆ GetKey()

def ionicsdk.secretshare.SecretSharePersistor.GetKey (   self)

Generate (first call) or Retrieve (subsequent calls) a key.

Returns
CBytes struct that can be passed as key to other encryption functions

◆ SetFilePath()

def ionicsdk.secretshare.SecretSharePersistor.SetFilePath (   self,
  filePath 
)

Sets the encrypted secret share file path.

Parameters
filePath(string): The file path to use
Returns
None

The documentation for this class was generated from the following file: