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

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

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

Public Member Functions

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...
 
def Debug (self)
 Get a debugging string representation of the instance. More...
 

Public Attributes

 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.KeyData.__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.

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

Member Function Documentation

◆ Debug()

def ionicsdk.common.KeyData.Debug (   self)

Get a debugging string representation of the instance.

Returns
A string describing the instance

Reimplemented in ionicsdk.common.UpdateKeyData.


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