summaryrefslogtreecommitdiffstats
path: root/include/cynara/cynara-creds-commons.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-commons.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-commons.h')
-rw-r--r--include/cynara/cynara-creds-commons.h132
1 files changed, 0 insertions, 132 deletions
diff --git a/include/cynara/cynara-creds-commons.h b/include/cynara/cynara-creds-commons.h
deleted file mode 100644
index 81b9784..0000000
--- a/include/cynara/cynara-creds-commons.h
+++ /dev/null
@@ -1,132 +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-commons.h
- * @author Lukasz Wojciechowski <l.wojciechow@partner.samsung.com>
- * @author Radoslaw Bartosiak <r.bartosiak@samsung.com>
- * @author Aleksander Zdyb <a.zdyb@samsung.com>
- * @author Oskar Switalski <o.switalski@samsung.com>
- * @version 1.0
- * @brief This file contains common APIs for Cynara credentials helper.
- */
-
-#ifndef CYNARA_CREDS_COMMONS_H
-#define CYNARA_CREDS_COMMONS_H
-
-#include <cynara/cynara-error.h>
-
-enum cynara_client_creds {
- CLIENT_METHOD_SMACK,
- CLIENT_METHOD_PID,
-
- CLIENT_METHOD_DEFAULT = 0xFFFF,
-};
-
-enum cynara_user_creds {
- USER_METHOD_UID,
- USER_METHOD_GID,
-
- USER_METHOD_DEFAULT = 0xFFFF,
-};
-
-#ifdef __cplusplus
-extern "C" {
-#endif
-
-/**
- * \par Description:
- * Gets the system default method value for client feature used in cynara-creds.
- *
- * \par Purpose:
- * Functions cynara_creds_dbus_get_client() and cynara_creds_socket_get_client() take a method
- * parameter, which determines a kind of process feature (i.e PID, SMACK label) returned by them.
- * The described function provides implementation for obtaining a system default value
- * for this parameter.
- *
- * \par Typical use case:
- * The function might be called before cynara_creds_dbus_get_client()
- * and cynara_creds_socket_get_client(), when functions shall be invoked with system default
- * value of method parameter.
- *
- * \par Method of function operation:
- * When this function is called for the first time it reads and returns the value of client_default
- * parameter from /etc/cynara/creds.conf file.
- * Returned value is cached so subsequent calls will not consult file again but use cached value.
- * This also means that after the initial call any changes in the file will be ignored for the
- * remaining lifetime of the process.
- *
- * \par Sync (or) Async:
- * This is a synchronous API.
- *
- * \par Thread safety:
- * This function is thread-safe.
- *
- * \param[out] method Placeholder for system default client feature
- * (like CLIENT_METHOD_SMACK, CLIENT_METHOD_PID)
- *
- * \return CYNARA_API_SUCCESS on success
- * \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 if there is error in memory allocation
- * \return CYNARA_API_UNKNOWN_ERROR if there is other error
- *
- */
-int cynara_creds_get_default_client_method(enum cynara_client_creds *method);
-
-/**
- * \par Description:
- * Gets the system default method value for user feature used in cynara-creds.
- *
- * \par Purpose:
- * Functions cynara_creds_dbus_get_user() and cynara_creds_socket_get_user() take a method
- * parameter, which determines a kind of process feature (i.e UID, GID) returned by them.
- * The described function provides implementation for obtaining a system default value
- * for this parameter.
- *
- * \par Typical use case:
- * The function might be called before cynara_creds_dbus_get_user()
- * and cynara_creds_socket_get_user() when functions shall be invoked with system default
- * value of method parameter.
- *
- * \par Method of function operation:
- * When this function is called for the first time it reads and returns the value of user_default
- * parameter from /etc/cynara/creds.conf file.
- * Returned value is cached so subsequent calls will not consult file again but use cached value.
- * This also means that after the initial call any changes in the file will be ignored for the
- * remaining lifetime of the process.
- *
- * \par Sync (or) Async:
- * This is a synchronous API.
- *
- * \par Thread safety:
- * This function is thread-safe.
- *
- * \param[out] method Placeholder for system default user feature
- * (like USER_METHOD_UID, USER_METHOD_GID)
- *
- * \return CYNARA_API_SUCCESS on success
- * \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 if there is error in memory allocation
- * \return CYNARA_API_UNKNOWN_ERROR if there is other error
- */
-int cynara_creds_get_default_user_method(enum cynara_user_creds *method);
-
-#ifdef __cplusplus
-}
-#endif
-
-#endif /* CYNARA_CREDS_COMMONS_H */