SET(TARGET_CYNARA "cynara")
SET(TARGET_LIB_CYNARA "cynara-client")
+SET(TARGET_LIB_CYNARA_ASYNC "cynara-client-async")
SET(TARGET_LIB_CYNARA_ADMIN "cynara-admin")
SET(TARGET_CYNARA_COMMON "cynara-commons")
SET(TARGET_CYNARA_TESTS "cynara-tests")
#
ADD_SUBDIRECTORY(cynara-client)
+ADD_SUBDIRECTORY(cynara-client-async)
ADD_SUBDIRECTORY(cynara-admin)
--- /dev/null
+# 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 CMakeLists.txt
+# @author Marcin Niesluchowski <m.niesluchow@samsung.com>
+#
+
+CONFIGURE_FILE(cynara-client-async.pc.in cynara-client-async.pc @ONLY)
+
+INSTALL(FILES
+ ${CMAKE_BINARY_DIR}/build/cynara-client-async/cynara-client-async.pc
+ DESTINATION
+ ${LIB_INSTALL_DIR}/pkgconfig
+ )
--- /dev/null
+prefix=@CMAKE_INSTALL_PREFIX@
+exec_prefix=${prefix}
+libdir=@LIB_INSTALL_DIR@
+includedir=${prefix}/include
+
+Name: cynara-client-async
+Description: cynara-client-async package
+Version: 0.0.1
+Requires:
+Libs: -L${libdir} -lcynara-client-async
+Cflags: -I${includedir}/cynara
Source0: %{name}-%{version}.tar.gz
Source1001: cynara.manifest
Source1002: libcynara-client.manifest
-Source1003: libcynara-admin.manifest
-Source1004: cynara-tests.manifest
+Source1003: libcynara-client-async.manifest
+Source1004: libcynara-admin.manifest
+Source1005: cynara-tests.manifest
Requires: default-ac-domains
BuildRequires: cmake
BuildRequires: zip
%endif
%description
-service, client libraries (libcynara-client, libcynara-admin)
+service and client libraries (libcynara-client, libcynara-client-async, libcynara-admin)
and tests (cynara-tests)
#######################################################
client library (devel) for checking policies
#######################################################
+%package -n libcynara-client-async
+Summary: Cynara - asynchronous client library
+Requires: cynara = %{version}-%{release}
+Requires(post): /sbin/ldconfig
+Requires(postun): /sbin/ldconfig
+
+%description -n libcynara-client-async
+asynchronous client library for checking policies
+
+%package -n libcynara-client-async-devel
+Summary: Cynara - asynchronous client library (devel)
+Requires: libcynara-client-async = %{version}-%{release}
+
+%description -n libcynara-client-async-devel
+asynchronous client library (devel) for checking policies
+
+#######################################################
%package -n libcynara-admin
Summary: Cynara - admin client library
Requires: cynara = %{version}-%{release}
cp -a %{SOURCE1002} .
cp -a %{SOURCE1003} .
cp -a %{SOURCE1004} .
+cp -a %{SOURCE1005} .
%build
%if 0%{?sec_build_binary_debug_enable}
%postun -n libcynara-client -p /sbin/ldconfig
+%post -n libcynara-client-async -p /sbin/ldconfig
+
+%postun -n libcynara-client-async -p /sbin/ldconfig
+
%post -n libcynara-admin -p /sbin/ldconfig
%postun -n libcynara-admin -p /sbin/ldconfig
%postun -n libcynara-client-devel -p /sbin/ldconfig
+%post -n libcynara-client-async-devel -p /sbin/ldconfig
+
+%postun -n libcynara-client-async-devel -p /sbin/ldconfig
+
%post -n libcynara-admin-devel -p /sbin/ldconfig
%postun -n libcynara-admin-devel -p /sbin/ldconfig
%{_libdir}/pkgconfig/cynara-client.pc
%{_libdir}/libcynara-client.so
+%files -n libcynara-client-async
+%manifest libcynara-client-async.manifest
+%license LICENSE
+%defattr(-,root,root,-)
+%{_libdir}/libcynara-client-async.so.*
+
+%files -n libcynara-client-async-devel
+%defattr(-,root,root,-)
+%{_includedir}/cynara/cynara-client-async.h
+%{_libdir}/pkgconfig/cynara-client-async.pc
+%{_libdir}/libcynara-client-async.so
+
%files -n libcynara-admin
%manifest libcynara-admin.manifest
%license LICENSE
--- /dev/null
+<manifest>
+ <request>
+ <domain name="_" />
+ </request>
+</manifest>
ADD_SUBDIRECTORY(include)
ADD_SUBDIRECTORY(common)
ADD_SUBDIRECTORY(client)
+ADD_SUBDIRECTORY(client-async)
ADD_SUBDIRECTORY(admin)
ADD_SUBDIRECTORY(service)
--- /dev/null
+# 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 CMakeLists.txt
+# @author Marcin Niesluchowski <m.niesluchow@samsung.com>
+#
+
+SET(LIB_CYNARA_ASYNC_VERSION_MAJOR 0)
+SET(LIB_CYNARA_ASYNC_VERSION ${LIB_CYNARA_ASYNC_VERSION_MAJOR}.0.2)
+
+SET(CYNARA_LIB_CYNARA_ASYNC_PATH ${CYNARA_PATH}/client-async)
+
+SET(LIB_CYNARA_ASYNC_SOURCES
+ ${CYNARA_LIB_CYNARA_ASYNC_PATH}/api/client-async-api.cpp
+ ${CYNARA_LIB_CYNARA_ASYNC_PATH}/logic/Logic.cpp
+ )
+
+INCLUDE_DIRECTORIES(
+ ${CYNARA_LIB_CYNARA_ASYNC_PATH}
+ )
+
+ADD_LIBRARY(${TARGET_LIB_CYNARA_ASYNC} SHARED ${LIB_CYNARA_ASYNC_SOURCES})
+
+SET_TARGET_PROPERTIES(
+ ${TARGET_LIB_CYNARA_ASYNC}
+ PROPERTIES
+ COMPILE_FLAGS "-D_GNU_SOURCE -fPIC -fvisibility=hidden"
+ SOVERSION ${LIB_CYNARA_ASYNC_VERSION_MAJOR}
+ VERSION ${LIB_CYNARA_ASYNC_VERSION}
+ )
+
+TARGET_LINK_LIBRARIES(${TARGET_LIB_CYNARA_ASYNC}
+ ${CYNARA_DEP_LIBRARIES}
+ ${TARGET_CYNARA_COMMON}
+ )
+
+INSTALL(TARGETS ${TARGET_LIB_CYNARA_ASYNC} DESTINATION ${LIB_INSTALL_DIR})
--- /dev/null
+/*
+ * 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 ApiInterface.h
+ * @author Marcin Niesluchowski <m.niesluchow@samsung.com>
+ * @version 1.0
+ * @brief This file contains libcynara-client-async API interface definition.
+ */
+
+#ifndef SRC_CLIENT_ASYNC_API_APIINTERFACE_H_
+#define SRC_CLIENT_ASYNC_API_APIINTERFACE_H_
+
+#include <string>
+
+#include <cynara-client-async.h>
+
+namespace Cynara {
+
+class ApiInterface {
+public:
+ ApiInterface() = default;
+ virtual ~ApiInterface() {};
+
+ virtual int connect(int &sockFd) = 0;
+ virtual int check(const std::string &client, const std::string &session,
+ const std::string &user, const std::string &privilege,
+ cynara_check_id &checkId) = 0;
+ virtual int receive(cynara_check_id &checkId) = 0;
+ virtual int cancel(const cynara_check_id checkId) = 0;
+};
+
+} // namespace Cynara
+
+#endif /* SRC_CLIENT_ASYNC_API_APIINTERFACE_H_ */
--- /dev/null
+/*
+ * 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 client-async-api.cpp
+ * @author Marcin Niesluchowski <m.niesluchow@samsung.com>
+ * @version 1.0
+ * @brief Implementation of external libcynara-client-async API
+ */
+
+#include <new>
+
+#include <common.h>
+#include <log/log.h>
+
+#include <api/ApiInterface.h>
+#include <cynara-client-async.h>
+#include <logic/Logic.h>
+
+struct cynara_async {
+ Cynara::ApiInterface *impl;
+
+ cynara_async(Cynara::ApiInterface *_impl) : impl(_impl) {
+ }
+
+ ~cynara_async() {
+ delete impl;
+ }
+};
+
+CYNARA_API
+int cynara_async_initialize(cynara_async **pp_cynara,
+ const cynara_async_configuration *p_conf UNUSED)
+{
+ if (!pp_cynara)
+ return CYNARA_ASYNC_API_INVALID_PARAM;
+
+ try {
+ *pp_cynara = new cynara_async(new Cynara::Logic);
+ } catch (const std::bad_alloc &ex) {
+ return CYNARA_ASYNC_API_OUT_OF_MEMORY;
+ }
+
+ init_log();
+
+ LOGD("Cynara client async initialized");
+
+ return CYNARA_ASYNC_API_SUCCESS;
+}
+
+CYNARA_API
+int cynara_async_finish(cynara_async *p_cynara)
+{
+ delete p_cynara;
+
+ return CYNARA_ASYNC_API_SUCCESS;
+}
+
+CYNARA_API
+int cynara_async_connect(cynara_async *p_cynara, int *p_sock_fd)
+{
+ if (!p_cynara || !p_cynara->impl)
+ return CYNARA_ASYNC_API_INVALID_PARAM;
+ if (!p_sock_fd)
+ return CYNARA_ASYNC_API_INVALID_PARAM;
+
+ return p_cynara->impl->connect(*p_sock_fd);
+}
+
+CYNARA_API
+int cynara_async_check(cynara_async *p_cynara,
+ const char *client, const char *client_session,
+ const char *user, const char *privilege,
+ cynara_check_id *p_check_id)
+{
+ if (!p_cynara || !p_cynara->impl)
+ return CYNARA_ASYNC_API_INVALID_PARAM;
+ if (!client || !client_session || !user || !privilege)
+ return CYNARA_ASYNC_API_INVALID_PARAM;
+ if (!p_check_id)
+ return CYNARA_ASYNC_API_INVALID_PARAM;
+
+ return p_cynara->impl->check(client, client_session,
+ user, privilege,
+ *p_check_id);
+}
+
+CYNARA_API
+int cynara_async_receive(cynara_async *p_cynara, cynara_check_id *p_check_id)
+{
+ if (!p_cynara || !p_cynara->impl)
+ return CYNARA_ASYNC_API_INVALID_PARAM;
+ if (!p_check_id)
+ return CYNARA_ASYNC_API_INVALID_PARAM;
+
+ return p_cynara->impl->receive(*p_check_id);
+}
+
+CYNARA_API
+int cynara_async_cancel(cynara_async *p_cynara, const cynara_check_id check_id)
+{
+ if (!p_cynara || !p_cynara->impl)
+ return CYNARA_ASYNC_API_INVALID_PARAM;
+
+ return p_cynara->impl->cancel(check_id);
+}
--- /dev/null
+/*
+ * 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 Logic.cpp
+ * @author Marcin Niesluchowski <m.niesluchow@samsung.com>
+ * @version 1.0
+ * @brief This file contains implementation of Logic class - main
+ * libcynara-client-async class
+ */
+
+#include <common.h>
+
+#include "Logic.h"
+
+namespace Cynara {
+
+int Logic::connect(int &sockFd UNUSED) noexcept
+{
+ return CYNARA_ASYNC_API_SUCCESS;
+}
+
+int Logic::check(const std::string &client UNUSED, const std::string &session UNUSED,
+ const std::string &user UNUSED, const std::string &privilege UNUSED,
+ cynara_check_id &checkId UNUSED) noexcept
+{
+ return CYNARA_ASYNC_API_SUCCESS;
+}
+
+int Logic::receive(cynara_check_id &checkId UNUSED) noexcept
+{
+ return CYNARA_ASYNC_API_SUCCESS;
+}
+
+int Logic::cancel(const cynara_check_id checkId UNUSED) noexcept
+{
+ return CYNARA_ASYNC_API_SUCCESS;
+}
+
+} // namespace Cynara
--- /dev/null
+/*
+ * 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 Logic.h
+ * @author Marcin Niesluchowski <m.niesluchow@samsung.com>
+ * @version 1.0
+ * @brief This file contains declaration of Logic class - main
+ * libcynara-client-async class
+ */
+
+#ifndef SRC_CLIENT_ASYNC_LOGIC_LOGIC_H_
+#define SRC_CLIENT_ASYNC_LOGIC_LOGIC_H_
+
+#include <api/ApiInterface.h>
+#include <cynara-client-async.h>
+
+namespace Cynara {
+
+class Logic : public ApiInterface {
+public:
+ Logic() = default;
+ virtual ~Logic() {};
+
+ virtual int connect(int &sockFd) noexcept;
+ virtual int check(const std::string &client, const std::string &session,
+ const std::string &user, const std::string &privilege,
+ cynara_check_id &checkId) noexcept;
+ virtual int receive(cynara_check_id &checkId) noexcept;
+ virtual int cancel(const cynara_check_id checkId) noexcept;
+};
+
+} // namespace Cynara
+
+#endif /* SRC_CLIENT_ASYNC_LOGIC_LOGIC_H_ */
)
INSTALL(FILES
+ ${CYNARA_PATH}/include/cynara-client-async.h
+ DESTINATION ${INCLUDE_INSTALL_DIR}/cynara
+ )
+
+INSTALL(FILES
${CYNARA_PATH}/include/cynara-admin.h
DESTINATION ${INCLUDE_INSTALL_DIR}/cynara
)
--- /dev/null
+/*
+ * 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-client-async.h
+ * @author Marcin Niesluchowski <m.niesluchow@samsung.com>
+ * @version 1.0
+ * @brief This file contains asynchronous client APIs of Cynara available
+ * with libcynara-client-asynchronous.
+ */
+
+
+#ifndef CYNARA_CLIENT_ASYNC_H
+#define CYNARA_CLIENT_ASYNC_H
+
+#include <cstdint>
+
+/**
+ * \name Return Codes
+ * exported by the foundation API.
+ * result codes begin with the start error code and extend into negative direction.
+ * @{
+*/
+
+/*! \brief indicating the result of the one specific API is successful or access is allowed */
+#define CYNARA_ASYNC_API_SUCCESS 0
+
+/*! \brief indicating that access that was checked is denied */
+#define CYNARA_ASYNC_API_ACCESS_DENIED -1
+
+/*! \brief indicating that answer was not yet received */
+#define CYNARA_ASYNC_API_ANSWER_NOT_READY -2
+
+/*! \brief indicating that client is already connected */
+#define CYNARA_ASYNC_API_ALREADY_CONNECTED -3
+
+/*! \brief indicating system is running out of memory state */
+#define CYNARA_ASYNC_API_OUT_OF_MEMORY -4
+
+/*! \brief indicating the API's parameter is malformed */
+#define CYNARA_ASYNC_API_INVALID_PARAM -5
+
+/*! \brief service not available */
+#define CYNARA_ASYNC_API_SERVICE_NOT_AVAILABLE -6
+
+/** @}*/
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+typedef struct cynara_async cynara_async;
+typedef struct cynara_async_configuration cynara_async_configuration;
+typedef uint16_t cynara_check_id;
+
+/**
+ * \par Description:
+ * Initialize cynara-async-client library with given configuration.
+ * Create structure used in following API calls.
+ *
+ * \par Purpose:
+ * This API must be used prior to calling cynara_async_connect function.
+ *
+ * \par Typical use case:
+ * Once before a service can call cynara_async_connect.
+ *
+ * \par Method of function operation:
+ * This API initializes inner library structures and in case of success creates
+ * and returns cynara_async structure.
+ *
+ * \par Sync (or) Async:
+ * This is a synchronous API.
+ *
+ * \par Thread-safety:
+ * This function is NOT thread-safe. If functions from described API are called by multithreaded
+ * application from different threads, they must be put into protected critical section.
+ *
+ * \par Important notes:
+ * Structure cynara_async created by cynara_async_initialize call should be released
+ * with cynara_async_finish.
+ *
+ * \param[out] pp_cynara Placeholder for created cynara_async structure.
+ * \param[in] p_conf Configuration for cynara-async-client library. NULL for default parameters.
+ *
+ * \return CYNARA_ASYNC_API_SUCCESS on success, or error code on error.
+ */
+
+int cynara_async_initialize(cynara_async **pp_cynara,
+ const cynara_async_configuration *p_conf);
+
+/**
+ * \par Description:
+ * Release cynara-async-client library and destroy structure created with cynara_async_initialize.
+ *
+ * \par Purpose:
+ * This API should be used to clean up after usage of cynara-async-client library.
+ *
+ * \par Typical use case:
+ * Once after all checks have been answered.
+ *
+ * \par Method of function operation:
+ * This API releases inner library structure and destroys cynara_async structure. All pending
+ * requests are cancelled.
+ *
+ * \par Sync (or) Async:
+ * This is a synchronous API.
+ *
+ * \par Thread-safety:
+ * This function is NOT thread-safe. If functions from described API are called by multithreaded
+ * application from different threads, they must be put into protected critical section.
+ *
+ * \par Important notes:
+ * No other call to cynara-async-client library should be made after call to cynara_async_finish.
+ *
+ * \param[in] p_cynara cynara_async structure.
+ *
+ * \return CYNARA_ASYNC_API_SUCCESS on success, or error code on error.
+ */
+int cynara_async_finish(cynara_async *p_cynara);
+
+/**
+ * \par Description:
+ * Connect with cynara server.
+ *
+ * \par Purpose:
+ * This API must be used prior to calling cynara_async_check and cynara_async_receive.
+ *
+ * \par Typical use case:
+ * After initiating cynara_async structure and after connection with cynara server has been lost.
+ *
+ * \par Method of function operation:
+ * This API connects to cynara server and provides socket descriptor of this connection.
+ *
+ * \par Sync (or) Async:
+ * This is a synchronous API.
+ *
+ * \par Thread-safety:
+ * This function is NOT thread-safe. If functions from described API are called by multithreaded
+ * application from different threads, they must be put into protected critical section.
+ *
+ * \par Important notes:
+ * Call to cynara_async_check needs cynara_async structure to be created first by
+ * cynara_async_initialize.
+ *
+ * \param[in] p_cynara cynara_async structure.
+ * \param[out] p_sock_fd Placeholder for connection socket descriptor.
+ *
+ * \return CYNARA_ASYNC_API_SUCCESS on success, CYNARA_ASYNC_API_ALREADY_CONNECTED when client is
+ * already connected or error code on error.
+ */
+int cynara_async_connect(cynara_async *p_cynara, int *p_sock_fd);
+
+/**
+ * \par Description:
+ * Check client, user access for given privilege.
+ *
+ * \par Purpose:
+ * This API should be used to check if a user running application identified as client
+ * has access to a privilege.
+ *
+ * \par Typical use case:
+ * A service wants to ask Cynara daemon, if a client demanding access to some privilege
+ * has proper rights. Despite the fact that the final response has been received, if there are
+ * still some pending checks, cynara_async_receive MUST be called after this call until not ready
+ * answer is returned. If service does not get answer after this sequence, it may get it
+ * asynchronously by calling cynara_async_receive.
+ *
+ * \par Method of function operation:
+ * Client (a process / application) demanding access to a privilege is running as some user.
+ * For such triple an access to a privilege is checked by calling cynara.
+ * Depending on defined policy, an external application may be launched to ask user a question,
+ * e.g. if [s]he wants to allow client to use a privilege. Additional parameter client_session
+ * may be used to distinguish between client session (e.g. for allowing access only for this
+ * particular application launch). If final answer is not returned, id of current check should
+ * be received.
+ *
+ * \par Sync (or) Async:
+ * This is an asynchronous API.
+ *
+ * \par Thread-safety:
+ * This function is NOT thread-safe. If functions from described API are called by multithreaded
+ * application from different threads, they must be put into protected critical section.
+ *
+ * \par Important notes:
+ * An external application may be launched to allow user interaction in granting or denying access.
+ * Call cynara_async_cancel to cancel pending request. Call to cynara_async_check needs
+ * cynara_async structure to be created first and connected with cynara daemon. To do that call
+ * cynara_async_initialize and cynara_async_connect.
+ *
+ * \param[in] p_cynara cynara_async structure.
+ * \param[in] client Application or process identifier.
+ * \param[in] client_session Session of client (connection, launch).
+ * \param[in] user User running client.
+ * \param[in] privilege Privilege that is a subject of a check.
+ * \param[out] p_check_id Placeholder for check id.
+ *
+ * \return CYNARA_ASYNC_API_SUCCESS on success (access granted), CYNARA_API_ACCESS_DENIED
+ * on access denial, CYNARA_ASYNC_API_ANSWER_NOT_READY on asynchronous request sent
+ * or other error code on error.
+ */
+int cynara_async_check(cynara_async *p_cynara,
+ const char *client, const char *client_session,
+ const char *user, const char *privilege,
+ cynara_check_id *p_check_id);
+
+/**
+ * \par Description:
+ * Receive answer of cynara_async_check call from cynara daemon.
+ *
+ * \par Purpose:
+ * This API should be used to receive answer on single check not answered by cynara_async_check.
+ *
+ * \par Typical use case:
+ * After calling cynara_async_check, if there are still pending checks, this function MUST be
+ * called until not ready answer is returned. After that, answer can be received by this call
+ * if a read event occurs on socket received by cynara_async_connect. It MUST be called then
+ * the same way as after cynara_async_check.
+ *
+ * \par Method of function operation:
+ * Receives answer sent by cynara daemon in response to cynara_async_check call.
+ *
+ * \par Sync (or) Async:
+ * This is an asynchronous API.
+ *
+ * \par Thread-safety:
+ * This function is NOT thread-safe. If functions from described API are called by multithreaded
+ * application from different threads, they must be put into protected critical section.
+ *
+ * \par Important notes:
+ * An external application may be launched to allow user interaction in granting or denying access.
+ * Call cynara_async_cancel to cancel pending request. Call to cynara_async_receive needs
+ * cynara_async structure to be created first and connected with cynara daemon. To do that call
+ * cynara_async_initialize and cynara_async_connect. As multiple answers can be available at once,
+ * cynara_async_receive MUST be called until not ready answer is returned.
+ *
+ * \param[in] p_cynara cynara_async structure.
+ * \param[out] p_check_id Placeholder for check id.
+ *
+ * \return CYNARA_ASYNC_API_SUCCESS on success (access granted), CYNARA_API_ACCESS_DENIED
+ * on access denial, CYNARA_ASYNC_API_ANSWER_NOT_READY on answer not yet fully received
+ * or other error code on error.
+ */
+int cynara_async_receive(cynara_async *p_cynara, cynara_check_id *p_check_id);
+
+/**
+ * \par Description:
+ * Cancel check request created by cynara_async_check.
+ *
+ * \par Purpose:
+ * This API should be used to cancel check request created by cynara_async_check.
+ *
+ * \par Typical use case:
+ * A service did not get final answer in cynara_async_check call and answer did not come yet
+ * due to check hanging on user decision to allow or deny privilege.
+ *
+ * \par Method of function operation:
+ * Cancels check request created by cynara_async_check call.
+ *
+ * \par Sync (or) Async:
+ * This is an asynchronous API.
+ *
+ * \par Thread-safety:
+ * This function is NOT thread-safe. If functions from described API are called by multithreaded
+ * application from different threads, they must be put into protected critical section.
+ *
+ * \par Important notes:
+ * Call to cynara_async_cancel needs cynara_async structure to be created first and connected
+ * with cynara daemon. To do that call cynara_async_initialize and cynara_async_connect.
+ *
+ * \param[in] p_cynara cynara_async structure.
+ * \param[in] check_id Check id to be cancelled
+ *
+ * \return CYNARA_ASYNC_API_SUCCESS on success or other error code on error.
+ */
+int cynara_async_cancel(cynara_async *p_cynara, cynara_check_id check_id);
+
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* CYNARA_CLIENT_ASYNC_H */
projects / platform / core / security / cynara.git / commitdiff