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
  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 requested service does not exist */
  79 #define SECURITY_SERVER_API_ERROR_NO_SUCH_SERVICE -4
  80
  81 /*! \brief   indicating requesting object is not exist */
  82 #define SECURITY_SERVER_API_ERROR_NO_SUCH_OBJECT -6
  83
  84 /*! \brief   indicating the authentication between client and server has been failed */
  85 #define SECURITY_SERVER_API_ERROR_AUTHENTICATION_FAILED -7
  86
  87 /*! \brief   indicating the API's input parameter is malformed */
  88 #define SECURITY_SERVER_API_ERROR_INPUT_PARAM -8
  89
  90 /*! \brief   indicating the output buffer size which is passed as parameter is too small */
  91 #define SECURITY_SERVER_API_ERROR_BUFFER_TOO_SMALL -9
  92
  93 /*! \brief   indicating system  is running out of memory state */
  94 #define SECURITY_SERVER_API_ERROR_OUT_OF_MEMORY -10
  95
  96 /*! \brief   indicating the access has been denied by Security Server */
  97 #define SECURITY_SERVER_API_ERROR_ACCESS_DENIED -11
  98
  99 /*! \brief   indicating Security Server has been failed for some reason */
 100 #define SECURITY_SERVER_API_ERROR_SERVER_ERROR -12
 101
 102 /*! \brief   indicating given cookie is not exist in the database  */
 103 #define SECURITY_SERVER_API_ERROR_NO_SUCH_COOKIE -13
 104
 105 /*! \brief   indicating there is no phone password set  */
 106 #define SECURITY_SERVER_API_ERROR_NO_PASSWORD -14
 107
 108 /*! \brief   indicating password exists in system  */
 109 #define SECURITY_SERVER_API_ERROR_PASSWORD_EXIST -15
 110
 111 /*! \brief   indicating password mismatch  */
 112 #define SECURITY_SERVER_API_ERROR_PASSWORD_MISMATCH -16
 113
 114 /*! \brief   indicating password retry timeout is not occurred yet  */
 115 #define SECURITY_SERVER_API_ERROR_PASSWORD_RETRY_TIMER -17
 116
 117 /*! \brief   indicating password retry timeout is not occurred yet  */
 118 #define SECURITY_SERVER_API_ERROR_PASSWORD_MAX_ATTEMPTS_EXCEEDED -18
 119
 120 /*! \brief   indicating password retry timeout is not occurred yet  */
 121 #define SECURITY_SERVER_API_ERROR_PASSWORD_EXPIRED -19
 122
 123 /*! \brief   indicating password retry timeout is not occurred yet  */
 124 #define SECURITY_SERVER_API_ERROR_PASSWORD_REUSED -20
 125
 126 /*! \brief   indicating getting smack label from socket failed  */
 127 #define SECURITY_SERVER_API_ERROR_GETTING_SOCKET_LABEL_FAILED -21
 128
 129 /*! \brief   indicating getting smack label from file failed  */
 130 #define SECURITY_SERVER_API_ERROR_GETTING_FILE_LABEL_FAILED -22
 131
 132 /*! \brief   indicating setting smack label for file failed  */
 133 #define SECURITY_SERVER_API_ERROR_SETTING_FILE_LABEL_FAILED -23
 134
 135 /*! \brief   indicating file already exists  */
 136 #define SECURITY_SERVER_API_ERROR_FILE_EXIST -24
 137
 138 /*! \brief   indicating file does not exist  */
 139 #define SECURITY_SERVER_API_ERROR_FILE_NOT_EXIST -25
 140
 141 /*! \brief   indicating file open error  */
 142 #define SECURITY_SERVER_API_ERROR_FILE_OPEN_FAILED -26
 143
 144 /*! \brief   indicating file creation error  */
 145 #define SECURITY_SERVER_API_ERROR_FILE_CREATION_FAILED -27
 146
 147 /*! \brief   indicating file deletion error  */
 148 #define SECURITY_SERVER_API_ERROR_FILE_DELETION_FAILED -28
 149
 150 /*! \brief   indicating the error with unknown reason */
 151 #define SECURITY_SERVER_API_ERROR_UNKNOWN -255
 152 /** @}*/
 153
 154
 155 #ifdef __cplusplus
 156 extern "C" {
 157 #endif
 158
 159
 160
 161 /**
 162  * \par Description:
 163  * Retreives Linux group ID from object name which is passed by parameter
 164  *
 165  * \par Purpose:
 166  * This API may be used before security_server_check_privilege() API by middleware daemon to get group ID of a specific object.
 167  *
 168  * \par Typical use case:
 169  * In middleware daemon, before checking privilege of a service the daemon need to know the GID of the service. This API support the functionality.
 170  *
 171  * \par Method of function operation:
 172  * Opens /etc/group file and searches the object name as group name. If there is matching result, returns GID as integer
 173  *
 174  * \par Sync (or) Async:
 175  * This is a Synchronous API.
 176  *
 177  * \par Important notes:
 178  * - This API is only allowed to be called by pre-defined middleware daemon
 179  *
 180  * \param[in] object Name of the object which is kwnown by the caller.
 181  *
 182  * \return matching gid (positive integer) on success, or negative error code on error.
 183  *
 184  * \par Prospective clients:
 185  * Inhouse middleware
 186  *
 187  * \par Known issues/bugs:
 188  * None
 189  *
 190  * \pre None
 191  *
 192  * \post None
 193  *
 194  * \see /etc/group,
 195  * security_server_get_object_name(), security_server_check_privilege()
 196  *
 197  * \remarks None
 198  *
 199  * \par Sample code:
 200  * \code
 201  * #include <security-server.h>
 202  * ...
 203  * int retval;
 204  *
 205  * // You have to make sure that  the input param '*object' is defined in the platform
 206  * retval = security_server_get_gid("telephony_makecall");
 207  * if(retval < 0)
 208  * {
 209  *      printf("%s", "Error has occurred\n");
 210  *      exit(0);
 211  * }
 212  * ...
 213  * \endcode
 214  *
 215  * Access to this function requires SMACK rule: "<app_label> security-server::api-get-gid w"
 216 */
 217 int security_server_get_gid(const char *object);
 218
 219 /**
 220  * \par Description:
 221  * Request cookie to the Security Server. Cookie is a random bit stream which is used as ticket for user space object.
 222  *
 223  * \par Purpose:
 224  * This API may be used by application and client middleware process to get access to middleware daemons.
 225  *
 226  * \par Typical use case:
 227  * 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.
 228  *
 229  * \par Method of function operation:
 230  * 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.
 231  *
 232  * \par Sync (or) Async:
 233  * This is a Synchronous API.
 234  *
 235  * \par Important notes:
 236  * Cookie needs to be stored relatively secure.
 237  *
 238  * \param[out] cookie Place holder for cookie value.
 239  * \param[in] max_cookie Allocated byte size of parameter "cookie".
 240  *
 241  * \return 0 on success, or negative error code on error.
 242  *
 243  * \par Prospective clients:
 244  * Any process
 245  *
 246  * \par Known issues/bugs:
 247  * None
 248  *
 249  * \pre output parameter cookie must be malloced before calling this API not to make memory curruption
 250  * Size of the cookie can be retrieved by security_server_get_cookie_size() API.
 251  *
 252  * \post None
 253  *
 254  * \see security_server_check_privilege(), security_server_get_cookie_size()
 255  *
 256  * \remarks None
 257  *
 258  * \par Sample code:
 259  * \code
 260  * #include <security-server.h>
 261  * ...
 262  * int retval;
 263  * size_t cookie_size;
 264  * cookie_size = security_server_get_cookie_size();
 265  * unsigned char cookie[cookie_size];
 266  *
 267  * // Call the API
 268  * retval = security_server_request_cookie(cookie, cookie_size);
 269  * if(retval < 0)
 270  * {
 271  *      printf("%s", "Error has occurred\n");
 272  *      exit(0);
 273  * }
 274  * ...
 275  * \endcode
 276  *
 277  * Access to this function not requires SMACK rule
 278 */
 279 int security_server_request_cookie(char *cookie, size_t bufferSize);
 280
 281
 282
 283 /**
 284  * \par Description:
 285  * This API gets the cookie's byte size which is issued by Security Server.
 286  *
 287  * \par Purpose:
 288  * This API may be used by application and middleware process to get size of cookie before getting and storing cookie value.
 289  *
 290  * \par Typical use case:
 291  * 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.
 292  *
 293  * \par Method of function operation:
 294  * This API just returns pre-defined integer value as cookie size.
 295  *
 296  * \par Sync (or) Async:
 297  * This is a Synchronous API.
 298  *
 299  * \par Important notes:
 300  * None
 301  *
 302  * \return Always returns byte size of the cookie.
 303  *
 304  * \par Prospective clients:
 305  * Any process
 306  *
 307  * \par Known issues/bugs:
 308  * None
 309  *
 310  * \pre None
 311  *
 312  * \post None
 313  *
 314  * \see security_server_request_cookie()
 315
 316  * \remarks None
 317  *
 318  * \par Sample code:
 319  * \code
 320  * #include <security-server.h>
 321  * ...
 322  * int retval;
 323  * size_t cookie_size;
 324  *
 325  * // API calling
 326  * cookie_size = security_server_get_cookie_size();
 327  * unsigned char cookie[cookie_size];
 328  *
 329  * char objectname[20];
 330  * retval = security_server_request_cookie(cookie, cookie_size);
 331  * if(retval < 0)
 332  * {
 333  *      printf("%s", "Error has occurred\n");
 334  *      exit(0);
 335  * }
 336  * ...
 337  * \endcode
 338  *
 339  * Access to this function not requires SMACK rule
 340 */
 341 int security_server_get_cookie_size(void);
 342
 343
 344
 345 /**
 346  * \par Description:
 347  * This API checks the cookie is allowed to access to given object.
 348  *
 349  * \par Purpose:
 350  * This API may be used by middleware process to ask the client application has privilege for the given object.
 351  *
 352  * \par Typical use case:
 353  * 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.
 354  *
 355  * \par Method of function operation:
 356  * 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.
 357  *
 358  * \par Sync (or) Async:
 359  * This is a Synchronous API.
 360  *
 361  * \par Important notes:
 362  * Cookie value needs to be stored relatively secure\n
 363  * Privilege should be pre-defined by Platform design.
 364  *
 365  * \param[in] cookie Received cookie value from client application
 366  * \param[in] privilege Object group ID which the client application wants to access
 367  *
 368  * \return 0 on success, or negative error code on error.
 369  *
 370  * \par Prospective clients:
 371  * Only pre-defiend middleware daemons
 372  *
 373  * \par Known issues/bugs:
 374  * None
 375  * \pre None
 376  *
 377  * \post None
 378  *
 379  * \see security_server_request_cookie(), security_server_get_gid(), security_server_get_cookie_size()
 380  *
 381  * \remarks None
 382  *
 383  * \par Sample code:
 384  * \code
 385  * #include <security-server.h>
 386  * ...
 387  * int retval;
 388  * size_t cookie_size;
 389  * int call_gid;
 390  * cookie_size = security_server_get_cookie_size();
 391  * unsigned char recved_cookie[cookie_size];
 392  *
 393  * ... // Receiving request with cookie
 394  *
 395  * call_gid = security_server_get_gid("telephony_makecall");
 396  * retval = security_server_check_privilege(recved_cookie, (gid_t)call_gid);
 397  * if(retval < 0)
 398  * {
 399  *      if(retval == SECURITY_SERVER_API_ERROR_ACCESS_DENIED)
 400  *      {
 401  *              printf("%s", "access has been denied\n");
 402  *              return;
 403  *      }
 404  *      printf("%s", "Error has occurred\n");
 405  * }
 406  * ...
 407  *
 408  * \endcode
 409  *
 410  * Access to this function requires SMACK rule: "<app_label> security-server::api-cookie-check w"
 411 */
 412 int security_server_check_privilege(const char *cookie, gid_t privilege);
 413
 414 int security_server_check_privilege_by_cookie(const char *cookie,
 415                                               const char *object,
 416                                               const char *access_rights);
 417
 418 /**
 419  * \par Description:
 420  * This API searchs a cookie value and returns PID of the given cookie.
 421  *
 422  * \par Purpose:
 423  * This API may be used by middleware process to ask the client application has privilege for the given object.
 424  *
 425  * \par Typical use case:
 426  * 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.
 427  *
 428  * \par Method of function operation:
 429  * 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.
 430  *
 431  * \par Sync (or) Async:
 432  * This is a Synchronous API.
 433  *
 434  * \par Important notes:
 435  * Cookie value needs to be stored relatively secure\n
 436  * This API is abled to be called only by pre-defined middleware servers.
 437  *
 438  * \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.
 439  *
 440  * \return positive integer on success meaning the PID, 0 means the cookie is for root process, negative integer error code on error.
 441  *
 442  * \par Prospective clients:
 443  * Only pre-defined middleware daemons
 444  *
 445  * \par Known issues/bugs:
 446  * None
 447  *
 448  * \pre None
 449  *
 450  * \post None
 451  *
 452  * \see security_server_request_cookie(), security_server_get_cookie_size()
 453  *
 454  * \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.
 455  * Therefore, please do not use strcpy() family to process cookie value. You MUST use memcpy() function to process cookie value.
 456  * 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.
 457  *
 458  * \par Sample code:
 459  * \code
 460  * #include <security-server.h>
 461  * ...
 462  * int peerpid;
 463  * size_t cookie_size;
 464  * gid_t call_gid;
 465  * cookie_size = security_server_get_cookie_size();
 466  * unsigned char recved_cookie[cookie_size];
 467  *
 468  * ... // Receiving request with cookie
 469  *
 470  * peerpid = security_server_get_cookie_pid(recved_cookie);
 471  * if(peerpid < 0)
 472  * {
 473  *      printf("%s", "Error has occurred\n");
 474  * }
 475  * ...
 476  *
 477  * \endcode
 478  *
 479  * Access to this function requires SMACK rule: "<app_label> security-server::api-cookie-check w"
 480 */
 481 int security_server_get_cookie_pid(const char *cookie);
 482
 483
 484
 485 /**
 486  * \par Description:
 487  * This API checks phone validity of password, to check existance, expiration, remaining attempts.
 488  *
 489  * \par Purpose:
 490  * This API should be used by applications which needs phone password check. Caller application should behave properly after this API call.
 491  *
 492  * \par Typical use case:
 493  * 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
 494  *
 495  * \par Method of function operation:
 496  * Sends a validate request to security server and security server replies with password information.
 497  *
 498  * \par Sync (or) Async:
 499  * This is a Synchronous API.
 500  *
 501  * \par Important notes:
 502  * 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
 503  *
 504  * \param[out] current_attempts Number of password check missed attempts.
 505  * \param[out] max_attempts Number of maximum attempts that the password locks. 0 means infinite
 506  * \param[out] valid_secs Remaining time in second which represents this password will be expired. 0xFFFFFFFF means infinite
 507  *
 508  * \return 0 if there is no password set, other negative integer error code on error.
 509  *
 510  * \par Prospective clients:
 511  * Applications which can unlock UI
 512  *
 513  * \par Known issues/bugs:
 514  * None
 515  *
 516  * \pre None
 517  *
 518  * \post None
 519  *
 520  * \see security_server_set_pwd(), security_server_chk_pwd()
 521  *
 522  * \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.
 523  *
 524  * \par Sample code:
 525  * \code
 526  * #include <security-server.h>
 527  * ...
 528  * int ret;
 529  * unsigned int attempt, max_attempt, expire_sec;
 530  *
 531  * ret = security_server_is_pwd_valid(&attempt, &max_attempt, &expire_sec);
 532  * if(is_pwd_set == SECURITY_SERVER_API_ERROR_NO_PASSWORD)
 533  * {
 534  *      printf("%s", "There is no password exists\n");
 535  * }
 536  * else if(is_pwd_set == SECURITY_SERVER_API_SUCCESS && expire_sec > 0 && attempt < max_attempts)
 537  * {
 538  *      printf("%s", "Password is valid by now\n");
 539  * }
 540  * else
 541  * {
 542  *      printf("%s", "Something wrong\n");
 543  * }
 544  * ...
 545  *
 546  * \endcode
 547  *
 548  * Access to this function requires SMACK rule: "<app_label> security-server::api-password-check w"
 549 */
 550 int security_server_is_pwd_valid(unsigned int *current_attempts,
 551                                  unsigned int *max_attempts,
 552                                  unsigned int *valid_secs);
 553
 554
 555
 556 /**
 557  * \par Description:
 558  * This API sets phone password only if current password matches.
 559  *
 560  * \par Purpose:
 561  * This API should be used by setting application when the user changes his/her phone password.
 562  *
 563  * \par Typical use case:
 564  * Setting application calls this API to change phone password. Caller needs current password to grant the change.
 565  *
 566  * \par Method of function operation:
 567  * 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
 568  *
 569  * \par Sync (or) Async:
 570  * This is a Synchronous API.
 571  *
 572  * \par Important notes:
 573  * There is retry timer on this API to limit replay attack. You will get error if you called this API too often.\n
 574  *
 575  * \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()
 576  * \param[in] new_pwd Null terminated new password string. It must not a NULL pointer.
 577  * \param[in] max_challenge Maximum number of attempts that user can try to check the password without success in serial. 0 means infinity.
 578  * \param[in] valid_period_in_days. Number of days that this password is valid. 0 means infinity
 579  *
 580  * \return 0 on success, negative integer error code on error.
 581  *
 582  * \par Prospective clients:
 583  * Platform's THE ONLY setting application and some dedicated privileged processes
 584  *
 585  * \par Known issues/bugs:
 586  * None
 587  *
 588  * \pre None
 589  *
 590  * \post None
 591  *
 592  * \see security_server_is_pwd_valid(), security_server_chk_pwd(), security_server_reset_pwd()
 593  *
 594  * \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.
 595  * \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.
 596  *
 597  * \par Sample code:
 598  * \code
 599  * #include <security-server.h>
 600  * ...
 601  * int ret;
 602  * unsigned int attempt, max_attempt, expire_sec;
 603  *
 604  * ret = security_server_is_pwd_valid(&attempt, &max_attempt, &expire_sec);
 605  * if(is_pwd_set == SECURITY_SERVER_API_ERROR_NO_PASSWORD)
 606  * {
 607  *      printf("%s", "There is no password exists\n");
 608  *      ret = security_server_set_pwd(NULL, "this_is_new_pwd", 20, 365);
 609  *      if(ret != SECURITY_SERVER_API_SUCCESS)
 610  *      {
 611  *              printf("%s", "we have error\n");
 612  *              ...
 613  *      }
 614  * }
 615  * else if(is_pwd_set == SECURITY_SERVER_API_SUCCESS && expire_sec > 0 && attempt < max_attempts)
 616  * {
 617  *      printf("%s", "Password is valid by now\n");
 618  *      ret = security_server_set_pwd("this_is_current_pwd", "this_is_new_pwd", 20, 365);
 619  *      if(ret != SECURITY_SERVER_API_SUCCESS)
 620  *      {
 621  *              printf("%s", "we have error\n");
 622  *              ...
 623  *      }
 624  * }
 625  * else
 626  * {
 627  *      printf("%s", "Something wrong\n");
 628  * }
 629  * ...
 630  *
 631  * \endcode
 632  *
 633  * Access to this function requires SMACK rule: "<app_label> security-server::api-password-set w"
 634 */
 635 int security_server_set_pwd(const char *cur_pwd,
 636                             const char *new_pwd,
 637                             const unsigned int max_challenge,
 638                             const unsigned int valid_period_in_days);
 639
 640
 641 /**
 642  * \par Description:
 643  * This API sets validity period for currently setup password.
 644  *
 645  * \par Purpose:
 646  * This API should be used by Enterprise authorities to modify password policy. To be used only with valid password setup.
 647  *
 648  * \par Typical use case:
 649  * Authorized application calls this API to change current passwords validity when password policy needs to be changed.
 650  *
 651  * \par Method of function operation:
 652  * 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.
 653  * If there is no password set, function returns proper error code.
 654  *
 655  * \par Sync (or) Async:
 656  * This is a Synchronous API.
 657  * \param[in] valid_period_in_days. Number of days that this password is valid. 0 means infinity
 658  *
 659  * \return 0 on success, negative integer error code on error.
 660  *
 661  * \par Prospective clients:
 662  * Platform's THE ONLY setting application and some dedicated privileged processes
 663  *
 664  * \par Known issues/bugs:
 665  * Identifying calling peer is not ready yet, should be based on SMACK somehow.
 666  *
 667  * \see security_server_is_pwd_valid(), security_server_chk_pwd(), security_server_reset_pwd()
 668  *
 669  * Access to this function requires SMACK rule: "<app_label> security-server::api-password-set w"
 670  */
 671 int security_server_set_pwd_validity(const unsigned int valid_period_in_days);
 672
 673
 674 /**
 675  * \par Description:
 676  * This API sets maximum number of attempts for currently setup password.
 677  *
 678  * \par Purpose:
 679  * This API should be used by Enterprise authorities to modify password policy. To be used only with valid password setup.
 680  *
 681  * \par Typical use case:
 682  * Authorized application calls this API to change current passwords max attempt number when password policy needs to be changed.
 683  *
 684  * \par Method of function operation:
 685  * 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.
 686  * If there is no password set, function returns proper error code.
 687  *
 688  * \par Sync (or) Async:
 689  * This is a Synchronous API.
 690  * \param[in] max_challenge Maximum number of attempts that user can try to check the password without success in serial. 0 means infinity.
 691  *
 692  * \return 0 on success, negative integer error code on error.
 693  *
 694  * \par Prospective clients:
 695  * Platform's THE ONLY setting application and some dedicated privileged processes
 696  *
 697  * \par Known issues/bugs:
 698  * Identifying calling peer is not ready yet, should be based on SMACK somehow.
 699  *
 700  * \see security_server_is_pwd_valid(), security_server_chk_pwd(), security_server_reset_pwd()
 701  *
 702  * Access to this function requires SMACK rule: "<app_label> security-server::api-password-set w"
 703  */
 704 int security_server_set_pwd_max_challenge(const unsigned int max_challenge);
 705
 706 /**
 707  * \par Description:
 708  * This API sets phone password without performing any checks connected with provided password. It
 709  * should be used only if current password is invalid or user forgot the password.
 710  *
 711  * \par Purpose:
 712  * This API should be used by setting application or dedicated processes when the user changes his/her phone password.
 713  *
 714  * \par Typical use case:
 715  * User forgets the password. He calls emergency manager(auto or manual)  for reset password. Emergency manager calls this API and reset phone password.
 716  *
 717  * \par Method of function operation:
 718  * Resetting phone password with input string without any matching current password. Function does
 719  * no checks before password replacement (expiration time check, currently set password checks,
 720  * history check and attempt count check are skipped).
 721  *
 722  * \par Sync (or) Async:
 723  * This is a Synchronous API.
 724  *
 725  * \par Important notes:
 726  * There is retry timer on this API to limit replay attack. You will get error if you called this API too often.\n
 727  *
 728  * \param[in] new_pwd Null terminated new password string. It must not a NULL pointer.
 729  * \param[in] max_challenge Maximum number of attempts that user can try to check the password without success in serial. 0 means infinity.
 730  * \param[in] valid_period_in_days. Number of days that this password is valid. 0 means infinity
 731  *
 732  * \return 0 on success, negative integer error code on error.
 733  *
 734  * \par Prospective clients:
 735  * Platform's THE ONLY setting application and some dedicated privileged processes
 736  *
 737  * \par Known issues/bugs:
 738  * None
 739  *
 740  * \pre None
 741  *
 742  * \post None
 743  *
 744  * \see security_server_is_pwd_valid(), security_server_chk_pwd(), security_server_set_pwd()
 745  *
 746  * \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.
 747  *
 748  * \par Sample code:
 749  * \code
 750  * #include <security-server.h>
 751  * ...
 752  * int ret;
 753  *
 754  *      ret = security_server_reset_pwd("this_is_new_pwd", 20, 365);
 755  *      if(retval != SECURITY_SERVER_API_SUCCESS)
 756  *      {
 757  *              printf("%s", "we have error\n");
 758  *              ...
 759  *      }
 760  * ...
 761  *
 762  * \endcode
 763  *
 764  * Access to this function requires SMACK rule: "<app_label> security-server::api-password-reset w"
 765 */
 766 int security_server_reset_pwd(const char *new_pwd,
 767                               const unsigned int max_challenge,
 768                               const unsigned int valid_period_in_days);
 769
 770 /**
 771  * \par Description:
 772  * This API compares stored phone password with challenged input value.
 773  *
 774  * \par Purpose:
 775  * This API should be used by applications which has phone UI lock capability.
 776  *
 777  * \par Typical use case:
 778  * Lock screen calls this API after user typed phone password and pressed okay.
 779  *
 780  * \par Method of function operation:
 781  * Sends challenged password to security-server, security-server compares hashed current password and hashed challenged password.
 782  *
 783  * \par Sync (or) Async:
 784  * This is a Synchronous API.
 785  *
 786  * \par Important notes:
 787  * There is retry timer on this API to limit replay attack. You will get error if you called this API too often.\n
 788  *
 789  * \param[in] challenge Null terminated challenged password string. It must not a NULL pointer.
 790  * \param[out] current_attempts Number of password check missed attempts.
 791  * \param[out] max_attempts Number of maximum attempts that the password locks. 0 means infinite
 792  * \param[out] valid_secs Remaining time in second which represents this password will be expired. 0xFFFFFFFF means infinite
 793  *
 794  * \return 0 on success, negative integer error code on error.
 795  *
 796  * \par Prospective clients:
 797  * Applications which has phone UI lock feature.
 798  *
 799  * \par Known issues/bugs:
 800  * None
 801  *
 802  * \pre None
 803  *
 804  * \post None
 805  *
 806  * \see security_server_is_pwd_valid(), security_server_set_pwd()
 807  *
 808  * \remarks The password file will be acces controlled and securely hashed. Security-server will remain previous password file to recover unexpected password file curruption.
 809  *
 810  * \par Sample code:
 811  * \code
 812  * #include <security-server.h>
 813  * ...
 814  * int retval;
 815  * unsigned int attempt, max_attempt, expire_sec;
 816  *
 817  * retval = security_server_chk_pwd("is_this_password", &attmpt, &max_attempt, &expire_sec);
 818  * if(retval == SECURITY_SERVER_API_ERROR_PASSWORD_MISMATCH)
 819  * {
 820  *      printf("%s", "Oh you typed wrong password\n");
 821  *      ...
 822  * }
 823  * else if(retval == SECURITY_SERVER_API_SUCCESS)
 824  * {
 825  *      printf("%s", "You remember your password.\n");
 826  *      ...
 827  * }
 828  * ...
 829  *
 830  * \endcode
 831  *
 832  * Access to this function requires SMACK rule: "<app_label> security-server::api-password-check w"
 833 */
 834 int security_server_chk_pwd(const char *challenge,
 835                             unsigned int *current_attempt,
 836                             unsigned int *max_attempt,
 837                             unsigned int *valid_secs);
 838
 839
 840 /**
 841  * \par Description:
 842  * 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
 843  *
 844  * \par Purpose:
 845  * This API should be used only by dedicated process in the platform.
 846  *
 847  * \par Typical use case:
 848  * Enterprise manager calls this API when the enterprise wants to enforce harder password policy.
 849  *
 850  * \par Method of function operation:
 851  * When enterprise manager (MDM) is trying to change the security policy for phone password, it calls this API background to change the history policy.
 852  *
 853  * \par Sync (or) Async:
 854  * This is a Synchronous API.
 855  *
 856  * \par Important notes:
 857  * There is retry timer on this API to limit replay attack. You will get error if you called this API too often.\n
 858  *
 859  * \param[in] history_size Number of history to be checked when user tries to change password. Maximum is currently 50
 860  *
 861  * \return 0 on success, negative integer error code on error.
 862  *
 863  * \par Prospective clients:
 864  * MDM client, Enterprise manager.
 865  *
 866  * \par Known issues/bugs:
 867  * None
 868  *
 869  * \pre None
 870  *
 871  * \post None
 872  *
 873  * \see security_server_set_pwd()
 874  *
 875  * \remarks The password file will be access controlled and securely hashed. Security-server will remain previous password file to recover unexpected password file curruption.
 876  *
 877  * \par Sample code:
 878  * \code
 879  * #include <security-server.h>
 880  * ...
 881  * int retval;
 882  *
 883  * ret = security_server_set_pwd_history(100);
 884  *      if(ret != SECURITY_SERVER_API_SUCCESS)
 885  *      {
 886  *              printf("%s", "You have error\n");
 887  *              ...
 888  *      }
 889  * ...
 890  *
 891  * \endcode
 892  *
 893  * Access to this function requires SMACK rule: "<app_label> security-server::api-password-set w"
 894 */
 895 int security_server_set_pwd_history(int history_size);
 896
 897 /*
 898  * This function allows to get process SMACK label by passing cookie assigned
 899  * to process. Function returns pointer to allocated buffer with label.
 900  * User has to free the buffer after using.
 901  *
 902  * \param[in] Pointer to cookie
 903  *
 904  * \return Pointer to SMACK label or NULL
 905  *
 906  * \par For free label use free(), label allocated by calloc()
 907  *      User responsibility is to free resource.
 908  *
 909  * Access to this function requires SMACK rule: "<app_label> security-server::api-cookie-check w"
 910  */
 911 char *security_server_get_smacklabel_cookie(const char *cookie);
 912
 913 /*
 914  * This function allows to get process SMACK label by passing socket descriptor.
 915  * Function returns pointer to allocated buffer with label.
 916  * User has to free the buffer after using.
 917  *
 918  * \param[in] Socket descriptor
 919  *
 920  * \return Pointer to SMACK label or NULL
 921  *
 922  * \par For free label use free(), label allocated by calloc().
 923  *      User responsibility is to free resource.
 924  *
 925  * Access to this function not requires SMACK rule
 926  */
 927 char *security_server_get_smacklabel_sockfd(int fd);
 928
 929 /*
 930  * This function will give permissions "rwxat" from
 931  * (subject) customer_label to caller process (object).
 932  * Object label will be extracted from socket.
 933  *
 934  * \param[in] CUSTOMER_LABEL execute label of the process that should have access to caller.
 935  * \param[in] CUSTOMER_PID all rules applied by this function should be removed from system
 936  *                         when process with CUSTOMER_PID dies.
 937  *
 938  * \return SECURITY_SERVER_API_SUCCESS on success
 939  * \return SECURITY_SERVER_API_ERROR_GETTING_SOCKET_LABEL_FAILED
 940  * \return SECURITY_SERVER_API_ERROR_ACCESS_DENIED
 941  * \return SECURITY_SERVER_API_ERROR_BAD_REQUEST input params were rejected by security-server
 942  * \return SECURITY_SERVER_API_ERROR_INPUT_PARAM input params were rejected by client library
 943  * \return SECURITY_SERVER_API_ERROR_SOCKET connection to security server failed.
 944  *
 945  * Important: In current implementation CUSTOMER_PID is ignored! This mean that rules applied
 946  * by this function won't be revoke until device reset!
 947  *
 948  * Access to this function requires SMACK rule: "<app_label> security-server::api-data-share w"
 949  * */
 950 int security_server_app_give_access(const char *customer_label, int customer_pid);
 951
 952 /*
 953  * This function allows middleware to check privileges of process with specified PID or socket
 954  * file descriptor.
 955  * Service is able to check process access to the specified object label with specified
 956  * access rights.
 957  *
 958  * \param[in] PID id of process or SOCKFD socket file descriptor to be checked
 959  * \param[in] SMACK object label
 960  * \param[in] SMACK access rights to be checked
 961  *
 962  * \return Privilege confirm or error code
 963  * \return SECURITY_SERVER_API_SUCCESS - on succes
 964  *
 965  * Access to this function requires SMACK rule: "<app_label> security-server::api-privilege-by-pid w"
 966  */
 967 int security_server_check_privilege_by_pid(int pid, const char *object, const char *access_rights);
 968
 969 int security_server_check_privilege_by_sockfd(int sockfd,
 970                                               const char *object,
 971                                               const char *access_rights);
 972
 973 #ifdef __cplusplus
 974 }
 975 #endif
 976
 977 /**
 978  * @}
 979 */
 980
 981 /**
 982  * @}
 983 */
 984
 985 #endif