HMAC function rename for consistency
authorMichael Rash <mbr@cipherdyne.org>
Sat, 30 Mar 2013 00:42:44 +0000 (20:42 -0400)
committerMichael Rash <mbr@cipherdyne.org>
Sat, 30 Mar 2013 00:42:44 +0000 (20:42 -0400)
Make sure that HMAC function names conform to previously established get_*,
set_* naming convention.

client/fwknop.c
lib/fko.h
lib/fko_funcs.c
lib/fko_hmac.c
perl/FKO/FKO.xs
perl/FKO/lib/FKO.pm
python/fko.py
python/fkomodule.c
server/utils.c
test/fko-python.py [new file with mode: 0755]
test/fko-wrapper/fko_wrapper.c

index 8c0a312..9f0aa79 100644 (file)
@@ -1175,7 +1175,7 @@ display_ctx(fko_ctx_t ctx)
     fko_get_spa_encryption_type(ctx, &encryption_type);
     fko_get_spa_encryption_mode(ctx, &encryption_mode);
     fko_get_encoded_data(ctx, &enc_data);
-    fko_get_hmac_data(ctx, &hmac_data);
+    fko_get_spa_hmac(ctx, &hmac_data);
     fko_get_spa_digest(ctx, &spa_digest);
     fko_get_spa_data(ctx, &spa_data);
 
index ded984c..f9bb798 100644 (file)
--- a/lib/fko.h
+++ b/lib/fko.h
@@ -282,9 +282,9 @@ DLL_API int fko_decrypt_spa_data(fko_ctx_t ctx, const char * const dec_key,
     const int dec_key_len);
 DLL_API int fko_verify_hmac(fko_ctx_t ctx, const char * const hmac_key,
     const int hmac_key_len);
-DLL_API int fko_calculate_hmac(fko_ctx_t ctx, const char * const hmac_key,
+DLL_API int fko_set_spa_hmac(fko_ctx_t ctx, const char * const hmac_key,
     const int hmac_key_len);
-DLL_API int fko_get_hmac_data(fko_ctx_t ctx, char **enc_data);
+DLL_API int fko_get_spa_hmac(fko_ctx_t ctx, char **enc_data);
 
 DLL_API int fko_get_encoded_data(fko_ctx_t ctx, char **enc_data);
 
index 72b9992..351ad0f 100644 (file)
@@ -458,7 +458,7 @@ fko_spa_data_final(fko_ctx_t ctx,
     if (res == FKO_SUCCESS &&
             ctx->hmac_type != FKO_HMAC_UNKNOWN && hmac_key != NULL)
     {
-        res = fko_calculate_hmac(ctx, hmac_key, hmac_key_len);
+        res = fko_set_spa_hmac(ctx, hmac_key, hmac_key_len);
 
         if (res == FKO_SUCCESS)
         {
index 4069c4e..aa38561 100644 (file)
@@ -112,7 +112,7 @@ int fko_verify_hmac(fko_ctx_t ctx,
     res = fko_set_spa_hmac_type(ctx, ctx->hmac_type);
     if(res == FKO_SUCCESS)
     {
-        res = fko_calculate_hmac(ctx, hmac_key, hmac_key_len);
+        res = fko_set_spa_hmac(ctx, hmac_key, hmac_key_len);
 
         if(res == FKO_SUCCESS)
         {
@@ -131,7 +131,7 @@ int fko_verify_hmac(fko_ctx_t ctx,
 /* Return the fko HMAC data
 */
 int
-fko_get_hmac_data(fko_ctx_t ctx, char **hmac_data)
+fko_get_spa_hmac(fko_ctx_t ctx, char **hmac_data)
 {
     /* Must be initialized
     */
@@ -178,7 +178,7 @@ fko_get_spa_hmac_type(fko_ctx_t ctx, short *hmac_type)
     return(FKO_SUCCESS);
 }
 
-int fko_calculate_hmac(fko_ctx_t ctx,
+int fko_set_spa_hmac(fko_ctx_t ctx,
     const char * const hmac_key, const int hmac_key_len)
 {
     unsigned char hmac[SHA512_DIGEST_STR_LEN] = {0};
index 7549a6e..5f60ea8 100644 (file)
@@ -393,7 +393,7 @@ _get_spa_hmac(ctx, val)
     fko_ctx_t ctx;
     char *val;
     CODE:
-    RETVAL = fko_get_hmac_data(ctx, &val);
+    RETVAL = fko_get_spa_hmac(ctx, &val);
     OUTPUT:
     val
     RETVAL
@@ -639,13 +639,13 @@ _verify_hmac(ctx, hmac_key, hmac_key_len)
     RETVAL
 
 int
-_calculate_hmac(ctx, hmac_key, hmac_key_len)
+_set_spa_hmac(ctx, hmac_key, hmac_key_len)
     INPUT:
     fko_ctx_t ctx;
     char*   hmac_key;
     int     hmac_key_len;
     CODE:
-    RETVAL = fko_calculate_hmac(ctx, hmac_key, hmac_key_len);
+    RETVAL = fko_set_spa_hmac(ctx, hmac_key, hmac_key_len);
     OUTPUT:
     RETVAL
 
index 0cddf27..0b516b9 100644 (file)
@@ -323,7 +323,7 @@ sub spa_hmac {
 
     my $val = '';
 
-    return FKO::_calculate_hmac($self->{_ctx})
+    return FKO::_set_spa_hmac($self->{_ctx})
         if($recompute and $hmac_key and $hmac_key_len);
 
     $self->{_err} = FKO::_get_spa_hmac($self->{_ctx}, $val);
@@ -518,12 +518,12 @@ sub verify_hmac {
     return FKO::_verify_hmac($self->{_ctx}, $hmac_key, $hmac_key_len)
 }
 
-sub calculate_hmac {
+sub set_spa_hmac {
     my $self         = shift;
     my $hmac_key     = shift || '';
     my $hmac_key_len = shift || 0;
 
-    return FKO::_calculate_hmac($self->{_ctx}, $hmac_key, $hmac_key_len)
+    return FKO::_set_spa_hmac($self->{_ctx}, $hmac_key, $hmac_key_len)
 }
 
 sub DESTROY {
index 3e6a3f0..be3e95b 100644 (file)
@@ -591,15 +591,15 @@ class Fko:
         """
         _fko.verify_hmac(self.ctx, hmac_key)
 
-    def calculate_hmac(self, hmac_key):
+    def set_spa_hmac(self, hmac_key):
         """Calculate the HMAC for the given data
         """
-        _fko.calculate_hmac(self.ctx, hmac_key)
+        _fko.set_spa_hmac(self.ctx, hmac_key)
 
-    def get_hmac_data(self):
+    def get_spa_hmac(self):
         """Return the HMAC for the data in the current context
         """
-        _fko.get_hmac_data(self.ctx)
+        _fko.get_spa_hmac(self.ctx)
 
 
     # GPG-related functions.
index 954b543..c4087e5 100644 (file)
@@ -76,8 +76,8 @@ static PyObject * key_gen(PyObject *self, PyObject *args);
 static PyObject * base64_encode(PyObject *self, PyObject *args);
 static PyObject * base64_decode(PyObject *self, PyObject *args);
 static PyObject * verify_hmac(PyObject *self, PyObject *args);
-static PyObject * calculate_hmac(PyObject *self, PyObject *args);
-static PyObject * get_hmac_data(PyObject *self, PyObject *args);
+static PyObject * set_spa_hmac(PyObject *self, PyObject *args);
+static PyObject * get_spa_hmac(PyObject *self, PyObject *args);
 
 /* FKO GPG-related Functions.
 */
@@ -206,9 +206,9 @@ static PyMethodDef FKOMethods[] = {
      "Base64 decode function"},
     {"verify_hmac", verify_hmac, METH_VARARGS,
      "Generate HMAC for the data and verify it against the HMAC included with the data"},
-    {"calculate_hmac", calculate_hmac, METH_VARARGS,
+    {"set_spa_hmac", set_spa_hmac, METH_VARARGS,
      "Calculate the HMAC for the given data"},
-    {"get_hmac_data", get_hmac_data, METH_VARARGS,
+    {"get_spa_hmac", get_spa_hmac, METH_VARARGS,
      "Return the HMAC for the data in the current context"},
 
     {"get_gpg_recipient",  get_gpg_recipient, METH_VARARGS,
@@ -1330,7 +1330,7 @@ verify_hmac(PyObject *self, PyObject *args)
 }
 
 static PyObject *
-calculate_hmac(PyObject *self, PyObject *args)
+set_spa_hmac(PyObject *self, PyObject *args)
 {
     fko_ctx_t ctx;
     char *hmac_key;
@@ -1340,7 +1340,7 @@ calculate_hmac(PyObject *self, PyObject *args)
     if(!PyArg_ParseTuple(args, "ks#", &ctx, &hmac_key, &hmac_key_len))
         return NULL;
 
-    res = fko_calculate_hmac(ctx, hmac_key, hmac_key_len);
+    res = fko_set_spa_hmac(ctx, hmac_key, hmac_key_len);
 
     if(res != FKO_SUCCESS)
     {
@@ -1352,7 +1352,7 @@ calculate_hmac(PyObject *self, PyObject *args)
 }
 
 static PyObject *
-get_hmac_data(PyObject *self, PyObject *args)
+get_spa_hmac(PyObject *self, PyObject *args)
 {
     fko_ctx_t ctx;
     char *enc_data;
@@ -1361,7 +1361,7 @@ get_hmac_data(PyObject *self, PyObject *args)
     if(!PyArg_ParseTuple(args, "k", &ctx))
         return NULL;
 
-    res = fko_get_hmac_data(ctx, &enc_data);
+    res = fko_get_spa_hmac(ctx, &enc_data);
 
     if(res != FKO_SUCCESS)
     {
index 9a05d2c..3a6e2ff 100644 (file)
@@ -115,7 +115,7 @@ dump_ctx(fko_ctx_t ctx)
     fko_get_spa_encryption_type(ctx, &encryption_type);
     fko_get_spa_encryption_mode(ctx, &encryption_mode);
     fko_get_encoded_data(ctx, &enc_data);
-    fko_get_hmac_data(ctx, &hmac_data);
+    fko_get_spa_hmac(ctx, &hmac_data);
     fko_get_spa_digest(ctx, &spa_digest);
     fko_get_spa_data(ctx, &spa_data);
 
diff --git a/test/fko-python.py b/test/fko-python.py
new file mode 100755 (executable)
index 0000000..096a20a
--- /dev/null
@@ -0,0 +1,37 @@
+#!/usr/bin/python
+
+#
+# Import the Fko class and all constants.
+#
+from fko import *
+
+# Create an Fko instance with an empty context.
+#
+fko = Fko()
+
+fko.hmac_type(FKO_HMAC_SHA512)
+
+# Set the SPA message (Note: Access request is default if not specified).
+#
+fko.spa_message("0.0.0.0,tcp/22")
+
+# Create the final SPA data message string.
+#
+fko.spa_data_final("testtest", "blah")
+
+# print the spa message.
+#
+print fko.spa_data()
+
+# Print some of the data:
+#
+print "Version:", fko.version()
+print "Timestamp:", fko.timestamp()
+print "Username:", fko.username()
+print "Digest Type (value):", fko.digest_type()
+print "Digest Type (string):", fko.digest_type_str()
+print "Digest:", fko.spa_digest()
+print "HMAC Type (value):", fko.hmac_type()
+print "HMAC Type (string):", fko.hmac_type_str()
+print "HMAC:", fko.get_spa_hmac()
+print "SPA Message:", fko.spa_message()
index fe88bff..2b71015 100644 (file)
@@ -166,7 +166,7 @@ display_ctx(fko_ctx_t ctx)
     fko_get_spa_hmac_type(ctx, &hmac_type);
     fko_get_spa_encryption_mode(ctx, &encryption_mode);
     fko_get_encoded_data(ctx, &enc_data);
-    fko_get_hmac_data(ctx, &hmac_data);
+    fko_get_spa_hmac(ctx, &hmac_data);
     fko_get_spa_digest(ctx, &spa_digest);
     fko_get_spa_data(ctx, &spa_data);