Package com.identity4j.util.crypt.impl

Class AbstractUnixSHAEncoder

java.lang.Object

com.identity4j.util.crypt.impl.AbstractEncoder

com.identity4j.util.crypt.impl.AbstractUnixSHAEncoder

All Implemented Interfaces:

Encoder

Direct Known Subclasses:

UnixSHA256Encoder, UnixSHA512Encoder

public abstract class AbstractUnixSHAEncoder
extends AbstractEncoder

Constructor Summary

Constructors

Constructor	Description
AbstractUnixSHAEncoder(String id, String saltPrefix, int size)

Method Summary

Modifier and Type	Method	Description
protected abstract String	doCrypt(byte[] unencodedData, String charset, String salt)
byte[]	encode(byte[] toEncode, byte[] salt, byte[] passphrase, String charset)	Encode a string
boolean	isOfType(byte[] encodedBytes, String charset)	Determine if this encoder may have been used to create the provided encoded bytes.
boolean	match(byte[] encodedData, byte[] unencodedData, byte[] passphrase, String charset)	Check if the provide un-encoded data would match the encoded data if it was encoded.

Methods inherited from class com.identity4j.util.crypt.impl.AbstractEncoder

decode, getId, randomBytes

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractUnixSHAEncoder

public AbstractUnixSHAEncoder(String id,
                              String saltPrefix,
                              int size)

Method Detail

match

public boolean match(byte[] encodedData,
                     byte[] unencodedData,
                     byte[] passphrase,
                     String charset)
              throws EncoderException

Description copied from interface: Encoder

Check if the provide un-encoded data would match the encoded data if it was encoded.

Specified by:

match in interface Encoder

Overrides:

match in class AbstractEncoder

Parameters:

encodedData - encoded data

unencodedData - un-encoded data

passphrase - passphrase if supported

charset - character set

Returns:

matches

Throws:

EncoderException

doCrypt

protected abstract String doCrypt(byte[] unencodedData,
                                  String charset,
                                  String salt)
                           throws UnsupportedEncodingException

Throws:

UnsupportedEncodingException

isOfType

public boolean isOfType(byte[] encodedBytes,
                        String charset)

Description copied from interface: Encoder

Determine if this encoder may have been used to create the provided encoded bytes. This method should only be used if it is very likely to be the right encoder.

Specified by:

isOfType in interface Encoder

Overrides:

isOfType in class AbstractEncoder

Parameters:

encodedBytes - encoded bytes

charset - character set

Returns:

this almost certainly was encoded with a similar encoder

encode

public byte[] encode(byte[] toEncode,
                     byte[] salt,
                     byte[] passphrase,
                     String charset)
              throws EncoderException

Description copied from interface: Encoder

Encode a string

Parameters:

toEncode - data to encode

salt - salt if supported

passphrase - passphrase if supported

charset - character set

Returns:

encoded bytes

Throws:

EncoderException - if encoding fails