Introduce cynara-offline-admin API

cynara-offline-admin is a special administrative API,
which allows to alter Cynara's database directly
on filesystem.

Change-Id: I47365889f2afc05ee8a40aeee5bd3bb1de22dccd

diff --git a/src/include/cynara-offline-admin.h b/src/include/cynara-offline-admin.h
new file mode 100644 (file)
index 0000000..b66d6df
--- /dev/null
+++ b/src/include/cynara-offline-admin.h
@@ -0,0 +1,256 @@
+/**
+ *  Copyright (c) 2014 Samsung Electronics Co., Ltd All Rights Reserved
+ *
+ *  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        cynara-offline-admin.h
+ * \author      Lukasz Wojciechowski <l.wojciechow@partner.samsung.com>
+ * \author      Aleksander Zdyb <a.zdyb@samsung.com>
+ * \version     1.0
+ * \brief       This file contains administration APIs of cynara available
+ *              with libcynara-offline-admin.
+ */
+
+#ifndef CYNARA_OFFLINE_ADMIN_H
+#define CYNARA_OFFLINE_ADMIN_H
+
+#include <cynara-admin-error.h>
+#include <cynara-admin-types.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/**
+ * \name cynara_offline_admin
+ * forward declaration of structure allowing initialization of library
+ * and usage of all libcynara-offline-admin API functions
+ */
+struct cynara_offline_admin;
+
+/**
+ * \par Description:
+ * Initialize cynara-offline-admin library.
+ * Creates structure used in following API calls.
+ *
+ * \par Purpose:
+ * This function must be invoked prior to other admin API calls. It creates structure needed by
+ * other cynara-offline-admin library API functions.
+ *
+ * \par Typical use case:
+ * Once before a service can call other cynara-offline-admin library functions.
+ *
+ * \par Method of function operation:
+ * This API initializes inner library structures and in case of success creates cynara_offline_admin
+ * structure and stores pointer to this structure at memory address passed
+ * in pp_cynara_offline_admin parameter.
+ *
+ * \par Sync (or) Async:
+ * This is a synchronous API.
+ *
+ * \par Important notes:
+ * Structure cynara_offline_admin created by cynara_offline_admin_initialize call should be released
+ * with cynara_offline_admin_finish.
+ *
+ * \param[out] pp_cynara_offline_admin address of pointer for created cynara_offline_admin
+ *             structure.
+ *
+ * \return CYNARA_ADMIN_API_SUCCESS on success, or negative error code otherwise.
+ *
+ * \brief Initialize cynara-offline-admin library.
+ */
+int cynara_offline_admin_initialize(struct cynara_offline_admin **pp_cynara_offline_admin);
+
+/**
+ * \par Description:
+ * Releases cynara-offline-admin library and destroys structure created
+ * with cynara_offline_admin_initialize function.
+ *
+ * \par Purpose:
+ * This API should be used to clean up after usage of cynara-offline-admin library.
+ *
+ * \par Typical use case:
+ * Function should be called once, when done with cynara-offline-admin library API usage.
+ *
+ * \par Method of function operation:
+ * This API releases inner library structures and destroys cynara_offline_admin structure.
+ *
+ * \par Sync (or) Async:
+ * This is a synchronous API.
+ *
+ * \par Important notes:
+ * No invocations of cynara-offline-admin library API functions are allowed after call to
+ * cynara_offline_admin_finish.
+ *
+ * \param[in] p_cynara_offline_admin cynara_offline_admin structure created
+ *            in cynara_offline_admin_initialize.
+ *
+ * \return CYNARA_ADMIN_API_SUCCESS on success, or negative error code otherwise.
+ *
+ * \brief Release cynara-offline-admin library.
+ */
+int cynara_offline_admin_finish(struct cynara_offline_admin *p_cynara_offline_admin);
+
+/**
+ * \par Description:
+ * Manages policies in cynara.
+ *
+ * \par Purpose:
+ * This API should be used to insert, update or delete policies in cynara.
+ *
+ * \par Typical use case:
+ * Enables altering policies by adding, updating or removing records.
+ *
+ * \par Method of function operation:
+ * Policies are arranged into buckets. Every policy is defined in context of some bucket identified
+ * with bucket field (string). A bucket consists of policies identified with tripple: (client, user,
+ * privilege), which is a (unique) key within considered bucket.
+ *
+ * Every policy can be one of two types: simple or bucket-pointing policy.
+ * Simple policies have result field with value of CYNARA_ADMIN_DENY or CYNARA_ADMIN_ALLOW.
+ * result_extra field should be NULL in this case.
+ * Bucket-pointing policies have result field with value of CYNARA_ADMIN_BUCKET and name of bucket
+ * they point to in result_extra field.
+ *
+ * Type of operation, which is run for every record (single policy) is defined by result field in
+ * cynara_admin_policy structure.
+ * In case of CYNARA_ADMIN_DENY or CYNARA_ADMIN_ALLOW a simple policy is updated or inserted into
+ * cynara database.
+ * In case of CYNARA_ADMIN_BUCKET, a bucket-pointing policy is updated or inserted into cynara
+ * database.
+ * In case of CYNARA_ADMIN_DELETE, a policy is removed from cynara database.
+ * One call of cynara_offline_admin_set_policies can manage many different policies
+ * in different buckets.
+ *
+ * However, considered buckets must exist before referring to them in policies.
+ *
+ * \par Sync (or) Async:
+ * This is a synchronous API.
+ *
+ * \par Important notes:
+ * When plugin API will be specified, there will be more valid types to pass as result.
+ * Numerical values of defines CYNARA_ADMIN_... may change, so usage of defines names is strongly
+ * recommended.
+ *
+ * \param[in] p_cynara_offline_admin cynara offline admin structure.
+ * \param[in] policies NULL terminated array of pointers to policy structures.
+ *
+ * \return CYNARA_ADMIN_API_SUCCESS on success, or negative error code otherwise.
+ *
+ * \brief Insert, update or delete policies in cynara database.
+ */
+int cynara_offline_admin_set_policies(struct cynara_offline_admin *p_cynara_offline_admin,
+                                      const struct cynara_admin_policy *const *policies);
+
+/**
+ * \par Description:
+ * Adds new, updates or removes existing bucket for policies in cynara.
+ *
+ * \par Purpose:
+ * This API should be used to add, remove or update buckets.
+ *
+ * \par Typical use case:
+ * Enables altering policies database by adding, updating or removing buckets.
+ *
+ * \par Method of function operation:
+ * Every bucket has a default policy. During search, if no policy matches the searched key (client,
+ * user, privilege), default policy is returned.
+
+ * Operation run on a single bucket defined with bucket parameter.
+
+ * Operation parameter defines what should happen with bucket. In case of:
+ * CYNARA_ADMIN_DENY, a bucket is inserted or updated with CYNARA_ADMIN_DENY default policy;
+ * CYNARA_ADMIN_ALLOW, a bucket is inserted or updated with CYNARA_ADMIN_ALLOW default policy;
+ * CYNARA_ADMIN_DELETE, a bucket is removed with all policies that were kept in it.
+ *
+ * \par Sync (or) Async:
+ * This is a synchronous API.
+ *
+ * \par Important notes:
+ * When plugin API will be specified, there will be more valid types to pass as operation / default
+ * policy. Numerical values of defines CYNARA_ADMIN_... may change, so usages of provided consts is
+ * strongly recommended.
+ *
+ * Default bucket identified with CYNARA_ADMIN_DEFAULT_BUCKET exists always. Its default policy
+ * is preset to DENY (can be altered, however). Default bucket cannot be removed.
+ *
+ * Extra parameter will be used to pass additional data to cynara extensions to build more complex
+ * policies, such as ALLOW but for 5 minutes only, or ALLOW if user confirms.
+ *
+ * \param[in] p_cynara_offline_admin cynara offline admin structure.
+ * \param[in] bucket bucket name
+ * \param[in] operation type of operation (default policy or CYNARA_ADMIN_DELETE)
+ * \param[in] extra additional data for default policy (will be available with cynara extensions)
+ *
+ * \return CYNARA_ADMIN_API_SUCCESS on success, or negative error code otherwise.
+ *
+ * \brief Add, remove or update buckets in cynara database.
+ */
+int cynara_offline_admin_set_bucket(struct cynara_offline_admin *p_cynara_offline_admin,
+                                    const char *bucket, int operation, const char *extra);
+
+/**
+ * \par Description:
+ * Raw check client, user access for given privilege without using plugins extensions.
+ *
+ * \par Purpose:
+ * This API should be used to check type of matching policy for check request.
+ *
+ * \par Typical use case:
+ * Administrator of cynara want to know, what would cynara return to client, if asked about given
+ * access.
+ *
+ * \par Method of function operation:
+ * Function works almost the same way as cynara_check() client function.
+ * The differences are:
+ * - user can specify bucket, from which search would be started (in case of cynara_check()
+ *   it is always the default bucket)
+ * - user can specify if search should be recursive: disabling recursive check will constrain search
+ *   to single bucket only, ignoring all policies leading to other buckets (in case of
+ *   cynara_check() search is always recursive)
+ * - when matching policy in cynara is found, its result is returned without being interpreted by
+ *   plugin extensions.
+ *
+ * \par Sync (or) Async:
+ * This is a synchronous API.
+ *
+ * \par Important notes:
+ * (*result_extra) may be set to NULL, if extra data are not used in matched policy
+ * If (*result_extra) is not NULL, it contains a string allocated by cynara offline admin library
+ * with malloc(3) function and must be released with free(3) function.
+ *
+ * \param[in] p_cynara_offline_admin cynara offline admin structure.
+ * \param[in] start_bucket name of bucket where search would start.
+ * \param[in] recursive FALSE (== 0) : search is not recursive (single bucket search);
+ *                      TRUE  (!= 0) : search does not ignore policies leading to another buckets.
+ * \param[in] client application or process identifier.
+ * \param[in] user user running client.
+ * \param[in] privilege privilege that is a subject of a check.
+ * \param[out] result placeholder for matched policy type
+ * \param[out] result_extra placeholder for matched policy additional data (see Important Notes!)
+ *
+ * \return CYNARA_ADMIN_API_SUCCESS on success, or error code otherwise.
+ *
+ * \brief Raw check client, user access for given privilege without using plugins extensions.
+ */
+int cynara_offline_admin_check(struct cynara_offline_admin *p_cynara_offline_admin,
+                               const char *start_bucket, const int recursive,
+                               const char *client, const char *user, const char *privilege,
+                               int *result, char **result_extra);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* CYNARA_OFFLINE_ADMIN_H */