gnu.javax.crypto.key

Class OutgoingMessage


public class OutgoingMessage
extends Object

An implementation of outgoing messages for use with key agreement protocols.

Constructor Summary

OutgoingMessage()
The basic constructor.

Method Summary

byte[]
toByteArray()
Returns the encoded form of the current message including the 4-byte length header.
byte[]
wrap()
Returns the encoded form of the current message excluding the 4-byte length header.
void
writeMPI(BigInteger val)
Encodes an MPI into the message.
void
writePrivateKey(PrivateKey k)
Encodes a private key into the message.
void
writePublicKey(PublicKey k)
Encodes a public key into the message.
void
writeString(String s)
Encodes a string into the message.

Methods inherited from class java.lang.Object

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

Constructor Details

OutgoingMessage

public OutgoingMessage()
The basic constructor. Object is special, because it has no superclass, so there is no call to super().

Method Details

toByteArray

public byte[] toByteArray()
            throws KeyAgreementException
Returns the encoded form of the current message including the 4-byte length header.
Throws:
KeyAgreementException - if an encoding size constraint is violated.

wrap

public byte[] wrap()
            throws KeyAgreementException
Returns the encoded form of the current message excluding the 4-byte length header.
Throws:
KeyAgreementException - if an encoding size constraint is violated.

writeMPI

public void writeMPI(BigInteger val)
            throws KeyAgreementException
Encodes an MPI into the message.
Parameters:
val - the MPI to encode.
Throws:
KeyAgreementException - if an encoding size constraint is violated.

writePrivateKey

public void writePrivateKey(PrivateKey k)
            throws KeyAgreementException
Encodes a private key into the message.

When a private key is encoded into an outgoing message, the byte array of the encoded key --according to its encoding/decoding format specified when the key was first instantiated-- are put in the message (a) preceeded by one byte representing both the type of key (upper 4-bit) and the identifier of the format used (lower 4-bit), and (b) preceeed by a 4-byte entity representing the total length, excluding these 4 bytes, of the bytes representing the encoded key and the one-byte representing the key-type and format; i.e.

 key --> 4-byte-length || 1-byte-type-and-format || encoded-key-bytes
 
Parameters:
k - the private key to encode.
Throws:
KeyAgreementException - if an encoding size constraint is violated.

writePublicKey

public void writePublicKey(PublicKey k)
            throws KeyAgreementException
Encodes a public key into the message.

When a public key is encoded into an outgoing message, the byte array of the encoded key --according to its encoding/decoding format specified when the key was first instantiated-- are put in the message (a) preceeded by one byte representing both the type of key (upper 4-bit) and the identifier of the format used (lower 4-bit), and (b) preceeed by a 4-byte entity representing the total length, excluding these 4 bytes, of the bytes representing the encoded key and the one-byte representing the key-type and format; i.e.

 key --> 4-byte-length || 1-byte-type-and-format || encoded-key-bytes
 
Parameters:
k - the public key to encode.
Throws:
KeyAgreementException - if an encoding size constraint is violated.

writeString

public void writeString(String s)
            throws KeyAgreementException
Encodes a string into the message.
Parameters:
s - the string to encode.
Throws:
KeyAgreementException - if the UTF8 encoding is not supported on this platform, or if an encoding size constraint is violated.

OutgoingMessage.java -- Copyright (C) 2003, 2006 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.