Client SDK Version 2.0.0
Ionic Security client SDK for Python users
|
Cipher that automatically chooses the correct cipher to use for file encryption / decryption. More...
Public Member Functions | |
def | __init__ (self, agentkeyservice, coverpageservice=None) |
Constructs an auto file cipher from key services and optional coverpage services. More... | |
![]() | |
def | __init__ (self) |
Constructs a file cipher with default values. | |
def | family (self) |
Access the instance FileCipherFamily enumeration. More... | |
def | familystring (self) |
Access the instance FileCipherFamily string. More... | |
def | getLastServerResponse (self) |
Return the Server Response object from the last Agent call. More... | |
def | encryptbytes (self, plaintextbytes, attributes=None, metadata=None, mutableAttributes=None) |
Encrypts an input byte buffer into an output byte buffer. More... | |
def | encryptbytes2 (self, plaintextbytes, encryptattributesInOut) |
Encrypts an input byte buffer into an output byte buffer. More... | |
def | decryptbytes (self, ciphertextbytes, metadata=None) |
Decrypts an input buffer into an output buffer. More... | |
def | decryptbytes2 (self, ciphertextbytes, decryptattributesInOut) |
Decrypts an input byte buffer into an output byte buffer. More... | |
def | encryptinplace (self, filepath, attributes=None, metadata=None, mutableAttributes=None) |
Encrypts a file in-place. More... | |
def | encryptinplace2 (self, filepath, encryptattributesInOut) |
Encrypts a file in-place. More... | |
def | decryptinplace (self, filepath, metadata=None) |
Decrypts a file in-place. More... | |
def | decryptinplace2 (self, filepath, decryptattributesInOut) |
Decrypts a file in-place. More... | |
def | encrypt (self, sourcepath, destpath, attributes=None, metadata=None, mutableAttributes=None) |
Encrypts an input file into an output file. More... | |
def | encrypt2 (self, sourcepath, destpath, encryptattributesInOut) |
Encrypts an input file into an output file. More... | |
def | decrypt (self, sourcepath, destpath, metadata=None) |
Decrypts an input file into an output output file. More... | |
def | decrypt2 (self, sourcepath, destpath, decryptattributesInOut) |
Decrypts an input file into an output output file. More... | |
def | getinfobytes (self, inputbytes) |
Determines if a file is Ionic protected and various pieces of information about the file. More... | |
def | getinfo (self, filepath) |
Determines if a file is Ionic protected and various pieces of information about the file. More... | |
Static Public Attributes | |
FAMILY = FileCipherFamily.AUTO | |
(FileCipherFamily) File Cipher Family enumeration for this class | |
FAMILY_STRING = FileCipherFamily.tostring(FAMILY) | |
(string) File Cipher Family label for this class | |
Cipher that automatically chooses the correct cipher to use for file encryption / decryption.
Important Limitations The automatic file cipher cannot and does not detect CSV or CMS file types automatically for encryption. Only decryption of these file types are supported automatically.
CSV files do not follow any standard or documented format, can contain any type of delimiter, may not contain any delimiters at all, etc. For this reason, the automatic file cipher will encrypt CSV files using the generic file cipher (FileCipherGeneric) as opposed to the specialized CSV file cipher (FileCipherCsv). When the CSV file cipher is desired, it must be used directly instead of relying on the automatic cipher.
Similarly, the CMS cipher will encrypt any input as the payload (typically a MIME encoded file attachment). Only the resultant encrypted CMS message follows a documented format. Therefore, when the CMS file cipher is desired for encryption, it must be used directly instead of relying on the automatic cipher.
def ionicsdk.filecipher.FileCipherAuto.__init__ | ( | self, | |
agentkeyservice, | |||
coverpageservice = None |
|||
) |
Constructs an auto file cipher from key services and optional coverpage services.
agentkeyservice | (class instance) The key service used to retrieve and create keys. |
coverpageservice | (class instance) The coverpage service used to retrieve cover pages and access denied pages. |
You acknowledge your access, review and use of the documentation on this page is subject to the Ionic Security Inc. Documentation Use Rights.
© 2016-2020 Ionic Security Inc. All rights reserved. -
Generated on Thu Jul 2 2020 12:40:01 for Client SDK Version 2.0.0 by
1.8.18