/src/openssl/crypto/ml_dsa/ml_dsa_poly.h

Source
/*
 * Copyright 2024-2025 The OpenSSL Project Authors. All Rights Reserved.
 *
 * Licensed under the Apache License 2.0 (the "License").  You may not use
 * this file except in compliance with the License.  You can obtain a copy
 * in the file LICENSE in the source distribution or at
 * https://www.openssl.org/source/license.html
 */
#if !defined(OSSL_LIBCRYPTO_ML_DSA_ML_DSA_POLY_H)
#define OSSL_LIBCRYPTO_ML_DSA_ML_DSA_POLY_H

#include <openssl/crypto.h>

#include "internal/common.h"
#include "ml_dsa_local.h"

#define ML_DSA_NUM_POLY_COEFFICIENTS 256

/* Polynomial object with 256 coefficients. The coefficients are unsigned 32 bits */
struct poly_st {
#if defined(VX_COMPILER_SUPPORT_VEC128)
    ALIGN16 uint32_t coeff[ML_DSA_NUM_POLY_COEFFICIENTS];
#else
    uint32_t coeff[ML_DSA_NUM_POLY_COEFFICIENTS];
#endif
};

static ossl_inline ossl_unused void
poly_zero(POLY *p)
{
    memset(p->coeff, 0, sizeof(*p));
}

/**
 * @brief Polynomial addition.
 *
 * @param lhs A polynomial with coefficients in the range (0..q-1)
 * @param rhs A polynomial with coefficients in the range (0..q-1) to add
 *            to the 'lhs'.
 * @param out The returned addition result with the coefficients all in the
 *            range 0..q-1
 */
static ossl_inline ossl_unused void
poly_add(const POLY *lhs, const POLY *rhs, POLY *out)
{
    int i;

    for (i = 0; i < ML_DSA_NUM_POLY_COEFFICIENTS; i++)
        out->coeff[i] = reduce_once(lhs->coeff[i] + rhs->coeff[i]);
}

/**
 * @brief Polynomial subtraction.
 *
 * @param lhs A polynomial with coefficients in the range (0..q-1)
 * @param rhs A polynomial with coefficients in the range (0..q-1) to subtract
 *            from the 'lhs'.
 * @param out The returned subtraction result with the coefficients all in the
 *            range 0..q-1
 */
static ossl_inline ossl_unused void
poly_sub(const POLY *lhs, const POLY *rhs, POLY *out)
{
    int i;

    for (i = 0; i < ML_DSA_NUM_POLY_COEFFICIENTS; i++)
        out->coeff[i] = mod_sub(lhs->coeff[i], rhs->coeff[i]);
}

/* @returns 1 if the polynomials are equal, or 0 otherwise */
static ossl_inline ossl_unused int
poly_equal(const POLY *a, const POLY *b)
{
    return CRYPTO_memcmp(a, b, sizeof(*a)) == 0;
}

static ossl_inline ossl_unused void
poly_ntt(POLY *p)
{
    ossl_ml_dsa_poly_ntt(p);
}

static ossl_inline ossl_unused int
poly_sample_in_ball_ntt(POLY *out, const uint8_t *seed, int seed_len,
    EVP_MD_CTX *h_ctx, const EVP_MD *md, uint32_t tau)
{
    if (!ossl_ml_dsa_poly_sample_in_ball(out, seed, seed_len, h_ctx, md, tau))
        return 0;
    poly_ntt(out);
    return 1;
}

static ossl_inline ossl_unused int
poly_expand_mask(POLY *out, const uint8_t *seed, size_t seed_len,
    uint32_t gamma1, EVP_MD_CTX *h_ctx, const EVP_MD *md)
{
    return ossl_ml_dsa_poly_expand_mask(out, seed, seed_len, gamma1, h_ctx, md);
}

/**
 * @brief Decompose the coefficients of a polynomial into (r1, r0) such that
 * coeff[i] == t1[i] * 2^13 + t0[i] mod q
 * See FIPS 204, Algorithm 35, Power2Round()
 *
 * @param t A polynomial containing coefficients in the range 0..q-1
 * @param t1 The returned polynomial containing coefficients that represent
 *           the top 10 MSB of each coefficient in t (i.e each ranging from 0..1023)
 * @param t0 The remainder coefficients of t in the range (0..4096 or q-4095..q-1)
 *           Each t0 coefficient has an effective range of 8192 (i.e. 13 bits).
 */
static ossl_inline ossl_unused void
poly_power2_round(const POLY *t, POLY *t1, POLY *t0)
{
    int i;

    for (i = 0; i < ML_DSA_NUM_POLY_COEFFICIENTS; i++)
        ossl_ml_dsa_key_compress_power2_round(t->coeff[i],
            t1->coeff + i, t0->coeff + i);
}

static ossl_inline ossl_unused void
poly_scale_power2_round(POLY *in, POLY *out)
{
    int i;

    for (i = 0; i < ML_DSA_NUM_POLY_COEFFICIENTS; i++)
        out->coeff[i] = (in->coeff[i] << ML_DSA_D_BITS);
}

static ossl_inline ossl_unused void
poly_high_bits(const POLY *in, uint32_t gamma2, POLY *out)
{
    int i;

    for (i = 0; i < ML_DSA_NUM_POLY_COEFFICIENTS; i++)
        out->coeff[i] = ossl_ml_dsa_key_compress_high_bits(in->coeff[i], gamma2);
}

static ossl_inline ossl_unused void
poly_low_bits(const POLY *in, uint32_t gamma2, POLY *out)
{
    int i;

    for (i = 0; i < ML_DSA_NUM_POLY_COEFFICIENTS; i++)
        out->coeff[i] = ossl_ml_dsa_key_compress_low_bits(in->coeff[i], gamma2);
}

static ossl_inline ossl_unused void
poly_make_hint(const POLY *ct0, const POLY *cs2, const POLY *w, uint32_t gamma2,
    POLY *out)
{
    int i;

    for (i = 0; i < ML_DSA_NUM_POLY_COEFFICIENTS; i++)
        out->coeff[i] = ossl_ml_dsa_key_compress_make_hint(ct0->coeff[i],
            cs2->coeff[i],
            gamma2, w->coeff[i]);
}

static ossl_inline ossl_unused void
poly_use_hint(const POLY *h, const POLY *r, uint32_t gamma2, POLY *out)
{
    int i;

    for (i = 0; i < ML_DSA_NUM_POLY_COEFFICIENTS; i++)
        out->coeff[i] = ossl_ml_dsa_key_compress_use_hint(h->coeff[i],
            r->coeff[i], gamma2);
}

static ossl_inline ossl_unused void
poly_max(const POLY *p, uint32_t *mx)
{
    int i;

    for (i = 0; i < ML_DSA_NUM_POLY_COEFFICIENTS; i++) {
        uint32_t c = p->coeff[i];
        uint32_t abs = abs_mod_prime(c);

        *mx = maximum(*mx, abs);
    }
}

static ossl_inline ossl_unused void
poly_max_signed(const POLY *p, uint32_t *mx)
{
    int i;

    for (i = 0; i < ML_DSA_NUM_POLY_COEFFICIENTS; i++) {
        uint32_t c = p->coeff[i];
        uint32_t abs = abs_signed(c);

        *mx = maximum(*mx, abs);
    }
}

#endif /* !defined(OSSL_LIBCRYPTO_ML_DSA_ML_DSA_POLY_H) */

Line	Count	Source
1		/*
2		* Copyright 2024-2025 The OpenSSL Project Authors. All Rights Reserved.
3		*
4		* Licensed under the Apache License 2.0 (the "License"). You may not use
5		* this file except in compliance with the License. You can obtain a copy
6		* in the file LICENSE in the source distribution or at
7		* https://www.openssl.org/source/license.html
8		*/
9		#if !defined(OSSL_LIBCRYPTO_ML_DSA_ML_DSA_POLY_H)
10		#define OSSL_LIBCRYPTO_ML_DSA_ML_DSA_POLY_H
11
12		#include <openssl/crypto.h>
13
14		#include "internal/common.h"
15		#include "ml_dsa_local.h"
16
17	0	#define ML_DSA_NUM_POLY_COEFFICIENTS 256
18
19		/* Polynomial object with 256 coefficients. The coefficients are unsigned 32 bits */
20		struct poly_st {
21		#if defined(VX_COMPILER_SUPPORT_VEC128)
22		ALIGN16 uint32_t coeff[ML_DSA_NUM_POLY_COEFFICIENTS];
23		#else
24		uint32_t coeff[ML_DSA_NUM_POLY_COEFFICIENTS];
25		#endif
26		};
27
28		static ossl_inline ossl_unused void
29		poly_zero(POLY *p)
30	0	{
31	0	memset(p->coeff, 0, sizeof(*p));
32	0	} Unexecuted instantiation: ml_dsa_encoders.c:poly_zero Unexecuted instantiation: ml_dsa_key.c:poly_zero Unexecuted instantiation: ml_dsa_matrix.c:poly_zero Unexecuted instantiation: ml_dsa_ntt.c:poly_zero Unexecuted instantiation: ml_dsa_sample.c:poly_zero Unexecuted instantiation: ml_dsa_sign.c:poly_zero
33
34		/**
35		* @brief Polynomial addition.
36		*
37		* @param lhs A polynomial with coefficients in the range (0..q-1)
38		* @param rhs A polynomial with coefficients in the range (0..q-1) to add
39		* to the 'lhs'.
40		* @param out The returned addition result with the coefficients all in the
41		* range 0..q-1
42		*/
43		static ossl_inline ossl_unused void
44		poly_add(const POLY lhs, const POLY rhs, POLY *out)
45	0	{
46	0	int i;
47
48	0	for (i = 0; i < ML_DSA_NUM_POLY_COEFFICIENTS; i++)
49	0	out->coeff[i] = reduce_once(lhs->coeff[i] + rhs->coeff[i]);
50	0	} Unexecuted instantiation: ml_dsa_encoders.c:poly_add Unexecuted instantiation: ml_dsa_key.c:poly_add Unexecuted instantiation: ml_dsa_matrix.c:poly_add Unexecuted instantiation: ml_dsa_ntt.c:poly_add Unexecuted instantiation: ml_dsa_sample.c:poly_add Unexecuted instantiation: ml_dsa_sign.c:poly_add
51
52		/**
53		* @brief Polynomial subtraction.
54		*
55		* @param lhs A polynomial with coefficients in the range (0..q-1)
56		* @param rhs A polynomial with coefficients in the range (0..q-1) to subtract
57		* from the 'lhs'.
58		* @param out The returned subtraction result with the coefficients all in the
59		* range 0..q-1
60		*/
61		static ossl_inline ossl_unused void
62		poly_sub(const POLY lhs, const POLY rhs, POLY *out)
63	0	{
64	0	int i;
65
66	0	for (i = 0; i < ML_DSA_NUM_POLY_COEFFICIENTS; i++)
67	0	out->coeff[i] = mod_sub(lhs->coeff[i], rhs->coeff[i]);
68	0	} Unexecuted instantiation: ml_dsa_encoders.c:poly_sub Unexecuted instantiation: ml_dsa_key.c:poly_sub Unexecuted instantiation: ml_dsa_matrix.c:poly_sub Unexecuted instantiation: ml_dsa_ntt.c:poly_sub Unexecuted instantiation: ml_dsa_sample.c:poly_sub Unexecuted instantiation: ml_dsa_sign.c:poly_sub
69
70		/* @returns 1 if the polynomials are equal, or 0 otherwise */
71		static ossl_inline ossl_unused int
72		poly_equal(const POLY a, const POLY b)
73	0	{
74	0	return CRYPTO_memcmp(a, b, sizeof(*a)) == 0;
75	0	} Unexecuted instantiation: ml_dsa_encoders.c:poly_equal Unexecuted instantiation: ml_dsa_key.c:poly_equal Unexecuted instantiation: ml_dsa_matrix.c:poly_equal Unexecuted instantiation: ml_dsa_ntt.c:poly_equal Unexecuted instantiation: ml_dsa_sample.c:poly_equal Unexecuted instantiation: ml_dsa_sign.c:poly_equal
76
77		static ossl_inline ossl_unused void
78		poly_ntt(POLY *p)
79	0	{
80	0	ossl_ml_dsa_poly_ntt(p);
81	0	} Unexecuted instantiation: ml_dsa_encoders.c:poly_ntt Unexecuted instantiation: ml_dsa_key.c:poly_ntt Unexecuted instantiation: ml_dsa_matrix.c:poly_ntt Unexecuted instantiation: ml_dsa_ntt.c:poly_ntt Unexecuted instantiation: ml_dsa_sample.c:poly_ntt Unexecuted instantiation: ml_dsa_sign.c:poly_ntt
82
83		static ossl_inline ossl_unused int
84		poly_sample_in_ball_ntt(POLY out, const uint8_t seed, int seed_len,
85		EVP_MD_CTX h_ctx, const EVP_MD md, uint32_t tau)
86	0	{
87	0	if (!ossl_ml_dsa_poly_sample_in_ball(out, seed, seed_len, h_ctx, md, tau))
88	0	return 0;
89	0	poly_ntt(out);
90	0	return 1;
91	0	} Unexecuted instantiation: ml_dsa_encoders.c:poly_sample_in_ball_ntt Unexecuted instantiation: ml_dsa_key.c:poly_sample_in_ball_ntt Unexecuted instantiation: ml_dsa_matrix.c:poly_sample_in_ball_ntt Unexecuted instantiation: ml_dsa_ntt.c:poly_sample_in_ball_ntt Unexecuted instantiation: ml_dsa_sample.c:poly_sample_in_ball_ntt Unexecuted instantiation: ml_dsa_sign.c:poly_sample_in_ball_ntt
92
93		static ossl_inline ossl_unused int
94		poly_expand_mask(POLY out, const uint8_t seed, size_t seed_len,
95		uint32_t gamma1, EVP_MD_CTX h_ctx, const EVP_MD md)
96	0	{
97	0	return ossl_ml_dsa_poly_expand_mask(out, seed, seed_len, gamma1, h_ctx, md);
98	0	} Unexecuted instantiation: ml_dsa_encoders.c:poly_expand_mask Unexecuted instantiation: ml_dsa_key.c:poly_expand_mask Unexecuted instantiation: ml_dsa_matrix.c:poly_expand_mask Unexecuted instantiation: ml_dsa_ntt.c:poly_expand_mask Unexecuted instantiation: ml_dsa_sample.c:poly_expand_mask Unexecuted instantiation: ml_dsa_sign.c:poly_expand_mask
99
100		/**
101		* @brief Decompose the coefficients of a polynomial into (r1, r0) such that
102		* coeff[i] == t1[i] * 2^13 + t0[i] mod q
103		* See FIPS 204, Algorithm 35, Power2Round()
104		*
105		* @param t A polynomial containing coefficients in the range 0..q-1
106		* @param t1 The returned polynomial containing coefficients that represent
107		* the top 10 MSB of each coefficient in t (i.e each ranging from 0..1023)
108		* @param t0 The remainder coefficients of t in the range (0..4096 or q-4095..q-1)
109		* Each t0 coefficient has an effective range of 8192 (i.e. 13 bits).
110		*/
111		static ossl_inline ossl_unused void
112		poly_power2_round(const POLY t, POLY t1, POLY *t0)
113	0	{
114	0	int i;
115
116	0	for (i = 0; i < ML_DSA_NUM_POLY_COEFFICIENTS; i++)
117	0	ossl_ml_dsa_key_compress_power2_round(t->coeff[i],
118	0	t1->coeff + i, t0->coeff + i);
119	0	} Unexecuted instantiation: ml_dsa_encoders.c:poly_power2_round Unexecuted instantiation: ml_dsa_key.c:poly_power2_round Unexecuted instantiation: ml_dsa_matrix.c:poly_power2_round Unexecuted instantiation: ml_dsa_ntt.c:poly_power2_round Unexecuted instantiation: ml_dsa_sample.c:poly_power2_round Unexecuted instantiation: ml_dsa_sign.c:poly_power2_round
120
121		static ossl_inline ossl_unused void
122		poly_scale_power2_round(POLY in, POLY out)
123	0	{
124	0	int i;
125
126	0	for (i = 0; i < ML_DSA_NUM_POLY_COEFFICIENTS; i++)
127	0	out->coeff[i] = (in->coeff[i] << ML_DSA_D_BITS);
128	0	} Unexecuted instantiation: ml_dsa_encoders.c:poly_scale_power2_round Unexecuted instantiation: ml_dsa_key.c:poly_scale_power2_round Unexecuted instantiation: ml_dsa_matrix.c:poly_scale_power2_round Unexecuted instantiation: ml_dsa_ntt.c:poly_scale_power2_round Unexecuted instantiation: ml_dsa_sample.c:poly_scale_power2_round Unexecuted instantiation: ml_dsa_sign.c:poly_scale_power2_round
129
130		static ossl_inline ossl_unused void
131		poly_high_bits(const POLY in, uint32_t gamma2, POLY out)
132	0	{
133	0	int i;
134
135	0	for (i = 0; i < ML_DSA_NUM_POLY_COEFFICIENTS; i++)
136	0	out->coeff[i] = ossl_ml_dsa_key_compress_high_bits(in->coeff[i], gamma2);
137	0	} Unexecuted instantiation: ml_dsa_encoders.c:poly_high_bits Unexecuted instantiation: ml_dsa_key.c:poly_high_bits Unexecuted instantiation: ml_dsa_matrix.c:poly_high_bits Unexecuted instantiation: ml_dsa_ntt.c:poly_high_bits Unexecuted instantiation: ml_dsa_sample.c:poly_high_bits Unexecuted instantiation: ml_dsa_sign.c:poly_high_bits
138
139		static ossl_inline ossl_unused void
140		poly_low_bits(const POLY in, uint32_t gamma2, POLY out)
141	0	{
142	0	int i;
143
144	0	for (i = 0; i < ML_DSA_NUM_POLY_COEFFICIENTS; i++)
145	0	out->coeff[i] = ossl_ml_dsa_key_compress_low_bits(in->coeff[i], gamma2);
146	0	} Unexecuted instantiation: ml_dsa_encoders.c:poly_low_bits Unexecuted instantiation: ml_dsa_key.c:poly_low_bits Unexecuted instantiation: ml_dsa_matrix.c:poly_low_bits Unexecuted instantiation: ml_dsa_ntt.c:poly_low_bits Unexecuted instantiation: ml_dsa_sample.c:poly_low_bits Unexecuted instantiation: ml_dsa_sign.c:poly_low_bits
147
148		static ossl_inline ossl_unused void
149		poly_make_hint(const POLY ct0, const POLY cs2, const POLY *w, uint32_t gamma2,
150		POLY *out)
151	0	{
152	0	int i;
153
154	0	for (i = 0; i < ML_DSA_NUM_POLY_COEFFICIENTS; i++)
155	0	out->coeff[i] = ossl_ml_dsa_key_compress_make_hint(ct0->coeff[i],
156	0	cs2->coeff[i],
157	0	gamma2, w->coeff[i]);
158	0	} Unexecuted instantiation: ml_dsa_encoders.c:poly_make_hint Unexecuted instantiation: ml_dsa_key.c:poly_make_hint Unexecuted instantiation: ml_dsa_matrix.c:poly_make_hint Unexecuted instantiation: ml_dsa_ntt.c:poly_make_hint Unexecuted instantiation: ml_dsa_sample.c:poly_make_hint Unexecuted instantiation: ml_dsa_sign.c:poly_make_hint
159
160		static ossl_inline ossl_unused void
161		poly_use_hint(const POLY h, const POLY r, uint32_t gamma2, POLY *out)
162	0	{
163	0	int i;
164
165	0	for (i = 0; i < ML_DSA_NUM_POLY_COEFFICIENTS; i++)
166	0	out->coeff[i] = ossl_ml_dsa_key_compress_use_hint(h->coeff[i],
167	0	r->coeff[i], gamma2);
168	0	} Unexecuted instantiation: ml_dsa_encoders.c:poly_use_hint Unexecuted instantiation: ml_dsa_key.c:poly_use_hint Unexecuted instantiation: ml_dsa_matrix.c:poly_use_hint Unexecuted instantiation: ml_dsa_ntt.c:poly_use_hint Unexecuted instantiation: ml_dsa_sample.c:poly_use_hint Unexecuted instantiation: ml_dsa_sign.c:poly_use_hint
169
170		static ossl_inline ossl_unused void
171		poly_max(const POLY p, uint32_t mx)
172	0	{
173	0	int i;
174
175	0	for (i = 0; i < ML_DSA_NUM_POLY_COEFFICIENTS; i++) {
176	0	uint32_t c = p->coeff[i];
177	0	uint32_t abs = abs_mod_prime(c);
178
179	0	mx = maximum(mx, abs);
180	0	}
181	0	} Unexecuted instantiation: ml_dsa_encoders.c:poly_max Unexecuted instantiation: ml_dsa_key.c:poly_max Unexecuted instantiation: ml_dsa_matrix.c:poly_max Unexecuted instantiation: ml_dsa_ntt.c:poly_max Unexecuted instantiation: ml_dsa_sample.c:poly_max Unexecuted instantiation: ml_dsa_sign.c:poly_max
182
183		static ossl_inline ossl_unused void
184		poly_max_signed(const POLY p, uint32_t mx)
185	0	{
186	0	int i;
187
188	0	for (i = 0; i < ML_DSA_NUM_POLY_COEFFICIENTS; i++) {
189	0	uint32_t c = p->coeff[i];
190	0	uint32_t abs = abs_signed(c);
191
192	0	mx = maximum(mx, abs);
193	0	}
194	0	} Unexecuted instantiation: ml_dsa_encoders.c:poly_max_signed Unexecuted instantiation: ml_dsa_key.c:poly_max_signed Unexecuted instantiation: ml_dsa_matrix.c:poly_max_signed Unexecuted instantiation: ml_dsa_ntt.c:poly_max_signed Unexecuted instantiation: ml_dsa_sample.c:poly_max_signed Unexecuted instantiation: ml_dsa_sign.c:poly_max_signed
195
196		#endif /* !defined(OSSL_LIBCRYPTO_ML_DSA_ML_DSA_POLY_H) */

Coverage Report

Created: 2026-07-16 06:59