CipherSpi.java 17.2 KB
Newer Older
Tom Tromey committed
1
/* CipherSpi.java -- The cipher service provider interface.
2
   Copyright (C) 2004, 2006  Free Software Foundation, Inc.
Tom Tromey committed
3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40

This file is 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, 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; see the file COPYING.  If not, write to the
Free Software Foundation, Inc., 51 Franklin Street, 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. */


package javax.crypto;

41 42
import java.nio.ByteBuffer;

Tom Tromey committed
43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183
import java.security.AlgorithmParameters;
import java.security.InvalidAlgorithmParameterException;
import java.security.InvalidKeyException;
import java.security.Key;
import java.security.NoSuchAlgorithmException;
import java.security.SecureRandom;
import java.security.spec.AlgorithmParameterSpec;

/**
 * <p>This class represents the <i>Service Provider Interface</i>
 * (<b>SPI</b>) for cryptographic ciphers.</p>
 *
 * <p>Providers of cryptographic ciphers must subclass this for every
 * cipher they implement, implementing the abstract methods as
 * appropriate, then provide an entry that points to the subclass in
 * their implementation of {@link java.security.Provider}.</p>
 *
 * <p>CipherSpi objects are instantiated along with {@link Cipher}s when
 * the {@link Cipher#getInstance(java.lang.String)} methods are invoked.
 * Particular ciphers are referenced by a <i>transformation</i>, which
 * is a String consisting of the cipher's name or the ciper's name
 * followed by a mode and a padding. Transformations all follow the
 * general form:</p>
 *
 * <ul>
 * <li><i>algorithm</i>, or</li>
 * <li><i>algorithm</i>/<i>mode</i>/<i>padding</i>
 * </ul>
 *
 * <p>Cipher names in the master {@link java.security.Provider} class
 * may be:</p>
 *
 * <ol>
 * <li>The algorithm's name, which uses a pluggable mode and padding:
 * <code>Cipher.<i>algorithm</i></code></li>
 * <li>The algorithm's name and the mode, which uses pluggable padding:
 * <code>Cipher.<i>algorithm</i>/<i>mode</i></code></li>
 * <li>The algorithm's name and the padding, which uses a pluggable
 * mode: <code>Cipher.<i>algorithm</i>//<i>padding</i></code></li>
 * <li>The algorihtm's name, the mode, and the padding:
 * <code>Cipher.<i>algorithm</i>/<i>mode</i>/<i>padding</i></code></li>
 * </ol>
 *
 * <p>When any {@link Cipher#getInstance(java.lang.String)} method is
 * invoked, the following happens if the transformation is simply
 * <i>algorithm</i>:</p>
 *
 * <ol>
 * <li>If the provider defines a <code>CipherSpi</code> implementation
 * for "<i>algorithm</i>", return it. Otherwise throw a {@link
 * java.security.NoSuchAlgorithmException}.</li>
 * </ol>
 *
 * <p>If the transformation is of the form
 * <i>algorithm</i>/<i>mode</i>/<i>padding</i>:</p>
 *
 * <ol>
 * <li>If the provider defines a <code>CipherSpi</code> subclass for
 * "<i>algorithm</i>/<i>mode</i>/<i>padding</i>", return it. Otherwise
 * go to step 2.</li>
 *
 * <li>If the provider defines a <code>CipherSpi</code> subclass for
 * "<i>algorithm</i>/<i>mode</i>", instatiate it, call {@link
 * #engineSetPadding(java.lang.String)} for the padding name, and return
 * it. Otherwise go to step 3.</li>
 *
 * <li>If the provider defines a <code>CipherSpi</code> subclass for
 * "<i>algorithm</i>//<i>padding</i>", instatiate it, call {@link
 * #engineSetMode(java.lang.String)} for the mode name, and return
 * it. Otherwise go to step 4.</li>
 *
 * <li>If the provider defines a <code>CipherSpi</code> subclass for
 * "<i>algorithm</i>", instatiate it, call {@link
 * #engineSetMode(java.lang.String)} for the mode name, call {@link
 * #engineSetPadding(java.lang.String)} for the padding name, and return
 * it. Otherwise throw a {@link java.security.NoSuchAlgorithmException}.</li>
 * </ol>
 *
 * @author Casey Marshall (csm@gnu.org)
 * @since 1.4
 */
public abstract class CipherSpi
{

  // Constructors.
  // ------------------------------------------------------------------------

  /**
   * Create a new CipherSpi.
   */
  public CipherSpi()
  {
  }

  // Abstract methods to be implemented by providers.
  // ------------------------------------------------------------------------

  /**
   * Finishes a multi-part transformation or transforms a portion of a
   * byte array, and returns the transformed bytes.
   *
   * @param input       The input bytes.
   * @param inputOffset The index in the input at which to start.
   * @param inputLength The number of bytes to transform.
   * @return The transformed bytes in a new array.
   * @throws javax.crypto.IllegalBlockSizeException If this instance has
   *         no padding and the input size is not a multiple of the
   *         block size.
   * @throws javax.crypto.BadPaddingException If this instance is being
   *         used for decryption and the padding is not appropriate for
   *         this instance's padding scheme.
   */
  protected abstract byte[]
  engineDoFinal(byte[] input, int inputOffset, int inputLength)
  throws IllegalBlockSizeException, BadPaddingException;

  /**
   * Finishes a multi-part transformation or transforms a portion of a
   * byte array, and stores the transformed bytes in the supplied array.
   *
   * @param input        The input bytes.
   * @param inputOffset  The index in the input at which to start.
   * @param inputLength  The number of bytes to transform.
   * @param output       The output byte array.
   * @param outputOffset The index in the output array at which to start.
   * @return The number of transformed bytes stored in the output array.
   * @throws javax.crypto.IllegalBlockSizeException If this instance has
   *         no padding and the input size is not a multiple of the
   *         block size.
   * @throws javax.crypto.BadPaddingException If this instance is being
   *         used for decryption and the padding is not appropriate for
   *         this instance's padding scheme.
   * @throws javax.crypto.ShortBufferException If there is not enough
   *         space in the output array for the transformed bytes.
   */
  protected abstract int
  engineDoFinal(byte[] input, int inputOffset, int inputLength,
                byte[] output, int outputOffset)
  throws IllegalBlockSizeException, BadPaddingException, ShortBufferException;

  /**
184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208
   * @since 1.5
   */
  protected int engineDoFinal (ByteBuffer input, ByteBuffer output)
    throws BadPaddingException, IllegalBlockSizeException,
           ShortBufferException
  {
    int total = 0;
    byte[] inbuf = new byte[256];
    while (input.hasRemaining ())
      {
        int in = Math.min (inbuf.length, input.remaining ());
        input.get (inbuf, 0, in);
        byte[] outbuf = new byte[engineGetOutputSize (in)];
        int out = 0;
        if (input.hasRemaining ()) // i.e., we have more 'update' calls
          out = engineUpdate (inbuf, 0, in, outbuf, 0);
        else
          out = engineDoFinal (inbuf, 0, in, outbuf, 0);
        output.put (outbuf, 0, out);
        total += out;
      }
    return total;
  }

  /**
Tom Tromey committed
209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409
   * Returns the block size of the underlying cipher.
   *
   * @return The block size.
   */
  protected abstract int engineGetBlockSize();

  /**
   * Returns the initializaiton vector this cipher was initialized with,
   * if any.
   *
   * @return The IV, or null if this cipher uses no IV or if this
   *         instance has not been initialized yet.
   */
  protected abstract byte[] engineGetIV();

  /**
   * <p>Return the length of the given key in bits.</p>
   *
   * <p>For compatibility this method is not declared
   * <code>abstract</code>, and the default implementation will throw an
   * {@link java.lang.UnsupportedOperationException}. Concrete
   * subclasses should override this method to return the correct
   * value.</p>
   *
   * @param key The key to get the size for.
   * @return The size of the key, in bits.
   * @throws java.security.InvalidKeyException If the key's length
   *         cannot be determined by this implementation.
   */
  protected int engineGetKeySize(Key key) throws InvalidKeyException
  {
    throw new UnsupportedOperationException();
  }

  /**
   * <p>Returns the size, in bytes, an output buffer must be for a call
   * to {@link #engineUpdate(byte[],int,int,byte[],int)} or {@link
   * #engineDoFinal(byte[],int,int,byte[],int)} to succeed.</p>
   *
   * <p>The actual output length may be smaller than the value returned
   * by this method, as it considers the padding length as well. The
   * length considered is the argument plus the length of any buffered,
   * unprocessed bytes.</p>
   *
   * @param inputLength The input length, in bytes.
   * @return The size an output buffer must be.
   */
  protected abstract int engineGetOutputSize(int inputLength);

  /**
   * Returns the parameters that this cipher is using. This may be the
   * parameters used to initialize this cipher, or it may be parameters
   * that have been initialized with random values.
   *
   * @return This cipher's parameters, or <code>null</code> if this
   *         cipher does not use parameters.
   */
  protected abstract AlgorithmParameters engineGetParameters();

  /**
   * Initializes this cipher with an operation mode, key, and source of
   * randomness. If this cipher requires any other initializing data,
   * for example an initialization vector, then it should generate it
   * from the provided source of randomness.
   *
   * @param opmode The operation mode, one of {@link
   *        Cipher#DECRYPT_MODE}, {@link Cipher#ENCRYPT_MODE}, {@link
   *        Cipher#UNWRAP_MODE}, or {@link Cipher#WRAP_MODE}.
   * @param key    The key to initialize this cipher with.
   * @param random The source of random bytes to use.
   * @throws java.security.InvalidKeyException If the given key is not
   *         acceptable for this implementation.
   */
  protected abstract void engineInit(int opmode, Key key, SecureRandom random)
  throws InvalidKeyException;

  /**
   * Initializes this cipher with an operation mode, key, parameters,
   * and source of randomness. If this cipher requires any other
   * initializing data, for example an initialization vector, then it should
   * generate it from the provided source of randomness.
   *
   * @param opmode The operation mode, one of {@link
   *        Cipher#DECRYPT_MODE}, {@link Cipher#ENCRYPT_MODE}, {@link
   *        Cipher#UNWRAP_MODE}, or {@link Cipher#WRAP_MODE}.
   * @param key    The key to initialize this cipher with.
   * @param params The algorithm parameters to initialize with.
   * @param random The source of random bytes to use.
   * @throws java.security.InvalidAlgorithmParameterException If the
   *         given parameters are not appropriate for this
   *         implementation.
   * @throws java.security.InvalidKeyException If the given key is not
   *         acceptable for this implementation.
   */
  protected abstract void
  engineInit(int opmode, Key key, AlgorithmParameters params,
             SecureRandom random)
  throws InvalidAlgorithmParameterException, InvalidKeyException;

  /**
   * Initializes this cipher with an operation mode, key, parameters,
   * and source of randomness. If this cipher requires any other
   * initializing data, for example an initialization vector, then it should
   * generate it from the provided source of randomness.
   *
   * @param opmode The operation mode, one of {@link
   *        Cipher#DECRYPT_MODE}, {@link Cipher#ENCRYPT_MODE}, {@link
   *        Cipher#UNWRAP_MODE}, or {@link Cipher#WRAP_MODE}.
   * @param key    The key to initialize this cipher with.
   * @param params The algorithm parameters to initialize with.
   * @param random The source of random bytes to use.
   * @throws java.security.InvalidAlgorithmParameterException If the
   *         given parameters are not appropriate for this
   *         implementation.
   * @throws java.security.InvalidKeyException If the given key is not
   *         acceptable for this implementation.
   */
  protected abstract void
  engineInit(int opmode, Key key, AlgorithmParameterSpec params,
             SecureRandom random)
  throws InvalidAlgorithmParameterException, InvalidKeyException;

  /**
   * Set the mode in which this cipher is to run.
   *
   * @param mode The name of the mode to use.
   * @throws java.security.NoSuchAlgorithmException If the mode is
   *         not supported by this cipher's provider.
   */
  protected abstract void engineSetMode(String mode)
  throws NoSuchAlgorithmException;

  /**
   * Set the method with which the input is to be padded.
   *
   * @param padding The name of the padding to use.
   * @throws javax.crypto.NoSuchPaddingException If the padding is not
   *         supported by this cipher's provider.
   */
  protected abstract void engineSetPadding(String padding)
  throws NoSuchPaddingException;

  /**
   * <p>Unwraps a previously-wrapped key.</p>
   *
   * <p>For compatibility this method is not declared
   * <code>abstract</code>, and the default implementation will throw an
   * {@link java.lang.UnsupportedOperationException}.</p>
   *
   * @param wrappedKey          The wrapped key.
   * @param wrappedKeyAlgorithm The name of the algorithm used to wrap
   *                            this key.
   * @param wrappedKeyType      The type of wrapped key; one of
   *                            {@link Cipher#PRIVATE_KEY},
   *                            {@link Cipher#PUBLIC_KEY}, or
   *                            {@link Cipher#SECRET_KEY}.
   * @return The unwrapped key.
   * @throws java.security.InvalidKeyException If the key cannot be
   *         unwrapped, or if <code>wrappedKeyType</code> is an
   *         inappropriate type for the unwrapped key.
   * @throws java.security.NoSuchAlgorithmException If the
   *         <code>wrappedKeyAlgorithm</code> is unknown.
   */
  protected Key engineUnwrap(byte[] wrappedKey, String wrappedKeyAlgorithm,
                             int wrappedKeyType)
  throws InvalidKeyException, NoSuchAlgorithmException
  {
    throw new UnsupportedOperationException();
  }

  /**
   * Continue with a multi-part transformation, returning a new array of
   * the transformed bytes.
   *
   * @param input       The next input bytes.
   * @param inputOffset The index in the input array from which to start.
   * @param inputLength The number of bytes to input.
   * @return The transformed bytes.
   */
  protected abstract byte[]
  engineUpdate(byte[] input, int inputOffset, int inputLength);

  /**
   * Continue with a multi-part transformation, storing the transformed
   * bytes into the specified array.
   *
   * @param input        The next input bytes.
   * @param inputOffset  The index in the input from which to start.
   * @param inputLength  The number of bytes to input.
   * @param output       The output buffer.
   * @param outputOffset The index in the output array from which to start.
   * @return The transformed bytes.
   * @throws javax.crypto.ShortBufferException If there is not enough
   *         space in the output array to store the transformed bytes.
   */
  protected abstract int
  engineUpdate(byte[] input, int inputOffset, int inputLength,
               byte[] output, int outputOffset)
  throws ShortBufferException;

  /**
410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429
   * @since 1.5
   */
  protected int engineUpdate (ByteBuffer input, ByteBuffer output)
    throws ShortBufferException
  {
    int total = 0;
    byte[] inbuf = new byte[256];
    while (input.hasRemaining ())
      {
        int in = Math.min (inbuf.length, input.remaining ());
        input.get (inbuf, 0, in);
        byte[] outbuf = new byte[engineGetOutputSize (in)];
        int out = engineUpdate (inbuf, 0, in, outbuf, 0);
        output.put (outbuf, 0, out);
        total += out;
      }
    return total;
  }

  /**
Tom Tromey committed
430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445
   * <p>Wrap a key.</p>
   *
   * <p>For compatibility this method is not declared
   * <code>abstract</code>, and the default implementation will throw an
   * {@link java.lang.UnsupportedOperationException}.</p>
   *
   * @param key The key to wrap.
   * @return The wrapped key.
   * @throws java.security.InvalidKeyException If the key cannot be
   *         wrapped.
   */
  protected byte[] engineWrap(Key key) throws InvalidKeyException, IllegalBlockSizeException
  {
    throw new UnsupportedOperationException();
  }
}