gnu.javax.crypto.jce.params

Class BlockCipherParameters


public class BlockCipherParameters
extends AlgorithmParametersSpi

An implementation of algorithm parameters for the GNU block ciphers. This encompasses the cipher's block size, its key size, and an optional initialization vector (IV).

Field Summary

protected BlockCipherParameterSpec
cipherSpec
The underlying block cipher specification.

Method Summary

protected byte[]
engineGetEncoded()
Return these parameters encoded in ASN.1 (DER).
protected byte[]
engineGetEncoded(String format)
Returns the parameters in the specified encoding format.
protected AlgorithmParameterSpec
engineGetParameterSpec(Class<T> c)
protected void
engineInit(byte[] encoded)
Initializes the engine with the specified parameters stored in the byte array and decodes them according to the ASN.1 specification.
protected void
engineInit(byte[] encoded, String format)
Initializes the engine with the specified parameters stored in the byte array and decodes them according to the specified decoding specification.
protected void
engineInit(AlgorithmParameterSpec spec)
Initializes the engine with the specified AlgorithmParameterSpec class.
protected String
engineToString()
Returns a string describing the parameters in the AlgorithmParametersSpi class.

Methods inherited from class java.security.AlgorithmParametersSpi

engineGetEncoded, engineGetEncoded, engineInit, engineInit, engineInit, engineToString, extends AlgorithmParameterSpec> T engineGetParameterSpec

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

cipherSpec

protected BlockCipherParameterSpec cipherSpec
The underlying block cipher specification.

Method Details

engineGetEncoded

protected byte[] engineGetEncoded()
            throws IOException
Return these parameters encoded in ASN.1 (DER).

For GNU block ciphers we will define these parameters as

 BlockCipherParameters ::= SEQUENCE {
    blockSize            INTEGER,
    keySize              INTEGER,
    initializationVector OCTET STRING OPTIONAL }
 
Overrides:
engineGetEncoded in interface AlgorithmParametersSpi
Returns:
The parameters, encoded an an ASN.1 DER sequence.
Throws:
IOException - If encoding these parameters fails.

engineGetEncoded

protected byte[] engineGetEncoded(String format)
            throws IOException
Returns the parameters in the specified encoding format. If format is null then the primary encoding format is used, the ASN.1 format, if it exists for the specified type.
Overrides:
engineGetEncoded in interface AlgorithmParametersSpi
Returns:
byte array representing the parameters

engineGetParameterSpec

protected AlgorithmParameterSpec engineGetParameterSpec(Class<T> c)
            throws InvalidParameterSpecException

engineInit

protected void engineInit(byte[] encoded)
            throws IOException
Initializes the engine with the specified parameters stored in the byte array and decodes them according to the ASN.1 specification. If the ASN.1 specification exists then it succeeds or else it throws IOException.
Overrides:
engineInit in interface AlgorithmParametersSpi
Parameters:
Throws:
IOException - Decoding Error

engineInit

protected void engineInit(byte[] encoded,
                          String format)
            throws IOException
Initializes the engine with the specified parameters stored in the byte array and decodes them according to the specified decoding specification. If format is null, then it is decoded using the ASN.1 specification if it exists or else it throws IOException.
Overrides:
engineInit in interface AlgorithmParametersSpi
Parameters:
format - Name of decoding format to use
Throws:
IOException - Decoding Error

engineInit

protected void engineInit(AlgorithmParameterSpec spec)
            throws InvalidParameterSpecException
Initializes the engine with the specified AlgorithmParameterSpec class.
Overrides:
engineInit in interface AlgorithmParametersSpi
Parameters:
Throws:
InvalidParameterSpecException - For an inapporiate ParameterSpec class

engineToString

protected String engineToString()
Returns a string describing the parameters in the AlgorithmParametersSpi class.
Overrides:
engineToString in interface AlgorithmParametersSpi
Returns:
A string representing the format of the parameters.

BlockCipherParameters.java -- Copyright (C) 2002, 2003, 2006, 2010 Free Software Foundation, Inc. This file is a part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.