replace : iotivity -> iotivity-sec

[platform/upstream/iotivity.git] / resource / csdk / security / include / pkix_interface.h

diff --git a/resource/csdk/security/include/pkix_interface.h b/resource/csdk/security/include/pkix_interface.h
index 5af15ce..105fda3 100644 (file)
--- a/resource/csdk/security/include/pkix_interface.h
+++ b/resource/csdk/security/include/pkix_interface.h
@@ -22,10 +22,71 @@
 #define PKIX_INTERFACE_H
 
 #include "cainterface.h"
+#ifdef HW_PKIX
+#include "mbedtls/ssl.h"
+#endif //HW_PKIX
 
 #ifdef __cplusplus
 extern "C" {
 #endif
+
+/**
+ * Pre-Definition for key context
+ */
+// IoTivity service name for HW key context query
+#define HWKEY_SVC_IOTIVITY "iotivity"
+
+// Default usage name for HW key context query
+#define HWKEY_USAGE_PRIMARY "primary"
+
+
+/**
+ * Callback function for HW
+ */
+//this callback will be invoked to get key context based on key usage
+typedef void* (*GetHwKeyContext)(const char* service, const char* usage, const char* keytype);
+
+//this callback will free key context that was retreived from TZ
+typedef int (*FreeHwKeyContext)(void* keyContext);
+
+//this callback will be invoked to load own certificate in case of TZ
+typedef int (*GetOwnCertFromHwCallback)(const void* keyContext, uint8_t** certChain, size_t* certChainLen);
+
+//this callback will be invoked to load private key in case of TZ
+typedef int (*SetupPkContextFromHwCallback)(mbedtls_pk_context* ctx, void* keyContext);
+
+typedef struct HWPkixContext {
+    GetHwKeyContext getHwKeyContext;
+    FreeHwKeyContext freeHwKeyContext;
+    GetOwnCertFromHwCallback getOwnCertCb;
+    SetupPkContextFromHwCallback setupPkContextCb;
+    void* hwKeyCtx;
+}HWPkixContext_t;
+
+/**
+ * API to seting callbacks which is requried to use H/W based PKI
+ *
+ * @param[in] getHwKeyContext callback to get hw key context
+ * @param[in] freeHwKeyContext callback to free hw key context
+ * @param[in] getOwnCertCb callback to load certificate chain
+ * @param[in] setupPkContextCb callback to setup PK context
+ *
+ * return 0 on success
+ */
+int SetHwPkixCallbacks(GetHwKeyContext getHwKeyContext,
+                        FreeHwKeyContext freeHwKeyContext,
+                        GetOwnCertFromHwCallback getOwnCertCb,
+                        SetupPkContextFromHwCallback setupPkContextCb);
+
+/**
+ * API to invoke the callback for setup PK context with H/W based PKI
+ *
+ * @param[in] pkCtx mbedtls's PK context
+ *
+ * return 0 on success
+ */
+int SetupHwPkContext(mbedtls_pk_context* pkCtx);
+
 /**
  * This method is used by mbedTLS/SRM to retrieve PKIX related info
  *