src/include/security-server.h

   1 /*
   2  *  security-server
   3  *
   4  *  Copyright (c) 2000 - 2011 Samsung Electronics Co., Ltd All Rights Reserved
   5  *
   6  *  Contact: Bumjin Im <bj.im@samsung.com>
   7  *
   8  *  Licensed under the Apache License, Version 2.0 (the "License");
   9  *  you may not use this file except in compliance with the License.
  10  *  You may obtain a copy of the License at
  11  *
  12  *      http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  *  Unless required by applicable law or agreed to in writing, software
  15  *  distributed under the License is distributed on an "AS IS" BASIS,
  16  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  17  *  See the License for the specific language governing permissions and
  18  *  limitations under the License
  19  *
  20  */
  21
  22 #ifndef SECURITY_SERVER_H
  23 #define SECURITY_SERVER_H
  24
  25 #include <sys/types.h>
  26 #include <privilege-control.h>
  27
  28 /**
  29  * @file    security-server.h
  30  * @version 1.0
  31  * @brief   This file contains APIs of the Security Server
  32 */
  33
  34 /**
  35  * @defgroup SecurityFW
  36  * @{
  37  *
  38  * @defgroup SECURITY_SERVER Security Server
  39  * @version  1.0
  40  * @brief    Security Server client library functions
  41  *
  42 */
  43
  44 /**
  45  * @addtogroup SECURITY_SERVER
  46  * @{
  47 */
  48
  49 /*
  50  * ====================================================================================================
  51  * <tt>
  52  *
  53  * Revision History:
  54  *
  55  *  -- Company Name -- | Modification Date | Description of Changes
  56  *  -----------------------------------------------------------------------
  57  *   --- Samsung ------ | --- 2010-07-25 -- | First created
  58  *
  59  *    </tt>
  60  */
  61
  62 /**
  63  * \name Return Codes
  64  * exported by the foundation API.
  65  * result codes begin with the start error code and extend into negative direction.
  66  * @{
  67 */
  68 #define SECURITY_SERVER_API_SUCCESS 0
  69 /*! \brief   indicating the result of the one specific API is successful */
  70 #define SECURITY_SERVER_API_ERROR_SOCKET -1
  71
  72 /*! \brief   indicating the socket between client and Security Server has been failed  */
  73 #define SECURITY_SERVER_API_ERROR_BAD_REQUEST -2
  74
  75 /*! \brief   indicating the response from Security Server is malformed */
  76 #define SECURITY_SERVER_API_ERROR_BAD_RESPONSE -3
  77
  78 /*! \brief   indicating the transmitting request has been failed */
  79 #define SECURITY_SERVER_API_ERROR_SEND_FAILED -4
  80
  81 /*! \brief   indicating the receiving response has been failed */
  82 #define SECURITY_SERVER_API_ERROR_RECV_FAILED -5
  83
  84 /*! \brief   indicating requesting object is not exist */
  85 #define SECURITY_SERVER_API_ERROR_NO_SUCH_OBJECT -6
  86
  87 /*! \brief   indicating the authentication between client and server has been failed */
  88 #define SECURITY_SERVER_API_ERROR_AUTHENTICATION_FAILED -7
  89
  90 /*! \brief   indicating the API's input parameter is malformed */
  91 #define SECURITY_SERVER_API_ERROR_INPUT_PARAM -8
  92
  93 /*! \brief   indicating the output buffer size which is passed as parameter is too small */
  94 #define SECURITY_SERVER_API_ERROR_BUFFER_TOO_SMALL -9
  95
  96 /*! \brief   indicating system  is running out of memory state */
  97 #define SECURITY_SERVER_API_ERROR_OUT_OF_MEMORY -10
  98
  99 /*! \brief   indicating the access has been denied by Security Server */
 100 #define SECURITY_SERVER_API_ERROR_ACCESS_DENIED -11
 101
 102 /*! \brief   indicating Security Server has been failed for some reason */
 103 #define SECURITY_SERVER_API_ERROR_SERVER_ERROR -12
 104
 105 /*! \brief   indicating given cookie is not exist in the database  */
 106 #define SECURITY_SERVER_API_ERROR_NO_SUCH_COOKIE -13
 107
 108 /*! \brief   indicating there is no phone password set  */
 109 #define SECURITY_SERVER_API_ERROR_NO_PASSWORD -14
 110
 111 /*! \brief   indicating password exists in system  */
 112 #define SECURITY_SERVER_API_ERROR_PASSWORD_EXIST -15
 113
 114 /*! \brief   indicating password mismatch  */
 115 #define SECURITY_SERVER_API_ERROR_PASSWORD_MISMATCH -16
 116
 117 /*! \brief   indicating password retry timeout is not occurred yet  */
 118 #define SECURITY_SERVER_API_ERROR_PASSWORD_RETRY_TIMER -17
 119
 120 /*! \brief   indicating password retry timeout is not occurred yet  */
 121 #define SECURITY_SERVER_API_ERROR_PASSWORD_MAX_ATTEMPTS_EXCEEDED -18
 122
 123 /*! \brief   indicating password retry timeout is not occurred yet  */
 124 #define SECURITY_SERVER_API_ERROR_PASSWORD_EXPIRED -19
 125
 126 /*! \brief   indicating password retry timeout is not occurred yet  */
 127 #define SECURITY_SERVER_API_ERROR_PASSWORD_REUSED -20
 128
 129 /*! \brief   indicating getting smack label from socket failed  */
 130 #define SECURITY_SERVER_API_ERROR_GETTING_SOCKET_LABEL_FAILED -21
 131
 132 /*! \brief   indicating the error with unknown reason */
 133 #define SECURITY_SERVER_API_ERROR_UNKNOWN -255
 134 /** @}*/
 135
 136
 137 #ifdef __cplusplus
 138 extern "C" {
 139 #endif
 140
 141
 142
 143 /**
 144  * \par Description:
 145  * Retreives Linux group ID from object name which is passed by parameter
 146  *
 147  * \par Purpose:
 148  * This API may be used before security_server_check_privilege() API by middleware daemon to get group ID of a specific object.
 149  *
 150  * \par Typical use case:
 151  * In middleware daemon, before checking privilege of a service the daemon need to know the GID of the service. This API support the functionality.
 152  *
 153  * \par Method of function operation:
 154  * Opens /etc/group file and searches the object name as group name. If there is matching result, returns GID as integer
 155  *
 156  * \par Sync (or) Async:
 157  * This is a Synchronous API.
 158  *
 159  * \par Important notes:
 160  * - This API is only allowed to be called by pre-defined middleware daemon
 161  *
 162  * \param[in] object Name of the object which is kwnown by the caller.
 163  *
 164  * \return matching gid (positive integer) on success, or negative error code on error.
 165  *
 166  * \par Prospective clients:
 167  * Inhouse middleware
 168  *
 169  * \par Known issues/bugs:
 170  * None
 171  *
 172  * \pre None
 173  *
 174  * \post None
 175  *
 176  * \see /etc/group,
 177  * security_server_get_object_name(), security_server_check_privilege()
 178  *
 179  * \remarks None
 180  *
 181  * \par Sample code:
 182  * \code
 183  * #include <security-server.h>
 184  * ...
 185  * int retval;
 186  *
 187  * // You have to make sure that  the input param '*object' is defined in the platform
 188  * retval = security_server_get_gid("telephony_makecall");
 189  * if(retval < 0)
 190  * {
 191  *      printf("%s", "Error has occurred\n");
 192  *      exit(0);
 193  * }
 194  * ...
 195  * \endcode
 196  *
 197  * Access to this function requires SMACK rule: "<app_label> security-server::api-get-gid w"
 198 */
 199 int security_server_get_gid(const char *object);
 200
 201
 202
 203 /**
 204  * \par Description:
 205  * Retreives object name as mull terminated string from Linux group ID which is passed by parameter
 206  *
 207  * \par Purpose:
 208  * This API may be used to get object name if the caller process only knows GID of the object.
 209  *
 210  * \par Typical use case:
 211  * In middleware daemon, by some reason, need to know object name from the Linux group ID, then call this API to retrieve object name as string
 212  *
 213  * \par Method of function operation:
 214  * Opens /etc/group file and searches matching gid. If there is matching result, returns name of the group as null terminated string
 215  *
 216  * \par Sync (or) Async:
 217  * This is a Synchronous API.
 218  *
 219  * \par Important notes:
 220  * - This API is only allowed to be called by pre-defined middleware daemon
 221  *
 222  * \param[in] gid Linux group ID which needed to be retrieved as object name.
 223  * \param[out] object Place holder for matching object name for gid.
 224  * \param[in] max_object_size Allocated byte size of parameter "object".
 225  *
 226  * \return 0 on success, or negative error code on error.
 227  *
 228  * \par Prospective clients:
 229  * Inhouse middleware.
 230  *
 231  * \par Known issues/bugs:
 232  * None
 233  *
 234  * \pre output parameter object must be malloced before calling this API not to make memory curruption
 235  *
 236  * \post None
 237  *
 238  * \see /etc/group,
 239  * security_server_get_gid()
 240  *
 241  * \remarks None
 242  *
 243  * \par Sample code:
 244  * \code
 245  * #include <security-server.h>
 246  * ...
 247  * int retval;
 248  * char objectname[20];
 249  *
 250  * // Call the API
 251  * retval = security_server_get_object_name(6005, objectname, sizeof(objectname));
 252  * if(retval < 0)
 253  * {
 254  *      printf("%s", "Error has occurred\n");
 255  *      exit(0);
 256  * }
 257  * ...
 258  * \endcode
 259  *
 260  * Access to this function requires SMACK rule: "<app_label> security-server::api-get-object-name w"
 261 */
 262 int security_server_get_object_name(gid_t gid, char *object, size_t max_object_size);
 263
 264
 265
 266 /**
 267  * \par Description:
 268  * Request cookie to the Security Server. Cookie is a random bit stream which is used as ticket for user space object.
 269  *
 270  * \par Purpose:
 271  * This API may be used by application and client middleware process to get access to middleware daemons.
 272  *
 273  * \par Typical use case:
 274  * 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.
 275  *
 276  * \par Method of function operation:
 277  * 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.
 278  *
 279  * \par Sync (or) Async:
 280  * This is a Synchronous API.
 281  *
 282  * \par Important notes:
 283  * Cookie needs to be stored relatively secure.
 284  *
 285  * \param[out] cookie Place holder for cookie value.
 286  * \param[in] max_cookie Allocated byte size of parameter "cookie".
 287  *
 288  * \return 0 on success, or negative error code on error.
 289  *
 290  * \par Prospective clients:
 291  * Any process
 292  *
 293  * \par Known issues/bugs:
 294  * None
 295  *
 296  * \pre output parameter cookie must be malloced before calling this API not to make memory curruption
 297  * Size of the cookie can be retrieved by security_server_get_cookie_size() API.
 298  *
 299  * \post None
 300  *
 301  * \see security_server_check_privilege(), security_server_get_cookie_size()
 302  *
 303  * \remarks None
 304  *
 305  * \par Sample code:
 306  * \code
 307  * #include <security-server.h>
 308  * ...
 309  * int retval;
 310  * size_t cookie_size;
 311  * cookie_size = security_server_get_cookie_size();
 312  * unsigned char cookie[cookie_size];
 313  *
 314  * // Call the API
 315  * retval = security_server_request_cookie(cookie, cookie_size);
 316  * if(retval < 0)
 317  * {
 318  *      printf("%s", "Error has occurred\n");
 319  *      exit(0);
 320  * }
 321  * ...
 322  * \endcode
 323  *
 324  * Access to this function not requires SMACK rule
 325 */
 326 int security_server_request_cookie(char *cookie, size_t bufferSize);
 327
 328
 329
 330 /**
 331  * \par Description:
 332  * This API gets the cookie's byte size which is issued by Security Server.
 333  *
 334  * \par Purpose:
 335  * This API may be used by application and middleware process to get size of cookie before getting and storing cookie value.
 336  *
 337  * \par Typical use case:
 338  * 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.
 339  *
 340  * \par Method of function operation:
 341  * This API just returns pre-defined integer value as cookie size.
 342  *
 343  * \par Sync (or) Async:
 344  * This is a Synchronous API.
 345  *
 346  * \par Important notes:
 347  * None
 348  *
 349  * \return Always returns byte size of the cookie.
 350  *
 351  * \par Prospective clients:
 352  * Any process
 353  *
 354  * \par Known issues/bugs:
 355  * None
 356  *
 357  * \pre None
 358  *
 359  * \post None
 360  *
 361  * \see security_server_request_cookie()
 362
 363  * \remarks None
 364  *
 365  * \par Sample code:
 366  * \code
 367  * #include <security-server.h>
 368  * ...
 369  * int retval;
 370  * size_t cookie_size;
 371  *
 372  * // API calling
 373  * cookie_size = security_server_get_cookie_size();
 374  * unsigned char cookie[cookie_size];
 375  *
 376  * char objectname[20];
 377  * retval = security_server_request_cookie(cookie, cookie_size);
 378  * if(retval < 0)
 379  * {
 380  *      printf("%s", "Error has occurred\n");
 381  *      exit(0);
 382  * }
 383  * ...
 384  * \endcode
 385  *
 386  * Access to this function not requires SMACK rule
 387 */
 388 int security_server_get_cookie_size(void);
 389
 390
 391
 392 /**
 393  * \par Description:
 394  * This API checks the cookie is allowed to access to given object.
 395  *
 396  * \par Purpose:
 397  * This API may be used by middleware process to ask the client application has privilege for the given object.
 398  *
 399  * \par Typical use case:
 400  * 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.
 401  *
 402  * \par Method of function operation:
 403  * 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.
 404  *
 405  * \par Sync (or) Async:
 406  * This is a Synchronous API.
 407  *
 408  * \par Important notes:
 409  * Cookie value needs to be stored relatively secure\n
 410  * Privilege should be pre-defined by Platform design.
 411  *
 412  * \param[in] cookie Received cookie value from client application
 413  * \param[in] privilege Object group ID which the client application wants to access
 414  *
 415  * \return 0 on success, or negative error code on error.
 416  *
 417  * \par Prospective clients:
 418  * Only pre-defiend middleware daemons
 419  *
 420  * \par Known issues/bugs:
 421  * None
 422  * \pre None
 423  *
 424  * \post None
 425  *
 426  * \see security_server_request_cookie(), security_server_get_gid(), security_server_get_cookie_size()
 427  *
 428  * \remarks None
 429  *
 430  * \par Sample code:
 431  * \code
 432  * #include <security-server.h>
 433  * ...
 434  * int retval;
 435  * size_t cookie_size;
 436  * int call_gid;
 437  * cookie_size = security_server_get_cookie_size();
 438  * unsigned char recved_cookie[cookie_size];
 439  *
 440  * ... // Receiving request with cookie
 441  *
 442  * call_gid = security_server_get_gid("telephony_makecall");
 443  * retval = security_server_check_privilege(recved_cookie, (gid_t)call_gid);
 444  * if(retval < 0)
 445  * {
 446  *      if(retval == SECURITY_SERVER_API_ERROR_ACCESS_DENIED)
 447  *      {
 448  *              printf("%s", "access has been denied\n");
 449  *              return;
 450  *      }
 451  *      printf("%s", "Error has occurred\n");
 452  * }
 453  * ...
 454  *
 455  * \endcode
 456  *
 457  * Access to this function requires SMACK rule: "<app_label> security-server::api-cookie-check w"
 458 */
 459 int security_server_check_privilege(const char *cookie, gid_t privilege);
 460
 461 int security_server_check_privilege_by_cookie(const char *cookie,
 462                                               const char *object,
 463                                               const char *access_rights);
 464
 465 int security_server_check_privilege_by_sockfd(int sockfd,
 466                                               const char *object,
 467                                               const char *access_rights);
 468
 469 /**
 470  * \par Description:
 471  * This API searchs a cookie value and returns PID of the given cookie.
 472  *
 473  * \par Purpose:
 474  * This API may be used by middleware process to ask the client application has privilege for the given object.
 475  *
 476  * \par Typical use case:
 477  * 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.
 478  *
 479  * \par Method of function operation:
 480  * 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.
 481  *
 482  * \par Sync (or) Async:
 483  * This is a Synchronous API.
 484  *
 485  * \par Important notes:
 486  * Cookie value needs to be stored relatively secure\n
 487  * This API is abled to be called only by pre-defined middleware servers.
 488  *
 489  * \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.
 490  *
 491  * \return positive integer on success meaning the PID, 0 means the cookie is for root process, negative integer error code on error.
 492  *
 493  * \par Prospective clients:
 494  * Only pre-defiend middleware daemons
 495  *
 496  * \par Known issues/bugs:
 497  * None
 498  *
 499  * \pre None
 500  *
 501  * \post None
 502  *
 503  * \see security_server_request_cookie(), security_server_get_cookie_size()
 504  *
 505  * \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.
 506  * Therefore, please do not use strcpy() family to process cookie value. You MUST use memcpy() function to process cookie value.
 507  * 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.
 508  *
 509  * \par Sample code:
 510  * \code
 511  * #include <security-server.h>
 512  * ...
 513  * int peerpid;
 514  * size_t cookie_size;
 515  * gid_t call_gid;
 516  * cookie_size = security_server_get_cookie_size();
 517  * unsigned char recved_cookie[cookie_size];
 518  *
 519  * ... // Receiving request with cookie
 520  *
 521  * peerpid = security_server_get_cookie_pid(recved_cookie);
 522  * if(peerpid < 0)
 523  * {
 524  *      printf("%s", "Error has occurred\n");
 525  * }
 526  * ...
 527  *
 528  * \endcode
 529  *
 530  * Access to this function requires SMACK rule: "<app_label> security-server::api-cookie-check w"
 531 */
 532 int security_server_get_cookie_pid(const char *cookie);
 533
 534
 535
 536 /**
 537  * \par Description:
 538  * This API checks phone validity of password, to check existance, expiration, remaining attempts.
 539  *
 540  * \par Purpose:
 541  * This API should be used by applications which needs phone password check. Caller application should behave properly after this API call.
 542  *
 543  * \par Typical use case:
 544  * 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
 545  *
 546  * \par Method of function operation:
 547  * Sends a validate request to security server and security server replies with password information.
 548  *
 549  * \par Sync (or) Async:
 550  * This is a Synchronous API.
 551  *
 552  * \par Important notes:
 553  * 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
 554  *
 555  * \param[out] current_attempts Number of password check missed attempts.
 556  * \param[out] max_attempts Number of maximum attempts that the password locks. 0 means infinite
 557  * \param[out] valid_secs Remaining time in second which represents this password will be expired. 0xFFFFFFFF means infinite
 558  *
 559  * \return 0 if there is no password set, other negative integer error code on error.
 560  *
 561  * \par Prospective clients:
 562  * Applications which can unlock UI
 563  *
 564  * \par Known issues/bugs:
 565  * None
 566  *
 567  * \pre None
 568  *
 569  * \post None
 570  *
 571  * \see security_server_set_pwd(), security_server_chk_pwd()
 572  *
 573  * \remarks If password file is currupted or accitentally deleted, this API may not synchronized with security-server, but security-server will check file status on next request.
 574  *
 575  * \par Sample code:
 576  * \code
 577  * #include <security-server.h>
 578  * ...
 579  * int ret;
 580  * unsigned int attempt, max_attempt, expire_sec;
 581  *
 582  * ret = security_server_is_pwd_valid(&attempt, &max_attempt, &expire_sec);
 583  * if(is_pwd_set == SECURITY_SERVER_API_ERROR_NO_PASSWORD)
 584  * {
 585  *      printf("%s", "There is no password exists\n");
 586  * }
 587  * else if(is_pwd_set == SECURITY_SERVER_SUCCESS && expire_sec > 0 && attempt < max_attempts)
 588  * {
 589  *      printf("%s", "Password is valid by now\n");
 590  * }
 591  * else
 592  * {
 593  *      printf("%s", "Something wrong\n");
 594  * }
 595  * ...
 596  *
 597  * \endcode
 598  *
 599  * Access to this function requires SMACK rule: "<app_label> security-server::api-password-check w"
 600 */
 601 int security_server_is_pwd_valid(unsigned int *current_attempts,
 602                                  unsigned int *max_attempts,
 603                                  unsigned int *valid_secs);
 604
 605
 606
 607 /**
 608  * \par Description:
 609  * This API sets phone password only if current password matches.
 610  *
 611  * \par Purpose:
 612  * This API should be used by setting application when the user changes his/her phone password.
 613  *
 614  * \par Typical use case:
 615  * Setting application calls this API to change phone password. Caller needs current password to grant the change.
 616  *
 617  * \par Method of function operation:
 618  * 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
 619  *
 620  * \par Sync (or) Async:
 621  * This is a Synchronous API.
 622  *
 623  * \par Important notes:
 624  * There is retry timer on this API to limit replay attack. You will get error if you called this API too often.\n
 625  *
 626  * \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()
 627  * \param[in] new_pwd Null terminated new password string. It must not a NULL pointer.
 628  * \param[in] max_challenge Maximum number of attempts that user can try to check the password without success in serial. 0 means infinity.
 629  * \param[in] valid_period_in_days. Number of days that this password is valid. 0 means infinity
 630  *
 631  * \return 0 on seccuess, negative integer error code on error.
 632  *
 633  * \par Prospective clients:
 634  * Platform's THE ONLY setting application and some dedicated privileged processes
 635  *
 636  * \par Known issues/bugs:
 637  * None
 638  *
 639  * \pre None
 640  *
 641  * \post None
 642  *
 643  * \see security_server_is_pwd_valid(), security_server_chk_pwd(), security_server_reset_pwd()
 644  *
 645  * \remarks Only setting application can call this API. The password file will be acces controlled and securely hashed. Security-server will remain previous password file to recover unexpected password file curruption.
 646  * \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.
 647  *
 648  * \par Sample code:
 649  * \code
 650  * #include <security-server.h>
 651  * ...
 652  * int ret;
 653  * unsigned int attempt, max_attempt, expire_sec;
 654  *
 655  * ret = security_server_is_pwd_valid(&attempt, &max_attempt, &expire_sec);
 656  * if(is_pwd_set == SECURITY_SERVER_API_ERROR_NO_PASSWORD)
 657  * {
 658  *      printf("%s", "There is no password exists\n");
 659  *      ret = security_server_set_pwd(NULL, "this_is_new_pwd", 20, 365);
 660  *      if(ret != SECURITY_SERVER_API_SUCCESS)
 661  *      {
 662  *              printf("%s", "we have error\n");
 663  *              ...
 664  *      }
 665  * }
 666  * else if(is_pwd_set == SECURITY_SERVER_SUCCESS && expire_sec > 0 && attempt < max_attempts)
 667  * {
 668  *      printf("%s", "Password is valid by now\n");
 669  *      ret = security_server_set_pwd("this_is_current_pwd", "this_is_new_pwd", 20, 365);
 670  *      if(ret != SECURITY_SERVER_API_SUCCESS)
 671  *      {
 672  *              printf("%s", "we have error\n");
 673  *              ...
 674  *      }
 675  * }
 676  * else
 677  * {
 678  *      printf("%s", "Something wrong\n");
 679  * }
 680  * ...
 681  *
 682  * \endcode
 683  *
 684  * Access to this function requires SMACK rule: "<app_label> security-server::api-password-set w"
 685 */
 686 int security_server_set_pwd(const char *cur_pwd,
 687                             const char *new_pwd,
 688                             const unsigned int max_challenge,
 689                             const unsigned int valid_period_in_days);
 690
 691
 692 /**
 693  * \par Description:
 694  * This API sets validity period for currently setup password.
 695  *
 696  * \par Purpose:
 697  * This API should be used by Enterprise authorities to modify password policy. To be used only with valid password setup.
 698  *
 699  * \par Typical use case:
 700  * Authorized application calls this API to change current passwords validity when password policy needs to be changed.
 701  *
 702  * \par Method of function operation:
 703  * 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.
 704  * If there is no password set, function returns proper error code.
 705  *
 706  * \par Sync (or) Async:
 707  * This is a Synchronous API.
 708  * \param[in] valid_period_in_days. Number of days that this password is valid. 0 means infinity
 709  *
 710  * \return 0 on success, negative integer error code on error.
 711  *
 712  * \par Prospective clients:
 713  * Platform's THE ONLY setting application and some dedicated privileged processes
 714  *
 715  * \par Known issues/bugs:
 716  * Identifying calling peer is not ready yet, should be based on SMACK somehow.
 717  *
 718  * \see security_server_is_pwd_valid(), security_server_chk_pwd(), security_server_reset_pwd()
 719  *
 720  * Access to this function requires SMACK rule: "<app_label> security-server::api-password-set w"
 721  */
 722 int security_server_set_pwd_validity(const unsigned int valid_period_in_days);
 723
 724
 725 /**
 726  * \par Description:
 727  * This API sets maximum number of attempts for currently setup password.
 728  *
 729  * \par Purpose:
 730  * This API should be used by Enterprise authorities to modify password policy. To be used only with valid password setup.
 731  *
 732  * \par Typical use case:
 733  * Authorized application calls this API to change current passwords max attempt number when password policy needs to be changed.
 734  *
 735  * \par Method of function operation:
 736  * 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.
 737  * If there is no password set, function returns proper error code.
 738  *
 739  * \par Sync (or) Async:
 740  * This is a Synchronous API.
 741  * \param[in] max_challenge Maximum number of attempts that user can try to check the password without success in serial. 0 means infinity.
 742  *
 743  * \return 0 on success, negative integer error code on error.
 744  *
 745  * \par Prospective clients:
 746  * Platform's THE ONLY setting application and some dedicated privileged processes
 747  *
 748  * \par Known issues/bugs:
 749  * Identifying calling peer is not ready yet, should be based on SMACK somehow.
 750  *
 751  * \see security_server_is_pwd_valid(), security_server_chk_pwd(), security_server_reset_pwd()
 752  *
 753  * Access to this function requires SMACK rule: "<app_label> security-server::api-password-set w"
 754  */
 755 int security_server_set_pwd_max_challenge(const unsigned int max_challenge);
 756
 757 /**
 758  * \par Description:
 759  * This API sets phone password only if current password is invalid or user forgot the password.
 760  *
 761  * \par Purpose:
 762  * This API should be used by setting application or dedicated processes when the user changes his/her phone password.
 763  *
 764  * \par Typical use case:
 765  * User forgots the password. He calls emergency manager(auto or manual)  for reset password. Emergency manager calls this API and reset phone password.
 766  *
 767  * \par Method of function operation:
 768  * Resetting phone password with input string without any matching current password.
 769  *
 770  * \par Sync (or) Async:
 771  * This is a Synchronous API.
 772  *
 773  * \par Important notes:
 774  * There is retry timer on this API to limit replay attack. You will get error if you called this API too often.\n
 775  *
 776  * \param[in] new_pwd Null terminated new password string. It must not a NULL pointer.
 777  * \param[in] max_challenge Maximum number of attempts that user can try to check the password without success in serial. 0 means infinity.
 778  * \param[in] valid_period_in_days. Number of days that this password is valid. 0 means infinity
 779  *
 780  * \return 0 on seccuess, negative integer error code on error.
 781  *
 782  * \par Prospective clients:
 783  * Platform's THE ONLY setting application and some dedicated privileged processes
 784  *
 785  * \par Known issues/bugs:
 786  * None
 787  *
 788  * \pre None
 789  *
 790  * \post None
 791  *
 792  * \see security_server_is_pwd_valid(), security_server_chk_pwd(), security_server_set_pwd()
 793  *
 794  * \remarks Only dedicated applications can call this API. The password file will be acces controlled and securely hashed. Security-server will remain previous password file to recover unexpected password file curruption.
 795  *
 796  * \par Sample code:
 797  * \code
 798  * #include <security-server.h>
 799  * ...
 800  * int ret;
 801  * unsigned int attempt, max_attempt, expire_sec;
 802  *
 803  *      ret = security_server_set_pwd("this_is_new_pwd", 20, 365);
 804  *      if(retval != SECURITY_SERVER_API_SUCCESS)
 805  *      {
 806  *              printf("%s", "we have error\n");
 807  *              ...
 808  *      }
 809  * ...
 810  *
 811  * \endcode
 812  *
 813  * Access to this function requires SMACK rule: "<app_label> security-server::api-password-set w"
 814 */
 815 int security_server_reset_pwd(const char *new_pwd,
 816                               const unsigned int max_challenge,
 817                               const unsigned int valid_period_in_days);
 818
 819 /**
 820  * \par Description:
 821  * This API compares stored phone password with challenged input value.
 822  *
 823  * \par Purpose:
 824  * This API should be used by applications which has phone UI lock capability.
 825  *
 826  * \par Typical use case:
 827  * Lock screen calls this API after user typed phone password and pressed okay.
 828  *
 829  * \par Method of function operation:
 830  * Sends challenged password to security-server, security-server compares hashed current password and hashed challenged password.
 831  *
 832  * \par Sync (or) Async:
 833  * This is a Synchronous API.
 834  *
 835  * \par Important notes:
 836  * There is retry timer on this API to limit replay attack. You will get error if you called this API too often.\n
 837  *
 838  * \param[in] challenge Null terminated challenged password string. It must not a NULL pointer.
 839  * \param[out] current_attempts Number of password check missed attempts.
 840  * \param[out] max_attempts Number of maximum attempts that the password locks. 0 means infinite
 841  * \param[out] valid_secs Remaining time in second which represents this password will be expired. 0xFFFFFFFF means infinite
 842  *
 843  * \return 0 on seccuess, negative integer error code on error.
 844  *
 845  * \par Prospective clients:
 846  * Applications which has phone UI lock feature.
 847  *
 848  * \par Known issues/bugs:
 849  * None
 850  *
 851  * \pre None
 852  *
 853  * \post None
 854  *
 855  * \see security_server_is_pwd_valid(), security_server_set_pwd()
 856  *
 857  * \remarks The password file will be acces controlled and securely hashed. Security-server will remain previous password file to recover unexpected password file curruption.
 858  *
 859  * \par Sample code:
 860  * \code
 861  * #include <security-server.h>
 862  * ...
 863  * int retval;
 864  * unsigned int attempt, max_attempt, expire_sec;
 865  *
 866  * retval = security_server_chk_pwd("is_this_password", &attmpt, &max_attempt, &expire_sec);
 867  * if(retval == SECURITY_SERVER_API_ERROR_PASSWORD_MISMATCH)
 868  * {
 869  *      printf("%s", "Oh you typed wrong password\n");
 870  *      ...
 871  * }
 872  * else if(retval == SECURITY_SERVER_API_SUCCESS)
 873  * {
 874  *      printf("%s", "You remember your password.\n");
 875  *      ...
 876  * }
 877  * ...
 878  *
 879  * \endcode
 880  *
 881  * Access to this function requires SMACK rule: "<app_label> security-server::api-password-check w"
 882 */
 883 int security_server_chk_pwd(const char *challenge,
 884                             unsigned int *current_attempt,
 885                             unsigned int *max_attempt,
 886                             unsigned int *valid_secs);
 887
 888
 889 /**
 890  * \par Description:
 891  * 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
 892  *
 893  * \par Purpose:
 894  * This API should be used only by dedicated process in the platform.
 895  *
 896  * \par Typical use case:
 897  * Enterprise manager calls this API when the enterprise wants to enforce harder password policy.
 898  *
 899  * \par Method of function operation:
 900  * When enterprise manager (MDM) is trying to change the security policy for phone password, it calls this API background to change the history policy.
 901  *
 902  * \par Sync (or) Async:
 903  * This is a Synchronous API.
 904  *
 905  * \par Important notes:
 906  * There is retry timer on this API to limit replay attack. You will get error if you called this API too often.\n
 907  *
 908  * \param[in] number_of_history Number of history to be checked when user tries to change password. Maximum is currently 50
 909  *
 910  * \return 0 on seccuess, negative integer error code on error.
 911  *
 912  * \par Prospective clients:
 913  * MDM client, Enterprise manager.
 914  *
 915  * \par Known issues/bugs:
 916  * None
 917  *
 918  * \pre None
 919  *
 920  * \post None
 921  *
 922  * \see security_server_set_pwd()
 923  *
 924  * \remarks The password file will be acces controlled and securely hashed. Security-server will remain previous password file to recover unexpected password file curruption.
 925  *
 926  * \par Sample code:
 927  * \code
 928  * #include <security-server.h>
 929  * ...
 930  * int retval;
 931  *
 932  * ret = security_server_set_pwd_history(100);
 933  *      if(ret != SECURITY_SERVER_API_SUCCESS)
 934  *      {
 935  *              printf("%s", "You have error\n");
 936  *              ...
 937  *      }
 938  * ...
 939  *
 940  * \endcode
 941  *
 942  * Access to this function requires SMACK rule: "<app_label> security-server::api-password-set w"
 943 */
 944 int security_server_set_pwd_history(int number_of_history);
 945
 946 /*
 947  * This function allows to get process SMACK label by passing cookie assigned
 948  * to process. Function returns pointer to allocated buffer with label.
 949  * User has to free the buffer after using.
 950  *
 951  * \param[in] Pointer to cookie
 952  *
 953  * \return Pointer to SMACK label or NULL
 954  *
 955  * \par For free label use free(), label allocated by calloc()
 956  *      User responsibility is to free resource.
 957  *
 958  * Access to this function requires SMACK rule: "<app_label> security-server::api-cookie-check w"
 959  */
 960 char *security_server_get_smacklabel_cookie(const char *cookie);
 961
 962 /*
 963  * This function allows to get process SMACK label by passing socket descriptor.
 964  * Function returns pointer to allocated buffer with label.
 965  * User has to free the buffer after using.
 966  *
 967  * \param[in] Socket descriptor
 968  *
 969  * \return Pointer to SMACK label or NULL
 970  *
 971  * \par For free label use free(), label allocated by calloc().
 972  *      User responsibility is to free resource.
 973  *
 974  * Access to this function not requires SMACK rule
 975  */
 976 char *security_server_get_smacklabel_sockfd(int fd);
 977
 978 /*
 979  * This function will give permissions "rwxat" from
 980  * (subject) customer_label to caller process (object).
 981  * Object label will be extracted from socket.
 982  *
 983  * Access to this function requires SMACK rule: "<app_label> security-server::api-data-share w"
 984  * */
 985 int security_server_app_give_access(const char *customer_label, int customer_pid);
 986
 987 /*
 988  * This function allows middleware to check priviliges of process with specified PID.
 989  * Service is able to check proces acces to the specified object label with specified
 990  * access rights.
 991  *
 992  * \param[in] PID number of process to be checked
 993  * \param[in] SMACK object label
 994  * \param[in] SMACK access rights to be checked
 995  *
 996  * \return Privilege confirm or error code
 997  * SECURITY_SERVER_SUCCESS - on succes
 998  *
 999  * Access to this function requires SMACK rule: "<app_label> security-server::api-privilege-by-pid w"
1000  */
1001 int security_server_check_privilege_by_pid(int pid, const char *object, const char *access_rights);
1002
1003 /*
1004  * This function allows middleware to enable permissions for specified app_id.
1005  *
1006  * \param[in] Application ID
1007  * \param[in] Application type definet in enum at the beginning of this file
1008  * \param[in] Permissions list
1009  * \param[in] Persistent
1010  *
1011  * \return SECURITY_SERVER_SUCCESS on success or error code on fail
1012  *
1013  * Access to this function requires SMACK rule: "<app_label> security-server::api-app-permissions w"
1014  */
1015 int security_server_app_enable_permissions(const char *app_id, app_type_t app_type, const char **perm_list, int persistent);
1016
1017 /*
1018  * This function allows middleware to disable permissions for specified app_id.
1019  *
1020  * \param[in] Application ID
1021  * \param[in] Application type definet in enum at the beginning of this file
1022  * \param[in] Permissions list
1023  *
1024  * \return SECURITY_SERVER_SUCCESS on success or error code on fail
1025  *
1026  * Access to this function requires SMACK rule: "<app_label> security-server::api-app-permissions w"
1027  */
1028 int security_server_app_disable_permissions(const char *app_id, app_type_t app_type, const char **perm_list);
1029
1030 /*
1031  * This function allows middleware to get UID assigned to cookie
1032  *
1033  * \param[in] Cookie
1034  * \param[out] Handler to store UID
1035  *
1036  * \return SECURITY_SERVER_SUCCESS on success or error code on fail
1037  *
1038  * Access to this function requires SMACK rule: "<app_label> security-server::api-cookie-check w"
1039  */
1040 int security_server_get_uid_by_cookie(const char *cookie, uid_t *uid);
1041
1042 /*
1043  * This function allows middleware to check if an app has the specified privilege
1044  * enabled.
1045  *
1046  * \param[in] Application ID
1047  * \param[in] Application type
1048  * \param[in] Privilege name
1049  * \param[out] Handler to store the result. It is set to 1 (true) if privilege is enabled, 0 (false) otherwise
1050  *
1051  * \return SECURITY_SERVER_SUCCESS on success or error code on fail
1052  *
1053  * Access to this function requires SMACK rule: "<app_label> security-server::api-app-privilege-by-name w"
1054  */
1055 int security_server_app_has_privilege(const char *app_id,
1056                                       app_type_t app_type,
1057                                       const char *privilege_name,
1058                                       int *result);
1059
1060 /*
1061  * This function allows middleware to check if caller app has the specified privilege
1062  * enabled. Security Server gets caller app smack label from the IPC socket.
1063  *
1064  * \param[in] Application type
1065  * \param[in] Privilege name
1066  * \param[out] Handler to store the result. It is set to 1 (true) if privilege is enabled, 0 (false) otherwise
1067  *
1068  * \return SECURITY_SERVER_SUCCESS on success or error code on fail
1069  *
1070  * Access to this function requires SMACK rule: "<app_label> security-server::api-app-privilege-by-name w"
1071  */
1072 int security_server_app_caller_has_privilege(app_type_t app_type,
1073                                              const char *privilege_name,
1074                                              int *result);
1075
1076 /*
1077  * This function allows middleware to get GID assigned to cookie
1078  *
1079  * \param[in] Cookie
1080  * \param[out] Handler to store GID
1081  *
1082  * \return SECURITY_SERVER_SUCCESS on success or error code on fail
1083  *
1084  * Access to this function requires SMACK rule: "<app_label> security-server::api-cookie-check w"
1085  */
1086 int security_server_get_gid_by_cookie(const char *cookie, gid_t *gid);
1087
1088 /*
1089  * This function allows to create, if doesn't exist, or open existing file by
1090  * Security Server on behalf of calling process in secured directory.
1091  *
1092  * \param[in] File name to create/open
1093  * \param[out] File descriptor
1094  *
1095  * \return SECURITY_SERVER_API_SUCCESS on success or error code on fail
1096  *
1097  * Access to this function requires SMACK rule: "<app_label> security-server::api-open-for w"
1098  */
1099 int security_server_open_for(const char *filename, int *fd);
1100
1101
1102 #ifdef __cplusplus
1103 }
1104 #endif
1105
1106 /**
1107  * @}
1108 */
1109
1110 /**
1111  * @}
1112 */
1113
1114 #endif