Add CBMC proof of checkDataType function

source/ota.c

@@ -1,6 +1,6 @@
 /*
  * AWS IoT Over-the-air Update v3.1.0
- * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
+ * Copyright (C) 2021 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * 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

test/cbmc/proofs/checkDataType/Makefile

@@ -0,0 +1,19 @@
+HARNESS_ENTRY = checkDataType_harness
+HARNESS_FILE = $(HARNESS_ENTRY)
+
+# This should be a unique identifier for this proof, and will appear on the
+# Litani dashboard. It can be human-readable and contain spaces if you wish.
+PROOF_UID = checkDataType
+
+INCLUDES += -I$(SRCDIR)/source/dependency/3rdparty/tinycbor/src/
+
+PROOF_SOURCES += $(PROOFDIR)/$(HARNESS_FILE).c
+PROJECT_SOURCES += $(SRCDIR)/source/ota_cbor.c
+
+# If this proof is found to consume huge amounts of RAM, you can set the
+# EXPENSIVE variable. With new enough versions of the proof tools, this will
+# restrict the number of EXPENSIVE CBMC jobs running at once. See the
+# documentation in Makefile.common under the "Job Pools" heading for details.
+# EXPENSIVE = true
+
+include ../Makefile.common

test/cbmc/proofs/checkDataType/README.md

@@ -0,0 +1,20 @@
+checkDataType proof
+==============
+
+This directory contains a memory safety proof for checkDataType.
+
+To run the proof.
+-------------
+
+* Add `cbmc`, `goto-cc`, `goto-instrument`, `goto-analyzer`, and `cbmc-viewer`
+  to your path.
+* Run `make`.
+* Open html/index.html in a web browser.
+
+To use [`arpa`](https://github.com/awslabs/aws-proof-build-assistant) to simplify writing Makefiles.
+-------------
+
+* Run `make arpa` to generate a Makefile.arpa that contains relevant build information for the proof.
+* Use Makefile.arpa as the starting point for your proof Makefile by:
+  1. Modifying Makefile.arpa (if required).
+  2. Including Makefile.arpa into the existing proof Makefile (add `sinclude Makefile.arpa` at the bottom of the Makefile, right before `include ../Makefile.common`).

test/cbmc/proofs/checkDataType/cbmc-proof.txt

@@ -0,0 +1,2 @@
+# This file marks this directory as containing a CBMC proof.
+# This file is required by the run-cbmc-proofs.py to differentiate between a proof directory from a normal directory.

test/cbmc/proofs/checkDataType/cbmc-viewer.json

@@ -0,0 +1,6 @@
+{ "expected-missing-functions":
+  [
+  ],
+  "proof-name": "checkDataType",
+  "proof-root": "test/cbmc/proofs"
+}

test/cbmc/proofs/checkDataType/checkDataType_harness.c

@@ -0,0 +1,45 @@
+/*
+ * AWS IoT Over-the-air Update v3.1.0
+ * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
+ *
+ * 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.
+ */
+
+/**
+ * @file checkDataType_harness.c
+ * @brief Implements the proof harness for checkDataType function.
+ */
+/* Include headers for cbor parsing. */
+#include "cbor.h"
+#include "ota_cbor_private.h"
+
+CborError __CPROVER_file_local_ota_cbor_c_checkDataType( CborType expectedType,
+                                                         CborValue * cborValue );
+
+
+void checkDataType_harness()
+{
+    CborType expectedType;
+    CborValue cborvalue;
+    CborError cborResult;
+
+    cborResult = __CPROVER_file_local_ota_cbor_c_checkDataType( expectedType, &cborvalue );
+
+    __CPROVER_assert( cborResult == CborNoError || cborResult == CborErrorIllegalType,
+                      "Invalid cborResult value: Expected either CborNoError or CborErrorIllegalType." );
+}

tools/lexicon.txt

@@ -62,6 +62,7 @@ certfile
 certfilepath
 certfilepathmaxsize
 certfilepathsize
+checkdatatype
 checkforupdate
 cli
 clienttoken