OpenJDK 27 · com.sun.security.sasl.CramMD5Base · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
protected boolean	aborted
protected boolean	completed
protected static Logger	logger
private static final int	MD5_BLOCKSIZE
protected byte[]	pw
private static final String	SASL_LOGGER_NAME Logger for debug messages

Access	Constructor and Description
protected	CramMD5Base()

Method Summary

Modifier and Type	Method and Description
protected void	clearPassword()
public void	dispose()
protected void	finalize() Overrides java.lang.Object.finalize. Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
public String	Returns: The string "CRAM-MD5". getMechanismName() Retrieves this mechanism's name.
public Object	Returns: value of property; only QOP is applicable to CRAM-MD5. getNegotiatedProperty(String propName) Retrieves the negotiated property.
pack-priv static final String	HMAC_MD5(byte[] key, byte[] text) Hashes its input arguments according to HMAC-MD5 (RFC 2104) and returns the resulting digest in its ASCII representation.
private static synchronized void	initLogger() Sets logger field.
public boolean	Returns: true if has completed; false otherwise; isComplete() Determines whether this mechanism has completed.
public byte[]	unwrap(byte[] incoming, int offset, int len) Unwraps the incoming buffer.
public byte[]	wrap(byte[] outgoing, int offset, int len) Wraps the outgoing buffer.

Inherited from java.lang.Object:: clone equals getClass hashCode notify notifyAll toString wait wait wait

aborted	back to summary
protected boolean aborted

completed	back to summary
protected boolean completed

logger	back to summary
protected static Logger logger

MD5_BLOCKSIZE	back to summary
private static final int MD5_BLOCKSIZE

pw	back to summary
protected byte[] pw

SASL_LOGGER_NAME	back to summary
private static final String SASL_LOGGER_NAME Logger for debug messages

CramMD5Base	back to summary
protected CramMD5Base()

Method Detail

clearPassword	back to summary
protected void clearPassword()

dispose	back to summary
public void dispose() throws SaslException

finalize back to summary

finalize	back to summary
protected void finalize() Overrides java.lang.Object.finalize. Doc from java.lang.Object.finalize. Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. A subclass overrides the `finalize` method to dispose of system resources or to perform other cleanup. When running in a Java virtual machine in which finalization has been disabled or removed, the garbage collector will never call `finalize()`. In a Java virtual machine in which finalization is enabled, the garbage collector might call `finalize` only after an indefinite delay. The general contract of `finalize` is that it is invoked if and when the Java virtual machine has determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, except as a result of an action taken by the finalization of some other object or class which is ready to be finalized. The `finalize` method may take any action, including making this object available again to other threads; the usual purpose of `finalize`, however, is to perform cleanup actions before the object is irrevocably discarded. For example, the finalize method for an object that represents an input/output connection might perform explicit I/O transactions to break the connection before the object is permanently discarded. The `finalize` method of class `Object` performs no special action; it simply returns normally. Subclasses of `Object` may override this definition. The Java programming language does not guarantee which thread will invoke the `finalize` method for any given object. It is guaranteed, however, that the thread that invokes finalize will not be holding any user-visible synchronization locks when finalize is invoked. If an uncaught exception is thrown by the finalize method, the exception is ignored and finalization of that object terminates. After the `finalize` method has been invoked for an object, no further action is taken until the Java virtual machine has again determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, including possible actions by other objects or classes which are ready to be finalized, at which point the object may be discarded. The `finalize` method is never invoked more than once by a Java virtual machine for any given object. Any exception thrown by the `finalize` method causes the finalization of this object to be halted, but is otherwise ignored. Annotations @SuppressWarnings:removal

protected void finalize()

Overrides java.lang.Object.finalize.

Doc from java.lang.Object.finalize.

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. A subclass overrides the finalize method to dispose of system resources or to perform other cleanup.

When running in a Java virtual machine in which finalization has been disabled or removed, the garbage collector will never call finalize(). In a Java virtual machine in which finalization is enabled, the garbage collector might call finalize only after an indefinite delay.

The general contract of finalize is that it is invoked if and when the Java virtual machine has determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, except as a result of an action taken by the finalization of some other object or class which is ready to be finalized. The finalize method may take any action, including making this object available again to other threads; the usual purpose of finalize, however, is to perform cleanup actions before the object is irrevocably discarded. For example, the finalize method for an object that represents an input/output connection might perform explicit I/O transactions to break the connection before the object is permanently discarded.

The finalize method of class Object performs no special action; it simply returns normally. Subclasses of Object may override this definition.

The Java programming language does not guarantee which thread will invoke the finalize method for any given object. It is guaranteed, however, that the thread that invokes finalize will not be holding any user-visible synchronization locks when finalize is invoked. If an uncaught exception is thrown by the finalize method, the exception is ignored and finalization of that object terminates.

After the finalize method has been invoked for an object, no further action is taken until the Java virtual machine has again determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, including possible actions by other objects or classes which are ready to be finalized, at which point the object may be discarded.

The finalize method is never invoked more than once by a Java virtual machine for any given object.

Any exception thrown by the finalize method causes the finalization of this object to be halted, but is otherwise ignored.

Annotations

@SuppressWarnings:removal

getMechanismName	back to summary
public String getMechanismName() Retrieves this mechanism's name. Returns:String The string "CRAM-MD5".

getMechanismName

back to summary

public String getMechanismName()

Retrieves this mechanism's name.

Returns:String: The string "CRAM-MD5".

getNegotiatedProperty back to summary

getNegotiatedProperty	back to summary
public Object getNegotiatedProperty(String propName) Retrieves the negotiated property. This method can be called only after the authentication exchange has completed (i.e., when `isComplete()` returns true); otherwise, a `SaslException` is thrown. Returns:Object value of property; only QOP is applicable to CRAM-MD5. Exceptions IllegalStateException: if this authentication exchange has not completed

public Object getNegotiatedProperty(String propName)

Retrieves the negotiated property. This method can be called only after the authentication exchange has completed (i.e., when isComplete() returns true); otherwise, a SaslException is thrown.

Returns:Object

value of property; only QOP is applicable to CRAM-MD5.

Exceptions

IllegalStateException:: if this authentication exchange has not completed

HMAC_MD5	back to summary
pack-priv static final String HMAC_MD5(byte[] key, byte[] text) throws NoSuchAlgorithmException Hashes its input arguments according to HMAC-MD5 (RFC 2104) and returns the resulting digest in its ASCII representation. HMAC-MD5 function is described as follows: MD5(key XOR opad, MD5(key XOR ipad, text)) where key is an n byte key ipad is the byte 0x36 repeated 64 times opad is the byte 0x5c repeated 64 times text is the data to be protected

HMAC_MD5

back to summary

pack-priv static final String HMAC_MD5(byte[] key, byte[] text) throws NoSuchAlgorithmException

Hashes its input arguments according to HMAC-MD5 (RFC 2104) and returns the resulting digest in its ASCII representation. HMAC-MD5 function is described as follows: MD5(key XOR opad, MD5(key XOR ipad, text)) where key is an n byte key ipad is the byte 0x36 repeated 64 times opad is the byte 0x5c repeated 64 times text is the data to be protected

initLogger	back to summary
private static synchronized void initLogger() Sets logger field.

isComplete	back to summary
public boolean isComplete() Determines whether this mechanism has completed. CRAM-MD5 completes after processing one challenge from the server. Returns:boolean true if has completed; false otherwise;

isComplete

back to summary

public boolean isComplete()

Determines whether this mechanism has completed. CRAM-MD5 completes after processing one challenge from the server.

Returns:boolean: true if has completed; false otherwise;

unwrap	back to summary
public byte[] unwrap(byte[] incoming, int offset, int len) throws SaslException Unwraps the incoming buffer. CRAM-MD5 supports no security layer. Exceptions SaslException: If attempt to use this method.

unwrap

back to summary

public byte[] unwrap(byte[] incoming, int offset, int len) throws SaslException

Unwraps the incoming buffer. CRAM-MD5 supports no security layer.

Exceptions

SaslException:: If attempt to use this method.

wrap	back to summary
public byte[] wrap(byte[] outgoing, int offset, int len) throws SaslException Wraps the outgoing buffer. CRAM-MD5 supports no security layer. Exceptions SaslException: If attempt to use this method.

wrap

back to summary

public byte[] wrap(byte[] outgoing, int offset, int len) throws SaslException

Wraps the outgoing buffer. CRAM-MD5 supports no security layer.

Exceptions

SaslException:: If attempt to use this method.

pack-priv abstract Class CramMD5Base

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail