Class List

Here are the classes, structs, unions and interfaces with brief descriptions:

[detail level 123]

▼Nionicsdk
▼Nagent	The client-side library for all Ionic.com REST API endpoint communication
CAgent	Agent class performs all client/server communication with Ionic.com
CAgentConfig	Configuration object used by Agent
CGetKeyError	Class used to return Error object(s) from calls to GetKeys2
CGetKeyErrorList	List of Get Key Errors with convenience functions for searching by key id
CGetKeyQueryList	List of Get Key Query Results with convenience functions for searching by external ID
CGetKeyQueryResult	Class used to return external key query result object(s)
CResourceRequest	Class used to request generic resource object(s)
CResourceResponse	Class used to return generic resource object(s)
CResourceResponseList	List of generic resource object(s) with convenience functions for searching by refid
▼Nchunkcipher	Supports protection of small-medium sized text strings and binary arrays
CChunkCipherAuto	Cipher that automatically chooses the correct cipher to use for data chunk encryption / decryption
CChunkCipherBase	Base class for all data chunk encryption / decryption ciphers
CChunkCipherDecryptAttributes	Allows for extended output options during data chunk decryption
CChunkCipherEncryptAttributes	Allows for extended input and output options during data chunk encryption
CChunkCipherV1	Cipher that supports version 1 data chunk encryption / decryption
CChunkCipherV2	Cipher that supports version 2 data chunk encryption / decryption
CChunkCipherV3	Cipher that supports version 3 data chunk encryption / decryption
CChunkCipherV4	Cipher that supports version 4 data chunk encryption / decryption
CChunkCrypto	Utility functions to retrieve ChunkInfo from protected data
CChunkInfo	Data class used to describe attributes of a data chunk
▼Ncommon	Common data structures used by IonicSDK modules
CDeviceProfile	Data class for storing device profile information (a.k.a
CDeviceProfileList	List of DeviceProfiles
CDeviceProfilePersistorAesGcmFile	AES/GCM protected device profile persistor implementation
CDeviceProfilePersistorBase	Abstract class used to load and save device profiles
CDeviceProfilePersistorDefault	Default device profile persistor implementation
CDeviceProfilePersistorPasswordFile	Password protected device profile persistor implementation
CDeviceProfilePersistorPlaintextFile	Plaintext device profile persistor implementation
CKeyAttributesDict	Default Dictionary of string Attribute names with lists of string values
CKeyData	Defines a data protection key as returned by Ionic.com
CKeyDataList	List of keys with convenience functions for searching
CKeyObligationsDict	Default Dictionary of string Obligation names with lists of string values
CMetadataDict	Dictionary of string to string
CSecretShareProfilePersistor	Secret Share device profile persistor implementation
CUpdateKeyData	Defines a data protection key as returned by Ionic.com
CUpdateKeyDataList	List of pdate keys with convenience functions for searching
▼Ncoverpage	Common functions allowing for Ionic-styled cover pages, which can provide explanation and enablement instructions for access to an Ionic-protected document
CCoverPageService	Service object that provides cover pages to a File Cipher
▼Ncryptocipher	Ionic cryptographic ciphers
CAesCtrCipher	Cipher class that implements AES CTR
CAesGcmCipher	Cipher class that implements AES GCM
CCryptoCipherBase	Root Cipher class that defines the interface and includes a number of utility functions shared by all Cipher classes
▼Nerrors
CIonicError	Defines error codes produced by the SDK and a method to retrieve a description of the error
▼Nexceptions	The Python Ionic SDK handles errors through exceptions rather than error return codes
CCServerResponse
CIonicException	Exception for Ionic SDK client logic
CIonicServerException	Exception for Ionic server errors
CServerResponse	Server response object returned from most Ionic server calls
▼Nfilecipher	Supports protection of files of all types
CFileCipherAuto	Cipher that automatically chooses the correct cipher to use for file encryption / decryption
CFileCipherBase	Base class for all file encryption / decryption ciphers
CFileCipherCms	Cipher that supports CMS (Cryptographic Message Syntax) encryption / decryption
CFileCipherCsv	Cipher that supports CSV (Comma Separated Values) file encryption / decryption
CFileCipherDecryptAttributes	Allows for extended input and output options during decryption
CFileCipherEncryptAttributes	Allows for extended input and output options during encryption
CFileCipherFamily	Enumeration of all supported cipher families
CFileCipherGeneric	Cipher that supports generic file encryption / decryption
CFileCipherOpenXml	Cipher that supports OpenXML file encryption / decryption
CFileCipherPdf	Cipher that supports PDF file encryption / decryption
CFileCrypto	Utility functions to retrieve FileInfo for any type of file or data
CFileInfo	Data class used to describe attributes of a file
▼Nkeyvault	The client-side library for all key vault services
CKeyVault	KeyVault service object
CKeyVaultAppleKeyChain	KeyVault service object for iOS, which uses the Apple key chain to store keys
CKeyVaultCustom	Key Vault Class that allows for the creation of a completely custom vault
CKeyVaultKeyRecord	Class pass key information in and out of the Key Vaults
CKeyVaultKeyRecordList	List of KeyVaultKeyRecord with convenience functions for searching by key ID
CKeyVaultMac	KeyVault service object for Mac, which uses an encrypted file using the Mac key chain to store keys
CKeyVaultWindowsDpApi	KeyVault service object for Windows, which uses an encrypted file using Windows DP (Data Protection) API
▼Nlog
CCustomLogger	Logger Custom Class for capturing some portion (or all) logging in the Python code
CISLog	Defines the different ways to configure SDK logging
▼Nsecretshare	Classes for secret share persistors and secret share device profile persistor
CSecretShareBucket	Secret Share bucket implementation
CSecretShareData	Secret Share data implementation
CSecretSharePersistor	Secret Share persistor implementation
▼Nservices
CAgentKeyServicesBase	AgentKeyServicesBase class performs all key related services (create and get) for higher level objects like chunk cipher and file cryto