libjava/classpath/gnu/javax/net/ssl/provider/SecurityParameters.java

   1 /* SecurityParameters.java -- SSL security parameters.
   2    Copyright (C) 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.net.ssl.provider;
  40
  41 import javax.net.ssl.SSLException;
  42
  43 /**
  44  * The interface that all security parameters used by Jessie must implement.
  45  * Security parameters handle all transforming of data, including encryption,
  46  * authentication, and compression.
  47  */
  48 interface SecurityParameters
  49 {
  50
  51   // Methods.
  52   // -------------------------------------------------------------------------
  53
  54   /**
  55    * Decrypts, verifies, and inflates a fragment received. The fragment is
  56    * just the data field of a text object, without the version, type, and
  57    * length fields. An exception is thrown if any step fails.
  58    *
  59    * @param fragment The fragment being decrypted.
  60    * @param version  The version field of the received text.
  61    * @param type     The type field of the received text.
  62    * @return The decrypted fragment.
  63    * @throws MacException If the MAC could not be verified, or if the padding
  64    *         on the decrypted fragment is incorrect.
  65    * @throws OverflowException If the processed text overflows the configured
  66    *         maximum fragment size.
  67    * @throws SSLException If any other error occurs.
  68    */
  69   byte[] decrypt (byte[] fragment, ProtocolVersion version, ContentType type)
  70     throws MacException, OverflowException, SSLException;
  71
  72   /**
  73    * Deflates, authenticates, and encrypts a fragment to be sent.
  74    *
  75    * @param buf The fragment being encrypted.
  76    * @param off The offset into the buffer to start at.
  77    * @param len The number of bytes in this fragment.
  78    * @param type The content type of this text.
  79    * @return The encrypted fragment.
  80    * @throws OverflowException If deflating increases the size of the fragment
  81    *         too much.
  82    * @throws SSLException If any other error occurs.
  83    */
  84   byte[] encrypt (byte[] buf, int off, int len, ContentType type)
  85     throws OverflowException, SSLException;
  86
  87   /**
  88    * Set all crypto primitives to <code>null</code>, meaning that any calls
  89    * to {@link #encrypt(byte[],int,int,org.metastatic.jessie.provider.ContentType)} or
  90    * {@link #decrypt(byte[],org.metastatic.jessie.provider.ProtocolVersion,org.metastatic.jessie.provider.ContentType})
  91    * will perform the identity transformation.
  92    */
  93   void reset();
  94
  95   /**
  96    * Returns the version of texts being sent.
  97    *
  98    * @return The version.
  99    */
 100   ProtocolVersion getVersion();
 101
 102   /**
 103    * Sets the version of texts being sent. This affects the {@link
 104    * #encrypt(byte[],int,int,org.metastatic.jessie.provider.ContentType)}
 105    * method.
 106    *
 107    * @param version The version to set.
 108    */
 109   void setVersion (ProtocolVersion version);
 110
 111   /**
 112    * Turns zlib deflating on or off.
 113    *
 114    * @param deflate Whether or not to deflate outgoing fragments.
 115    */
 116   void setDeflating (boolean deflate);
 117
 118   /**
 119    * Turns zlib inflating on or off.
 120    *
 121    * @param inflate Whether or not to inflate incoming fragments.
 122    */
 123   void setInflating (boolean inflate);
 124
 125   /**
 126    * Returns the maximum size that plaintext fragments may be.
 127    *
 128    * @return The fragment length.
 129    */
 130   int getFragmentLength();
 131
 132   /**
 133    * Sets the maximum size that plaintext fragments may be.
 134    *
 135    * @param fragmentLength The new fragment length.
 136    */
 137   void setFragmentLength (int fragmentLength);
 138
 139   /**
 140    * Set the cipher used to decrypt incoming fragments. The parameter must be
 141    * appropriate for the implementation.
 142    *
 143    * @param cipher The cipher.
 144    * @throws ClassCastException If the argument is not appropriate for the
 145    *         implementation.
 146    */
 147   void setInCipher (Object cipher);
 148
 149   /**
 150    * Set the cipher used to encrypt outgoing fragments. The parameter must be
 151    * appropriate for the implementation.
 152    *
 153    * @param cipher The cipher.
 154    * @throws ClassCastException If the argument is not appropriate for the
 155    *         implementation.
 156    */
 157   void setOutCipher (Object cipher);
 158
 159   /**
 160    * Set the MAC used to verify incoming fragments. The parameter must be
 161    * appropriate for the implementation.
 162    *
 163    * @param mac The MAC.
 164    * @throws ClassCastException If the argument is not appropriate for the
 165    *         implementation.
 166    */
 167   void setInMac (Object mac);
 168
 169   /**
 170    * Set the MAC used to authenticating outgoinging fragments. The parameter
 171    * must be appropriate for the implementation.
 172    *
 173    * @param mac The MAC.
 174    * @throws ClassCastException If the argument is not appropriate for the
 175    *         implementation.
 176    */
 177   void setOutMac (Object mac);
 178 }