Client SDK Version 1.8.1
Ionic Security client SDK for Python users
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
ionicsdk.common.UpdateKeyData Class Reference

Defines a data protection key as returned by Ionic.com. More...

Inheritance diagram for ionicsdk.common.UpdateKeyData:
ionicsdk.common.KeyData

Public Member Functions

def __init__ (self, id, bytes, attributes=None, obligations=None, origin=None, mutableAttributes=None, mutableAttributesFromServer=None, attributesSigBase64FromServer=None, mutableAttributesSigBase64FromServer=None, forceUpdate=False)
 Initializes the key object with provided inputs. More...
 
def Debug (self)
 Get a debugging string representation of the instance. More...
 
- Public Member Functions inherited from ionicsdk.common.KeyData
def __init__ (self, id, bytes, attributes=None, obligations=None, origin=None, mutableAttributes=None, mutableAttributesFromServer=None, attributesSigBase64FromServer=None, mutableAttributesSigBase64FromServer=None)
 Initializes the key object with provided inputs. More...
 

Static Public Member Functions

def FromKeyData (pyKey, forceUpdate=False)
 Utlity method for converting from KeyData to UpdateKeyData. More...
 

Public Attributes

 forceUpdate
 (bool) The force flag controls whether or not the Ionic key server should update the key forcefully when it is out of date
 
- Public Attributes inherited from ionicsdk.common.KeyData
 id
 (string) The key ID
 
 bytes
 (bytes) The key
 
 attributes
 (KeyAttributesDict) The key non-mutable attributes
 
 mutableAttributes
 (KeyAttributesDict) The key mutable attributes
 
 obligations
 (KeyObligationsDict) The key obligations
 
 origin
 (string) The key origin, usually a URL
 
 mutableAttributesFromServer
 (KeyAttributesDict) The key mutable attributes from the server version
 
 attributesSigBase64FromServer
 (string) Base 64 encoded signature of the server's non-mutable attributes
 
 mutableAttributesSigBase64FromServer
 (string) Base 64 encoded signature of the server's mutable attributes
 

Detailed Description

Defines a data protection key as returned by Ionic.com.

Constructor & Destructor Documentation

◆ __init__()

def ionicsdk.common.UpdateKeyData.__init__ (   self,
  id,
  bytes,
  attributes = None,
  obligations = None,
  origin = None,
  mutableAttributes = None,
  mutableAttributesFromServer = None,
  attributesSigBase64FromServer = None,
  mutableAttributesSigBase64FromServer = None,
  forceUpdate = False 
)

Initializes the key object with provided inputs.

Parameters
id(string): The key ID (also known as the key tag).
bytes(bytes): The raw key bytes. It must be exactly 32 bytes in length.
attributes(dict[string,list[string]], optional): The key attributes.
obligations(KeyObligationsDict) The key obligations
origin(string) The key origin, usually a URL
mutableAttributes(KeyAttributesDict) The key mutable attributes
mutableAttributesFromServer(KeyAttributesDict) The key mutable attributes from the server version
attributesSigBase64FromServer(string) Base 64 encoded signature of the server's non-mutable attributes
mutableAttributesSigBase64FromServer(string) Base 64 encoded signature of the server's mutable attributes
forceUpdate(bool): Whether to force update or error when asked to update an out of date key.

Member Function Documentation

◆ Debug()

def ionicsdk.common.UpdateKeyData.Debug (   self)

Get a debugging string representation of the instance.

Returns
A string describing the instance

Reimplemented from ionicsdk.common.KeyData.

◆ FromKeyData()

def ionicsdk.common.UpdateKeyData.FromKeyData (   pyKey,
  forceUpdate = False 
)
static

Utlity method for converting from KeyData to UpdateKeyData.

Parameters
pyKey(KeyData): Key data to convert
forceUpdate(bool): Whether to force update or error when asked to update an out of date key.
Returns
An UpdateKeyData instance copied from the args

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