Initial commit: cframework. Longbow and Libparc

Change-Id: I90378dbd30da6033b20fb1f829b3b822cf366c59
Signed-off-by: Luca Muscariello <lumuscar+fdio@cisco.com>

1 files changed, 100 insertions, 0 deletions

diff --git a/libparc/parc/security/parc_SigningAlgorithm.h b/libparc/parc/security/parc_SigningAlgorithm.h
new file mode 100644
index 00000000..02f7c946
--- /dev/null
+++ b/libparc/parc/security/parc_SigningAlgorithm.h
@@ -0,0 +1,100 @@
+/*
+ * 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_SigningAlgorithm.h
+ * @ingroup security
+ * @brief This module encapsulates information about the types of available signing algorithms.
+ *
+ * Both asymmetric digital signature algorithms, e.g., RSA and DSA, and symmetric Message Authentication
+ * Codes (MACS), e.g., HMAC, are supported. This module exposes the functionality necessary to map between
+ * enum and human-readable string representations of these algorithms.
+ *
+ */
+#ifndef libparc_parc_SigningAlgorithm_h
+#define libparc_parc_SigningAlgorithm_h
+
+#include <parc/security/parc_CryptoHashType.h>
+#include <parc/security/parc_CryptoSuite.h>
+
+typedef enum {
+    PARCSigningAlgorithm_UNKNOWN = -1,
+    PARCSigningAlgorithm_RSA = 1,
+    PARCSigningAlgorithm_DSA = 2,
+    PARCSigningAlgorithm_HMAC = 3,
+    PARCSigningAlgortihm_NULL = 4,
+} PARCSigningAlgorithm;
+
+/**
+ * Return a human readable string representation of the specified signing algorithm.
+ *
+ * @param [in] algorithm A pointer to a PARCSigningAlgorithm as the target signing algorithm.
+ * @return A static, null-terminated string.
+ *
+ * Example:
+ * @code
+ * {
+ *     PARCSigningAlgorithm alg = PARCSigningAlgorithm_RSA;
+ *     const char *stringRep = parcSigningAlgorithm_ToString(alg);
+ *     // do something with stringRep
+ * }
+ * @endcode
+ *
+ * @see parcSigningAlgorithm_FromString
+ */
+const char *parcSigningAlgorithm_ToString(PARCSigningAlgorithm algorithm);
+
+/**
+ * Get the `PARCSigningAlgorithm` enum from a corresponding human-readable string representation
+ * of a signing algorithm.
+ *
+ * @param [in] name A nul-terminate C-string representation of signing algorithm.
+ * @return A valid `PARCSigningAlgorithm` enum.
+ *
+ * Example:
+ * @code
+ * {
+ *     const char *stringRep = "PARCSigningAlgortihm_NULL";
+ *     PARCSigningAlgorithm alg = parcSigningAlgorithm_FromString(stringRep);
+ *     // do something with alg
+ * }
+ * @endcode
+ *
+ * @see parcSigningAlgorithm_ToString
+ */
+PARCSigningAlgorithm parcSigningAlgorithm_FromString(const char *name);
+
+/**
+ * Get the `PARCSigningAlgorithm` type associated with the specified `PARCCryptoSuite` type.
+ *
+ * PARCCryptoSuite types combine hash and signing algorithms to be used to signature and/or MAC generation.
+ * Therefore, a PARCCryptoSuite type of PARCCryptoSuite_DSA_SHA256, for example, uses the
+ * PARCSigningAlgorithm_DSA type of signing algorithm. This function serves to determine the
+ * signing algorithm type from the suite.
+ *
+ * @param [in] suite The type of cryptographic suite used for signature and/or MAC generation.
+ * @return A valid `PARCSigningAlgorithm` enum associated with the specified `PARCCryptoSuite` type.
+ *
+ * Example:
+ * @code
+ * {
+ *     PARCCryptoSuite suite = PARCCryptoSuite_RSA_SHA256;
+ *     PARCSigningAlgorithm alg = parcSigningAlgorithm_GetSigningAlgorithm(suite);
+ *     // do something with alg
+ * }
+ * @endcode
+ */
+PARCSigningAlgorithm parcSigningAlgorithm_GetSigningAlgorithm(PARCCryptoSuite suite);
+#endif // libparc_parc_SigningAlgorithm_h