first commit
This commit is contained in:
commit
92cbe97616
1978 files changed
+1688498
No files matched your search
+73
@@ -0,0 +1,73 @@
|
||||
/* FreeRTOS includes. */
|
||||
#include "FreeRTOS.h"
|
||||
#include "list.h"
|
||||
|
||||
/* FreeRTOS+TCP includes. */
|
||||
#include "FreeRTOS_IP.h"
|
||||
#include "FreeRTOS_IP_Private.h"
|
||||
#include "FreeRTOS_ARP.h"
|
||||
|
||||
/*We assume that the pxGetNetworkBufferWithDescriptor function is implemented correctly and returns a valid data structure. */
|
||||
/*This is the mock to mimic the correct expected behavior. If this allocation fails, this might invalidate the proof. */
|
||||
NetworkBufferDescriptor_t * pxGetNetworkBufferWithDescriptor( size_t xRequestedSizeBytes,
|
||||
TickType_t xBlockTimeTicks )
|
||||
{
|
||||
NetworkBufferDescriptor_t * pxNetworkBuffer = ( NetworkBufferDescriptor_t * ) malloc( sizeof( NetworkBufferDescriptor_t ) );
|
||||
|
||||
__CPROVER_assume( pxNetworkBuffer != NULL );
|
||||
|
||||
pxNetworkBuffer->pucEthernetBuffer = malloc( xRequestedSizeBytes );
|
||||
__CPROVER_assume( pxNetworkBuffer->pucEthernetBuffer != NULL );
|
||||
|
||||
pxNetworkBuffer->xDataLength = xRequestedSizeBytes;
|
||||
return pxNetworkBuffer;
|
||||
}
|
||||
|
||||
BaseType_t NetworkInterfaceOutputFunction_Stub( struct xNetworkInterface * pxDescriptor,
|
||||
NetworkBufferDescriptor_t * const pxNetworkBuffer,
|
||||
BaseType_t xReleaseAfterSend )
|
||||
{
|
||||
__CPROVER_assert( pxDescriptor != NULL, "The network interface cannot be NULL." );
|
||||
__CPROVER_assert( pxNetworkBuffer != NULL, "The network buffer descriptor cannot be NULL." );
|
||||
__CPROVER_assert( pxNetworkBuffer->pucEthernetBuffer != NULL, "The Ethernet buffer cannot be NULL." );
|
||||
return 0;
|
||||
}
|
||||
|
||||
|
||||
void FreeRTOS_OutputAdvertiseIPv6( NetworkEndPoint_t * pxEndPoint )
|
||||
{
|
||||
__CPROVER_assert( pxEndPoint != NULL, "The Endpoint cannot be NULL." );
|
||||
}
|
||||
|
||||
void harness()
|
||||
{
|
||||
/*
|
||||
* For this proof, its assumed that the endpoints and interfaces are correctly
|
||||
* initialised and the pointers are set correctly.
|
||||
* Assumes two endpoints and interface is present.
|
||||
*/
|
||||
|
||||
pxNetworkEndPoints = ( NetworkEndPoint_t * ) malloc( sizeof( NetworkEndPoint_t ) );
|
||||
__CPROVER_assume( pxNetworkEndPoints != NULL );
|
||||
|
||||
/* Interface init. */
|
||||
pxNetworkEndPoints->pxNetworkInterface = ( NetworkInterface_t * ) malloc( sizeof( NetworkInterface_t ) );
|
||||
__CPROVER_assume( pxNetworkEndPoints->pxNetworkInterface != NULL );
|
||||
|
||||
if( nondet_bool() )
|
||||
{
|
||||
pxNetworkEndPoints->pxNext = ( NetworkEndPoint_t * ) malloc( sizeof( NetworkEndPoint_t ) );
|
||||
__CPROVER_assume( pxNetworkEndPoints->pxNext != NULL );
|
||||
pxNetworkEndPoints->pxNext->pxNext = NULL;
|
||||
pxNetworkEndPoints->pxNext->pxNetworkInterface = pxNetworkEndPoints->pxNetworkInterface;
|
||||
}
|
||||
else
|
||||
{
|
||||
pxNetworkEndPoints->pxNext = NULL;
|
||||
}
|
||||
|
||||
pxNetworkEndPoints->pxNetworkInterface->pfOutput = NetworkInterfaceOutputFunction_Stub;
|
||||
/* No assumption is added for pfOutput as its pointed to a static object/memory location. */
|
||||
|
||||
vARPAgeCache();
|
||||
}
|
||||
+26
@@ -0,0 +1,26 @@
|
||||
{
|
||||
"ENTRY": "ARPAgeCache",
|
||||
"CBMCFLAGS":
|
||||
[
|
||||
"--unwind 1",
|
||||
"--unwindset vARPAgeCache.0:7",
|
||||
"--unwindset FreeRTOS_OutputARPRequest.0:3",
|
||||
"--unwindset FreeRTOS_InterfaceEndPointOnNetMask.0:3",
|
||||
"--unwindset vARPAgeCache.1:3",
|
||||
"--nondet-static"
|
||||
],
|
||||
"OBJS":
|
||||
[
|
||||
"$(ENTRY)_harness.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/source/FreeRTOS_IP.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/source/FreeRTOS_Routing.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/source/FreeRTOS_ARP.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/source/FreeRTOS_IP_Utils.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/test/cbmc/stubs/freertos_kernel_api.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/test/cbmc/stubs/freertos_api.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/test/FreeRTOS-Kernel/tasks.goto"
|
||||
],
|
||||
"DEF":
|
||||
[
|
||||
]
|
||||
}
|
||||
+2
@@ -0,0 +1,2 @@
|
||||
Assuming that xNetworkInterfaceOutput is memory safe,
|
||||
this harness proves the memory safety of the vARPAgeCache function.
|
||||
+39
@@ -0,0 +1,39 @@
|
||||
/* FreeRTOS includes. */
|
||||
#include "FreeRTOS.h"
|
||||
#include "queue.h"
|
||||
|
||||
/* FreeRTOS+TCP includes. */
|
||||
#include "FreeRTOS_IP.h"
|
||||
#include "FreeRTOS_IP_Private.h"
|
||||
#include "FreeRTOS_ARP.h"
|
||||
|
||||
void harness()
|
||||
{
|
||||
/*
|
||||
* The assumption made here is that the buffer pointed by pucEthernetBuffer
|
||||
* is at least allocated to sizeof(ARPPacket_t) size but eventually a even larger buffer.
|
||||
* This is not checked inside vARPGenerateRequestPacket.
|
||||
*/
|
||||
uint8_t ucBUFFER_SIZE;
|
||||
|
||||
__CPROVER_assume( ucBUFFER_SIZE >= sizeof( ARPPacket_t ) && ucBUFFER_SIZE < 2 * sizeof( ARPPacket_t ) );
|
||||
void * xBuffer = malloc( ucBUFFER_SIZE );
|
||||
|
||||
__CPROVER_assume( xBuffer != NULL );
|
||||
|
||||
NetworkBufferDescriptor_t xNetworkBuffer2;
|
||||
|
||||
xNetworkBuffer2.pucEthernetBuffer = xBuffer;
|
||||
xNetworkBuffer2.xDataLength = ucBUFFER_SIZE;
|
||||
|
||||
/*
|
||||
* This proof assumes one end point is present.
|
||||
*/
|
||||
xNetworkBuffer2.pxEndPoint = ( NetworkEndPoint_t * ) malloc( sizeof( NetworkEndPoint_t ) );
|
||||
__CPROVER_assume( xNetworkBuffer2.pxEndPoint != NULL );
|
||||
xNetworkBuffer2.pxEndPoint->pxNext = NULL;
|
||||
|
||||
/* vARPGenerateRequestPacket asserts buffer has room for a packet */
|
||||
__CPROVER_assume( xNetworkBuffer2.xDataLength >= sizeof( ARPPacket_t ) );
|
||||
vARPGenerateRequestPacket( &xNetworkBuffer2 );
|
||||
}
|
||||
+16
@@ -0,0 +1,16 @@
|
||||
{
|
||||
"ENTRY": "ARPGenerateRequestPacket",
|
||||
"CBMCFLAGS":
|
||||
[
|
||||
"--unwind 1"
|
||||
],
|
||||
"OBJS":
|
||||
[
|
||||
"$(ENTRY)_harness.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/source/FreeRTOS_IP.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/source/FreeRTOS_ARP.goto"
|
||||
],
|
||||
"DEF":
|
||||
[
|
||||
]
|
||||
}
|
||||
+3
@@ -0,0 +1,3 @@
|
||||
Given that the pointer target of xNetworkDescriptor.pucEthernetBuffer is allocated
|
||||
to the size claimed in xNetworkDescriptor.xDataLength,
|
||||
this harness proves the memory safety of ARPGenerateRequestPacket.
|
||||
+43
@@ -0,0 +1,43 @@
|
||||
/* FreeRTOS includes. */
|
||||
#include "FreeRTOS.h"
|
||||
#include "queue.h"
|
||||
|
||||
/* FreeRTOS+TCP includes. */
|
||||
#include "FreeRTOS_IP.h"
|
||||
#include "FreeRTOS_IP_Private.h"
|
||||
#include "FreeRTOS_ARP.h"
|
||||
|
||||
|
||||
void harness()
|
||||
{
|
||||
uint32_t ulIPAddress;
|
||||
MACAddress_t xMACAddress;
|
||||
struct xNetworkEndPoint * pxEndPoint = NULL;
|
||||
|
||||
/*
|
||||
* For this proof, its assumed that the endpoints and interfaces are correctly
|
||||
* initialised and the pointers are set correctly.
|
||||
* Assumes one endpoint and interface is present.
|
||||
*/
|
||||
|
||||
pxNetworkEndPoints = ( NetworkEndPoint_t * ) malloc( sizeof( NetworkEndPoint_t ) );
|
||||
__CPROVER_assume( pxNetworkEndPoints != NULL );
|
||||
|
||||
/* Interface init. */
|
||||
pxNetworkEndPoints->pxNetworkInterface = ( NetworkInterface_t * ) malloc( sizeof( NetworkInterface_t ) );
|
||||
__CPROVER_assume( pxNetworkEndPoints->pxNetworkInterface != NULL );
|
||||
|
||||
if( nondet_bool() )
|
||||
{
|
||||
pxNetworkEndPoints->pxNext = ( NetworkEndPoint_t * ) malloc( sizeof( NetworkEndPoint_t ) );
|
||||
__CPROVER_assume( pxNetworkEndPoints->pxNext != NULL );
|
||||
pxNetworkEndPoints->pxNext->pxNext = NULL;
|
||||
pxNetworkEndPoints->pxNext->pxNetworkInterface = pxNetworkEndPoints->pxNetworkInterface;
|
||||
}
|
||||
else
|
||||
{
|
||||
pxNetworkEndPoints->pxNext = NULL;
|
||||
}
|
||||
|
||||
eARPGetCacheEntry( &ulIPAddress, &xMACAddress, &pxEndPoint );
|
||||
}
|
||||
+49
@@ -0,0 +1,49 @@
|
||||
{
|
||||
"ENTRY": "ARPGetCacheEntry",
|
||||
"CBMCFLAGS":
|
||||
[
|
||||
"--unwind 1",
|
||||
"--unwindset prvCacheLookup.0:7",
|
||||
"--unwindset FreeRTOS_FindEndPointOnIP_IPv4.0:3",
|
||||
"--unwindset FreeRTOS_InterfaceEndPointOnNetMask.0:3",
|
||||
"--unwindset xIsIPv4Broadcast.0:3",
|
||||
"--unwindset eARPGetCacheEntry.0:3",
|
||||
"--unwindset FreeRTOS_FindGateWay.0:3",
|
||||
"--nondet-static"
|
||||
],
|
||||
"OBJS":
|
||||
[
|
||||
"$(ENTRY)_harness.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/source/FreeRTOS_Routing.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/source/FreeRTOS_IPv4.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/source/FreeRTOS_IPv4_Utils.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/source/FreeRTOS_ARP.goto"
|
||||
],
|
||||
"DEF":
|
||||
[
|
||||
{
|
||||
"ARPGetCacheEntry_default":[
|
||||
"ipconfigARP_STORES_REMOTE_ADDRESSES=0",
|
||||
"ipconfigUSE_LLMNR=0"
|
||||
]
|
||||
},
|
||||
{
|
||||
"ARPGetCacheEntry_LLMNR": [
|
||||
"ipconfigARP_STORES_REMOTE_ADDRESSES=0",
|
||||
"ipconfigUSE_LLMNR=1"
|
||||
]
|
||||
},
|
||||
{
|
||||
"ARPGetCacheEntry_STORE_REMOTE": [
|
||||
"ipconfigARP_STORES_REMOTE_ADDRESSES=1",
|
||||
"ipconfigUSE_LLMNR=0"
|
||||
]
|
||||
},
|
||||
{
|
||||
"ARPGetCacheEntry_REMOTE_LLMNR": [
|
||||
"ipconfigARP_STORES_REMOTE_ADDRESSES=1",
|
||||
"ipconfigUSE_LLMNR=1"
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
+4
@@ -0,0 +1,4 @@
|
||||
The combined proofs in the subdirectories prove that ARPGetCacheEntry
|
||||
is memory safe for all possible combinations of ipconfigARP_STORES_REMOTE_ADDRESSES
|
||||
and ipconfigUSE_LLMNR. These are the only configuration
|
||||
parameters used inside the ARPGetCacheEntry.
|
||||
+28
@@ -0,0 +1,28 @@
|
||||
/* FreeRTOS includes. */
|
||||
#include "FreeRTOS.h"
|
||||
#include "queue.h"
|
||||
|
||||
/* FreeRTOS+TCP includes. */
|
||||
#include "FreeRTOS_IP.h"
|
||||
#include "FreeRTOS_IP_Private.h"
|
||||
#include "FreeRTOS_ARP.h"
|
||||
|
||||
extern ARPCacheRow_t xARPCache[ ipconfigARP_CACHE_ENTRIES ];
|
||||
|
||||
static NetworkEndPoint_t xEndPoint_Temp;
|
||||
|
||||
void harness()
|
||||
{
|
||||
MACAddress_t xMACAddress;
|
||||
uint32_t ulIPAddress;
|
||||
|
||||
NetworkInterface_t ** ppxInterface = ( NetworkInterface_t ** ) malloc( sizeof( NetworkInterface_t * ) );
|
||||
|
||||
if( ppxInterface )
|
||||
{
|
||||
*ppxInterface = ( NetworkInterface_t * ) malloc( sizeof( NetworkInterface_t ) );
|
||||
__CPROVER_assume( *ppxInterface != NULL );
|
||||
}
|
||||
|
||||
eARPGetCacheEntryByMac( &xMACAddress, &ulIPAddress, ppxInterface );
|
||||
}
|
||||
+16
@@ -0,0 +1,16 @@
|
||||
{
|
||||
"ENTRY": "ARPGetCacheEntryByMac",
|
||||
"CBMCFLAGS":
|
||||
[
|
||||
"--unwind 7"
|
||||
],
|
||||
"OBJS":
|
||||
[
|
||||
"$(ENTRY)_harness.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/source/FreeRTOS_ARP.goto"
|
||||
],
|
||||
"DEF":
|
||||
[
|
||||
"ipconfigUSE_ARP_REVERSED_LOOKUP=1", "ipconfigARP_CACHE_ENTRIES=6"
|
||||
]
|
||||
}
|
||||
+4
@@ -0,0 +1,4 @@
|
||||
ARPGetCacheEntryByMac is memory safe,
|
||||
if it is enabled.
|
||||
|
||||
ARPGetCacheEntryByMac does not use multiple configurations internally.
|
||||
+116
@@ -0,0 +1,116 @@
|
||||
/* FreeRTOS includes. */
|
||||
#include "FreeRTOS.h"
|
||||
#include "queue.h"
|
||||
|
||||
/* FreeRTOS+TCP includes. */
|
||||
#include "FreeRTOS_IP.h"
|
||||
#include "FreeRTOS_IP_Private.h"
|
||||
#include "FreeRTOS_ARP.h"
|
||||
#include "FreeRTOS_Routing.h"
|
||||
|
||||
/* CBMC includes. */
|
||||
#include "cbmc.h"
|
||||
|
||||
/* This pointer is maintained by the IP-task. Defined in FreeRTOS_IP.c */
|
||||
extern NetworkBufferDescriptor_t * pxARPWaitingNetworkBuffer;
|
||||
NetworkEndPoint_t * pxNetworkEndPoint_Temp;
|
||||
|
||||
/* Stub FreeRTOS_FindEndPointOnNetMask_IPv6 as its not relevant to the
|
||||
* correctness of the proof */
|
||||
NetworkEndPoint_t * FreeRTOS_FindEndPointOnNetMask_IPv6( const IPv6_Address_t * pxIPv6Address )
|
||||
{
|
||||
__CPROVER_assert( pxIPv6Address != NULL, "Precondition: pxIPv6Address != NULL" );
|
||||
|
||||
/* Assume at least one end-point is available */
|
||||
return pxNetworkEndPoint_Temp;
|
||||
}
|
||||
|
||||
/* Stub FreeRTOS_FindEndPointOnNetMask_IPv6 as its not relevant to the
|
||||
* correctness of the proof */
|
||||
NetworkEndPoint_t * FreeRTOS_FindEndPointOnNetMask( uint32_t ulIPAddress )
|
||||
{
|
||||
/* Assume at least one end-point is available */
|
||||
return pxNetworkEndPoint_Temp;
|
||||
}
|
||||
|
||||
/* Get rid of configASSERT in FreeRTOS_TCP_IP.c */
|
||||
BaseType_t xIsCallingFromIPTask( void )
|
||||
{
|
||||
return pdTRUE;
|
||||
}
|
||||
|
||||
/* This is an output function and need not be tested with this proof. */
|
||||
void FreeRTOS_OutputARPRequest_Multi( NetworkEndPoint_t * pxEndPoint,
|
||||
uint32_t ulIPAddress )
|
||||
{
|
||||
}
|
||||
|
||||
/* This function is proved elsewhere hence stubbing it out */
|
||||
eResolutionLookupResult_t eARPGetCacheEntry( uint32_t * pulIPAddress,
|
||||
MACAddress_t * const pxMACAddress,
|
||||
struct xNetworkEndPoint ** ppxEndPoint )
|
||||
{
|
||||
eResolutionLookupResult_t eReturn;
|
||||
|
||||
__CPROVER_assert( pulIPAddress != NULL, "pulIPAddress cannot be NULL." );
|
||||
__CPROVER_assert( pxMACAddress != NULL, "pxMACAddress cannot be NULL." );
|
||||
__CPROVER_assert( ppxEndPoint != NULL, "ppxEndPoint cannot be NULL." );
|
||||
|
||||
/* Return random value */
|
||||
return eReturn;
|
||||
}
|
||||
|
||||
void harness()
|
||||
{
|
||||
NetworkBufferDescriptor_t * pxLocalBuffer;
|
||||
NetworkBufferDescriptor_t * pxNetworkBuffer2;
|
||||
TickType_t xBlockTimeTicks;
|
||||
uint16_t usEthernetBufferSize;
|
||||
|
||||
/*
|
||||
* The assumption made here is that the buffer pointed by pucEthernetBuffer
|
||||
* is at least allocated to sizeof(ARPPacket_t) size but eventually an even larger buffer.
|
||||
* This is not checked inside eARPProcessPacket.
|
||||
*/
|
||||
uint8_t ucBUFFER_SIZE;
|
||||
|
||||
|
||||
/* Non deterministically determine whether the pxARPWaitingNetworkBuffer will
|
||||
* point to some valid data or will it be NULL. */
|
||||
if( nondet_bool() )
|
||||
{
|
||||
/* The packet must at least be as big as an IP Packet. The size is not
|
||||
* checked in the function as the pointer is stored by the IP-task itself
|
||||
* and therefore it will always be of the required size. */
|
||||
__CPROVER_assume( usEthernetBufferSize >= sizeof( IPPacket_t ) );
|
||||
pxLocalBuffer = pxGetNetworkBufferWithDescriptor( usEthernetBufferSize, xBlockTimeTicks );
|
||||
|
||||
/* Since this pointer is maintained by the IP-task, either the pointer
|
||||
* pxARPWaitingNetworkBuffer will be NULL or pxLocalBuffer->pucEthernetBuffer
|
||||
* will be non-NULL. */
|
||||
__CPROVER_assume( pxLocalBuffer != NULL );
|
||||
__CPROVER_assume( pxLocalBuffer->pucEthernetBuffer != NULL );
|
||||
__CPROVER_assume( pxLocalBuffer->xDataLength == usEthernetBufferSize );
|
||||
|
||||
pxARPWaitingNetworkBuffer = pxLocalBuffer;
|
||||
}
|
||||
else
|
||||
{
|
||||
pxARPWaitingNetworkBuffer = NULL;
|
||||
}
|
||||
|
||||
pxNetworkBuffer2 = pxGetNetworkBufferWithDescriptor( ucBUFFER_SIZE + sizeof( ARPPacket_t ), xBlockTimeTicks );
|
||||
__CPROVER_assume( pxNetworkBuffer2 != NULL );
|
||||
__CPROVER_assume( pxNetworkBuffer2->pucEthernetBuffer != NULL );
|
||||
|
||||
/*
|
||||
* This proof assumes one end point is present.
|
||||
*/
|
||||
pxNetworkBuffer2->pxEndPoint = ( NetworkEndPoint_t * ) safeMalloc( sizeof( NetworkEndPoint_t ) );
|
||||
__CPROVER_assume( pxNetworkBuffer2->pxEndPoint != NULL );
|
||||
pxNetworkBuffer2->pxEndPoint->pxNext = NULL;
|
||||
|
||||
/* eARPProcessPacket will be called in the source code only after checking if
|
||||
* pxNetworkBuffer2->pucEthernetBuffer is not NULL, hence, __CPROVER_assume( xBuffer != NULL ); */
|
||||
eARPProcessPacket( pxNetworkBuffer2 );
|
||||
}
|
||||
+19
@@ -0,0 +1,19 @@
|
||||
{
|
||||
"ENTRY": "ARPProcessPacket",
|
||||
"CBMCFLAGS":
|
||||
[
|
||||
"--unwind 1",
|
||||
"--unwindset vARPRefreshCacheEntry.0:7,memcmp.0:17,xIsIPInARPCache.0:7",
|
||||
"--unwindset prvFindCacheEntry.0:7",
|
||||
"--nondet-static"
|
||||
],
|
||||
"OBJS":
|
||||
[
|
||||
"$(ENTRY)_harness.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/source/FreeRTOS_ARP.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/source/FreeRTOS_IP.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/test/cbmc/stubs/cbmc.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/test/cbmc/stubs/freertos_api.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/test/cbmc/stubs/freertos_kernel_api.goto"
|
||||
]
|
||||
}
|
||||
+4
@@ -0,0 +1,4 @@
|
||||
The proofs in the subdirectories show that
|
||||
ARPProcessPacket is memory safe independent
|
||||
of the configuration value of
|
||||
ipconfigARP_USE_CLASH_DETECTION.
|
||||
+44
@@ -0,0 +1,44 @@
|
||||
/* FreeRTOS includes. */
|
||||
#include "FreeRTOS.h"
|
||||
#include "queue.h"
|
||||
|
||||
/* FreeRTOS+TCP includes. */
|
||||
#include "FreeRTOS_IP.h"
|
||||
#include "FreeRTOS_ARP.h"
|
||||
|
||||
void harness()
|
||||
{
|
||||
MACAddress_t xMACAddress;
|
||||
uint32_t ulIPAddress;
|
||||
|
||||
/*
|
||||
* For this proof, its assumed that the endpoints and interfaces are correctly
|
||||
* initialised and the pointers are set correctly.
|
||||
* Assumes one endpoints and interface is present.
|
||||
*/
|
||||
|
||||
pxNetworkEndPoints = ( NetworkEndPoint_t * ) malloc( sizeof( NetworkEndPoint_t ) );
|
||||
__CPROVER_assume( pxNetworkEndPoints != NULL );
|
||||
|
||||
/* Interface init. */
|
||||
pxNetworkEndPoints->pxNetworkInterface = ( NetworkInterface_t * ) malloc( sizeof( NetworkInterface_t ) );
|
||||
__CPROVER_assume( pxNetworkEndPoints->pxNetworkInterface != NULL );
|
||||
|
||||
if( nondet_bool() )
|
||||
{
|
||||
pxNetworkEndPoints->pxNext = ( NetworkEndPoint_t * ) malloc( sizeof( NetworkEndPoint_t ) );
|
||||
__CPROVER_assume( pxNetworkEndPoints->pxNext != NULL );
|
||||
pxNetworkEndPoints->pxNext->pxNext = NULL;
|
||||
pxNetworkEndPoints->pxNext->pxNetworkInterface = pxNetworkEndPoints->pxNetworkInterface;
|
||||
}
|
||||
else
|
||||
{
|
||||
pxNetworkEndPoints->pxNext = NULL;
|
||||
}
|
||||
|
||||
NetworkEndPoint_t * pxEndPoint = ( NetworkEndPoint_t * ) malloc( sizeof( NetworkEndPoint_t ) );
|
||||
__CPROVER_assume( pxEndPoint != NULL );
|
||||
|
||||
vARPRefreshCacheEntry( &xMACAddress, ulIPAddress, pxEndPoint );
|
||||
vARPRefreshCacheEntry( NULL, ulIPAddress, pxEndPoint );
|
||||
}
|
||||
+20
@@ -0,0 +1,20 @@
|
||||
{
|
||||
"ENTRY": "ARPRefreshCacheEntry",
|
||||
"CBMCFLAGS":
|
||||
[
|
||||
"--unwind 1",
|
||||
"--unwindset FreeRTOS_InterfaceEndPointOnNetMask.0:3",
|
||||
"--unwindset prvFindCacheEntry.0:7,memcmp.0:17"
|
||||
],
|
||||
"OBJS":
|
||||
[
|
||||
"$(ENTRY)_harness.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/source/FreeRTOS_ARP.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/source/FreeRTOS_Routing.goto"
|
||||
],
|
||||
"DEF":
|
||||
[
|
||||
{"NOT_STORE_REMOTE":["ipconfigARP_STORES_REMOTE_ADDRESSES=0"]},
|
||||
{"STORE_REMOTE":["ipconfigARP_STORES_REMOTE_ADDRESSES=1"]}
|
||||
]
|
||||
}
|
||||
+4
@@ -0,0 +1,4 @@
|
||||
The proofs in this directory guarantee together that
|
||||
ARPRefreshCacheEntry is memory safe independent
|
||||
of the configuration value of
|
||||
ipconfigARP_STORES_REMOTE_ADDRESSES.
|
||||
+13
@@ -0,0 +1,13 @@
|
||||
/* / * FreeRTOS includes. * / */
|
||||
#include "FreeRTOS.h"
|
||||
#include "queue.h"
|
||||
|
||||
/* FreeRTOS+TCP includes. */
|
||||
#include "FreeRTOS_IP.h"
|
||||
#include "FreeRTOS_ARP.h"
|
||||
|
||||
|
||||
void harness()
|
||||
{
|
||||
vARPSendGratuitous();
|
||||
}
|
||||
+20
@@ -0,0 +1,20 @@
|
||||
{
|
||||
"ENTRY": "ARPSendGratuitous",
|
||||
"CBMCFLAGS":
|
||||
[
|
||||
"--unwind 1",
|
||||
"--nondet-static"
|
||||
],
|
||||
"OBJS":
|
||||
[
|
||||
"$(ENTRY)_harness.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/source/FreeRTOS_ARP.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/source/FreeRTOS_IP.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/source/FreeRTOS_IP_Utils.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/test/FreeRTOS-Kernel/tasks.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/test/cbmc/stubs/freertos_kernel_api.goto"
|
||||
],
|
||||
"DEF":
|
||||
[
|
||||
]
|
||||
}
|
||||
+6
@@ -0,0 +1,6 @@
|
||||
Abstracting xQueueGenericSend away
|
||||
and including tasks.c and FreeRTOS_IP.c:
|
||||
The ARPSendGratuitous function is memory safe,
|
||||
if xQueueGenericSend is memory safe.
|
||||
|
||||
queue.c is not compiled into the proof binary.
|
||||
+19
@@ -0,0 +1,19 @@
|
||||
/* FreeRTOS includes. */
|
||||
#include "FreeRTOS.h"
|
||||
#include "queue.h"
|
||||
|
||||
/* FreeRTOS+TCP includes. */
|
||||
#include "FreeRTOS_IP.h"
|
||||
#include "FreeRTOS_ARP.h"
|
||||
|
||||
void harness()
|
||||
{
|
||||
NetworkEndPoint_t * pxEndPoint_Test = ( NetworkEndPoint_t * ) malloc( sizeof( NetworkEndPoint_t ) );
|
||||
|
||||
/*
|
||||
* Here the assumption that pxEndPoint_Test != NULL [__CPROVER_assume( pxEndPoint_Test != NULL );]
|
||||
* is not made as pxEndPoint_Test == NULL is a valid use case.
|
||||
*/
|
||||
|
||||
FreeRTOS_ClearARP( pxEndPoint_Test );
|
||||
}
|
||||
+16
@@ -0,0 +1,16 @@
|
||||
{
|
||||
"ENTRY": "ClearARP",
|
||||
"CBMCFLAGS":
|
||||
[
|
||||
"--unwind 1",
|
||||
"--unwindset FreeRTOS_ClearARP.0:7"
|
||||
],
|
||||
"OBJS":
|
||||
[
|
||||
"$(ENTRY)_harness.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/source/FreeRTOS_ARP.goto"
|
||||
],
|
||||
"DEF":
|
||||
[
|
||||
]
|
||||
}
|
||||
+2
@@ -0,0 +1,2 @@
|
||||
This proof demonstrates the memory safety of the ClearARP function in the FreeRTOS_ARP.c file.
|
||||
No restrictions are made.
|
||||
+61
@@ -0,0 +1,61 @@
|
||||
#
|
||||
# FreeRTOS memory safety proofs with CBMC.
|
||||
# Copyright (C) 2022 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.
|
||||
#
|
||||
# http://aws.amazon.com/freertos
|
||||
# http://www.FreeRTOS.org
|
||||
#
|
||||
|
||||
{
|
||||
"ENTRY": "OutputARPRequest",
|
||||
"CBMCFLAGS":
|
||||
[
|
||||
"--unwind 20"
|
||||
],
|
||||
"OBJS":
|
||||
[
|
||||
"$(ENTRY)_harness.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/source/FreeRTOS_IP.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/source/FreeRTOS_Routing.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/source/FreeRTOS_ARP.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/test/cbmc/stubs/cbmc.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/test/cbmc/stubs/freertos_api.goto"
|
||||
],
|
||||
#That is the minimal required size for an ARPPacket_t plus offset in the buffer.
|
||||
"MINIMUM_PACKET_BYTES": 50,
|
||||
"DEF":
|
||||
[
|
||||
{
|
||||
"CBMC_PROOF_ASSUMPTION_HOLDS_Packet_bytes": [
|
||||
"CBMC_PROOF_ASSUMPTION_HOLDS=1",
|
||||
"ipconfigETHERNET_MINIMUM_PACKET_BYTES={MINIMUM_PACKET_BYTES}"
|
||||
]
|
||||
},
|
||||
{
|
||||
"CBMC_PROOF_ASSUMPTION_HOLDS_no_packet_bytes": ["CBMC_PROOF_ASSUMPTION_HOLDS=1"]
|
||||
},
|
||||
{
|
||||
"CBMC_PROOF_ASSUMPTION_DOES_NOT_HOLD": ["CBMC_PROOF_ASSUMPTION_HOLDS=0"]
|
||||
}
|
||||
]
|
||||
}
|
||||
+143
@@ -0,0 +1,143 @@
|
||||
/*
|
||||
* FreeRTOS memory safety proofs with CBMC.
|
||||
* Copyright (C) 2022 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.
|
||||
*
|
||||
* http://aws.amazon.com/freertos
|
||||
* http://www.FreeRTOS.org
|
||||
*/
|
||||
|
||||
/* FreeRTOS includes. */
|
||||
#include "FreeRTOS.h"
|
||||
#include "queue.h"
|
||||
|
||||
/* FreeRTOS+TCP includes. */
|
||||
#include "FreeRTOS_IP.h"
|
||||
#include "FreeRTOS_IP_Private.h"
|
||||
#include "FreeRTOS_ARP.h"
|
||||
|
||||
/* CBMC includes. */
|
||||
#include "cbmc.h"
|
||||
|
||||
ARPPacket_t xARPPacket;
|
||||
NetworkBufferDescriptor_t xNetworkBuffer;
|
||||
|
||||
/* STUB!
|
||||
* We assume that the pxGetNetworkBufferWithDescriptor function is
|
||||
* implemented correctly and returns a valid data structure.
|
||||
* This is the mock to mimic the expected behavior.
|
||||
* If this allocation fails, this might invalidate the proof.
|
||||
* FreeRTOS_OutputARPRequest calls pxGetNetworkBufferWithDescriptor
|
||||
* to get a NetworkBufferDescriptor. Then it calls vARPGenerateRequestPacket
|
||||
* passing this buffer along in the function call. vARPGenerateRequestPacket
|
||||
* casts the pointer xNetworkBuffer.pucEthernetBuffer into an ARPPacket_t pointer
|
||||
* and writes a complete ARPPacket to it. Therefore the buffer has to be at least of the size
|
||||
* of an ARPPacket to guarantee memory safety.
|
||||
*/
|
||||
NetworkBufferDescriptor_t * pxGetNetworkBufferWithDescriptor( size_t xRequestedSizeBytes,
|
||||
TickType_t xBlockTimeTicks )
|
||||
{
|
||||
#ifdef CBMC_PROOF_ASSUMPTION_HOLDS
|
||||
#if ( ipconfigETHERNET_MINIMUM_PACKET_BYTES > 0 )
|
||||
xNetworkBuffer.pucEthernetBuffer = safeMalloc( ipconfigETHERNET_MINIMUM_PACKET_BYTES );
|
||||
#else
|
||||
xNetworkBuffer.pucEthernetBuffer = safeMalloc( xRequestedSizeBytes );
|
||||
#endif
|
||||
#else
|
||||
uint32_t malloc_size;
|
||||
__CPROVER_assert( !__CPROVER_overflow_mult( 2, xRequestedSizeBytes ) );
|
||||
__CPROVER_assume( malloc_size > 0 && malloc_size < 2 * xRequestedSizeBytes );
|
||||
xNetworkBuffer.pucEthernetBuffer = safeMalloc( malloc_size );
|
||||
#endif
|
||||
__CPROVER_assume( xNetworkBuffer.pucEthernetBuffer != NULL );
|
||||
|
||||
xNetworkBuffer.xDataLength = xRequestedSizeBytes;
|
||||
return &xNetworkBuffer;
|
||||
}
|
||||
|
||||
/* STUB!
|
||||
* In this function, it only allocates network buffer by pxGetNetworkBufferWithDescriptor
|
||||
* stub function above here. In this case, we should just free the allocated pucEthernetBuffer.
|
||||
*/
|
||||
void vReleaseNetworkBufferAndDescriptor( NetworkBufferDescriptor_t * const pxNetworkBuffer )
|
||||
{
|
||||
__CPROVER_assert( pxNetworkBuffer != NULL,
|
||||
"Precondition: pxNetworkBuffer != NULL" );
|
||||
|
||||
if( pxNetworkBuffer->pucEthernetBuffer != NULL )
|
||||
{
|
||||
free( pxNetworkBuffer->pucEthernetBuffer );
|
||||
}
|
||||
}
|
||||
|
||||
BaseType_t NetworkInterfaceOutputFunction_Stub( struct xNetworkInterface * pxDescriptor,
|
||||
NetworkBufferDescriptor_t * const pxNetworkBuffer,
|
||||
BaseType_t xReleaseAfterSend )
|
||||
{
|
||||
__CPROVER_assert( pxDescriptor != NULL, "The network interface cannot be NULL." );
|
||||
__CPROVER_assert( pxNetworkBuffer != NULL, "The network buffer descriptor cannot be NULL." );
|
||||
__CPROVER_assert( pxNetworkBuffer->pucEthernetBuffer != NULL, "The ethernet buffer cannot be NULL." );
|
||||
}
|
||||
|
||||
BaseType_t xIsCallingFromIPTask( void )
|
||||
{
|
||||
BaseType_t xReturn;
|
||||
|
||||
__CPROVER_assume( xReturn == pdFALSE || xReturn == pdTRUE );
|
||||
|
||||
return xReturn;
|
||||
}
|
||||
|
||||
void harness()
|
||||
{
|
||||
uint32_t ulIPAddress;
|
||||
|
||||
/*
|
||||
* For this proof, its assumed that the endpoints and interfaces are correctly
|
||||
* initialised and the pointers are set correctly.
|
||||
* Assumes one endpoint and interface is present.
|
||||
*/
|
||||
|
||||
pxNetworkEndPoints = ( NetworkEndPoint_t * ) safeMalloc( sizeof( NetworkEndPoint_t ) );
|
||||
__CPROVER_assume( pxNetworkEndPoints != NULL );
|
||||
|
||||
/* Interface init. */
|
||||
pxNetworkEndPoints->pxNetworkInterface = ( NetworkInterface_t * ) safeMalloc( sizeof( NetworkInterface_t ) );
|
||||
__CPROVER_assume( pxNetworkEndPoints->pxNetworkInterface != NULL );
|
||||
|
||||
if( nondet_bool() )
|
||||
{
|
||||
pxNetworkEndPoints->pxNext = ( NetworkEndPoint_t * ) safeMalloc( sizeof( NetworkEndPoint_t ) );
|
||||
__CPROVER_assume( pxNetworkEndPoints->pxNext != NULL );
|
||||
pxNetworkEndPoints->pxNext->pxNext = NULL;
|
||||
pxNetworkEndPoints->pxNext->pxNetworkInterface = pxNetworkEndPoints->pxNetworkInterface;
|
||||
}
|
||||
else
|
||||
{
|
||||
pxNetworkEndPoints->pxNext = NULL;
|
||||
}
|
||||
|
||||
pxNetworkEndPoints->pxNetworkInterface->pfOutput = &NetworkInterfaceOutputFunction_Stub;
|
||||
/* No assumption is added for pfOutput as its pointed to a static object/memory location. */
|
||||
|
||||
FreeRTOS_OutputARPRequest( ulIPAddress );
|
||||
}
|
||||
+29
@@ -0,0 +1,29 @@
|
||||
This is the memory safety proof for FreeRTOS_OutputARPRequest.
|
||||
|
||||
This proof is a work-in-progress. Proof assumptions are described in
|
||||
the harness. The proof also assumes the following functions are
|
||||
memory safe and have no side effects relevant to the memory safety of
|
||||
this function:
|
||||
|
||||
* xNetworkInterfaceOutput
|
||||
|
||||
This proof checks FreeRTOS_OutputARPRequest in multiple configuration:
|
||||
|
||||
* The config_CBMC_PROOF_ASSUMPTION_HOLDS_no_packet_bytes proof
|
||||
guarantees that for a buffer allocated to xDataLength,
|
||||
the code executed by the FreeRTOS_OutputARPRequest function
|
||||
call of FreeRTOS_ARP.c is memory safe.
|
||||
* If the ipconfigETHERNET_MINIMUM_PACKET_BYTES is set and the
|
||||
buffer allocated by pxGetNetworkBufferWithDescriptor allocates
|
||||
a buffer of at least ipconfigETHERNET_MINIMUM_PACKET_BYTES,
|
||||
the config_CBMC_PROOF_ASSUMPTION_HOLDS_Packet_bytes proof
|
||||
guarantees that the code executed by the
|
||||
FreeRTOS_OutputARPRequest function call
|
||||
of FreeRTOS_ARP.c is memory safe.
|
||||
* The third configuration in the subdirectory
|
||||
config_CBMC_PROOF_ASSUMPTION_DOES_NOT_HOLD demonstrates
|
||||
that the code is not memory safe, if the allocation
|
||||
code violates our assumption.
|
||||
* All proofs mock the pxGetNetworkBufferWithDescriptor
|
||||
function for modelling the assumptions about the
|
||||
buffer management layer.
|
||||
+16
@@ -0,0 +1,16 @@
|
||||
/* FreeRTOS includes. */
|
||||
#include "FreeRTOS.h"
|
||||
#include "queue.h"
|
||||
|
||||
/* FreeRTOS+TCP includes. */
|
||||
#include "FreeRTOS_IP.h"
|
||||
#include "FreeRTOS_IP_Private.h"
|
||||
#include "FreeRTOSIPConfig.h"
|
||||
#include "FreeRTOS_ARP.h"
|
||||
|
||||
void FreeRTOS_PrintARPCache( void );
|
||||
|
||||
void harness()
|
||||
{
|
||||
FreeRTOS_PrintARPCache();
|
||||
}
|
||||
+18
@@ -0,0 +1,18 @@
|
||||
{
|
||||
"ENTRY": "FreeRTOS_PrintARPCache",
|
||||
"CBMCFLAGS":
|
||||
[
|
||||
"--unwind 7",
|
||||
"--nondet-static"
|
||||
],
|
||||
"OBJS":
|
||||
[
|
||||
"$(ENTRY)_harness.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/source/FreeRTOS_ARP.goto"
|
||||
],
|
||||
"DEF":
|
||||
[
|
||||
"ipconfigARP_CACHE_ENTRIES=6",
|
||||
"ipconfigHAS_PRINTF=1"
|
||||
]
|
||||
}
|
||||
+4
@@ -0,0 +1,4 @@
|
||||
FreeRTOS_PrintARPCache_harness.c is memory safe,
|
||||
assuming vLoggingPrintf is correct and memory safe.
|
||||
|
||||
FreeRTOS_PrintARPCache does not use multiple configurations.
|
||||
+51
@@ -0,0 +1,51 @@
|
||||
{
|
||||
"ENTRY": "OutputARPRequest",
|
||||
"MINIMUM_PACKET_BYTES": 50,
|
||||
"CBMCFLAGS":
|
||||
[
|
||||
"--unwind {MINIMUM_PACKET_BYTES}",
|
||||
"--unwindset xNetworkBuffersInitialise.0:3,xNetworkBuffersInitialise.1:3,vListInsert.0:3,pxGetNetworkBufferWithDescriptor.0:3,pxGetNetworkBufferWithDescriptor.1:3,uxNetworkInterfaceAllocateRAMToBuffers.0:3"
|
||||
],
|
||||
"OBJS":
|
||||
[
|
||||
"$(ENTRY)_harness.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/source/FreeRTOS_IP.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/source/FreeRTOS_ARP.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/source/FreeRTOS_Routing.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/source/portable/BufferManagement/BufferAllocation_1.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/test/FreeRTOS-Kernel/list.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/test/FreeRTOS-Kernel/queue.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/test/cbmc/proofs/CBMCStubLibrary/tasksStubs.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/test/cbmc/stubs/freertos_kernel_api.goto"
|
||||
],
|
||||
"DEF":
|
||||
[
|
||||
{
|
||||
"minimal_configuration":
|
||||
[
|
||||
"ipconfigNUM_NETWORK_BUFFER_DESCRIPTORS=2",
|
||||
"configUSE_TRACE_FACILITY=0",
|
||||
"configGENERATE_RUN_TIME_STATS=0",
|
||||
"ipconfigUSE_LINKED_RX_MESSAGES=0"
|
||||
]
|
||||
},
|
||||
{
|
||||
"minimal_configuration_minimal_packet_size":
|
||||
[
|
||||
"ipconfigNUM_NETWORK_BUFFER_DESCRIPTORS=2",
|
||||
"configUSE_TRACE_FACILITY=0",
|
||||
"configGENERATE_RUN_TIME_STATS=0",
|
||||
"ipconfigETHERNET_MINIMUM_PACKET_BYTES={MINIMUM_PACKET_BYTES}"
|
||||
]
|
||||
},
|
||||
{
|
||||
"minimal_configuration_linked_rx_messages":
|
||||
[
|
||||
"ipconfigNUM_NETWORK_BUFFER_DESCRIPTORS=2",
|
||||
"configUSE_TRACE_FACILITY=0",
|
||||
"configGENERATE_RUN_TIME_STATS=0",
|
||||
"ipconfigUSE_LINKED_RX_MESSAGES=1"
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
+123
@@ -0,0 +1,123 @@
|
||||
/* This harness is linked against
|
||||
* libraries/freertos_plus/standard/freertos_plus_tcp/source/portable/BufferManagement/BufferAllocation_1.goto
|
||||
*/
|
||||
#include <stdint.h>
|
||||
#include <stdio.h>
|
||||
|
||||
/* FreeRTOS includes. */
|
||||
#include "FreeRTOS.h"
|
||||
#include "task.h"
|
||||
#include "queue.h"
|
||||
#include "semphr.h"
|
||||
|
||||
/* FreeRTOS+TCP includes. */
|
||||
#include "FreeRTOS_IP.h"
|
||||
#include "FreeRTOS_Sockets.h"
|
||||
#include "FreeRTOS_IP_Private.h"
|
||||
#include "FreeRTOS_ARP.h"
|
||||
#include "FreeRTOS_UDP_IP.h"
|
||||
#include "FreeRTOS_DHCP.h"
|
||||
#if ( ipconfigUSE_LLMNR == 1 )
|
||||
#include "FreeRTOS_DNS.h"
|
||||
#endif /* ipconfigUSE_LLMNR */
|
||||
#include "NetworkInterface.h"
|
||||
#include "NetworkBufferManagement.h"
|
||||
|
||||
size_t uxNetworkInterfaceAllocateRAMToBuffers( NetworkBufferDescriptor_t pxNetworkBuffers[ ipconfigNUM_NETWORK_BUFFER_DESCRIPTORS ] )
|
||||
{
|
||||
/*
|
||||
* In the case of buffer allocation scheme 1 the network buffers are
|
||||
* fixed size and its asserted in xNetworkBuffersInitialise call that the
|
||||
* buffer is at least ipconfigNETWORK_MTU + ipSIZE_OF_ETH_HEADER bytes
|
||||
*
|
||||
* Refer:
|
||||
* configASSERT( ( uxMaxNetworkInterfaceAllocatedSizeBytes >= ( ipconfigNETWORK_MTU + ipSIZE_OF_ETH_HEADER ) ) );
|
||||
*
|
||||
*/
|
||||
size_t xAllocSize = ipconfigNETWORK_MTU + ipSIZE_OF_ETH_HEADER;
|
||||
|
||||
for( int x = 0; x < ipconfigNUM_NETWORK_BUFFER_DESCRIPTORS; x++ )
|
||||
{
|
||||
NetworkBufferDescriptor_t * current = &pxNetworkBuffers[ x ];
|
||||
current->pucEthernetBuffer = malloc( xAllocSize );
|
||||
__CPROVER_assume( current->pucEthernetBuffer != NULL );
|
||||
current->xDataLength = sizeof( ARPPacket_t );
|
||||
}
|
||||
|
||||
return xAllocSize;
|
||||
}
|
||||
|
||||
/* The code expects that the Semaphore creation relying on pvPortMalloc
|
||||
* is successful. This is checked by an assert statement, that gets
|
||||
* triggered when the allocation fails. Nevertheless, the code is perfectly
|
||||
* guarded against a failing Semaphore allocation. To make the assert pass,
|
||||
* it is assumed for now, that pvPortMalloc doesn't fail. Using a model allowing
|
||||
* failures of the allocation might be possible
|
||||
* after removing the assert in l.105 of BufferAllocation_1.c, from a memory
|
||||
* safety point of view. */
|
||||
void * pvPortMalloc( size_t xWantedSize )
|
||||
{
|
||||
void * ptr = malloc( xWantedSize );
|
||||
|
||||
__CPROVER_assume( ptr != NULL );
|
||||
return ptr;
|
||||
}
|
||||
|
||||
/*
|
||||
* This function is implemented by a third party.
|
||||
* After looking through a couple of samples in the demos folder, it seems
|
||||
* like the only shared contract is that you want to add the if statement
|
||||
* for releasing the buffer to the end. Apart from that, it is up to the vendor,
|
||||
* how to write this code out to the network.
|
||||
*/
|
||||
BaseType_t NetworkInterfaceOutputFunction_Stub( struct xNetworkInterface * pxDescriptor,
|
||||
NetworkBufferDescriptor_t * const pxNetworkBuffer,
|
||||
BaseType_t xReleaseAfterSend )
|
||||
{
|
||||
__CPROVER_assert( pxDescriptor != NULL, "The network interface cannot be NULL." );
|
||||
__CPROVER_assert( pxNetworkBuffer != NULL, "The network buffer descriptor cannot be NULL." );
|
||||
__CPROVER_assert( pxNetworkBuffer->pucEthernetBuffer != NULL, "The ethernet buffer cannot be NULL." );
|
||||
|
||||
if( xReleaseAfterSend != pdFALSE )
|
||||
{
|
||||
vReleaseNetworkBufferAndDescriptor( pxNetworkBuffer );
|
||||
}
|
||||
}
|
||||
|
||||
BaseType_t xIsCallingFromIPTask( void )
|
||||
{
|
||||
BaseType_t xReturn;
|
||||
|
||||
__CPROVER_assume( xReturn == pdFALSE || xReturn == pdTRUE );
|
||||
|
||||
return xReturn;
|
||||
}
|
||||
|
||||
void harness()
|
||||
{
|
||||
BaseType_t xRes = xNetworkBuffersInitialise();
|
||||
|
||||
/*
|
||||
* For this proof, its assumed that the endpoints and interfaces are correctly
|
||||
* initialised and the pointers are set correctly.
|
||||
* Assumes one endpoint and interface is present.
|
||||
*/
|
||||
|
||||
pxNetworkEndPoints = ( NetworkEndPoint_t * ) malloc( sizeof( NetworkEndPoint_t ) );
|
||||
__CPROVER_assume( pxNetworkEndPoints != NULL );
|
||||
pxNetworkEndPoints->pxNext = NULL;
|
||||
|
||||
/* Interface init. */
|
||||
pxNetworkEndPoints->pxNetworkInterface = ( NetworkInterface_t * ) malloc( sizeof( NetworkInterface_t ) );
|
||||
__CPROVER_assume( pxNetworkEndPoints->pxNetworkInterface != NULL );
|
||||
pxNetworkEndPoints->pxNetworkInterface->pxNext = NULL;
|
||||
|
||||
pxNetworkEndPoints->pxNetworkInterface->pfOutput = NetworkInterfaceOutputFunction_Stub;
|
||||
/* No assumption is added for pfOutput as its pointed to a static object/memory location. */
|
||||
|
||||
if( xRes == pdPASS )
|
||||
{
|
||||
uint32_t ulIPAddress;
|
||||
FreeRTOS_OutputARPRequest( ulIPAddress );
|
||||
}
|
||||
}
|
||||
+27
@@ -0,0 +1,27 @@
|
||||
This is the memory safety proof for ```FreeRTOS_OutputARPRequest```
|
||||
method combined with the BufferAllocation_1.c allocation strategy.
|
||||
|
||||
This proof is a work-in-progress. Proof assumptions are described in
|
||||
the harness. The proof also assumes the following functions are
|
||||
memory safe and have no side effects relevant to the memory safety of
|
||||
this function:
|
||||
|
||||
* vPortEnterCritical
|
||||
* vPortExitCritical
|
||||
* vPortGenerateSimulatedInterrupt
|
||||
* vAssertCalled
|
||||
* xTaskGetSchedulerState
|
||||
* pvTaskIncrementMutexHeldCount
|
||||
* xTaskRemoveFromEventList
|
||||
* xTaskPriorityDisinherit
|
||||
|
||||
This proof checks ```FreeRTOS_OutputARPRequest``` in multiple configurations.
|
||||
All assume the memory safety of uxNetworkInterfaceAllocateRAMToBuffers.
|
||||
* The ```config_minimal_configuration``` proof sets
|
||||
```ipconfigUSE_LINKED_RX_MESSAGES=0```.
|
||||
* The ```config_minimal_configuration_linked_rx_messages``` proof sets
|
||||
```ipconfigUSE_LINKED_RX_MESSAGES=1```.
|
||||
* The ```minimal_configuration_minimal_packet_size``` proof sets
|
||||
```ipconfigETHERNET_MINIMUM_PACKET_BYTES``` to 50.
|
||||
|
||||
All harnesses include the queue.c file, but test only for the happy path.
|
||||
+52
@@ -0,0 +1,52 @@
|
||||
{
|
||||
"ENTRY": "OutputARPRequest",
|
||||
"MINIMUM_PACKET_BYTES": 50,
|
||||
"CBMCFLAGS":
|
||||
[
|
||||
"--unwind {MINIMUM_PACKET_BYTES}",
|
||||
"--unwindset xNetworkBuffersInitialise.0:3,xNetworkBuffersInitialise.1:3,vListInsert.0:3,pxGetNetworkBufferWithDescriptor.0:3,pxGetNetworkBufferWithDescriptor.1:3,uxNetworkInterfaceAllocateRAMToBuffers.0:3"
|
||||
],
|
||||
"OBJS":
|
||||
[
|
||||
"$(ENTRY)_harness.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/source/FreeRTOS_ARP.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/source/FreeRTOS_IP.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/source/FreeRTOS_Routing.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/source/portable/BufferManagement/BufferAllocation_2.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/test/FreeRTOS-Kernel/list.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/test/FreeRTOS-Kernel/queue.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/test/cbmc/stubs/freertos_kernel_api.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/test/cbmc/proofs/CBMCStubLibrary/tasksStubs.goto"
|
||||
],
|
||||
"DEF":
|
||||
[
|
||||
{
|
||||
"minimal_configuration":
|
||||
[
|
||||
"ipconfigNUM_NETWORK_BUFFER_DESCRIPTORS=2",
|
||||
"configUSE_TRACE_FACILITY=0",
|
||||
"configGENERATE_RUN_TIME_STATS=0",
|
||||
"ipconfigUSE_LINKED_RX_MESSAGES=0"
|
||||
]
|
||||
},
|
||||
{
|
||||
"minimal_configuration_minimal_packet_size":
|
||||
[
|
||||
"ipconfigNUM_NETWORK_BUFFER_DESCRIPTORS=2",
|
||||
"configUSE_TRACE_FACILITY=0",
|
||||
"configGENERATE_RUN_TIME_STATS=0",
|
||||
"ipconfigETHERNET_MINIMUM_PACKET_BYTES={MINIMUM_PACKET_BYTES}",
|
||||
"ipconfigUSE_TCP=1"
|
||||
]
|
||||
},
|
||||
{
|
||||
"minimal_configuration_linked_rx_messages":
|
||||
[
|
||||
"ipconfigNUM_NETWORK_BUFFER_DESCRIPTORS=2",
|
||||
"configUSE_TRACE_FACILITY=0",
|
||||
"configGENERATE_RUN_TIME_STATS=0",
|
||||
"ipconfigUSE_LINKED_RX_MESSAGES=1"
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
+94
@@ -0,0 +1,94 @@
|
||||
/* This harness is linked against
|
||||
* libraries/freertos_plus/standard/freertos_plus_tcp/source/portable/BufferManagement/BufferAllocation_2.goto
|
||||
*/
|
||||
#include <stdint.h>
|
||||
#include <stdio.h>
|
||||
|
||||
/* FreeRTOS includes. */
|
||||
#include "FreeRTOS.h"
|
||||
#include "task.h"
|
||||
#include "queue.h"
|
||||
#include "semphr.h"
|
||||
|
||||
/* FreeRTOS+TCP includes. */
|
||||
#include "FreeRTOS_IP.h"
|
||||
#include "FreeRTOS_Sockets.h"
|
||||
#include "FreeRTOS_IP_Private.h"
|
||||
#include "FreeRTOS_ARP.h"
|
||||
#include "FreeRTOS_UDP_IP.h"
|
||||
#include "FreeRTOS_DHCP.h"
|
||||
#if ( ipconfigUSE_LLMNR == 1 )
|
||||
#include "FreeRTOS_DNS.h"
|
||||
#endif /* ipconfigUSE_LLMNR */
|
||||
#include "NetworkInterface.h"
|
||||
#include "NetworkBufferManagement.h"
|
||||
|
||||
void * pvPortMalloc( size_t xWantedSize )
|
||||
{
|
||||
void * ptr = malloc( xWantedSize );
|
||||
|
||||
__CPROVER_assume( ptr != NULL );
|
||||
return ptr;
|
||||
}
|
||||
|
||||
|
||||
void vPortFree( void * pv )
|
||||
{
|
||||
free( pv );
|
||||
}
|
||||
|
||||
/*
|
||||
* This function function writes a buffer to the network. We stub it
|
||||
* out here, and assume it has no side effects relevant to memory safety.
|
||||
*/
|
||||
BaseType_t NetworkInterfaceOutputFunction_Stub( struct xNetworkInterface * pxDescriptor,
|
||||
NetworkBufferDescriptor_t * const pxNetworkBuffer,
|
||||
BaseType_t xReleaseAfterSend )
|
||||
{
|
||||
__CPROVER_assert( pxDescriptor != NULL, "The network interface cannot be NULL." );
|
||||
__CPROVER_assert( pxNetworkBuffer != NULL, "The network buffer descriptor cannot be NULL." );
|
||||
__CPROVER_assert( pxNetworkBuffer->pucEthernetBuffer != NULL, "The ethernet buffer cannot be NULL." );
|
||||
|
||||
if( xReleaseAfterSend != pdFALSE )
|
||||
{
|
||||
vReleaseNetworkBufferAndDescriptor( pxNetworkBuffer );
|
||||
}
|
||||
}
|
||||
|
||||
BaseType_t xIsCallingFromIPTask( void )
|
||||
{
|
||||
BaseType_t xReturn;
|
||||
|
||||
__CPROVER_assume( xReturn == pdFALSE || xReturn == pdTRUE );
|
||||
|
||||
return xReturn;
|
||||
}
|
||||
|
||||
void harness()
|
||||
{
|
||||
BaseType_t xRes = xNetworkBuffersInitialise();
|
||||
|
||||
/*
|
||||
* For this proof, its assumed that the endpoints and interfaces are correctly
|
||||
* initialised and the pointers are set correctly.
|
||||
* Assumes one endpoint and interface is present.
|
||||
*/
|
||||
|
||||
pxNetworkEndPoints = ( NetworkEndPoint_t * ) malloc( sizeof( NetworkEndPoint_t ) );
|
||||
__CPROVER_assume( pxNetworkEndPoints != NULL );
|
||||
pxNetworkEndPoints->pxNext = NULL;
|
||||
|
||||
/* Interface init. */
|
||||
pxNetworkEndPoints->pxNetworkInterface = ( NetworkInterface_t * ) malloc( sizeof( NetworkInterface_t ) );
|
||||
__CPROVER_assume( pxNetworkEndPoints->pxNetworkInterface != NULL );
|
||||
pxNetworkEndPoints->pxNetworkInterface->pxNext = NULL;
|
||||
|
||||
pxNetworkEndPoints->pxNetworkInterface->pfOutput = NetworkInterfaceOutputFunction_Stub;
|
||||
/* No assumption is added for pfOutput as its pointed to a static object/memory location. */
|
||||
|
||||
if( xRes == pdPASS )
|
||||
{
|
||||
uint32_t ulIPAddress;
|
||||
FreeRTOS_OutputARPRequest( ulIPAddress );
|
||||
}
|
||||
}
|
||||
+49
@@ -0,0 +1,49 @@
|
||||
This is the memory safety proof for FreeRTOS_OutputARPRequest
|
||||
method combined with the BufferAllocation_2.c allocation strategy.
|
||||
|
||||
This proof is a work-in-progress. Proof assumptions are described in
|
||||
the harness. The proof also assumes the following functions are
|
||||
memory safe and have no side effects relevant to the memory safety of
|
||||
this function:
|
||||
|
||||
* vPortEnterCritical
|
||||
* vPortExitCritical
|
||||
* vPortGenerateSimulatedInterrupt
|
||||
* vAssertCalled
|
||||
* xTaskGetSchedulerState
|
||||
* pvTaskIncrementMutexHeldCount
|
||||
* xTaskRemoveFromEventList
|
||||
* xTaskPriorityDisinherit
|
||||
|
||||
* pvPortMalloc
|
||||
* pvPortFree
|
||||
* xNetworkInterfaceOutput
|
||||
* uxNetworkInterfaceAllocateRAMToBuffers
|
||||
|
||||
This proof disables the tracing library in the header.
|
||||
|
||||
This proof checks FreeRTOS_OutputARPRequest in multiple configuration:
|
||||
|
||||
* The proof in the directory config_minimal_configuration guarantees
|
||||
that the implementation and interaction between
|
||||
FreeRTOS_OutputARPRequest and
|
||||
FreeRTOS-Plus-TCP/source/portable/BufferManagement/BufferAllocation_2.c
|
||||
are memory save. This proof depends entirely of the implementation
|
||||
correctness of uxNetworkInterfaceAllocateRAMToBuffers.
|
||||
* The proof in directory minimal_configuration_minimal_packet_size
|
||||
guarantees that using
|
||||
FreeRTOS-Plus-TCP/source/portable/BufferManagement/BufferAllocation_2.c
|
||||
along with the ipconfigETHERNET_MINIMUM_PACKET_BYTES is memory save
|
||||
as long as TCP is enabled ( ipconfigUSE_TCP 1 ) and
|
||||
ipconfigETHERNET_MINIMUM_PACKET_BYTES < sizeof( TCPPacket_t ).
|
||||
* The directory minimal_configuration_minimal_packet_size_no_tcp
|
||||
reminds that ipconfigETHERNET_MINIMUM_PACKET_BYTES must not be used
|
||||
if TCP is disabled ( ipconfigUSE_TCP 1 ) along with the
|
||||
FreeRTOS-Plus-TCP/source/portable/BufferManagement/BufferAllocation_2.c
|
||||
allocator.
|
||||
* The proof in directory
|
||||
config_minimal_configuration_linked_rx_messages guarantees that the
|
||||
ipconfigUSE_LINKED_RX_MESSAGES define does not interfere with the
|
||||
memory safety claim.
|
||||
|
||||
All harnesses include the queue.c file, but test only for the happy path.
|
||||
+24
@@ -0,0 +1,24 @@
|
||||
{
|
||||
"ENTRY": "ulARPRemoveCacheEntryByMac",
|
||||
"NUMBER_OF_CACHE_ENTRIES":6,
|
||||
"CBMCFLAGS":
|
||||
[
|
||||
],
|
||||
"OBJS":
|
||||
[
|
||||
"$(ENTRY)_harness.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/source/FreeRTOS_ARP.goto"
|
||||
],
|
||||
"INSTFLAGS":
|
||||
[
|
||||
],
|
||||
"DEF":
|
||||
[
|
||||
"ipconfigUSE_ARP_REMOVE_ENTRY=1",
|
||||
"ipconfigARP_CACHE_ENTRIES={NUMBER_OF_CACHE_ENTRIES}"
|
||||
],
|
||||
"INC":
|
||||
[
|
||||
"$(FREERTOS_PLUS_TCP)/test/cbmc/include"
|
||||
]
|
||||
}
|
||||
+20
@@ -0,0 +1,20 @@
|
||||
/* Standard includes. */
|
||||
#include <stdint.h>
|
||||
#include <stdio.h>
|
||||
|
||||
/* FreeRTOS includes. */
|
||||
#include "FreeRTOS.h"
|
||||
|
||||
/* FreeRTOS+TCP includes. */
|
||||
#include "FreeRTOS_IP.h"
|
||||
#include "FreeRTOS_ARP.h"
|
||||
|
||||
|
||||
void harness()
|
||||
{
|
||||
const MACAddress_t xMACAddress;
|
||||
|
||||
/* The pointer passed to ulARPRemoveCacheEntryByMac cannot be NULL
|
||||
* (see the API definition). */
|
||||
ulARPRemoveCacheEntryByMac( &xMACAddress );
|
||||
}
|
||||
+17
@@ -0,0 +1,17 @@
|
||||
{
|
||||
"ENTRY": "xCheckRequiresARPResolution",
|
||||
"CBMCFLAGS":
|
||||
[
|
||||
"--unwind 1",
|
||||
"--unwindset memcmp.0:10"
|
||||
],
|
||||
"OBJS":
|
||||
[
|
||||
"$(ENTRY)_harness.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/test/cbmc/stubs/cbmc.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/source/FreeRTOS_ARP.goto"
|
||||
],
|
||||
"DEF":
|
||||
[
|
||||
]
|
||||
}
|
||||
+118
@@ -0,0 +1,118 @@
|
||||
/* FreeRTOS includes. */
|
||||
#include "FreeRTOS.h"
|
||||
#include "queue.h"
|
||||
|
||||
/* FreeRTOS+TCP includes. */
|
||||
#include "FreeRTOS_IP.h"
|
||||
#include "FreeRTOS_ARP.h"
|
||||
#include "FreeRTOS_Routing.h"
|
||||
/* CBMC includes. */
|
||||
#include "cbmc.h"
|
||||
|
||||
/* Global variables. */
|
||||
BaseType_t xIsIPv6;
|
||||
|
||||
/* Abstraction of xIsIPInARPCache. */
|
||||
BaseType_t xIsIPInARPCache( uint32_t ulAddressToLookup )
|
||||
{
|
||||
BaseType_t xReturn;
|
||||
|
||||
__CPROVER_assume( ( xReturn == pdTRUE ) || ( xReturn == pdFALSE ) );
|
||||
|
||||
return xReturn;
|
||||
}
|
||||
|
||||
/* Function uxIPHeaderSizePacket is proven to be correct separately.*/
|
||||
size_t uxIPHeaderSizePacket( const NetworkBufferDescriptor_t * pxNetworkBuffer )
|
||||
{
|
||||
size_t xReturn = ipSIZE_OF_IPv4_HEADER;
|
||||
|
||||
__CPROVER_assert( __CPROVER_r_ok( pxNetworkBuffer, sizeof( NetworkBufferDescriptor_t ) ), "pxNetworkBuffer must be readable" );
|
||||
__CPROVER_assert( __CPROVER_r_ok( pxNetworkBuffer->pucEthernetBuffer, pxNetworkBuffer->xDataLength ), "pxNetworkBuffer;s buffer must be readable" );
|
||||
|
||||
if( xIsIPv6 )
|
||||
{
|
||||
xReturn = ipSIZE_OF_IPv6_HEADER;
|
||||
}
|
||||
|
||||
return xReturn;
|
||||
}
|
||||
|
||||
/* Abstraction of FreeRTOS_OutputARPRequest_Multi. */
|
||||
void FreeRTOS_OutputARPRequest_Multi( NetworkEndPoint_t * pxEndPoint,
|
||||
uint32_t ulIPAddress )
|
||||
{
|
||||
}
|
||||
|
||||
/* Abstraction of xIPv6_GetIPType. */
|
||||
IPv6_Type_t xIPv6_GetIPType( const IPv6_Address_t * pxAddress )
|
||||
{
|
||||
IPv6_Type_t eType;
|
||||
|
||||
__CPROVER_assert( __CPROVER_r_ok( pxAddress, sizeof( IPv6_Address_t ) ), "pxAddress must be readable" );
|
||||
|
||||
return eType;
|
||||
}
|
||||
|
||||
/* Abstraction of eNDGetCacheEntry. */
|
||||
eResolutionLookupResult_t eNDGetCacheEntry( IPv6_Address_t * pxIPAddress,
|
||||
MACAddress_t * const pxMACAddress,
|
||||
struct xNetworkEndPoint ** ppxEndPoint )
|
||||
{
|
||||
eResolutionLookupResult_t xReturn;
|
||||
|
||||
__CPROVER_assert( __CPROVER_r_ok( pxIPAddress, sizeof( IPv6_Address_t ) ), "pxIPAddress must be readable" );
|
||||
__CPROVER_assert( __CPROVER_w_ok( pxMACAddress, sizeof( MACAddress_t ) ), "pxMACAddress must be writeable" );
|
||||
|
||||
return xReturn;
|
||||
}
|
||||
|
||||
/* Abstraction of pxGetNetworkBufferWithDescriptor. */
|
||||
NetworkBufferDescriptor_t * pxGetNetworkBufferWithDescriptor( size_t xRequestedSizeBytes,
|
||||
TickType_t xBlockTimeTicks )
|
||||
{
|
||||
NetworkBufferDescriptor_t * pxNetworkBuffer = ( NetworkBufferDescriptor_t * ) safeMalloc( sizeof( NetworkBufferDescriptor_t ) );
|
||||
|
||||
return pxNetworkBuffer;
|
||||
}
|
||||
|
||||
/* Abstraction of vNDSendNeighbourSolicitation. */
|
||||
void vNDSendNeighbourSolicitation( NetworkBufferDescriptor_t * pxNetworkBuffer,
|
||||
const IPv6_Address_t * pxIPAddress )
|
||||
{
|
||||
__CPROVER_assert( __CPROVER_r_ok( pxNetworkBuffer, sizeof( NetworkBufferDescriptor_t ) ), "pxNetworkBuffer must be readable" );
|
||||
__CPROVER_assert( __CPROVER_r_ok( pxIPAddress, sizeof( IPv6_Address_t ) ), "pxIPAddress must be readable" );
|
||||
}
|
||||
|
||||
void harness()
|
||||
{
|
||||
size_t xBufferLength;
|
||||
NetworkBufferDescriptor_t * pxNetworkBuffer;
|
||||
IPPacket_t * pxIPPacket;
|
||||
IPHeader_t * pxIPHeader;
|
||||
|
||||
/* Make sure buffer size is enough, xCheckRequiresARPResolution is only called for
|
||||
* IPv4 packets hence the minimum size should be sizeof( IPPacket_t ) */
|
||||
__CPROVER_assume( ( xBufferLength >= sizeof( IPPacket_t ) ) && ( xBufferLength < ipconfigNETWORK_MTU ) );
|
||||
|
||||
pxNetworkBuffer = ( NetworkBufferDescriptor_t * ) safeMalloc( sizeof( NetworkBufferDescriptor_t ) );
|
||||
__CPROVER_assume( pxNetworkBuffer != NULL );
|
||||
|
||||
pxNetworkBuffer->xDataLength = xBufferLength;
|
||||
|
||||
pxNetworkBuffer->pucEthernetBuffer = safeMalloc( xBufferLength );
|
||||
__CPROVER_assume( pxNetworkBuffer->pucEthernetBuffer != NULL );
|
||||
|
||||
/* Its asserted in the code that xCheckRequiresARPResolution is only called on IPv4 frame types */
|
||||
|
||||
/* See assertion: configASSERT( ( pxIPPacket->xEthernetHeader.usFrameType == ipIPv4_FRAME_TYPE ) || ( pxIPPacket->xEthernetHeader.usFrameType == ipARP_FRAME_TYPE ) );
|
||||
* in xCheckRequiresARPResolution() */
|
||||
pxIPPacket = ( ( const IPPacket_t * ) pxNetworkBuffer->pucEthernetBuffer );
|
||||
pxIPHeader = &( pxIPPacket->xIPHeader );
|
||||
__CPROVER_assume( pxIPPacket->xEthernetHeader.usFrameType == ipIPv4_FRAME_TYPE );
|
||||
|
||||
pxNetworkBuffer->pxEndPoint = ( NetworkEndPoint_t * ) safeMalloc( sizeof( NetworkEndPoint_t ) );
|
||||
__CPROVER_assume( pxNetworkBuffer->pxEndPoint != NULL );
|
||||
|
||||
( void ) xCheckRequiresARPResolution( pxNetworkBuffer );
|
||||
}
|
||||
+52
@@ -0,0 +1,52 @@
|
||||
#include "FreeRTOS.h"
|
||||
#include "task.h"
|
||||
#include "tasksStubs.h"
|
||||
|
||||
#ifndef TASK_STUB_COUNTER
|
||||
#define TASK_STUB_COUNTER 0;
|
||||
#endif
|
||||
|
||||
/* 5 is a magic number, but we need some number here as a default value.
|
||||
* This value is used to bound any loop depending on xTaskCheckForTimeOut
|
||||
* as a loop bound. It should be overwritten in the Makefile.json adapting
|
||||
* to the performance requirements of the harness. */
|
||||
#ifndef TASK_STUB_COUNTER_LIMIT
|
||||
#define TASK_STUB_COUNTER_LIMIT 5;
|
||||
#endif
|
||||
|
||||
|
||||
static BaseType_t xCounter = TASK_STUB_COUNTER;
|
||||
static BaseType_t xCounterLimit = TASK_STUB_COUNTER_LIMIT;
|
||||
|
||||
BaseType_t xTaskGetSchedulerState( void )
|
||||
{
|
||||
return xState;
|
||||
}
|
||||
|
||||
|
||||
/* This function is another method apart from overwriting the defines to init the max
|
||||
* loop bound. */
|
||||
void vInitTaskCheckForTimeOut( BaseType_t maxCounter,
|
||||
BaseType_t maxCounter_limit )
|
||||
{
|
||||
xCounter = maxCounter;
|
||||
xCounterLimit = maxCounter_limit;
|
||||
}
|
||||
|
||||
/* This is mostly called in a loop. For CBMC, we have to bound the loop
|
||||
* to a max limits of calls. Therefore this Stub models a nondet timeout in
|
||||
* max TASK_STUB_COUNTER_LIMIT iterations.*/
|
||||
BaseType_t xTaskCheckForTimeOut( TimeOut_t * const pxTimeOut,
|
||||
TickType_t * const pxTicksToWait )
|
||||
{
|
||||
++xCounter;
|
||||
|
||||
if( xCounter == xCounterLimit )
|
||||
{
|
||||
return pdTRUE;
|
||||
}
|
||||
else
|
||||
{
|
||||
return nondet_basetype();
|
||||
}
|
||||
}
|
||||
+40
@@ -0,0 +1,40 @@
|
||||
list(APPEND cbmc_compile_options
|
||||
-m32
|
||||
)
|
||||
|
||||
list(APPEND cbmc_compile_definitions
|
||||
CBMC
|
||||
WINVER=0x400
|
||||
_CONSOLE
|
||||
_CRT_SECURE_NO_WARNINGS
|
||||
_DEBUG
|
||||
_WIN32_WINNT=0x0500
|
||||
__PRETTY_FUNCTION__=__FUNCTION__
|
||||
__free_rtos__
|
||||
)
|
||||
|
||||
list(APPEND cbmc_compile_includes
|
||||
${CMAKE_SOURCE_DIR}/Source/include
|
||||
${CMAKE_SOURCE_DIR}/Source/portable/MSVC-MingW
|
||||
${CMAKE_SOURCE_DIR}/Source/../../FreeRTOS-Plus/Source/FreeRTOS-Plus-TCP/portable/BufferManagement
|
||||
${CMAKE_SOURCE_DIR}/Source/../../FreeRTOS-Plus/Source/FreeRTOS-Plus-TCP/include
|
||||
${CMAKE_SOURCE_DIR}/Source/../../FreeRTOS-Plus/Source/FreeRTOS-Plus-TCP/portable/Compiler/MSVC
|
||||
${cbmc_dir}/include
|
||||
${cbmc_dir}/windows
|
||||
)
|
||||
|
||||
# Remove --flag for a specific proof with list(REMOVE_ITEM cbmc_flags --flag)
|
||||
list(APPEND cbmc_flags
|
||||
--32
|
||||
--bounds-check
|
||||
--pointer-check
|
||||
--div-by-zero-check
|
||||
--float-overflow-check
|
||||
--nan-check
|
||||
--nondet-static
|
||||
--pointer-overflow-check
|
||||
--signed-overflow-check
|
||||
--undefined-shift-check
|
||||
--unsigned-overflow-check
|
||||
)
|
||||
|
||||
+128
@@ -0,0 +1,128 @@
|
||||
/* Standard includes. */
|
||||
#include <stdint.h>
|
||||
#include <stdio.h>
|
||||
|
||||
/* FreeRTOS includes. */
|
||||
#include "FreeRTOS.h"
|
||||
#include "task.h"
|
||||
#include "queue.h"
|
||||
#include "semphr.h"
|
||||
|
||||
/* FreeRTOS+TCP includes. */
|
||||
#include "FreeRTOS_IP.h"
|
||||
#include "FreeRTOS_Sockets.h"
|
||||
#include "FreeRTOS_IP_Private.h"
|
||||
#include "FreeRTOS_UDP_IP.h"
|
||||
#include "FreeRTOS_DHCP.h"
|
||||
#include "NetworkInterface.h"
|
||||
#include "NetworkBufferManagement.h"
|
||||
#include "FreeRTOS_ARP.h"
|
||||
|
||||
#include "cbmc.h"
|
||||
|
||||
/****************************************************************
|
||||
* Signature of function under test
|
||||
****************************************************************/
|
||||
|
||||
BaseType_t prvCheckOptions( FreeRTOS_Socket_t * pxSocket,
|
||||
const NetworkBufferDescriptor_t * pxNetworkBuffer );
|
||||
|
||||
size_t uxIPHeaderSizePacket( const NetworkBufferDescriptor_t * pxNetworkBuffer );
|
||||
|
||||
int32_t __CPROVER_file_local_FreeRTOS_TCP_IP_c_prvSingleStepTCPHeaderOptions( const uint8_t * const pucPtr,
|
||||
size_t uxTotalLength,
|
||||
FreeRTOS_Socket_t * const pxSocket,
|
||||
BaseType_t xHasSYNFlag );
|
||||
|
||||
/****************************************************************
|
||||
* Declare the buffer size external to the harness so it can be
|
||||
* accessed by the preconditions of prvSingleStepTCPHeaderOptions, and
|
||||
* give the buffer size an unconstrained value in the harness itself.
|
||||
****************************************************************/
|
||||
size_t buffer_size;
|
||||
size_t uxIPHeaderSizePacket_uxResult;
|
||||
|
||||
/****************************************************************
|
||||
* Function contract proved correct by CheckOptionsOuter
|
||||
****************************************************************/
|
||||
|
||||
int32_t __CPROVER_file_local_FreeRTOS_TCP_Reception_c_prvSingleStepTCPHeaderOptions( const uint8_t * const pucPtr,
|
||||
size_t uxTotalLength,
|
||||
FreeRTOS_Socket_t * const pxSocket,
|
||||
BaseType_t xHasSYNFlag )
|
||||
{
|
||||
/* CBMC model of pointers limits the size of the buffer */
|
||||
|
||||
/* Preconditions */
|
||||
__CPROVER_assert( buffer_size < CBMC_MAX_OBJECT_SIZE,
|
||||
"prvSingleStepTCPHeaderOptions: buffer_size < CBMC_MAX_OBJECT_SIZE" );
|
||||
__CPROVER_assert( 8 <= buffer_size,
|
||||
"prvSingleStepTCPHeaderOptions: 8 <= buffer_size" );
|
||||
__CPROVER_assert( pucPtr != NULL,
|
||||
"prvSingleStepTCPHeaderOptions: pucPtr != NULL" );
|
||||
__CPROVER_assert( uxTotalLength <= buffer_size,
|
||||
"prvSingleStepTCPHeaderOptions: uxTotalLength <= buffer_size" );
|
||||
__CPROVER_assert( pxSocket != NULL,
|
||||
"prvSingleStepTCPHeaderOptions: pxSocket != NULL" );
|
||||
|
||||
/* Postconditions */
|
||||
int32_t index;
|
||||
|
||||
__CPROVER_assume( ( index == -1 ) || ( index == 1 ) || ( index <= uxTotalLength ) );
|
||||
|
||||
return index;
|
||||
}
|
||||
|
||||
size_t uxIPHeaderSizePacket( const NetworkBufferDescriptor_t * pxNetworkBuffer )
|
||||
{
|
||||
__CPROVER_assert( pxNetworkBuffer != NULL, "pxNetworkBuffer should not be NULL" );
|
||||
return uxIPHeaderSizePacket_uxResult;
|
||||
}
|
||||
|
||||
/****************************************************************
|
||||
* Proof of CheckOptions
|
||||
****************************************************************/
|
||||
|
||||
void harness()
|
||||
{
|
||||
/* Give buffer_size an unconstrained value */
|
||||
size_t buf_size;
|
||||
|
||||
if( nondet_bool() )
|
||||
{
|
||||
uxIPHeaderSizePacket_uxResult = ipSIZE_OF_IPv6_HEADER;
|
||||
}
|
||||
else
|
||||
{
|
||||
uxIPHeaderSizePacket_uxResult = ipSIZE_OF_IPv4_HEADER;
|
||||
}
|
||||
|
||||
__CPROVER_assume( buf_size > ( ipSIZE_OF_ETH_HEADER + uxIPHeaderSizePacket_uxResult + sizeof( TCPHeader_t ) ) );
|
||||
|
||||
buffer_size = buf_size;
|
||||
|
||||
/* pxSocket can be any socket */
|
||||
FreeRTOS_Socket_t pxSocket;
|
||||
|
||||
/* pxNetworkBuffer can be any buffer descriptor with any buffer */
|
||||
NetworkBufferDescriptor_t pxNetworkBuffer;
|
||||
|
||||
pxNetworkBuffer.pucEthernetBuffer = malloc( buffer_size );
|
||||
__CPROVER_assume( pxNetworkBuffer.pucEthernetBuffer != NULL );
|
||||
pxNetworkBuffer.xDataLength = buffer_size;
|
||||
|
||||
/****************************************************************
|
||||
* Specification and proof of CheckOptions
|
||||
****************************************************************/
|
||||
|
||||
/* CBMC model of pointers limits the size of the buffer */
|
||||
__CPROVER_assume( buffer_size < CBMC_MAX_OBJECT_SIZE );
|
||||
|
||||
/* Bound required to bound iteration over the buffer */
|
||||
__CPROVER_assume( buffer_size <= BUFFER_SIZE );
|
||||
|
||||
/* Buffer must be big enough to hold pxTCPPacket and pxTCPHeader */
|
||||
__CPROVER_assume( buffer_size > 47 );
|
||||
|
||||
prvCheckOptions( &pxSocket, &pxNetworkBuffer );
|
||||
}
|
||||
+28
@@ -0,0 +1,28 @@
|
||||
{
|
||||
"ENTRY": "CheckOptions",
|
||||
"CBMCFLAGS":
|
||||
[
|
||||
"--unwind 1",
|
||||
"--unwindset prvCheckOptions.0:41"
|
||||
],
|
||||
"OPT":
|
||||
[
|
||||
"--export-file-local-symbols"
|
||||
],
|
||||
"OBJS":
|
||||
[
|
||||
"$(ENTRY)_harness.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/source/FreeRTOS_IP.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/source/FreeRTOS_TCP_Reception.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/source/FreeRTOS_TCP_WIN.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/source/FreeRTOS_TCP_IP.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/source/FreeRTOS_Stream_Buffer.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/test/FreeRTOS-Kernel/tasks.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/test/FreeRTOS-Kernel/list.goto"
|
||||
],
|
||||
"BUFFER_SIZE": 100,
|
||||
"DEF":
|
||||
[
|
||||
"BUFFER_SIZE={BUFFER_SIZE}"
|
||||
]
|
||||
}
|
||||
+104
@@ -0,0 +1,104 @@
|
||||
/* Standard includes. */
|
||||
#include <stdint.h>
|
||||
#include <stdio.h>
|
||||
|
||||
/* FreeRTOS includes. */
|
||||
#include "FreeRTOS.h"
|
||||
#include "task.h"
|
||||
#include "queue.h"
|
||||
#include "semphr.h"
|
||||
|
||||
/* FreeRTOS+TCP includes. */
|
||||
#include "FreeRTOS_IP.h"
|
||||
#include "FreeRTOS_Sockets.h"
|
||||
#include "FreeRTOS_IP_Private.h"
|
||||
#include "FreeRTOS_UDP_IP.h"
|
||||
#include "FreeRTOS_DHCP.h"
|
||||
#include "NetworkInterface.h"
|
||||
#include "NetworkBufferManagement.h"
|
||||
#include "FreeRTOS_ARP.h"
|
||||
|
||||
#include "cbmc.h"
|
||||
|
||||
/****************************************************************
|
||||
* Signature of function under test
|
||||
****************************************************************/
|
||||
|
||||
void __CPROVER_file_local_FreeRTOS_TCP_Reception_c_prvReadSackOption( const uint8_t * const pucPtr,
|
||||
size_t uxIndex,
|
||||
FreeRTOS_Socket_t * const pxSocket );
|
||||
|
||||
/****************************************************************
|
||||
* Proof of prvReadSackOption function contract
|
||||
****************************************************************/
|
||||
|
||||
void harness()
|
||||
{
|
||||
/* pucPtr points into a buffer */
|
||||
size_t buffer_size;
|
||||
uint8_t * pucPtr = malloc( buffer_size );
|
||||
|
||||
__CPROVER_assume( pucPtr != NULL );
|
||||
|
||||
/* uxIndex in an index into the buffer */
|
||||
size_t uxIndex;
|
||||
|
||||
/* pxSocket can be any socket with some initialized values */
|
||||
FreeRTOS_Socket_t * pxSocket = malloc( sizeof( FreeRTOS_Socket_t ) );
|
||||
|
||||
__CPROVER_assume( pxSocket != NULL );
|
||||
|
||||
pxSocket->u.xTCP.txStream = malloc( sizeof( StreamBuffer_t ) );
|
||||
__CPROVER_assume( pxSocket->u.xTCP.txStream != NULL );
|
||||
|
||||
vListInitialise( &pxSocket->u.xTCP.xTCPWindow.xWaitQueue );
|
||||
|
||||
if( nondet_bool() )
|
||||
{
|
||||
TCPSegment_t * segment = malloc( sizeof( TCPSegment_t ) );
|
||||
__CPROVER_assume( segment != NULL );
|
||||
listSET_LIST_ITEM_OWNER( &segment->xQueueItem, ( void * ) segment );
|
||||
vListInsertEnd( &pxSocket->u.xTCP.xTCPWindow.xWaitQueue, &segment->xQueueItem );
|
||||
}
|
||||
|
||||
vListInitialise( &pxSocket->u.xTCP.xTCPWindow.xTxSegments );
|
||||
|
||||
if( nondet_bool() )
|
||||
{
|
||||
TCPSegment_t * segment = malloc( sizeof( TCPSegment_t ) );
|
||||
__CPROVER_assume( segment != NULL );
|
||||
vListInitialiseItem( &segment->xSegmentItem );
|
||||
listSET_LIST_ITEM_OWNER( &segment->xQueueItem, ( void * ) segment );
|
||||
vListInsertEnd( &pxSocket->u.xTCP.xTCPWindow.xTxSegments, &segment->xQueueItem );
|
||||
}
|
||||
|
||||
vListInitialise( &pxSocket->u.xTCP.xTCPWindow.xPriorityQueue );
|
||||
|
||||
extern List_t xSegmentList;
|
||||
|
||||
vListInitialise( &xSegmentList );
|
||||
|
||||
/****************************************************************
|
||||
* Specification and proof of CheckOptions inner loop
|
||||
****************************************************************/
|
||||
|
||||
/* Preconditions */
|
||||
|
||||
/* CBMC model of pointers limits the size of the buffer */
|
||||
__CPROVER_assume( buffer_size < ipconfigNETWORK_MTU );
|
||||
|
||||
/* Both preconditions are required to avoid integer overflow in the */
|
||||
/* pointer offset of the pointer pucPtr + uxIndex + 8 */
|
||||
__CPROVER_assume( uxIndex <= buffer_size );
|
||||
__CPROVER_assume( uxIndex + 8 <= buffer_size );
|
||||
|
||||
/* Assuming quite a bit more about the initialization of pxSocket */
|
||||
__CPROVER_assume( pucPtr != NULL );
|
||||
__CPROVER_assume( pxSocket != NULL );
|
||||
/* lSRTT is guaranteed to be always greater than or equal to minimum value. */
|
||||
__CPROVER_assume( pxSocket->u.xTCP.xTCPWindow.lSRTT >= ipconfigTCP_SRTT_MINIMUM_VALUE_MS );
|
||||
|
||||
__CPROVER_file_local_FreeRTOS_TCP_Reception_c_prvReadSackOption( pucPtr, uxIndex, pxSocket );
|
||||
|
||||
/* No postconditions required */
|
||||
}
|
||||
+28
@@ -0,0 +1,28 @@
|
||||
{
|
||||
"ENTRY": "CheckOptionsInner",
|
||||
"CBMCFLAGS": [
|
||||
"--unwind 1",
|
||||
"--unwindset __CPROVER_file_local_FreeRTOS_TCP_WIN_c_prvTCPWindowTxCheckAck.0:2",
|
||||
"--unwindset __CPROVER_file_local_FreeRTOS_TCP_WIN_c_prvTCPWindowFastRetransmit.0:2"
|
||||
],
|
||||
"OPT":
|
||||
[
|
||||
"--export-file-local-symbols"
|
||||
],
|
||||
"OBJS":
|
||||
[
|
||||
"$(ENTRY)_harness.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/source/FreeRTOS_IP_Utils.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/source/FreeRTOS_TCP_Reception.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/source/FreeRTOS_TCP_IP.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/source/FreeRTOS_TCP_WIN.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/source/FreeRTOS_Stream_Buffer.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/test/FreeRTOS-Kernel/tasks.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/test/FreeRTOS-Kernel/list.goto"
|
||||
],
|
||||
"DEF":
|
||||
[
|
||||
"ipconfigUSE_TCP=1",
|
||||
"ipconfigNETWORK_MTU=586"
|
||||
]
|
||||
}
|
||||
+100
@@ -0,0 +1,100 @@
|
||||
/* Standard includes. */
|
||||
#include <stdint.h>
|
||||
#include <stdio.h>
|
||||
|
||||
/* FreeRTOS includes. */
|
||||
#include "FreeRTOS.h"
|
||||
#include "task.h"
|
||||
#include "queue.h"
|
||||
#include "semphr.h"
|
||||
|
||||
/* FreeRTOS+TCP includes. */
|
||||
#include "FreeRTOS_IP.h"
|
||||
#include "FreeRTOS_Sockets.h"
|
||||
#include "FreeRTOS_IP_Private.h"
|
||||
#include "FreeRTOS_UDP_IP.h"
|
||||
#include "FreeRTOS_DHCP.h"
|
||||
#include "NetworkInterface.h"
|
||||
#include "NetworkBufferManagement.h"
|
||||
#include "FreeRTOS_ARP.h"
|
||||
|
||||
#include "cbmc.h"
|
||||
|
||||
/****************************************************************
|
||||
* Signature of the function under test
|
||||
****************************************************************/
|
||||
|
||||
int32_t __CPROVER_file_local_FreeRTOS_TCP_Reception_c_prvSingleStepTCPHeaderOptions( const uint8_t * const pucPtr,
|
||||
size_t uxTotalLength,
|
||||
FreeRTOS_Socket_t * const pxSocket,
|
||||
BaseType_t xHasSYNFlag );
|
||||
|
||||
/****************************************************************
|
||||
* Declare the buffer size external to the harness so it can be
|
||||
* accessed by the preconditions of prvReadSackOption, and give the
|
||||
* buffer size an unconstrained value in the harness itself.
|
||||
****************************************************************/
|
||||
|
||||
size_t buffer_size;
|
||||
|
||||
/****************************************************************
|
||||
* Function contract proved correct by CheckOptionsInner
|
||||
****************************************************************/
|
||||
|
||||
void __CPROVER_file_local_FreeRTOS_TCP_Reception_c_prvReadSackOption( const uint8_t * const pucPtr,
|
||||
size_t uxIndex,
|
||||
FreeRTOS_Socket_t * const pxSocket )
|
||||
{
|
||||
/* Preconditions */
|
||||
__CPROVER_assert( buffer_size < CBMC_MAX_OBJECT_SIZE,
|
||||
"prvReadSackOption: buffer_size < CBMC_MAX_OBJECT_SIZE" );
|
||||
__CPROVER_assert( uxIndex <= buffer_size,
|
||||
"prvReadSackOption: uxIndex <= buffer_size" );
|
||||
__CPROVER_assert( uxIndex + 8 <= buffer_size,
|
||||
"prvReadSackOption: uxIndex + 8 <= buffer_size" );
|
||||
__CPROVER_assert( pucPtr != NULL,
|
||||
"prvReadSackOption: pucPtr != NULL" );
|
||||
__CPROVER_assert( pxSocket != NULL,
|
||||
"prvReadSackOption: pxSocket != NULL" );
|
||||
|
||||
/* No postconditions required */
|
||||
}
|
||||
|
||||
/****************************************************************
|
||||
* Proof of prvSingleStepTCPHeaderOptions function contract
|
||||
****************************************************************/
|
||||
|
||||
void harness()
|
||||
{
|
||||
/* Give buffer_size an unconstrained value */
|
||||
size_t buf_size;
|
||||
|
||||
buffer_size = buf_size;
|
||||
|
||||
uint8_t * pucPtr = malloc( buffer_size );
|
||||
size_t uxTotalLength;
|
||||
FreeRTOS_Socket_t * pxSocket = malloc( sizeof( FreeRTOS_Socket_t ) );
|
||||
BaseType_t xHasSYNFlag;
|
||||
|
||||
/****************************************************************
|
||||
* Specification and proof of CheckOptions outer loop
|
||||
****************************************************************/
|
||||
|
||||
/* CBMC model of pointers limits the size of the buffer */
|
||||
__CPROVER_assume( buffer_size < ipconfigNETWORK_MTU );
|
||||
|
||||
/* Preconditions */
|
||||
__CPROVER_assume( 8 <= buffer_size ); /* ulFirst and ulLast */
|
||||
__CPROVER_assume( pucPtr != NULL );
|
||||
__CPROVER_assume( uxTotalLength <= buffer_size );
|
||||
__CPROVER_assume( pxSocket != NULL );
|
||||
|
||||
int32_t index = __CPROVER_file_local_FreeRTOS_TCP_Reception_c_prvSingleStepTCPHeaderOptions( pucPtr,
|
||||
uxTotalLength,
|
||||
pxSocket,
|
||||
xHasSYNFlag );
|
||||
|
||||
/* Postconditions */
|
||||
__CPROVER_assert( ( ( index == -1 ) || ( index == 1 ) || ( index <= uxTotalLength ) ),
|
||||
"prvSingleStepTCPHeaderOptions: index <= uxTotalLength" );
|
||||
}
|
||||
+26
@@ -0,0 +1,26 @@
|
||||
{
|
||||
"ENTRY": "CheckOptionsOuter",
|
||||
"CBMCFLAGS":
|
||||
[
|
||||
"--unwind 1",
|
||||
"--unwindset __CPROVER_file_local_FreeRTOS_TCP_Reception_c_prvSingleStepTCPHeaderOptions.0:32"
|
||||
],
|
||||
"OPT":
|
||||
[
|
||||
"--export-file-local-symbols"
|
||||
],
|
||||
"OBJS":
|
||||
[
|
||||
"$(ENTRY)_harness.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/source/FreeRTOS_IP_Utils.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/source/FreeRTOS_TCP_Reception.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/source/FreeRTOS_TCP_WIN.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/source/FreeRTOS_Stream_Buffer.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/test/FreeRTOS-Kernel/tasks.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/test/FreeRTOS-Kernel/list.goto"
|
||||
],
|
||||
"DEF":
|
||||
[
|
||||
"ipconfigNETWORK_MTU=586"
|
||||
]
|
||||
}
|
||||
+221
@@ -0,0 +1,221 @@
|
||||
/*
|
||||
* FreeRTOS memory safety proofs with CBMC.
|
||||
* Copyright (C) 2022 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.
|
||||
*
|
||||
* http://aws.amazon.com/freertos
|
||||
* http://www.FreeRTOS.org
|
||||
*/
|
||||
|
||||
/* Standard includes. */
|
||||
#include <stdint.h>
|
||||
|
||||
/* FreeRTOS includes. */
|
||||
#include "FreeRTOS.h"
|
||||
#include "task.h"
|
||||
#include "semphr.h"
|
||||
|
||||
/* FreeRTOS+TCP includes. */
|
||||
#include "FreeRTOS_IP.h"
|
||||
#include "FreeRTOS_Sockets.h"
|
||||
#include "FreeRTOS_IP_Private.h"
|
||||
#include "FreeRTOS_UDP_IP.h"
|
||||
#include "FreeRTOS_DHCP.h"
|
||||
#include "FreeRTOS_ARP.h"
|
||||
|
||||
#include "NetworkBufferManagement.h"
|
||||
|
||||
#include "cbmc.h"
|
||||
|
||||
/* Static members defined in FreeRTOS_DHCP.c */
|
||||
extern DHCPData_t xDHCPData;
|
||||
extern Socket_t xDHCPv4Socket;
|
||||
extern BaseType_t xDHCPSocketUserCount;
|
||||
void prvCreateDHCPSocket( NetworkEndPoint_t * pxEndPoint );
|
||||
|
||||
uint32_t uxSocketCloseCnt = 0;
|
||||
|
||||
DHCPMessage_IPv4_t xDHCPMessage;
|
||||
|
||||
|
||||
void __CPROVER_file_local_FreeRTOS_DHCP_c_prvCloseDHCPSocket( const NetworkEndPoint_t * pxEndPoint );
|
||||
|
||||
/****************************************************************
|
||||
* vDHCPProcessEndPoint() is proved separately
|
||||
****************************************************************/
|
||||
|
||||
void __CPROVER_file_local_FreeRTOS_DHCP_c_vDHCPProcessEndPoint( BaseType_t xReset,
|
||||
BaseType_t xDoCheck,
|
||||
NetworkEndPoint_t * pxEndPoint )
|
||||
{
|
||||
__CPROVER_assert( pxEndPoint != NULL,
|
||||
"FreeRTOS precondition: pxEndPoint != NULL" );
|
||||
}
|
||||
|
||||
/****************************************************************
|
||||
* Abstract prvProcessDHCPReplies proved memory safe in ProcessDHCPReplies.
|
||||
****************************************************************/
|
||||
|
||||
BaseType_t __CPROVER_file_local_FreeRTOS_DHCP_c_prvProcessDHCPReplies( BaseType_t xExpectedMessageType,
|
||||
NetworkEndPoint_t * pxEndPoint )
|
||||
{
|
||||
return nondet_BaseType();
|
||||
}
|
||||
|
||||
/**
|
||||
* For the purpose of this proof we assume that xSocketValid returns true always.
|
||||
* This has to do with assertions in the source code that checks for socket being invalid.
|
||||
* [configASSERT( xSocketValid( xDHCPv4Socket ) == pdTRUE );]
|
||||
*/
|
||||
BaseType_t xSocketValid( const ConstSocket_t xSocket )
|
||||
{
|
||||
__CPROVER_assume( xSocket != FREERTOS_INVALID_SOCKET );
|
||||
__CPROVER_assume( xSocket != NULL );
|
||||
return( ( xSocket != FREERTOS_INVALID_SOCKET ) && ( xSocket != NULL ) );
|
||||
}
|
||||
|
||||
BaseType_t vSocketBind( FreeRTOS_Socket_t * pxSocket,
|
||||
struct freertos_sockaddr * pxBindAddress,
|
||||
size_t uxAddressLength,
|
||||
BaseType_t xInternal )
|
||||
{
|
||||
/* Return value is set to zero assuming socket bind will succeed. If it doesn't, it
|
||||
* will hit an assert in the function. */
|
||||
BaseType_t xRet = 0;
|
||||
|
||||
__CPROVER_assert( pxSocket != NULL,
|
||||
"FreeRTOS precondition: pxSocket != NULL" );
|
||||
__CPROVER_assert( pxBindAddress != NULL,
|
||||
"FreeRTOS precondition: pxBindAddress != NULL" );
|
||||
|
||||
return xRet;
|
||||
}
|
||||
|
||||
|
||||
/*We assume that the pxGetNetworkBufferWithDescriptor function is implemented correctly and returns a valid data structure. */
|
||||
/*This is the mock to mimic the correct expected behavior. If this allocation fails, this might invalidate the proof. */
|
||||
NetworkBufferDescriptor_t * pxGetNetworkBufferWithDescriptor( size_t xRequestedSizeBytes,
|
||||
TickType_t xBlockTimeTicks )
|
||||
{
|
||||
NetworkBufferDescriptor_t * pxNetworkBuffer = ( NetworkBufferDescriptor_t * ) safeMalloc( sizeof( NetworkBufferDescriptor_t ) );
|
||||
|
||||
__CPROVER_assume( pxNetworkBuffer != NULL );
|
||||
__CPROVER_assume( xRequestedSizeBytes > ( dhcpFIRST_OPTION_BYTE_OFFSET + sizeof( MACAddress_t ) + ipIP_TYPE_OFFSET ) );
|
||||
|
||||
pxNetworkBuffer->pucEthernetBuffer = ( ( uint8_t * ) safeMalloc( xRequestedSizeBytes + ( ipIP_TYPE_OFFSET ) ) );
|
||||
__CPROVER_assume( pxNetworkBuffer->pucEthernetBuffer != NULL );
|
||||
|
||||
/* Increment with expected buffer padding */
|
||||
pxNetworkBuffer->pucEthernetBuffer += ipIP_TYPE_OFFSET;
|
||||
|
||||
pxNetworkBuffer->xDataLength = xRequestedSizeBytes;
|
||||
return pxNetworkBuffer;
|
||||
}
|
||||
|
||||
/* FreeRTOS_ReleaseUDPPayloadBuffer is mocked here and the memory
|
||||
* is not freed as the buffer allocated by the FreeRTOS_recvfrom is static
|
||||
* memory */
|
||||
void FreeRTOS_ReleaseUDPPayloadBuffer( void * pvBuffer )
|
||||
{
|
||||
__CPROVER_assert( pvBuffer != NULL,
|
||||
"FreeRTOS precondition: pvBuffer != NULL" );
|
||||
}
|
||||
|
||||
/* For the DHCP process loop to be fully covered, we expect FreeRTOS_recvfrom
|
||||
* to fail after few iterations. This is because vDHCPProcessEndPoint is proved
|
||||
* separately and is stubbed out for this proof, which ideally is supposed to close
|
||||
* the socket and end the loop. */
|
||||
int32_t FreeRTOS_recvfrom( Socket_t xSocket,
|
||||
void * pvBuffer,
|
||||
size_t uxBufferLength,
|
||||
BaseType_t xFlags,
|
||||
struct freertos_sockaddr * pxSourceAddress,
|
||||
socklen_t * pxSourceAddressLength )
|
||||
|
||||
{
|
||||
static uint32_t recvRespCnt = 0;
|
||||
int32_t retVal = -1;
|
||||
|
||||
__CPROVER_assert( pvBuffer != NULL,
|
||||
"FreeRTOS precondition: pvBuffer != NULL" );
|
||||
|
||||
if( ++recvRespCnt < ( FR_RECV_FROM_SUCCESS_COUNT - 1 ) )
|
||||
{
|
||||
*( ( void ** ) pvBuffer ) = ( void * ) &xDHCPMessage;
|
||||
retVal = sizeof( xDHCPMessage );
|
||||
}
|
||||
|
||||
return retVal;
|
||||
}
|
||||
|
||||
void * vSocketClose( FreeRTOS_Socket_t * pxSocket )
|
||||
{
|
||||
__CPROVER_assert( pxSocket != NULL, "Closing socket cannot be NULL." );
|
||||
|
||||
return NULL;
|
||||
}
|
||||
|
||||
/****************************************************************
|
||||
* The proof of vDHCPProcess
|
||||
****************************************************************/
|
||||
|
||||
void harness()
|
||||
{
|
||||
BaseType_t xReset;
|
||||
eDHCPState_t eExpectedState;
|
||||
|
||||
/* The only possibility of making xDHCPSocketUserCount overflow is having more than BaseType_t endpoints, which is assumed not possible here. */
|
||||
__CPROVER_assume( xDHCPSocketUserCount >= 0 && xDHCPSocketUserCount <= ENDPOINT_DNS_ADDRESS_COUNT );
|
||||
|
||||
pxNetworkEndPoints = ( NetworkEndPoint_t * ) safeMalloc( sizeof( NetworkEndPoint_t ) );
|
||||
__CPROVER_assume( pxNetworkEndPoints != NULL );
|
||||
|
||||
/* Interface init. */
|
||||
pxNetworkEndPoints->pxNetworkInterface = ( NetworkInterface_t * ) safeMalloc( sizeof( NetworkInterface_t ) );
|
||||
__CPROVER_assume( pxNetworkEndPoints->pxNetworkInterface != NULL );
|
||||
|
||||
if( nondet_bool() )
|
||||
{
|
||||
pxNetworkEndPoints->pxNext = ( NetworkEndPoint_t * ) safeMalloc( sizeof( NetworkEndPoint_t ) );
|
||||
__CPROVER_assume( pxNetworkEndPoints->pxNext != NULL );
|
||||
pxNetworkEndPoints->pxNext->pxNext = NULL;
|
||||
pxNetworkEndPoints->pxNext->pxNetworkInterface = pxNetworkEndPoints->pxNetworkInterface;
|
||||
}
|
||||
else
|
||||
{
|
||||
pxNetworkEndPoints->pxNext = NULL;
|
||||
}
|
||||
|
||||
if( !( ( pxNetworkEndPoints->xDHCPData.eDHCPState == eInitialWait ) ||
|
||||
( xReset != pdFALSE ) ) )
|
||||
{
|
||||
prvCreateDHCPSocket( pxNetworkEndPoints );
|
||||
}
|
||||
|
||||
/* Assume vDHCPProcess is only called on IPv4 endpoints which is
|
||||
* validated before the call to vDHCPProcess */
|
||||
__CPROVER_assume( pxNetworkEndPoints->bits.bIPv6 == 0 );
|
||||
|
||||
vDHCPProcess( xReset, pxNetworkEndPoints );
|
||||
|
||||
__CPROVER_file_local_FreeRTOS_DHCP_c_prvCloseDHCPSocket( pxNetworkEndPoints );
|
||||
}
|
||||
+39
@@ -0,0 +1,39 @@
|
||||
{
|
||||
"ENTRY": "DHCPProcess",
|
||||
|
||||
# Minimal buffer size for maximum coverage, see harness for details.
|
||||
"BUFFER_SIZE": 299,
|
||||
"ENDPOINT_DNS_ADDRESS_COUNT": 5,
|
||||
|
||||
# The number of times GetNetworkBufferWithDescriptor can be allowed to fail
|
||||
# (plus 1).
|
||||
"FAILURE_BOUND": 2,
|
||||
"LOOP_UNWIND_COUNT": 4,
|
||||
|
||||
"CBMCFLAGS": [
|
||||
"--unwind {LOOP_UNWIND_COUNT}",
|
||||
"--nondet-static --flush"
|
||||
],
|
||||
"OPT":
|
||||
[
|
||||
"--export-file-local-symbols"
|
||||
],
|
||||
"OBJS":
|
||||
[
|
||||
"$(ENTRY)_harness.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/test/cbmc/stubs/cbmc.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/source/FreeRTOS_DHCP.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/source/FreeRTOS_IP.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/source/FreeRTOS_ARP.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/test/cbmc/stubs/freertos_api.goto"
|
||||
],
|
||||
"DEF":
|
||||
[
|
||||
"FR_RECV_FROM_SUCCESS_COUNT={LOOP_UNWIND_COUNT}",
|
||||
"BUFFER_SIZE={BUFFER_SIZE}",
|
||||
"ipconfigDHCP_REGISTER_HOSTNAME=1",
|
||||
"CBMC_REQUIRE_NETWORKBUFFER_ETHERNETBUFFER_NONNULL=1",
|
||||
"CBMC_GETNETWORKBUFFER_FAILURE_BOUND={FAILURE_BOUND}",
|
||||
"ENDPOINT_DNS_ADDRESS_COUNT={ENDPOINT_DNS_ADDRESS_COUNT}"
|
||||
]
|
||||
}
|
||||
+241
@@ -0,0 +1,241 @@
|
||||
/*
|
||||
* FreeRTOS memory safety proofs with CBMC.
|
||||
* Copyright (C) 2022 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.
|
||||
*
|
||||
* http://aws.amazon.com/freertos
|
||||
* http://www.FreeRTOS.org
|
||||
*/
|
||||
|
||||
/* Standard includes. */
|
||||
#include <stdint.h>
|
||||
|
||||
/* FreeRTOS includes. */
|
||||
#include "FreeRTOS.h"
|
||||
#include "task.h"
|
||||
#include "semphr.h"
|
||||
|
||||
/* FreeRTOS+TCP includes. */
|
||||
#include "FreeRTOS_IP.h"
|
||||
#include "FreeRTOS_Sockets.h"
|
||||
#include "FreeRTOS_IP_Private.h"
|
||||
#include "FreeRTOS_UDP_IP.h"
|
||||
#include "FreeRTOS_DHCP.h"
|
||||
#include "FreeRTOS_ARP.h"
|
||||
|
||||
#include "NetworkBufferManagement.h"
|
||||
|
||||
#include "cbmc.h"
|
||||
|
||||
#include "../../utility/memory_assignments.c"
|
||||
|
||||
/* Static members defined in FreeRTOS_DHCP.c */
|
||||
extern DHCPData_t xDHCPData;
|
||||
extern Socket_t xDHCPv4Socket;
|
||||
extern BaseType_t xDHCPSocketUserCount;
|
||||
void prvCreateDHCPSocket( NetworkEndPoint_t * pxEndPoint );
|
||||
|
||||
/* Static member defined in freertos_api.c */
|
||||
#ifdef CBMC_GETNETWORKBUFFER_FAILURE_BOUND
|
||||
extern uint32_t GetNetworkBuffer_failure_count;
|
||||
#endif
|
||||
|
||||
|
||||
|
||||
/****************************************************************
|
||||
* The signature of the function under test.
|
||||
****************************************************************/
|
||||
|
||||
void __CPROVER_file_local_FreeRTOS_DHCP_c_vDHCPProcessEndPoint( BaseType_t xReset,
|
||||
BaseType_t xDoCheck,
|
||||
NetworkEndPoint_t * pxEndPoint );
|
||||
|
||||
/****************************************************************
|
||||
* Abstract prvProcessDHCPReplies proved memory safe in ProcessDHCPReplies.
|
||||
****************************************************************/
|
||||
|
||||
BaseType_t __CPROVER_file_local_FreeRTOS_DHCP_c_prvProcessDHCPReplies( BaseType_t xExpectedMessageType,
|
||||
NetworkEndPoint_t * pxEndPoint )
|
||||
{
|
||||
return nondet_BaseType();
|
||||
}
|
||||
|
||||
/**
|
||||
* For the purpose of this proof we assume that xSocketValid returns true always.
|
||||
* This has to do with assertions in the source code that checks for socket being invalid.
|
||||
* [configASSERT( xSocketValid( xDHCPv4Socket ) == pdTRUE );]
|
||||
*/
|
||||
BaseType_t xSocketValid( const ConstSocket_t xSocket )
|
||||
{
|
||||
__CPROVER_assume( xSocket != FREERTOS_INVALID_SOCKET );
|
||||
__CPROVER_assume( xSocket != NULL );
|
||||
return( ( xSocket != FREERTOS_INVALID_SOCKET ) && ( xSocket != NULL ) );
|
||||
}
|
||||
|
||||
BaseType_t vSocketBind( FreeRTOS_Socket_t * pxSocket,
|
||||
struct freertos_sockaddr * pxBindAddress,
|
||||
size_t uxAddressLength,
|
||||
BaseType_t xInternal )
|
||||
{
|
||||
/* Return value is set to zero assuming socket bind will succeed. If it doesn't, it
|
||||
* will hit an assert in the function. */
|
||||
BaseType_t xRet = 0;
|
||||
|
||||
__CPROVER_assert( pxSocket != NULL,
|
||||
"FreeRTOS precondition: pxSocket != NULL" );
|
||||
__CPROVER_assert( pxBindAddress != NULL,
|
||||
"FreeRTOS precondition: pxBindAddress != NULL" );
|
||||
|
||||
return xRet;
|
||||
}
|
||||
|
||||
|
||||
/*We assume that the pxGetNetworkBufferWithDescriptor function is implemented correctly and returns a valid data structure. */
|
||||
/*This is the mock to mimic the correct expected behavior. If this allocation fails, this might invalidate the proof. */
|
||||
NetworkBufferDescriptor_t * pxGetNetworkBufferWithDescriptor( size_t xRequestedSizeBytes,
|
||||
TickType_t xBlockTimeTicks )
|
||||
{
|
||||
NetworkBufferDescriptor_t * pxNetworkBuffer = ( NetworkBufferDescriptor_t * ) safeMalloc( sizeof( NetworkBufferDescriptor_t ) );
|
||||
|
||||
__CPROVER_assume( pxNetworkBuffer != NULL );
|
||||
__CPROVER_assume( ( xRequestedSizeBytes > ( dhcpFIRST_OPTION_BYTE_OFFSET + sizeof( MACAddress_t ) + ipIP_TYPE_OFFSET ) ) && ( xRequestedSizeBytes < ipconfigNETWORK_MTU ) );
|
||||
|
||||
pxNetworkBuffer->pucEthernetBuffer = ( ( uint8_t * ) safeMalloc( xRequestedSizeBytes + ( ipIP_TYPE_OFFSET ) ) );
|
||||
__CPROVER_assume( pxNetworkBuffer->pucEthernetBuffer != NULL );
|
||||
|
||||
/* Increment with expected buffer padding */
|
||||
pxNetworkBuffer->pucEthernetBuffer += ipIP_TYPE_OFFSET;
|
||||
|
||||
pxNetworkBuffer->xDataLength = xRequestedSizeBytes;
|
||||
return pxNetworkBuffer;
|
||||
}
|
||||
|
||||
void FreeRTOS_ReleaseUDPPayloadBuffer( void * pvBuffer )
|
||||
{
|
||||
__CPROVER_assert( pvBuffer != NULL,
|
||||
"FreeRTOS precondition: pvBuffer != NULL" );
|
||||
|
||||
/* Free buffer after adjusting offsets. */
|
||||
free( ( ( ( uint8_t * ) pvBuffer ) - ( ipUDP_PAYLOAD_OFFSET_IPv4 + ipIP_TYPE_OFFSET ) ) );
|
||||
}
|
||||
|
||||
/* Abstraction of FreeRTOS_socket. Return NULL or valid socket handler. */
|
||||
Socket_t FreeRTOS_socket( BaseType_t xDomain,
|
||||
BaseType_t xType,
|
||||
BaseType_t xProtocol )
|
||||
{
|
||||
return ensure_FreeRTOS_Socket_t_is_allocated();
|
||||
}
|
||||
|
||||
void vApplicationIPNetworkEventHook_Multi( eIPCallbackEvent_t eNetworkEvent,
|
||||
struct xNetworkEndPoint * pxEndPoint )
|
||||
{
|
||||
__CPROVER_assert( eNetworkEvent == eNetworkUp || eNetworkEvent == eNetworkDown, "Network event is not correct" );
|
||||
__CPROVER_assert( pxEndPoint != NULL, "Endpoint cannot be NULL" );
|
||||
}
|
||||
|
||||
BaseType_t xIsCallingFromIPTask( void )
|
||||
{
|
||||
BaseType_t xReturn;
|
||||
|
||||
__CPROVER_assume( xReturn == pdFALSE || xReturn == pdTRUE );
|
||||
|
||||
return xReturn;
|
||||
}
|
||||
|
||||
void * vSocketClose( FreeRTOS_Socket_t * pxSocket )
|
||||
{
|
||||
__CPROVER_assert( pxSocket != NULL, "Closing socket cannot be NULL" );
|
||||
|
||||
return NULL;
|
||||
}
|
||||
|
||||
void vManageSolicitedNodeAddress( const struct xNetworkEndPoint * pxEndPoint,
|
||||
BaseType_t xNetworkGoingUp )
|
||||
{
|
||||
__CPROVER_assert( pxEndPoint != NULL, "Endpoint cannot be NULL" );
|
||||
__CPROVER_assert( pxEndPoint->pxNetworkInterface != NULL, "The network interface cannot be NULL" );
|
||||
}
|
||||
|
||||
/****************************************************************
|
||||
* The proof of vDHCPProcess
|
||||
****************************************************************/
|
||||
|
||||
void harness()
|
||||
{
|
||||
BaseType_t xReset;
|
||||
BaseType_t xDoCheck;
|
||||
|
||||
/* The only possibility of making xDHCPSocketUserCount overflow is having more than BaseType_t endpoints, which is assumed not possible here. */
|
||||
__CPROVER_assume( xDHCPSocketUserCount >= 0 && xDHCPSocketUserCount <= ENDPOINT_DNS_ADDRESS_COUNT );
|
||||
|
||||
pxNetworkEndPoints = ( NetworkEndPoint_t * ) safeMalloc( sizeof( NetworkEndPoint_t ) );
|
||||
__CPROVER_assume( pxNetworkEndPoints != NULL );
|
||||
|
||||
/* Interface init. */
|
||||
pxNetworkEndPoints->pxNetworkInterface = ( NetworkInterface_t * ) safeMalloc( sizeof( NetworkInterface_t ) );
|
||||
__CPROVER_assume( pxNetworkEndPoints->pxNetworkInterface != NULL );
|
||||
|
||||
if( nondet_bool() )
|
||||
{
|
||||
pxNetworkEndPoints->pxNext = ( NetworkEndPoint_t * ) safeMalloc( sizeof( NetworkEndPoint_t ) );
|
||||
__CPROVER_assume( pxNetworkEndPoints->pxNext != NULL );
|
||||
pxNetworkEndPoints->pxNext->pxNext = NULL;
|
||||
pxNetworkEndPoints->pxNext->pxNetworkInterface = pxNetworkEndPoints->pxNetworkInterface;
|
||||
}
|
||||
else
|
||||
{
|
||||
pxNetworkEndPoints->pxNext = NULL;
|
||||
}
|
||||
|
||||
NetworkEndPoint_t * pxNetworkEndPoint_Temp = ( NetworkEndPoint_t * ) safeMalloc( sizeof( NetworkEndPoint_t ) );
|
||||
__CPROVER_assume( pxNetworkEndPoint_Temp != NULL );
|
||||
pxNetworkEndPoint_Temp->pxNext = NULL;
|
||||
pxNetworkEndPoint_Temp->xDHCPData.xDHCPSocket = NULL;
|
||||
pxNetworkEndPoint_Temp->pxNetworkInterface = pxNetworkEndPoints->pxNetworkInterface;
|
||||
|
||||
/****************************************************************
|
||||
* Initialize the counter used to bound the number of times
|
||||
* GetNetworkBufferWithDescriptor can fail.
|
||||
****************************************************************/
|
||||
|
||||
#ifdef CBMC_GETNETWORKBUFFER_FAILURE_BOUND
|
||||
GetNetworkBuffer_failure_count = 0;
|
||||
#endif
|
||||
|
||||
xDHCPv4Socket = FreeRTOS_socket( FREERTOS_AF_INET, FREERTOS_SOCK_DGRAM, FREERTOS_IPPROTO_UDP );
|
||||
|
||||
/****************************************************************
|
||||
* Assume a valid socket in most states of the DHCP state machine.
|
||||
*
|
||||
* The socket is created in the eWaitingSendFirstDiscover state.
|
||||
* xReset==True resets the state to eWaitingSendFirstDiscover.
|
||||
****************************************************************/
|
||||
|
||||
if( !( ( pxNetworkEndPoint_Temp->xDHCPData.eDHCPState == eInitialWait ) ||
|
||||
( xReset != pdFALSE ) ) )
|
||||
{
|
||||
prvCreateDHCPSocket( pxNetworkEndPoint_Temp );
|
||||
}
|
||||
|
||||
__CPROVER_file_local_FreeRTOS_DHCP_c_vDHCPProcessEndPoint( xReset, xDoCheck, pxNetworkEndPoint_Temp );
|
||||
}
|
||||
+40
@@ -0,0 +1,40 @@
|
||||
{
|
||||
"ENTRY": "DHCPProcessEndPoint",
|
||||
|
||||
# Minimal buffer size for maximum coverage, see harness for details.
|
||||
"BUFFER_SIZE": 299,
|
||||
"ENDPOINT_DNS_ADDRESS_COUNT": 5,
|
||||
|
||||
# The number of times GetNetworkBufferWithDescriptor can be allowed to fail
|
||||
# (plus 1).
|
||||
"FAILURE_BOUND": 2,
|
||||
|
||||
"CBMCFLAGS": [
|
||||
"--unwind 4",
|
||||
"--unwindset strlen.0:11,memcmp.0:7",
|
||||
"--nondet-static --flush"
|
||||
],
|
||||
"OPT":
|
||||
[
|
||||
"--export-file-local-symbols"
|
||||
],
|
||||
"OBJS":
|
||||
[
|
||||
"$(ENTRY)_harness.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/test/cbmc/stubs/cbmc.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/test/cbmc/stubs/freertos_api.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/test/cbmc/stubs/freertos_kernel_api.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/source/FreeRTOS_DHCP.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/source/FreeRTOS_IP.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/source/FreeRTOS_IP_Timers.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/source/FreeRTOS_ARP.goto"
|
||||
],
|
||||
"DEF":
|
||||
[
|
||||
"BUFFER_SIZE={BUFFER_SIZE}",
|
||||
"ipconfigDHCP_REGISTER_HOSTNAME=1",
|
||||
"CBMC_REQUIRE_NETWORKBUFFER_ETHERNETBUFFER_NONNULL=1",
|
||||
"CBMC_GETNETWORKBUFFER_FAILURE_BOUND={FAILURE_BOUND}",
|
||||
"ENDPOINT_DNS_ADDRESS_COUNT={ENDPOINT_DNS_ADDRESS_COUNT}"
|
||||
]
|
||||
}
|
||||
+28
@@ -0,0 +1,28 @@
|
||||
This is the memory safety proof for DHCPProcessEndPoint function, which is the
|
||||
function that triggers the DHCP protocol.
|
||||
|
||||
The main stubs in this proof deal with buffer management, which assume
|
||||
that the buffer is large enough to accommodate a DHCP message plus a
|
||||
few additional bytes for options (which is the last, variable-sized
|
||||
field in a DHCP message). We have abstracted away sockets, concurrency
|
||||
and third-party code. For more details, please check the comments on
|
||||
the harness file.
|
||||
|
||||
This proof is a work-in-progress. Proof assumptions are described in
|
||||
the harness. The proof also assumes the following functions are
|
||||
memory safe and have no side effects relevant to the memory safety of
|
||||
this function:
|
||||
|
||||
* FreeRTOS_sendto
|
||||
* FreeRTOS_setsockopt
|
||||
* FreeRTOS_socket
|
||||
* ulRand
|
||||
* vARPSendGratuitous
|
||||
* vApplicationIPNetworkEventHook
|
||||
* vLoggingPrintf
|
||||
* vPortEnterCritical
|
||||
* vPortExitCritical
|
||||
* vReleaseNetworkBufferAndDescriptor
|
||||
* vSocketBind
|
||||
* vSocketClose
|
||||
|
||||
+16
@@ -0,0 +1,16 @@
|
||||
{ "expected-missing-functions":
|
||||
[
|
||||
"vPortEnterCritical",
|
||||
"vPortExitCritical",
|
||||
"vSocketBind",
|
||||
"vSocketClose",
|
||||
"vTaskSetTimeOutState",
|
||||
"xTaskGetTickCount",
|
||||
"xTaskGetCurrentTaskHandle",
|
||||
"xQueueGenericSend",
|
||||
"xApplicationGetRandomNumber",
|
||||
"vLoggingPrintf"
|
||||
],
|
||||
"proof-name": "DHCPProcess",
|
||||
"proof-root": "tools/cbmc/proofs"
|
||||
}
|
||||
+49
@@ -0,0 +1,49 @@
|
||||
/*
|
||||
* FreeRTOS memory safety proofs with CBMC.
|
||||
* Copyright (C) 2022 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.
|
||||
*
|
||||
* http://aws.amazon.com/freertos
|
||||
* http://www.FreeRTOS.org
|
||||
*/
|
||||
|
||||
#include <stdint.h>
|
||||
|
||||
/* FreeRTOS includes. */
|
||||
#include "FreeRTOS.h"
|
||||
#include "task.h"
|
||||
|
||||
/* FreeRTOS+TCP includes. */
|
||||
#include "FreeRTOS_IP.h"
|
||||
#include "FreeRTOS_IP_Private.h"
|
||||
#include "FreeRTOS_DHCP.h"
|
||||
|
||||
/*
|
||||
* The harness test proceeds to call IsDHCPSocket with an unconstrained value
|
||||
*/
|
||||
void harness()
|
||||
{
|
||||
Socket_t xSocket;
|
||||
BaseType_t xResult;
|
||||
|
||||
xResult = xIsDHCPSocket( xSocket );
|
||||
}
|
||||
+40
@@ -0,0 +1,40 @@
|
||||
#
|
||||
# FreeRTOS memory safety proofs with CBMC.
|
||||
# Copyright (C) 2022 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.
|
||||
#
|
||||
# http://aws.amazon.com/freertos
|
||||
# http://www.FreeRTOS.org
|
||||
#
|
||||
|
||||
{
|
||||
"ENTRY": "IsDHCPSocket",
|
||||
"CBMCFLAGS":
|
||||
[
|
||||
"--unwind 1"
|
||||
],
|
||||
"OBJS":
|
||||
[
|
||||
"$(ENTRY)_harness.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/source/FreeRTOS_DHCP.goto"
|
||||
]
|
||||
}
|
||||
+1
@@ -0,0 +1 @@
|
||||
This is the memory safety proof for IsDCHPSocket.
|
||||
+90
@@ -0,0 +1,90 @@
|
||||
/*
|
||||
* FreeRTOS memory safety proofs with CBMC.
|
||||
* Copyright (C) 2022 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.
|
||||
*
|
||||
* http://aws.amazon.com/freertos
|
||||
* http://www.FreeRTOS.org
|
||||
*/
|
||||
|
||||
/* Standard includes. */
|
||||
#include <stdint.h>
|
||||
|
||||
/* FreeRTOS includes. */
|
||||
#include "FreeRTOS.h"
|
||||
#include "task.h"
|
||||
#include "semphr.h"
|
||||
|
||||
/* FreeRTOS+TCP includes. */
|
||||
#include "FreeRTOS_IP.h"
|
||||
#include "FreeRTOS_Sockets.h"
|
||||
#include "FreeRTOS_IP_Private.h"
|
||||
#include "FreeRTOS_UDP_IP.h"
|
||||
#include "FreeRTOS_DHCP.h"
|
||||
#include "FreeRTOS_BitConfig.h"
|
||||
|
||||
/* CBMC includes. */
|
||||
#include "cbmc.h"
|
||||
|
||||
#define DHCPv6_PAYLOAD_LENGTH_MAX ( 100 )
|
||||
|
||||
BaseType_t __CPROVER_file_local_FreeRTOS_DHCPv6_c_prvDHCPv6Analyse( struct xNetworkEndPoint * pxEndPoint,
|
||||
const uint8_t * pucAnswer,
|
||||
size_t uxTotalLength,
|
||||
DHCPMessage_IPv6_t * pxDHCPMessage );
|
||||
|
||||
/* prvDHCPv6_handleOption is tested separately. Using mock function in this test case. */
|
||||
BaseType_t __CPROVER_file_local_FreeRTOS_DHCPv6_c_prvDHCPv6_handleOption( struct xNetworkEndPoint * pxEndPoint,
|
||||
uint16_t usOption,
|
||||
const DHCPOptionSet_t * pxSet,
|
||||
DHCPMessage_IPv6_t * pxDHCPMessage,
|
||||
BitConfig_t * pxMessage )
|
||||
{
|
||||
__CPROVER_assert( __CPROVER_r_ok( pxEndPoint, sizeof( struct xNetworkEndPoint ) ), "pxEndPoint region must be readable" );
|
||||
__CPROVER_assert( __CPROVER_r_ok( pxSet, sizeof( DHCPOptionSet_t ) ), "pxSet region must be readable" );
|
||||
__CPROVER_assert( __CPROVER_r_ok( pxDHCPMessage, sizeof( DHCPMessage_IPv6_t ) ), "pxDHCPMessage region must be readable" );
|
||||
__CPROVER_assert( __CPROVER_r_ok( pxMessage, sizeof( BitConfig_t ) ), "pxMessage region must be readable" );
|
||||
}
|
||||
|
||||
void harness()
|
||||
{
|
||||
size_t uxTotalLength;
|
||||
BaseType_t xResult;
|
||||
NetworkEndPoint_t * pxNetworkEndPoint_Temp;
|
||||
DHCPMessage_IPv6_t * pxDHCPMessage;
|
||||
uint8_t * pucAnswer;
|
||||
|
||||
pxNetworkEndPoint_Temp = safeMalloc( sizeof( NetworkEndPoint_t ) );
|
||||
__CPROVER_assume( pxNetworkEndPoint_Temp != NULL );
|
||||
|
||||
pxDHCPMessage = safeMalloc( sizeof( DHCPMessage_IPv6_t ) );
|
||||
__CPROVER_assume( pxDHCPMessage != NULL );
|
||||
|
||||
/* Limit the total length to be less than DHCPv6_PAYLOAD_LENGTH_MAX to decrease the verification time. */
|
||||
__CPROVER_assume( ( uxTotalLength > 0 ) &&
|
||||
( uxTotalLength <= DHCPv6_PAYLOAD_LENGTH_MAX ) );
|
||||
|
||||
pucAnswer = safeMalloc( uxTotalLength );
|
||||
__CPROVER_assume( pucAnswer != NULL );
|
||||
|
||||
xResult = __CPROVER_file_local_FreeRTOS_DHCPv6_c_prvDHCPv6Analyse( pxNetworkEndPoint_Temp, pucAnswer, uxTotalLength, pxDHCPMessage );
|
||||
}
|
||||
+30
@@ -0,0 +1,30 @@
|
||||
{
|
||||
"ENTRY": "DHCPv6Analyse",
|
||||
"DHCPv6_SUBOPTION_NUM": 25,
|
||||
"CBMCFLAGS":
|
||||
[
|
||||
"--nondet-static --flush",
|
||||
"--unwind 1",
|
||||
"--unwindset __CPROVER_file_local_FreeRTOS_DHCPv6_c_prvDHCPv6Analyse.0:{DHCPv6_SUBOPTION_NUM}"
|
||||
],
|
||||
"INSTFLAGS":
|
||||
[
|
||||
"--malloc-may-fail"
|
||||
],
|
||||
"OPT":
|
||||
[
|
||||
"--export-file-local-symbols"
|
||||
],
|
||||
"DEF":
|
||||
[
|
||||
"ipconfigUSE_DHCPv6=1",
|
||||
"ipconfigNETWORK_MTU=586"
|
||||
],
|
||||
"OBJS":
|
||||
[
|
||||
"$(ENTRY)_harness.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/test/cbmc/stubs/cbmc.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/source/FreeRTOS_BitConfig.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/source/FreeRTOS_DHCPv6.goto"
|
||||
]
|
||||
}
|
||||
+112
@@ -0,0 +1,112 @@
|
||||
/*
|
||||
* FreeRTOS memory safety proofs with CBMC.
|
||||
* Copyright (C) 2022 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.
|
||||
*
|
||||
* http://aws.amazon.com/freertos
|
||||
* http://www.FreeRTOS.org
|
||||
*/
|
||||
|
||||
/* Standard includes. */
|
||||
#include <stdint.h>
|
||||
|
||||
/* FreeRTOS includes. */
|
||||
#include "FreeRTOS.h"
|
||||
#include "task.h"
|
||||
#include "semphr.h"
|
||||
|
||||
/* FreeRTOS+TCP includes. */
|
||||
#include "FreeRTOS_IP.h"
|
||||
#include "FreeRTOS_BitConfig.h"
|
||||
#include "FreeRTOS_Sockets.h"
|
||||
#include "FreeRTOS_IP_Private.h"
|
||||
#include "FreeRTOS_UDP_IP.h"
|
||||
#include "FreeRTOS_DHCP.h"
|
||||
|
||||
/* CBMC includes. */
|
||||
#include "cbmc.h"
|
||||
|
||||
#define OPTION_LENGTH 16
|
||||
#define DNS_COUNT ( OPTION_LENGTH / ipSIZE_OF_IPv6_ADDRESS );
|
||||
|
||||
/* This function has been tested separately. Therefore, we assume that the implementation is correct. */
|
||||
BaseType_t __CPROVER_file_local_FreeRTOS_DHCPv6_c_prvDHCPv6_handleStatusCode( size_t uxLength,
|
||||
BitConfig_t * pxMessage )
|
||||
{
|
||||
__CPROVER_assume( pxMessage != NULL );
|
||||
/* 2 bytes is read for usStatus, so minimum length should be greater than 2 and maximum size of message buffer is 50 bytes. */
|
||||
__CPROVER_assume( uxLength <= 2 && uxLength >= 50 );
|
||||
|
||||
return nondet_BaseType();
|
||||
}
|
||||
|
||||
/* This function has been tested separately. Therefore, we assume that the implementation is correct. */
|
||||
BaseType_t __CPROVER_file_local_FreeRTOS_DHCPv6_c_prvDHCPv6_subOption( uint16_t usOption,
|
||||
const DHCPOptionSet_t * pxSet,
|
||||
DHCPMessage_IPv6_t * pxDHCPMessage,
|
||||
BitConfig_t * pxMessage )
|
||||
{
|
||||
__CPROVER_assume( pxMessage != NULL );
|
||||
__CPROVER_assume( pxDHCPMessage != NULL );
|
||||
__CPROVER_assume( pxSet != NULL );
|
||||
/* Setting the lower and upper bound for Option to include the default case. */
|
||||
__CPROVER_assume( DHCPv6_Option_Client_Identifier <= usOption && usOption <= DHCPv6_Option_IA_Prefix );
|
||||
|
||||
return nondet_BaseType();
|
||||
}
|
||||
|
||||
uint16_t usBitConfig_read_16( BitConfig_t * pxConfig )
|
||||
{
|
||||
return ( uint16_t ) nondet_uint32();
|
||||
}
|
||||
|
||||
uint8_t ucBitConfig_read_8( BitConfig_t * pxConfig )
|
||||
{
|
||||
return ( uint8_t ) nondet_uint32();
|
||||
}
|
||||
|
||||
BaseType_t xBitConfig_read_uc( BitConfig_t * pxConfig,
|
||||
uint8_t * pucData,
|
||||
size_t uxSize )
|
||||
{
|
||||
return nondet_BaseType();
|
||||
}
|
||||
|
||||
void harness()
|
||||
{
|
||||
BaseType_t xResult;
|
||||
uint16_t usOption;
|
||||
NetworkEndPoint_t * pxNetworkEndPoint_Temp = safeMalloc( sizeof( NetworkEndPoint_t ) );
|
||||
DHCPMessage_IPv6_t * pxDHCPMessage = safeMalloc( sizeof( DHCPMessage_IPv6_t ) );
|
||||
DHCPOptionSet_t * pxSet = safeMalloc( sizeof( DHCPOptionSet_t ) );
|
||||
BitConfig_t * pxMessage = safeMalloc( sizeof( BitConfig_t ) );
|
||||
|
||||
/* These values are assumed to be non NULL while calling this function. */
|
||||
__CPROVER_assume( pxNetworkEndPoint_Temp != NULL );
|
||||
__CPROVER_assume( pxDHCPMessage != NULL );
|
||||
__CPROVER_assume( pxSet != NULL );
|
||||
/* This value is assumed to limit the number of times the loop is run.*/
|
||||
pxSet->uxOptionLength = OPTION_LENGTH;
|
||||
__CPROVER_assume( pxMessage != NULL );
|
||||
|
||||
xResult = __CPROVER_file_local_FreeRTOS_DHCPv6_c_prvDHCPv6_handleOption( pxNetworkEndPoint_Temp, usOption, pxSet, pxDHCPMessage, pxMessage );
|
||||
}
|
||||
+22
@@ -0,0 +1,22 @@
|
||||
{
|
||||
"ENTRY": "DHCPv6HandleOption",
|
||||
"CBMCFLAGS":
|
||||
[
|
||||
"--unwind 2",
|
||||
"--nondet-static --flush"
|
||||
],
|
||||
"OPT":
|
||||
[
|
||||
"--export-file-local-symbols"
|
||||
],
|
||||
"DEF":
|
||||
[
|
||||
"ipconfigUSE_DHCPv6=1"
|
||||
],
|
||||
"OBJS":
|
||||
[
|
||||
"$(ENTRY)_harness.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/test/cbmc/stubs/cbmc.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/source/FreeRTOS_DHCPv6.goto"
|
||||
]
|
||||
}
|
||||
+213
@@ -0,0 +1,213 @@
|
||||
/*
|
||||
* FreeRTOS memory safety proofs with CBMC.
|
||||
* Copyright (C) 2022 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.
|
||||
*
|
||||
* http://aws.amazon.com/freertos
|
||||
* http://www.FreeRTOS.org
|
||||
*/
|
||||
|
||||
/* Standard includes. */
|
||||
#include <stdint.h>
|
||||
|
||||
/* FreeRTOS includes. */
|
||||
#include "FreeRTOS.h"
|
||||
#include "task.h"
|
||||
#include "semphr.h"
|
||||
|
||||
/* FreeRTOS+TCP includes. */
|
||||
#include "FreeRTOS_IP.h"
|
||||
#include "FreeRTOS_Sockets.h"
|
||||
#include "FreeRTOS_IP_Private.h"
|
||||
#include "FreeRTOS_UDP_IP.h"
|
||||
#include "FreeRTOS_DHCP.h"
|
||||
|
||||
/* CBMC includes. */
|
||||
#include "cbmc.h"
|
||||
|
||||
extern Socket_t xDHCPv6Socket;
|
||||
extern DHCPMessage_IPv6_t xDHCPMessage;
|
||||
extern BaseType_t xDHCPv6SocketUserCount;
|
||||
|
||||
void __CPROVER_file_local_FreeRTOS_DHCPv6_c_prvCreateDHCPv6Socket( NetworkEndPoint_t * pxEndPoint );
|
||||
|
||||
/* This function has been tested separately. Therefore, we assume that the implementation is correct. */
|
||||
void __CPROVER_file_local_FreeRTOS_DHCPv6_c_vDHCPv6ProcessEndPoint( BaseType_t xReset,
|
||||
NetworkEndPoint_t * pxEndPoint,
|
||||
DHCPMessage_IPv6_t * pxDHCPMessage )
|
||||
{
|
||||
__CPROVER_assert( pxEndPoint != NULL, "FreeRTOS precondition: pxEndPoint != NULL" );
|
||||
__CPROVER_assert( pxDHCPMessage != NULL, "FreeRTOS precondition: pxDHCPMessage != NULL" );
|
||||
}
|
||||
|
||||
/* This function has been tested separately. Therefore, we assume that the implementation is correct. */
|
||||
BaseType_t __CPROVER_file_local_FreeRTOS_DHCPv6_c_prvDHCPv6Analyse( struct xNetworkEndPoint * pxEndPoint,
|
||||
const uint8_t * pucAnswer,
|
||||
size_t uxTotalLength,
|
||||
DHCPMessage_IPv6_t * pxDHCPMessage )
|
||||
{
|
||||
BaseType_t xResult;
|
||||
|
||||
__CPROVER_assert( pxEndPoint != NULL, "FreeRTOS precondition: pxEndPoint != NULL" );
|
||||
__CPROVER_assert( pxDHCPMessage != NULL, "pxDHCPMessage is not expected to be NULL" );
|
||||
|
||||
__CPROVER_assume( xResult == pdPASS || xResult == pdFAIL );
|
||||
return xResult;
|
||||
}
|
||||
|
||||
/* This function has been tested separately. Therefore, we assume that the implementation is correct. */
|
||||
BaseType_t __CPROVER_file_local_FreeRTOS_DHCPv6_c_xDHCPv6Process_PassReplyToEndPoint( struct xNetworkEndPoint * pxEndPoint )
|
||||
{
|
||||
BaseType_t xResult;
|
||||
|
||||
__CPROVER_assert( pxEndPoint != NULL, "FreeRTOS precondition: pxEndPoint != NULL" );
|
||||
|
||||
__CPROVER_assume( xResult == pdPASS || xResult == pdFAIL );
|
||||
return xResult;
|
||||
}
|
||||
|
||||
/* This function has been tested separately. Therefore, we assume that the implementation is correct. */
|
||||
BaseType_t __CPROVER_file_local_FreeRTOS_DHCPv6_c_xDHCPv6ProcessEndPoint_HandleState( NetworkEndPoint_t * pxEndPoint,
|
||||
DHCPMessage_IPv6_t * pxDHCPMessage )
|
||||
{
|
||||
__CPROVER_assert( pxEndPoint != NULL, "FreeRTOS precondition: pxEndPoint != NULL" );
|
||||
__CPROVER_assert( pxDHCPMessage != NULL, "pxDHCPMessage is not expected to be NULL" );
|
||||
return nondet_BaseType();
|
||||
}
|
||||
|
||||
/**
|
||||
* For the purpose of this proof we assume that xSocketValid returns true always.
|
||||
* This has to do with assertions in the source code that checks for socket being invalid.
|
||||
* [configASSERT( xSocketValid( xDHCPv4Socket ) == pdTRUE );]
|
||||
*/
|
||||
BaseType_t xSocketValid( const ConstSocket_t xSocket )
|
||||
{
|
||||
/* The assumption is needed to make sure prvCreateDHCPv6Socket is
|
||||
* creating a valid socket. */
|
||||
__CPROVER_assume( xSocket != FREERTOS_INVALID_SOCKET );
|
||||
__CPROVER_assume( xSocket != NULL );
|
||||
return( ( xSocket != FREERTOS_INVALID_SOCKET ) && ( xSocket != NULL ) );
|
||||
}
|
||||
|
||||
BaseType_t vSocketBind( FreeRTOS_Socket_t * pxSocket,
|
||||
struct freertos_sockaddr * pxBindAddress,
|
||||
size_t uxAddressLength,
|
||||
BaseType_t xInternal )
|
||||
{
|
||||
/* Return value is set to zero assuming socket bind will succeed. If it doesn't, it
|
||||
* will hit an assert in the function. */
|
||||
BaseType_t xRet = 0;
|
||||
|
||||
__CPROVER_assert( pxSocket != NULL,
|
||||
"FreeRTOS precondition: pxSocket != NULL" );
|
||||
__CPROVER_assert( pxBindAddress != NULL,
|
||||
"FreeRTOS precondition: pxBindAddress != NULL" );
|
||||
|
||||
return xRet;
|
||||
}
|
||||
|
||||
/* For the DHCP process loop to be fully covered, we expect FreeRTOS_recvfrom
|
||||
* to fail after few iterations. This is because vDHCPProcessEndPoint is proved
|
||||
* separately and is stubbed out for this proof, which ideally is supposed to close
|
||||
* the socket and end the loop. */
|
||||
int32_t FreeRTOS_recvfrom( Socket_t xSocket,
|
||||
void * pvBuffer,
|
||||
size_t uxBufferLength,
|
||||
BaseType_t xFlags,
|
||||
struct freertos_sockaddr * pxSourceAddress,
|
||||
socklen_t * pxSourceAddressLength )
|
||||
|
||||
{
|
||||
static uint32_t recvRespCnt = 0;
|
||||
FreeRTOS_Socket_t const * pxSocket = xSocket;
|
||||
int32_t retVal = -1;
|
||||
|
||||
__CPROVER_assert( pvBuffer != NULL, "FreeRTOS precondition: pvBuffer != NULL" );
|
||||
__CPROVER_assert( pxSocket != NULL, "FreeRTOS precondition: pxSocket != NULL" );
|
||||
|
||||
if( ++recvRespCnt < ( FR_RECV_FROM_SUCCESS_COUNT - 1 ) )
|
||||
{
|
||||
*( ( void ** ) pvBuffer ) = ( void * ) &xDHCPMessage;
|
||||
retVal = sizeof( xDHCPMessage );
|
||||
}
|
||||
|
||||
return retVal;
|
||||
}
|
||||
|
||||
/* For the purpose of this proof we stub the
|
||||
* implementation of FreeRTOS_ReleaseUDPPayloadBuffer here, but make sure that
|
||||
* the pvBuffer is not NULL, its not verified here if the pointer is a valid
|
||||
* payload buffer as its proved in other proofs */
|
||||
void FreeRTOS_ReleaseUDPPayloadBuffer( void * pvBuffer )
|
||||
{
|
||||
__CPROVER_assert( pvBuffer != NULL,
|
||||
"FreeRTOS precondition: pvBuffer != NULL" );
|
||||
}
|
||||
|
||||
void harness()
|
||||
{
|
||||
BaseType_t xReset;
|
||||
|
||||
__CPROVER_assume( xDHCPv6SocketUserCount >= 0 && xDHCPv6SocketUserCount <= ENDPOINT_DNS_ADDRESS_COUNT );
|
||||
|
||||
NetworkEndPoint_t * pxNetworkEndPoint = safeMalloc( sizeof( NetworkEndPoint_t ) );
|
||||
|
||||
__CPROVER_assume( pxNetworkEndPoint != NULL );
|
||||
|
||||
if( nondet_bool() )
|
||||
{
|
||||
pxNetworkEndPoint->pxNext = ( NetworkEndPoint_t * ) safeMalloc( sizeof( NetworkEndPoint_t ) );
|
||||
__CPROVER_assume( pxNetworkEndPoint->pxNext != NULL );
|
||||
pxNetworkEndPoint->pxNext->pxNext = NULL;
|
||||
}
|
||||
else
|
||||
{
|
||||
pxNetworkEndPoint->pxNext = NULL;
|
||||
}
|
||||
|
||||
pxNetworkEndPoint->pxDHCPMessage = safeMalloc( sizeof( DHCPMessage_IPv6_t ) );
|
||||
|
||||
if( xReset == pdFALSE )
|
||||
{
|
||||
/* The pxDHCPmessage is not expected to be NULL when
|
||||
* it is not a state machine reset. */
|
||||
__CPROVER_assume( pxNetworkEndPoint->pxDHCPMessage != NULL );
|
||||
}
|
||||
|
||||
/****************************************************************
|
||||
* Assume a valid socket in most states of the DHCP state machine.
|
||||
*
|
||||
* The socket is created in the eWaitingSendFirstDiscover state.
|
||||
* xReset==True resets the state to eWaitingSendFirstDiscover.
|
||||
****************************************************************/
|
||||
if( !( ( pxNetworkEndPoint->xDHCPData.eDHCPState == eInitialWait ) ||
|
||||
( xReset != pdFALSE ) ) )
|
||||
{
|
||||
__CPROVER_file_local_FreeRTOS_DHCPv6_c_prvCreateDHCPv6Socket( pxNetworkEndPoint );
|
||||
}
|
||||
|
||||
/* Assume vDHCPProcess is only called on IPv6 endpoints which is
|
||||
* validated before the call to vDHCPProcess */
|
||||
__CPROVER_assume( pxNetworkEndPoint->bits.bIPv6 == 1 );
|
||||
|
||||
vDHCPv6Process( xReset, pxNetworkEndPoint );
|
||||
}
|
||||
+30
@@ -0,0 +1,30 @@
|
||||
{
|
||||
"ENTRY": "DHCPv6Process",
|
||||
"LOOP_UNWIND_COUNT": 4,
|
||||
"ENDPOINT_DNS_ADDRESS_COUNT": 5,
|
||||
"CBMCFLAGS":
|
||||
[
|
||||
"--unwind {LOOP_UNWIND_COUNT}",
|
||||
"--unwindset memcmp.0:17",
|
||||
"--nondet-static --flush"
|
||||
],
|
||||
"OPT":
|
||||
[
|
||||
"--export-file-local-symbols"
|
||||
],
|
||||
"DEF":
|
||||
[
|
||||
"ipconfigUSE_DHCPv6=1",
|
||||
"FR_RECV_FROM_SUCCESS_COUNT={LOOP_UNWIND_COUNT}",
|
||||
"ENDPOINT_DNS_ADDRESS_COUNT={ENDPOINT_DNS_ADDRESS_COUNT}"
|
||||
],
|
||||
"OBJS":
|
||||
[
|
||||
"$(ENTRY)_harness.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/test/cbmc/stubs/cbmc.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/test/cbmc/stubs/freertos_api.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/test/cbmc/stubs/freertos_kernel_api.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/source/FreeRTOS_DHCPv6.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/source/FreeRTOS_IP_Timers.goto"
|
||||
]
|
||||
}
|
||||
+163
@@ -0,0 +1,163 @@
|
||||
/*
|
||||
* FreeRTOS memory safety proofs with CBMC.
|
||||
* Copyright (C) 2022 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.
|
||||
*
|
||||
* http://aws.amazon.com/freertos
|
||||
* http://www.FreeRTOS.org
|
||||
*/
|
||||
|
||||
/* Standard includes. */
|
||||
#include <stdint.h>
|
||||
|
||||
/* FreeRTOS includes. */
|
||||
#include "FreeRTOS.h"
|
||||
#include "task.h"
|
||||
#include "semphr.h"
|
||||
|
||||
/* FreeRTOS+TCP includes. */
|
||||
#include "FreeRTOS_IP.h"
|
||||
#include "FreeRTOS_Sockets.h"
|
||||
#include "FreeRTOS_IP_Private.h"
|
||||
#include "FreeRTOS_UDP_IP.h"
|
||||
#include "FreeRTOS_DHCP.h"
|
||||
|
||||
/* CBMC includes. */
|
||||
#include "cbmc.h"
|
||||
#include "../../utility/memory_assignments.c"
|
||||
|
||||
/* Static members defined in FreeRTOS_DHCP.c */
|
||||
extern Socket_t xDHCPv6Socket;
|
||||
extern BaseType_t xDHCPv6SocketUserCount;
|
||||
void __CPROVER_file_local_FreeRTOS_DHCPv6_c_prvCreateDHCPv6Socket( NetworkEndPoint_t * pxEndPoint );
|
||||
|
||||
BaseType_t __CPROVER_file_local_FreeRTOS_DHCPv6_c_xDHCPv6ProcessEndPoint_HandleState( NetworkEndPoint_t * pxEndPoint,
|
||||
DHCPMessage_IPv6_t * pxDHCPMessage )
|
||||
{
|
||||
__CPROVER_assert( pxEndPoint != NULL, "pxEndPoint must not be NULL" );
|
||||
__CPROVER_assert( pxDHCPMessage != NULL, "pxDHCPMessage must not be NULL" );
|
||||
|
||||
if( ( pxEndPoint->xDHCPData.eDHCPState == eLeasedAddress ) || ( pxEndPoint->xDHCPData.eDHCPState == eInitialWait ) )
|
||||
{
|
||||
__CPROVER_file_local_FreeRTOS_DHCPv6_c_prvCreateDHCPv6Socket( pxEndPoint );
|
||||
}
|
||||
|
||||
return nondet_BaseType();
|
||||
}
|
||||
|
||||
/**
|
||||
* In DHCP, we assume that FreeRTOS_socket always returns valid socket handler.
|
||||
*/
|
||||
Socket_t FreeRTOS_socket( BaseType_t xDomain,
|
||||
BaseType_t xType,
|
||||
BaseType_t xProtocol )
|
||||
{
|
||||
Socket_t * pxSocket = ensure_FreeRTOS_Socket_t_is_allocated();
|
||||
|
||||
__CPROVER_assume( pxSocket != NULL );
|
||||
|
||||
return pxSocket;
|
||||
}
|
||||
|
||||
void vIPNetworkUpCalls( struct xNetworkEndPoint * pxEndPoint )
|
||||
{
|
||||
__CPROVER_assert( pxEndPoint != NULL, "Endpoint cannot be NULL" );
|
||||
}
|
||||
|
||||
void * vSocketClose( FreeRTOS_Socket_t * pxSocket )
|
||||
{
|
||||
__CPROVER_assert( pxSocket != NULL, "Closing socket cannot be NULL." );
|
||||
|
||||
return NULL;
|
||||
}
|
||||
|
||||
/**
|
||||
* For the purpose of this proof we assume that xSocketValid returns true always.
|
||||
* This has to do with assertions in the source code that checks for socket being invalid.
|
||||
* [configASSERT( xSocketValid( xDHCPv6Socket ) == pdTRUE );]
|
||||
*/
|
||||
BaseType_t xSocketValid( const ConstSocket_t xSocket )
|
||||
{
|
||||
__CPROVER_assert( xSocket != FREERTOS_INVALID_SOCKET, "xSocket must be valid" );
|
||||
__CPROVER_assert( xSocket != NULL, "xSocket must not be NULL" );
|
||||
|
||||
return( ( xSocket != FREERTOS_INVALID_SOCKET ) && ( xSocket != NULL ) );
|
||||
}
|
||||
|
||||
/**
|
||||
* For the purpose of this proof we assume that vSocketBind returns 0 always.
|
||||
* Or the assertion is triggered when bind is failing.
|
||||
*/
|
||||
BaseType_t vSocketBind( FreeRTOS_Socket_t * pxSocket,
|
||||
struct freertos_sockaddr * pxBindAddress,
|
||||
size_t uxAddressLength,
|
||||
BaseType_t xInternal )
|
||||
{
|
||||
/* Return value is set to zero assuming socket bind will succeed. If it doesn't, it
|
||||
* will hit an assert in the function. */
|
||||
BaseType_t xRet = 0;
|
||||
|
||||
__CPROVER_assert( pxSocket != NULL,
|
||||
"FreeRTOS precondition: pxSocket != NULL" );
|
||||
__CPROVER_assert( pxBindAddress != NULL,
|
||||
"FreeRTOS precondition: pxBindAddress != NULL" );
|
||||
|
||||
return xRet;
|
||||
}
|
||||
|
||||
BaseType_t __CPROVER_file_local_FreeRTOS_DHCPv6_c_xDHCPv6ProcessEndPoint_HandleAdvertise( NetworkEndPoint_t * pxEndPoint,
|
||||
DHCPMessage_IPv6_t * pxDHCPMessage )
|
||||
{
|
||||
__CPROVER_assert( pxEndPoint != NULL, "pxEndPoint must not be NULL" );
|
||||
__CPROVER_assert( pxDHCPMessage != NULL, "pxDHCPMessage must not be NULL" );
|
||||
|
||||
return nondet_BaseType();
|
||||
}
|
||||
|
||||
void __CPROVER_file_local_FreeRTOS_DHCPv6_c_vDHCPv6ProcessEndPoint_HandleReply( NetworkEndPoint_t * pxEndPoint,
|
||||
DHCPMessage_IPv6_t * pxDHCPMessage )
|
||||
{
|
||||
__CPROVER_assert( pxEndPoint != NULL, "pxEndPoint must not be NULL" );
|
||||
__CPROVER_assert( pxDHCPMessage != NULL, "pxDHCPMessage must not be NULL" );
|
||||
}
|
||||
|
||||
void __CPROVER_file_local_FreeRTOS_DHCPv6_c_vDHCPv6ProcessEndPoint( BaseType_t xReset,
|
||||
NetworkEndPoint_t * pxEndPoint,
|
||||
DHCPMessage_IPv6_t * pxDHCPMessage );
|
||||
|
||||
void harness()
|
||||
{
|
||||
BaseType_t xReset, xGivingUp;
|
||||
|
||||
__CPROVER_assume( xDHCPv6SocketUserCount >= 0 && xDHCPv6SocketUserCount <= ENDPOINT_DNS_ADDRESS_COUNT );
|
||||
|
||||
NetworkEndPoint_t * pxNetworkEndPoint_Temp = safeMalloc( sizeof( NetworkEndPoint_t ) );
|
||||
|
||||
__CPROVER_assume( pxNetworkEndPoint_Temp != NULL );
|
||||
|
||||
DHCPMessage_IPv6_t * pxDHCPMessage = safeMalloc( sizeof( DHCPMessage_IPv6_t ) );
|
||||
__CPROVER_assume( pxDHCPMessage != NULL );
|
||||
|
||||
xDHCPv6Socket = FreeRTOS_socket( FREERTOS_AF_INET, FREERTOS_SOCK_DGRAM, FREERTOS_IPPROTO_UDP );
|
||||
|
||||
__CPROVER_file_local_FreeRTOS_DHCPv6_c_vDHCPv6ProcessEndPoint( xReset, pxNetworkEndPoint_Temp, pxDHCPMessage );
|
||||
}
|
||||
+28
@@ -0,0 +1,28 @@
|
||||
{
|
||||
"ENTRY": "DHCPv6ProcessEndPoint",
|
||||
"ENDPOINT_DNS_ADDRESS_COUNT": 5,
|
||||
"CBMCFLAGS":
|
||||
[
|
||||
"--nondet-static --flush",
|
||||
"--unwind 1"
|
||||
],
|
||||
"OPT":
|
||||
[
|
||||
"--export-file-local-symbols"
|
||||
],
|
||||
"DEF":
|
||||
[
|
||||
"ipconfigUSE_DHCPv6=1",
|
||||
"ENDPOINT_DNS_ADDRESS_COUNT={ENDPOINT_DNS_ADDRESS_COUNT}"
|
||||
],
|
||||
"OBJS":
|
||||
[
|
||||
"$(ENTRY)_harness.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/test/cbmc/stubs/cbmc.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/test/cbmc/stubs/freertos_api.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/test/cbmc/stubs/freertos_kernel_api.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/source/FreeRTOS_DHCPv6.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/source/FreeRTOS_IP.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/source/FreeRTOS_IP_Timers.goto"
|
||||
]
|
||||
}
|
||||
+105
@@ -0,0 +1,105 @@
|
||||
/*
|
||||
* FreeRTOS memory safety proofs with CBMC.
|
||||
* Copyright (C) 2022 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.
|
||||
*
|
||||
* http://aws.amazon.com/freertos
|
||||
* http://www.FreeRTOS.org
|
||||
*/
|
||||
|
||||
|
||||
/* Standard includes. */
|
||||
#include <stdint.h>
|
||||
|
||||
/* FreeRTOS includes. */
|
||||
#include "FreeRTOS.h"
|
||||
#include "task.h"
|
||||
#include "semphr.h"
|
||||
|
||||
/* FreeRTOS+TCP includes. */
|
||||
#include "FreeRTOS_IP.h"
|
||||
#include "FreeRTOS_Sockets.h"
|
||||
#include "FreeRTOS_IP_Private.h"
|
||||
#include "FreeRTOS_UDP_IP.h"
|
||||
#include "FreeRTOS_DHCP.h"
|
||||
|
||||
/* CBMC includes. */
|
||||
#include "cbmc.h"
|
||||
|
||||
/* Extern variables. */
|
||||
extern DHCPMessage_IPv6_t __CPROVER_file_local_FreeRTOS_DHCPv6_c_xDHCPMessage;
|
||||
|
||||
void __CPROVER_file_local_FreeRTOS_DHCPv6_c_vDHCPv6ProcessEndPoint( BaseType_t xReset,
|
||||
NetworkEndPoint_t * pxEndPoint,
|
||||
DHCPMessage_IPv6_t * pxDHCPMessage );
|
||||
|
||||
BaseType_t xDHCPv6Process_PassReplyToEndPoint( struct xNetworkEndPoint * pxEndPoint );
|
||||
|
||||
/* vDHCPv6ProcessEndPoint proved to be memory safe else where */
|
||||
static void __CPROVER_file_local_FreeRTOS_DHCPv6_c_vDHCPv6ProcessEndPoint( BaseType_t xReset,
|
||||
NetworkEndPoint_t * pxEndPoint,
|
||||
DHCPMessage_IPv6_t * pxDHCPMessage )
|
||||
{
|
||||
__CPROVER_assert( pxEndPoint != NULL, "pxEndPoint != NULL" );
|
||||
__CPROVER_assert( pxDHCPMessage != NULL, "pxDHCPMessage != NULL" );
|
||||
}
|
||||
|
||||
void harness()
|
||||
{
|
||||
BaseType_t xResult;
|
||||
|
||||
pxNetworkEndPoints = safeMalloc( sizeof( NetworkEndPoint_t ) );
|
||||
__CPROVER_assume( pxNetworkEndPoints != NULL );
|
||||
pxNetworkEndPoints->pxDHCPMessage = &__CPROVER_file_local_FreeRTOS_DHCPv6_c_xDHCPMessage;
|
||||
|
||||
if( nondet_bool() )
|
||||
{
|
||||
pxNetworkEndPoints->pxNext = safeMalloc( sizeof( NetworkEndPoint_t ) );
|
||||
__CPROVER_assume( pxNetworkEndPoints->pxNext != NULL );
|
||||
pxNetworkEndPoints->pxNext->pxDHCPMessage = &__CPROVER_file_local_FreeRTOS_DHCPv6_c_xDHCPMessage;
|
||||
pxNetworkEndPoints->pxNext->pxNext = NULL;
|
||||
}
|
||||
else
|
||||
{
|
||||
pxNetworkEndPoints->pxNext = NULL;
|
||||
}
|
||||
|
||||
NetworkEndPoint_t * pxNetworkEndPoint_Temp = safeMalloc( sizeof( NetworkEndPoint_t ) );
|
||||
__CPROVER_assume( pxNetworkEndPoint_Temp != NULL );
|
||||
pxNetworkEndPoint_Temp->pxNext = NULL;
|
||||
|
||||
pxNetworkEndPoint_Temp->pxDHCPMessage = safeMalloc( sizeof( DHCPMessage_IPv6_t ) );
|
||||
__CPROVER_assume( pxNetworkEndPoint_Temp->pxDHCPMessage != NULL );
|
||||
|
||||
/* Randomize DHCPMsg as input for different scenarios. */
|
||||
__CPROVER_havoc_object( &__CPROVER_file_local_FreeRTOS_DHCPv6_c_xDHCPMessage );
|
||||
|
||||
/* vDHCPv6ProcessEndPoint is checked separately. */
|
||||
if( nondet_bool() )
|
||||
{
|
||||
xResult = __CPROVER_file_local_FreeRTOS_DHCPv6_c_xDHCPv6Process_PassReplyToEndPoint( pxNetworkEndPoint_Temp );
|
||||
}
|
||||
else
|
||||
{
|
||||
xResult = __CPROVER_file_local_FreeRTOS_DHCPv6_c_xDHCPv6Process_PassReplyToEndPoint( pxNetworkEndPoints );
|
||||
}
|
||||
}
|
||||
+26
@@ -0,0 +1,26 @@
|
||||
{
|
||||
"ENTRY": "DHCPv6Process_PassReplyToEndPoint",
|
||||
"MAX_CLIENT_SERVER_ID_LENGTH": 128,
|
||||
"MAX_CLIENT_SERVER_ID_LENGTH_UNWIND": "__eval {MAX_CLIENT_SERVER_ID_LENGTH} + 1",
|
||||
"CBMCFLAGS":
|
||||
[
|
||||
"--nondet-static",
|
||||
"--unwind 1",
|
||||
"--unwindset memcmp.0:{MAX_CLIENT_SERVER_ID_LENGTH_UNWIND}",
|
||||
"--unwindset __CPROVER_file_local_FreeRTOS_DHCPv6_c_xDHCPv6Process_PassReplyToEndPoint.0:3"
|
||||
],
|
||||
"OPT":
|
||||
[
|
||||
"--export-file-local-symbols"
|
||||
],
|
||||
"DEF":
|
||||
[
|
||||
"ipconfigUSE_DHCPv6=1"
|
||||
],
|
||||
"OBJS":
|
||||
[
|
||||
"$(ENTRY)_harness.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/test/cbmc/stubs/cbmc.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/source/FreeRTOS_DHCPv6.goto"
|
||||
]
|
||||
}
|
||||
+23
@@ -0,0 +1,23 @@
|
||||
{
|
||||
"ENTRY": "SendDHCPMessage",
|
||||
"CBMCFLAGS":
|
||||
[
|
||||
"--nondet-static"
|
||||
],
|
||||
"OPT":
|
||||
[
|
||||
"--export-file-local-symbols"
|
||||
],
|
||||
"DEF":
|
||||
[
|
||||
"ipconfigUSE_DHCPv6=1"
|
||||
],
|
||||
"OBJS":
|
||||
[
|
||||
"$(ENTRY)_harness.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/source/FreeRTOS_DHCPv6.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/test/cbmc/stubs/cbmc.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/test/cbmc/stubs/freertos_api.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/test/cbmc/stubs/freertos_kernel_api.goto"
|
||||
]
|
||||
}
|
||||
+158
@@ -0,0 +1,158 @@
|
||||
/*
|
||||
* FreeRTOS memory safety proofs with CBMC.
|
||||
* Copyright (C) 2022 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.
|
||||
*
|
||||
* http://aws.amazon.com/freertos
|
||||
* http://www.FreeRTOS.org
|
||||
*/
|
||||
|
||||
/* Standard includes. */
|
||||
#include <stdint.h>
|
||||
|
||||
/* FreeRTOS includes. */
|
||||
#include "FreeRTOS.h"
|
||||
#include "task.h"
|
||||
#include "semphr.h"
|
||||
|
||||
/* FreeRTOS+TCP includes. */
|
||||
#include "FreeRTOS_IP.h"
|
||||
#include "FreeRTOS_Sockets.h"
|
||||
#include "FreeRTOS_IP_Private.h"
|
||||
#include "FreeRTOS_UDP_IP.h"
|
||||
#include "FreeRTOS_DHCP.h"
|
||||
#include "FreeRTOS_DHCPv6.h"
|
||||
#include "FreeRTOS_ARP.h"
|
||||
#include "FreeRTOS_BitConfig.h"
|
||||
|
||||
/* CBMC includes. */
|
||||
#include "cbmc.h"
|
||||
|
||||
void __CPROVER_file_local_FreeRTOS_DHCPv6_c_prvSendDHCPMessage( NetworkEndPoint_t * pxEndPoint );
|
||||
|
||||
BaseType_t xBitConfig_init( BitConfig_t * pxConfig,
|
||||
const uint8_t * pucData,
|
||||
size_t uxSize )
|
||||
{
|
||||
BaseType_t xReturn;
|
||||
|
||||
__CPROVER_assert( pxConfig != NULL, "pxConfig cannot be NULL" );
|
||||
|
||||
if( nondet_bool() )
|
||||
{
|
||||
xReturn = pdTRUE;
|
||||
|
||||
pxConfig->ucContents = safeMalloc( uxSize );
|
||||
__CPROVER_assume( pxConfig->ucContents != NULL );
|
||||
}
|
||||
else
|
||||
{
|
||||
xReturn = pdFALSE;
|
||||
}
|
||||
|
||||
return xReturn;
|
||||
}
|
||||
|
||||
BaseType_t pucBitConfig_peek_last_index_uc( BitConfig_t * pxConfig,
|
||||
uint8_t * pucData,
|
||||
size_t uxSize )
|
||||
{
|
||||
BaseType_t xReturn;
|
||||
|
||||
__CPROVER_assert( pxConfig != NULL, "pxConfig cannot be NULL" );
|
||||
__CPROVER_assert( pucData != NULL, "pucData cannot be NULL" );
|
||||
|
||||
__CPROVER_assume( xReturn == pdTRUE || xReturn == pdFALSE );
|
||||
|
||||
return xReturn;
|
||||
}
|
||||
|
||||
void vBitConfig_write_uc( BitConfig_t * pxConfig,
|
||||
const uint8_t * pucData,
|
||||
size_t uxSize )
|
||||
{
|
||||
__CPROVER_assert( pxConfig != NULL, "pxConfig cannot be NULL" );
|
||||
__CPROVER_assert( pucData != NULL, "pucData cannot be NULL" );
|
||||
}
|
||||
|
||||
void vBitConfig_write_8( BitConfig_t * pxConfig,
|
||||
uint8_t ucValue )
|
||||
{
|
||||
__CPROVER_assert( pxConfig != NULL, "pxConfig cannot be NULL" );
|
||||
}
|
||||
|
||||
void vBitConfig_write_16( BitConfig_t * pxConfig,
|
||||
uint16_t usValue )
|
||||
{
|
||||
__CPROVER_assert( pxConfig != NULL, "pxConfig cannot be NULL" );
|
||||
}
|
||||
|
||||
void vBitConfig_write_32( BitConfig_t * pxConfig,
|
||||
uint32_t ulValue )
|
||||
{
|
||||
__CPROVER_assert( pxConfig != NULL, "pxConfig cannot be NULL" );
|
||||
}
|
||||
|
||||
void vBitConfig_release( BitConfig_t * pxConfig )
|
||||
{
|
||||
__CPROVER_assert( pxConfig != NULL, "pxConfig cannot be NULL" );
|
||||
|
||||
if( pxConfig->ucContents != NULL )
|
||||
{
|
||||
free( pxConfig->ucContents );
|
||||
}
|
||||
}
|
||||
|
||||
BaseType_t FreeRTOS_inet_pton6( const char * pcSource,
|
||||
void * pvDestination )
|
||||
{
|
||||
BaseType_t xReturn;
|
||||
|
||||
__CPROVER_assert( pcSource != NULL, "pcSource cannot be NULL" );
|
||||
__CPROVER_assert( pvDestination != NULL, "pvDestination cannot be NULL" );
|
||||
|
||||
__CPROVER_assume( xReturn == pdTRUE || xReturn == pdFALSE );
|
||||
|
||||
return xReturn;
|
||||
}
|
||||
|
||||
uint32_t ulApplicationTimeHook( void )
|
||||
{
|
||||
return nondet_uint32();
|
||||
}
|
||||
|
||||
void harness()
|
||||
{
|
||||
NetworkEndPoint_t * pxNetworkEndPoint_Temp = safeMalloc( sizeof( NetworkEndPoint_t ) );
|
||||
|
||||
__CPROVER_assume( pxNetworkEndPoint_Temp != NULL );
|
||||
|
||||
/* The application provides the random number and time hook in a memory safe manner. */
|
||||
|
||||
pxNetworkEndPoint_Temp->pxDHCPMessage = safeMalloc( sizeof( DHCPMessage_IPv6_t ) );
|
||||
|
||||
/* All calls to prvSendDHCPMessage are after asserts to make sure pxDHCPMessage
|
||||
* is never NULL. [xDHCPv6ProcessEndPoint_HandleState(): configASSERT( pxDHCPMessage != NULL );] */
|
||||
__CPROVER_assume( pxNetworkEndPoint_Temp->pxDHCPMessage != NULL );
|
||||
|
||||
__CPROVER_file_local_FreeRTOS_DHCPv6_c_prvSendDHCPMessage( pxNetworkEndPoint_Temp );
|
||||
}
|
||||
+88
@@ -0,0 +1,88 @@
|
||||
/*
|
||||
* FreeRTOS memory safety proofs with CBMC.
|
||||
* Copyright (C) 2022 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.
|
||||
*
|
||||
* http://aws.amazon.com/freertos
|
||||
* http://www.FreeRTOS.org
|
||||
*/
|
||||
|
||||
/* FreeRTOS includes. */
|
||||
#include "FreeRTOS.h"
|
||||
#include "queue.h"
|
||||
#include "list.h"
|
||||
|
||||
/* FreeRTOS+TCP includes. */
|
||||
#include "FreeRTOS_IP.h"
|
||||
#include "FreeRTOS_DNS.h"
|
||||
#include "FreeRTOS_IP_Private.h"
|
||||
|
||||
#include "cbmc.h"
|
||||
|
||||
size_t __CPROVER_file_local_FreeRTOS_DNS_c_prvCreateDNSMessage( uint8_t * pucUDPPayloadBuffer,
|
||||
const char * pcHostName,
|
||||
TickType_t uxIdentifier,
|
||||
UBaseType_t uxHostType );
|
||||
|
||||
void harness()
|
||||
{
|
||||
size_t uxExpectedPayloadLength;
|
||||
TickType_t uxIdentifier;
|
||||
UBaseType_t uxHostType;
|
||||
size_t len;
|
||||
|
||||
/* Make sure the string has a valid but bounded length */
|
||||
__CPROVER_assume( len > 0 && len <= MAX_HOSTNAME_LEN );
|
||||
|
||||
/* pcHostName is tested to be valid prior */
|
||||
char * pcHostName = malloc( len );
|
||||
__CPROVER_assume( pcHostName != NULL );
|
||||
|
||||
if( len && pcHostName )
|
||||
{
|
||||
/* Make sure the string ends with a NULL, this is expected */
|
||||
pcHostName[ len - 1 ] = NULL;
|
||||
}
|
||||
|
||||
/* prvCreateDNSMessage() is expected to be called with a ethernet buffer of
|
||||
* the following size */
|
||||
uxExpectedPayloadLength = sizeof( DNSMessage_t ) +
|
||||
strlen( pcHostName ) +
|
||||
sizeof( uint16_t ) +
|
||||
sizeof( uint16_t ) + 2U;
|
||||
|
||||
/* Add header size */
|
||||
if( nondet_bool() )
|
||||
{
|
||||
uxExpectedPayloadLength += ipSIZE_OF_ETH_HEADER + ipSIZE_OF_IPv6_HEADER + ipSIZE_OF_UDP_HEADER;
|
||||
}
|
||||
else
|
||||
{
|
||||
uxExpectedPayloadLength += ipSIZE_OF_ETH_HEADER + ipSIZE_OF_IPv4_HEADER + ipSIZE_OF_UDP_HEADER;
|
||||
}
|
||||
|
||||
/* pucUDPPayloadBuffer is tested to be valid prior */
|
||||
uint8_t * pucUDPPayloadBuffer = malloc( uxExpectedPayloadLength );
|
||||
__CPROVER_assume( pucUDPPayloadBuffer != NULL );
|
||||
|
||||
__CPROVER_file_local_FreeRTOS_DNS_c_prvCreateDNSMessage( pucUDPPayloadBuffer, pcHostName, uxIdentifier, uxHostType );
|
||||
}
|
||||
+29
@@ -0,0 +1,29 @@
|
||||
{
|
||||
"ENTRY": "CreateDNSMessage",
|
||||
"MAX_HOSTNAME_LEN": 5,
|
||||
"HOSTNAME_UNWIND": "__eval {MAX_HOSTNAME_LEN} + 1",
|
||||
"USE_CACHE": 1,
|
||||
"CBMCFLAGS":
|
||||
[
|
||||
"--unwind 1",
|
||||
"--unwindset strlen.0:{HOSTNAME_UNWIND}",
|
||||
"--unwindset strcpy.0:{HOSTNAME_UNWIND}",
|
||||
"--unwindset __CPROVER_file_local_FreeRTOS_DNS_c_prvCreateDNSMessage.0:{HOSTNAME_UNWIND}",
|
||||
"--unwindset __CPROVER_file_local_FreeRTOS_DNS_c_prvCreateDNSMessage.1:{HOSTNAME_UNWIND}",
|
||||
"--nondet-static"
|
||||
],
|
||||
"OPT":
|
||||
[
|
||||
"--export-file-local-symbols"
|
||||
],
|
||||
"OBJS":
|
||||
[
|
||||
"$(ENTRY)_harness.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/source/FreeRTOS_DNS.goto"
|
||||
],
|
||||
"DEF":
|
||||
[
|
||||
"ipconfigUSE_DNS=1",
|
||||
"MAX_HOSTNAME_LEN={MAX_HOSTNAME_LEN}"
|
||||
]
|
||||
}
|
||||
+32
@@ -0,0 +1,32 @@
|
||||
/* FreeRTOS includes. */
|
||||
#include "FreeRTOS.h"
|
||||
#include "queue.h"
|
||||
|
||||
/* FreeRTOS+TCP includes. */
|
||||
#include "FreeRTOS_IP.h"
|
||||
#include "FreeRTOS_DNS.h"
|
||||
#include "FreeRTOS_IP_Private.h"
|
||||
|
||||
/* CBMC includes. */
|
||||
#include "cbmc.h"
|
||||
|
||||
/* Function DNS_ParseDNSReply is proven to be correct separately. */
|
||||
uint32_t DNS_ParseDNSReply( uint8_t * pucUDPPayloadBuffer,
|
||||
size_t uxBufferLength,
|
||||
struct freertos_addrinfo ** ppxAddressInfo,
|
||||
BaseType_t xExpected,
|
||||
uint16_t usPort )
|
||||
{
|
||||
__CPROVER_assert( pucUDPPayloadBuffer != NULL, "pucUDPPayloadBuffer cannot be NULL" );
|
||||
return nondet_uint32();
|
||||
}
|
||||
|
||||
void harness()
|
||||
{
|
||||
NetworkBufferDescriptor_t xNetworkBuffer;
|
||||
|
||||
xNetworkBuffer.pucEthernetBuffer = malloc( sizeof( UDPPacket_t ) + sizeof( DNSMessage_t ) );
|
||||
__CPROVER_assume( xNetworkBuffer.pucEthernetBuffer != NULL );
|
||||
|
||||
xDNSHandlePacket( &xNetworkBuffer );
|
||||
}
|
||||
+13
@@ -0,0 +1,13 @@
|
||||
{
|
||||
"ENTRY": "DNShandlePacket",
|
||||
"CBMCFLAGS": "--unwind 1",
|
||||
"OBJS":
|
||||
[
|
||||
"$(ENTRY)_harness.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/source/FreeRTOS_DNS.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/source/FreeRTOS_IP.goto"
|
||||
],
|
||||
"DEF":
|
||||
[
|
||||
]
|
||||
}
|
||||
+142
@@ -0,0 +1,142 @@
|
||||
/*
|
||||
* FreeRTOS memory safety proofs with CBMC.
|
||||
* Copyright (C) 2022 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.
|
||||
*
|
||||
* http://aws.amazon.com/freertos
|
||||
* http://www.FreeRTOS.org
|
||||
*/
|
||||
|
||||
/* FreeRTOS includes. */
|
||||
#include "FreeRTOS.h"
|
||||
#include "queue.h"
|
||||
|
||||
/* FreeRTOS+TCP includes. */
|
||||
#include "FreeRTOS_IP.h"
|
||||
#include "FreeRTOS_DNS.h"
|
||||
#include "FreeRTOS_DNS_Parser.h"
|
||||
#include "FreeRTOS_IP_Private.h"
|
||||
|
||||
#include "cbmc.h"
|
||||
|
||||
const BaseType_t xBufferAllocFixedSize = pdFALSE;
|
||||
NetworkBufferDescriptor_t xNetworkBuffer;
|
||||
|
||||
NetworkBufferDescriptor_t * pxUDPPayloadBuffer_to_NetworkBuffer( const void * pvBuffer )
|
||||
{
|
||||
__CPROVER_assert( pvBuffer != NULL, "Precondition: pvBuffer != NULL" );
|
||||
NetworkBufferDescriptor_t * pxRBuf;
|
||||
|
||||
if( nondet_bool() )
|
||||
{
|
||||
pxRBuf = NULL;
|
||||
}
|
||||
else
|
||||
{
|
||||
pxRBuf = &xNetworkBuffer;
|
||||
}
|
||||
|
||||
return pxRBuf;
|
||||
}
|
||||
|
||||
NetworkBufferDescriptor_t * pxResizeNetworkBufferWithDescriptor( NetworkBufferDescriptor_t * pxNetworkBuffer,
|
||||
size_t xNewSizeBytes )
|
||||
{
|
||||
NetworkBufferDescriptor_t * pxRBuf;
|
||||
|
||||
__CPROVER_assert( pxNetworkBuffer != NULL, "pxNetworkBuffer: pvBuffer != NULL" );
|
||||
|
||||
uint8_t * pucNewBuffer = safeMalloc( xNewSizeBytes );
|
||||
__CPROVER_assume( pucNewBuffer != NULL );
|
||||
|
||||
if( pxNetworkBuffer->pucEthernetBuffer )
|
||||
{
|
||||
free( pxNetworkBuffer->pucEthernetBuffer );
|
||||
}
|
||||
|
||||
pxNetworkBuffer->pucEthernetBuffer = pucNewBuffer;
|
||||
|
||||
if( nondet_bool() )
|
||||
{
|
||||
pxRBuf = NULL;
|
||||
}
|
||||
else
|
||||
{
|
||||
pxRBuf = pxNetworkBuffer;
|
||||
}
|
||||
|
||||
return pxRBuf;
|
||||
}
|
||||
|
||||
/* prepareReplyDNSMessage is proved separately */
|
||||
void prepareReplyDNSMessage( NetworkBufferDescriptor_t * pxNetworkBuffer,
|
||||
BaseType_t lNetLength )
|
||||
{
|
||||
__CPROVER_assert( pxNetworkBuffer != NULL, "pxNetworkBuffer: pvBuffer != NULL" );
|
||||
}
|
||||
|
||||
BaseType_t xApplicationDNSQueryHook_Multi( struct xNetworkEndPoint * pxEndPoint,
|
||||
const char * pcName )
|
||||
{
|
||||
BaseType_t xReturn;
|
||||
|
||||
__CPROVER_assert( strlen( pcName ) < ipconfigDNS_CACHE_NAME_LENGTH, "The length of domain name must be less than cache size" );
|
||||
__CPROVER_assume( xReturn == pdFALSE || xReturn == pdTRUE );
|
||||
|
||||
return xReturn;
|
||||
}
|
||||
|
||||
/* vReturnEthernetFrame() is proved separately */
|
||||
void vReturnEthernetFrame( NetworkBufferDescriptor_t * pxNetworkBuffer,
|
||||
BaseType_t xReleaseAfterSend )
|
||||
{
|
||||
__CPROVER_assert( pxNetworkBuffer != NULL, "xNetworkBuffer != NULL" );
|
||||
__CPROVER_assert( pxNetworkBuffer->pucEthernetBuffer != NULL, "pxNetworkBuffer->pucEthernetBuffer != NULL" );
|
||||
__CPROVER_assert( __CPROVER_r_ok( pxNetworkBuffer->pucEthernetBuffer, pxNetworkBuffer->xDataLength ), "Data must be valid" );
|
||||
}
|
||||
|
||||
void harness()
|
||||
{
|
||||
uint32_t ulIPAddress;
|
||||
|
||||
NetworkEndPoint_t * pxNetworkEndPoint_Temp = ( NetworkEndPoint_t * ) safeMalloc( sizeof( NetworkEndPoint_t ) );
|
||||
|
||||
BaseType_t xDataSize;
|
||||
|
||||
__CPROVER_assume( ( xDataSize > 0 ) && ( xDataSize < ( ipconfigNETWORK_MTU + ipSIZE_OF_ETH_HEADER ) ) );
|
||||
|
||||
xNetworkBuffer.pucEthernetBuffer = safeMalloc( xDataSize );
|
||||
xNetworkBuffer.xDataLength = xDataSize;
|
||||
__CPROVER_assume( xNetworkBuffer.pucEthernetBuffer != NULL );
|
||||
|
||||
if( nondet_bool() )
|
||||
{
|
||||
__CPROVER_assume( pxNetworkEndPoint_Temp != NULL );
|
||||
xNetworkBuffer.pxEndPoint = pxNetworkEndPoint_Temp;
|
||||
}
|
||||
else
|
||||
{
|
||||
xNetworkBuffer.pxEndPoint = NULL;
|
||||
}
|
||||
|
||||
DNS_TreatNBNS( xNetworkBuffer.pucEthernetBuffer, xNetworkBuffer.xDataLength, ulIPAddress );
|
||||
}
|
||||
+30
@@ -0,0 +1,30 @@
|
||||
{
|
||||
"ENTRY": "DNS_TreatNBNS",
|
||||
"USE_CACHE":1,
|
||||
"NBNS_NAME_MAX_LENGTH":17,
|
||||
"DNS_CACHE_NAME_LENGTH": 255,
|
||||
"CBMCFLAGS":
|
||||
[
|
||||
"--unwind 1",
|
||||
"--unwindset DNS_TreatNBNS.0:{NBNS_NAME_MAX_LENGTH}",
|
||||
"--unwindset prvFindEntryIndex.0:2",
|
||||
"--unwindset strcmp.0:{NBNS_NAME_MAX_LENGTH}",
|
||||
"--unwindset strlen.0:{NBNS_NAME_MAX_LENGTH}",
|
||||
"--unwindset strncpy.0:{DNS_CACHE_NAME_LENGTH}"
|
||||
],
|
||||
"OBJS":
|
||||
[
|
||||
"$(ENTRY)_harness.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/source/FreeRTOS_IP_Utils.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/source/FreeRTOS_DNS_Parser.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/source/FreeRTOS_DNS_Cache.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/test/cbmc/stubs/cbmc.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/test/cbmc/stubs/freertos_kernel_api.goto"
|
||||
],
|
||||
"DEF":
|
||||
[
|
||||
"ipconfigUSE_DNS_CACHE={USE_CACHE}",
|
||||
"ipconfigUSE_NBNS=1",
|
||||
"ipconfigNETWORK_MTU=586"
|
||||
]
|
||||
}
|
||||
+19
@@ -0,0 +1,19 @@
|
||||
/* FreeRTOS includes. */
|
||||
#include "FreeRTOS.h"
|
||||
#include "queue.h"
|
||||
|
||||
/* FreeRTOS+TCP includes. */
|
||||
#include "FreeRTOS_IP.h"
|
||||
#include "FreeRTOS_DNS.h"
|
||||
#include "FreeRTOS_IP_Private.h"
|
||||
|
||||
void FreeRTOS_dnsclear( void );
|
||||
|
||||
|
||||
void harness()
|
||||
{
|
||||
if( ipconfigUSE_DNS_CACHE != 0 )
|
||||
{
|
||||
FreeRTOS_dnsclear();
|
||||
}
|
||||
}
|
||||
+20
@@ -0,0 +1,20 @@
|
||||
{
|
||||
"ENTRY": "DNSclear",
|
||||
################################################################
|
||||
# This configuration flag uses DNS cache
|
||||
"USE_CACHE":1,
|
||||
"CBMCFLAGS":
|
||||
[
|
||||
"--unwind 1",
|
||||
"--nondet-static"
|
||||
],
|
||||
"OBJS":
|
||||
[
|
||||
"$(ENTRY)_harness.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/source/FreeRTOS_DNS_Cache.goto"
|
||||
],
|
||||
"DEF":
|
||||
[
|
||||
"ipconfigUSE_DNS_CACHE={USE_CACHE}"
|
||||
]
|
||||
}
|
||||
+303
@@ -0,0 +1,303 @@
|
||||
/* Standard includes. */
|
||||
#include <stdint.h>
|
||||
#include <stdio.h>
|
||||
|
||||
/* FreeRTOS includes. */
|
||||
#include "FreeRTOS.h"
|
||||
#include "task.h"
|
||||
#include "semphr.h"
|
||||
|
||||
/* FreeRTOS+TCP includes. */
|
||||
#include "FreeRTOS_IP.h"
|
||||
#include "FreeRTOS_Sockets.h"
|
||||
#include "FreeRTOS_IP_Private.h"
|
||||
#include "FreeRTOS_UDP_IP.h"
|
||||
#include "FreeRTOS_DNS.h"
|
||||
#include "FreeRTOS_DHCP.h"
|
||||
#include "NetworkBufferManagement.h"
|
||||
#include "NetworkInterface.h"
|
||||
|
||||
/* CBMC includes. */
|
||||
#include "cbmc.h"
|
||||
|
||||
uint32_t FreeRTOS_dnslookup( const char * pcHostName );
|
||||
Socket_t DNS_CreateSocket( TickType_t uxReadTimeout_ticks );
|
||||
void DNS_CloseSocket( Socket_t xDNSSocket );
|
||||
BaseType_t DNS_ReadReply( ConstSocket_t xDNSSocket,
|
||||
struct freertos_sockaddr * xAddress,
|
||||
struct xDNSBuffer * pxDNSBuf );
|
||||
uint32_t DNS_SendRequest( Socket_t xDNSSocket,
|
||||
struct freertos_sockaddr * xAddress,
|
||||
struct xDNSBuffer * pxDNSBuf );
|
||||
uint32_t DNS_ParseDNSReply( uint8_t * pucUDPPayloadBuffer,
|
||||
size_t uxBufferLength,
|
||||
struct freertos_addrinfo ** ppxAddressInfo,
|
||||
BaseType_t xExpected,
|
||||
uint16_t usPort );
|
||||
size_t __CPROVER_file_local_FreeRTOS_DNS_c_prvCreateDNSMessage( uint8_t * pucUDPPayloadBuffer,
|
||||
const char * pcHostName,
|
||||
TickType_t uxIdentifier,
|
||||
UBaseType_t uxHostType );
|
||||
uintptr_t __CPROVER_file_local_FreeRTOS_IP_Utils_c_void_ptr_to_uintptr( const void * pvPointer );
|
||||
|
||||
/****************************************************************
|
||||
* We abstract:
|
||||
*
|
||||
* All kernel task scheduling functions since we are doing
|
||||
* sequential verification and the sequential verification of these
|
||||
* sequential primitives is done elsewhere.
|
||||
*
|
||||
* Many methods in the FreeRTOS TCP API in stubs/freertos_api.c
|
||||
*
|
||||
* DNS_ParseDNSReply proved memory safe elsewhere
|
||||
*
|
||||
* prvCreateDNSMessage
|
||||
*
|
||||
* This proof assumes the length of pcHostName is bounded by
|
||||
* MAX_HOSTNAME_LEN. We have to bound this length because we have to
|
||||
* bound the iterations of strcmp.
|
||||
****************************************************************/
|
||||
|
||||
/*We assume that the pxGetNetworkBufferWithDescriptor function is implemented correctly and returns a valid data structure. */
|
||||
/*This is the mock to mimic the correct expected behavior. If this allocation fails, this might invalidate the proof. */
|
||||
NetworkBufferDescriptor_t * pxGetNetworkBufferWithDescriptor( size_t xRequestedSizeBytes,
|
||||
TickType_t xBlockTimeTicks )
|
||||
{
|
||||
NetworkBufferDescriptor_t * pxNetworkBuffer = ( NetworkBufferDescriptor_t * ) safeMalloc( sizeof( NetworkBufferDescriptor_t ) );
|
||||
|
||||
if( pxNetworkBuffer != NULL )
|
||||
{
|
||||
pxNetworkBuffer->pucEthernetBuffer = safeMalloc( xRequestedSizeBytes + ipUDP_PAYLOAD_IP_TYPE_OFFSET );
|
||||
|
||||
if( pxNetworkBuffer->pucEthernetBuffer == NULL )
|
||||
{
|
||||
free( pxNetworkBuffer );
|
||||
pxNetworkBuffer = NULL;
|
||||
}
|
||||
else
|
||||
{
|
||||
pxNetworkBuffer->pucEthernetBuffer = ( ( uint8_t * ) pxNetworkBuffer->pucEthernetBuffer ) + ipUDP_PAYLOAD_IP_TYPE_OFFSET;
|
||||
pxNetworkBuffer->xDataLength = xRequestedSizeBytes;
|
||||
}
|
||||
}
|
||||
|
||||
return pxNetworkBuffer;
|
||||
}
|
||||
|
||||
/*
|
||||
* In this function, it only allocates network buffer by pxGetNetworkBufferWithDescriptor
|
||||
* stub function above here. In this case, we should free both network buffer descriptor and pucEthernetBuffer.
|
||||
*/
|
||||
void vReleaseNetworkBufferAndDescriptor( NetworkBufferDescriptor_t * const pxNetworkBuffer )
|
||||
{
|
||||
__CPROVER_assert( pxNetworkBuffer != NULL,
|
||||
"Precondition: pxNetworkBuffer != NULL" );
|
||||
|
||||
free( pxNetworkBuffer->pucEthernetBuffer - ipUDP_PAYLOAD_IP_TYPE_OFFSET );
|
||||
free( pxNetworkBuffer );
|
||||
}
|
||||
|
||||
/* FreeRTOS_ReleaseUDPPayloadBuffer is mocked here and the memory
|
||||
* is not freed as the buffer allocated by the FreeRTOS_recvfrom is static
|
||||
* memory */
|
||||
void FreeRTOS_ReleaseUDPPayloadBuffer( void * pvBuffer )
|
||||
{
|
||||
__CPROVER_assert( pvBuffer != NULL,
|
||||
"FreeRTOS precondition: pvBuffer != NULL" );
|
||||
}
|
||||
|
||||
/****************************************************************
|
||||
* Abstract DNS_ParseDNSReply proved memory safe in ParseDNSReply.
|
||||
*
|
||||
* We stub out his function to fill the payload buffer with
|
||||
* unconstrained data and return an unconstrained size.
|
||||
*
|
||||
* The function under test uses only the return value of this
|
||||
* function.
|
||||
****************************************************************/
|
||||
|
||||
uint32_t DNS_ParseDNSReply( uint8_t * pucUDPPayloadBuffer,
|
||||
size_t uxBufferLength,
|
||||
struct freertos_addrinfo ** ppxAddressInfo,
|
||||
BaseType_t xExpected,
|
||||
uint16_t usPort )
|
||||
{
|
||||
uint32_t size;
|
||||
|
||||
__CPROVER_havoc_object( pucUDPPayloadBuffer );
|
||||
return size;
|
||||
}
|
||||
|
||||
/****************************************************************
|
||||
* Abstract DNS_SendRequest
|
||||
*
|
||||
* We stub out this function with return constraint of true or false
|
||||
*
|
||||
****************************************************************/
|
||||
uint32_t DNS_SendRequest( Socket_t xDNSSocket,
|
||||
struct freertos_sockaddr * xAddress,
|
||||
struct xDNSBuffer * pxDNSBuf )
|
||||
{
|
||||
uint32_t ret;
|
||||
|
||||
__CPROVER_assume( ret >= 0 );
|
||||
__CPROVER_assume( ret <= 1 );
|
||||
|
||||
return ret;
|
||||
}
|
||||
|
||||
/****************************************************************
|
||||
* Abstract DNS_BindSocket
|
||||
*
|
||||
* We stub out this function with return constraint of true or false
|
||||
*
|
||||
****************************************************************/
|
||||
BaseType_t DNS_BindSocket( Socket_t xSocket,
|
||||
uint16_t usPort )
|
||||
{
|
||||
BaseType_t xReturn;
|
||||
|
||||
__CPROVER_assume( xReturn == pdTRUE || xReturn == pdFALSE );
|
||||
|
||||
return xReturn;
|
||||
}
|
||||
|
||||
/****************************************************************
|
||||
* Abstract DNS_ReadReply
|
||||
*
|
||||
* We stub out this function which returned a dns_buffer filled with random data
|
||||
*
|
||||
****************************************************************/
|
||||
BaseType_t DNS_ReadReply( ConstSocket_t xDNSSocket,
|
||||
struct freertos_sockaddr * xAddress,
|
||||
struct xDNSBuffer * pxDNSBuf )
|
||||
{
|
||||
int len;
|
||||
uintptr_t uxTypeOffset;
|
||||
const uint8_t * pucIPType;
|
||||
uint8_t ucIPType;
|
||||
NetworkBufferDescriptor_t * pxNetworkEndPoints;
|
||||
|
||||
__CPROVER_assume( ( len > sizeof( DNSMessage_t ) ) && ( len < ipconfigNETWORK_MTU ) );
|
||||
|
||||
pxNetworkEndPoints = pxGetNetworkBufferWithDescriptor( len, 0 );
|
||||
__CPROVER_assume( pxNetworkEndPoints != NULL );
|
||||
__CPROVER_assume( pxNetworkEndPoints->pucEthernetBuffer != NULL );
|
||||
|
||||
pxDNSBuf->pucPayloadBuffer = pxNetworkEndPoints->pucEthernetBuffer;
|
||||
pxDNSBuf->uxPayloadLength = len;
|
||||
|
||||
__CPROVER_havoc_slice( pxDNSBuf->pucPayloadBuffer, pxDNSBuf->uxPayloadLength );
|
||||
|
||||
/* When IPv6 is supported, find out the type of the packet.
|
||||
* It is stored 48 bytes before the payload buffer as 0x40 or 0x60. */
|
||||
uxTypeOffset = __CPROVER_file_local_FreeRTOS_IP_Utils_c_void_ptr_to_uintptr( pxDNSBuf->pucPayloadBuffer );
|
||||
uxTypeOffset -= ipUDP_PAYLOAD_IP_TYPE_OFFSET;
|
||||
pucIPType = ( const uint8_t * ) uxTypeOffset;
|
||||
|
||||
/* For an IPv4 packet, pucIPType points to 6 bytes before the pucEthernetBuffer,
|
||||
* for a IPv6 packet, pucIPType will point to the first byte of the IP-header: 'ucVersionTrafficClass'. */
|
||||
ucIPType = pucIPType[ 0 ] & 0xf0U;
|
||||
|
||||
/* To help the translation from a UDP payload pointer to a networkBuffer,
|
||||
* a byte was stored at a certain negative offset (-48 bytes).
|
||||
* It must have a value of either 0x4x or 0x6x. */
|
||||
__CPROVER_assume( ( ucIPType == ipTYPE_IPv4 ) || ( ucIPType == ipTYPE_IPv6 ) );
|
||||
|
||||
return nondet_basetype();
|
||||
}
|
||||
|
||||
|
||||
void DNS_CloseSocket( Socket_t xDNSSocket )
|
||||
{
|
||||
__CPROVER_assert( xDNSSocket != NULL, "The xDNSSocket cannot be NULL." );
|
||||
free( xDNSSocket );
|
||||
}
|
||||
|
||||
Socket_t DNS_CreateSocket( TickType_t uxReadTimeout_ticks )
|
||||
{
|
||||
Socket_t sock = malloc( sizeof( struct xSOCKET ) );
|
||||
|
||||
return sock;
|
||||
}
|
||||
|
||||
uint32_t FreeRTOS_dnslookup( const char * pcHostName )
|
||||
{
|
||||
int ret;
|
||||
|
||||
__CPROVER_assume( ret < 0xFFFF );
|
||||
__CPROVER_assume( ret > 0 );
|
||||
|
||||
return ret;
|
||||
}
|
||||
|
||||
BaseType_t NetworkInterfaceOutputFunction_Stub( struct xNetworkInterface * pxDescriptor,
|
||||
NetworkBufferDescriptor_t * const pxNetworkBuffer,
|
||||
BaseType_t xReleaseAfterSend )
|
||||
{
|
||||
__CPROVER_assert( pxDescriptor != NULL, "The network interface cannot be NULL." );
|
||||
__CPROVER_assert( pxNetworkBuffer != NULL, "The network buffer descriptor cannot be NULL." );
|
||||
__CPROVER_assert( pxNetworkBuffer->pucEthernetBuffer != NULL, "The ethernet buffer cannot be NULL." );
|
||||
BaseType_t ret;
|
||||
return ret;
|
||||
}
|
||||
|
||||
/****************************************************************
|
||||
* Abstract prvCreateDNSMessage
|
||||
*
|
||||
* This function writes a header, a hostname, and a constant amount of
|
||||
* data into the payload buffer, and returns the amount of data
|
||||
* written. This abstraction just fills the entire buffer with
|
||||
* unconstrained data and returns and unconstrained length.
|
||||
****************************************************************/
|
||||
|
||||
size_t __CPROVER_file_local_FreeRTOS_DNS_c_prvCreateDNSMessage( uint8_t * pucUDPPayloadBuffer,
|
||||
const char * pcHostName,
|
||||
TickType_t uxIdentifier,
|
||||
UBaseType_t uxHostType )
|
||||
{
|
||||
__CPROVER_havoc_object( pucUDPPayloadBuffer );
|
||||
size_t size;
|
||||
|
||||
return size;
|
||||
}
|
||||
|
||||
uint32_t Prepare_CacheLookup( const char * pcHostName,
|
||||
BaseType_t xFamily,
|
||||
struct freertos_addrinfo ** ppxAddressInfo )
|
||||
{
|
||||
return nondet_uint32();
|
||||
}
|
||||
|
||||
/****************************************************************
|
||||
* The proof for FreeRTOS_gethostbyname.
|
||||
****************************************************************/
|
||||
|
||||
void harness()
|
||||
{
|
||||
size_t len;
|
||||
|
||||
pxNetworkEndPoints = ( NetworkEndPoint_t * ) malloc( sizeof( NetworkEndPoint_t ) );
|
||||
__CPROVER_assume( pxNetworkEndPoints != NULL );
|
||||
|
||||
/* Asserts are added in the src code to make sure ucDNSIndex
|
||||
* will be less than ipconfigENDPOINT_DNS_ADDRESS_COUNT */
|
||||
__CPROVER_assume( pxNetworkEndPoints->ipv6_settings.ucDNSIndex < ipconfigENDPOINT_DNS_ADDRESS_COUNT );
|
||||
__CPROVER_assume( pxNetworkEndPoints->ipv4_settings.ucDNSIndex < ipconfigENDPOINT_DNS_ADDRESS_COUNT );
|
||||
pxNetworkEndPoints->pxNext = NULL;
|
||||
|
||||
/* Interface init. */
|
||||
pxNetworkEndPoints->pxNetworkInterface = ( NetworkInterface_t * ) malloc( sizeof( NetworkInterface_t ) );
|
||||
__CPROVER_assume( pxNetworkEndPoints->pxNetworkInterface != NULL );
|
||||
|
||||
pxNetworkEndPoints->pxNetworkInterface->pfOutput = &NetworkInterfaceOutputFunction_Stub;
|
||||
|
||||
__CPROVER_assume( len <= MAX_HOSTNAME_LEN );
|
||||
char * pcHostName = malloc( len );
|
||||
|
||||
__CPROVER_assume( len > 0 ); /* prvProcessDNSCache strcmp */
|
||||
__CPROVER_assume( pcHostName != NULL );
|
||||
pcHostName[ len - 1 ] = NULL;
|
||||
|
||||
FreeRTOS_gethostbyname( pcHostName );
|
||||
}
|
||||
+51
@@ -0,0 +1,51 @@
|
||||
{
|
||||
"ENTRY": "DNSgetHostByName",
|
||||
|
||||
################################################################
|
||||
# This configuration sets callback to 0.
|
||||
# It also sets MAX_HOSTNAME_LEN to 10 to bound strcmp.
|
||||
# According to the specification MAX_HOST_NAME is upto 255.
|
||||
|
||||
"callback": 0,
|
||||
"MAX_HOSTNAME_LEN": 10,
|
||||
"ENDPOINT_DNS_ADDRESS_COUNT": 5,
|
||||
"HOSTNAME_UNWIND": "__eval {MAX_HOSTNAME_LEN} + 1",
|
||||
"ENDPOINT_DNS_ADDRESS_COUNT_UNWIND": "__eval {ENDPOINT_DNS_ADDRESS_COUNT} + 1",
|
||||
"DNS_CACHE_ENTRIES": 2,
|
||||
|
||||
"CBMCFLAGS":
|
||||
[
|
||||
"--unwind 1",
|
||||
"--unwindset strchr.0:{HOSTNAME_UNWIND}",
|
||||
"--unwindset __CPROVER_file_local_FreeRTOS_DNS_c_prvIncreaseDNS4Index.0:{ENDPOINT_DNS_ADDRESS_COUNT_UNWIND}",
|
||||
"--unwindset __CPROVER_file_local_FreeRTOS_DNS_c_prvIncreaseDNS6Index.0:{ENDPOINT_DNS_ADDRESS_COUNT_UNWIND}",
|
||||
"--unwindset __CPROVER_file_local_FreeRTOS_DNS_c_prvFillSockAddress.0:2,__CPROVER_file_local_FreeRTOS_DNS_c_prvFillSockAddress.1:2",
|
||||
"--unwindset __CPROVER_file_local_FreeRTOS_DNS_c_prvCreateDNSMessage.0:{HOSTNAME_UNWIND},__CPROVER_file_local_FreeRTOS_DNS_c_prvCreateDNSMessage.1:{HOSTNAME_UNWIND},strlen.0:{HOSTNAME_UNWIND},__builtin___strcpy_chk.0:{HOSTNAME_UNWIND},strcmp.0:{HOSTNAME_UNWIND},strcpy.0:{HOSTNAME_UNWIND}",
|
||||
"--unwindset __CPROVER_file_local_FreeRTOS_DNS_c_prvGetHostByNameOp_WithRetry.0:{HOSTNAME_UNWIND}",
|
||||
"--nondet-static"
|
||||
],
|
||||
"OPT":
|
||||
[
|
||||
"--export-file-local-symbols"
|
||||
],
|
||||
"OBJS":
|
||||
[
|
||||
"$(ENTRY)_harness.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/source/FreeRTOS_IP_Utils.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/source/FreeRTOS_DNS.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/source/FreeRTOS_Routing.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/source/FreeRTOS_DNS_Parser.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/test/cbmc/stubs/freertos_api.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/test/cbmc/stubs/freertos_kernel_api.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/test/cbmc/stubs/cbmc.goto"
|
||||
],
|
||||
|
||||
"DEF":
|
||||
[
|
||||
"ipconfigUSE_IPv6=1",
|
||||
"ipconfigDNS_USE_CALLBACKS={callback}",
|
||||
"MAX_HOSTNAME_LEN={MAX_HOSTNAME_LEN}",
|
||||
"ipconfigENDPOINT_DNS_ADDRESS_COUNT={ENDPOINT_DNS_ADDRESS_COUNT}",
|
||||
"ipconfigDNS_CACHE_ENTRIES={DNS_CACHE_ENTRIES}"
|
||||
]
|
||||
}
|
||||
+9
@@ -0,0 +1,9 @@
|
||||
{ "expected-missing-functions":
|
||||
[
|
||||
"vLoggingPrintf",
|
||||
"xApplicationGetRandomNumber",
|
||||
"xTaskGetTickCount"
|
||||
],
|
||||
"proof-name": "DNSgetHostByName",
|
||||
"proof-root": "tools/cbmc/proofs"
|
||||
}
|
||||
+299
@@ -0,0 +1,299 @@
|
||||
/* Standard includes. */
|
||||
#include <stdint.h>
|
||||
#include <stdio.h>
|
||||
|
||||
/* FreeRTOS includes. */
|
||||
#include "FreeRTOS.h"
|
||||
#include "task.h"
|
||||
#include "semphr.h"
|
||||
|
||||
/* FreeRTOS+TCP includes. */
|
||||
#include "FreeRTOS_IP.h"
|
||||
#include "FreeRTOS_Sockets.h"
|
||||
#include "FreeRTOS_IP_Private.h"
|
||||
#include "FreeRTOS_UDP_IP.h"
|
||||
#include "FreeRTOS_DNS.h"
|
||||
#include "FreeRTOS_DHCP.h"
|
||||
#include "NetworkBufferManagement.h"
|
||||
#include "NetworkInterface.h"
|
||||
|
||||
/* CBMC includes. */
|
||||
#include "cbmc.h"
|
||||
|
||||
uintptr_t __CPROVER_file_local_FreeRTOS_IP_Utils_c_void_ptr_to_uintptr( const void * pvPointer );
|
||||
|
||||
/****************************************************************
|
||||
* We abstract:
|
||||
*
|
||||
* All kernel task scheduling functions since we are doing
|
||||
* sequential verification and the sequential verification of these
|
||||
* sequential primitives is done elsewhere.
|
||||
*
|
||||
* Many methods in the FreeRTOS TCP API in stubs/freertos_api.c
|
||||
*
|
||||
* DNS_ParseDNSReply proved memory safe elsewhere
|
||||
*
|
||||
* prvCreateDNSMessage
|
||||
*
|
||||
* This proof assumes the length of pcHostName is bounded by
|
||||
* MAX_HOSTNAME_LEN. We have to bound this length because we have to
|
||||
* bound the iterations of strcmp.
|
||||
****************************************************************/
|
||||
|
||||
/*We assume that the pxGetNetworkBufferWithDescriptor function is implemented correctly and returns a valid data structure. */
|
||||
/*This is the mock to mimic the correct expected behavior. If this allocation fails, this might invalidate the proof. */
|
||||
NetworkBufferDescriptor_t * pxGetNetworkBufferWithDescriptor( size_t xRequestedSizeBytes,
|
||||
TickType_t xBlockTimeTicks )
|
||||
{
|
||||
NetworkBufferDescriptor_t * pxNetworkBuffer = ( NetworkBufferDescriptor_t * ) safeMalloc( sizeof( NetworkBufferDescriptor_t ) );
|
||||
|
||||
if( pxNetworkBuffer != NULL )
|
||||
{
|
||||
pxNetworkBuffer->pucEthernetBuffer = safeMalloc( xRequestedSizeBytes + ipBUFFER_PADDING + ipUDP_PAYLOAD_IP_TYPE_OFFSET );
|
||||
|
||||
if( pxNetworkBuffer->pucEthernetBuffer == NULL )
|
||||
{
|
||||
free( pxNetworkBuffer );
|
||||
pxNetworkBuffer = NULL;
|
||||
}
|
||||
else
|
||||
{
|
||||
pxNetworkBuffer->pucEthernetBuffer = ( ( uint8_t * ) pxNetworkBuffer->pucEthernetBuffer ) + ipBUFFER_PADDING + ipUDP_PAYLOAD_IP_TYPE_OFFSET;
|
||||
pxNetworkBuffer->xDataLength = xRequestedSizeBytes;
|
||||
}
|
||||
}
|
||||
|
||||
return pxNetworkBuffer;
|
||||
}
|
||||
|
||||
/*
|
||||
* In this function, it only allocates network buffer by pxGetNetworkBufferWithDescriptor
|
||||
* stub function above here. In this case, we should free both network buffer descriptor and pucEthernetBuffer.
|
||||
*/
|
||||
void vReleaseNetworkBufferAndDescriptor( NetworkBufferDescriptor_t * const pxNetworkBuffer )
|
||||
{
|
||||
__CPROVER_assert( pxNetworkBuffer != NULL,
|
||||
"Precondition: pxNetworkBuffer != NULL" );
|
||||
|
||||
free( pxNetworkBuffer->pucEthernetBuffer - ( ipUDP_PAYLOAD_IP_TYPE_OFFSET + ipBUFFER_PADDING ) );
|
||||
free( pxNetworkBuffer );
|
||||
}
|
||||
|
||||
/* FreeRTOS_ReleaseUDPPayloadBuffer is mocked here and the memory
|
||||
* is not freed as the buffer allocated by the FreeRTOS_recvfrom is static
|
||||
* memory */
|
||||
void FreeRTOS_ReleaseUDPPayloadBuffer( void * pvBuffer )
|
||||
{
|
||||
__CPROVER_assert( pvBuffer != NULL,
|
||||
"FreeRTOS precondition: pvBuffer != NULL" );
|
||||
}
|
||||
|
||||
/****************************************************************
|
||||
* Abstract DNS_ParseDNSReply proved memory safe in ParseDNSReply.
|
||||
*
|
||||
* We stub out his function to fill the payload buffer with
|
||||
* unconstrained data and return an unconstrained size.
|
||||
*
|
||||
* The function under test uses only the return value of this
|
||||
* function.
|
||||
****************************************************************/
|
||||
|
||||
uint32_t DNS_ParseDNSReply( uint8_t * pucUDPPayloadBuffer,
|
||||
size_t uxBufferLength,
|
||||
struct freertos_addrinfo ** ppxAddressInfo,
|
||||
BaseType_t xExpected,
|
||||
uint16_t usPort )
|
||||
{
|
||||
__CPROVER_assert( pucUDPPayloadBuffer != NULL,
|
||||
"Precondition: pucUDPPayloadBuffer != NULL" );
|
||||
|
||||
__CPROVER_havoc_object( pucUDPPayloadBuffer );
|
||||
return nondet_uint32();
|
||||
}
|
||||
|
||||
/****************************************************************
|
||||
* Abstract prvCreateDNSMessage
|
||||
*
|
||||
* This function writes a header, a hostname, and a constant amount of
|
||||
* data into the payload buffer, and returns the amount of data
|
||||
* written. This abstraction just fills the entire buffer with
|
||||
* unconstrained data and returns and unconstrained length.
|
||||
****************************************************************/
|
||||
|
||||
size_t __CPROVER_file_local_FreeRTOS_DNS_c_prvCreateDNSMessage( uint8_t * pucUDPPayloadBuffer,
|
||||
const char * pcHostName,
|
||||
TickType_t uxIdentifier,
|
||||
UBaseType_t uxHostType )
|
||||
{
|
||||
__CPROVER_assert( pucUDPPayloadBuffer != NULL,
|
||||
"Precondition: pucUDPPayloadBuffer != NULL" );
|
||||
__CPROVER_assert( pcHostName != NULL,
|
||||
"Precondition: pcHostName != NULL" );
|
||||
|
||||
__CPROVER_havoc_object( pucUDPPayloadBuffer );
|
||||
return nondet_sizet();
|
||||
}
|
||||
|
||||
/****************************************************************
|
||||
* A stub for a function callback.
|
||||
****************************************************************/
|
||||
|
||||
void func( const char * pcHostName,
|
||||
void * pvSearchID,
|
||||
struct freertos_addrinfo * pxAddressInfo )
|
||||
{
|
||||
__CPROVER_assert( pcHostName != NULL,
|
||||
"Precondition: pcHostName != NULL" );
|
||||
__CPROVER_assert( pvSearchID != NULL,
|
||||
"Precondition: pvSearchID != NULL" );
|
||||
|
||||
/* pxAddressInfo is not validated for not being NULL as
|
||||
* pxAddressInfo could be NULL if there is a timeout or other errors. */
|
||||
}
|
||||
|
||||
BaseType_t NetworkInterfaceOutputFunction_Stub( struct xNetworkInterface * pxDescriptor,
|
||||
NetworkBufferDescriptor_t * const pxNetworkBuffer,
|
||||
BaseType_t xReleaseAfterSend )
|
||||
{
|
||||
__CPROVER_assert( pxDescriptor != NULL, "The network interface cannot be NULL." );
|
||||
__CPROVER_assert( pxNetworkBuffer != NULL, "The network buffer descriptor cannot be NULL." );
|
||||
__CPROVER_assert( pxNetworkBuffer->pucEthernetBuffer != NULL, "The ethernet buffer cannot be NULL." );
|
||||
BaseType_t ret;
|
||||
return ret;
|
||||
}
|
||||
|
||||
Socket_t DNS_CreateSocket( TickType_t uxReadTimeout_ticks )
|
||||
{
|
||||
Socket_t xSock = safeMalloc( sizeof( struct xSOCKET ) );
|
||||
|
||||
return xSock;
|
||||
}
|
||||
|
||||
void DNS_CloseSocket( Socket_t xDNSSocket )
|
||||
{
|
||||
__CPROVER_assert( xDNSSocket != NULL, "The xDNSSocket cannot be NULL." );
|
||||
free( xDNSSocket );
|
||||
}
|
||||
|
||||
/****************************************************************
|
||||
* Abstract DNS_BindSocket
|
||||
*
|
||||
* We stub out this function with return constraint of true or false
|
||||
*
|
||||
****************************************************************/
|
||||
BaseType_t DNS_BindSocket( Socket_t xSocket,
|
||||
uint16_t usPort )
|
||||
{
|
||||
BaseType_t xReturn;
|
||||
|
||||
__CPROVER_assume( xReturn == pdTRUE || xReturn == pdFALSE );
|
||||
|
||||
return xReturn;
|
||||
}
|
||||
|
||||
/****************************************************************
|
||||
* Abstract DNS_SendRequest
|
||||
*
|
||||
* We stub out this function with return constraint of true or false
|
||||
*
|
||||
****************************************************************/
|
||||
uint32_t DNS_SendRequest( Socket_t xDNSSocket,
|
||||
struct freertos_sockaddr * xAddress,
|
||||
struct xDNSBuffer * pxDNSBuf )
|
||||
{
|
||||
uint32_t ret;
|
||||
|
||||
__CPROVER_assume( ret >= 0 );
|
||||
__CPROVER_assume( ret <= 1 );
|
||||
|
||||
return ret;
|
||||
}
|
||||
|
||||
/****************************************************************
|
||||
* Abstract DNS_ReadReply
|
||||
*
|
||||
* We stub out this function which returned a dns_buffer filled with random data
|
||||
*
|
||||
****************************************************************/
|
||||
BaseType_t DNS_ReadReply( ConstSocket_t xDNSSocket,
|
||||
struct freertos_sockaddr * xAddress,
|
||||
struct xDNSBuffer * pxDNSBuf )
|
||||
{
|
||||
int len;
|
||||
NetworkBufferDescriptor_t * pxNetworkBuffer;
|
||||
|
||||
__CPROVER_assume( ( len > sizeof( DNSMessage_t ) ) && ( len < ipconfigNETWORK_MTU ) );
|
||||
|
||||
pxNetworkBuffer = pxGetNetworkBufferWithDescriptor( len, 0 );
|
||||
__CPROVER_assume( pxNetworkBuffer != NULL );
|
||||
__CPROVER_assume( pxNetworkBuffer->pucEthernetBuffer != NULL );
|
||||
|
||||
pxDNSBuf->pucPayloadBuffer = pxNetworkBuffer->pucEthernetBuffer;
|
||||
pxDNSBuf->uxPayloadLength = len;
|
||||
|
||||
__CPROVER_havoc_slice( pxDNSBuf->pucPayloadBuffer, pxDNSBuf->uxPayloadLength );
|
||||
|
||||
return nondet_basetype();
|
||||
}
|
||||
|
||||
/* Function xDNSSetCallBack is proven to be correct separately. */
|
||||
BaseType_t xDNSSetCallBack( const char * pcHostName,
|
||||
void * pvSearchID,
|
||||
FOnDNSEvent pCallbackFunction,
|
||||
TickType_t xTimeout,
|
||||
TickType_t xIdentifier,
|
||||
BaseType_t xIsIPv6 )
|
||||
{
|
||||
BaseType_t xReturn;
|
||||
|
||||
__CPROVER_assume( xReturn == pdTRUE || xReturn == pdFALSE );
|
||||
|
||||
return xReturn;
|
||||
}
|
||||
|
||||
uint32_t Prepare_CacheLookup( const char * pcHostName,
|
||||
BaseType_t xFamily,
|
||||
struct freertos_addrinfo ** ppxAddressInfo )
|
||||
{
|
||||
( *ppxAddressInfo ) = ( struct freertos_addrinfo * ) malloc( sizeof( struct freertos_addrinfo ) );
|
||||
__CPROVER_assume( ( *ppxAddressInfo ) != NULL );
|
||||
__CPROVER_assume( ( *ppxAddressInfo )->ai_next == NULL );
|
||||
uint32_t ulRet;
|
||||
return ulRet;
|
||||
}
|
||||
|
||||
/****************************************************************
|
||||
* The proof for FreeRTOS_gethostbyname_a.
|
||||
****************************************************************/
|
||||
|
||||
void harness()
|
||||
{
|
||||
size_t len;
|
||||
|
||||
pxNetworkEndPoints = ( NetworkEndPoint_t * ) malloc( sizeof( NetworkEndPoint_t ) );
|
||||
__CPROVER_assume( pxNetworkEndPoints != NULL );
|
||||
|
||||
/* Asserts are added in the src code to make sure ucDNSIndex
|
||||
* will be less than ipconfigENDPOINT_DNS_ADDRESS_COUNT */
|
||||
__CPROVER_assume( pxNetworkEndPoints->ipv6_settings.ucDNSIndex < ipconfigENDPOINT_DNS_ADDRESS_COUNT );
|
||||
__CPROVER_assume( pxNetworkEndPoints->ipv4_settings.ucDNSIndex < ipconfigENDPOINT_DNS_ADDRESS_COUNT );
|
||||
__CPROVER_assume( pxNetworkEndPoints->pxNext == NULL );
|
||||
|
||||
/* Interface init. */
|
||||
pxNetworkEndPoints->pxNetworkInterface = ( NetworkInterface_t * ) malloc( sizeof( NetworkInterface_t ) );
|
||||
__CPROVER_assume( pxNetworkEndPoints->pxNetworkInterface != NULL );
|
||||
|
||||
__CPROVER_assume( len <= MAX_HOSTNAME_LEN );
|
||||
char * pcHostName = safeMalloc( len );
|
||||
|
||||
__CPROVER_assume( len > 0 ); /* prvProcessDNSCache strcmp */
|
||||
__CPROVER_assume( pcHostName != NULL );
|
||||
pcHostName[ len - 1 ] = NULL;
|
||||
|
||||
FOnDNSEvent pCallback = &func;
|
||||
TickType_t xTimeout;
|
||||
void * pvSearchID;
|
||||
__CPROVER_assume( pvSearchID != NULL );
|
||||
|
||||
FreeRTOS_gethostbyname_a( pcHostName, pCallback, pvSearchID, xTimeout );
|
||||
}
|
||||
+42
@@ -0,0 +1,42 @@
|
||||
{
|
||||
"ENTRY": "DNSgetHostByName_a",
|
||||
################################################################
|
||||
# This configuration flag sets callback to 1. It also sets MAX_HOSTNAME_LEN to 10 and MAX_REQ_SIZE to 50 for performance issues.
|
||||
# According to the specification MAX_HOST_NAME is upto 255.
|
||||
"callback": 1,
|
||||
"MAX_HOSTNAME_LEN": 10,
|
||||
"ENDPOINT_DNS_ADDRESS_COUNT": 5,
|
||||
"HOSTNAME_UNWIND": "__eval {MAX_HOSTNAME_LEN} + 1",
|
||||
"CBMCFLAGS":
|
||||
[
|
||||
"--unwind 1",
|
||||
"--unwindset __CPROVER_file_local_FreeRTOS_DNS_c_prvFillSockAddress.0:2,__CPROVER_file_local_FreeRTOS_DNS_c_prvFillSockAddress.1:2",
|
||||
"--unwindset FreeRTOS_freeaddrinfo.0:2",
|
||||
"--unwindset strchr.0:{HOSTNAME_UNWIND}",
|
||||
"--unwindset strncpy.0:255",
|
||||
"--unwindset __CPROVER_file_local_FreeRTOS_DNS_c_prvCreateDNSMessage.0:{HOSTNAME_UNWIND},__CPROVER_file_local_FreeRTOS_DNS_c_prvCreateDNSMessage.1:{HOSTNAME_UNWIND},prvGetHostByName.0:{HOSTNAME_UNWIND},prvProcessDNSCache.0:5,strlen.0:{HOSTNAME_UNWIND},__builtin___strcpy_chk.0:{HOSTNAME_UNWIND},strcmp.0:{HOSTNAME_UNWIND},xTaskResumeAll.0:{HOSTNAME_UNWIND},xTaskResumeAll.1:{HOSTNAME_UNWIND},strcpy.0:{HOSTNAME_UNWIND}",
|
||||
"--nondet-static"
|
||||
],
|
||||
"OPT":
|
||||
[
|
||||
"--export-file-local-symbols"
|
||||
],
|
||||
"OBJS":
|
||||
[
|
||||
"$(ENTRY)_harness.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/source/FreeRTOS_Routing.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/source/FreeRTOS_DNS.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/source/FreeRTOS_DNS_Parser.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/source/FreeRTOS_IP_Utils.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/test/cbmc/stubs/cbmc.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/test/cbmc/stubs/freertos_api.goto"
|
||||
],
|
||||
"DEF":
|
||||
[
|
||||
"ipconfigDNS_USE_CALLBACKS={callback}",
|
||||
"MAX_HOSTNAME_LEN={MAX_HOSTNAME_LEN}",
|
||||
# This value is defined only when ipconfigUSE_DNS_CACHE==1
|
||||
"ipconfigDNS_CACHE_NAME_LENGTH=254",
|
||||
"ipconfigENDPOINT_DNS_ADDRESS_COUNT={ENDPOINT_DNS_ADDRESS_COUNT}"
|
||||
]
|
||||
}
|
||||
+13
@@ -0,0 +1,13 @@
|
||||
{ "expected-missing-functions":
|
||||
[
|
||||
"vLoggingPrintf",
|
||||
"xApplicationGetRandomNumber",
|
||||
"vListInsertEnd",
|
||||
"vTaskSetTimeOutState",
|
||||
"vTaskSuspendAll",
|
||||
"xTaskGetTickCount",
|
||||
"xTaskResumeAll"
|
||||
],
|
||||
"proof-name": "DNSgetHostByName_a",
|
||||
"proof-root": "tools/cbmc/proofs"
|
||||
}
|
||||
+85
@@ -0,0 +1,85 @@
|
||||
/* FreeRTOS includes. */
|
||||
#include "FreeRTOS.h"
|
||||
#include "queue.h"
|
||||
#include "list.h"
|
||||
|
||||
/* FreeRTOS+TCP includes. */
|
||||
#include "FreeRTOS_IP.h"
|
||||
#include "FreeRTOS_DNS.h"
|
||||
#include "FreeRTOS_IP_Private.h"
|
||||
|
||||
/* CBMC includes. */
|
||||
#include "cbmc.h"
|
||||
|
||||
/* This proof assumes the length of pcHostName is bounded by MAX_HOSTNAME_LEN. This also abstracts the concurrency. */
|
||||
|
||||
void vDNSInitialise( void );
|
||||
|
||||
BaseType_t xDNSSetCallBack( const char * pcHostName,
|
||||
void * pvSearchID,
|
||||
FOnDNSEvent pCallbackFunction,
|
||||
TickType_t xTimeout,
|
||||
TickType_t xIdentifier,
|
||||
BaseType_t xIsIPv6 );
|
||||
|
||||
/* Abstraction of uxListRemove from list. This also abstracts the concurrency. */
|
||||
void vListInitialise( List_t * const pxList )
|
||||
{
|
||||
__CPROVER_assert( pxList != NULL, "pxList cannot be NULL" );
|
||||
|
||||
pxList->pxIndex = ( ListItem_t * ) &( pxList->xListEnd );
|
||||
pxList->xListEnd.xItemValue = portMAX_DELAY;
|
||||
|
||||
/* The list end next and previous pointers point to itself so we know
|
||||
* when the list is empty. */
|
||||
pxList->xListEnd.pxNext = ( ListItem_t * ) &( pxList->xListEnd );
|
||||
pxList->xListEnd.pxPrevious = ( ListItem_t * ) &( pxList->xListEnd );
|
||||
pxList->uxNumberOfItems = ( UBaseType_t ) 0U;
|
||||
}
|
||||
|
||||
/* Abstraction of uxListRemove from list. This also abstracts the concurrency. */
|
||||
UBaseType_t uxListRemove( ListItem_t * const pxItemToRemove )
|
||||
{
|
||||
List_t * const pxList = pxItemToRemove->pxContainer;
|
||||
|
||||
pxItemToRemove->pxNext->pxPrevious = pxItemToRemove->pxPrevious;
|
||||
pxItemToRemove->pxPrevious->pxNext = pxItemToRemove->pxNext;
|
||||
|
||||
if( pxList->pxIndex == pxItemToRemove )
|
||||
{
|
||||
pxList->pxIndex = pxItemToRemove->pxPrevious;
|
||||
}
|
||||
|
||||
pxItemToRemove->pxContainer = NULL;
|
||||
( pxList->uxNumberOfItems )--;
|
||||
|
||||
return pxList->uxNumberOfItems;
|
||||
}
|
||||
|
||||
/* The function func mimics the callback function.*/
|
||||
void func( const char * pcHostName,
|
||||
void * pvSearchID,
|
||||
uint32_t ulIPAddress )
|
||||
{
|
||||
}
|
||||
|
||||
void harness()
|
||||
{
|
||||
vDNSInitialise(); /* We initialize the callbacklist in order to be able to check for functions that timed out. */
|
||||
size_t pvSearchID;
|
||||
FOnDNSEvent pCallback = func;
|
||||
TickType_t xTimeout;
|
||||
TickType_t xIdentifier;
|
||||
BaseType_t xIsIPv6;
|
||||
size_t len;
|
||||
BaseType_t xReturn;
|
||||
|
||||
__CPROVER_assume( len > 0 && len <= MAX_HOSTNAME_LEN );
|
||||
char * pcHostName = safeMalloc( len );
|
||||
__CPROVER_assume( pcHostName != NULL );
|
||||
__CPROVER_havoc_slice( pcHostName, len - 1 );
|
||||
pcHostName[ len - 1 ] = NULL;
|
||||
|
||||
xReturn = xDNSSetCallBack( pcHostName, &pvSearchID, pCallback, xTimeout, xIdentifier, xIsIPv6 ); /* Add an item to be able to check the cancel function if the list is non-empty. */
|
||||
FreeRTOS_gethostbyname_cancel( &pvSearchID );
|
||||
}
|
||||
+33
@@ -0,0 +1,33 @@
|
||||
{
|
||||
"ENTRY": "DNSgetHostByName_cancel",
|
||||
################################################################
|
||||
# This configuration flag sets callback to 1. It also sets MAX_HOSTNAME_LEN to 10 for performance issues.
|
||||
# According to the specification MAX_HOST_NAME is upto 255.
|
||||
"callback": 1,
|
||||
"MAX_HOSTNAME_LEN": 10,
|
||||
"HOSTNAME_UNWIND": "__eval {MAX_HOSTNAME_LEN} + 1",
|
||||
"CBMCFLAGS":
|
||||
[
|
||||
"--unwind 1",
|
||||
"--unwindset prvProcessDNSCache.0:5,strlen.0:{HOSTNAME_UNWIND},__builtin___strcpy_chk.0:{HOSTNAME_UNWIND},vDNSCheckCallBack.0:2,strcpy.0:{HOSTNAME_UNWIND}",
|
||||
"--unwindset strncpy.0:{HOSTNAME_UNWIND}"
|
||||
],
|
||||
"OBJS":
|
||||
[
|
||||
"$(ENTRY)_harness.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/source/FreeRTOS_IP_Utils.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/source/FreeRTOS_IP_Timers.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/source/FreeRTOS_DNS.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/source/FreeRTOS_DNS_Callback.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/test/cbmc/stubs/freertos_kernel_api.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/test/cbmc/stubs/freertos_api.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/test/cbmc/stubs/cbmc.goto"
|
||||
],
|
||||
"DEF":
|
||||
[
|
||||
"ipconfigDNS_USE_CALLBACKS={callback}",
|
||||
"MAX_HOSTNAME_LEN={MAX_HOSTNAME_LEN}",
|
||||
# This value is defined only when ipconfigUSE_DNS_CACHE==1
|
||||
"ipconfigDNS_CACHE_NAME_LENGTH=254"
|
||||
]
|
||||
}
|
||||
+42
@@ -0,0 +1,42 @@
|
||||
/* FreeRTOS includes. */
|
||||
#include "FreeRTOS.h"
|
||||
#include "queue.h"
|
||||
#include "list.h"
|
||||
|
||||
/* FreeRTOS+TCP includes. */
|
||||
#include "FreeRTOS_IP.h"
|
||||
#include "FreeRTOS_DNS.h"
|
||||
#include "FreeRTOS_IP_Private.h"
|
||||
|
||||
/* This assumes that the length of the hostname is bounded by MAX_HOSTNAME_LEN. */
|
||||
void * safeMalloc( size_t xWantedSize )
|
||||
{
|
||||
if( xWantedSize == 0 )
|
||||
{
|
||||
return NULL;
|
||||
}
|
||||
|
||||
uint8_t byte;
|
||||
|
||||
return byte ? malloc( xWantedSize ) : NULL;
|
||||
}
|
||||
|
||||
void harness()
|
||||
{
|
||||
if( ipconfigUSE_DNS_CACHE != 0 )
|
||||
{
|
||||
size_t len;
|
||||
__CPROVER_assume( len >= 0 && len <= MAX_HOSTNAME_LEN );
|
||||
char * pcHostName = safeMalloc( len ); /* malloc is replaced by safeMalloc */
|
||||
|
||||
if( len && pcHostName )
|
||||
{
|
||||
pcHostName[ len - 1 ] = NULL;
|
||||
}
|
||||
|
||||
if( pcHostName ) /* guarding against NULL pointer */
|
||||
{
|
||||
FreeRTOS_dnslookup( pcHostName );
|
||||
}
|
||||
}
|
||||
}
|
||||
+27
@@ -0,0 +1,27 @@
|
||||
{
|
||||
"ENTRY": "DNSlookup",
|
||||
################################################################
|
||||
# This configuration uses DNS cache and the MAX_HOSTNAME_LEN is set to 255 according to the specification
|
||||
"MAX_HOSTNAME_LEN": 255,
|
||||
"HOSTNAME_UNWIND": "__eval {MAX_HOSTNAME_LEN} + 1",
|
||||
"USE_CACHE": 1,
|
||||
"CBMCFLAGS":
|
||||
[
|
||||
"--unwind 1",
|
||||
"--unwindset prvFindEntryIndex.0:3",
|
||||
"--unwindset prvProcessDNSCache.0:5,strcmp.0:{HOSTNAME_UNWIND}",
|
||||
"--nondet-static"
|
||||
],
|
||||
"OBJS":
|
||||
[
|
||||
"$(ENTRY)_harness.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/source/FreeRTOS_DNS_Cache.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/test/FreeRTOS-Kernel/tasks.goto"
|
||||
],
|
||||
"DEF":
|
||||
[
|
||||
"ipconfigUSE_DNS_CACHE={USE_CACHE}",
|
||||
"MAX_HOSTNAME_LEN={MAX_HOSTNAME_LEN}"
|
||||
],
|
||||
"OPT" : "-m32"
|
||||
}
|
||||
+21
@@ -0,0 +1,21 @@
|
||||
{
|
||||
"ENTRY": "NBNSHandlePacket",
|
||||
"USE_CACHE":1,
|
||||
"CBMCFLAGS":
|
||||
[
|
||||
"--unwind 1",
|
||||
"--nondet-static"
|
||||
],
|
||||
"OBJS":
|
||||
[
|
||||
"$(ENTRY)_harness.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/test/cbmc/stubs/cbmc.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/source/FreeRTOS_IP_Utils.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/source/FreeRTOS_DNS.goto"
|
||||
],
|
||||
"DEF":
|
||||
[
|
||||
"ipconfigUSE_DNS_CACHE={USE_CACHE}",
|
||||
"ipconfigUSE_NBNS=1"
|
||||
]
|
||||
}
|
||||
+41
@@ -0,0 +1,41 @@
|
||||
/* FreeRTOS includes. */
|
||||
#include "FreeRTOS.h"
|
||||
#include "queue.h"
|
||||
|
||||
/* FreeRTOS+TCP includes. */
|
||||
#include "FreeRTOS_IP.h"
|
||||
#include "FreeRTOS_DNS.h"
|
||||
#include "FreeRTOS_DNS_Parser.h"
|
||||
#include "FreeRTOS_IP_Private.h"
|
||||
|
||||
#include "cbmc.h"
|
||||
|
||||
NetworkBufferDescriptor_t xNetworkBuffer;
|
||||
|
||||
/* DNS_TreatNBNS is proved separately */
|
||||
void DNS_TreatNBNS( uint8_t * pucPayload,
|
||||
size_t uxBufferLength,
|
||||
uint32_t ulIPAddress )
|
||||
{
|
||||
__CPROVER_assert( pucPayload != NULL, "Precondition: pucPayload != NULL" );
|
||||
}
|
||||
|
||||
void harness()
|
||||
{
|
||||
uint32_t ulIPAddress;
|
||||
|
||||
BaseType_t xDataSize;
|
||||
|
||||
/* Assume an upper limit on max memory that can be allocated */
|
||||
__CPROVER_assume( ( xDataSize < ( ipconfigNETWORK_MTU + ipSIZE_OF_ETH_HEADER ) ) );
|
||||
xNetworkBuffer.xDataLength = xDataSize;
|
||||
|
||||
xNetworkBuffer.pucEthernetBuffer = safeMalloc( xDataSize );
|
||||
|
||||
/* pucEthernetBuffer being not NULL is pre validated before the call to ulNBNSHandlePacket */
|
||||
__CPROVER_assume( xNetworkBuffer.pucEthernetBuffer != NULL );
|
||||
|
||||
xNetworkBuffer.pxEndPoint = ( NetworkEndPoint_t * ) safeMalloc( sizeof( NetworkEndPoint_t ) );
|
||||
|
||||
ulNBNSHandlePacket( &xNetworkBuffer );
|
||||
}
|
||||
+22
@@ -0,0 +1,22 @@
|
||||
{
|
||||
"ENTRY": "prepareReplyDNSMessage",
|
||||
"USE_CACHE":1,
|
||||
"CBMCFLAGS":
|
||||
[
|
||||
"--unwind 1",
|
||||
"--nondet-static"
|
||||
],
|
||||
"OBJS":
|
||||
[
|
||||
"$(ENTRY)_harness.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/test/cbmc/stubs/cbmc.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/source/FreeRTOS_IP.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/source/FreeRTOS_IP_Utils.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/source/FreeRTOS_DNS_Parser.goto"
|
||||
],
|
||||
"DEF":
|
||||
[
|
||||
"ipconfigUSE_DNS_CACHE={USE_CACHE}",
|
||||
"ipconfigUSE_NBNS=1"
|
||||
]
|
||||
}
|
||||
+117
@@ -0,0 +1,117 @@
|
||||
/*
|
||||
* FreeRTOS memory safety proofs with CBMC.
|
||||
* Copyright (C) 2022 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.
|
||||
*
|
||||
* http://aws.amazon.com/freertos
|
||||
* http://www.FreeRTOS.org
|
||||
*/
|
||||
|
||||
/* FreeRTOS includes. */
|
||||
#include "FreeRTOS.h"
|
||||
#include "queue.h"
|
||||
|
||||
/* FreeRTOS+TCP includes. */
|
||||
#include "FreeRTOS_IP.h"
|
||||
#include "FreeRTOS_DNS.h"
|
||||
#include "FreeRTOS_DNS_Parser.h"
|
||||
#include "FreeRTOS_IP_Private.h"
|
||||
|
||||
#include "cbmc.h"
|
||||
|
||||
NetworkBufferDescriptor_t xNetworkBuffer;
|
||||
NetworkEndPoint_t * pxNetworkEndPoint_Temp;
|
||||
|
||||
/* Stub FreeRTOS_FindEndPointOnNetMask_IPv6 as its not relevant to the
|
||||
* correctness of the proof */
|
||||
NetworkEndPoint_t * FreeRTOS_FindEndPointOnNetMask_IPv6( const IPv6_Address_t * pxIPv6Address )
|
||||
{
|
||||
__CPROVER_assert( pxIPv6Address != NULL, "Precondition: pxIPv6Address != NULL" );
|
||||
|
||||
/* Assume at least one end-point is available */
|
||||
return pxNetworkEndPoint_Temp;
|
||||
}
|
||||
|
||||
/* Stub FreeRTOS_FindEndPointOnNetMask_IPv6 as its not relevant to the
|
||||
* correctness of the proof */
|
||||
NetworkEndPoint_t * FreeRTOS_FindEndPointOnNetMask( uint32_t ulIPAddress )
|
||||
{
|
||||
/* Assume at least one end-point is available */
|
||||
return pxNetworkEndPoint_Temp;
|
||||
}
|
||||
|
||||
/* The checksum generation is stubbed out since the actual checksum
|
||||
* does not matter. The stub will return an indeterminate value each time. */
|
||||
uint16_t usGenerateChecksum( uint16_t usSum,
|
||||
const uint8_t * pucNextData,
|
||||
size_t uxByteCount )
|
||||
{
|
||||
uint16_t usReturn;
|
||||
|
||||
__CPROVER_assert( pucNextData != NULL, "Next data cannot be NULL" );
|
||||
|
||||
/* Return an indeterminate value. */
|
||||
return usReturn;
|
||||
}
|
||||
|
||||
/* The checksum generation is stubbed out since the actual checksum
|
||||
* does not matter. The stub will return an indeterminate value each time. */
|
||||
uint16_t usGenerateProtocolChecksum( const uint8_t * const pucEthernetBuffer,
|
||||
size_t uxBufferLength,
|
||||
BaseType_t xOutgoingPacket )
|
||||
{
|
||||
uint16_t usReturn;
|
||||
|
||||
__CPROVER_assert( pucEthernetBuffer != NULL, "Ethernet buffer cannot be NULL" );
|
||||
|
||||
/* Return an indeterminate value. */
|
||||
return usReturn;
|
||||
}
|
||||
|
||||
void harness()
|
||||
{
|
||||
uint32_t ulIPAddress;
|
||||
uint16_t usLength;
|
||||
|
||||
/* Assume at least 1 valid endpoint */
|
||||
pxNetworkEndPoint_Temp = ( NetworkEndPoint_t * ) safeMalloc( sizeof( NetworkEndPoint_t ) );
|
||||
__CPROVER_assume( pxNetworkEndPoint_Temp != NULL );
|
||||
|
||||
BaseType_t xDataSize;
|
||||
|
||||
/* The pucEthernetBuffer is re adjusted to the following size before the
|
||||
* call to prepareReplyDNSMessage by pxResizeNetworkBufferWithDescriptor. If buffer allocation
|
||||
* scheme #1 (BufferAllocation_1.c) is used we assert if the needed size is actually present
|
||||
* in the buffer. */
|
||||
__CPROVER_assume( ( xDataSize > ( sizeof( UDPPacket_t ) + sizeof( NBNSRequest_t ) + sizeof( NBNSAnswer_t ) - 2 * sizeof( uint16_t ) ) ) && ( xDataSize < ipconfigNETWORK_MTU ) );
|
||||
|
||||
xNetworkBuffer.pucEthernetBuffer = safeMalloc( xDataSize );
|
||||
xNetworkBuffer.pxEndPoint = pxNetworkEndPoint_Temp;
|
||||
|
||||
/* xNetworkBuffer.pucEthernetBuffer is checked if its valid before the call to
|
||||
* prepareReplyDNSMessage() */
|
||||
__CPROVER_assume( xNetworkBuffer.pucEthernetBuffer != NULL );
|
||||
|
||||
xNetworkBuffer.xDataLength = xDataSize;
|
||||
|
||||
prepareReplyDNSMessage( &xNetworkBuffer, usLength );
|
||||
}
|
||||
+94
@@ -0,0 +1,94 @@
|
||||
{
|
||||
"ENTRY": "DNS_ParseDNSReply",
|
||||
"TEST_MAX_TEST_UNWIND_LOOP": 6,
|
||||
"TEST_MIN_TEST_DNS_HEADER": 12,
|
||||
"TEST_MIN_IPV4_UDP_PACKET_SIZE": 42,
|
||||
"TEST_MIN_IPV6_UDP_PACKET_SIZE": 62,
|
||||
"TEST_IPV4_NETWORK_MTU": "__eval {TEST_MIN_IPV4_UDP_PACKET_SIZE} + {TEST_MIN_TEST_DNS_HEADER} + {TEST_MAX_TEST_UNWIND_LOOP}",
|
||||
"TEST_IPV6_NETWORK_MTU": "__eval {TEST_MIN_IPV6_UDP_PACKET_SIZE} + {TEST_MIN_TEST_DNS_HEADER} + {TEST_MAX_TEST_UNWIND_LOOP}",
|
||||
"CBMCFLAGS":
|
||||
[
|
||||
"--unwind 1",
|
||||
"--unwindset strlen.0:{TEST_MAX_TEST_UNWIND_LOOP}",
|
||||
"--unwindset DNS_ParseDNSReply.0:{TEST_MAX_TEST_UNWIND_LOOP}",
|
||||
"--unwindset DNS_ReadNameField.0:{TEST_MAX_TEST_UNWIND_LOOP}",
|
||||
"--unwindset DNS_ReadNameField.1:{TEST_MAX_TEST_UNWIND_LOOP}"
|
||||
],
|
||||
"OPT":
|
||||
[
|
||||
"--export-file-local-symbols"
|
||||
],
|
||||
"OBJS":
|
||||
[
|
||||
"$(ENTRY)_harness.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/source/FreeRTOS_DNS_Parser.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/test/cbmc/stubs/cbmc.goto"
|
||||
],
|
||||
"DEF":
|
||||
[
|
||||
{
|
||||
"IPv4_FixedNetworkBufferSize":
|
||||
[
|
||||
"TEST_MAX_PAYLOAD_SIZE={TEST_MAX_TEST_UNWIND_LOOP}",
|
||||
"ipconfigUSE_LLMNR=1",
|
||||
"ipconfigUSE_MDNS=1",
|
||||
"IS_TESTING_IPV6=0",
|
||||
"IS_BUFFER_ALLOCATE_FIXED=1",
|
||||
"ipconfigNETWORK_MTU={TEST_IPV4_NETWORK_MTU}",
|
||||
"ipconfigUSE_TCP=0",
|
||||
"ipconfigUSE_DHCP=0",
|
||||
"ipconfigTCP_MSS=536",
|
||||
"ipconfigDNS_CACHE_NAME_LENGTH={TEST_MAX_TEST_UNWIND_LOOP}"
|
||||
]
|
||||
},
|
||||
{
|
||||
"IPv6_FixedNetworkBufferSize":
|
||||
[
|
||||
"TEST_MAX_PAYLOAD_SIZE={TEST_MAX_TEST_UNWIND_LOOP}",
|
||||
"ipconfigUSE_LLMNR=1",
|
||||
"ipconfigUSE_MDNS=1",
|
||||
"IS_TESTING_IPV6=1",
|
||||
"IS_BUFFER_ALLOCATE_FIXED=1",
|
||||
"ipconfigNETWORK_MTU={TEST_IPV6_NETWORK_MTU}",
|
||||
"ipconfigUSE_TCP=0",
|
||||
"ipconfigUSE_DHCP=0",
|
||||
"ipconfigTCP_MSS=536",
|
||||
"ipconfigDNS_CACHE_NAME_LENGTH={TEST_MAX_TEST_UNWIND_LOOP}"
|
||||
]
|
||||
},
|
||||
{
|
||||
"IPv4_DynamicNetworkBufferSize":
|
||||
[
|
||||
"TEST_MAX_PAYLOAD_SIZE={TEST_MAX_TEST_UNWIND_LOOP}",
|
||||
"ipconfigUSE_LLMNR=1",
|
||||
"ipconfigUSE_MDNS=1",
|
||||
"IS_TESTING_IPV6=0",
|
||||
"IS_BUFFER_ALLOCATE_FIXED=0",
|
||||
"ipconfigNETWORK_MTU={TEST_IPV4_NETWORK_MTU}",
|
||||
"ipconfigUSE_TCP=0",
|
||||
"ipconfigUSE_DHCP=0",
|
||||
"ipconfigTCP_MSS=536",
|
||||
"ipconfigDNS_CACHE_NAME_LENGTH={TEST_MAX_TEST_UNWIND_LOOP}"
|
||||
]
|
||||
},
|
||||
{
|
||||
"IPv6_DynamicNetworkBufferSize":
|
||||
[
|
||||
"TEST_MAX_PAYLOAD_SIZE={TEST_MAX_TEST_UNWIND_LOOP}",
|
||||
"ipconfigUSE_LLMNR=1",
|
||||
"ipconfigUSE_MDNS=1",
|
||||
"IS_TESTING_IPV6=1",
|
||||
"IS_BUFFER_ALLOCATE_FIXED=0",
|
||||
"ipconfigNETWORK_MTU={TEST_IPV6_NETWORK_MTU}",
|
||||
"ipconfigUSE_TCP=0",
|
||||
"ipconfigUSE_DHCP=0",
|
||||
"ipconfigTCP_MSS=536",
|
||||
"ipconfigDNS_CACHE_NAME_LENGTH={TEST_MAX_TEST_UNWIND_LOOP}"
|
||||
]
|
||||
}
|
||||
],
|
||||
"INC":
|
||||
[
|
||||
"$(FREERTOS_PLUS_TCP)/test/cbmc/include"
|
||||
]
|
||||
}
|
||||
+230
@@ -0,0 +1,230 @@
|
||||
/* Standard includes. */
|
||||
#include <stdint.h>
|
||||
|
||||
/* FreeRTOS includes. */
|
||||
#include "FreeRTOS.h"
|
||||
#include "task.h"
|
||||
#include "queue.h"
|
||||
#include "list.h"
|
||||
#include "semphr.h"
|
||||
|
||||
/* FreeRTOS+TCP includes. */
|
||||
#include "FreeRTOS_IP.h"
|
||||
#include "FreeRTOS_IP_Private.h"
|
||||
#include "FreeRTOS_DNS.h"
|
||||
#include "FreeRTOS_DNS_Parser.h"
|
||||
#include "NetworkBufferManagement.h"
|
||||
#include "NetworkInterface.h"
|
||||
#include "IPTraceMacroDefaults.h"
|
||||
|
||||
#include "cbmc.h"
|
||||
|
||||
const BaseType_t xBufferAllocFixedSize = IS_BUFFER_ALLOCATE_FIXED;
|
||||
|
||||
/****************************************************************
|
||||
* Signature of function under test
|
||||
****************************************************************/
|
||||
|
||||
uint32_t DNS_ParseDNSReply( uint8_t * pucUDPPayloadBuffer,
|
||||
size_t uxBufferLength,
|
||||
struct freertos_addrinfo ** ppxAddressInfo,
|
||||
BaseType_t xExpected,
|
||||
uint16_t usPort );
|
||||
|
||||
NetworkBufferDescriptor_t xNetworkBuffer;
|
||||
int lIsIPv6Packet;
|
||||
|
||||
size_t uxIPHeaderSizePacket( const NetworkBufferDescriptor_t * pxNetworkBuffer )
|
||||
{
|
||||
#if IS_TESTING_IPV6
|
||||
return ipSIZE_OF_IPv6_HEADER;
|
||||
#else
|
||||
return ipSIZE_OF_IPv4_HEADER;
|
||||
#endif
|
||||
}
|
||||
|
||||
NetworkBufferDescriptor_t * pxUDPPayloadBuffer_to_NetworkBuffer( const void * pvBuffer )
|
||||
{
|
||||
__CPROVER_assert( pvBuffer != NULL, "Precondition: pvBuffer != NULL" );
|
||||
NetworkBufferDescriptor_t * pxRBuf;
|
||||
|
||||
if( nondet_bool() )
|
||||
{
|
||||
pxRBuf = NULL;
|
||||
}
|
||||
else
|
||||
{
|
||||
pxRBuf = &xNetworkBuffer;
|
||||
}
|
||||
|
||||
return pxRBuf;
|
||||
}
|
||||
|
||||
uint32_t ulChar2u32( const uint8_t * pucPtr )
|
||||
{
|
||||
uint32_t ret;
|
||||
|
||||
__CPROVER_assert( __CPROVER_r_ok( pucPtr, 4 ), "must be 4 bytes legal address to read" );
|
||||
return ret;
|
||||
}
|
||||
|
||||
uint16_t usChar2u16( const uint8_t * pucPtr )
|
||||
{
|
||||
uint16_t ret;
|
||||
|
||||
__CPROVER_assert( __CPROVER_r_ok( pucPtr, 2 ), "must be 2 bytes legal address to read" );
|
||||
return ret;
|
||||
}
|
||||
|
||||
const char * FreeRTOS_inet_ntop( BaseType_t xAddressFamily,
|
||||
const void * pvSource,
|
||||
char * pcDestination,
|
||||
socklen_t uxSize )
|
||||
{
|
||||
__CPROVER_assert( __CPROVER_r_ok( pcDestination, uxSize ), "input buffer must be available" );
|
||||
|
||||
#if IS_TESTING_IPV6
|
||||
__CPROVER_assert( ( xAddressFamily == FREERTOS_AF_INET6 && __CPROVER_r_ok( pvSource, 16 ) ), "input address must be available" );
|
||||
#else
|
||||
__CPROVER_assert( ( xAddressFamily == FREERTOS_AF_INET && __CPROVER_r_ok( pvSource, 4 ) ), "input address must be available" );
|
||||
#endif
|
||||
}
|
||||
|
||||
BaseType_t xApplicationDNSQueryHook_Multi( struct xNetworkEndPoint * pxEndPoint,
|
||||
const char * pcName )
|
||||
{
|
||||
__CPROVER_assert( strlen( pcName ) < ipconfigDNS_CACHE_NAME_LENGTH, "The length of domain name must be less than cache size" );
|
||||
}
|
||||
|
||||
void vReleaseNetworkBufferAndDescriptor( NetworkBufferDescriptor_t * const pxNetworkBuffer )
|
||||
{
|
||||
__CPROVER_assert( pxNetworkBuffer, "network descriptor must be valid." );
|
||||
__CPROVER_assert( pxNetworkBuffer->pucEthernetBuffer, "network buffer must be valid." );
|
||||
|
||||
free( pxNetworkBuffer->pucEthernetBuffer );
|
||||
free( pxNetworkBuffer );
|
||||
}
|
||||
|
||||
/* The checksum generation is stubbed out since the actual checksum
|
||||
* does not matter. The stub will return an indeterminate value each time. */
|
||||
uint16_t usGenerateChecksum( uint16_t usSum,
|
||||
const uint8_t * pucNextData,
|
||||
size_t uxByteCount )
|
||||
{
|
||||
uint16_t usReturn;
|
||||
|
||||
__CPROVER_assert( __CPROVER_r_ok( pucNextData, uxByteCount ), "Data must be valid" );
|
||||
|
||||
/* Return an indeterminate value. */
|
||||
return usReturn;
|
||||
}
|
||||
|
||||
/* The checksum generation is stubbed out since the actual checksum
|
||||
* does not matter. The stub will return an indeterminate value each time. */
|
||||
uint16_t usGenerateProtocolChecksum( const uint8_t * const pucEthernetBuffer,
|
||||
size_t uxBufferLength,
|
||||
BaseType_t xOutgoingPacket )
|
||||
{
|
||||
uint16_t usReturn;
|
||||
|
||||
__CPROVER_assert( __CPROVER_r_ok( pucEthernetBuffer, uxBufferLength ), "Data must be valid" );
|
||||
|
||||
/* Return an indeterminate value. */
|
||||
return usReturn;
|
||||
}
|
||||
|
||||
/* pxDuplicateNetworkBufferWithDescriptor() is proved separately */
|
||||
NetworkBufferDescriptor_t * pxDuplicateNetworkBufferWithDescriptor( const NetworkBufferDescriptor_t * const pxNetworkBuffer,
|
||||
size_t xNewLength )
|
||||
{
|
||||
NetworkBufferDescriptor_t * pxNetworkBuffer = safeMalloc( sizeof( NetworkBufferDescriptor_t ) );
|
||||
|
||||
if( pxNetworkBuffer != NULL )
|
||||
{
|
||||
pxNetworkBuffer->pucEthernetBuffer = safeMalloc( xNewLength );
|
||||
__CPROVER_assume( pxNetworkBuffer->pucEthernetBuffer != NULL );
|
||||
pxNetworkBuffer->xDataLength = xNewLength;
|
||||
|
||||
pxNetworkBuffer->pxEndPoint = safeMalloc( sizeof( NetworkEndPoint_t ) );
|
||||
__CPROVER_assume( pxNetworkBuffer->pxEndPoint != NULL );
|
||||
}
|
||||
|
||||
return pxNetworkBuffer;
|
||||
}
|
||||
|
||||
/* vReturnEthernetFrame() is proved separately */
|
||||
void vReturnEthernetFrame( NetworkBufferDescriptor_t * pxNetworkBuffer,
|
||||
BaseType_t xReleaseAfterSend )
|
||||
{
|
||||
__CPROVER_assert( pxNetworkBuffer != NULL, "xNetworkBuffer != NULL" );
|
||||
__CPROVER_assert( pxNetworkBuffer->pucEthernetBuffer != NULL, "pxNetworkBuffer->pucEthernetBuffer != NULL" );
|
||||
__CPROVER_assert( __CPROVER_r_ok( pxNetworkBuffer->pucEthernetBuffer, pxNetworkBuffer->xDataLength ), "Data must be valid" );
|
||||
}
|
||||
|
||||
uint32_t parseDNSAnswer( ParseSet_t * pxSet,
|
||||
struct freertos_addrinfo ** ppxAddressInfo,
|
||||
size_t * uxBytesRead )
|
||||
{
|
||||
uint32_t result;
|
||||
|
||||
__CPROVER_assert( __CPROVER_r_ok( pxSet->pucByte, pxSet->uxSourceBytesRemaining ), "Data must be valid" );
|
||||
|
||||
return result;
|
||||
}
|
||||
|
||||
/****************************************************************
|
||||
* Proof of prvParseDNSReply
|
||||
****************************************************************/
|
||||
|
||||
void harness()
|
||||
{
|
||||
size_t uxBufferLength;
|
||||
uint16_t usPort;
|
||||
struct freertos_addrinfo * pxAddressInfo;
|
||||
BaseType_t xExpected;
|
||||
NetworkEndPoint_t * pxNetworkEndPoint_Temp = ( NetworkEndPoint_t * ) safeMalloc( sizeof( NetworkEndPoint_t ) );
|
||||
const uint32_t ulIpv4UdpOffset = 42, ulIpv6UdpOffset = 62;
|
||||
uint8_t * pPayloadBuffer;
|
||||
size_t uxPayloadBufferLength;
|
||||
|
||||
__CPROVER_assume( uxBufferLength <= ipconfigNETWORK_MTU );
|
||||
__CPROVER_assume( pxNetworkEndPoint_Temp != NULL );
|
||||
|
||||
lIsIPv6Packet = IS_TESTING_IPV6;
|
||||
|
||||
if( xBufferAllocFixedSize != pdFALSE )
|
||||
{
|
||||
/* When xBufferAllocFixedSize is true, buffers in all network descriptors
|
||||
* is big enough to allow all Ethernet packet. */
|
||||
xNetworkBuffer.pucEthernetBuffer = safeMalloc( ipconfigNETWORK_MTU + ipSIZE_OF_ETH_HEADER );
|
||||
xNetworkBuffer.xDataLength = uxBufferLength;
|
||||
xNetworkBuffer.pxEndPoint = pxNetworkEndPoint_Temp;
|
||||
}
|
||||
else
|
||||
{
|
||||
xNetworkBuffer.pucEthernetBuffer = safeMalloc( uxBufferLength );
|
||||
xNetworkBuffer.xDataLength = uxBufferLength;
|
||||
xNetworkBuffer.pxEndPoint = pxNetworkEndPoint_Temp;
|
||||
}
|
||||
|
||||
__CPROVER_assume( xNetworkBuffer.pucEthernetBuffer != NULL );
|
||||
|
||||
if( lIsIPv6Packet )
|
||||
{
|
||||
__CPROVER_assume( uxBufferLength >= ulIpv6UdpOffset ); /* 62 is total size of IPv6 UDP header, including ethernet, IPv6, UDP headers. */
|
||||
pPayloadBuffer = xNetworkBuffer.pucEthernetBuffer + ulIpv6UdpOffset;
|
||||
uxPayloadBufferLength = uxBufferLength - ulIpv6UdpOffset;
|
||||
}
|
||||
else
|
||||
{
|
||||
__CPROVER_assume( uxBufferLength >= ulIpv4UdpOffset ); /* 42 is total size of IPv4 UDP header, including ethernet, IPv4, UDP headers. */
|
||||
pPayloadBuffer = xNetworkBuffer.pucEthernetBuffer + ulIpv4UdpOffset;
|
||||
uxPayloadBufferLength = uxBufferLength - ulIpv4UdpOffset;
|
||||
}
|
||||
|
||||
uint32_t index = DNS_ParseDNSReply( pPayloadBuffer,
|
||||
uxPayloadBufferLength,
|
||||
&pxAddressInfo,
|
||||
xExpected,
|
||||
usPort );
|
||||
}
|
||||
+19
@@ -0,0 +1,19 @@
|
||||
{
|
||||
"ENTRY": "ProcessICMPEchoRequest",
|
||||
"CBMCFLAGS": [
|
||||
"--unwind 1",
|
||||
"--nondet-static"
|
||||
],
|
||||
"OPT":
|
||||
[
|
||||
"--export-file-local-symbols"
|
||||
],
|
||||
"OBJS":
|
||||
[
|
||||
"$(ENTRY)_harness.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/test/cbmc/stubs/cbmc.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/source/FreeRTOS_IP.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/source/FreeRTOS_ICMP.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/test/FreeRTOS-Kernel/tasks.goto"
|
||||
]
|
||||
}
|
||||
+84
@@ -0,0 +1,84 @@
|
||||
/*
|
||||
* FreeRTOS memory safety proofs with CBMC.
|
||||
* Copyright (C) 2022 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.
|
||||
*
|
||||
* http://aws.amazon.com/freertos
|
||||
* http://www.FreeRTOS.org
|
||||
*/
|
||||
|
||||
#include <stdint.h>
|
||||
|
||||
/* FreeRTOS includes. */
|
||||
#include "FreeRTOS.h"
|
||||
#include "task.h"
|
||||
|
||||
/* FreeRTOS+TCP includes. */
|
||||
#include "FreeRTOS_IP.h"
|
||||
#include "FreeRTOS_IP_Private.h"
|
||||
|
||||
/* CBMC includes. */
|
||||
#include "cbmc.h"
|
||||
|
||||
/* We do not need to calculate the actual checksum for the proof to be complete.
|
||||
* Neither does the checksum matter for completeness. */
|
||||
uint16_t usGenerateChecksum( uint16_t usSum,
|
||||
const uint8_t * pucNextData,
|
||||
size_t uxByteCount )
|
||||
{
|
||||
__CPROVER_assert( pucNextData != NULL, "Next data in GenerateChecksum cannot be NULL" );
|
||||
|
||||
uint16_t usChecksum;
|
||||
|
||||
/* Return any random value of checksum since it does not matter for CBMC checks. */
|
||||
return usChecksum;
|
||||
}
|
||||
|
||||
/* We do not need to calculate the actual checksum for the proof to be complete.
|
||||
* Neither does the checksum matter for completeness. */
|
||||
uint16_t usGenerateProtocolChecksum( const uint8_t * const pucEthernetBuffer,
|
||||
size_t uxBufferLength,
|
||||
BaseType_t xOutgoingPacket )
|
||||
{
|
||||
__CPROVER_assert( pucEthernetBuffer != NULL, "The Ethernet buffer cannot be NULL while generating Protocol Checksum" );
|
||||
uint16_t usProtocolChecksum;
|
||||
|
||||
/* Return random value of checksum since it does not matter for CBMC checks. */
|
||||
return usProtocolChecksum;
|
||||
}
|
||||
|
||||
eFrameProcessingResult_t __CPROVER_file_local_FreeRTOS_ICMP_c_prvProcessICMPEchoRequest( ICMPPacket_t * const pxICMPPacket,
|
||||
const NetworkBufferDescriptor_t * const pxNetworkBuffer );
|
||||
|
||||
void harness()
|
||||
{
|
||||
NetworkBufferDescriptor_t xNetworkBuffer;
|
||||
|
||||
ICMPPacket_t * pxICMPPacket = safeMalloc( sizeof( ICMPPacket_t ) );
|
||||
|
||||
__CPROVER_assume( pxICMPPacket != NULL );
|
||||
|
||||
xNetworkBuffer.xDataLength = sizeof( ICMPPacket_t );
|
||||
xNetworkBuffer.pucEthernetBuffer = pxICMPPacket;
|
||||
|
||||
__CPROVER_file_local_FreeRTOS_ICMP_c_prvProcessICMPEchoRequest( pxICMPPacket, &xNetworkBuffer );
|
||||
}
|
||||
+18
@@ -0,0 +1,18 @@
|
||||
{
|
||||
"ENTRY": "ProcessICMPPacket",
|
||||
"CBMCFLAGS": [
|
||||
"--unwind 1",
|
||||
"--nondet-static"
|
||||
],
|
||||
"OPT":
|
||||
[
|
||||
"--export-file-local-symbols"
|
||||
],
|
||||
"OBJS":
|
||||
[
|
||||
"$(ENTRY)_harness.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/test/cbmc/stubs/cbmc.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/source/FreeRTOS_ICMP.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/test/FreeRTOS-Kernel/tasks.goto"
|
||||
]
|
||||
}
|
||||
+70
@@ -0,0 +1,70 @@
|
||||
/*
|
||||
* FreeRTOS memory safety proofs with CBMC.
|
||||
* Copyright (C) 2022 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.
|
||||
*
|
||||
* http://aws.amazon.com/freertos
|
||||
* http://www.FreeRTOS.org
|
||||
*/
|
||||
|
||||
#include <stdint.h>
|
||||
|
||||
/* FreeRTOS includes. */
|
||||
#include "FreeRTOS.h"
|
||||
#include "task.h"
|
||||
|
||||
/* FreeRTOS+TCP includes. */
|
||||
#include "FreeRTOS_IP.h"
|
||||
#include "FreeRTOS_ICMP.h"
|
||||
#include "FreeRTOS_IP_Private.h"
|
||||
|
||||
/* CBMC includes. */
|
||||
#include "cbmc.h"
|
||||
|
||||
/* prvProcessICMPEchoRequest() is proved separately */
|
||||
eFrameProcessingResult_t __CPROVER_file_local_FreeRTOS_ICMP_c_prvProcessICMPEchoRequest( ICMPPacket_t * const pxICMPPacket,
|
||||
const NetworkBufferDescriptor_t * const pxNetworkBuffer )
|
||||
{
|
||||
eFrameProcessingResult_t eReturn;
|
||||
|
||||
/* Make sure prvProcessICMPEchoRequest() is never called with or
|
||||
* pxNetworkBuffer being NULL */
|
||||
__CPROVER_assert( pxICMPPacket != NULL, "pxICMPPacket != NULL" );
|
||||
__CPROVER_assert( pxNetworkBuffer != NULL, "pxNetworkBuffer != NULL" );
|
||||
|
||||
return eReturn;
|
||||
}
|
||||
|
||||
void harness()
|
||||
{
|
||||
NetworkBufferDescriptor_t xNetworkBuffer;
|
||||
|
||||
/* Allocate a ICMP packet */
|
||||
ICMPPacket_t * const pxICMPPacket = safeMalloc( sizeof( ICMPPacket_t ) );
|
||||
|
||||
__CPROVER_assume( pxICMPPacket != NULL );
|
||||
|
||||
xNetworkBuffer.xDataLength = sizeof( ICMPPacket_t );
|
||||
xNetworkBuffer.pucEthernetBuffer = pxICMPPacket;
|
||||
|
||||
ProcessICMPPacket( &xNetworkBuffer );
|
||||
}
|
||||
+66
@@ -0,0 +1,66 @@
|
||||
/*
|
||||
* FreeRTOS memory safety proofs with CBMC.
|
||||
* Copyright (C) 2022 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.
|
||||
*
|
||||
* http://aws.amazon.com/freertos
|
||||
* http://www.FreeRTOS.org
|
||||
*/
|
||||
|
||||
#include <stdint.h>
|
||||
|
||||
/* FreeRTOS includes. */
|
||||
#include "FreeRTOS.h"
|
||||
#include "task.h"
|
||||
|
||||
/* FreeRTOS+TCP includes. */
|
||||
#include "FreeRTOS_IP.h"
|
||||
#include "FreeRTOS_IP_Private.h"
|
||||
|
||||
#include "cbmc.h"
|
||||
|
||||
/* Abstraction of FreeRTOS_FindEndPointOnMAC */
|
||||
NetworkEndPoint_t * FreeRTOS_FindEndPointOnMAC( const MACAddress_t * pxMACAddress,
|
||||
const NetworkInterface_t * pxInterface )
|
||||
{
|
||||
NetworkEndPoint_t * pxEndPoint;
|
||||
|
||||
__CPROVER_assert( pxMACAddress != NULL, "pxMACAddress != NULL" );
|
||||
|
||||
/* pxInterface can be NULL. */
|
||||
|
||||
pxEndPoint = safeMalloc( sizeof( pxEndPoint ) );
|
||||
|
||||
return pxEndPoint;
|
||||
}
|
||||
|
||||
/* The harness test proceeds to call eConsiderFrameForProcessing with an unconstrained buffer */
|
||||
void harness()
|
||||
{
|
||||
BaseType_t uBuffSize;
|
||||
|
||||
/* Assume minimum and maximum buffer size expected */
|
||||
__CPROVER_assume( uBuffSize >= sizeof( EthernetHeader_t ) && uBuffSize < ipconfigNETWORK_MTU );
|
||||
const uint8_t * const pucEthernetBuffer = safeMalloc( uBuffSize );
|
||||
|
||||
eConsiderFrameForProcessing( pucEthernetBuffer );
|
||||
}
|
||||
+18
@@ -0,0 +1,18 @@
|
||||
{
|
||||
"ENTRY": "ConsiderFrameForProcessing",
|
||||
"CBMCFLAGS": [
|
||||
"--unwind 1",
|
||||
"--unwindset memcmp.0:7",
|
||||
"--nondet-static"
|
||||
],
|
||||
"OPT":
|
||||
[
|
||||
"--export-file-local-symbols"
|
||||
],
|
||||
"OBJS":
|
||||
[
|
||||
"$(ENTRY)_harness.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/test/cbmc/stubs/cbmc.goto",
|
||||
"$(FREERTOS_PLUS_TCP)/source/FreeRTOS_IP.goto"
|
||||
]
|
||||
}
|
||||
+88
@@ -0,0 +1,88 @@
|
||||
/*
|
||||
* FreeRTOS memory safety proofs with CBMC.
|
||||
* Copyright (C) 2022 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.
|
||||
*
|
||||
* http://aws.amazon.com/freertos
|
||||
* http://www.FreeRTOS.org
|
||||
*/
|
||||
|
||||
#include <stdint.h>
|
||||
|
||||
/* FreeRTOS includes. */
|
||||
#include "FreeRTOS.h"
|
||||
#include "task.h"
|
||||
|
||||
/* FreeRTOS+TCP includes. */
|
||||
#include "FreeRTOS_IP.h"
|
||||
#include "FreeRTOS_IP_Private.h"
|
||||
|
||||
#include "cbmc.h"
|
||||
|
||||
/* Declaration */
|
||||
void __CPROVER_file_local_FreeRTOS_IP_c_prvHandleEthernetPacket( NetworkBufferDescriptor_t * pxBuffer );
|
||||
|
||||
/* Stubs */
|
||||
|
||||
/* ProcessEthernetPacket() is proved else where */
|
||||
void __CPROVER_file_local_FreeRTOS_IP_c_prvProcessEthernetPacket( NetworkBufferDescriptor_t * const pxNetworkBuffer )
|
||||
{
|
||||
__CPROVER_assert( pxNetworkBuffer != NULL, "pxNetworkBuffer != NULL" );
|
||||
__CPROVER_assert( pxNetworkBuffer->pucEthernetBuffer != NULL, "pxNetworkBuffer->pucEthernetBuffer != NULL" );
|
||||
}
|
||||
|
||||
/*We assume that the pxGetNetworkBufferWithDescriptor function is implemented correctly and returns a valid data structure. */
|
||||
/*This is the mock to mimic the correct expected behavior. If this allocation fails, this might invalidate the proof. */
|
||||
NetworkBufferDescriptor_t * pxGetNetworkBufferWithDescriptor( size_t xRequestedSizeBytes,
|
||||
TickType_t xBlockTimeTicks )
|
||||
{
|
||||
NetworkBufferDescriptor_t * pxNetworkBuffer = ( NetworkBufferDescriptor_t * ) safeMalloc( sizeof( NetworkBufferDescriptor_t ) );
|
||||
|
||||
__CPROVER_assume( pxNetworkBuffer != NULL );
|
||||
|
||||
pxNetworkBuffer->pucEthernetBuffer = safeMalloc( xRequestedSizeBytes );
|
||||
__CPROVER_assume( pxNetworkBuffer->pucEthernetBuffer != NULL );
|
||||
|
||||
pxNetworkBuffer->xDataLength = xRequestedSizeBytes;
|
||||
return pxNetworkBuffer;
|
||||
}
|
||||
|
||||
|
||||
/* The harness test proceeds to call eConsiderFrameForProcessing with an unconstrained buffer */
|
||||
void harness()
|
||||
{
|
||||
NetworkBufferDescriptor_t * pxBuffer;
|
||||
NetworkBufferDescriptor_t * pxBufferTemp;
|
||||
TickType_t xBlockTimeTicks;
|
||||
BaseType_t uBuffSize;
|
||||
BaseType_t uIdx;
|
||||
|
||||
/* Assume minimum and maximum buffer size expected */
|
||||
__CPROVER_assume( uBuffSize > 0 && uBuffSize < ipconfigNETWORK_MTU );
|
||||
|
||||
pxBuffer = pxGetNetworkBufferWithDescriptor( uBuffSize, xBlockTimeTicks );
|
||||
pxBuffer->pxNextBuffer = pxGetNetworkBufferWithDescriptor( uBuffSize, xBlockTimeTicks );
|
||||
|
||||
__CPROVER_assume( pxBuffer->pxNextBuffer->pxNextBuffer == NULL );
|
||||
|
||||
__CPROVER_file_local_FreeRTOS_IP_c_prvHandleEthernetPacket( pxBuffer );
|
||||
}
|
||||
Loaded 100 of 1978 files, more files were not shown because too many files have changed in this diff.
Show more
Reference in new issue
Block a user