SHOW Signed

net.rim.device.api.crypto
Interface BlockFormatterEngine

All Known Implementing Classes:
OAEPFormatterEngine, PKCS1FormatterEngine, PKCS5FormatterEngine

public interface BlockFormatterEngine

The BlockFormatterEngine interface formats input by inserting padding into the data. This interface allows for block ciphers that use specific forms of padding.

The BlockUnformatterEngine removes specific padding from data.

Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

Since:
JDE 3.6.0

Method Summary
 Category: Signed  int formatAndEncrypt(byte[] input, int inputOffset, int inputLength, byte[] output, int outputOffset)
          Formats the input into the proper format and then encrypts it, assuming this is not the last block to be encrypted.
 Category: Signed  int formatAndEncrypt(byte[] input, int inputOffset, int inputLength, byte[] output, int outputOffset, boolean lastBlock)
          Formats the input into the proper format and then encrypts it.
 Category: Signed  String getAlgorithm()
          Returns the name of this algorithm, eg "PKCS5".
 Category: Signed  int getInputBlockLength()
          Returns the length of an input block in bytes.
 Category: Signed  int getOutputBlockLength()
          Returns the length of an output block in bytes.
 

Method Detail

formatAndEncrypt

public int formatAndEncrypt(byte[] input,
                            int inputOffset,
                            int inputLength,
                            byte[] output,
                            int outputOffset,
                            boolean lastBlock)
                     throws MessageTooLongException,
                            CryptoTokenException
Formats the input into the proper format and then encrypts it.

Parameters:
input - A byte array containing the data to be encrypted.
inputOffset - The offset, or initial bit position, of the data within the byte array.
inputLength - The amount of data to encrypt.
output - A byte array to hold the encoded and encrypted data.
outputOffset - The offset, or initial bit position, of the data within the byte array.
lastBlock - A boolean that indicates the last block to be encrypted.
Returns:
The actual number of bytes encrypted and inserted into the output array.
Throws:
MessageTooLongException - Thrown if the input is too long to be encoded with the given encoding scheme.
CryptoTokenException - Thrown when a problem occurs with a crypto token or the crypto token is invalid.
Since:
JDE 4.0.2
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

formatAndEncrypt

public int formatAndEncrypt(byte[] input,
                            int inputOffset,
                            int inputLength,
                            byte[] output,
                            int outputOffset)
                     throws MessageTooLongException,
                            CryptoTokenException
Formats the input into the proper format and then encrypts it, assuming this is not the last block to be encrypted.

Parameters:
input - A byte array containing the data to be encrypted.
inputOffset - The offset, or initial bit position, of the data within the byte array.
inputLength - The amount of data to encrypt.
output - A byte array to hold the encoded and encrypted data.
outputOffset - The offset, or initial bit position, of the data within the byte array.
Returns:
The actual number of bytes encrypted and placed into the output array.
Throws:
MessageTooLongException - Thrown if the input is too long to be encoded with the given encoding scheme.
CryptoTokenException - Thrown when a problem occurs with a crypto token or the crypto token is invalid.
Since:
JDE 4.0.2
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

getInputBlockLength

public int getInputBlockLength()
Returns the length of an input block in bytes.

Returns:
An integer that represents the length of a block in bytes.
Since:
JDE 3.6.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

getOutputBlockLength

public int getOutputBlockLength()
Returns the length of an output block in bytes.

Returns:
An integer that represents the output block length in bytes.
Since:
JDE 3.6.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

getAlgorithm

public String getAlgorithm()
Returns the name of this algorithm, eg "PKCS5".

Returns:
A String representing the name of the algorithm.
Since:
JDE 3.6.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.


Copyright 1999-2004 Research In Motion Limited. 295 Phillip Street, Waterloo, Ontario, Canada, N2L 3W8. All Rights Reserved.
Copyright 1993-2003 Sun Microsystems, Inc. 901 San Antonio Road, Palo Alto, California, 94303, U.S.A.
Copyright 2002-2003 Nokia Corporation All Rights Reserved.
Java is a trademark or registered trademark of Sun Microsystems, Inc. in the US and other countries.