summaryrefslogtreecommitdiffstats
path: root/include/cynara/cynara-creds-dbus.h
diff options
context:
space:
mode:
authorJosé Bollo <jose.bollo@iot.bzh>2019-10-03 14:33:21 +0200
committerJosé Bollo <jose.bollo@iot.bzh>2019-10-04 16:02:32 +0200
commitb5bd40e1e68b739307e20e19d2164c5b370846df (patch)
tree91d05e9d740e7e0413509ab7a563b3ce14444b62 /include/cynara/cynara-creds-dbus.h
parentd4a2c432763b033acf7c94ee7e121aca5a3a4f10 (diff)
Isolate compatibility with old cynara
The compatibility items of the old cynara librarie are separated and isolated. The option WITH_CYNARA_COMPAT activates it or not. Change-Id: Iba77c97d8df31f5f515b57411487943192451ac6 Signed-off-by: José Bollo <jose.bollo@iot.bzh>
Diffstat (limited to 'include/cynara/cynara-creds-dbus.h')
-rw-r--r--include/cynara/cynara-creds-dbus.h171
1 files changed, 0 insertions, 171 deletions
diff --git a/include/cynara/cynara-creds-dbus.h b/include/cynara/cynara-creds-dbus.h
deleted file mode 100644
index 04af96f..0000000
--- a/include/cynara/cynara-creds-dbus.h
+++ /dev/null
@@ -1,171 +0,0 @@
-/*
- * Copyright (c) 2014-2015 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 src/include/cynara-creds-dbus.h
- * @author Lukasz Wojciechowski <l.wojciechow@partner.samsung.com>
- * @author Radoslaw Bartosiak <r.bartosiak@samsung.com>
- * @author Oskar Switalski <o.switalski@samsung.com>
- * @version 1.0
- * @brief This file contains Cynara credentials helper APIs for dbus clients.
- * @example cynara-creds-dbus.example
- */
-
-#ifndef CYNARA_CREDS_DBUS_H
-#define CYNARA_CREDS_DBUS_H
-
-#include <dbus/dbus.h>
-#include <sys/types.h>
-
-#include <cynara/cynara-creds-commons.h>
-
-#ifdef __cplusplus
-extern "C" {
-#endif
-
-/**
- * \par Description:
- * Creates a client identification string with given method. Client is a process identified by the
- * unique name at the other side of the dbus connection.
- *
- * \par Purpose:
- * Client identification string is required for cynara_check() and cynara_async_create_request()
- * functions.
- *
- * \par Typical use case:
- * The function is called before the call of cynara_check() or cynara_async_create_request()
- * function. Returned string is used as client parameter in cynara_check() or
- * cynara_async_create_request() function. String is released with free() function when it is no
- * longer needed.
- *
- * \par Method of function operation:
- * The function generates client string by calling a method from DBus Interface
- * ("org.freedesktop.DBus") which is placed on system bus ("org.freedesktop.DBus").
- *
- * \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 mutex protected critical section.
- *
- * \par Important notes:
- * Memory for returned client string is obtained with malloc(), and should be freed with free().
- * Allocated string is returned only, when function succeeds.
- * If method is CLIENT_METHOD_DEFAULT then it will be chosen based on Cynara configuration file.
- *
- * \param[in] connection DBus connection to a bus. It manages incomming and outgoing messages
- * \param[in] uniqueName DBus identifier of the client
- * \param[in] method Method of client identifier creation
- * \param[out] client Placeholder for allocated string containing client id
- *
- * \return CYNARA_API_SUCCESS on success
- * \return CYNARA_API_INVALID_PARAM when client is NULL or uniqueName or client has wrong
- * value (i.e NULL or non-existing)
- * \return CYNARA_API_METHOD_NOT_SUPPORTED when requested method is not supported
- * \return CYNARA_API_CONFIGURATION_ERROR if the configuration file can not be opened or
- * there are errors in configuration file
- * \return CYNARA_API_OUT_OF_MEMORY when there was error allocating memory
- */
-int cynara_creds_dbus_get_client(DBusConnection *connection, const char *uniqueName,
- enum cynara_client_creds method, char **client);
-
-/**
- * \par Description:
- * Creates a user identification string with given method. User is an executor of process
- * at the other side of socket.
- *
- * \par Purpose:
- * User identification string is required for cynara_check() and cynara_async_create_request()
- * functions.
- *
- * \par Typical use case:
- * The function is called before the call of cynara_check() or cynara_async_create_request()
- * function. Returned string is used as user parameter in cynara_check() or
- * cynara_async_create_request() function. String is released with free() function when it is no
- * longer needed.
- *
- * \par Method of function operation:
- * The function generates user string by calling a method from DBus Interface
- * ("org.freedesktop.DBus") which is placed on system bus ("org.freedesktop.DBus").
- *
- * \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 mutex protected critical section.
- *
- * \par Important notes:
- * Memory for returned user string is obtained with malloc(), and should be freed with free().
- * Allocated string is returned only, when function succeeds.
- * If method is USER_METHOD_DEFAULT then it will be chosen based on Cynara configuration file.
- *
- * \param[in] connection DBus connection to a bus. It manages incomming and outgoing messages
- * \param[in] uniqueName DBus identifier of the client invoked by the user
- * \param[in] method Method of client identifier creation
- * \param[out] user Placeholder for allocated string containing user id
- *
- * \return CYNARA_API_SUCCESS on success
- * \return CYNARA_API_INVALID_PARAM when user is NULL or connection is not valid DBus connection or
- * uniqueName does not represent a process conected to the DBus
- * \return CYNARA_API_METHOD_NOT_SUPPORTED when requested method is not supported
- * \return CYNARA_API_CONFIGURATION_ERROR if the configuration file can not be opened or
- * there are errors in configuration file
- * \return CYNARA_API_OUT_OF_MEMORY when there was error allocating memory
- */
-int cynara_creds_dbus_get_user(DBusConnection *connection, const char *uniqueName,
- enum cynara_user_creds method, char **user);
-
-/**
- * \par Description:
- * Return PID of a proces identified by the unique name at the other side of the dbus connection.
- *
- * \par Purpose:
- * PID may be used for client_session creation with cynara_helper_session_from_pid() function
- * from libcynara-helper-session library. Client_session is needed for cynara_check()
- * and cynara_async_create_request() functions.
- *
- * \par Typical use case:
- * The function is called before the call of cynara_helper_session_from_pid() function.
- *
- * \par Method of function operation:
- * The function reads PID of the peer by calling a method from DBus Interface
- * ("org.freedesktop.DBus") which is placed on system bus ("org.freedesktop.DBus")
- * with "GetConnectionUnixProcessID" argument.
- *
- * \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 mutex protected critical section.
- *
- * \param[in] connection DBus connection to a bus. It manages incomming and outgoing messages
- * \param[in] uniqueName DBus identifier of the client invoked by the user
- * \param[out] pid Placeholder for PID returned by function
- *
- * \return CYNARA_API_SUCCESS on success
- * \return CYNARA_API_INVALID_PARAM when socket_fd is not valid connected socket descriptor
- * \return CYNARA_API_UNKNOWN_ERROR when system function fails in incredible situation
- * \return CYNARA_API_OUT_OF_MEMORY when there was error allocating memory
- */
-int cynara_creds_dbus_get_pid(DBusConnection *connection, const char *uniqueName, pid_t *pid);
-
-#ifdef __cplusplus
-}
-#endif
-
-#endif /* CYNARA_CREDS_DBUS_H */