Source for gnu.javax.crypto.jce.spec.BlockCipherParameterSpec

   1: /* BlockCipherParameterSpec.java --
   2:    Copyright (C) 2002, 2006  Free Software Foundation, Inc.
   3: 
   4: This file is a part of GNU Classpath.
   5: 
   6: GNU Classpath is free software; you can redistribute it and/or modify
   7: it under the terms of the GNU General Public License as published by
   8: the Free Software Foundation; either version 2 of the License, or (at
   9: your option) any later version.
  10: 
  11: GNU Classpath is distributed in the hope that it will be useful, but
  12: WITHOUT ANY WARRANTY; without even the implied warranty of
  13: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14: General Public License for more details.
  15: 
  16: You should have received a copy of the GNU General Public License
  17: along with GNU Classpath; if not, write to the Free Software
  18: Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301
  19: USA
  20: 
  21: Linking this library statically or dynamically with other modules is
  22: making a combined work based on this library.  Thus, the terms and
  23: conditions of the GNU General Public License cover the whole
  24: combination.
  25: 
  26: As a special exception, the copyright holders of this library give you
  27: permission to link this library with independent modules to produce an
  28: executable, regardless of the license terms of these independent
  29: modules, and to copy and distribute the resulting executable under
  30: terms of your choice, provided that you also meet, for each linked
  31: independent module, the terms and conditions of the license of that
  32: module.  An independent module is a module which is not derived from
  33: or based on this library.  If you modify this library, you may extend
  34: this exception to your version of the library, but you are not
  35: obligated to do so.  If you do not wish to do so, delete this
  36: exception statement from your version.  */
  37: 
  38: 
  39: package gnu.javax.crypto.jce.spec;
  40: 
  41: import gnu.java.security.util.Util;
  42: 
  43: import java.security.spec.AlgorithmParameterSpec;
  44: 
  45: /**
  46:  * Block cipher parameters in GNU are the cipher's name, its block and key
  47:  * sizes, and an optional initialization vector.
  48:  */
  49: public class BlockCipherParameterSpec
  50:     implements AlgorithmParameterSpec
  51: {
  52:   /** The initialization vector. */
  53:   protected byte[] iv;
  54:   /** The cipher's block size, in bytes. */
  55:   protected int blockSize;
  56:   /** The cipher's key size, in bytes. */
  57:   protected int keySize;
  58: 
  59:   /**
  60:    * Create a new parameter specification.
  61:    *
  62:    * @param iv The initialization vector, or <code>null</code> if there is no
  63:    *          IV.
  64:    * @param blockSize The cipher's block size, in bytes.
  65:    * @param keySize The cipher's key size, in bytes.
  66:    */
  67:   public BlockCipherParameterSpec(byte[] iv, int blockSize, int keySize)
  68:   {
  69:     this.iv = (iv != null) ? (byte[]) iv.clone() : null;
  70:     this.blockSize = blockSize;
  71:     this.keySize = keySize;
  72:   }
  73: 
  74:   /**
  75:    * Create a new parameter specification with no IV.
  76:    *
  77:    * @param blockSize The cipher's block size, in bytes.
  78:    * @param keySize The cipher's key size, in bytes.
  79:    */
  80:   public BlockCipherParameterSpec(int blockSize, int keySize)
  81:   {
  82:     this(null, blockSize, keySize);
  83:   }
  84: 
  85:   /**
  86:    * Get the initialization vector for the cipher, or <code>null</code> if
  87:    * there is no IV.
  88:    *
  89:    * @return The IV.
  90:    */
  91:   public byte[] getIV()
  92:   {
  93:     return iv;
  94:   }
  95: 
  96:   /**
  97:    * Get the block size of the cipher these parameters are for.
  98:    *
  99:    * @return The block size.
 100:    */
 101:   public int getBlockSize()
 102:   {
 103:     return blockSize;
 104:   }
 105: 
 106:   /**
 107:    * Get the key size of the cipher these parameters are for.
 108:    *
 109:    * @return The block size.
 110:    */
 111:   public int getKeySize()
 112:   {
 113:     return keySize;
 114:   }
 115: 
 116:   public String toString()
 117:   {
 118:     return getClass().getName() + " { "
 119:            + ((iv != null) ? ("IV=" + Util.toString(iv)) + ", " : "")
 120:            + "BS=" + blockSize + ", KS=" + keySize + " }";
 121:   }
 122: }