Skip to content

Commit

Permalink
add seraphis hash functions
Browse files Browse the repository at this point in the history
  • Loading branch information
UkoeHB committed May 21, 2024
1 parent 35eb5c1 commit efd6288
Show file tree
Hide file tree
Showing 3 changed files with 220 additions and 0 deletions.
1 change: 1 addition & 0 deletions src/seraphis_crypto/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@
# THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

set(seraphis_crypto_sources
sp_hash_functions.cpp
dummy.cpp)

monero_find_all_headers(seraphis_crypto_headers, "${CMAKE_CURRENT_SOURCE_DIR}")
Expand Down
150 changes: 150 additions & 0 deletions src/seraphis_crypto/sp_hash_functions.cpp
Original file line number Diff line number Diff line change
@@ -0,0 +1,150 @@
// Copyright (c) 2022, The Monero Project
//
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without modification, are
// permitted provided that the following conditions are met:
//
// 1. Redistributions of source code must retain the above copyright notice, this list of
// conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright notice, this list
// of conditions and the following disclaimer in the documentation and/or other
// materials provided with the distribution.
//
// 3. Neither the name of the copyright holder nor the names of its contributors may be
// used to endorse or promote products derived from this software without specific
// prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
// THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
// STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
// THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

//paired header
#include "sp_hash_functions.h"

//local headers
extern "C"
{
#include "crypto/crypto-ops.h"
}
#include "crypto/blake2b.h"
#include "misc_log_ex.h"

//third party headers

//standard headers


#undef MONERO_DEFAULT_LOG_CATEGORY
#define MONERO_DEFAULT_LOG_CATEGORY "seraphis"

namespace sp
{
//-------------------------------------------------------------------------------------------------------------------
// H_x[k](data)
// - if derivation_key == nullptr, then the hash is NOT keyed
//-------------------------------------------------------------------------------------------------------------------
static void hash_base(const void *derivation_key, //32 bytes
const void *data,
const std::size_t data_length,
void *hash_out,
const std::size_t out_length)
{
CHECK_AND_ASSERT_THROW_MES(blake2b(hash_out,
out_length,
data,
data_length,
derivation_key,
derivation_key ? 32 : 0) == 0,
"seraphis hash base: blake2b failed.");
}
//-------------------------------------------------------------------------------------------------------------------
//-------------------------------------------------------------------------------------------------------------------
void sp_hash_to_1(const void *data, const std::size_t data_length, void *hash_out)
{
// H_1(x): 1-byte output
hash_base(nullptr, data, data_length, hash_out, 1);
}
//-------------------------------------------------------------------------------------------------------------------
void sp_hash_to_2(const void *data, const std::size_t data_length, void *hash_out)
{
// H_2(x): 2-byte output
hash_base(nullptr, data, data_length, hash_out, 2);
}
//-------------------------------------------------------------------------------------------------------------------
void sp_hash_to_8(const void *data, const std::size_t data_length, void *hash_out)
{
// H_8(x): 8-byte output
hash_base(nullptr, data, data_length, hash_out, 8);
}
//-------------------------------------------------------------------------------------------------------------------
void sp_hash_to_16(const void *data, const std::size_t data_length, void *hash_out)
{
// H_16(x): 16-byte output
hash_base(nullptr, data, data_length, hash_out, 16);
}
//-------------------------------------------------------------------------------------------------------------------
void sp_hash_to_32(const void *data, const std::size_t data_length, void *hash_out)
{
// H_32(x): 32-byte output
hash_base(nullptr, data, data_length, hash_out, 32);
}
//-------------------------------------------------------------------------------------------------------------------
void sp_hash_to_64(const void *data, const std::size_t data_length, void *hash_out)
{
// H_64(x): 64-byte output
hash_base(nullptr, data, data_length, hash_out, 64);
}
//-------------------------------------------------------------------------------------------------------------------
void sp_hash_to_scalar(const void *data, const std::size_t data_length, void *hash_out)
{
// H_n(x): Ed25519 group scalar output (32 bytes)
// note: hash to 64 bytes then mod l
unsigned char temp[64];
hash_base(nullptr, data, data_length, temp, 64);
sc_reduce(temp); //mod l
memcpy(hash_out, temp, 32);
}
//-------------------------------------------------------------------------------------------------------------------
void sp_hash_to_x25519_scalar(const void *data, const std::size_t data_length, void *hash_out)
{
// H_n_x25519(x): canonical X25519 group scalar output (32 bytes)
// - bits 0, 1, 2, 255 set to zero
hash_base(nullptr, data, data_length, hash_out, 32);
reinterpret_cast<unsigned char*>(hash_out)[0] &= 255 - 7;
reinterpret_cast<unsigned char*>(hash_out)[31] &= 127;
}
//-------------------------------------------------------------------------------------------------------------------
void sp_derive_key(const void *derivation_key, const void *data, const std::size_t data_length, void *hash_out)
{
// H_n[k](x): Ed25519 group scalar output (32 bytes)
// note: hash to 64 bytes then mod l
unsigned char temp[64];
hash_base(derivation_key, data, data_length, temp, 64);
sc_reduce(temp); //mod l
memcpy(hash_out, temp, 32);
}
//-------------------------------------------------------------------------------------------------------------------
void sp_derive_secret(const void *derivation_key, const void *data, const std::size_t data_length, void *hash_out)
{
// H_32[k](x): 32-byte output
hash_base(derivation_key, data, data_length, hash_out, 32);
}
//-------------------------------------------------------------------------------------------------------------------
void sp_derive_x25519_key(const void *derivation_key, const void *data, const std::size_t data_length, void *hash_out)
{
// H_n_x25519[k](x): canonical X25519 group scalar output (32 bytes)
// - bits 0, 1, 2, 255 set to zero
hash_base(derivation_key, data, data_length, hash_out, 32);
reinterpret_cast<unsigned char*>(hash_out)[0] &= 255 - 7;
reinterpret_cast<unsigned char*>(hash_out)[31] &= 127;
}
//-------------------------------------------------------------------------------------------------------------------
} //namespace sp
69 changes: 69 additions & 0 deletions src/seraphis_crypto/sp_hash_functions.h
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
// Copyright (c) 2022, The Monero Project
//
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without modification, are
// permitted provided that the following conditions are met:
//
// 1. Redistributions of source code must retain the above copyright notice, this list of
// conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright notice, this list
// of conditions and the following disclaimer in the documentation and/or other
// materials provided with the distribution.
//
// 3. Neither the name of the copyright holder nor the names of its contributors may be
// used to endorse or promote products derived from this software without specific
// prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
// THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
// STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
// THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

// Core hash functions for Seraphis (note: this implementation satisfies the Jamtis specification).

#pragma once

//local headers

//third party headers

//standard headers
#include <cstddef>

//forward declarations


namespace sp
{

/// H_1(x): 1-byte output
void sp_hash_to_1(const void *data, const std::size_t data_length, void *hash_out);
/// H_2(x): 2-byte output
void sp_hash_to_2(const void *data, const std::size_t data_length, void *hash_out);
/// H_8(x): 8-byte output
void sp_hash_to_8(const void *data, const std::size_t data_length, void *hash_out);
/// H_16(x): 16-byte output
void sp_hash_to_16(const void *data, const std::size_t data_length, void *hash_out);
/// H_32(x): 32-byte output
void sp_hash_to_32(const void *data, const std::size_t data_length, void *hash_out);
/// H_64(x): 64-byte output
void sp_hash_to_64(const void *data, const std::size_t data_length, void *hash_out);
/// H_n(x): Ed25519 group scalar output (32 bytes)
void sp_hash_to_scalar(const void *data, const std::size_t data_length, void *hash_out);
/// H_n_x25519(x): canonical X25519 group scalar output (32 bytes)
void sp_hash_to_x25519_scalar(const void *data, const std::size_t data_length, void *hash_out);
/// H_n[k](x): 32-byte key; Ed25519 group scalar output (32 bytes)
void sp_derive_key(const void *derivation_key, const void *data, const std::size_t data_length, void *hash_out);
/// H_32[k](x): 32-byte key; 32-byte output
void sp_derive_secret(const void *derivation_key, const void *data, const std::size_t data_length, void *hash_out);
/// H_n_x25519[k](x): 32-byte key; canonical X25519 group scalar output (32 bytes)
void sp_derive_x25519_key(const void *derivation_key, const void *data, const std::size_t data_length, void *hash_out);

} //namespace sp

0 comments on commit efd6288

Please sign in to comment.