secp/secp_k1/base_field.hpp

Go to the documentation of this file.

//---------------------------------------------------------------------------//
// Copyright (c) 2021 Mikhail Komarov <nemo@nil.foundation>
// Copyright (c) 2021 Ilias Khairullin <ilias@nil.foundation>
//
// MIT License
//
// 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.
//---------------------------------------------------------------------------//
 
#ifndef CRYPTO3_ALGEBRA_FIELDS_SECP_K1_BASE_FIELD_HPP
#define CRYPTO3_ALGEBRA_FIELDS_SECP_K1_BASE_FIELD_HPP
 
#include <nil/crypto3/algebra/fields/detail/element/fp.hpp>
 
#include <nil/crypto3/algebra/fields/params.hpp>
#include <nil/crypto3/algebra/fields/field.hpp>
 
#include <nil/crypto3/detail/literals.hpp>
 
namespace nil {
    namespace crypto3 {
        namespace algebra {
            namespace fields {
 
                template<std::size_t Version>
                struct secp_k1_base_field;
 
                template<>
                struct secp_k1_base_field<160> : public field<160> {
                    typedef field<160> policy_type;
 
                    constexpr static const std::size_t modulus_bits = policy_type::modulus_bits;
                    typedef typename policy_type::integral_type integral_type;
 
                    typedef typename policy_type::extended_integral_type extended_integral_type;
 
                    constexpr static const std::size_t number_bits = policy_type::number_bits;
 
                    constexpr static const integral_type modulus = 0xfffffffffffffffffffffffffffffffeffffac73_cppui160;
 
                    typedef typename policy_type::modular_backend modular_backend;
                    constexpr static const modular_params_type modulus_params = modulus;
                    typedef nil::crypto3::multiprecision::number<
                        nil::crypto3::multiprecision::backends::modular_adaptor<modular_backend, nil::crypto3::multiprecision::backends::modular_params_ct<modular_backend, modulus_params>>>
                        modular_type;
 
                    typedef typename detail::element_fp<params<secp_k1_base_field<160>>> value_type;
 
                    constexpr static const std::size_t value_bits = modulus_bits;
                    constexpr static const std::size_t arity = 1;
                };
 
                template<>
                struct secp_k1_base_field<192> : public field<192> {
                    typedef field<192> policy_type;
 
                    constexpr static const std::size_t modulus_bits = policy_type::modulus_bits;
                    typedef typename policy_type::integral_type integral_type;
 
                    typedef typename policy_type::extended_integral_type extended_integral_type;
 
                    constexpr static const std::size_t number_bits = policy_type::number_bits;
 
                    constexpr static const integral_type modulus =
                        0xfffffffffffffffffffffffffffffffffffffffeffffee37_cppui192;
 
                    typedef typename policy_type::modular_backend modular_backend;
                    constexpr static const modular_params_type modulus_params = modulus;
                    typedef nil::crypto3::multiprecision::number<
                        nil::crypto3::multiprecision::backends::modular_adaptor<modular_backend, nil::crypto3::multiprecision::backends::modular_params_ct<modular_backend, modulus_params>>>
                        modular_type;
 
                    typedef typename detail::element_fp<params<secp_k1_base_field<192>>> value_type;
 
                    constexpr static const std::size_t value_bits = modulus_bits;
                    constexpr static const std::size_t arity = 1;
                };
 
                template<>
                struct secp_k1_base_field<224> : public field<224> {
                    typedef field<224> policy_type;
 
                    constexpr static const std::size_t modulus_bits = policy_type::modulus_bits;
                    typedef typename policy_type::integral_type integral_type;
 
                    typedef typename policy_type::extended_integral_type extended_integral_type;
 
                    constexpr static const std::size_t number_bits = policy_type::number_bits;
 
                    constexpr static const integral_type modulus =
                        0xfffffffffffffffffffffffffffffffffffffffffffffffeffffe56d_cppui224;
 
                    typedef typename policy_type::modular_backend modular_backend;
                    constexpr static const modular_params_type modulus_params = modulus;
                    typedef nil::crypto3::multiprecision::number<
                        nil::crypto3::multiprecision::backends::modular_adaptor<modular_backend, nil::crypto3::multiprecision::backends::modular_params_ct<modular_backend, modulus_params>>>
                        modular_type;
 
                    typedef typename detail::element_fp<params<secp_k1_base_field<224>>> value_type;
 
                    constexpr static const std::size_t value_bits = modulus_bits;
                    constexpr static const std::size_t arity = 1;
                };
 
                template<>
                struct secp_k1_base_field<256> : public field<256> {
                    typedef field<256> policy_type;
 
                    constexpr static const std::size_t modulus_bits = policy_type::modulus_bits;
                    typedef typename policy_type::integral_type integral_type;
 
                    typedef typename policy_type::extended_integral_type extended_integral_type;
 
                    constexpr static const std::size_t number_bits = policy_type::number_bits;
 
                    constexpr static const integral_type modulus =
                        0xfffffffffffffffffffffffffffffffffffffffffffffffffffffffefffffc2f_cppui256;
 
                    typedef typename policy_type::modular_backend modular_backend;
                    constexpr static const modular_params_type modulus_params = modulus;
                    typedef nil::crypto3::multiprecision::number<
                        nil::crypto3::multiprecision::backends::modular_adaptor<modular_backend, nil::crypto3::multiprecision::backends::modular_params_ct<modular_backend, modulus_params>>>
                        modular_type;
 
                    typedef typename detail::element_fp<params<secp_k1_base_field<256>>> value_type;
 
                    constexpr static const std::size_t value_bits = modulus_bits;
                    constexpr static const std::size_t arity = 1;
                };
 
                // TODO: define nist_base_field for other base field sizes
 
                template<std::size_t Version>
                using secp_k1_fq = secp_k1_base_field<Version>;
 
                constexpr typename std::size_t const secp_k1_fq<160>::modulus_bits;
                constexpr typename std::size_t const secp_k1_fq<160>::number_bits;
                constexpr typename std::size_t const secp_k1_fq<160>::value_bits;
                constexpr typename secp_k1_fq<160>::integral_type const secp_k1_fq<160>::modulus;
 
                constexpr typename std::size_t const secp_k1_fq<192>::modulus_bits;
                constexpr typename std::size_t const secp_k1_fq<192>::number_bits;
                constexpr typename std::size_t const secp_k1_fq<192>::value_bits;
                constexpr typename secp_k1_fq<192>::integral_type const secp_k1_fq<192>::modulus;
 
                constexpr typename std::size_t const secp_k1_fq<224>::modulus_bits;
                constexpr typename std::size_t const secp_k1_fq<224>::number_bits;
                constexpr typename std::size_t const secp_k1_fq<224>::value_bits;
                constexpr typename secp_k1_fq<224>::integral_type const secp_k1_fq<224>::modulus;
 
                constexpr typename std::size_t const secp_k1_fq<256>::modulus_bits;
                constexpr typename std::size_t const secp_k1_fq<256>::number_bits;
                constexpr typename std::size_t const secp_k1_fq<256>::value_bits;
                constexpr typename secp_k1_fq<256>::integral_type const secp_k1_fq<256>::modulus;
            }    // namespace fields
        }        // namespace algebra
    }            // namespace crypto3
}    // namespace nil
 
#endif    // CRYPTO3_ALGEBRA_FIELDS_NIST_BASE_FIELD_HPP