checkpw/checkpw.h

   1 /*
   2  * Copyright (c) 2000-2001 Apple Computer, 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 /*
  19  *  checkpw.h
  20  *  utility to authenticate users using crypt with a fallback on Directory Services
  21  *
  22  *    Copyright:  (c) 2000 by Apple Computer, Inc., all rights reserved
  23  *
  24  */
  25
  26 #ifndef __CHKUSRNAMPASSWD_H__
  27 #define __CHKUSRNAMPASSWD_H__
  28
  29 #include <pwd.h>
  30
  31 #ifdef __cplusplus
  32 extern "C" {
  33 #endif
  34
  35 enum {
  36         CHECKPW_SUCCESS = 0,
  37         CHECKPW_UNKNOWNUSER = -1,
  38         CHECKPW_BADPASSWORD = -2,
  39         CHECKPW_FAILURE = -3
  40 };
  41
  42 /*!
  43     @function checkpw
  44
  45         checks a username/password combination.
  46
  47     @param username (input) username as a UTF8 string
  48
  49         @param password (input) password as a UTF8 string
  50
  51     @result CHECKPW_SUCCESS username/password correct
  52
  53         CHECKPW_UNKNOWNUSER no such user
  54
  55         CHECKPW_BADPASSWORD wrong password
  56
  57         CHECKPW_FAILURE failed to communicate with DirectoryServices
  58
  59 */
  60 int checkpw( const char* userName, const char* password );
  61
  62 #ifdef __cplusplus
  63 }
  64 #endif
  65
  66 #endif // __CHKUSRNAMPASSWD_H__