AppleOD.h   [plain text]

/*
 * Copyright (c) 2004 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_LICENSE_HEADER_START@
 *
 * This file contains Original Code and/or Modifications of Original Code
 * as defined in and that are subject to the Apple Public Source License
 * Version 2.0 (the 'License'). You may not use this file except in
 * compliance with the License. Please obtain a copy of the License at
 * http://www.opensource.apple.com/apsl/ and read it before using this
 * file.
 *
 * The Original Code and all software distributed under the License are
 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
 * Please see the License for the specific language governing rights and
 * limitations under the License.
 *
 * @APPLE_LICENSE_HEADER_END@
 */

#ifndef __aod_h__
#define __aod_h__	1

#include "prot.h"

/* Mail user attribute version */
#define	kXMLKeyAttrVersion				"kAttributeVersion"
	#define	kXMLValueVersion				"Apple Mail 1.0"

/* Account state */
#define	kXMLKeyAcctState				"kMailAccountState"
	#define	kXMLValueAcctEnabled			"Enabled"
	#define	kXMLValueAcctDisabled			"Off"
	#define	kXMLValueAcctFwd				"Forward"

/* Auto forward key (has no specific value) */
#define	kXMLKeyAutoFwd					"kAutoForwardValue"

/* IMAP login state */
#define	kXMLKeykIMAPLoginState			"kIMAPLoginState"
	#define	kXMLValueIMAPLoginOK			"IMAPAllowed"
	#define	kXMLValueIMAPLogInNotOK			"IMAPDeny"

/* POP3 login state */
#define	kXMLKeyPOP3LoginState			"kPOP3LoginState"
	#define	kXMLValuePOP3LoginOK			"POP3Allowed"
	#define	kXMLValuePOP3LoginNotOK			"POP3Deny"

/* Account location key (has no specific value) */
#define	kXMLKeyAcctLoc					"kMailAccountLocation"

/* Account location key (has no specific value) */
#define	kXMLKeyAltDataStoreLoc			"kAltMailStoreLoc"

/* Disk Quota  (has no specific value) */
#define	kXMLKeyDiskQuota				"kUserDiskQuota"

/* Server Principals */
#define	kXMLDictionary					"cyrus"
#define	kXMLSMTP_Principal				"smtp_principal"
#define	kXMLIMAP_Principal				"imap_principal"
#define	kXMLPOP3_Principal				"pop_principal"

#define	kPlistFilePath					"/etc/MailServicesOther.plist"

#define	kMAX_GUID_LEN			128
#define	kONE_K_BUF				1024

#define MAX_USER_NAME_SIZE		256
#define	MAX_USER_BUF_SIZE		512
#define	MAX_CHAL_BUF_SIZE		2048
#define	MAX_IO_BUF_SIZE			21848

#define	ODA_NO_ERROR			0
#define	ODA_AUTH_FAILED			-2000
#define	ODA_AUTH_CANCEL			-2001
#define	ODA_PROTOCOL_ERROR		-2002
#define	ODA_METHOD_NOT_ENABLDE	-2003


static const char * const odText[] = {
	/*  0 */	"No Error",
	/*  1 */	"AOD: Parameter error (parameter %d)",
	/*  2 */	"AOD: Unable to open Directory Services (Error %d)",
	/*  3 */	"AOD: Unable to open Directory Services search node (Error %d)",
	/*  4 */	"AOD: Unable to find user %s (Error %d)",
	/*  5 */	"AOD: Unable to open user directory node for user %s (Error %d)",
	/*  6 */	"AOD: Authentication failed for user %s (Error %d)",
	/*  7 */	"AOD: Warning: Authentication succeeded for user %s but a new password is required (Error %d)",
	/*  8 */	"AOD: Warning: Authentication succeeded for user %s but user password has expired (Error %d)",
	/*  9 */	"AOD: Error: Unable to allocate memory (Error %d)",
	/* 10 */	"AOD: Unknown error (Error %d)",
		0
};

#define	kMAX_GUID_LEN			128
#define	kONE_K_BUF				1024

typedef enum {
	eTypeNoErr				=  0,
	eTypeParamErr			=  1,
	eTypeOpenDSFailed		=  2,
	eTypeOpenSearchFailed	=  3,
	eTypeUserNotFound		=  4,
	eTypeCantOpenUserNode	=  5,
	eTypeAuthFailed			=  6,
	eTypeAuthWarnNewPW		=  7,
	eTypeAuthWarnExpirePW	=  8,
	eTypeAllocError			=  9,
	eMaxErrors				= 10,
	eMalformedAttr			= -8003,
	eWrongVersion			= -8004,
	eNoUserID				= -8005,
	eItemNotFound			= -8001,
	eInvalidDataType		= -8002,
	eEmptyString			= -8006
} eErrorType;

typedef enum {
	eAcctEnabled			= 1,
	eAcctDisabled			= 2,
	eAcctNotMember			= 3,
	eAcctForwarded			= 4,
	eAcctProtocolEnabled	= 5
} eMailAcctState;

typedef enum {
	eAODNoErr				=  0,
	eAODParamErr			= -1,
	eAODOpenDSFailed		= -2,
	eAODOpenSearchFailed	= -3,
	eAODUserNotFound		= -4,
	eAODCantOpenUserNode	= -5,
	eAODAuthFailed			= -6,
	eAODAuthWarnNewPW		= -7,
	eAODAuthWarnExpirePW	= -8,
	eAODAllocError			= -9,
	eAODConfigError			= -10,
	eAOD					= 0xFF
} eAODError;

struct od_user_opts
{
	char			fUserID[ kONE_K_BUF ];
	char			fRecName[ kONE_K_BUF ];
	char			fGUID[ kMAX_GUID_LEN ];
	unsigned long	fUID;
	eMailAcctState	fAcctState;
	eMailAcctState	fPOP3Login;
	eMailAcctState	fIMAPLogin;
	char			fAutoFwdAddr[ kONE_K_BUF ];
	char			fAccountLoc[ kONE_K_BUF ];
	char			fAltDataLoc[ kONE_K_BUF ];
	int				fDiskQuota;
};

typedef enum
{
	kSGSSSuccess		= 0,
	kSGSSBufferSizeErr	= -70001,
	kSGSSImportNameErr	= -70002,
	kSGSSAquireCredErr	= -70003,
	kSGSSInquireCredErr	= -70004,
	kSGSSAuthFailed		= -70005,
	kGSSErrUnknownType	= -70010,
	kUnknownErr			= -70010
} eGSSError;

#define CHAR64(c)  (((c) < 0 || (c) > 127) ? -1 : index_64[(c)])

static char basis_64[] = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/???????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????";

static char index_64[ 128 ] =
{
    -1,-1,-1,-1, -1,-1,-1,-1, -1,-1,-1,-1, -1,-1,-1,-1,
    -1,-1,-1,-1, -1,-1,-1,-1, -1,-1,-1,-1, -1,-1,-1,-1,
    -1,-1,-1,-1, -1,-1,-1,-1, -1,-1,-1,62, -1,-1,-1,63,
    52,53,54,55, 56,57,58,59, 60,61,-1,-1, -1,-1,-1,-1,
    -1, 0, 1, 2,  3, 4, 5, 6,  7, 8, 9,10, 11,12,13,14,
    15,16,17,18, 19,20,21,22, 23,24,25,-1, -1,-1,-1,-1,
    -1,26,27,28, 29,30,31,32, 33,34,35,36, 37,38,39,40,
    41,42,43,44, 45,46,47,48, 49,50,51,-1, -1,-1,-1,-1
};

int odGetUserOpts   ( const char *inUserID, struct od_user_opts *inOutOpts );
int odCheckPass		( const char *inUserID, const char *inPasswd );
int odCheckAPOP		( char **inOutUserID, const char *inChallenge, const char *inResponse  );
int odCRAM_MD5		( const char *inUserID, const char *inChallenge, const char *inResponse  );
int odDoAuthenticate( const char *inMethod, const char *inDigest, const char *inCont,
					  const char *inProtocol, struct protstream *inStreamIn,
					  struct protstream *inStreamOut, char **inOutCannonUser );

typedef struct
{
	int		len;
	char	key[ FILENAME_MAX ];
	int		reserved;
} CallbackUserData;

int apple_password_callback ( char *inBuf, int inSize, int in_rwflag, void *inUserData );


extern char	gErrStr[ kONE_K_BUF ];

#endif /* aod */