ionicsdk.chunkcipher.ChunkCipherBase Class Reference

Base class for all data chunk encryption / decryption ciphers. More...

Inheritance diagram for ionicsdk.chunkcipher.ChunkCipherBase:

Public Member Functions
def	__init__ (self)
	Constructor for base class.
def	id (self)
	Gets the hard-coded cipher ID of this instance. More...
def	label (self)
	Gets the hard-coded cipher label of this instance. More...
def	getLastServerResponse (self)
	Return the Server Response object from the last Agent call. More...
def	encryptstr (self, plaintext, attributes=None, metadata=None, mutableAttributes=None)
	Encrypts an input string into an output string. More...
def	encryptstr2 (self, plaintext, encryptattributesInOut)
	Encrypts an input string into an output string. More...
def	encryptbytes (self, plaintextbytes, attributes=None, metadata=None, mutableAttributes=None)
	Encrypts an input bytes buffer into an output string. More...
def	encryptbytes2 (self, plaintextbytes, encryptattributesInOut)
	Encrypts an input bytes buffer into an output string. More...
def	decryptstr (self, ciphertext, metadata=None)
	Decrypts an input string into an output string. More...
def	decryptstr2 (self, ciphertext, decryptattributesInOut)
	Decrypts an input string into an output string. More...
def	decryptbytes (self, ciphertext, metadata=None)
	Decrypts an input string into an output byte buffer. More...
def	decryptbytes2 (self, ciphertext, decryptattributesInOut)
	Decrypts an input string into an output bytes buffer. More...

Detailed Description

Base class for all data chunk encryption / decryption ciphers.

Not to be used directly. Use one of the appropriate subclasses:

• ChunkCipherAuto - Cipher that automatically chooses the correct cipher to use for data chunk encryption / decryption.
  
• ChunkCipherV1 - Cipher that supports version 1 data chunk encryption / decryption.
  
• ChunkCipherV2 - Cipher that supports version 2 data chunk encryption / decryption.
  
• ChunkCipherV3 - Cipher that supports version 3 data chunk encryption / decryption.
  
• ChunkCipherV4 - Cipher that supports version 4 data chunk encryption / decryption.
  

Member Function Documentation

decryptbytes()

def ionicsdk.chunkcipher.ChunkCipherBase.decryptbytes	(		self,
			ciphertext,
			metadata = None
	)

Decrypts an input string into an output byte buffer.

This function performs data chunk decryption using the method implied by the class name (e.g. ISChunkCryptoV1).

Parameters

ciphertext	(string): The ciphertext input string.
metadata	(agent.MetadataDict, optional): The metadata properties to send along with the HTTP request.

Returns

The plaintext output byte buffer.

decryptbytes2()

def ionicsdk.chunkcipher.ChunkCipherBase.decryptbytes2	(		self,
			ciphertext,
			decryptattributesInOut
	)

Decrypts an input string into an output bytes buffer.

This function performs data chunk decryption using the method implied by the class name (e.g. ISChunkCryptoV1).

Parameters

ciphertext	(string): The ciphertext input string.
decryptattributesInOut	(ChunkCipherDecryptAttributes): Object to provide and return detailed information.

Returns

The plaintext output bytes buffer. The decryptattributesInOut paramater will also be modified.

decryptstr()

def ionicsdk.chunkcipher.ChunkCipherBase.decryptstr	(		self,
			ciphertext,
			metadata = None
	)

Decrypts an input string into an output string.

This function performs data chunk decryption using the method implied by the class name (e.g. ISChunkCryptoV1).

Parameters

ciphertext	(string): The ciphertext input string.
metadata	(agent.MetadataDict, optional): The metadata properties to send along with the HTTP request.

Returns

The plaintext output string.

decryptstr2()

def ionicsdk.chunkcipher.ChunkCipherBase.decryptstr2	(		self,
			ciphertext,
			decryptattributesInOut
	)

Decrypts an input string into an output string.

This function performs data chunk decryption using the method implied by the class name (e.g. ISChunkCryptoV1).

Parameters

ciphertext	(string): The ciphertext input string.
decryptattributesInOut	(ChunkCipherDecryptAttributes): Object to provide and return detailed information.

Returns

The plaintext output string. The decryptattributesInOut paramater will also be modified.

encryptbytes()

def ionicsdk.chunkcipher.ChunkCipherBase.encryptbytes	(		self,
			plaintextbytes,
			attributes = None,
			metadata = None,
			mutableAttributes = None
	)

Encrypts an input bytes buffer into an output string.

This function performs data chunk encryption using the method implied by the class name (e.g. ISChunkCryptoV1).

Parameters

plaintextbytes	(bytes): The binary plaintext input buffer.
attributes	(agent.KeyAttributesDict, optional): The attributes to use when creating a key to protect data.
metadata	(agent.MetadataDict, optional): The metadata properties to send along with the HTTP request.
mutableAttributes	(KeyAttributesDict, optional): The protection key mutable attributes to use for creating the protection key.

Returns

The ciphertext output string.

encryptbytes2()

def ionicsdk.chunkcipher.ChunkCipherBase.encryptbytes2	(		self,
			plaintextbytes,
			encryptattributesInOut
	)

Encrypts an input bytes buffer into an output string.

This function performs data chunk encryption using the method implied by the class name (e.g. ISChunkCryptoV1).

Parameters

plaintextbytes	(bytes): The binary plaintext input buffer.
encryptattributesInOut	(ChunkCipherEncryptAttributes): Object to provide and return detailed information.

Returns

The ciphertext output string. The encryptattributesInOut paramater will also be modified.

encryptstr()

def ionicsdk.chunkcipher.ChunkCipherBase.encryptstr	(		self,
			plaintext,
			attributes = None,
			metadata = None,
			mutableAttributes = None
	)

Encrypts an input string into an output string.

This function performs data chunk encryption using the method implied by the class name (e.g. ISChunkCryptoV1).

Parameters

plaintext	(string): The plaintext input string.
attributes	(agent.KeyAttributesDict, optional): The attributes to use when creating a key to protect data.
metadata	(agent.MetadataDict, optional): The metadata properties to send along with the HTTP request.
mutableAttributes	(KeyAttributesDict, optional): The protection key mutable attributes to use for creating the protection key.

Returns

The ciphertext output string.

encryptstr2()

def ionicsdk.chunkcipher.ChunkCipherBase.encryptstr2	(		self,
			plaintext,
			encryptattributesInOut
	)

Encrypts an input string into an output string.

This function performs data chunk encryption using the method implied by the class name (e.g. ISChunkCryptoV1).

Parameters

plaintext	(string): The plaintext input string.
encryptattributesInOut	(ChunkCipherEncryptAttributes): Object to provide and return detailed information.

Returns

The ciphertext output string. The encryptattributesInOut paramater will also be modified.

getLastServerResponse()

def ionicsdk.chunkcipher.ChunkCipherBase.getLastServerResponse

(

self

)

Return the Server Response object from the last Agent call.

Returns

A valid ServerResponse object or None if no server calls have been made yet.

id()

def ionicsdk.chunkcipher.ChunkCipherBase.id

(

self

)

Gets the hard-coded cipher ID of this instance.

Returns

The ID string

label()

def ionicsdk.chunkcipher.ChunkCipherBase.label

(

self

)

Gets the hard-coded cipher label of this instance.

Returns

The label string

---

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

• ionicsdk/chunkcipher.py