Dash Core Source Documentation (0.16.0.1)

Find detailed information regarding the Dash Core source code.

sph_luffa.h File Reference

Luffa interface. More...

#include <stddef.h>
#include <crypto/sph_types.h>
+ Include dependency graph for sph_luffa.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  sph_luffa224_context
 This structure is a context for Luffa-224 computations: it contains the intermediate values and some data from the last entered block. More...
 
struct  sph_luffa384_context
 This structure is a context for Luffa-384 computations. More...
 
struct  sph_luffa512_context
 This structure is a context for Luffa-512 computations. More...
 

Macros

#define SPH_SIZE_luffa224   224
 Output size (in bits) for Luffa-224. More...
 
#define SPH_SIZE_luffa256   256
 Output size (in bits) for Luffa-256. More...
 
#define SPH_SIZE_luffa384   384
 Output size (in bits) for Luffa-384. More...
 
#define SPH_SIZE_luffa512   512
 Output size (in bits) for Luffa-512. More...
 

Typedefs

typedef sph_luffa224_context sph_luffa256_context
 This structure is a context for Luffa-256 computations. More...
 

Functions

void sph_luffa224_init (void *cc)
 Initialize a Luffa-224 context. More...
 
void sph_luffa224 (void *cc, const void *data, size_t len)
 Process some data bytes. More...
 
void sph_luffa224_close (void *cc, void *dst)
 Terminate the current Luffa-224 computation and output the result into the provided buffer. More...
 
void sph_luffa224_addbits_and_close (void *cc, unsigned ub, unsigned n, void *dst)
 Add a few additional bits (0 to 7) to the current computation, then terminate it and output the result in the provided buffer, which must be wide enough to accomodate the result (28 bytes). More...
 
void sph_luffa256_init (void *cc)
 Initialize a Luffa-256 context. More...
 
void sph_luffa256 (void *cc, const void *data, size_t len)
 Process some data bytes. More...
 
void sph_luffa256_close (void *cc, void *dst)
 Terminate the current Luffa-256 computation and output the result into the provided buffer. More...
 
void sph_luffa256_addbits_and_close (void *cc, unsigned ub, unsigned n, void *dst)
 Add a few additional bits (0 to 7) to the current computation, then terminate it and output the result in the provided buffer, which must be wide enough to accomodate the result (32 bytes). More...
 
void sph_luffa384_init (void *cc)
 Initialize a Luffa-384 context. More...
 
void sph_luffa384 (void *cc, const void *data, size_t len)
 Process some data bytes. More...
 
void sph_luffa384_close (void *cc, void *dst)
 Terminate the current Luffa-384 computation and output the result into the provided buffer. More...
 
void sph_luffa384_addbits_and_close (void *cc, unsigned ub, unsigned n, void *dst)
 Add a few additional bits (0 to 7) to the current computation, then terminate it and output the result in the provided buffer, which must be wide enough to accomodate the result (48 bytes). More...
 
void sph_luffa512_init (void *cc)
 Initialize a Luffa-512 context. More...
 
void sph_luffa512 (void *cc, const void *data, size_t len)
 Process some data bytes. More...
 
void sph_luffa512_close (void *cc, void *dst)
 Terminate the current Luffa-512 computation and output the result into the provided buffer. More...
 
void sph_luffa512_addbits_and_close (void *cc, unsigned ub, unsigned n, void *dst)
 Add a few additional bits (0 to 7) to the current computation, then terminate it and output the result in the provided buffer, which must be wide enough to accomodate the result (64 bytes). More...
 

Detailed Description

Luffa interface.

Luffa is a family of functions which differ by their output size; this implementation defines Luffa for output sizes 224, 256, 384 and 512 bits.

==========================(LICENSE BEGIN)============================

Copyright (c) 2007-2010 Projet RNRT SAPHIR

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

===========================(LICENSE END)=============================

Author
Thomas Pornin thoma.nosp@m.s.po.nosp@m.rnin@.nosp@m.cryp.nosp@m.tolog.nosp@m..com

Definition in file sph_luffa.h.

Macro Definition Documentation

◆ SPH_SIZE_luffa224

#define SPH_SIZE_luffa224   224

Output size (in bits) for Luffa-224.

Definition at line 49 of file sph_luffa.h.

◆ SPH_SIZE_luffa256

#define SPH_SIZE_luffa256   256

Output size (in bits) for Luffa-256.

Definition at line 54 of file sph_luffa.h.

◆ SPH_SIZE_luffa384

#define SPH_SIZE_luffa384   384

Output size (in bits) for Luffa-384.

Definition at line 59 of file sph_luffa.h.

◆ SPH_SIZE_luffa512

#define SPH_SIZE_luffa512   512

Output size (in bits) for Luffa-512.

Definition at line 64 of file sph_luffa.h.

Typedef Documentation

◆ sph_luffa256_context

This structure is a context for Luffa-256 computations.

It is identical to sph_luffa224_context.

Definition at line 88 of file sph_luffa.h.

Function Documentation

◆ sph_luffa224()

void sph_luffa224 ( void *  cc,
const void *  data,
size_t  len 
)

Process some data bytes.

It is acceptable that len is zero (in which case this function does nothing).

Parameters
ccthe Luffa-224 context
datathe input data
lenthe input data length (in bytes)

Definition at line 1305 of file luffa.c.

References luffa3().

◆ sph_luffa224_addbits_and_close()

void sph_luffa224_addbits_and_close ( void *  cc,
unsigned  ub,
unsigned  n,
void *  dst 
)

Add a few additional bits (0 to 7) to the current computation, then terminate it and output the result in the provided buffer, which must be wide enough to accomodate the result (28 bytes).

If bit number i in ub has value 2^i, then the extra bits are those numbered 7 downto 8-n (this is the big-endian convention at the byte level). The context is automatically reinitialized.

Parameters
ccthe Luffa-224 context
ubthe extra bits
nthe number of extra bits (0 to 7)
dstthe destination buffer

Definition at line 1319 of file luffa.c.

References luffa3_close(), and sph_luffa224_init().

Referenced by sph_luffa224_close().

◆ sph_luffa224_close()

void sph_luffa224_close ( void *  cc,
void *  dst 
)

Terminate the current Luffa-224 computation and output the result into the provided buffer.

The destination buffer must be wide enough to accomodate the result (28 bytes). The context is automatically reinitialized.

Parameters
ccthe Luffa-224 context
dstthe destination buffer

Definition at line 1312 of file luffa.c.

References sph_luffa224_addbits_and_close().

◆ sph_luffa224_init()

void sph_luffa224_init ( void *  cc)

Initialize a Luffa-224 context.

This process performs no memory allocation.

Parameters
ccthe Luffa-224 context (pointer to a sph_luffa224_context)

Definition at line 1294 of file luffa.c.

References memcpy(), sph_luffa224_context::ptr, sph_luffa224_context::V, and V_INIT.

Referenced by sph_luffa224_addbits_and_close().

◆ sph_luffa256()

void sph_luffa256 ( void *  cc,
const void *  data,
size_t  len 
)

Process some data bytes.

It is acceptable that len is zero (in which case this function does nothing).

Parameters
ccthe Luffa-256 context
datathe input data
lenthe input data length (in bytes)

Definition at line 1338 of file luffa.c.

References luffa3().

◆ sph_luffa256_addbits_and_close()

void sph_luffa256_addbits_and_close ( void *  cc,
unsigned  ub,
unsigned  n,
void *  dst 
)

Add a few additional bits (0 to 7) to the current computation, then terminate it and output the result in the provided buffer, which must be wide enough to accomodate the result (32 bytes).

If bit number i in ub has value 2^i, then the extra bits are those numbered 7 downto 8-n (this is the big-endian convention at the byte level). The context is automatically reinitialized.

Parameters
ccthe Luffa-256 context
ubthe extra bits
nthe number of extra bits (0 to 7)
dstthe destination buffer

Definition at line 1352 of file luffa.c.

References luffa3_close(), and sph_luffa256_init().

Referenced by sph_luffa256_close().

◆ sph_luffa256_close()

void sph_luffa256_close ( void *  cc,
void *  dst 
)

Terminate the current Luffa-256 computation and output the result into the provided buffer.

The destination buffer must be wide enough to accomodate the result (32 bytes). The context is automatically reinitialized.

Parameters
ccthe Luffa-256 context
dstthe destination buffer

Definition at line 1345 of file luffa.c.

References sph_luffa256_addbits_and_close().

◆ sph_luffa256_init()

void sph_luffa256_init ( void *  cc)

Initialize a Luffa-256 context.

This process performs no memory allocation.

Parameters
ccthe Luffa-256 context (pointer to a sph_luffa256_context)

Definition at line 1327 of file luffa.c.

References memcpy(), sph_luffa224_context::ptr, sph_luffa224_context::V, and V_INIT.

Referenced by sph_luffa256_addbits_and_close().

◆ sph_luffa384()

void sph_luffa384 ( void *  cc,
const void *  data,
size_t  len 
)

Process some data bytes.

It is acceptable that len is zero (in which case this function does nothing).

Parameters
ccthe Luffa-384 context
datathe input data
lenthe input data length (in bytes)

Definition at line 1371 of file luffa.c.

References luffa4().

◆ sph_luffa384_addbits_and_close()

void sph_luffa384_addbits_and_close ( void *  cc,
unsigned  ub,
unsigned  n,
void *  dst 
)

Add a few additional bits (0 to 7) to the current computation, then terminate it and output the result in the provided buffer, which must be wide enough to accomodate the result (48 bytes).

If bit number i in ub has value 2^i, then the extra bits are those numbered 7 downto 8-n (this is the big-endian convention at the byte level). The context is automatically reinitialized.

Parameters
ccthe Luffa-384 context
ubthe extra bits
nthe number of extra bits (0 to 7)
dstthe destination buffer

Definition at line 1385 of file luffa.c.

References luffa4_close(), and sph_luffa384_init().

Referenced by sph_luffa384_close().

◆ sph_luffa384_close()

void sph_luffa384_close ( void *  cc,
void *  dst 
)

Terminate the current Luffa-384 computation and output the result into the provided buffer.

The destination buffer must be wide enough to accomodate the result (48 bytes). The context is automatically reinitialized.

Parameters
ccthe Luffa-384 context
dstthe destination buffer

Definition at line 1378 of file luffa.c.

References sph_luffa384_addbits_and_close().

◆ sph_luffa384_init()

void sph_luffa384_init ( void *  cc)

Initialize a Luffa-384 context.

This process performs no memory allocation.

Parameters
ccthe Luffa-384 context (pointer to a sph_luffa384_context)

Definition at line 1360 of file luffa.c.

References memcpy(), sph_luffa384_context::ptr, sph_luffa384_context::V, and V_INIT.

Referenced by sph_luffa384_addbits_and_close().

◆ sph_luffa512()

void sph_luffa512 ( void *  cc,
const void *  data,
size_t  len 
)

Process some data bytes.

It is acceptable that len is zero (in which case this function does nothing).

Parameters
ccthe Luffa-512 context
datathe input data
lenthe input data length (in bytes)

Definition at line 1404 of file luffa.c.

References luffa5().

Referenced by HashX11().

◆ sph_luffa512_addbits_and_close()

void sph_luffa512_addbits_and_close ( void *  cc,
unsigned  ub,
unsigned  n,
void *  dst 
)

Add a few additional bits (0 to 7) to the current computation, then terminate it and output the result in the provided buffer, which must be wide enough to accomodate the result (64 bytes).

If bit number i in ub has value 2^i, then the extra bits are those numbered 7 downto 8-n (this is the big-endian convention at the byte level). The context is automatically reinitialized.

Parameters
ccthe Luffa-512 context
ubthe extra bits
nthe number of extra bits (0 to 7)
dstthe destination buffer

Definition at line 1418 of file luffa.c.

References luffa5_close(), and sph_luffa512_init().

Referenced by sph_luffa512_close().

◆ sph_luffa512_close()

void sph_luffa512_close ( void *  cc,
void *  dst 
)

Terminate the current Luffa-512 computation and output the result into the provided buffer.

The destination buffer must be wide enough to accomodate the result (64 bytes). The context is automatically reinitialized.

Parameters
ccthe Luffa-512 context
dstthe destination buffer

Definition at line 1411 of file luffa.c.

References sph_luffa512_addbits_and_close().

Referenced by HashX11().

◆ sph_luffa512_init()

void sph_luffa512_init ( void *  cc)

Initialize a Luffa-512 context.

This process performs no memory allocation.

Parameters
ccthe Luffa-512 context (pointer to a sph_luffa512_context)

Definition at line 1393 of file luffa.c.

References memcpy(), sph_luffa512_context::ptr, sph_luffa512_context::V, and V_INIT.

Referenced by HashX11(), and sph_luffa512_addbits_and_close().

Released under the MIT license