Skip to content

Commit bfe14c2

Browse files
committed
CBMC: Add contract and proof for polyvecl_ntt
Resolves #118 Signed-off-by: Matthias J. Kannwischer <[email protected]>
1 parent a76c97a commit bfe14c2

File tree

3 files changed

+73
-2
lines changed

3 files changed

+73
-2
lines changed

mldsa/polyvec.h

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,11 +72,18 @@ __contract__(
7272
* Name: polyvecl_ntt
7373
*
7474
* Description: Forward NTT of all polynomials in vector of length MLDSA_L.
75-
*Output coefficients can be up to 16*MLDSA_Q larger than input coefficients.
75+
* Coefficients can grow by 8*MLDSA_Q in absolute value.
7676
*
7777
* Arguments: - polyvecl *v: pointer to input/output vector
7878
**************************************************/
79-
void polyvecl_ntt(polyvecl *v);
79+
void polyvecl_ntt(polyvecl *v)
80+
__contract__(
81+
requires(memory_no_alias(v, sizeof(polyvecl)))
82+
requires(forall(k0, 0, MLDSA_L, array_abs_bound(v->vec[k0].coeffs, 0, MLDSA_N, MLDSA_Q)))
83+
assigns(memory_slice(v, sizeof(polyvecl)))
84+
ensures(forall(k1, 0, MLDSA_L, array_abs_bound(v->vec[k1].coeffs, 0, MLDSA_N, MLD_NTT_BOUND)))
85+
);
86+
8087
#define polyvecl_invntt_tomont MLD_NAMESPACE(polyvecl_invntt_tomont)
8188
void polyvecl_invntt_tomont(polyvecl *v);
8289
#define polyvecl_pointwise_poly_montgomery \

proofs/cbmc/polyvecl_ntt/Makefile

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
# SPDX-License-Identifier: Apache-2.0
2+
3+
include ../Makefile_params.common
4+
5+
HARNESS_ENTRY = harness
6+
HARNESS_FILE = polyvecl_ntt_harness
7+
8+
# This should be a unique identifier for this proof, and will appear on the
9+
# Litani dashboard. It can be human-readable and contain spaces if you wish.
10+
PROOF_UID = polyvecl_ntt
11+
12+
DEFINES +=
13+
INCLUDES +=
14+
15+
REMOVE_FUNCTION_BODY +=
16+
UNWINDSET += $(MLD_NAMESPACE)polyvecl_ntt.0:7 # Largest value of MLDSA_L
17+
18+
PROOF_SOURCES += $(PROOFDIR)/$(HARNESS_FILE).c
19+
PROJECT_SOURCES += $(SRCDIR)/mldsa/polyvec.c
20+
21+
CHECK_FUNCTION_CONTRACTS=$(MLD_NAMESPACE)polyvecl_ntt
22+
USE_FUNCTION_CONTRACTS=$(MLD_NAMESPACE)poly_ntt
23+
APPLY_LOOP_CONTRACTS=on
24+
USE_DYNAMIC_FRAMES=1
25+
26+
# Disable any setting of EXTERNAL_SAT_SOLVER, and choose SMT backend instead
27+
EXTERNAL_SAT_SOLVER=
28+
CBMCFLAGS=--smt2
29+
30+
FUNCTION_NAME = polyvecl_ntt
31+
32+
# If this proof is found to consume huge amounts of RAM, you can set the
33+
# EXPENSIVE variable. With new enough versions of the proof tools, this will
34+
# restrict the number of EXPENSIVE CBMC jobs running at once. See the
35+
# documentation in Makefile.common under the "Job Pools" heading for details.
36+
# EXPENSIVE = true
37+
38+
# This function is large enough to need...
39+
CBMC_OBJECT_BITS = 8
40+
41+
# If you require access to a file-local ("static") function or object to conduct
42+
# your proof, set the following (and do not include the original source file
43+
# ("mldsa/poly.c") in PROJECT_SOURCES).
44+
# REWRITTEN_SOURCES = $(PROOFDIR)/<__SOURCE_FILE_BASENAME__>.i
45+
# include ../Makefile.common
46+
# $(PROOFDIR)/<__SOURCE_FILE_BASENAME__>.i_SOURCE = $(SRCDIR)/mldsa/poly.c
47+
# $(PROOFDIR)/<__SOURCE_FILE_BASENAME__>.i_FUNCTIONS = foo bar
48+
# $(PROOFDIR)/<__SOURCE_FILE_BASENAME__>.i_OBJECTS = baz
49+
# Care is required with variables on the left-hand side: REWRITTEN_SOURCES must
50+
# be set before including Makefile.common, but any use of variables on the
51+
# left-hand side requires those variables to be defined. Hence, _SOURCE,
52+
# _FUNCTIONS, _OBJECTS is set after including Makefile.common.
53+
54+
include ../Makefile.common
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
// Copyright (c) 2025 The mldsa-native project authors
2+
// SPDX-License-Identifier: Apache-2.0
3+
4+
#include "polyvec.h"
5+
6+
void harness(void)
7+
{
8+
polyvecl *a;
9+
polyvecl_ntt(a);
10+
}

0 commit comments

Comments
 (0)