Add libotp internal library for slapi plugins

1 files changed, 95 insertions, 0 deletions

diff --git a/daemons/ipa-slapi-plugins/libotp/libotp.h b/daemons/ipa-slapi-plugins/libotp/libotp.h
new file mode 100644
index 000000000..7ed729337
--- /dev/null
+++ b/daemons/ipa-slapi-plugins/libotp/libotp.h
@@ -0,0 +1,95 @@
+/** BEGIN COPYRIGHT BLOCK
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program 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 License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * Additional permission under GPLv3 section 7:
+ *
+ * In the following paragraph, "GPL" means the GNU General Public
+ * License, version 3 or any later version, and "Non-GPL Code" means
+ * code that is governed neither by the GPL nor a license
+ * compatible with the GPL.
+ *
+ * You may link the code of this Program with Non-GPL Code and convey
+ * linked combinations including the two, provided that such Non-GPL
+ * Code only links to the code of this Program through those well
+ * defined interfaces identified in the file named EXCEPTION found in
+ * the source code files (the "Approved Interfaces"). The files of
+ * Non-GPL Code may instantiate templates or use macros or inline
+ * functions from the Approved Interfaces without causing the resulting
+ * work to be covered by the GPL. Only the copyright holders of this
+ * Program may make changes or additions to the list of Approved
+ * Interfaces.
+ *
+ * Authors:
+ * Nathaniel McCallum <npmccallum@redhat.com>
+ *
+ * Copyright (C) 2013 Red Hat, Inc.
+ * All rights reserved.
+ * END COPYRIGHT BLOCK **/
+
+#ifndef LIBOTP_H_
+#define LIBOTP_H_
+
+#ifdef HAVE_CONFIG_H
+#  include <config.h>
+#endif
+
+#include <dirsrv/slapi-plugin.h>
+#include <stdbool.h>
+#include <stdlib.h>
+
+struct otptoken;
+
+/* Frees the token array. */
+void otptoken_free_array(struct otptoken **tokens);
+
+/* Find tokens.
+ *
+ * All criteria below are cumulative. For example, if you specify both dn and
+ * active and the token at the dn specified isn't active, an empty array will
+ * be returned.
+ *
+ * If user_dn is not NULL, the user's tokens are returned.
+ *
+ * If token_dn is not NULL, only this specified token is returned.
+ *
+ * If active is true, only tokens that are active are returned.
+ *
+ * If filter is not NULL, the filter will be added to the search criteria.
+ *
+ * Returns NULL on error. If no tokens are found, an empty array is returned.
+ * The array is NULL terminated.
+ */
+struct otptoken **otptoken_find(Slapi_ComponentId *id, const char *user_dn,
+                                const char *token_dn, bool active,
+                                const char *filter);
+
+/* Get the length of the token code. */
+int otptoken_get_digits(struct otptoken *token);
+
+/* Get the SDN of the token. */
+const Slapi_DN *otptoken_get_sdn(struct otptoken *token);
+
+/* Validate the token code within a range of steps. */
+bool otptoken_validate(struct otptoken *token, size_t steps, uint32_t code);
+
+/* Validate the token code within a range of steps. If tail is true,
+ * it will be assumed that the token is specified at the end of the string. */
+bool otptoken_validate_string(struct otptoken *token, size_t steps,
+                       const char *code, ssize_t len, bool tail);
+
+/* Synchronize the token within a range of steps. */
+bool otptoken_sync(struct otptoken * const *tokens, size_t steps,
+                   uint32_t first_code, uint32_t second_code);
+
+#endif /* LIBOTP_H_ */