summaryrefslogtreecommitdiff
path: root/daemon/ldap.c
blob: 719ac0dc6fccd7ac3da66402a75148f8d4bf40fe (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
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
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067

/* TODO: Include attribution for ideas, and code from mod_auth_digest */

#include "usuals.h"
#include "httpauthd.h"
#include "md5.h"
#include "sha1.h"
#include "bd.h"

#include <sys/time.h>

/* LDAP library */
#include <ldap.h>

/* -------------------------------------------------------------------------------
 * Defaults and Constants
 */

/* TODO: We need to support more password types */
#define LDAP_PW_CLEAR    0
#define LDAP_PW_CRYPT    1
#define LDAP_PW_MD5      2
#define LDAP_PW_SHA      3
#define LDAP_PW_UNKNOWN -1

typedef struct ldap_pw_type
{
    const char* name;
    int type;
}
ldap_pw_type_t;

static const ldap_pw_type_t kLDAPPWTypes[] =
{
    { "cleartext", LDAP_PW_CLEAR },
    { "crypt", LDAP_PW_CRYPT },
    { "md5", LDAP_PW_MD5 },
    { "sha", LDAP_PW_SHA }
};


/* -------------------------------------------------------------------------------
 * Structures
 */

/* Our hanler context */
typedef struct ldap_context
{
    /* Base Handler ------------------------------------------------------ */
    bd_context_t bd;

    /* Settings ---------------------------------------------------------- */
    const char* servers;      /* Servers to authenticate against (required) */
    const char* filter;       /* Filter (either this or dnmap must be set) */
    const char* base;         /* Base for the filter */
    const char* pw_attr;      /* The clear password attribute */
    const char* ha1_attr;     /* Password for an encrypted Digest H(A1) */
    const char* user;         /* User to bind as */
    const char* password;     /* Password to bind with */
    const char* dnmap;        /* For mapping users to dns */
    int port;                 /* Port to connect to LDAP server on */
    int scope;                /* Scope for filter */

    int dobind;               /* Bind to do simple authentication */
    int ldap_max;             /* Number of open connections allowed */
    int ldap_timeout;         /* Maximum amount of time to dedicate to an ldap query */

    /* Context ----------------------------------------------------------- */
    LDAP** pool;            /* Pool of available connections */
    int pool_mark;          /* Amount of connections allocated */
}
ldap_context_t;

/* Forward declarations for callbacks */
static int complete_digest(ha_request_t* rq, const char* user, unsigned char* ha1);
static int validate_basic(ha_request_t* rq, const char* user, const char* password);

/* The defaults for the context */
static const ldap_context_t ldap_defaults =
{
    BD_CALLBACKS(complete_digest, validate_basic),
    NULL,               /* servers */
    NULL,               /* filter */
    NULL,               /* base */
    "userPassword",     /* pw_attr */
    NULL,               /* ha1_attr */
    NULL,               /* user */
    NULL,               /* password */
    NULL,               /* dnmap */
    389,                /* port */
    LDAP_SCOPE_SUBTREE, /* scope */
    1,                  /* dobind */
    10,                 /* ldap_max */
    30,                 /* ldap_timeout */
    NULL,               /* pool */
    0                   /* pool_mark */
};


/* -------------------------------------------------------------------------------
 * Internal Functions
 */

static int report_ldap(const ha_request_t* rq, const char* msg, int code)
{
    ASSERT(code != LDAP_SUCCESS);

    switch(code)
    {
    case LDAP_NO_MEMORY:
        ha_messagex(NULL, LOG_CRIT, "out of memory");
        return HA_CRITERROR;

    default:
        if(!msg)
            msg = "error";
        ha_messagex(rq, LOG_ERR, "%s: %s", msg, ldap_err2string(code));
        return HA_FAILED;
    };
}

#define LDAP_NO_ESCAPE "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ.-_"
#define LDAP_HEX "0123456789abcdef"

static const char* escape_ldap(ha_buffer_t* buf, const char* str)
{
    const char* t = str;
    size_t pos;

    ha_bufcpy(buf, "");

    while(*t)
    {
        pos = strspn(t, LDAP_NO_ESCAPE);

        if(pos > 0)
        {
            ha_bufjoin(buf);
            ha_bufncpy(buf, t, pos);

            t += pos;
        }

        while(*t && !strchr(LDAP_NO_ESCAPE, *t))
        {
            char hex[4];
            hex[0] = '\\';
            hex[1] = LDAP_HEX[*t >> 4 & 0xf];
            hex[2] = LDAP_HEX[*t & 0xf];
            hex[3] = '\0';

            ha_bufjoin(buf);
            ha_bufcpy(buf, hex);

            t++;
        }
    }

    return ha_bufdata(buf);
}

static const char* substitute_params(const ha_request_t* rq, ldap_context_t* ctx,
                                     const char* user, const char* str)
{
    const char* t;

    ASSERT(ctx && rq && user && str);

    /* TODO: We need to be escaping the user and realm properly */
    /* This starts a new block to join */
    ha_bufcpy(rq->buf, "");

    while(str[0])
    {
        t = strchr(str, '%');
        if(!t)
        {
            ha_bufjoin(rq->buf);
            ha_bufcpy(rq->buf, str);
            break;
        }

        ha_bufjoin(rq->buf);
        ha_bufncpy(rq->buf, str, t - str);

        t++;

        switch(t[0])
        {
        case 'u':
            ha_bufjoin(rq->buf);
            escape_ldap(rq->buf, user);
            t++;
            break;

        case 'r':
            ha_bufjoin(rq->buf);
            escape_ldap(rq->buf, rq->context->realm);
            t++;
            break;

        case '%':
            ha_bufjoin(rq->buf);
            ha_bufcpy(rq->buf, "%");
            t++;
            break;
        };

        str = t;
    }

    return ha_bufdata(rq->buf);
}

static const char* make_password_md5(ha_buffer_t* buf, const char* clearpw)
{
    md5_ctx_t md5;
    unsigned char digest[MD5_LEN];

    ASSERT(buf && clearpw);

    md5_init(&md5);
    md5_update(&md5, clearpw, strlen(clearpw));
    md5_final(digest, &md5);

    return ha_bufenc64(buf, digest, MD5_LEN);
}

static const char* make_password_sha(ha_buffer_t* buf, const char* clearpw)
{
    sha1_ctx_t sha;
    unsigned char digest[SHA1_LEN];

    ASSERT(buf && clearpw);

    sha1_init(&sha);
    sha1_update(&sha, clearpw, strlen(clearpw));
    sha1_final(digest, &sha);

    return ha_bufenc64(buf, digest, SHA1_LEN);
}

static int parse_ldap_password(const char** password)
{
    const char* pw;
    const char* scheme;
    int i;

    ASSERT(password && *password);

    pw = *password;

    /* zero length passwords are clear */
    if(strlen(pw) == 0)
        return LDAP_PW_CLEAR;

    /* passwords without a scheme are clear */
    if(pw[0] != '{')
        return LDAP_PW_CLEAR;

    pw++;
    scheme = pw;

    while(*pw && (isalpha(*pw) || isdigit(*pw) || *pw == '-'))
        pw++;

    /* scheme should end in a brace */
    if(*pw != '}')
        return LDAP_PW_CLEAR;

    *password = pw + 1;

    /* find a scheme in our map */
    for(i = 0; i < countof(kLDAPPWTypes); i++)
    {
        if(strncasecmp(kLDAPPWTypes[i].name, scheme, pw - scheme) == 0)
            return kLDAPPWTypes[i].type;
    }

    return LDAP_PW_UNKNOWN;
}

static const char* find_cleartext_password(ha_buffer_t* buf, const char** pws)
{
    ASSERT(buf);

    for(; pws && *pws; pws++)
    {
        const char* pw = *pws;

        if(parse_ldap_password(&pw) == LDAP_PW_CLEAR)
            return pw;
    }

    return NULL;
}

static int parse_ldap_ha1(const ha_request_t* rq, struct berval* bv, unsigned char* ha1)
{
    size_t len;
    void* d;

    ASSERT(rq && bv && ha1);

    /* Raw binary */
    if(bv->bv_len == MD5_LEN)
    {
        ha_messagex(rq, LOG_DEBUG, "found ha1 in raw binary format");
        memcpy(ha1, bv->bv_val, MD5_LEN);
        return HA_OK;
    }

    /* Hex encoded */
    else if(bv->bv_len == (MD5_LEN * 2))
    {
        len = MD5_LEN;
        d = ha_bufdechex(rq->buf, bv->bv_val, &len);

        if(d && len == MD5_LEN)
        {
            ha_messagex(rq, LOG_DEBUG, "found ha1 in hex encoded format");
            memcpy(ha1, d, MD5_LEN);
            return HA_OK;
        }
    }

    /* B64 Encoded */
    else
    {
        len = MD5_LEN;
        d = ha_bufdec64(rq->buf, bv->bv_val, &len);

        if(d && len == MD5_LEN)
        {
            ha_messagex(rq, LOG_DEBUG, "found ha1 in b64 encoded format");
            memcpy(ha1, ha_bufdata(rq->buf), MD5_LEN);
            return HA_OK;
        }
    }

    return ha_buferr(rq->buf) ? HA_CRITERROR : HA_FALSE;
}

static int validate_ldap_password(const ha_request_t* rq, ldap_context_t* ctx, LDAP* ld,
                                  LDAPMessage* entry, const char* user, const char* clearpw)
{
    char** pws;
    char** t;
    const char* pw;
    const char* p;
    int type;
    int res = HA_FALSE;
    int unknown = 0;

    ASSERT(entry && ld && ctx && clearpw && rq);

    ASSERT(ctx->pw_attr);
    pws = ldap_get_values(ld, entry, ctx->pw_attr);

    if(pws)
    {
        for(t = pws ; *t; t++)
        {
            pw = *t;
            type = parse_ldap_password(&pw);

            switch(type)
            {
            case LDAP_PW_CLEAR:
                p = clearpw;
                break;

            case LDAP_PW_MD5:
                p = make_password_md5(rq->buf, clearpw);
                break;

            case LDAP_PW_CRYPT:
                /* Not sure if crypt is thread safe */
                ha_lock(NULL);
                    p = crypt(clearpw, pw);
                ha_unlock(NULL);
                break;

            case LDAP_PW_SHA:
                p = make_password_sha(rq->buf, clearpw);
                break;

            case LDAP_PW_UNKNOWN:
                unknown = 1;
                continue;

            default:
                /* Not reached */
                ASSERT(0);
            };

            if(!p)
            {
                res = HA_CRITERROR;
                break;
            }

            if(strcmp(pw, p) == 0)
            {
                ha_messagex(rq, LOG_DEBUG, "successful validate against password");
                res = HA_OK;
                break;
            }
        }

        ldap_value_free(pws);
    }

    if(res == HA_FALSE && unknown)
        ha_messagex(rq, LOG_ERR, "server does not contain any compatible passwords for user: %s", user);

    return res;
}

static int validate_ldap_ha1(const ha_request_t* rq, ldap_context_t* ctx, LDAP* ld,
                             LDAPMessage* entry, const char* user, const char* realm,
                             const char* clearpw)
{
    struct berval** ha1s;
    struct berval** b;
    unsigned char key[MD5_LEN];
    unsigned char k[MD5_LEN];
    int r, first = 1;
    int res = HA_FALSE;

    ASSERT(ctx && ld && entry && rq && user && clearpw);

    if(!ctx->ha1_attr)
        return HA_FALSE;

    ha1s = ldap_get_values_len(ld, entry, ctx->ha1_attr);

    if(ha1s)
    {
        digest_makeha1(key, user, realm, clearpw);

        for(b = ha1s ; *b; b++)
        {
            r = parse_ldap_ha1(rq, *b, k);
            if(r < 0)
            {
                res = r;
                break;
            }

            if(r == HA_FALSE)
            {
                if(first)
                    ha_messagex(rq, LOG_ERR, "server contains invalid HA1 digest hash for user: %s", user);

                first = 0;
                continue;
            }

            if(memcmp(key, k, MD5_LEN) == 0)
            {
                ha_messagex(rq, LOG_DEBUG, "successful validate against ha1");
                res = HA_OK;
                break;
            }
        }

        ldap_value_free_len(ha1s);
    }

    return res;
}

static LDAP* get_ldap_connection(const ha_request_t* rq, ldap_context_t* ctx)
{
    LDAP* ld;
    int i, r;

    ASSERT(ctx);

    for(i = 0; i < ctx->ldap_max; i++)
    {
        /* An open connection in the pool */
        if(ctx->pool[i])
        {
            ha_messagex(rq, LOG_DEBUG, "using cached connection");
            ld = ctx->pool[i];
            ctx->pool[i] = NULL;
            return ld;
        }
    }

    if(ctx->pool_mark >= ctx->ldap_max)
    {
        ha_messagex(rq, LOG_ERR, "too many open connections");
        return NULL;
    }

    ld = ldap_init(ctx->servers, ctx->port);
    if(!ld)
    {
        ha_message(rq, LOG_ERR, "couldn't initialize connection");
        return NULL;
    }

    if(ctx->user || ctx->password)
    {
        r = ldap_simple_bind_s(ld, ctx->user ? ctx->user : "",
                               ctx->password ? ctx->password : "");
        if(r != LDAP_SUCCESS)
        {
            report_ldap(rq, "couldn't bind to LDAP server", r);
            ldap_unbind_s(ld);
            return NULL;
        }
    }

    ctx->pool_mark++;
    ha_messagex(rq, LOG_DEBUG, "opened new connection (total %d)", ctx->pool_mark);
    return ld;
}

static void discard_ldap_connection(const ha_request_t* rq, ldap_context_t* ctx, LDAP* ld)
{
    ldap_unbind_s(ld);
    ctx->pool_mark--;
    ha_messagex(rq, LOG_DEBUG, "discarding connection (total %d)", ctx->pool_mark);
}

static void save_ldap_connection(const ha_request_t* rq, ldap_context_t* ctx, LDAP* ld)
{
    int i, e;

    ASSERT(ctx);

    if(!ld)
        return;

    ldap_get_option(ld, LDAP_OPT_ERROR_NUMBER, &e);

    /* Make sure it's worth saving */
    switch(e)
    {
    case LDAP_SERVER_DOWN:
    case LDAP_LOCAL_ERROR:
    case LDAP_NO_MEMORY:
        discard_ldap_connection(rq, ctx, ld);
        break;

    default:
        for(i = 0; i < ctx->ldap_max; i++)
        {
            /* An open connection in the pool */
            if(!ctx->pool[i])
            {
                ha_messagex(rq, LOG_DEBUG, "caching connection for later use");
                ctx->pool[i] = ld;
                ld = NULL;
                break;
            }
        }
        break;
    };
}

static int retrieve_user_entry(const ha_request_t* rq, ldap_context_t* ctx, LDAP* ld,
                               const char* user, const char** dn,
                               LDAPMessage** entry, LDAPMessage** result)
{
    struct timeval tv;
    const char* filter;
    const char* attrs[3];
    const char* base;
    int scope;
    int r;

    ASSERT(ctx && rq && ld && user && dn && entry && result);

    if(ctx->filter)
    {
        /* Filters can also have %u and %r */
        filter = substitute_params(rq, ctx, user, ctx->filter);
        if(!filter)
            return HA_CRITERROR;
    }
    else
    {
        filter = "(objectClass=*)";
    }

    attrs[0] = ctx->dobind ? NULL : ctx->pw_attr;
    attrs[1] = ctx->dobind ? NULL : ctx->ha1_attr;
    attrs[2] = NULL;

    tv.tv_sec = ctx->ldap_timeout;
    tv.tv_usec = 0;

    base = *dn ? *dn : ctx->base;
    scope = *dn ? LDAP_SCOPE_BASE : ctx->scope;

    ha_messagex(rq, LOG_DEBUG, "performing search: [ base: %s / scope: %d / filter: %s ]",
                base, scope, filter);

    r = ldap_search_st(ld, base, scope, filter, (char**)attrs, 0, &tv, result);

    if(r != LDAP_SUCCESS)
    {
        if(r == LDAP_NO_SUCH_OBJECT)
        {
            ha_messagex(rq, LOG_WARNING, "user not found in %s", user);
            return HA_FALSE;
        }

        return report_ldap(rq, "couldn't search LDAP server", r);
    }


    /* Only one result should exist */
    switch(r = ldap_count_entries(ld, *result))
    {
    case 1:
        *entry = ldap_first_entry(ld, *result);
        if(!(*dn))
        {
            *dn = ldap_get_dn(ld, *entry);
            ha_messagex(rq, LOG_DEBUG, "found entry for user: %s", *dn);
        }
        return HA_OK;

    case 0:
        ha_messagex(rq, LOG_WARNING, "user not found in %s", user);
        break;

    default:
        ha_messagex(rq, LOG_WARNING, "more than one user found for filter: %s", filter);
        break;
    };

    return HA_FALSE;
}

static int complete_digest(ha_request_t* rq, const char* user, unsigned char* ha1)
{
    ldap_context_t* ctx = (ldap_context_t*)rq->context->ctx_data;
    LDAP* ld = NULL;                /* freed in finally */
    LDAPMessage* results = NULL;    /* freed in finally */
    LDAPMessage* entry = NULL;      /* no need to free */
    struct berval** ha1s = NULL;    /* freed manually */
    char** pws;
    int ret = HA_FALSE;
    const char* dn = NULL;
    int r;

    ASSERT(rq && ha1 && user);

    ld = get_ldap_connection(rq, ctx);
    if(!ld)
    {
        ret = HA_FAILED;
        goto finally;
    }

    /*
     * Discover the DN of the user. If there's a DN map string
     * then we can do this really quickly here without querying
     * the LDAP tree
     */
    if(ctx->dnmap)
    {
        /* The map can have %u and %r to denote user and realm */
        dn = substitute_params(rq, ctx, user, ctx->dnmap);
        if(!dn)
        {
            ret = HA_FAILED;
            goto finally;
        }

        ha_messagex(rq, LOG_INFO, "mapped %s to %s", user, dn);
    }

    /* Okay now we contact the LDAP server. */
    r = retrieve_user_entry(rq, ctx, ld, user, &dn, &entry, &results);
    if(r != HA_OK)
    {
        ret = r;
        goto finally;
    }

    /* Figure out the users ha1 */
    if(ctx->ha1_attr)
        ha1s = ldap_get_values_len(ld, entry, ctx->ha1_attr);

    if(ha1s)
    {
        if(*ha1s)
        {
            ret = parse_ldap_ha1(rq, *ha1s, ha1);
            if(ret != HA_OK)
            {
                if(ret == HA_FALSE)
                    ha_messagex(rq, LOG_ERR, "server contains invalid HA1 for user: %s", user);
            }
        }

        ha_messagex(rq, LOG_DEBUG, "using HA1 from ldap");
        ldap_value_free_len(ha1s);
        goto finally;
    }

    /* If no ha1 set or none found, use password and make a HA1 */
    pws = ldap_get_values(ld, entry, ctx->pw_attr);

    if(pws)
    {
        /* Find a cleartext password */
        const char* t = find_cleartext_password(rq->buf, (const char**)pws);

        if(t)
        {
            digest_makeha1(ha1, user, rq->context->realm, t);
            ret = HA_OK;
        }

        ldap_value_free(pws);

        if(ret == HA_OK)
        {
            ha_messagex(rq, LOG_DEBUG, "using clear password from ldap");
            goto finally;
        }
    }

    ha_messagex(rq, LOG_ERR, "server contains no clear password or HA1 for user: %s", user);

finally:

    if(ld)
        save_ldap_connection(rq, ctx, ld);

    if(results)
        ldap_msgfree(results);

    return ret;
}

static int validate_basic(ha_request_t* rq, const char* user, const char* password)
{
    ldap_context_t* ctx = (ldap_context_t*)rq->context->ctx_data;
    LDAP* ld = NULL;
    LDAPMessage* entry = NULL;
    LDAPMessage* results = NULL;
    const char* dn = NULL;
    int ret = HA_FALSE;
    int found = 0;
    int r;

    ASSERT(rq && user && password);

    ld = get_ldap_connection(rq, ctx);
    if(!ld)
    {
        ret = HA_FAILED;
        goto finally;
    }


    /*
     * Discover the DN of the user. If there's a DN map string
     * then we can do this really quickly here without querying
     * the LDAP tree
     */
    if(ctx->dnmap)
    {
        /* The map can have %u and %r to denote user and realm */
        dn = substitute_params(rq, ctx, user, ctx->dnmap);
        if(!dn)
        {
            ret = HA_CRITERROR;
            goto finally;
        }

        ha_messagex(rq, LOG_INFO, "mapped %s to %s", user, dn);
    }


    /**
     * Okay now we contact the LDAP server. There are many ways
     * this is used for different authentication modes:
     *
     * - If a dn has been mapped above, this can apply a
     *   configured filter to narrow things down.
     * - If no dn has been mapped, then this maps out a dn
     *   by using the single object the filter returns.
     * - If not in 'dobind' mode we also retrieve the password
     *   here.
     *
     * All this results in only one query to the LDAP server,
     * except for the case of dobind without a dnmap.
     */

    if(!ctx->dobind || !dn || ctx->filter)
    {
        r = retrieve_user_entry(rq, ctx, ld, user, &dn, &entry, &results);
        if(r != HA_OK)
        {
            ret = r;
            goto finally;
        }
    }


    /* Now if in bind mode we try to bind as that user */
    if(ctx->dobind)
    {
        ASSERT(dn);

        r = ldap_simple_bind_s(ld, dn, password);
        if(r != LDAP_SUCCESS)
        {
            if(r == LDAP_INVALID_CREDENTIALS)
                ha_messagex(rq, LOG_WARNING, "basic authentication (via bind) failed for user: %s",
                                user);

            else
                report_ldap(rq, "couldn't bind to LDAP server", r);

            goto finally;
        }

        /* It worked! */
        ha_messagex(rq, LOG_NOTICE, "validated basic user using bind: %s", user);
        found = 1;

        /* Now we have to rebind the connection back to the main user */
        r = ldap_simple_bind_s(ld, ctx->user ? ctx->user : "",
                               ctx->password ? ctx->password : "");
        if(r != LDAP_SUCCESS)
        {
            report_ldap(rq, "couldn't rebind LDAP connection back to auth credentials", r);

            /* Discard the connection since it's useless to us */
            discard_ldap_connection(rq, ctx, ld);
            ld = NULL;
        }
    }


    /* Otherwise we compare the password attribute */
    else
    {
        ret = validate_ldap_password(rq, ctx, ld, entry, user, password);
        if(ret == HA_FALSE)
        ret = validate_ldap_ha1(rq, ctx, ld, entry, user,
                                rq->context->realm, password);

        if(ret == HA_OK)
        {
            ha_messagex(rq, LOG_NOTICE, "validated basic user password/ha1: %s", user);
            found = 1;
        }

        else
        {
            ha_messagex(rq, LOG_WARNING, "invalid, unreadable or unrecognized password for user: %s", user);
        }
    }

finally:

    if(ld)
        save_ldap_connection(rq, ctx, ld);

    if(results)
        ldap_msgfree(results);

    /* TODO: Check to make sure this fits within the return values */
    return ret;
}


/* -------------------------------------------------------------------------------
 * Handler Functions
 */

int ldap_config(ha_context_t* context, const char* name, const char* value)
{
    ldap_context_t* ctx = (ldap_context_t*)(context->ctx_data);

    ASSERT(name && value && value[0]);

    if(strcmp(name, "ldapservers") == 0)
    {
        ctx->servers = value;
        return HA_OK;
    }

    else if(strcmp(name, "ldapfilter") == 0)
    {
        ctx->filter = value;
        return HA_OK;
    }

    else if(strcmp(name, "ldapbase") == 0)
    {
        ctx->base = value;
        return HA_OK;
    }

    else if(strcmp(name, "ldappwattr") == 0)
    {
        ctx->pw_attr = value;
        return HA_OK;
    }

    else if(strcmp(name, "ldapha1attr") == 0)
    {
        ctx->ha1_attr = value;
        return HA_OK;
    }

    else if(strcmp(name, "ldapuser") == 0)
    {
        ctx->user = value;
        return HA_OK;
    }

    else if(strcmp(name, "ldappassword") == 0)
    {
        ctx->password = value;
        return HA_OK;
    }

    else if(strcmp(name, "ldapdnmap") == 0)
    {
        ctx->dnmap = value;
        return HA_OK;
    }

    else if(strcmp(name, "ldapscope") == 0)
    {
        if(strcmp(value, "sub") == 0 || strcmp(value, "subtree") == 0)
            ctx->scope = LDAP_SCOPE_SUBTREE;
        else if(strcmp(value, "base") == 0)
            ctx->scope = LDAP_SCOPE_BASE;
        else if(strcmp(value, "one") == 0 || strcmp(value, "onelevel") == 0)
            ctx->scope = LDAP_SCOPE_ONELEVEL;
        else
        {
            ha_messagex(NULL, LOG_ERR, "invalid value for '%s' (must be 'sub', 'base' or 'one')", name);
            return HA_FAILED;
        }

        return HA_OK;
    }

    else if(strcmp(name, "ldapdobind") == 0)
    {
        return ha_confbool(name, value, &(ctx->dobind));
    }

    else if(strcmp(name, "ldapmax") == 0)
    {
        return ha_confint(name, value, 1, 256, &(ctx->ldap_max));
    }

    else if(strcmp(name, "ldaptimeout") == 0)
    {
        return ha_confint(name, value, 0, 86400, &(ctx->ldap_timeout));
    }

    return HA_FALSE;
}

int ldap_inithand(ha_context_t* context)
{
    int r;

    if((r = bd_init(context)) != HA_OK)
        return r;

    /* Context specific initialization */
    if(context)
    {
        ldap_context_t* ctx = (ldap_context_t*)(context->ctx_data);
        ASSERT(ctx);

        /* Check for mandatory configuration */
        if(!ctx->servers)
        {
            ha_messagex(NULL, LOG_ERR, "configuration incomplete. "
                           "Must have LDAPServers.");
            return HA_FAILED;
        }

        if(!ctx->dnmap && (!ctx->filter || !ctx->base))
        {
            ha_messagex(NULL, LOG_ERR, "configuration incomplete. "
                                 "When not using LDAPDNMap must specify LDAPBase and LDAPFilter.");
            return HA_FAILED;
        }

        ASSERT(!ctx->pool);
        ASSERT(ctx->ldap_max > 0);

        /*
         * Our connection pool. It's the size of our maximum
         * amount of pending connections as that's the max
         * we'd be able to use at a time anyway.
         */
        ctx->pool = (LDAP**)malloc(sizeof(LDAP*) * ctx->ldap_max);
        if(!ctx->pool)
        {
            ha_messagex(NULL, LOG_CRIT, "out of memory");
            return HA_CRITERROR;
        }

        memset(ctx->pool, 0, sizeof(LDAP*) * ctx->ldap_max);
        ha_messagex(NULL, LOG_INFO, "initialized handler");
    }

    return HA_OK;
}

void ldap_destroy(ha_context_t* context)
{
    if(context)
    {
        /* Note: We don't need to be thread safe here anymore */
        ldap_context_t* ctx = (ldap_context_t*)(context->ctx_data);
        int i;

        ASSERT(ctx);

        if(ctx->pool)
        {
            /* Close any connections we have open */
            for(i = 0; i < ctx->ldap_max; i++)
            {
                if(ctx->pool[i])
                    ldap_unbind_s(ctx->pool[i]);
            }

            /* And free the connection pool */
            free(ctx->pool);
        }
    }

    bd_destroy(context);
    ha_messagex(NULL, LOG_INFO, "uninitialized ldap handler");
}



/* -------------------------------------------------------------------------------
 * Handler Definition
 */

ha_handler_t ldap_handler =
{
    "LDAP",                  /* The type */
    ldap_inithand,           /* Initialization function */
    ldap_destroy,            /* Uninitialization routine */
    ldap_config,             /* Config routine */
    bd_process,              /* Processing routine */
    &ldap_defaults,          /* The context defaults */
    sizeof(ldap_context_t)
};