libsyncml  0.5.4
sml_auth.h
1 /*
2  * libsyncml - A syncml protocol implementation
3  * Copyright (C) 2005 Armin Bauer <armin.bauer@opensync.org>
4  * Copyright (C) 2008 Michael Bell <michael.bell@opensync.org>
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with this library; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19  *
20  */
21 
29 
30 #ifndef _SML_AUTH_H_
31 #define _SML_AUTH_H_
32 
33 typedef struct SmlAuthenticator SmlAuthenticator;
34 typedef SmlBool (* SmlAuthVerifyCb)(SmlChal *chal, SmlCred *cred, const char *username, void *userdata, SmlError **error);
35 
36 SmlAuthenticator *smlAuthNew(SmlError **error);
37 void smlAuthFree(SmlAuthenticator *auth);
38 SmlBool smlAuthRegister(SmlAuthenticator *auth, SmlManager *manager, SmlError **error);
39 void smlAuthSetState(SmlAuthenticator *auth, SmlErrorType type);
40 void smlAuthSetVerifyCallback(SmlAuthenticator *auth, SmlAuthVerifyCb callback, void *userdata);
41 void smlAuthSetEnable(SmlAuthenticator *auth, SmlBool enabled);
42 SmlBool smlAuthIsEnabled(SmlAuthenticator *auth);
43 
44 /* This can be used from within the SmlAuthVerifyCb to do the authentication itself. */
45 SmlBool smlAuthVerify(SmlChal *chal, SmlCred *cred, const char *username, const char *password, SmlError **error);
46 
47 /* set required authentication type if this is a server */
48 void smlAuthSetType(SmlAuthenticator *auth, SmlAuthType code);
49 
50 /* expire date: 20090813 */
51 SmlStatus *smlAuthHeaderReply(SmlSession *session, SmlAuthType code, SmlError **error) LIBSYNCML_DEPRECATED;
52 
53 #endif //_SML_AUTH_H_
54 
Represent an error.