Security/libsecurity_checkpw/lib/checkpw.h

   1 /*
   2  * Copyright (c) 2000-2011 Apple Inc. All Rights Reserved.
   3  *
   4  * The contents of this file constitute Original Code as defined in and are
   5  * subject to the Apple Public Source License Version 1.2 (the 'License').
   6  * You may not use this file except in compliance with the License. Please obtain
   7  * a copy of the License at http://www.apple.com/publicsource and read it before
   8  * using this file.
   9  *
  10  * This Original Code and all software distributed under the License are
  11  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS
  12  * OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES, INCLUDING WITHOUT
  13  * LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
  14  * PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT. Please see the License for the
  15  * specific language governing rights and limitations under the License.
  16  */
  17
  18 #ifndef __CHKUSRNAMPASSWD_H__
  19 #define __CHKUSRNAMPASSWD_H__
  20
  21 #include <Availability.h>
  22
  23 #include <pwd.h>
  24
  25 #ifdef __cplusplus
  26 extern "C" {
  27 #endif
  28
  29 enum {
  30         CHECKPW_SUCCESS = 0,
  31         CHECKPW_UNKNOWNUSER = -1,
  32         CHECKPW_BADPASSWORD = -2,
  33         CHECKPW_FAILURE = -3
  34 };
  35
  36 /*!
  37         @function checkpw
  38
  39         checks a username/password combination.
  40
  41         @param username (input) username as a UTF8 string
  42         @param password (input) password as a UTF8 string
  43
  44         @result CHECKPW_SUCCESS username/password correct
  45         CHECKPW_UNKNOWNUSER no such user
  46         CHECKPW_BADPASSWORD wrong password
  47         CHECKPW_FAILURE failed to communicate with DirectoryServices
  48
  49         @discussion Deprecated and should no longer be used.
  50         Username/password combinations can be checked in two ways:
  51         1) PAM(3): with the "checkpw" service.
  52         2) OpenDirectory: ODRecordVerifyPassword() - if you are
  53            currently using OpenDirectory.
  54 */
  55
  56 int checkpw( const char* userName, const char* password )
  57         __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_1,__MAC_10_7,__IPHONE_NA,__IPHONE_NA);
  58
  59 #ifdef __cplusplus
  60 }
  61 #endif
  62
  63 #endif // __CHKUSRNAMPASSWD_H__