summaryrefslogtreecommitdiffstats
path: root/auth-plugin.h
blob: 7b7989e7d2ad1c9a4dcda2dd7a33167d65fb1a18 (plain)
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
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
52
53
54
55
56
#ifndef _auth_plugin_h
#define _auth_plugin_h
/*
 *  This file is part of libESMTP, a library for submission of RFC 2822
 *  formatted electronic mail messages using the SMTP protocol described
 *  in RFC 2821.
 *
 *  Copyright (C) 2001,2002  Brian Stafford  <brian@stafford.uklinux.net>
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License as published by the Free Software Foundation; either
 *  version 2.1 of the License, or (at your option) any later version.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

/****************************************************************************
 * Client side SASL plugins.
 * This header is used only by the plugins.  Structures and constants shared
 * between the plugin and the app are in auth-client.h
 ****************************************************************************/

typedef int (*auth_init_client_t) (void *pctx);
typedef void (*auth_detsroy_client_t) (void *ctx);

/* Plugins export client info through this structure */
struct auth_client_plugin
  {
  /* Plugin information */
    const char *keyw;			/* mechanism keyword */
    const char *description;		/* description of the mechanism */
  /* Plugin instance */
    auth_init_client_t init;		/* Create plugin context */
    auth_detsroy_client_t destroy;	/* Destroy plugin context */
  /* Authentication */
    auth_response_t response;		/* request response to a challenge */
    int flags;				/* plugin information */
  /* Security Layer */
    int ssf;				/* security strength */
    auth_recode_t encode;		/* encode data for transmission */
    auth_recode_t decode;		/* decode received data */
  };

#ifndef NULL
# define NULL		((void *) 0)
#endif

#endif