PrevNextUpHome SophiaFramework UNIVERSE 5.3
SFBCipherWrapper
Wrapper Class for the ICipherWrapper interface.
#include <SFBCipherWrapper.h.hpp>
class SFBCipherWrapper : public SFBCipher1;
SFMTYPEDEFWRAPPER(SFBCipherWrapper)

Inheritance diagram

 Inheritance diagram of SFBCipherWrapperClass

Version

BREW 2.0 BREW 2.1 BREW 3.1 BREW 4.0
X X O O

Reference

BREW API ICipherWrapper

Member

Public Functions
SFCError SetCipher( SFBQuerySmpConstRef cipher )
Sets the cipher used by SFBCipherWrapper to the SFBCipher1 specified.
static
SFBParametersSmp
NewInstance( SFCErrorPtr exception = null ) (inherits from SFBParameters)
Create a new SFBParameters instance.
static
SFBParametersSmp
NewInstance( AEECLSID id , SFCErrorPtr exception = null ) (inherits from SFBParameters)
Create a new SFBParameters instance.
SFCError Process( VoidConstPtr input , UInt32 insize , VoidPtr output , UInt32Ptr outsize ) (inherits from SFBCipher1)
Encrypt or decrypt data.
SFCError Process( SFXBufferConstRef input , SFXBufferPtr output ) (inherits from SFBCipher1)
Encrypt or decrypt data.
SFCError Process( SFXAnsiStringConstRef input , SFXAnsiStringPtr output ) (inherits from SFBCipher1)
Encrypt or decrypt data.
SFCError ProcessLast( VoidPtr output , UInt32Ptr outsize ) (inherits from SFBCipher1)
Encrypt or decrypt last partial block(s) remaining from call to SFBCipher1::Process().
SFCError ProcessLast( SFXBufferPtr output ) (inherits from SFBCipher1)
Encrypt or decrypt last partial block(s) remaining from call to SFBCipher1::Process().
SFCError ProcessLast( SFXAnsiStringPtr output ) (inherits from SFBCipher1)
Encrypt or decrypt last partial block(s) remaining from call to SFBCipher1::Process().
SFCError SetParam( SInt32 id , VoidConstPtr data , UInt32 length ) (inherits from SFBParameters)
This method sets a parameter value.
SFCError SetParam( SInt32 id , SFXBufferConstRef data ) (inherits from SFBParameters)
This method sets a parameter value.
SFCError SetParam( SInt32 id , SFXAnsiStringConstRef data ) (inherits from SFBParameters)
This method sets a parameter value.

SFBCipherWrapper::SetCipher
Sets the cipher used by SFBCipherWrapper to the SFBCipher1 specified.
[ public ]
SFCError SetCipher(
    SFBQuerySmpConstRef cipher   // Pointer to SFBCipher1 or SFBRawCipher interface object 
);

Return value

  • SUCCESS: Cipher is successfully associated with the chaining mode.
  • ECLASSNOTSUPPORT: Class is not supported or is not a valid object.

Description

The caller should release the cipher after calling this function to avoid memory leaks. ICipherWrapper_SetCipher performs its own IQUERYINTERFACE_AddRef().

The cipher key must be set after calling SFBCipherWrapper::SetCipher() in order for the object to be properly initialized.

Reference

BREW API ICIPHERWRAPPER_SetCipher