Client SDK Version 2.0.0
Ionic Security client SDK for Python users
Public Member Functions | List of all members
ionicsdk.common.SecretShareProfilePersistor Class Reference

Secret Share device profile persistor implementation. More...

Inheritance diagram for ionicsdk.common.SecretShareProfilePersistor:
ionicsdk.common.DeviceProfilePersistorBase

Public Member Functions

def __init__ (self, secretsharedata, filePath=None, secretshareFilePath=None)
 Constructs a persistor with the provided values. More...
 
def SetFilePath (self, filePath)
 Sets the encrypted device profile file path. More...
 
def SetSecretShareFilePath (self, filePath)
 Sets the secret share persistor file path. More...
 
- Public Member Functions inherited from ionicsdk.common.DeviceProfilePersistorBase
def __init__ (self)
 Constructs a persistor with default values.
 
def getversion (self)
 Gets the profile persistor verion to use, or an empty value if a default will be used. More...
 
def setversion (self, version)
 Sets the profile persistor verion to use. More...
 

Detailed Description

Secret Share device profile 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.

This class provides a file-based device persistor that is uses a seperate Secret Share Persistor to store the encryption keys.

It needs two file paths, one for the secret share persistor and the other for the encrypted device profiles.

NOTE: The secret share persistor will query the SecretShareData each time a key is requested. It does not cache anything other than the file paths.

Constructor & Destructor Documentation

◆ __init__()

def ionicsdk.common.SecretShareProfilePersistor.__init__ (   self,
  secretsharedata,
  filePath = None,
  secretshareFilePath = None 
)

Constructs a persistor with the provided values.

Parameters
secretsharedata(SecretShareData) data object used by secret share to encrypt
filePath(string): The device profile file path to use
secretshareFilePath(string): The secret share persistor file path to use

Member Function Documentation

◆ SetFilePath()

def ionicsdk.common.SecretShareProfilePersistor.SetFilePath (   self,
  filePath 
)

Sets the encrypted device profile file path.

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

◆ SetSecretShareFilePath()

def ionicsdk.common.SecretShareProfilePersistor.SetSecretShareFilePath (   self,
  filePath 
)

Sets the secret share persistor file path.

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

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