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
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
|
/*
* 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 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
*/
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif
#include <assert.h>
#ifdef USE_PTHREADS
#include <pthread.h>
#endif
#if HAVE_DLSYM
# include <dlfcn.h>
# ifndef DLEXT
# define DLEXT ".so"
# endif
# ifndef RTLD_LAZY
# define RTLD_LAZY RTLD_NOW
# endif
typedef void *dlhandle_t;
#else
# include <ltdl.h>
# ifndef DLEXT
# define DLEXT ""
# endif
typedef lt_dlhandle dlhandle_t;
# define dlopen(n,f) lt_dlopenext((n))
# define dlsym(h,s) lt_dlsym((h),(s))
# define dlclose(h) lt_dlclose((h))
#endif
#include <stdlib.h>
#include <string.h>
#include <ctype.h>
#include <missing.h>
#include "auth-client.h"
#include "auth-plugin.h"
#include "api.h"
#ifdef USE_PTHREADS
static pthread_mutex_t plugin_mutex = PTHREAD_MUTEX_INITIALIZER;
#endif
struct auth_plugin
{
struct auth_plugin *next;
dlhandle_t module;
const struct auth_client_plugin *info;
};
static struct auth_plugin *client_plugins, *end_client_plugins;
struct auth_context
{
int min_ssf;
unsigned flags;
const struct auth_client_plugin *client;
void *plugin_ctx;
auth_interact_t interact;
void *interact_arg;
char *external_id;
};
#define mechanism_disabled(p,a,f) \
(((p)->flags & AUTH_PLUGIN_##f) && !((a)->flags & AUTH_PLUGIN_##f))
#if HAVE_DLSYM && defined AUTHPLUGINDIR
# define PLUGIN_DIR AUTHPLUGINDIR "/"
#else
# define PLUGIN_DIR
#endif
static char *
plugin_name (const char *str)
{
char *buf, *p;
static const char prefix[] = PLUGIN_DIR "sasl-";
assert (str != NULL);
buf = malloc (sizeof prefix + strlen (str) + sizeof DLEXT);
if (buf == NULL)
return NULL;
strcpy (buf, prefix);
p = buf + sizeof prefix - 1;
while (*str != '\0')
*p++ = tolower (*str++);
strcpy (p, DLEXT);
return buf;
}
static int
append_plugin (dlhandle_t module, const struct auth_client_plugin *info)
{
struct auth_plugin *auth_plugin;
assert (info != NULL);
auth_plugin = malloc (sizeof (struct auth_plugin));
if (auth_plugin == NULL)
{
/* FIXME: propagate an ENOMEM back to the app. */
return 0;
}
auth_plugin->info = info;
auth_plugin->module = module;
auth_plugin->next = NULL;
if (client_plugins == NULL)
client_plugins = auth_plugin;
else
end_client_plugins->next = auth_plugin;
end_client_plugins = auth_plugin;
return 1;
}
static const struct auth_client_plugin *
load_client_plugin (const char *name)
{
dlhandle_t module;
char *plugin;
const struct auth_client_plugin *info;
assert (name != NULL);
/* Try searching for a plugin. */
plugin = plugin_name (name);
if (plugin == NULL)
return NULL;
module = dlopen (plugin, RTLD_LAZY);
free (plugin);
if (module == NULL)
return NULL;
info = dlsym (module, "sasl_client");
if (info == NULL || info->response == NULL)
{
dlclose (module);
return NULL;
}
/* This plugin module is OK. Add it to the list of loaded modules.
*/
if (!append_plugin (module, info))
{
dlclose (module);
return NULL;
}
return info;
}
void
auth_client_init (void)
{
#if !HAVE_DLSYM
# ifdef USE_PTHREADS
pthread_mutex_lock (&plugin_mutex);
# endif
lt_dlinit ();
# ifdef AUTHPLUGINDIR
lt_dladdsearchdir (AUTHPLUGINDIR);
# endif
/* Add builtin mechanisms to the plugin list */
# ifdef USE_PTHREADS
pthread_mutex_unlock (&plugin_mutex);
# endif
#endif
}
void
auth_client_exit (void)
{
struct auth_plugin *plugin, *next;
/* Scan the auth_plugin array and dlclose() the modules */
#ifdef USE_PTHREADS
pthread_mutex_lock (&plugin_mutex);
#endif
for (plugin = client_plugins; plugin != NULL; plugin = next)
{
next = plugin->next;
if (plugin->module != NULL)
dlclose (plugin->module);
free (plugin);
}
client_plugins = end_client_plugins = NULL;
#if !HAVE_DLSYM
lt_dlexit ();
#endif
#ifdef USE_PTHREADS
pthread_mutex_unlock (&plugin_mutex);
#endif
}
auth_context_t
auth_create_context (void)
{
auth_context_t context;
context = malloc (sizeof (struct auth_context));
if (context == NULL)
return NULL;
memset (context, 0, sizeof (struct auth_context));
return context;
}
int
auth_destroy_context (auth_context_t context)
{
API_CHECK_ARGS (context != NULL, 0);
if (context->plugin_ctx != NULL)
{
if (context->client != NULL && context->client->destroy != NULL)
(*context->client->destroy) (context->plugin_ctx);
}
free (context);
return 1;
}
int
auth_set_mechanism_flags (auth_context_t context, unsigned set, unsigned clear)
{
API_CHECK_ARGS (context != NULL, 0);
context->flags &= AUTH_PLUGIN_EXTERNAL | ~clear;
context->flags |= ~AUTH_PLUGIN_EXTERNAL & set;
return 1;
}
int
auth_set_mechanism_ssf (auth_context_t context, int min_ssf)
{
API_CHECK_ARGS (context != NULL, 0);
context->min_ssf = min_ssf;
return 1;
}
int
auth_set_external_id (auth_context_t context, const char *identity)
{
static const struct auth_client_plugin external_client =
{
/* Plugin information */
"EXTERNAL",
"SASL EXTERNAL mechanism (RFC 2222)",
/* Plugin instance */
NULL,
NULL,
/* Authentication */
(auth_response_t) 1,
AUTH_PLUGIN_EXTERNAL,
/* Security Layer */
0,
NULL,
NULL,
};
struct auth_plugin *plugin;
API_CHECK_ARGS (context != NULL, 0);
if (context->external_id != NULL)
free (context->external_id);
if (identity != NULL)
{
/* Install external module if required */
for (plugin = client_plugins; plugin != NULL; plugin = plugin->next)
if (plugin->info->flags & AUTH_PLUGIN_EXTERNAL)
break;
if (plugin == NULL)
{
#ifdef USE_PTHREADS
pthread_mutex_lock (&plugin_mutex);
#endif
append_plugin (NULL, &external_client);
#ifdef USE_PTHREADS
pthread_mutex_unlock (&plugin_mutex);
#endif
}
context->flags |= AUTH_PLUGIN_EXTERNAL;
context->external_id = strdup (identity);
}
else
{
context->flags &= ~AUTH_PLUGIN_EXTERNAL;
context->external_id = NULL;
}
return 1;
}
int
auth_set_interact_cb (auth_context_t context,
auth_interact_t interact, void *arg)
{
API_CHECK_ARGS (context != NULL, 0);
context->interact = interact;
context->interact_arg = arg;
return 1;
}
/* Perform various checks to see if SASL is usable. Do not check
for loaded plugins though. This is checked when trying to
select one for use. */
int
auth_client_enabled (auth_context_t context)
{
if (context == NULL)
return 0;
if (context->interact == NULL)
return 0;
return 1;
}
int
auth_set_mechanism (auth_context_t context, const char *name)
{
struct auth_plugin *plugin;
const struct auth_client_plugin *info;
API_CHECK_ARGS (context != NULL && name != NULL, 0);
#ifdef USE_PTHREADS
pthread_mutex_lock (&plugin_mutex);
#endif
/* Get rid of old context */
if (context->plugin_ctx != NULL)
{
if (context->client != NULL && context->client->destroy != NULL)
(*context->client->destroy) (context->plugin_ctx);
context->plugin_ctx = NULL;
}
/* Check the list of already loaded modules. */
info = NULL;
for (plugin = client_plugins; plugin != NULL; plugin = plugin->next)
if (strcasecmp (name, plugin->info->keyw) == 0)
{
info = plugin->info;
break;
}
/* Load the module if not found above. */
if (info == NULL && (info = load_client_plugin (name)) == NULL)
{
#ifdef USE_PTHREADS
pthread_mutex_unlock (&plugin_mutex);
#endif
return 0;
}
/* Check the application's requirements regarding minimum SSF and
whether anonymous or plain text mechanisms are explicitly allowed.
This has to be checked here since the list of loaded plugins is
global and the plugin may have been acceptable in another context
but not in this one. */
if (info->ssf < context->min_ssf
|| mechanism_disabled (info, context, EXTERNAL)
|| mechanism_disabled (info, context, ANONYMOUS)
|| mechanism_disabled (info, context, PLAIN))
{
#ifdef USE_PTHREADS
pthread_mutex_unlock (&plugin_mutex);
#endif
return 0;
}
context->client = info;
#ifdef USE_PTHREADS
pthread_mutex_unlock (&plugin_mutex);
#endif
return 1;
}
const char *
auth_mechanism_name (auth_context_t context)
{
API_CHECK_ARGS (context != NULL && context->client != NULL, NULL);
return context->client->keyw;
}
const char *
auth_response (auth_context_t context, const char *challenge, int *len)
{
API_CHECK_ARGS (context != NULL
&& context->client != NULL
&& len != NULL
&& ((context->client->flags & AUTH_PLUGIN_EXTERNAL)
|| context->interact != NULL),
NULL);
if (challenge == NULL)
{
if (context->plugin_ctx != NULL && context->client->destroy != NULL)
(*context->client->destroy) (context->plugin_ctx);
if (context->client->init == NULL)
context->plugin_ctx = NULL;
else if (!(*context->client->init) (&context->plugin_ctx))
return NULL;
}
if (context->client->flags & AUTH_PLUGIN_EXTERNAL)
{
*len = strlen (context->external_id);
return context->external_id;
}
assert (context->client->response != NULL);
return (*context->client->response) (context->plugin_ctx,
challenge, len,
context->interact,
context->interact_arg);
}
int
auth_get_ssf (auth_context_t context)
{
API_CHECK_ARGS (context != NULL && context->client != NULL, -1);
return context->client->ssf;
}
void
auth_encode (char **dstbuf, int *dstlen,
const char *srcbuf, int srclen, void *arg)
{
auth_context_t context = arg;
if (context != NULL
&& context->client != NULL
&& context->client->encode != NULL)
(*context->client->encode) (context->plugin_ctx,
dstbuf, dstlen, srcbuf, srclen);
}
void
auth_decode (char **dstbuf, int *dstlen,
const char *srcbuf, int srclen, void *arg)
{
auth_context_t context = arg;
if (context != NULL
&& context->client != NULL
&& context->client->encode != NULL)
(*context->client->decode) (context->plugin_ctx,
dstbuf, dstlen, srcbuf, srclen);
}
|