+++ /dev/null
-/*
- * security-server
- *
- * Copyright (c) 2000 - 2011 Samsung Electronics Co., Ltd All Rights Reserved
- *
- * Contact: Bumjin Im <bj.im@samsung.com>
- *
- * 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
- *
- */
-
-#ifndef SECURITY_SERVER_H
-#define SECURITY_SERVER_H
-
-#include <sys/types.h>
-#include <privilege-control.h>
-
-/**
- * @file security-server.h
- * @version 1.0
- * @brief This file contains APIs of the Security Server
-*/
-
-/**
- * @defgroup SecurityFW
- * @{
- *
- * @defgroup SECURITY_SERVER Security Server
- * @version 1.0
- * @brief Security Server client library functions
- *
-*/
-
-/**
- * @addtogroup SECURITY_SERVER
- * @{
-*/
-
-/*
- * ====================================================================================================
- * <tt>
- *
- * Revision History:
- *
- * -- Company Name -- | Modification Date | Description of Changes
- * -----------------------------------------------------------------------
- * --- Samsung ------ | --- 2010-07-25 -- | First created
- *
- * </tt>
- */
-
-/**
- * \name Return Codes
- * exported by the foundation API.
- * result codes begin with the start error code and extend into negative direction.
- * @{
-*/
-#define SECURITY_SERVER_API_SUCCESS 0
-/*! \brief indicating the result of the one specific API is successful */
-#define SECURITY_SERVER_API_ERROR_SOCKET -1
-
-/*! \brief indicating the socket between client and Security Server has been failed */
-#define SECURITY_SERVER_API_ERROR_BAD_REQUEST -2
-
-/*! \brief indicating the response from Security Server is malformed */
-#define SECURITY_SERVER_API_ERROR_BAD_RESPONSE -3
-
-/*! \brief indicating the requested service does not exist */
-#define SECURITY_SERVER_API_ERROR_NO_SUCH_SERVICE -4
-
-/*! \brief indicating requesting object is not exist */
-#define SECURITY_SERVER_API_ERROR_NO_SUCH_OBJECT -6
-
-/*! \brief indicating the authentication between client and server has been failed */
-#define SECURITY_SERVER_API_ERROR_AUTHENTICATION_FAILED -7
-
-/*! \brief indicating the API's input parameter is malformed */
-#define SECURITY_SERVER_API_ERROR_INPUT_PARAM -8
-
-/*! \brief indicating the output buffer size which is passed as parameter is too small */
-#define SECURITY_SERVER_API_ERROR_BUFFER_TOO_SMALL -9
-
-/*! \brief indicating system is running out of memory state */
-#define SECURITY_SERVER_API_ERROR_OUT_OF_MEMORY -10
-
-/*! \brief indicating the access has been denied by Security Server */
-#define SECURITY_SERVER_API_ERROR_ACCESS_DENIED -11
-
-/*! \brief indicating Security Server has been failed for some reason */
-#define SECURITY_SERVER_API_ERROR_SERVER_ERROR -12
-
-/*! \brief indicating given cookie is not exist in the database */
-#define SECURITY_SERVER_API_ERROR_NO_SUCH_COOKIE -13
-
-/*! \brief indicating there is no phone password set */
-#define SECURITY_SERVER_API_ERROR_NO_PASSWORD -14
-
-/*! \brief indicating password exists in system */
-#define SECURITY_SERVER_API_ERROR_PASSWORD_EXIST -15
-
-/*! \brief indicating password mismatch */
-#define SECURITY_SERVER_API_ERROR_PASSWORD_MISMATCH -16
-
-/*! \brief indicating password retry timeout is not occurred yet */
-#define SECURITY_SERVER_API_ERROR_PASSWORD_RETRY_TIMER -17
-
-/*! \brief indicating password retry timeout is not occurred yet */
-#define SECURITY_SERVER_API_ERROR_PASSWORD_MAX_ATTEMPTS_EXCEEDED -18
-
-/*! \brief indicating password retry timeout is not occurred yet */
-#define SECURITY_SERVER_API_ERROR_PASSWORD_EXPIRED -19
-
-/*! \brief indicating password retry timeout is not occurred yet */
-#define SECURITY_SERVER_API_ERROR_PASSWORD_REUSED -20
-
-/*! \brief indicating getting smack label from socket failed */
-#define SECURITY_SERVER_API_ERROR_GETTING_SOCKET_LABEL_FAILED -21
-
-/*! \brief indicating getting smack label from file failed */
-#define SECURITY_SERVER_API_ERROR_GETTING_FILE_LABEL_FAILED -22
-
-/*! \brief indicating setting smack label for file failed */
-#define SECURITY_SERVER_API_ERROR_SETTING_FILE_LABEL_FAILED -23
-
-/*! \brief indicating file already exists */
-#define SECURITY_SERVER_API_ERROR_FILE_EXIST -24
-
-/*! \brief indicating file does not exist */
-#define SECURITY_SERVER_API_ERROR_FILE_NOT_EXIST -25
-
-/*! \brief indicating file open error */
-#define SECURITY_SERVER_API_ERROR_FILE_OPEN_FAILED -26
-
-/*! \brief indicating file creation error */
-#define SECURITY_SERVER_API_ERROR_FILE_CREATION_FAILED -27
-
-/*! \brief indicating file deletion error */
-#define SECURITY_SERVER_API_ERROR_FILE_DELETION_FAILED -28
-
-/*! \brief indicating the error with unknown reason */
-#define SECURITY_SERVER_API_ERROR_UNKNOWN -255
-/** @}*/
-
-
-#ifdef __cplusplus
-extern "C" {
-#endif
-
-
-
-/**
- * \par Description:
- * Retreives Linux group ID from object name which is passed by parameter
- *
- * \par Purpose:
- * This API may be used before security_server_check_privilege() API by middleware daemon to get group ID of a specific object.
- *
- * \par Typical use case:
- * In middleware daemon, before checking privilege of a service the daemon need to know the GID of the service. This API support the functionality.
- *
- * \par Method of function operation:
- * Opens /etc/group file and searches the object name as group name. If there is matching result, returns GID as integer
- *
- * \par Sync (or) Async:
- * This is a Synchronous API.
- *
- * \par Important notes:
- * - This API is only allowed to be called by pre-defined middleware daemon
- *
- * \param[in] object Name of the object which is kwnown by the caller.
- *
- * \return matching gid (positive integer) on success, or negative error code on error.
- *
- * \par Prospective clients:
- * Inhouse middleware
- *
- * \par Known issues/bugs:
- * None
- *
- * \pre None
- *
- * \post None
- *
- * \see /etc/group,
- * security_server_get_object_name(), security_server_check_privilege()
- *
- * \remarks None
- *
- * \par Sample code:
- * \code
- * #include <security-server.h>
- * ...
- * int retval;
- *
- * // You have to make sure that the input param '*object' is defined in the platform
- * retval = security_server_get_gid("telephony_makecall");
- * if(retval < 0)
- * {
- * printf("%s", "Error has occurred\n");
- * exit(0);
- * }
- * ...
- * \endcode
- *
- * Access to this function requires SMACK rule: "<app_label> security-server::api-get-gid w"
-*/
-int security_server_get_gid(const char *object);
-
-/**
- * \par Description:
- * Request cookie to the Security Server. Cookie is a random bit stream which is used as ticket for user space object.
- *
- * \par Purpose:
- * This API may be used by application and client middleware process to get access to middleware daemons.
- *
- * \par Typical use case:
- * When an application process wants to get access to some middleware object, first call this API to get cookie value. Then it calls the service API to get service with the cookie value.
- *
- * \par Method of function operation:
- * Caller process just send request message. Security Server checks proc file system to get list of gIDs the caller belongs, then create a random cookie and responds to caller.
- *
- * \par Sync (or) Async:
- * This is a Synchronous API.
- *
- * \par Important notes:
- * Cookie needs to be stored relatively secure.
- *
- * \param[out] cookie Place holder for cookie value.
- * \param[in] max_cookie Allocated byte size of parameter "cookie".
- *
- * \return 0 on success, or negative error code on error.
- *
- * \par Prospective clients:
- * Any process
- *
- * \par Known issues/bugs:
- * None
- *
- * \pre output parameter cookie must be malloced before calling this API not to make memory curruption
- * Size of the cookie can be retrieved by security_server_get_cookie_size() API.
- *
- * \post None
- *
- * \see security_server_check_privilege(), security_server_get_cookie_size()
- *
- * \remarks None
- *
- * \par Sample code:
- * \code
- * #include <security-server.h>
- * ...
- * int retval;
- * size_t cookie_size;
- * cookie_size = security_server_get_cookie_size();
- * unsigned char cookie[cookie_size];
- *
- * // Call the API
- * retval = security_server_request_cookie(cookie, cookie_size);
- * if(retval < 0)
- * {
- * printf("%s", "Error has occurred\n");
- * exit(0);
- * }
- * ...
- * \endcode
- *
- * Access to this function not requires SMACK rule
-*/
-int security_server_request_cookie(char *cookie, size_t bufferSize);
-
-
-
-/**
- * \par Description:
- * This API gets the cookie's byte size which is issued by Security Server.
- *
- * \par Purpose:
- * This API may be used by application and middleware process to get size of cookie before getting and storing cookie value.
- *
- * \par Typical use case:
- * When an application process wants to get access to some middleware object, first call this API to get cookie value. Then it calls the service API to get service with the cookie value.
- *
- * \par Method of function operation:
- * This API just returns pre-defined integer value as cookie size.
- *
- * \par Sync (or) Async:
- * This is a Synchronous API.
- *
- * \par Important notes:
- * None
- *
- * \return Always returns byte size of the cookie.
- *
- * \par Prospective clients:
- * Any process
- *
- * \par Known issues/bugs:
- * None
- *
- * \pre None
- *
- * \post None
- *
- * \see security_server_request_cookie()
-
- * \remarks None
- *
- * \par Sample code:
- * \code
- * #include <security-server.h>
- * ...
- * int retval;
- * size_t cookie_size;
- *
- * // API calling
- * cookie_size = security_server_get_cookie_size();
- * unsigned char cookie[cookie_size];
- *
- * char objectname[20];
- * retval = security_server_request_cookie(cookie, cookie_size);
- * if(retval < 0)
- * {
- * printf("%s", "Error has occurred\n");
- * exit(0);
- * }
- * ...
- * \endcode
- *
- * Access to this function not requires SMACK rule
-*/
-int security_server_get_cookie_size(void);
-
-
-
-/**
- * \par Description:
- * This API checks the cookie is allowed to access to given object.
- *
- * \par Purpose:
- * This API may be used by middleware process to ask the client application has privilege for the given object.
- *
- * \par Typical use case:
- * When middleware server receives request message from client application process with cookie value, it calls this API to ask to Security Server that the client application has privilege to access the service. If yes, then the middleware daemon can continue service, if not, it can return error to client application.
- *
- * \par Method of function operation:
- * When Security Server receives this request, it searches cookie database and check the cookie is there, if there is matching cookie, then it checks the cookie has the privilege. It returns success if there is match, if not, it returns error.
- *
- * \par Sync (or) Async:
- * This is a Synchronous API.
- *
- * \par Important notes:
- * Cookie value needs to be stored relatively secure\n
- * Privilege should be pre-defined by Platform design.
- *
- * \param[in] cookie Received cookie value from client application
- * \param[in] privilege Object group ID which the client application wants to access
- *
- * \return 0 on success, or negative error code on error.
- *
- * \par Prospective clients:
- * Only pre-defiend middleware daemons
- *
- * \par Known issues/bugs:
- * None
- * \pre None
- *
- * \post None
- *
- * \see security_server_request_cookie(), security_server_get_gid(), security_server_get_cookie_size()
- *
- * \remarks None
- *
- * \par Sample code:
- * \code
- * #include <security-server.h>
- * ...
- * int retval;
- * size_t cookie_size;
- * int call_gid;
- * cookie_size = security_server_get_cookie_size();
- * unsigned char recved_cookie[cookie_size];
- *
- * ... // Receiving request with cookie
- *
- * call_gid = security_server_get_gid("telephony_makecall");
- * retval = security_server_check_privilege(recved_cookie, (gid_t)call_gid);
- * if(retval < 0)
- * {
- * if(retval == SECURITY_SERVER_API_ERROR_ACCESS_DENIED)
- * {
- * printf("%s", "access has been denied\n");
- * return;
- * }
- * printf("%s", "Error has occurred\n");
- * }
- * ...
- *
- * \endcode
- *
- * Access to this function requires SMACK rule: "<app_label> security-server::api-cookie-check w"
-*/
-int security_server_check_privilege(const char *cookie, gid_t privilege);
-
-int security_server_check_privilege_by_cookie(const char *cookie,
- const char *object,
- const char *access_rights);
-
-/**
- * \par Description:
- * This API searchs a cookie value and returns PID of the given cookie.
- *
- * \par Purpose:
- * This API may be used by middleware process to ask the client application has privilege for the given object.
- *
- * \par Typical use case:
- * In some cases, a middleware server wants to know PID of the application process. But if the middleware server uses non-direct IPC such as dbus, it's nearly impossible to know and guarantee peer PID. By using this API, the middleware server can retrieve a PID of the requesting process.
- *
- * \par Method of function operation:
- * When Security Server receives this request, it searches cookie database and check the cookie is there, if there is matching cookie, then it returns corresponding PID for the cookie.
- *
- * \par Sync (or) Async:
- * This is a Synchronous API.
- *
- * \par Important notes:
- * Cookie value needs to be stored relatively secure\n
- * This API is abled to be called only by pre-defined middleware servers.
- *
- * \param[in] cookie Received cookie value from client application. Cookie is not a null terminated human readable string. Make sure you're code doesn't have any string related process on the cookie.
- *
- * \return positive integer on success meaning the PID, 0 means the cookie is for root process, negative integer error code on error.
- *
- * \par Prospective clients:
- * Only pre-defined middleware daemons
- *
- * \par Known issues/bugs:
- * None
- *
- * \pre None
- *
- * \post None
- *
- * \see security_server_request_cookie(), security_server_get_cookie_size()
- *
- * \remarks the cookie is not a null terminated string. Cookie is a BINARY byte stream of such length which can be retrieved by security_server_get_cookie_size() API.
- * Therefore, please do not use strcpy() family to process cookie value. You MUST use memcpy() function to process cookie value.
- * You also have to know that the cookie value doesn't carry any null terminator. So you don't need to allocate 1 more byte of the cookie size.
- *
- * \par Sample code:
- * \code
- * #include <security-server.h>
- * ...
- * int peerpid;
- * size_t cookie_size;
- * gid_t call_gid;
- * cookie_size = security_server_get_cookie_size();
- * unsigned char recved_cookie[cookie_size];
- *
- * ... // Receiving request with cookie
- *
- * peerpid = security_server_get_cookie_pid(recved_cookie);
- * if(peerpid < 0)
- * {
- * printf("%s", "Error has occurred\n");
- * }
- * ...
- *
- * \endcode
- *
- * Access to this function requires SMACK rule: "<app_label> security-server::api-cookie-check w"
-*/
-int security_server_get_cookie_pid(const char *cookie);
-
-
-
-/**
- * \par Description:
- * This API checks phone validity of password, to check existance, expiration, remaining attempts.
- *
- * \par Purpose:
- * This API should be used by applications which needs phone password check. Caller application should behave properly after this API call.
- *
- * \par Typical use case:
- * Lock screen can call this API before it shows unlock screen, if there is password, lock screen can show password input UI, if not, lock screen can show just unlock screen
- *
- * \par Method of function operation:
- * Sends a validate request to security server and security server replies with password information.
- *
- * \par Sync (or) Async:
- * This is a Synchronous API.
- *
- * \par Important notes:
- * Password file should be stored safely. The password file will be stored by security server and only allowed itself to read/write, and data is will be securely hashed\n
- *
- * \param[out] current_attempts Number of password check missed attempts.
- * \param[out] max_attempts Number of maximum attempts that the password locks. 0 means infinite
- * \param[out] valid_secs Remaining time in second which represents this password will be expired. 0xFFFFFFFF means infinite
- *
- * \return 0 if there is no password set, other negative integer error code on error.
- *
- * \par Prospective clients:
- * Applications which can unlock UI
- *
- * \par Known issues/bugs:
- * None
- *
- * \pre None
- *
- * \post None
- *
- * \see security_server_set_pwd(), security_server_chk_pwd()
- *
- * \remarks If password file is corrupted or accidentally deleted, this API may not synchronized with security-server, but security-server will check file status on next request.
- *
- * \par Sample code:
- * \code
- * #include <security-server.h>
- * ...
- * int ret;
- * unsigned int attempt, max_attempt, expire_sec;
- *
- * ret = security_server_is_pwd_valid(&attempt, &max_attempt, &expire_sec);
- * if(is_pwd_set == SECURITY_SERVER_API_ERROR_NO_PASSWORD)
- * {
- * printf("%s", "There is no password exists\n");
- * }
- * else if(is_pwd_set == SECURITY_SERVER_API_SUCCESS && expire_sec > 0 && attempt < max_attempts)
- * {
- * printf("%s", "Password is valid by now\n");
- * }
- * else
- * {
- * printf("%s", "Something wrong\n");
- * }
- * ...
- *
- * \endcode
- *
- * Access to this function requires SMACK rule: "<app_label> security-server::api-password-check w"
-*/
-int security_server_is_pwd_valid(unsigned int *current_attempts,
- unsigned int *max_attempts,
- unsigned int *valid_secs);
-
-
-
-/**
- * \par Description:
- * This API sets phone password only if current password matches.
- *
- * \par Purpose:
- * This API should be used by setting application when the user changes his/her phone password.
- *
- * \par Typical use case:
- * Setting application calls this API to change phone password. Caller needs current password to grant the change.
- *
- * \par Method of function operation:
- * Sends current password with new password to security-server, security-server checks current password and set new password to current only when current password is correct. Caller application can determine maximum number of attempts and expiration time in days
- *
- * \par Sync (or) Async:
- * This is a Synchronous API.
- *
- * \par Important notes:
- * There is retry timer on this API to limit replay attack. You will get error if you called this API too often.\n
- *
- * \param[in] cur_pwd Null terminated current password string. It can be NULL pointer if there is no password set yet - by calling security_server_is_pwd_empty()
- * \param[in] new_pwd Null terminated new password string. It must not a NULL pointer.
- * \param[in] max_challenge Maximum number of attempts that user can try to check the password without success in serial. 0 means infinity.
- * \param[in] valid_period_in_days. Number of days that this password is valid. 0 means infinity
- *
- * \return 0 on success, negative integer error code on error.
- *
- * \par Prospective clients:
- * Platform's THE ONLY setting application and some dedicated privileged processes
- *
- * \par Known issues/bugs:
- * None
- *
- * \pre None
- *
- * \post None
- *
- * \see security_server_is_pwd_valid(), security_server_chk_pwd(), security_server_reset_pwd()
- *
- * \remarks Only setting application can call this API. The password file will be access controlled and securely hashed. Security-server will remain previous password file to recover unexpected password file corruption.
- * \remarks If current password exists and it's expired, or max attempts reached, you cannot call this API. You have to call security_server_reset_pwd() API.
- *
- * \par Sample code:
- * \code
- * #include <security-server.h>
- * ...
- * int ret;
- * unsigned int attempt, max_attempt, expire_sec;
- *
- * ret = security_server_is_pwd_valid(&attempt, &max_attempt, &expire_sec);
- * if(is_pwd_set == SECURITY_SERVER_API_ERROR_NO_PASSWORD)
- * {
- * printf("%s", "There is no password exists\n");
- * ret = security_server_set_pwd(NULL, "this_is_new_pwd", 20, 365);
- * if(ret != SECURITY_SERVER_API_SUCCESS)
- * {
- * printf("%s", "we have error\n");
- * ...
- * }
- * }
- * else if(is_pwd_set == SECURITY_SERVER_API_SUCCESS && expire_sec > 0 && attempt < max_attempts)
- * {
- * printf("%s", "Password is valid by now\n");
- * ret = security_server_set_pwd("this_is_current_pwd", "this_is_new_pwd", 20, 365);
- * if(ret != SECURITY_SERVER_API_SUCCESS)
- * {
- * printf("%s", "we have error\n");
- * ...
- * }
- * }
- * else
- * {
- * printf("%s", "Something wrong\n");
- * }
- * ...
- *
- * \endcode
- *
- * Access to this function requires SMACK rule: "<app_label> security-server::api-password-set w"
-*/
-int security_server_set_pwd(const char *cur_pwd,
- const char *new_pwd,
- const unsigned int max_challenge,
- const unsigned int valid_period_in_days);
-
-
-/**
- * \par Description:
- * This API sets validity period for currently setup password.
- *
- * \par Purpose:
- * This API should be used by Enterprise authorities to modify password policy. To be used only with valid password setup.
- *
- * \par Typical use case:
- * Authorized application calls this API to change current passwords validity when password policy needs to be changed.
- *
- * \par Method of function operation:
- * Function attempts to find currently set password and changes its current validity to passed number of days. Retry counter for the password is reset to zero.
- * If there is no password set, function returns proper error code.
- *
- * \par Sync (or) Async:
- * This is a Synchronous API.
- * \param[in] valid_period_in_days. Number of days that this password is valid. 0 means infinity
- *
- * \return 0 on success, negative integer error code on error.
- *
- * \par Prospective clients:
- * Platform's THE ONLY setting application and some dedicated privileged processes
- *
- * \par Known issues/bugs:
- * Identifying calling peer is not ready yet, should be based on SMACK somehow.
- *
- * \see security_server_is_pwd_valid(), security_server_chk_pwd(), security_server_reset_pwd()
- *
- * Access to this function requires SMACK rule: "<app_label> security-server::api-password-set w"
- */
-int security_server_set_pwd_validity(const unsigned int valid_period_in_days);
-
-
-/**
- * \par Description:
- * This API sets maximum number of attempts for currently setup password.
- *
- * \par Purpose:
- * This API should be used by Enterprise authorities to modify password policy. To be used only with valid password setup.
- *
- * \par Typical use case:
- * Authorized application calls this API to change current passwords max attempt number when password policy needs to be changed.
- *
- * \par Method of function operation:
- * Function attempts to find currently set password and changes its max attempt number to passed one. Retry counter for the password is reset to zero.
- * If there is no password set, function returns proper error code.
- *
- * \par Sync (or) Async:
- * This is a Synchronous API.
- * \param[in] max_challenge Maximum number of attempts that user can try to check the password without success in serial. 0 means infinity.
- *
- * \return 0 on success, negative integer error code on error.
- *
- * \par Prospective clients:
- * Platform's THE ONLY setting application and some dedicated privileged processes
- *
- * \par Known issues/bugs:
- * Identifying calling peer is not ready yet, should be based on SMACK somehow.
- *
- * \see security_server_is_pwd_valid(), security_server_chk_pwd(), security_server_reset_pwd()
- *
- * Access to this function requires SMACK rule: "<app_label> security-server::api-password-set w"
- */
-int security_server_set_pwd_max_challenge(const unsigned int max_challenge);
-
-/**
- * \par Description:
- * This API sets phone password without performing any checks connected with provided password. It
- * should be used only if current password is invalid or user forgot the password.
- *
- * \par Purpose:
- * This API should be used by setting application or dedicated processes when the user changes his/her phone password.
- *
- * \par Typical use case:
- * User forgets the password. He calls emergency manager(auto or manual) for reset password. Emergency manager calls this API and reset phone password.
- *
- * \par Method of function operation:
- * Resetting phone password with input string without any matching current password. Function does
- * no checks before password replacement (expiration time check, currently set password checks,
- * history check and attempt count check are skipped).
- *
- * \par Sync (or) Async:
- * This is a Synchronous API.
- *
- * \par Important notes:
- * There is retry timer on this API to limit replay attack. You will get error if you called this API too often.\n
- *
- * \param[in] new_pwd Null terminated new password string. It must not a NULL pointer.
- * \param[in] max_challenge Maximum number of attempts that user can try to check the password without success in serial. 0 means infinity.
- * \param[in] valid_period_in_days. Number of days that this password is valid. 0 means infinity
- *
- * \return 0 on success, negative integer error code on error.
- *
- * \par Prospective clients:
- * Platform's THE ONLY setting application and some dedicated privileged processes
- *
- * \par Known issues/bugs:
- * None
- *
- * \pre None
- *
- * \post None
- *
- * \see security_server_is_pwd_valid(), security_server_chk_pwd(), security_server_set_pwd()
- *
- * \remarks Only dedicated applications can call this API. The password file will be access controlled and securely hashed. Security-server will remain previous password file to recover unexpected password file corruption.
- *
- * \par Sample code:
- * \code
- * #include <security-server.h>
- * ...
- * int ret;
- *
- * ret = security_server_reset_pwd("this_is_new_pwd", 20, 365);
- * if(retval != SECURITY_SERVER_API_SUCCESS)
- * {
- * printf("%s", "we have error\n");
- * ...
- * }
- * ...
- *
- * \endcode
- *
- * Access to this function requires SMACK rule: "<app_label> security-server::api-password-reset w"
-*/
-int security_server_reset_pwd(const char *new_pwd,
- const unsigned int max_challenge,
- const unsigned int valid_period_in_days);
-
-/**
- * \par Description:
- * This API compares stored phone password with challenged input value.
- *
- * \par Purpose:
- * This API should be used by applications which has phone UI lock capability.
- *
- * \par Typical use case:
- * Lock screen calls this API after user typed phone password and pressed okay.
- *
- * \par Method of function operation:
- * Sends challenged password to security-server, security-server compares hashed current password and hashed challenged password.
- *
- * \par Sync (or) Async:
- * This is a Synchronous API.
- *
- * \par Important notes:
- * There is retry timer on this API to limit replay attack. You will get error if you called this API too often.\n
- *
- * \param[in] challenge Null terminated challenged password string. It must not a NULL pointer.
- * \param[out] current_attempts Number of password check missed attempts.
- * \param[out] max_attempts Number of maximum attempts that the password locks. 0 means infinite
- * \param[out] valid_secs Remaining time in second which represents this password will be expired. 0xFFFFFFFF means infinite
- *
- * \return 0 on success, negative integer error code on error.
- *
- * \par Prospective clients:
- * Applications which has phone UI lock feature.
- *
- * \par Known issues/bugs:
- * None
- *
- * \pre None
- *
- * \post None
- *
- * \see security_server_is_pwd_valid(), security_server_set_pwd()
- *
- * \remarks The password file will be acces controlled and securely hashed. Security-server will remain previous password file to recover unexpected password file curruption.
- *
- * \par Sample code:
- * \code
- * #include <security-server.h>
- * ...
- * int retval;
- * unsigned int attempt, max_attempt, expire_sec;
- *
- * retval = security_server_chk_pwd("is_this_password", &attmpt, &max_attempt, &expire_sec);
- * if(retval == SECURITY_SERVER_API_ERROR_PASSWORD_MISMATCH)
- * {
- * printf("%s", "Oh you typed wrong password\n");
- * ...
- * }
- * else if(retval == SECURITY_SERVER_API_SUCCESS)
- * {
- * printf("%s", "You remember your password.\n");
- * ...
- * }
- * ...
- *
- * \endcode
- *
- * Access to this function requires SMACK rule: "<app_label> security-server::api-password-check w"
-*/
-int security_server_chk_pwd(const char *challenge,
- unsigned int *current_attempt,
- unsigned int *max_attempt,
- unsigned int *valid_secs);
-
-
-/**
- * \par Description:
- * This API set the number of password history which should be maintained. Once this number set, user cannot reuse recent number of passwords which is described in this history value
- *
- * \par Purpose:
- * This API should be used only by dedicated process in the platform.
- *
- * \par Typical use case:
- * Enterprise manager calls this API when the enterprise wants to enforce harder password policy.
- *
- * \par Method of function operation:
- * When enterprise manager (MDM) is trying to change the security policy for phone password, it calls this API background to change the history policy.
- *
- * \par Sync (or) Async:
- * This is a Synchronous API.
- *
- * \par Important notes:
- * There is retry timer on this API to limit replay attack. You will get error if you called this API too often.\n
- *
- * \param[in] history_size Number of history to be checked when user tries to change password. Maximum is currently 50
- *
- * \return 0 on success, negative integer error code on error.
- *
- * \par Prospective clients:
- * MDM client, Enterprise manager.
- *
- * \par Known issues/bugs:
- * None
- *
- * \pre None
- *
- * \post None
- *
- * \see security_server_set_pwd()
- *
- * \remarks The password file will be access controlled and securely hashed. Security-server will remain previous password file to recover unexpected password file curruption.
- *
- * \par Sample code:
- * \code
- * #include <security-server.h>
- * ...
- * int retval;
- *
- * ret = security_server_set_pwd_history(100);
- * if(ret != SECURITY_SERVER_API_SUCCESS)
- * {
- * printf("%s", "You have error\n");
- * ...
- * }
- * ...
- *
- * \endcode
- *
- * Access to this function requires SMACK rule: "<app_label> security-server::api-password-set w"
-*/
-int security_server_set_pwd_history(int history_size);
-
-/*
- * This function allows to get process SMACK label by passing cookie assigned
- * to process. Function returns pointer to allocated buffer with label.
- * User has to free the buffer after using.
- *
- * \param[in] Pointer to cookie
- *
- * \return Pointer to SMACK label or NULL
- *
- * \par For free label use free(), label allocated by calloc()
- * User responsibility is to free resource.
- *
- * Access to this function requires SMACK rule: "<app_label> security-server::api-cookie-check w"
- */
-char *security_server_get_smacklabel_cookie(const char *cookie);
-
-/*
- * This function allows to get process SMACK label by passing socket descriptor.
- * Function returns pointer to allocated buffer with label.
- * User has to free the buffer after using.
- *
- * \param[in] Socket descriptor
- *
- * \return Pointer to SMACK label or NULL
- *
- * \par For free label use free(), label allocated by calloc().
- * User responsibility is to free resource.
- *
- * Access to this function not requires SMACK rule
- */
-char *security_server_get_smacklabel_sockfd(int fd);
-
-/*
- * This function will give permissions "rwxat" from
- * (subject) customer_label to caller process (object).
- * Object label will be extracted from socket.
- *
- * \param[in] CUSTOMER_LABEL execute label of the process that should have access to caller.
- * \param[in] CUSTOMER_PID all rules applied by this function should be removed from system
- * when process with CUSTOMER_PID dies.
- *
- * \return SECURITY_SERVER_API_SUCCESS on success
- * \return SECURITY_SERVER_API_ERROR_GETTING_SOCKET_LABEL_FAILED
- * \return SECURITY_SERVER_API_ERROR_ACCESS_DENIED
- * \return SECURITY_SERVER_API_ERROR_BAD_REQUEST input params were rejected by security-server
- * \return SECURITY_SERVER_API_ERROR_INPUT_PARAM input params were rejected by client library
- * \return SECURITY_SERVER_API_ERROR_SOCKET connection to security server failed.
- *
- * Important: In current implementation CUSTOMER_PID is ignored! This mean that rules applied
- * by this function won't be revoke until device reset!
- *
- * Access to this function requires SMACK rule: "<app_label> security-server::api-data-share w"
- * */
-int security_server_app_give_access(const char *customer_label, int customer_pid);
-
-/*
- * This function allows middleware to check privileges of process with specified PID or socket
- * file descriptor.
- * Service is able to check process access to the specified object label with specified
- * access rights.
- *
- * \param[in] PID id of process or SOCKFD socket file descriptor to be checked
- * \param[in] SMACK object label
- * \param[in] SMACK access rights to be checked
- *
- * \return Privilege confirm or error code
- * \return SECURITY_SERVER_API_SUCCESS - on succes
- *
- * Access to this function requires SMACK rule: "<app_label> security-server::api-privilege-by-pid w"
- */
-int security_server_check_privilege_by_pid(int pid, const char *object, const char *access_rights);
-
-int security_server_check_privilege_by_sockfd(int sockfd,
- const char *object,
- const char *access_rights);
-
-/*
- * This function allows middleware to check if an app has the specified privilege
- * enabled.
- *
- * \param[in] Application ID (smack label)
- * \param[in] Application type
- * \param[in] Privilege name
- * \param[out] Handler to store the result. It is set to 1 (true) if privilege is enabled, 0 (false) otherwise
- *
- * \return SECURITY_SERVER_API_SUCCESS on success or error code on fail
- *
- * Access to this function requires SMACK rule: "<app_label> security-server::api-app-privilege-by-name w"
- */
-int security_server_app_has_privilege(const char *app_label,
- app_type_t app_type,
- const char *privilege_name,
- int *result);
-
-#ifdef __cplusplus
-}
-#endif
-
-/**
- * @}
-*/
-
-/**
- * @}
-*/
-
-#endif
#include <message-buffer.h>
-#include <security-server.h>
+#include <security-manager.h>
IMPLEMENT_SAFE_SINGLETON(SecurityServer::Log::LogSystem);
if (m_sock < 0) {
int err = errno;
LogError("Error creating socket: " << strerror(err));
- return SECURITY_SERVER_API_ERROR_SOCKET;
+ return SECURITY_MANAGER_API_ERROR_SOCKET;
}
if ((flags = fcntl(m_sock, F_GETFL, 0)) < 0 ||
{
int err = errno;
LogError("Error in fcntl: " << strerror(err));
- return SECURITY_SERVER_API_ERROR_SOCKET;
+ return SECURITY_MANAGER_API_ERROR_SOCKET;
}
memset(&clientAddr, 0, sizeof(clientAddr));
if (strlen(interface) >= sizeof(clientAddr.sun_path)) {
LogError("Error: interface name " << interface << "is too long. Max len is:" << sizeof(clientAddr.sun_path));
- return SECURITY_SERVER_API_ERROR_NO_SUCH_SERVICE;
+ return SECURITY_MANAGER_API_ERROR_NO_SUCH_SERVICE;
}
strcpy(clientAddr.sun_path, interface);
if ((retval == -1) && (errno == EINPROGRESS)) {
if (0 >= waitForSocket(m_sock, POLLIN, POLL_TIMEOUT)) {
LogError("Error in waitForSocket.");
- return SECURITY_SERVER_API_ERROR_SOCKET;
+ return SECURITY_MANAGER_API_ERROR_SOCKET;
}
int error = 0;
socklen_t len = sizeof(error);
if (-1 == retval) {
int err = errno;
LogError("Error in getsockopt: " << strerror(err));
- return SECURITY_SERVER_API_ERROR_SOCKET;
+ return SECURITY_MANAGER_API_ERROR_SOCKET;
}
if (error == EACCES) {
LogError("Access denied");
- return SECURITY_SERVER_API_ERROR_ACCESS_DENIED;
+ return SECURITY_MANAGER_API_ERROR_ACCESS_DENIED;
}
if (error != 0) {
LogError("Error in connect: " << strerror(error));
- return SECURITY_SERVER_API_ERROR_SOCKET;
+ return SECURITY_MANAGER_API_ERROR_SOCKET;
}
- return SECURITY_SERVER_API_SUCCESS;
+ return SECURITY_MANAGER_API_SUCCESS;
}
if (-1 == retval) {
int err = errno;
LogError("Error connecting socket: " << strerror(err));
if (err == EACCES)
- return SECURITY_SERVER_API_ERROR_ACCESS_DENIED;
+ return SECURITY_MANAGER_API_ERROR_ACCESS_DENIED;
if (err == ENOTSOCK)
- return SECURITY_SERVER_API_ERROR_NO_SUCH_SERVICE;
- return SECURITY_SERVER_API_ERROR_SOCKET;
+ return SECURITY_MANAGER_API_ERROR_NO_SUCH_SERVICE;
+ return SECURITY_MANAGER_API_ERROR_SOCKET;
}
- return SECURITY_SERVER_API_SUCCESS;
+ return SECURITY_MANAGER_API_SUCCESS;
}
int Get() {
ssize_t done = 0;
char buffer[2048];
- if (SECURITY_SERVER_API_SUCCESS != (ret = sock.Connect(interface))) {
+ if (SECURITY_MANAGER_API_SUCCESS != (ret = sock.Connect(interface))) {
LogError("Error in SockRAII");
return ret;
}
while ((send.size() - done) > 0) {
if (0 >= waitForSocket(sock.Get(), POLLOUT, POLL_TIMEOUT)) {
LogError("Error in poll(POLLOUT)");
- return SECURITY_SERVER_API_ERROR_SOCKET;
+ return SECURITY_MANAGER_API_ERROR_SOCKET;
}
ssize_t temp = TEMP_FAILURE_RETRY(write(sock.Get(), &send[done], send.size() - done));
if (-1 == temp) {
int err = errno;
LogError("Error in write: " << strerror(err));
- return SECURITY_SERVER_API_ERROR_SOCKET;
+ return SECURITY_MANAGER_API_ERROR_SOCKET;
}
done += temp;
}
do {
if (0 >= waitForSocket(sock.Get(), POLLIN, POLL_TIMEOUT)) {
LogError("Error in poll(POLLIN)");
- return SECURITY_SERVER_API_ERROR_SOCKET;
+ return SECURITY_MANAGER_API_ERROR_SOCKET;
}
ssize_t temp = TEMP_FAILURE_RETRY(read(sock.Get(), buffer, 2048));
if (-1 == temp) {
int err = errno;
LogError("Error in read: " << strerror(err));
- return SECURITY_SERVER_API_ERROR_SOCKET;
+ return SECURITY_MANAGER_API_ERROR_SOCKET;
}
if (0 == temp) {
LogError("Read return 0/Connection closed by server(?)");
- return SECURITY_SERVER_API_ERROR_SOCKET;
+ return SECURITY_MANAGER_API_ERROR_SOCKET;
}
RawBuffer raw(buffer, buffer+temp);
recv.Push(raw);
} while(!recv.Ready());
- return SECURITY_SERVER_API_SUCCESS;
+ return SECURITY_MANAGER_API_SUCCESS;
}
int sendToServerAncData(char const * const interface, const RawBuffer &send, struct msghdr &hdr) {
SockRAII sock;
ssize_t done = 0;
- if (SECURITY_SERVER_API_SUCCESS != (ret = sock.Connect(interface))) {
+ if (SECURITY_MANAGER_API_SUCCESS != (ret = sock.Connect(interface))) {
LogError("Error in SockRAII");
return ret;
}
while ((send.size() - done) > 0) {
if (0 >= waitForSocket(sock.Get(), POLLOUT, POLL_TIMEOUT)) {
LogError("Error in poll(POLLOUT)");
- return SECURITY_SERVER_API_ERROR_SOCKET;
+ return SECURITY_MANAGER_API_ERROR_SOCKET;
}
ssize_t temp = TEMP_FAILURE_RETRY(write(sock.Get(), &send[done], send.size() - done));
if (-1 == temp) {
int err = errno;
LogError("Error in write: " << strerror(err));
- return SECURITY_SERVER_API_ERROR_SOCKET;
+ return SECURITY_MANAGER_API_ERROR_SOCKET;
}
done += temp;
}
if (0 >= waitForSocket(sock.Get(), POLLIN, POLL_TIMEOUT)) {
LogError("Error in poll(POLLIN)");
- return SECURITY_SERVER_API_ERROR_SOCKET;
+ return SECURITY_MANAGER_API_ERROR_SOCKET;
}
ssize_t temp = TEMP_FAILURE_RETRY(recvmsg(sock.Get(), &hdr, MSG_CMSG_CLOEXEC));
if (temp < 0) {
int err = errno;
LogError("Error in recvmsg(): " << strerror(err) << " errno: " << err);
- return SECURITY_SERVER_API_ERROR_SOCKET;
+ return SECURITY_MANAGER_API_ERROR_SOCKET;
}
if (0 == temp) {
LogError("Read return 0/Connection closed by server(?)");
- return SECURITY_SERVER_API_ERROR_SOCKET;
+ return SECURITY_MANAGER_API_ERROR_SOCKET;
}
- return SECURITY_SERVER_API_SUCCESS;
+ return SECURITY_MANAGER_API_SUCCESS;
}
int try_catch(const std::function<int()>& func)
} catch (...) {
LogError("Unknown exception occured");
}
- return SECURITY_SERVER_API_ERROR_UNKNOWN;
+ return SECURITY_MANAGER_API_ERROR_UNKNOWN;
}
} // namespace SecurityServer
projects / platform / core / security / security-manager.git / commitdiff