adding skeleton for revocation service

1 files changed, 143 insertions, 0 deletions

diff --git a/src/include/gnunet_revocation_service.h b/src/include/gnunet_revocation_service.h
new file mode 100644
index 000000000..772dbbe75
--- /dev/null
+++ b/src/include/gnunet_revocation_service.h
@@ -0,0 +1,143 @@
+/*
+      This file is part of GNUnet
+      (C) 2013 Christian Grothoff (and other contributing authors)
+
+      GNUnet is free software; you can redistribute it and/or modify
+      it under the terms of the GNU General Public Licerevocation as published
+      by the Free Software Foundation; either version 3, or (at your
+      option) any later version.
+
+      GNUnet is distributed in the hope that it will be useful, but
+      WITHOUT ANY WARRANTY; without even the implied warranty of
+      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+      General Public Licerevocation for more details.
+
+      You should have received a copy of the GNU General Public Licerevocation
+      along with GNUnet; see the file COPYING.  If not, write to the
+      Free Software Foundation, Inc., 59 Temple Place - Suite 330,
+      Boston, MA 02111-1307, USA.
+ */
+
+#ifndef GNUNET_REVOCATION_SERVICE_H_
+#define GNUNET_REVOCATION_SERVICE_H_
+
+/**
+ * @file include/gnunet_revocation_service.h
+ * @brief API to perform and access key revocations
+ * @defgroup revocation key revocation service
+ * @{
+ */
+
+#ifdef __cplusplus
+extern "C"
+{
+#if 0                           /* keep Emacsens' auto-indent happy */
+}
+#endif
+#endif
+
+#include "gnunet_util_lib.h"
+
+/**
+ * Version of the key revocation API.
+ */
+#define GNUNET_REVOCATION_VERSION 0x00000000
+
+/**
+ * Handle for the key revocation query.
+ */
+struct GNUNET_REVOCATION_Query;
+
+/**
+ * Callback to call with the result of a key revocation query.
+ *
+ * @param cls closure
+ * @param is_valid #GNUNET_NO of the key is/was revoked, 
+ *                 #GNUNET_YES if the key is still valid
+ *
+ */
+typedef void (*GNUNET_REVOCATION_Callback) (void *cls,
+                                            int is_valid);
+
+
+/**
+ * Check if a key was revoked.
+ *
+ * @param cfg the configuration to use
+ * @param key key to check for revocation
+ * @param func funtion to call with the result of the check
+ * @param func_cls closure to pass to @a func
+ * @return handle to use in #GNUNET_REVOCATION_query_cancel to stop REVOCATION from invoking the callback
+ */
+struct GNUNET_REVOCATION_Query *
+GNUNET_REVOCATION_query (const struct GNUNET_CONFIGURATION_Handle *cfg,
+                         const struct GNUNET_CRYPTO_EccPublicSignKey *key,
+                         GNUNET_REVOCATION_Callback func, void *func_cls);
+
+
+/**
+ * Cancel key revocation check.
+ *
+ * @param q query to cancel
+ */
+void
+GNUNET_REVOCATION_query_cancel (struct GNUNET_REVOCATION_Query *q);
+
+
+/**
+ * Handle for the key revocation operation.
+ */
+struct GNUNET_REVOCATION_Handle;
+
+
+/**
+ * Perform key revocation.
+ *
+ * @param cfg the configuration to use
+ * @param key key to revoke
+ * @param pow proof of work to use
+ * @param func funtion to call with the result of the check
+ *             (called with `is_valid` being #GNUNET_NO if
+ *              the revocation worked).
+ * @param func_cls closure to pass to @a func
+ * @return handle to use in #GNUNET_REVOCATION_cancel to stop REVOCATION from invoking the callback
+ */
+struct GNUNET_REVOCATION_Handle *
+GNUNET_REVOCATION_revoke (const struct GNUNET_CONFIGURATION_Handle *cfg,
+                          const struct GNUNET_CRYPTO_EccPrivateKey *key,
+                          uint64_t pow,
+                          GNUNET_REVOCATION_Callback func, void *func_cls);
+
+
+/**
+ * Cancel key revocation.
+ *
+ * @param h operation to cancel
+ */
+void
+GNUNET_REVOCATION_revoke_cancel (struct GNUNET_REVOCATION_Handle *h);
+
+
+/**
+ * Check if the given proof-of-work value
+ * would be acceptable for revoking the given key.
+ *
+ * @param key key to check for
+ * @param pow proof of work value
+ * @return #GNUNET_YES if the @a pow is acceptable, #GNUNET_NO if not
+ */
+int
+GNUNET_REVOCATION_check_pow (const struct GNUNET_CRYPTO_EccPublicSignKey *key,
+                             uint64_t pow);
+
+
+#if 0                           /* keep Emacsens' auto-indent happy */
+{
+#endif
+#ifdef __cplusplus
+}
+#endif
+
+/** @} */ /* end of group revocation */
+
+#endif /* GNUNET_REVOCATION_SERVICE_H_ */