Skip to content

Commit 71e42b4

Browse files
authored
Update CBMC starter kit (#753)
* ci(cbmc): Update CBMC starter kit to v2.5 * ci(cbmc): Remove starter-kit and Litani submodules * ci(cbmc): Update README to include a section on CBMC
1 parent c61d536 commit 71e42b4

13 files changed

+1559
-15
lines changed

.gitmodules

-6
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,6 @@
44
[submodule ".cbmc-batch/aws-c-common"]
55
path = verification/cbmc/aws-c-common
66
url = https://github.com/awslabs/aws-c-common.git
7-
[submodule "verification/cbmc/templates"]
8-
path = verification/cbmc/templates
9-
url = https://github.com/awslabs/aws-templates-for-cbmc-proofs.git
10-
[submodule "verification/litani"]
11-
path = verification/litani
12-
url = https://github.com/awslabs/aws-build-accumulator
137
[submodule "aws-encryption-sdk-specification"]
148
path = aws-encryption-sdk-specification
159
url = https://github.com/awslabs/aws-encryption-sdk-specification.git

README.md

+8
Original file line numberDiff line numberDiff line change
@@ -197,6 +197,14 @@ logic by setting `-DBUILD_AWS_ENC_SDK_CPP=OFF` to never build the C++ components
197197
by setting `-DBUILD_AWS_ENC_SDK_CPP=ON` to require building the C++ components (and
198198
fail if the C++ dependencies are not found.)
199199

200+
## CBMC
201+
202+
To learn more about CBMC and proofs specifically, review the training material [here](https://model-checking.github.io/cbmc-training).
203+
204+
The `verification/cbmc/proofs` directory contains CBMC proofs.
205+
206+
In order to run these proofs you will need to install CBMC and other tools by following the instructions [here](https://model-checking.github.io/cbmc-training/installation.html).
207+
200208
## License
201209

202210
This library is licensed under the Apache 2.0 License.

verification/cbmc/include/README.md

-1
This file was deleted.

verification/cbmc/include/README.md

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
CBMC proof include files
2+
========================
3+
4+
This directory contains include files written for CBMC proof. It is
5+
common to write some code to model aspects of the system under test,
6+
and the header files for this code go here.

verification/cbmc/proofs/Makefile-template-defines

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ SRCDIR ?= $(abspath $(PROOF_ROOT)/../../..)
66

77
# Absolute path to the litani script.
88
#
9-
LITANI ?= $(abspath $(PROOF_ROOT)/../../litani/litani)
9+
LITANI ?= litani
1010

1111

1212
# Name of this proof project, displayed in proof reports. For example,

verification/cbmc/proofs/Makefile.common

-1
This file was deleted.

0 commit comments

Comments
 (0)