Merge pull request #11 from bigbrett/demo-examples

Demo examples

.clang-format

@@ -0,0 +1,98 @@
+---
+Language:        Cpp
+AccessModifierOffset: -2
+AlignAfterOpenBracket: Align
+AlignConsecutiveAssignments: true
+AlignConsecutiveDeclarations: true
+AlignEscapedNewlinesLeft: true
+AlignOperands:   true
+AlignTrailingComments: true
+AllowAllParametersOfDeclarationOnNextLine: false
+AllowShortBlocksOnASingleLine: false
+AllowShortCaseLabelsOnASingleLine: false
+AllowShortFunctionsOnASingleLine: Empty
+AllowShortIfStatementsOnASingleLine: false
+AllowShortLoopsOnASingleLine: false
+AlwaysBreakAfterDefinitionReturnType: None
+AlwaysBreakAfterReturnType: None
+AlwaysBreakBeforeMultilineStrings: false
+AlwaysBreakTemplateDeclarations: true
+BinPackArguments: 'true'
+BinPackParameters: 'true'
+BraceWrapping:  
+  AfterCaseLabel:  false
+  AfterClass:      false
+  AfterControlStatement: Never
+  AfterEnum:       false
+  AfterFunction:   true
+  AfterNamespace:  false
+  AfterObjCDeclaration: false
+  AfterStruct:     false
+  AfterUnion:      false
+  AfterExternBlock: false
+  BeforeCatch:     false
+  BeforeElse:      true
+  BeforeLambdaBody: false
+  BeforeWhile:     false
+  IndentBraces:    false
+BreakBeforeBinaryOperators: None
+BreakBeforeBraces: Custom
+BreakBeforeTernaryOperators: true
+BreakConstructorInitializersBeforeComma: false
+BreakAfterJavaFieldAnnotations: false
+BreakStringLiterals: true
+ColumnLimit: 80 
+CommentPragmas:  '^ IWYU pragma:'
+ConstructorInitializerAllOnOneLineOrOnePerLine: false
+ConstructorInitializerIndentWidth: 4
+ContinuationIndentWidth: 4
+Cpp11BracedListStyle: true
+DerivePointerAlignment: false
+DisableFormat:   false
+ExperimentalAutoDetectBinPacking: false
+ForEachMacros:   [ foreach, Q_FOREACH, BOOST_FOREACH ]
+IncludeCategories:
+  - Regex:           '^"(llvm|llvm-c|clang|clang-c)/'
+    Priority:        2
+  - Regex:           '^(<|"(gtest|isl|json)/)'
+    Priority:        3
+  - Regex:           '.*'
+    Priority:        1
+IncludeIsMainRegex: '$'
+IndentCaseLabels: true 
+IndentWidth:     4
+IndentWrappedFunctionNames: false
+JavaScriptQuotes: Leave
+JavaScriptWrapImports: true
+KeepEmptyLinesAtTheStartOfBlocks: true
+MacroBlockBegin: ''
+MacroBlockEnd:   ''
+MaxEmptyLinesToKeep: 2
+NamespaceIndentation: None
+ObjCBlockIndentWidth: 2
+ObjCSpaceAfterProperty: false
+ObjCSpaceBeforeProtocolList: true
+PenaltyBreakBeforeFirstCallParameter: 19
+PenaltyBreakComment: 300
+PenaltyBreakFirstLessLess: 120
+PenaltyBreakString: 1000
+PenaltyExcessCharacter: 1000000
+PenaltyReturnTypeOnItsOwnLine: 60
+PointerAlignment: Left
+ReflowComments:  true
+SortIncludes:   false
+SpaceAfterCStyleCast: false
+SpaceAfterTemplateKeyword: true
+SpaceBeforeAssignmentOperators: true
+SpaceBeforeParens: ControlStatements
+SpaceInEmptyParentheses: false
+SpacesBeforeTrailingComments: 1
+SpacesInAngles:  false
+SpacesInContainerLiterals: true
+SpacesInCStyleCastParentheses: false
+SpacesInParentheses: false
+SpacesInSquareBrackets: false
+Standard:        Cpp11
+TabWidth:        4
+UseTab:          Never
+---

README.md

@@ -1,5 +1,10 @@
 # wolfHSM-examples
 
+This repository contains examples code demonstrating how to use various wolfHSM features. The examples provided are split between port-agnostic demo code, and port-specific server/client applications that use the aformentioned demo code.
+
+- `demo/`: port-agnostic demonstration code (`demo/`). This code is intended to be used as a reference for how to use wolfHSM features, and are organized by high-level wolfHSM feature.
+- `port/`: Example server and client applications for each port. These applications initialize the server and client context and then run the demo code.
+
 ## Current Examples
 Currently, the only public example for wolfHSM uses the POSIX simulator. If you are interested in examples for NDA-restricted hardware platforms, please contact us at support@wolfssl.com.
 

demo/client/wh_demo_client_all.c

@@ -0,0 +1,30 @@
+#include "wh_demo_client_all.h"
+#include "wh_demo_client_nvm.h"
+#include "wh_demo_client_keystore.h"
+
+int wh_DemoClient_All(whClientContext* clientContext)
+{
+    int rc = 0;
+
+    /* NVM demos */
+    rc = wh_DemoClient_Nvm(clientContext);
+    if (rc != 0) {
+        return rc;
+    }
+
+    /* Keystore demos */
+    rc = wh_DemoClient_KeystoreBasic(clientContext);
+    if (rc != 0) {
+        return rc;
+    }
+    rc = wh_DemoClient_KeystoreCommitKey(clientContext);
+    if (rc != 0) {
+        return rc;
+    }
+    rc = wh_DemoClient_KeystoreAes(clientContext);
+    if (rc != 0) {
+        return rc;
+    }
+
+    return rc;
+}

demo/client/wh_demo_client_all.h

@@ -0,0 +1,8 @@
+#ifndef CLIENT_DEMO_DRIVER_H_
+#define CLIENT_DEMO_DRIVER_H_
+
+#include "wolfhsm/wh_client.h"
+
+int wh_DemoClient_All(whClientContext* clientContext);
+
+#endif /* CLIENT_DEMO_DRIVER_H_ */

demo/client/wh_demo_client_counter.c

@@ -0,0 +1,7 @@
+#include "wh_demo_client_counter.h"
+#include "wolfhsm/wh_error.h"
+
+int wh_DemoClient_Counter(whClientContext* clientContext)
+{
+    return WH_ERROR_OK;
+}

demo/client/wh_demo_client_counter.h

@@ -0,0 +1,7 @@
+#ifndef CLIENT_COUNTER_H
+#define CLIENT_COUNTER_H
+#include "wolfhsm/wh_client.h"
+
+int wh_DemoClient_Counter(whClientContext* clientContext);
+
+#endif /* CLIENT_COUNTER_H */

demo/client/wh_demo_client_crypto.c

@@ -0,0 +1,7 @@
+#include "wh_demo_client_crypto.h"
+#include "wolfhsm/wh_error.h"
+
+int wh_DemoClient_Crypto(whClientContext* clientContext);
+{
+    return WH_ERROR_OK;
+}

demo/client/wh_demo_client_crypto.h

@@ -0,0 +1,7 @@
+#ifndef CLIENT_CRYPTO_H_
+#define CLIENT_CRYPTO_H_
+#include "wolfhsm/wh_client.h"
+
+int wh_DemoClient_Crypto(whClientContext* clientContext);
+
+#endif /* CLIENT_CRYPTO_H_ */