org.jboss.sasl.digest

Class DigestMD5Base.DigestPrivacy

java.lang.Object

org.jboss.sasl.digest.DigestMD5Base.DigestIntegrity

org.jboss.sasl.digest.DigestMD5Base.DigestPrivacy

All Implemented Interfaces:

SecurityCtx

Enclosing class:

DigestMD5Base

final class DigestMD5Base.DigestPrivacy
extends DigestMD5Base.DigestIntegrity
implements SecurityCtx

Implementation of the SecurityCtx interface allowing for messages between the client and server to be integrity checked and encrypted. After a successful DIGEST-MD5 authentication, privacy is invoked if the SASL QOP (quality-of-protection) is set to 'auth-conf'.

Further details on the integrity-protection mechanism can be found at section 2.4 - Confidentiality protection in RFC2831 definition.

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String	CLIENT_CONF_MAGIC
private javax.crypto.Cipher	decCipher
private javax.crypto.Cipher	encCipher
private static java.lang.String	SVR_CONF_MAGIC

Fields inherited from class org.jboss.sasl.digest.DigestMD5Base.DigestIntegrity

messageType, myKi, mySeqNum, peerKi, peerSeqNum, sequenceNum

Constructor Summary

Constructors

Constructor and Description
DigestPrivacy(boolean clientMode) Initializes the cipher object instances for encryption and decryption.

Method Summary

Modifier and Type	Method and Description
private void	generatePrivacyKeyPair(boolean clientMode) Generates client-server and server-client keys to encrypt and decrypt messages.
byte[]	unwrap(byte[] incoming, int start, int len) Return verified message without MAC - only if the received MAC and re-generated MAC are the same.
byte[]	wrap(byte[] outgoing, int start, int len) Encrypt out-going message.

Methods inherited from class org.jboss.sasl.digest.DigestMD5Base.DigestIntegrity

getHMAC, incrementSeqNum

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CLIENT_CONF_MAGIC

private static final java.lang.String CLIENT_CONF_MAGIC

See Also:

Constant Field Values

SVR_CONF_MAGIC

private static final java.lang.String SVR_CONF_MAGIC

See Also:

Constant Field Values

encCipher

private javax.crypto.Cipher encCipher

decCipher

private javax.crypto.Cipher decCipher

Constructor Detail

DigestPrivacy

DigestPrivacy(boolean clientMode)
       throws javax.security.sasl.SaslException

Initializes the cipher object instances for encryption and decryption.

Throws:

javax.security.sasl.SaslException - if an error occurs with the Key initialization, or a string cannot be encoded into a byte array using the UTF-8 encoding, or an error occurs when writing to a byte array output buffers or the mechanism cannot load the MD5 message digest algorithm or invalid initialization parameters are passed to the cipher object instances.

Method Detail

generatePrivacyKeyPair

private void generatePrivacyKeyPair(boolean clientMode)
                             throws java.io.IOException,
                                    java.security.NoSuchAlgorithmException

Generates client-server and server-client keys to encrypt and decrypt messages. Also generates IVs for DES ciphers.

Throws:

java.io.IOException - if an error occurs when writing to or from the byte array output buffers.

java.security.NoSuchAlgorithmException - if the MD5 message digest algorithm cannot loaded.

java.io.UnsupportedEncodingException - if an UTF-8 encoding is not supported on the platform.

javax.security.sasl.SaslException - if an error occurs initializing the keys and IVs for the chosen cipher.

wrap

public byte[] wrap(byte[] outgoing,
                   int start,
                   int len)
            throws javax.security.sasl.SaslException

Encrypt out-going message.

Specified by:

wrap in interface SecurityCtx

Overrides:

wrap in class DigestMD5Base.DigestIntegrity

Parameters:

outgoing - A non-null byte array containing the outgoing message.

start - The offset from which to read the byte array.

len - The non-zero number of bytes to be read from the offset.

Returns:

The encrypted message.

Throws:

javax.security.sasl.SaslException - if an error occurs when writing to or from the byte array output buffers or if the MD5 message digest algorithm cannot loaded or if an UTF-8 encoding is not supported on the platform.

unwrap

public byte[] unwrap(byte[] incoming,
                     int start,
                     int len)
              throws javax.security.sasl.SaslException

Description copied from class: DigestMD5Base.DigestIntegrity

Return verified message without MAC - only if the received MAC and re-generated MAC are the same.

Specified by:

unwrap in interface SecurityCtx

Overrides:

unwrap in class DigestMD5Base.DigestIntegrity

Parameters:

incoming - A non-null byte array containing the incoming message.

start - The offset from which to read the byte array.

len - The non-zero number of bytes to read from the offset position.

Returns:

The verified message or null if integrity checking fails.

Throws:

javax.security.sasl.SaslException