Botan::PolynomialVector Class Reference

#include <kyber_structures.h>

Public Member Functions
void	csubq ()
void	invntt_tomont ()
void	ntt ()
PolynomialVector &	operator+= (const PolynomialVector &other)
Polynomial &	operator[] (size_t idx)
	PolynomialVector ()=delete
	PolynomialVector (const size_t k)
void	reduce ()
template<concepts::resizable_byte_buffer T = secure_vector<uint8_t>>
T	to_bytes ()

Static Public Member Functions
static PolynomialVector	from_bytes (std::span< const uint8_t > a, const KyberConstants &mode)
static PolynomialVector	getnoise_eta1 (KyberSigmaOrEncryptionRandomness seed, uint8_t nonce, const KyberConstants &mode)
static PolynomialVector	getnoise_eta2 (StrongSpan< const KyberEncryptionRandomness > seed, uint8_t nonce, const KyberConstants &mode)
static Polynomial	pointwise_acc_montgomery (const PolynomialVector &a, const PolynomialVector &b)

Detailed Description

Definition at line 391 of file kyber_structures.h.

Constructor & Destructor Documentation

PolynomialVector() [1/2]

Botan::PolynomialVector::PolynomialVector ( )

delete

PolynomialVector() [2/2]

Botan::PolynomialVector::PolynomialVector ( const size_t k )

inlineexplicit

Definition at line 395 of file kyber_structures.h.

: m_vec(k) {}

Member Function Documentation

csubq()

void Botan::PolynomialVector::csubq ( )

inline

Applies conditional subtraction of q to each coefficient of each element of the vector of polynomials.

Definition at line 465 of file kyber_structures.h.

                   {
         for(auto& p : m_vec) {
            p.csubq();
         }
      }

from_bytes()

static PolynomialVector Botan::PolynomialVector::from_bytes ( std::span< const uint8_t > a, const KyberConstants & mode )

inlinestatic

Definition at line 398 of file kyber_structures.h.

                                                                                               {
         BOTAN_ASSERT(a.size() == mode.polynomial_vector_byte_length(), "wrong byte length for frombytes");
 
         PolynomialVector r(mode.k());
 
         BufferSlicer bs(a);
         for(size_t i = 0; i < mode.k(); ++i) {
            r.m_vec[i] = Polynomial::from_bytes(bs.take(KyberConstants::kSerializedPolynomialByteLength));
         }
         BOTAN_ASSERT_NOMSG(bs.empty());
 
         return r;
      }

References BOTAN_ASSERT, BOTAN_ASSERT_NOMSG, Botan::BufferSlicer::empty(), Botan::Polynomial::from_bytes(), Botan::KyberConstants::k(), Botan::KyberConstants::kSerializedPolynomialByteLength, Botan::KyberConstants::polynomial_vector_byte_length(), and Botan::BufferSlicer::take().

Referenced by Botan::Kyber_PrivateKey::Kyber_PrivateKey().

getnoise_eta1()

static PolynomialVector Botan::PolynomialVector::getnoise_eta1 ( KyberSigmaOrEncryptionRandomness seed, uint8_t nonce, const KyberConstants & mode )

inlinestatic

Definition at line 438 of file kyber_structures.h.

                                                                        {
         PolynomialVector r(mode.k());
         for(auto& p : r.m_vec) {
            p = Polynomial::getnoise_eta1(seed, nonce++, mode);
         }
         return r;
      }

References Botan::Polynomial::getnoise_eta1(), and Botan::KyberConstants::k().

Referenced by Botan::Kyber_PublicKeyInternal::indcpa_encrypt(), and Botan::Kyber_PrivateKey::Kyber_PrivateKey().

getnoise_eta2()

static PolynomialVector Botan::PolynomialVector::getnoise_eta2 ( StrongSpan< const KyberEncryptionRandomness > seed, uint8_t nonce, const KyberConstants & mode )

inlinestatic

Definition at line 428 of file kyber_structures.h.

                                                                        {
         PolynomialVector r(mode.k());
         for(auto& p : r.m_vec) {
            p = Polynomial::getnoise_eta2(seed, nonce++, mode);
         }
         return r;
      }

References Botan::Polynomial::getnoise_eta2(), and Botan::KyberConstants::k().

Referenced by Botan::Kyber_PublicKeyInternal::indcpa_encrypt().

invntt_tomont()

void Botan::PolynomialVector::invntt_tomont ( )

inline

Apply inverse NTT to all elements of a vector of polynomials and multiply by Montgomery factor 2^16.

Definition at line 494 of file kyber_structures.h.

                           {
         for(auto& v : m_vec) {
            v.invntt_tomont();
         }
      }

ntt()

void Botan::PolynomialVector::ntt ( )

inline

Apply forward NTT to all elements of a vector of polynomials.

Definition at line 503 of file kyber_structures.h.

                 {
         for(auto& v : m_vec) {
            v.ntt();
         }
      }

operator+=()

PolynomialVector & Botan::PolynomialVector::operator+= ( const PolynomialVector & other )

inline

Definition at line 471 of file kyber_structures.h.

                                                                  {
         BOTAN_ASSERT(m_vec.size() == other.m_vec.size(), "cannot add polynomial vectors of differing lengths");
 
         for(size_t i = 0; i < m_vec.size(); ++i) {
            m_vec[i] += other.m_vec[i];
         }
         return *this;
      }

References BOTAN_ASSERT.

operator[]()

Polynomial & Botan::PolynomialVector::operator[] ( size_t idx )

inline

Definition at line 480 of file kyber_structures.h.

{ return m_vec[idx]; }

pointwise_acc_montgomery()

static Polynomial Botan::PolynomialVector::pointwise_acc_montgomery ( const PolynomialVector & a, const PolynomialVector & b )

inlinestatic

Pointwise multiply elements of a and b, accumulate into r, and multiply by 2^-16.

Definition at line 415 of file kyber_structures.h.

                                                                                                       {
         BOTAN_ASSERT(a.m_vec.size() == b.m_vec.size(),
                      "pointwise_acc_montgomery works on equally sized "
                      "PolynomialVectors only");
 
         Polynomial r;
         for(size_t i = 0; i < a.m_vec.size(); ++i) {
            r += Polynomial::basemul_montgomery(a.m_vec[i], b.m_vec[i]);
         }
         r.reduce();
         return r;
      }

References Botan::Polynomial::basemul_montgomery(), BOTAN_ASSERT, and Botan::Polynomial::reduce().

Referenced by Botan::Kyber_PrivateKeyInternal::indcpa_decrypt(), Botan::Kyber_PublicKeyInternal::indcpa_encrypt(), and Botan::PolynomialMatrix::pointwise_acc_montgomery().

reduce()

void Botan::PolynomialVector::reduce ( )

inline

Applies Barrett reduction to each coefficient of each element of a vector of polynomials.

Definition at line 485 of file kyber_structures.h.

                    {
         for(auto& v : m_vec) {
            v.reduce();
         }
      }

to_bytes()

template<concepts::resizable_byte_buffer T = secure_vector<uint8_t>>

T Botan::PolynomialVector::to_bytes ( )

inline

Definition at line 449 of file kyber_structures.h.

                   {
         T r(m_vec.size() * KyberConstants::kSerializedPolynomialByteLength);
 
         BufferStuffer bs(r);
         for(auto& v : m_vec) {
            v.to_bytes(bs.next(KyberConstants::kSerializedPolynomialByteLength));
         }
         BOTAN_ASSERT_NOMSG(bs.full());
 
         return r;
      }

References BOTAN_ASSERT_NOMSG, Botan::BufferStuffer::full(), Botan::KyberConstants::kSerializedPolynomialByteLength, Botan::BufferStuffer::next(), and T.

---

The documentation for this class was generated from the following file:

• src/lib/pubkey/kyber/kyber_common/kyber_structures.h