/ 
Crypt-Sodium-XS-0.000039
River stage zero No dependents
/ Crypt::Sodium::XS::OO::shorthash

NAME

Crypt::Sodium::XS::OO::shorthash - Short-input hashing

SYNOPSIS

use Crypt::Sodium::XS;

my $shorthash = Crypt::Sodium::XS->shorthash;

my $key = $shorthash->keygen;
my $msg = "short input";

my $hash = $shorthash->shorthash($msg, $key);

DESCRIPTION

Crypt::Sodium::XS::OO::shorthash outputs short but unpredictable (without knowing the secret key) values suitable for picking a list in a hash table for a given key. This function is optimized for short inputs.

The output of this function is only 64 bits. Therefore, it should not be considered collision-resistant.

Use cases:

  • Hash tables

  • Probabilistic data structures such as Bloom filters

  • Integrity checking in interactive protocols

CONSTRUCTOR

new

my $shorthash
  = Crypt::Sodium::XS::OO::shorthash->new(primitive => 'siphash24');
my $shorthash = Crypt::Sodium::XS->shorthash;

Returns a new secretstream object for the given primitive. If not given, the default primitive is default.

ATTRIBUTES

primitive

my $primitive = $shorthash->primitive;
$shorthash->primitive('poly1305');

Gets or sets the primitive used for all operations by this object. Note this can be default.

METHODS

primitives

my @primitives = Crypt::Sodium::XS::OO::shorthash->primitives;
my @primitives = $shorthash->primitives;

Returns a list of all supported primitive names, including default.

Can be called as a class method.

PRIMITIVE

my $primitive = $shorthash->PRIMITIVE;

Returns the primitive used for all operations by this object. Note this will never be default but would instead be the primitive it represents.

keygen

my $key = $shorthash->keygen($flags);

$flags is optional. It is the flags used for the $key Crypt::Sodium::XS::MemVault. See Crypt::Sodium::XS::ProtMem.

Returns a Crypt::Sodium::XS::MemVault: a new secret key of "KEYBYTES" bytes.

shorthash

my $hash = $shorthash->shorthash($message, $key);

$message is the message to hash. It may be a Crypt::Sodium::XS::MemVault.

$key is the secret key used in the hash. It must be "KEYBYTES" bytes. It may be a Crypt::Sodium::XS::MemVault.

Returns the hash output of "BYTES" bytes.

BYTES

my $hash_size = $shorthash->BYTES;

Returns the size, in bytes, of hash output.

KEYBYTES

my $key_size = $shorthash->KEYBYTES;

Returns the size, in bytes, of a secret key.

SEE ALSO

Crypt::Sodium::XS
Crypt::Sodium::XS::shorthash
https://doc.libsodium.org/hashing/short-input_hashing

FEEDBACK

For reporting bugs, giving feedback, submitting patches, etc. please use the following:

AUTHOR

Brad Barden <perlmodules@5c30.org>

COPYRIGHT & LICENSE

Copyright (c) 2022 Brad Barden. All rights reserved.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.