Merge pull request #7296 from JacobBarthelmeh/autosar

initial AutoSAR shim layer

Author: SparkiDev

configure.ac

@@ -7932,6 +7932,19 @@ else
 fi
 
 
+# Support for autosar shim
+AC_ARG_ENABLE([autosar],
+    [AS_HELP_STRING([--enable-autosar],[Enable AutoSAR support (default: disabled)])],
+    [ ENABLED_AUTOSAR=$enableval ],
+    [ ENABLED_AUTOSAR=no ]
+    )
+
+if test "$ENABLED_AUTOSAR" = "yes"
+then
+    AM_CFLAGS="$AM_CFLAGS -DWOLFSSL_AUTOSAR"
+fi
+
+
 # Session Export
 AC_ARG_ENABLE([sessionexport],
     [AS_HELP_STRING([--enable-sessionexport],[Enable export and import of sessions (default: disabled)])],
@@ -9177,6 +9190,7 @@ AM_CONDITIONAL([BUILD_DTLS],[test "x$ENABLED_DTLS" = "xyes" || test "x$ENABLED_U
 AM_CONDITIONAL([BUILD_MAXQ10XX],[test "x$ENABLED_MAXQ10XX" = "xyes"])
 AM_CONDITIONAL([BUILD_ARIA],[test "x$ENABLED_ARIA" = "xyes"])
 AM_CONDITIONAL([BUILD_XILINX],[test "x$ENABLED_XILINX" = "xyes"])
+AM_CONDITIONAL([BUILD_AUTOSAR],[test "x$ENABLED_AUTOSAR" = "xyes"])
 
 if test "$ENABLED_REPRODUCIBLE_BUILD" != "yes" &&
    (test "$ax_enable_debug" = "yes" ||
@@ -9668,6 +9682,7 @@ echo "   * Dual alg cert support:      $ENABLED_DUAL_ALG_CERTS"
 echo "   * ERR Queues per Thread:      $ENABLED_ERRORQUEUEPERTHREAD"
 echo "   * rwlock:                     $ENABLED_RWLOCK"
 echo "   * keylog export:              $ENABLED_KEYLOG_EXPORT"
+echo "   * AutoSAR :                   $ENABLED_AUTOSAR"
 echo ""
 echo "---"
 

wolfcrypt/src/include.am

@@ -214,3 +214,6 @@ if BUILD_MAXQ10XX
 src_libwolfssl@LIBSUFFIX@_la_SOURCES += wolfcrypt/src/port/maxim/maxq10xx.c
 endif
 EXTRA_DIST += wolfcrypt/src/port/maxim/README.md
+
+include wolfcrypt/src/port/autosar/include.am
+

wolfcrypt/src/port/autosar/README.md

@@ -0,0 +1,45 @@
+## 1.0 Intro To Using wolfSSL with AutoSAR
+
+This readme covers building and using wolfSSL for AutoSAR applications. Currently AES-CBC and RNG are supported. The version of AutoSAR used for reference was 4.4. Currently there is no asynchronous support.
+
+
+## 2.0 Building wolfSSL
+
+### 2.1 wolfSSL Library
+To enable the use of AutoSAR with wolfSSL use the enable option --enable-autosar. In example “./configure --eanble-autosar”. If building without autotools then the macro WOLFSSL_AUTOSAR should be defined. This is usually defined in a user_settings.h file which gets included to the wolfSSL build when the macro WOLFSSL_USER_SETTINGS is defined.
+
+
+### 2.2 Key Redirection
+By default the next available key with the same key type desired is used. When specific keys are to be used then key input redirection is needed. This is done at compile time with setting specific macros. An example of key redirection would be as follows :
+
+/* set redirection of primary and secondary */
+#define REDIRECTION_CONFIG 0x03
+
+/* set primary key to keyId of 1 and element type CRYPTO_KE_CIPHER_KEY */
+#define REDIRECTION_IN1_KEYID 1
+#define REDIRECTION_IN1_KEYELMID 0x01
+
+
+/* set secondary key to keyId of 4 and element type CRYPTO_KE_CIPHER_IV */
+#define REDIRECTION_IN2_KEYID 4
+#define REDIRECTION_IN2_KEYELMID 0x05
+
+
+## 3.0 example
+
+There is an example test case located at wolfcrypt/src/port/autsar/example.c. After compiling with autotools (./configure --enable-autsar && make) the example can be ran by running the command ./wolfcrypt/src/port/autsar/example.test
+
+## 4.0 API Implemented
+
+- Std_ReturnType Csm_Decrypt(uint32 jobId,                            
+         Crypto_OperationModeType mode, const uint8* dataPtr, uint32 dataLength, 
+         uint8* resultPtr, uint32* resultLengthPtr);                             
+- Std_ReturnType Csm_Encrypt(uint32 jobId,                            
+         Crypto_OperationModeType mode, const uint8* dataPtr, uint32 dataLength, 
+         uint8* resultPtr, uint32* resultLengthPtr);                             
+- Std_ReturnType Csm_KeyElementSet(uint32 keyId, uint32 keyElementId, 
+         const uint8* keyPtr, uint32 keyLength);                                 
+- Std_ReturnType Csm_RandomGenerate( uint32 jobId, uint8* resultPtr,  
+         uint32* resultLengthPtr);
+
+Along with the structures necessary for these API.

wolfcrypt/src/port/autosar/cryif.c

@@ -0,0 +1,103 @@
+/* cryif.c
+ *
+ * Copyright (C) 2006-2024 wolfSSL Inc.
+ *
+ * This file is part of wolfSSL.
+ *
+ * wolfSSL is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * wolfSSL is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1335, USA
+ */
+
+/* AutoSAR 4.4 */
+/* shim layer for use of wolfSSL crypto driver */
+
+
+#ifdef HAVE_CONFIG_H
+    #include <config.h>
+#endif
+
+#include <wolfssl/wolfcrypt/settings.h>
+#include <wolfssl/version.h>
+#include <wolfssl/wolfcrypt/port/autosar/Csm.h>
+#include <wolfssl/wolfcrypt/port/autosar/CryIf.h>
+#include <wolfssl/wolfcrypt/port/autosar/Crypto.h>
+
+#ifdef WOLFSSL_AUTOSAR
+#ifndef NO_WOLFSSL_AUTOSAR_CRYIF
+
+#include <wolfssl/wolfcrypt/logging.h>
+
+/* initialization function */
+void CryIf_Init(const CryIf_ConfigType* in)
+{
+    (void)in;
+    Crypto_Init(NULL);
+}
+
+
+void CryIf_GetVersionInfo(Std_VersionInfoType* ver)
+{
+    if (ver != NULL) {
+        ver->vendorID = 0; /* no vendor or module ID */
+        ver->moduleID = 0;
+        ver->sw_major_version = (LIBWOLFSSL_VERSION_HEX >> 24) & 0xFFF;
+        ver->sw_minor_version = (LIBWOLFSSL_VERSION_HEX >> 12) & 0xFFF;
+        ver->sw_patch_version = (LIBWOLFSSL_VERSION_HEX) & 0xFFF;
+    }
+}
+
+
+/* returns E_OK on success */
+Std_ReturnType CryIf_ProcessJob(uint32 id, Crypto_JobType* job)
+{
+    WOLFSSL_ENTER("CryIf_ProcessJob");
+    if (job == NULL) {
+        return E_NOT_OK;
+    }
+
+    /* only handle synchronous jobs */
+    if (job->jobPrimitiveInfo->processingType != CRYPTO_PROCESSING_SYNC) {
+        WOLFSSL_MSG("Crypto Interface only supporting synchronous jobs");
+        return E_NOT_OK;
+    }
+
+    return Crypto_ProcessJob(id, job);
+}
+
+
+/* not implemented yet since async not supported */
+Std_ReturnType CryIf_CancelJob(uint32 id, Crypto_JobType* job)
+{
+    (void)id;
+    (void)job;
+    WOLFSSL_STUB("CryIf_CancelJob");
+
+    return E_NOT_OK;
+}
+
+
+/* return E_OK on success */
+Std_ReturnType CryIf_KeyElementSet(uint32 keyId, uint32 eId, const uint8* key,
+        uint32 keySz)
+{
+    if (key == NULL || keySz == 0) {
+        /* report CRYIF_E_PARAM_POINTER to the DET */
+        return E_NOT_OK;
+    }
+
+    return Crypto_KeyElementSet(keyId, eId, key, keySz);
+}
+#endif /* NO_WOLFSSL_AUTOSAR_CRYIF */
+#endif /* WOLFSSL_AUTOSAR */
+