Package com.goterl.lazysodium.interfaces

Interface PwHash.Lazy

All Known Implementing Classes:

LazySodium, LazySodiumJava

Enclosing interface:

PwHash

public static interface PwHash.Lazy

Method Summary

Modifier and Type	Method	Description
String	cryptoPwHash(String password, int cryptoPwHashLen, byte[] salt, long opsLimit, com.sun.jna.NativeLong memLimit, PwHash.Alg alg)	Hashes a given password.
String	cryptoPwHashStr(String password, long opsLimit, com.sun.jna.NativeLong memLimit)	Deprecated. Uses dumb result format; use cryptoPwHashString(String, long, NativeLong) instead.
String	cryptoPwHashString(String password, long opsLimit, com.sun.jna.NativeLong memLimit)	The most minimal way of hashing a given password to a standard-format string including all used parameters.
PwHash.NeedsRehashResult	cryptoPwHashStringNeedsRehash(String hash, long opsLimit, com.sun.jna.NativeLong memLimit)	Checks whether the hash needs a rehash.
boolean	cryptoPwHashStringVerify(String hash, String password)	Verifies a password represented as a standard-formatted hash, generated by cryptoPwHashString(String, long, NativeLong).
String	cryptoPwHashStrRemoveNulls(String password, long opsLimit, com.sun.jna.NativeLong memLimit)	Deprecated. Uses dumb result format; use cryptoPwHashString(String, long, NativeLong) instead.
boolean	cryptoPwHashStrVerify(String hash, String password)	Deprecated. Uses dumb hash format; use cryptoPwHashStringVerify(String, String) instead.

Method Details

cryptoPwHash

String cryptoPwHash(String password,
 int cryptoPwHashLen,
 byte[] salt,
 long opsLimit,
 com.sun.jna.NativeLong memLimit,
 PwHash.Alg alg)
             throws SodiumException

Hashes a given password.

Parameters:

cryptoPwHashLen - The hash size that you want. Anything between PwHash.BYTES_MIN and PwHash.BYTES_MAX

password - The password to hash.

salt - A salt to use with the hash, generated randomly.

opsLimit - The number of cycles to perform whilst hashing. Between PwHash.OPSLIMIT_MIN and PwHash.OPSLIMIT_MAX.

memLimit - The amount of memory to use. Between PwHash.MEMLIMIT_MIN and PwHash.MEMLIMIT_MAX.

alg - The algorithm to use. Defaults to PwHash.Alg.PWHASH_ALG_ARGON2ID13.

Returns:

A hash of the password in bytes, encoded to string.

Throws:

SodiumException - If the password is too short or the opsLimit is not correct.

cryptoPwHashString

String cryptoPwHashString(String password,
 long opsLimit,
 com.sun.jna.NativeLong memLimit)
                   throws SodiumException

The most minimal way of hashing a given password to a standard-format string including all used parameters. We auto-generate the salt and use the default hashing algorithm PwHash.Alg.

Parameters:

password - The password string to hash.

opsLimit - The number of cycles to perform whilst hashing. Between PwHash.OPSLIMIT_MIN and PwHash.OPSLIMIT_MAX.

memLimit - The amount of memory to use. Between PwHash.MEMLIMIT_MIN and PwHash.MEMLIMIT_MAX.

Returns:

The hashed password in a standard format, including all used parameters.

Throws:

SodiumException - If the password could not be hashed.

See Also:

• cryptoPwHashStringVerify(String, String)

cryptoPwHashStr

@Deprecated
String cryptoPwHashStr(String password,
 long opsLimit,
 com.sun.jna.NativeLong memLimit)
                throws SodiumException

Deprecated.

Uses dumb result format; use cryptoPwHashString(String, long, NativeLong) instead.

The most minimal way of hashing a given password to a string including all used parameters. We auto-generate the salt and use the default hashing algorithm PwHash.Alg.

Parameters:

password - The password string to hash.

opsLimit - The number of cycles to perform whilst hashing. Between PwHash.OPSLIMIT_MIN and PwHash.OPSLIMIT_MAX.

memLimit - The amount of memory to use. Between PwHash.MEMLIMIT_MIN and PwHash.MEMLIMIT_MAX.

Returns:

The hashed password represented as a long encoded string, which includes useless null bytes.

Throws:

SodiumException - If the password could not be hashed.

See Also:

• cryptoPwHashStrRemoveNulls(String, long, NativeLong)
• cryptoPwHashStrVerify(String, String)

cryptoPwHashStrRemoveNulls

@Deprecated
String cryptoPwHashStrRemoveNulls(String password,
 long opsLimit,
 com.sun.jna.NativeLong memLimit)
                           throws SodiumException

Deprecated.

Uses dumb result format; use cryptoPwHashString(String, long, NativeLong) instead.

Hashes a string to a string representation including the used parameters, and removes all useless null bytes. Uses the hashing algorithm PwHash.Alg.

Parameters:

password - The password string to hash.

opsLimit - The number of cycles to perform whilst hashing. Between PwHash.OPSLIMIT_MIN and PwHash.OPSLIMIT_MAX.

memLimit - The amount of memory to use. Between PwHash.MEMLIMIT_MIN and PwHash.MEMLIMIT_MAX.

Returns:

The hash and all used parameters represented as a long hexadecimal string.

Throws:

SodiumException - If the password could not be hashed.

See Also:

• cryptoPwHashStrVerify(String, String)

cryptoPwHashStrVerify

@Deprecated
boolean cryptoPwHashStrVerify(String hash,
 String password)

Deprecated.

Uses dumb hash format; use cryptoPwHashStringVerify(String, String) instead.

Verifies a password represented as a long encoded string generated by cryptoPwHashStr(String, long, NativeLong) or cryptoPwHashStrRemoveNulls(String, long, NativeLong).

Parameters:

hash - The encoded hash generated by cryptoPwHashStr(String, long, NativeLong) or cryptoPwHashStrRemoveNulls(String, long, NativeLong)

password - The password.

Returns:

True if the password matches the hash, false otherwise.

cryptoPwHashStringVerify

boolean cryptoPwHashStringVerify(String hash,
 String password)

Verifies a password represented as a standard-formatted hash, generated by cryptoPwHashString(String, long, NativeLong).

Parameters:

hash - Standard-formatted hash

password - The password.

Returns:

True if the password matches the hash, false otherwise.

cryptoPwHashStringNeedsRehash

PwHash.NeedsRehashResult cryptoPwHashStringNeedsRehash(String hash,
 long opsLimit,
 com.sun.jna.NativeLong memLimit)

Checks whether the hash needs a rehash.

Parameters:

hash - Standard-formatted hash generated by cryptoPwHashString(String, long, NativeLong).

opsLimit - The operations limit which should be used.

memLimit - The memory limit which should be used.

Returns:

Whether the hash should be rehashed.