From ec688b4723a041044226358bcd4dd6e2da39da49 Mon Sep 17 00:00:00 2001
From: Luca Muscariello <lumuscar+fdio@cisco.com>
Date: Thu, 23 Feb 2017 17:01:02 +0100
Subject: Initial commit: cframework. Longbow and Libparc

Change-Id: I90378dbd30da6033b20fb1f829b3b822cf366c59
Signed-off-by: Luca Muscariello <lumuscar+fdio@cisco.com>
---
 libparc/parc/security/parc_Security.h | 89 +++++++++++++++++++++++++++++++++++
 1 file changed, 89 insertions(+)
 create mode 100755 libparc/parc/security/parc_Security.h

(limited to 'libparc/parc/security/parc_Security.h')

diff --git a/libparc/parc/security/parc_Security.h b/libparc/parc/security/parc_Security.h
new file mode 100755
index 00000000..2c20496b
--- /dev/null
+++ b/libparc/parc/security/parc_Security.h
@@ -0,0 +1,89 @@
+/*
+ * Copyright (c) 2017 Cisco and/or its affiliates.
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at:
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * @file parc_Security.h
+ * @ingroup security
+ * @brief PARC Security Library framework director.
+ *
+ */
+#ifndef libparc_parc_Security_h
+#define libparc_parc_Security_h
+
+#include <stdbool.h>
+
+/**
+ * Initialise the PARC Security framework.
+ *
+ * This function may be called multiple times,
+ * each time incrementing a reference count that is decremented by calls to `parcSecurityFini`.
+ *
+ * Example:
+ * @code
+ * {
+ *     parcSecurity_Init();
+ * }
+ * @endcode
+ *
+ * @see parcSecurity_Fini
+ */
+void parcSecurity_Init(void);
+
+/**
+ * Deinitialise the PARC Security framework.
+ *
+ * Example:
+ * @code
+ * {
+ *     parcSecurity_Fini();
+ * }
+ * @endcode
+ *
+ * @see parcSecurity_Init
+ */
+void parcSecurity_Fini(void);
+
+/**
+ * Assert that the PARC Security Framework is initalised.
+ *
+ * Example:
+ * @code
+ * {
+ *     parcSecurity_AssertIsInitialized();
+ *
+ * }
+ * @endcode
+ *
+ * @see parcSecurity_Init
+ */
+void parcSecurity_AssertIsInitialized(void);
+
+/**
+ * Determine if the PARC Security Framework is initalised.
+ *
+ * @return True if the PARC Security Framework is initalised.
+ * @return False otherwise
+ *
+ * Example:
+ * @code
+ * {
+ *     parcSecurity_IsInitialized();
+ * }
+ * @endcode
+ *
+ * @see parcSecurity_Init
+ */
+bool parcSecurity_IsInitialized(void);
+#endif // libparc_parc_Security_h
-- 
cgit 1.2.3-korg