3 * Copyright 1998-2003 The OpenLDAP Foundation, All Rights Reserved.
4 * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
10 #include <ac/stdlib.h>
11 #include <ac/string.h>
20 #ifdef HAVE_CYRUS_SASL
21 # ifdef HAVE_SASL_SASL_H
22 # include <sasl/sasl.h>
27 # if SASL_VERSION_MAJOR >= 2
28 # include <sasl/saslplug.h>
29 # define SASL_CONST const
34 static sasl_security_properties_t sasl_secprops;
35 #endif /* HAVE_CYRUS_SASL */
41 int slap_sasl_config( int cargc, char **cargv, char *line,
42 const char *fname, int lineno )
44 /* set SASL proxy authorization policy */
45 if ( strcasecmp( cargv[0], "sasl-authz-policy" ) == 0 ) {
48 LDAP_LOG( CONFIG, CRIT,
49 "%s: line %d: missing policy in"
50 " \"sasl-authz-policy <policy>\" line\n",
53 Debug( LDAP_DEBUG_ANY,
54 "%s: line %d: missing policy in"
55 " \"sasl-authz-policy <policy>\" line\n",
61 if ( slap_sasl_setpolicy( cargv[1] ) ) {
63 LDAP_LOG( CONFIG, CRIT,
64 "%s: line %d: unable "
65 "to parse value \"%s\" "
66 "in \"sasl-authz-policy "
68 fname, lineno, cargv[1] );
70 Debug( LDAP_DEBUG_ANY,
71 "%s: line %d: unable "
72 "to parse value \"%s\" "
73 "in \"sasl-authz-policy "
75 fname, lineno, cargv[1] );
80 } else if ( !strcasecmp( cargv[0], "sasl-regexp" )
81 || !strcasecmp( cargv[0], "saslregexp" ) )
86 LDAP_LOG( CONFIG, CRIT,
87 "%s: line %d: need 2 args in "
88 "\"saslregexp <match> <replace>\"\n",
91 Debug( LDAP_DEBUG_ANY,
92 "%s: line %d: need 2 args in "
93 "\"saslregexp <match> <replace>\"\n",
99 rc = slap_sasl_regexp_config( cargv[1], cargv[2] );
104 #ifdef HAVE_CYRUS_SASL
106 } else if ( strcasecmp( cargv[0], "sasl-host" ) == 0 ) {
109 LDAP_LOG( CONFIG, CRIT,
110 "%s: line %d: missing host in \"sasl-host <host>\" line\n",
113 Debug( LDAP_DEBUG_ANY,
114 "%s: line %d: missing host in \"sasl-host <host>\" line\n",
121 if ( global_host != NULL ) {
123 LDAP_LOG( CONFIG, CRIT,
124 "%s: line %d: already set sasl-host!\n",
127 Debug( LDAP_DEBUG_ANY,
128 "%s: line %d: already set sasl-host!\n",
135 global_host = ch_strdup( cargv[1] );
139 } else if ( strcasecmp( cargv[0], "sasl-realm" ) == 0 ) {
142 LDAP_LOG( CONFIG, CRIT, "%s: line %d: "
143 "missing realm in \"sasl-realm <realm>\" line.\n",
146 Debug( LDAP_DEBUG_ANY, "%s: line %d: "
147 "missing realm in \"sasl-realm <realm>\" line.\n",
154 if ( global_realm != NULL ) {
156 LDAP_LOG( CONFIG, CRIT,
157 "%s: line %d: already set sasl-realm!\n",
160 Debug( LDAP_DEBUG_ANY,
161 "%s: line %d: already set sasl-realm!\n",
168 global_realm = ch_strdup( cargv[1] );
171 /* SASL security properties */
172 } else if ( strcasecmp( cargv[0], "sasl-secprops" ) == 0 ) {
177 LDAP_LOG( CONFIG, CRIT, "%s: line %d: "
178 "missing flags in \"sasl-secprops <properties>\" line\n",
181 Debug( LDAP_DEBUG_ANY, "%s: line %d: "
182 "missing flags in \"sasl-secprops <properties>\" line\n",
189 txt = slap_sasl_secprops( cargv[1] );
192 LDAP_LOG( CONFIG, CRIT,
193 "%s: line %d sasl-secprops: %s\n",
194 fname, lineno, txt );
196 Debug( LDAP_DEBUG_ANY,
197 "%s: line %d: sasl-secprops: %s\n",
198 fname, lineno, txt );
203 #endif /* HAVE_CYRUS_SASL */
209 #ifdef HAVE_CYRUS_SASL
217 Connection *conn = context;
221 if ( message == NULL ) {
222 return SASL_BADPARAM;
226 #if SASL_VERSION_MAJOR >= 2
228 level = LDAP_DEBUG_NONE;
232 level = LDAP_DEBUG_ANY;
236 level = LDAP_DEBUG_ANY;
240 level = LDAP_DEBUG_TRACE;
244 level = LDAP_DEBUG_TRACE;
248 level = LDAP_DEBUG_TRACE;
252 level = LDAP_DEBUG_TRACE;
256 level = LDAP_DEBUG_TRACE;
257 label = "Password Trace";
261 level = LDAP_DEBUG_ANY;
264 case SASL_LOG_WARNING:
265 level = LDAP_DEBUG_TRACE;
269 level = LDAP_DEBUG_TRACE;
274 return SASL_BADPARAM;
278 LDAP_LOG( TRANSPORT, ENTRY,
279 "SASL [conn=%ld] %s: %s\n", conn ? conn->c_connid : -1, label, message);
281 Debug( level, "SASL [conn=%ld] %s: %s\n",
282 conn ? conn->c_connid: -1,
291 #if SASL_VERSION_MAJOR >= 2
292 static const char *slap_propnames[] = {
293 "*slapConn", "*authcDN", "*authzDN", NULL };
295 static Filter *generic_filter;
301 typedef struct lookup_info {
304 const struct propval *list;
305 sasl_server_params_t *sparams;
316 LDAPControl **ctrls )
319 AttributeDescription *ad;
323 slap_callback *tmp = op->o_callback;
324 lookup_info *sl = tmp->sc_private;
326 for( i = 0; i < sl->last; i++ ) {
327 const char *name = sl->list[i].name;
329 if ( name[0] == '*' ) {
330 if ( sl->flags & SASL_AUXPROP_AUTHZID ) continue;
332 } else if ( !(sl->flags & SASL_AUXPROP_AUTHZID ) )
335 if ( sl->list[i].values ) {
336 if ( !(sl->flags & SASL_AUXPROP_OVERRIDE) ) continue;
339 rc = slap_str2ad( name, &ad, &text );
340 if ( rc != LDAP_SUCCESS ) {
342 LDAP_LOG( TRANSPORT, DETAIL1,
343 "slap_auxprop: str2ad(%s): %s\n", name, text, 0 );
345 Debug( LDAP_DEBUG_TRACE,
346 "slap_auxprop: str2ad(%s): %s\n", name, text, 0 );
350 a = attr_find( e->e_attrs, ad );
352 if ( ! access_allowed( be, conn, op, e, ad, NULL, ACL_AUTH, NULL ) )
354 if ( sl->list[i].values && ( sl->flags & SASL_AUXPROP_OVERRIDE ) )
355 sl->sparams->utils->prop_erase( sl->sparams->propctx, sl->list[i].name );
356 for ( bv = a->a_vals; bv->bv_val; bv++ ) {
357 sl->sparams->utils->prop_set( sl->sparams->propctx, sl->list[i].name,
358 bv->bv_val, bv->bv_len );
367 sasl_server_params_t *sparams,
374 Connection *conn = NULL;
377 sl.list = sparams->utils->prop_get( sparams->propctx );
378 sl.sparams = sparams;
381 /* Find our DN and conn first */
382 for( i = 0, sl.last = 0; sl.list[i].name; i++ ) {
383 if ( sl.list[i].name[0] == '*' ) {
384 if ( !strcmp( sl.list[i].name, slap_propnames[PROP_CONN] ) ) {
385 if ( sl.list[i].values && sl.list[i].values[0] )
386 AC_MEMCPY( &conn, sl.list[i].values[0], sizeof( conn ) );
387 if ( !sl.last ) sl.last = i;
389 if ( (flags & SASL_AUXPROP_AUTHZID) &&
390 !strcmp( sl.list[i].name, slap_propnames[PROP_AUTHZ] ) ) {
392 if ( sl.list[i].values && sl.list[i].values[0] )
393 AC_MEMCPY( &dn, sl.list[i].values[0], sizeof( dn ) );
394 if ( !sl.last ) sl.last = i;
397 if ( !strcmp( sl.list[i].name, slap_propnames[PROP_AUTHC] ) ) {
398 if ( !sl.last ) sl.last = i;
399 if ( sl.list[i].values && sl.list[i].values[0] ) {
400 AC_MEMCPY( &dn, sl.list[i].values[0], sizeof( dn ) );
401 if ( !(flags & SASL_AUXPROP_AUTHZID) )
408 /* Now see what else needs to be fetched */
409 for( i = 0; i < sl.last; i++ ) {
410 const char *name = sl.list[i].name;
412 if ( name[0] == '*' ) {
413 if ( flags & SASL_AUXPROP_AUTHZID ) continue;
415 } else if ( !(flags & SASL_AUXPROP_AUTHZID ) )
418 if ( sl.list[i].values ) {
419 if ( !(flags & SASL_AUXPROP_OVERRIDE) ) continue;
427 slap_callback cb = { slap_cb_null_response,
428 slap_cb_null_sresult, sasl_ap_lookup, slap_cb_null_sreference, NULL };
432 be = select_backend( &dn, 0, 1 );
434 if ( be && be->be_search ) {
435 op.o_tag = LDAP_REQ_SEARCH;
436 op.o_protocol = LDAP_VERSION3;
437 op.o_ndn = conn->c_ndn;
439 op.o_time = slap_get_time();
440 op.o_do_not_cache = 1;
441 op.o_is_auth_check = 1;
442 op.o_threadctx = conn->c_sasl_bindop->o_threadctx;
444 (*be->be_search)( be, conn, &op, NULL, &dn,
445 LDAP_SCOPE_BASE, LDAP_DEREF_NEVER, 1, 0,
446 generic_filter, NULL, NULL, 0 );
451 static sasl_auxprop_plug_t slap_auxprop_plugin = {
454 NULL, /* glob_context */
455 NULL, /* auxprop_free */
463 const sasl_utils_t *utils,
466 sasl_auxprop_plug_t **plug,
467 const char *plugname)
469 if ( !out_version | !plug ) return SASL_BADPARAM;
471 if ( max_version < SASL_AUXPROP_PLUG_VERSION ) return SASL_BADVERS;
473 *out_version = SASL_AUXPROP_PLUG_VERSION;
474 *plug = &slap_auxprop_plugin;
478 typedef struct checkpass_info {
491 LDAPControl **ctrls )
493 slap_callback *tmp = op->o_callback;
494 checkpass_info *ci = tmp->sc_private;
498 ci->rc = SASL_NOVERIFY;
500 a = attr_find( e->e_attrs, slap_schema.si_ad_userPassword );
502 if ( ! access_allowed( be, conn, op, e, slap_schema.si_ad_userPassword,
503 NULL, ACL_AUTH, NULL ) ) return 0;
505 for ( bv = a->a_vals; bv->bv_val != NULL; bv++ ) {
506 if ( !lutil_passwd( bv, &ci->cred, NULL ) ) {
518 const char *username,
521 struct propctx *propctx)
523 Connection *conn = (Connection *)context;
531 /* SASL will fallback to its own mechanisms if we don't
532 * find an answer here.
535 rc = slap_sasl_getdn( conn, (char *)username, 0, NULL, &dn,
536 SLAP_GETDN_AUTHCID );
537 if ( rc != LDAP_SUCCESS ) {
538 sasl_seterror( sconn, 0, ldap_err2string( rc ) );
542 if ( dn.bv_len == 0 ) {
543 sasl_seterror( sconn, 0,
544 "No password is associated with the Root DSE" );
545 if ( dn.bv_val != NULL ) {
546 ch_free( dn.bv_val );
551 be = select_backend( &dn, 0, 1 );
552 if ( be && be->be_search ) {
554 slap_callback cb = { slap_cb_null_response,
555 slap_cb_null_sresult, sasl_cb_checkpass, slap_cb_null_sreference, NULL };
557 ci.cred.bv_val = (char *)pass;
558 ci.cred.bv_len = passlen;
561 op.o_tag = LDAP_REQ_SEARCH;
562 op.o_protocol = LDAP_VERSION3;
563 op.o_ndn = conn->c_ndn;
565 op.o_time = slap_get_time();
566 op.o_do_not_cache = 1;
567 op.o_is_auth_check = 1;
568 op.o_threadctx = conn->c_sasl_bindop->o_threadctx;
570 (*be->be_search)( be, conn, &op, NULL, &dn,
571 LDAP_SCOPE_BASE, LDAP_DEREF_NEVER, 1, 0,
572 generic_filter, NULL, NULL, 0 );
574 if ( ci.rc != SASL_OK ) {
575 sasl_seterror( sconn, 0,
576 ldap_err2string( LDAP_INVALID_CREDENTIALS ) );
579 ch_free( dn.bv_val );
584 /* Convert a SASL authcid or authzid into a DN. Store the DN in an
585 * auxiliary property, so that we can refer to it in sasl_authorize
586 * without interfering with anything else. Also, the SASL username
587 * buffer is constrained to 256 characters, and our DNs could be
588 * much longer (totally arbitrary length)...
591 slap_sasl_canonicalize(
597 const char *user_realm,
602 Connection *conn = (Connection *)context;
603 struct propctx *props = sasl_auxprop_getctx( sconn );
604 struct propval auxvals[3];
607 const char *names[2];
612 LDAP_LOG( TRANSPORT, ENTRY,
613 "slap_sasl_canonicalize: conn %d %s=\"%s\"\n",
614 conn ? conn->c_connid : -1,
615 (flags & SASL_CU_AUTHID) ? "authcid" : "authzid",
616 in ? in : "<empty>");
618 Debug( LDAP_DEBUG_ARGS, "SASL Canonicalize [conn=%ld]: %s=\"%s\"\n",
619 conn ? conn->c_connid : -1,
620 (flags & SASL_CU_AUTHID) ? "authcid" : "authzid",
621 in ? in : "<empty>");
624 /* If name is too big, just truncate. We don't care, we're
625 * using DNs, not the usernames.
627 if ( inlen > out_max )
630 /* See if we need to add request, can only do it once */
631 prop_getnames( props, slap_propnames, auxvals );
632 if ( !auxvals[0].name )
633 prop_request( props, slap_propnames );
635 if ( flags & SASL_CU_AUTHID )
640 /* Need to store the Connection for auxprop_lookup */
641 if ( !auxvals[PROP_CONN].values ) {
642 names[0] = slap_propnames[PROP_CONN];
644 prop_set( props, names[0], (char *)&conn, sizeof( conn ) );
647 /* Already been here? */
648 if ( auxvals[which].values )
651 /* Normally we require an authzID to have a u: or dn: prefix.
652 * However, SASL frequently gives us an authzID that is just
653 * an exact copy of the authcID, without a prefix. We need to
654 * detect and allow this condition. If SASL calls canonicalize
655 * with SASL_CU_AUTHID|SASL_CU_AUTHZID this is a no-brainer.
656 * But if it's broken into two calls, we need to remember the
657 * authcID so that we can compare the authzID later. We store
658 * the authcID temporarily in conn->c_sasl_dn. We necessarily
659 * finish Canonicalizing before Authorizing, so there is no
660 * conflict with slap_sasl_authorize's use of this temp var.
662 * The SASL EXTERNAL mech is backwards from all the other mechs,
663 * it does authzID before the authcID. If we see that authzID
664 * has already been done, don't do anything special with authcID.
666 if ( flags == SASL_CU_AUTHID && !auxvals[PROP_AUTHZ].values ) {
667 conn->c_sasl_dn.bv_val = (char *) in;
668 } else if ( flags == SASL_CU_AUTHZID && conn->c_sasl_dn.bv_val ) {
669 rc = strcmp( in, conn->c_sasl_dn.bv_val );
670 conn->c_sasl_dn.bv_val = NULL;
671 /* They were equal, no work needed */
672 if ( !rc ) goto done;
675 rc = slap_sasl_getdn( conn, (char *)in, inlen, (char *)user_realm, &dn,
676 (flags & SASL_CU_AUTHID) ? SLAP_GETDN_AUTHCID : SLAP_GETDN_AUTHZID );
677 if ( rc != LDAP_SUCCESS ) {
678 sasl_seterror( sconn, 0, ldap_err2string( rc ) );
682 names[0] = slap_propnames[which];
685 prop_set( props, names[0], (char *)&dn, sizeof( dn ) );
688 LDAP_LOG( TRANSPORT, ENTRY,
689 "slap_sasl_canonicalize: conn %d %s=\"%s\"\n",
690 conn ? conn->c_connid : -1, names[0]+1,
691 dn.bv_val ? dn.bv_val : "<EMPTY>" );
693 Debug( LDAP_DEBUG_ARGS, "SASL Canonicalize [conn=%ld]: %s=\"%s\"\n",
694 conn ? conn->c_connid : -1, names[0]+1,
695 dn.bv_val ? dn.bv_val : "<EMPTY>" );
699 AC_MEMCPY( out, in, inlen );
711 char *requested_user,
715 const char *def_realm,
717 struct propctx *props)
719 Connection *conn = (Connection *)context;
720 struct propval auxvals[3];
721 struct berval authcDN, authzDN;
725 LDAP_LOG( TRANSPORT, ENTRY,
726 "slap_sasl_authorize: conn %d authcid=\"%s\" authzid=\"%s\"\n",
727 conn ? conn->c_connid : -1, auth_identity, requested_user);
729 Debug( LDAP_DEBUG_ARGS, "SASL Authorize [conn=%ld]: "
730 "authcid=\"%s\" authzid=\"%s\"\n",
731 conn ? conn->c_connid : -1, auth_identity, requested_user );
733 if ( conn->c_sasl_dn.bv_val ) {
734 ch_free( conn->c_sasl_dn.bv_val );
735 conn->c_sasl_dn.bv_val = NULL;
736 conn->c_sasl_dn.bv_len = 0;
740 prop_getnames( props, slap_propnames+1, auxvals );
742 AC_MEMCPY( &authcDN, auxvals[0].values[0], sizeof(authcDN) );
744 /* Nothing to do if no authzID was given */
745 if ( !auxvals[1].name || !auxvals[1].values ) {
746 conn->c_sasl_dn = authcDN;
750 AC_MEMCPY( &authzDN, auxvals[1].values[0], sizeof(authzDN) );
752 rc = slap_sasl_authorized( conn, &authcDN, &authzDN );
753 ch_free( authcDN.bv_val );
754 if ( rc != LDAP_SUCCESS ) {
756 LDAP_LOG( TRANSPORT, INFO,
757 "slap_sasl_authorize: conn %ld authorization disallowed (%d)\n",
758 (long)(conn ? conn->c_connid : -1), rc, 0 );
760 Debug( LDAP_DEBUG_TRACE, "SASL Authorize [conn=%ld]: "
761 " authorization disallowed (%d)\n",
762 (long) (conn ? conn->c_connid : -1), rc, 0 );
765 sasl_seterror( sconn, 0, "not authorized" );
766 ch_free( authzDN.bv_val );
770 conn->c_sasl_dn = authzDN;
772 if (conn->c_sasl_bindop) {
773 Statslog( LDAP_DEBUG_STATS,
774 "conn=%lu op=%lu BIND authcid=\"%s\"\n",
775 conn->c_connid, conn->c_sasl_bindop->o_opid,
776 auth_identity, 0, 0);
780 LDAP_LOG( TRANSPORT, ENTRY,
781 "slap_sasl_authorize: conn %d authorization allowed\n",
782 (long)(conn ? conn->c_connid : -1), 0, 0 );
784 Debug( LDAP_DEBUG_TRACE, "SASL Authorize [conn=%ld]: "
785 " authorization allowed\n",
786 (long) (conn ? conn->c_connid : -1), 0, 0 );
799 struct berval authcDN, authzDN;
801 Connection *conn = context;
805 if ( conn->c_sasl_dn.bv_val ) {
806 ch_free( conn->c_sasl_dn.bv_val );
807 conn->c_sasl_dn.bv_val = NULL;
808 conn->c_sasl_dn.bv_len = 0;
812 LDAP_LOG( TRANSPORT, ENTRY,
813 "slap_sasl_authorize: conn %d authcid=\"%s\" authzid=\"%s\"\n",
814 conn ? conn->c_connid : -1, authcid ? authcid : "<empty>",
815 authzid ? authzid : "<empty>" );
817 Debug( LDAP_DEBUG_ARGS, "SASL Authorize [conn=%ld]: "
818 "authcid=\"%s\" authzid=\"%s\"\n",
819 (long) (conn ? conn->c_connid : -1),
820 authcid ? authcid : "<empty>",
821 authzid ? authzid : "<empty>" );
824 /* Figure out how much data we have for the dn */
825 rc = sasl_getprop( conn->c_sasl_context, SASL_REALM, (void **)&realm );
826 if( rc != SASL_OK && rc != SASL_NOTDONE ) {
828 LDAP_LOG( TRANSPORT, ERR,
829 "slap_sasl_authorize: getprop(REALM) failed.\n", 0, 0, 0 );
831 Debug(LDAP_DEBUG_TRACE,
832 "authorize: getprop(REALM) failed!\n", 0,0,0);
834 *errstr = "Could not extract realm";
838 /* Convert the identities to DN's. If no authzid was given, client will
839 be bound as the DN matching their username */
840 rc = slap_sasl_getdn( conn, (char *)authcid, 0, realm,
841 &authcDN, SLAP_GETDN_AUTHCID );
842 if( rc != LDAP_SUCCESS ) {
843 *errstr = ldap_err2string( rc );
846 if( ( authzid == NULL ) || !strcmp( authcid,authzid ) ) {
848 LDAP_LOG( TRANSPORT, ENTRY,
849 "slap_sasl_authorize: conn %d Using authcDN=%s\n",
850 conn ? conn->c_connid : -1, authcDN.bv_val, 0 );
852 Debug( LDAP_DEBUG_TRACE, "SASL Authorize [conn=%ld]: "
853 "Using authcDN=%s\n", (long) (conn ? conn->c_connid : -1), authcDN.bv_val,0 );
856 conn->c_sasl_dn = authcDN;
859 rc = slap_sasl_getdn( conn, (char *)authzid, 0, realm,
860 &authzDN, SLAP_GETDN_AUTHZID );
861 if( rc != LDAP_SUCCESS ) {
862 ch_free( authcDN.bv_val );
863 *errstr = ldap_err2string( rc );
867 rc = slap_sasl_authorized(conn, &authcDN, &authzDN );
868 ch_free( authcDN.bv_val );
871 LDAP_LOG( TRANSPORT, INFO,
872 "slap_sasl_authorize: conn %ld authorization disallowed (%d)\n",
873 (long)(conn ? conn->c_connid : -1), rc, 0 );
875 Debug( LDAP_DEBUG_TRACE, "SASL Authorize [conn=%ld]: "
876 " authorization disallowed (%d)\n",
877 (long) (conn ? conn->c_connid : -1), rc, 0 );
880 *errstr = "not authorized";
881 ch_free( authzDN.bv_val );
884 conn->c_sasl_dn = authzDN;
888 LDAP_LOG( TRANSPORT, RESULTS,
889 "slap_sasl_authorize: conn %d authorization allowed\n",
890 (long)(conn ? conn->c_connid : -1 ), 0, 0 );
892 Debug( LDAP_DEBUG_TRACE, "SASL Authorize [conn=%ld]: "
893 " authorization allowed\n",
894 (long) (conn ? conn->c_connid : -1), 0, 0 );
897 if (conn->c_sasl_bindop) {
898 Statslog( LDAP_DEBUG_STATS,
899 "conn=%lu op=%lu BIND authcid=\"%s\"\n",
900 conn->c_connid, conn->c_sasl_bindop->o_opid,
907 #endif /* SASL_VERSION_MAJOR >= 2 */
910 slap_sasl_err2ldap( int saslerr )
916 rc = LDAP_SASL_BIND_IN_PROGRESS;
925 rc = LDAP_AUTH_METHOD_NOT_SUPPORTED;
928 rc = LDAP_INVALID_CREDENTIALS;
931 rc = LDAP_INSUFFICIENT_ACCESS;
935 rc = LDAP_INAPPROPRIATE_AUTH;
946 int slap_sasl_init( void )
948 #ifdef HAVE_CYRUS_SASL
950 static sasl_callback_t server_callbacks[] = {
951 { SASL_CB_LOG, &slap_sasl_log, NULL },
952 { SASL_CB_LIST_END, NULL, NULL }
955 #ifdef HAVE_SASL_VERSION
956 #define SASL_BUILD_VERSION ((SASL_VERSION_MAJOR << 24) |\
957 (SASL_VERSION_MINOR << 16) | SASL_VERSION_STEP)
959 sasl_version( NULL, &rc );
960 if ( ((rc >> 16) != ((SASL_VERSION_MAJOR << 8)|SASL_VERSION_MINOR)) ||
961 (rc & 0xffff) < SASL_VERSION_STEP) {
964 LDAP_LOG( TRANSPORT, INFO,
965 "slap_sasl_init: SASL version mismatch, got %x, wanted %x.\n",
966 rc, SASL_BUILD_VERSION, 0 );
968 Debug( LDAP_DEBUG_ANY,
969 "slap_sasl_init: SASL version mismatch, got %x, wanted %x.\n",
970 rc, SASL_BUILD_VERSION, 0 );
976 /* SASL 2 does its own memory management internally */
977 #if SASL_VERSION_MAJOR < 2
986 ldap_pvt_sasl_mutex_new,
987 ldap_pvt_sasl_mutex_lock,
988 ldap_pvt_sasl_mutex_unlock,
989 ldap_pvt_sasl_mutex_dispose );
991 #if SASL_VERSION_MAJOR >= 2
992 sasl_auxprop_add_plugin( "slapd", slap_auxprop_init );
994 /* should provide callbacks for logging */
995 /* server name should be configurable */
996 rc = sasl_server_init( server_callbacks, "slapd" );
998 if( rc != SASL_OK ) {
1000 LDAP_LOG( TRANSPORT, INFO, "slap_sasl_init: init failed.\n", 0, 0, 0 );
1002 Debug( LDAP_DEBUG_ANY, "sasl_server_init failed\n",
1005 #if SASL_VERSION_MAJOR < 2
1006 /* A no-op used to make sure we linked with Cyrus 1.5 */
1007 sasl_client_auth( NULL, NULL, NULL, 0, NULL, NULL );
1014 LDAP_LOG( TRANSPORT, INFO, "slap_sasl_init: initialized!\n", 0, 0, 0 );
1016 Debug( LDAP_DEBUG_TRACE, "slap_sasl_init: initialized!\n",
1021 /* default security properties */
1022 memset( &sasl_secprops, '\0', sizeof(sasl_secprops) );
1023 sasl_secprops.max_ssf = INT_MAX;
1024 sasl_secprops.maxbufsize = 65536;
1025 sasl_secprops.security_flags = SASL_SEC_NOPLAINTEXT|SASL_SEC_NOANONYMOUS;
1031 int slap_sasl_destroy( void )
1033 #ifdef HAVE_CYRUS_SASL
1036 #if SASL_VERSION_MAJOR >= 2
1037 filter_free( generic_filter );
1039 free( global_host );
1045 int slap_sasl_open( Connection *conn )
1047 int cb, sc = LDAP_SUCCESS;
1048 #if SASL_VERSION_MAJOR >= 2
1049 char *ipremoteport = NULL, *iplocalport = NULL;
1052 #ifdef HAVE_CYRUS_SASL
1053 sasl_conn_t *ctx = NULL;
1054 sasl_callback_t *session_callbacks;
1056 assert( conn->c_sasl_context == NULL );
1057 assert( conn->c_sasl_extra == NULL );
1059 conn->c_sasl_layers = 0;
1062 #if SASL_VERSION_MAJOR >= 2
1063 SLAP_CALLOC( 5, sizeof(sasl_callback_t));
1065 SLAP_CALLOC( 3, sizeof(sasl_callback_t));
1067 if( session_callbacks == NULL ) {
1069 LDAP_LOG( TRANSPORT, ERR,
1070 "slap_sasl_open: SLAP_MALLOC failed", 0, 0, 0 );
1072 Debug( LDAP_DEBUG_ANY,
1073 "slap_sasl_open: SLAP_MALLOC failed", 0, 0, 0 );
1077 conn->c_sasl_extra = session_callbacks;
1079 session_callbacks[cb=0].id = SASL_CB_LOG;
1080 session_callbacks[cb].proc = &slap_sasl_log;
1081 session_callbacks[cb++].context = conn;
1083 session_callbacks[cb].id = SASL_CB_PROXY_POLICY;
1084 session_callbacks[cb].proc = &slap_sasl_authorize;
1085 session_callbacks[cb++].context = conn;
1087 #if SASL_VERSION_MAJOR >= 2
1088 session_callbacks[cb].id = SASL_CB_CANON_USER;
1089 session_callbacks[cb].proc = &slap_sasl_canonicalize;
1090 session_callbacks[cb++].context = conn;
1092 /* XXXX: this should be conditional */
1093 session_callbacks[cb].id = SASL_CB_SERVER_USERDB_CHECKPASS;
1094 session_callbacks[cb].proc = &slap_sasl_checkpass;
1095 session_callbacks[cb++].context = conn;
1098 session_callbacks[cb].id = SASL_CB_LIST_END;
1099 session_callbacks[cb].proc = NULL;
1100 session_callbacks[cb++].context = NULL;
1102 if( global_host == NULL ) {
1103 global_host = ldap_pvt_get_fqdn( NULL );
1106 /* create new SASL context */
1107 #if SASL_VERSION_MAJOR >= 2
1108 if ( generic_filter == NULL ) {
1109 generic_filter = str2filter( "(objectclass=*)" );
1111 if ( conn->c_sock_name.bv_len != 0 &&
1112 strncmp( conn->c_sock_name.bv_val, "IP=", 3 ) == 0) {
1115 iplocalport = ch_strdup( conn->c_sock_name.bv_val + 3 );
1116 /* Convert IPv6 addresses to address;port syntax. */
1117 p = strrchr( iplocalport, ' ' );
1118 /* Convert IPv4 addresses to address;port syntax. */
1119 if ( p == NULL ) p = strchr( iplocalport, ':' );
1124 if ( conn->c_peer_name.bv_len != 0 &&
1125 strncmp( conn->c_peer_name.bv_val, "IP=", 3 ) == 0) {
1128 ipremoteport = ch_strdup( conn->c_peer_name.bv_val + 3 );
1129 /* Convert IPv6 addresses to address;port syntax. */
1130 p = strrchr( ipremoteport, ' ' );
1131 /* Convert IPv4 addresses to address;port syntax. */
1132 if ( p == NULL ) p = strchr( ipremoteport, ':' );
1137 sc = sasl_server_new( "ldap", global_host, global_realm,
1138 iplocalport, ipremoteport, session_callbacks, SASL_SUCCESS_DATA, &ctx );
1139 if ( iplocalport != NULL ) {
1140 ch_free( iplocalport );
1142 if ( ipremoteport != NULL ) {
1143 ch_free( ipremoteport );
1146 sc = sasl_server_new( "ldap", global_host, global_realm,
1147 session_callbacks, SASL_SECURITY_LAYER, &ctx );
1150 if( sc != SASL_OK ) {
1152 LDAP_LOG( TRANSPORT, ERR,
1153 "slap_sasl_open: sasl_server_new failed: %d\n", sc, 0, 0 );
1155 Debug( LDAP_DEBUG_ANY, "sasl_server_new failed: %d\n",
1162 conn->c_sasl_context = ctx;
1164 if( sc == SASL_OK ) {
1165 sc = sasl_setprop( ctx,
1166 SASL_SEC_PROPS, &sasl_secprops );
1168 if( sc != SASL_OK ) {
1170 LDAP_LOG( TRANSPORT, ERR,
1171 "slap_sasl_open: sasl_setprop failed: %d \n", sc, 0, 0 );
1173 Debug( LDAP_DEBUG_ANY, "sasl_setprop failed: %d\n",
1177 slap_sasl_close( conn );
1182 sc = slap_sasl_err2ldap( sc );
1187 int slap_sasl_external(
1190 const char *auth_id )
1192 #if SASL_VERSION_MAJOR >= 2
1194 sasl_conn_t *ctx = conn->c_sasl_context;
1196 if ( ctx == NULL ) {
1197 return LDAP_UNAVAILABLE;
1200 sc = sasl_setprop( ctx, SASL_SSF_EXTERNAL, &ssf );
1202 if ( sc != SASL_OK ) {
1206 sc = sasl_setprop( ctx, SASL_AUTH_EXTERNAL, auth_id );
1208 if ( sc != SASL_OK ) {
1212 #elif defined(HAVE_CYRUS_SASL)
1214 sasl_conn_t *ctx = conn->c_sasl_context;
1215 sasl_external_properties_t extprops;
1217 if ( ctx == NULL ) {
1218 return LDAP_UNAVAILABLE;
1221 memset( &extprops, '\0', sizeof(extprops) );
1223 extprops.auth_id = (char *) auth_id;
1225 sc = sasl_setprop( ctx, SASL_SSF_EXTERNAL,
1226 (void *) &extprops );
1228 if ( sc != SASL_OK ) {
1233 return LDAP_SUCCESS;
1236 int slap_sasl_reset( Connection *conn )
1238 #ifdef HAVE_CYRUS_SASL
1239 sasl_conn_t *ctx = conn->c_sasl_context;
1244 /* must return "anonymous" */
1245 return LDAP_SUCCESS;
1248 char ** slap_sasl_mechs( Connection *conn )
1250 char **mechs = NULL;
1252 #ifdef HAVE_CYRUS_SASL
1253 sasl_conn_t *ctx = conn->c_sasl_context;
1257 SASL_CONST char *mechstr;
1259 sc = sasl_listmech( ctx,
1260 NULL, NULL, ",", NULL,
1261 &mechstr, NULL, NULL );
1263 if( sc != SASL_OK ) {
1265 LDAP_LOG( TRANSPORT, ERR,
1266 "slap_sasl_mechs: sasl_listmech failed: %d\n", sc, 0, 0 );
1268 Debug( LDAP_DEBUG_ANY, "slap_sasl_listmech failed: %d\n",
1275 mechs = ldap_str2charray( mechstr, "," );
1277 #if SASL_VERSION_MAJOR < 2
1286 int slap_sasl_close( Connection *conn )
1288 #ifdef HAVE_CYRUS_SASL
1289 sasl_conn_t *ctx = conn->c_sasl_context;
1292 sasl_dispose( &ctx );
1295 conn->c_sasl_context = NULL;
1297 free( conn->c_sasl_extra );
1298 conn->c_sasl_extra = NULL;
1301 return LDAP_SUCCESS;
1309 struct berval *cred,
1315 #ifdef HAVE_CYRUS_SASL
1316 sasl_conn_t *ctx = conn->c_sasl_context;
1317 struct berval response;
1318 unsigned reslen = 0;
1319 const char *errstr = NULL;
1323 LDAP_LOG( TRANSPORT, ENTRY,
1324 "sasl_bind: dn=\"%s\" mech=%s datalen=%ld\n",
1325 dn->bv_len ? dn->bv_val : "",
1326 conn->c_sasl_bind_in_progress ? "<continuing>" :
1327 conn->c_sasl_bind_mech.bv_val,
1328 cred ? cred->bv_len : 0 );
1330 Debug(LDAP_DEBUG_ARGS,
1331 "==> sasl_bind: dn=\"%s\" mech=%s datalen=%ld\n",
1332 dn->bv_len ? dn->bv_val : "",
1333 conn->c_sasl_bind_in_progress ? "<continuing>":conn->c_sasl_bind_mech.bv_val,
1334 cred ? cred->bv_len : 0 );
1339 send_ldap_result( conn, op, LDAP_UNAVAILABLE,
1340 NULL, "SASL unavailable on this session", NULL, NULL );
1344 #if SASL_VERSION_MAJOR >= 2
1345 #define START( ctx, mech, cred, clen, resp, rlen, err ) \
1346 sasl_server_start( ctx, mech, cred, clen, resp, rlen )
1347 #define STEP( ctx, cred, clen, resp, rlen, err ) \
1348 sasl_server_step( ctx, cred, clen, resp, rlen )
1350 #define START( ctx, mech, cred, clen, resp, rlen, err ) \
1351 sasl_server_start( ctx, mech, cred, clen, resp, rlen, err )
1352 #define STEP( ctx, cred, clen, resp, rlen, err ) \
1353 sasl_server_step( ctx, cred, clen, resp, rlen, err )
1356 if ( !conn->c_sasl_bind_in_progress ) {
1358 conn->c_sasl_bind_mech.bv_val,
1359 cred->bv_val, cred->bv_len,
1360 (SASL_CONST char **)&response.bv_val, &reslen, &errstr );
1364 cred->bv_val, cred->bv_len,
1365 (SASL_CONST char **)&response.bv_val, &reslen, &errstr );
1368 response.bv_len = reslen;
1370 if ( sc == SASL_OK ) {
1371 sasl_ssf_t *ssf = NULL;
1373 *edn = conn->c_sasl_dn;
1374 conn->c_sasl_dn.bv_val = NULL;
1375 conn->c_sasl_dn.bv_len = 0;
1379 (void) sasl_getprop( ctx, SASL_SSF, (void *)&ssf );
1380 *ssfp = ssf ? *ssf : 0;
1383 ldap_pvt_thread_mutex_lock( &conn->c_mutex );
1384 conn->c_sasl_layers++;
1385 ldap_pvt_thread_mutex_unlock( &conn->c_mutex );
1388 send_ldap_sasl( conn, op, rc,
1389 NULL, NULL, NULL, NULL,
1390 response.bv_len ? &response : NULL );
1392 } else if ( sc == SASL_CONTINUE ) {
1393 send_ldap_sasl( conn, op, rc = LDAP_SASL_BIND_IN_PROGRESS,
1394 NULL, NULL, NULL, NULL, &response );
1397 #if SASL_VERSION_MAJOR >= 2
1398 errstr = sasl_errdetail( ctx );
1400 send_ldap_result( conn, op, rc = slap_sasl_err2ldap( sc ),
1401 NULL, errstr, NULL, NULL );
1404 #if SASL_VERSION_MAJOR < 2
1405 if( response.bv_len ) {
1406 ch_free( response.bv_val );
1411 LDAP_LOG( TRANSPORT, RESULTS, "slap_sasl_bind: rc=%d\n", rc, 0, 0 );
1413 Debug(LDAP_DEBUG_TRACE, "<== slap_sasl_bind: rc=%d\n", rc, 0, 0);
1418 send_ldap_result( conn, op, rc = LDAP_UNAVAILABLE,
1419 NULL, "SASL not supported", NULL, NULL );
1425 char* slap_sasl_secprops( const char *in )
1427 #ifdef HAVE_CYRUS_SASL
1428 int rc = ldap_pvt_sasl_secprops( in, &sasl_secprops );
1430 return rc == LDAP_SUCCESS ? NULL : "Invalid security properties";
1432 return "SASL not supported";
1436 #ifdef HAVE_CYRUS_SASL
1441 struct berval *reqoid,
1442 struct berval *reqdata,
1444 struct berval **rspdata,
1445 LDAPControl *** rspctrls,
1449 struct berval id = { 0, NULL }; /* needs to come from connection */
1450 struct berval new = { 0, NULL };
1451 struct berval old = { 0, NULL };
1453 assert( reqoid != NULL );
1454 assert( ber_bvcmp( &slap_EXOP_MODIFY_PASSWD, reqoid ) == 0 );
1456 rc = sasl_getprop( conn->c_sasl_context, SASL_USERNAME,
1457 (SASL_CONST void **)&id.bv_val );
1459 if( rc != SASL_OK ) {
1460 *text = "unable to retrieve SASL username";
1466 LDAP_LOG( BACKEND, ENTRY,
1467 "slap_sasl_setpass: \"%s\"\n",
1468 id.bv_val ? id.bv_val : "", 0, 0);
1470 Debug( LDAP_DEBUG_ARGS, "==> slap_sasl_setpass: \"%s\"\n",
1471 id.bv_val ? id.bv_val : "", 0, 0 );
1474 rc = slap_passwd_parse( reqdata,
1475 NULL, &old, &new, text );
1477 if( rc != LDAP_SUCCESS ) {
1481 if( new.bv_len == 0 ) {
1482 slap_passwd_generate(&new);
1484 if( new.bv_len == 0 ) {
1485 *text = "password generation failed.";
1490 *rspdata = slap_passwd_return( &new );
1493 #if SASL_VERSION_MAJOR < 2
1494 rc = sasl_setpass( conn->c_sasl_context,
1495 id.bv_val, new.bv_val, new.bv_len, 0, text );
1497 rc = sasl_setpass( conn->c_sasl_context, id.bv_val,
1498 new.bv_val, new.bv_len, old.bv_val, old.bv_len, 0 );
1499 if( rc != SASL_OK ) {
1500 *text = sasl_errdetail( conn->c_sasl_context );
1521 #endif /* HAVE_CYRUS_SASL */
1523 /* Take any sort of identity string and return a DN with the "dn:" prefix. The
1524 string returned in *dn is in its own allocated memory, and must be free'd
1525 by the calling process.
1526 -Mark Adamson, Carnegie Mellon
1528 The "dn:" prefix is no longer used anywhere inside slapd. It is only used
1529 on strings passed in directly from SASL.
1530 -Howard Chu, Symas Corp.
1537 static struct berval ext_bv = BER_BVC( "EXTERNAL" );
1539 int slap_sasl_getdn( Connection *conn, char *id, int len,
1540 char *user_realm, struct berval *dn, int flags )
1543 int rc, is_dn = SET_NONE, do_norm = 1;
1547 LDAP_LOG( TRANSPORT, ENTRY,
1548 "slap_sasl_getdn: conn %d id=%s [len=%d]\n",
1549 conn ? conn->c_connid : -1, id ? (*id ? id : "<empty>") : "NULL", len );
1551 Debug( LDAP_DEBUG_ARGS, "slap_sasl_getdn: id=%s [len=%d]\n",
1552 id ? ( *id ? id : "<empty>" ) : "NULL", len, 0 );
1559 if ( len == 0 ) len = strlen( id );
1561 /* Blatantly anonymous ID */
1562 if ( len == sizeof("anonymous") - 1 &&
1563 !strcasecmp( id, "anonymous" ) ) {
1564 return( LDAP_SUCCESS );
1570 /* An authcID needs to be converted to authzID form. Set the
1571 * values directly into *dn; they will be normalized later. (and
1572 * normalizing always makes a new copy.) An ID from a TLS certificate
1573 * is already normalized, so copy it and skip normalization.
1575 if( flags & SLAP_GETDN_AUTHCID ) {
1576 if( conn->c_sasl_bind_mech.bv_len == ext_bv.bv_len &&
1577 strcasecmp( ext_bv.bv_val, conn->c_sasl_bind_mech.bv_val ) == 0 )
1579 /* EXTERNAL DNs are already normalized */
1582 ber_str2bv( id, len, 1, dn );
1585 /* convert to u:<username> form */
1591 if( is_dn == SET_NONE ) {
1592 if( !strncasecmp( id, "u:", sizeof("u:")-1 )) {
1596 } else if ( !strncasecmp( id, "dn:", sizeof("dn:")-1) ) {
1603 /* No other possibilities from here */
1604 if( is_dn == SET_NONE ) {
1607 return( LDAP_INAPPROPRIATE_AUTH );
1610 /* Username strings */
1611 if( is_dn == SET_U ) {
1613 len = dn->bv_len + sizeof("uid=")-1 + sizeof(",cn=auth")-1;
1615 /* username may have embedded realm name */
1616 if( ( realm = strchr( dn->bv_val, '@') ) ) {
1618 len += sizeof(",cn=")-2;
1619 } else if( user_realm && *user_realm ) {
1620 len += strlen( user_realm ) + sizeof(",cn=")-1;
1623 if( conn->c_sasl_bind_mech.bv_len ) {
1624 len += conn->c_sasl_bind_mech.bv_len + sizeof(",cn=")-1;
1627 /* Build the new dn */
1629 dn->bv_val = SLAP_MALLOC( len+1 );
1630 if( dn->bv_val == NULL ) {
1632 LDAP_LOG( TRANSPORT, ERR,
1633 "slap_sasl_getdn: SLAP_MALLOC failed", 0, 0, 0 );
1635 Debug( LDAP_DEBUG_ANY,
1636 "slap_sasl_getdn: SLAP_MALLOC failed", 0, 0, 0 );
1640 p = lutil_strcopy( dn->bv_val, "uid=" );
1641 p = lutil_strncopy( p, c1, dn->bv_len );
1644 int rlen = dn->bv_len - ( realm - c1 );
1645 p = lutil_strcopy( p, ",cn=" );
1646 p = lutil_strncopy( p, realm, rlen );
1648 } else if( user_realm && *user_realm ) {
1649 p = lutil_strcopy( p, ",cn=" );
1650 p = lutil_strcopy( p, user_realm );
1653 if( conn->c_sasl_bind_mech.bv_len ) {
1654 p = lutil_strcopy( p, ",cn=" );
1655 p = lutil_strcopy( p, conn->c_sasl_bind_mech.bv_val );
1657 p = lutil_strcopy( p, ",cn=auth" );
1658 dn->bv_len = p - dn->bv_val;
1661 LDAP_LOG( TRANSPORT, ENTRY,
1662 "slap_sasl_getdn: u:id converted to %s.\n", dn->bv_val, 0, 0 );
1664 Debug( LDAP_DEBUG_TRACE, "getdn: u:id converted to %s\n", dn->bv_val,0,0 );
1668 /* Dup the DN in any case, so we don't risk
1669 * leaks or dangling pointers later,
1670 * and the DN value is '\0' terminated */
1671 ber_dupbv( &dn2, dn );
1672 dn->bv_val = dn2.bv_val;
1675 /* All strings are in DN form now. Normalize if needed. */
1677 rc = dnNormalize2( NULL, dn, &dn2 );
1679 /* User DNs were constructed above and must be freed now */
1680 ch_free( dn->bv_val );
1682 if ( rc != LDAP_SUCCESS ) {
1690 /* Run thru regexp */
1691 slap_sasl2dn( conn, dn, &dn2 );
1693 ch_free( dn->bv_val );
1696 LDAP_LOG( TRANSPORT, ENTRY,
1697 "slap_sasl_getdn: dn:id converted to %s.\n", dn->bv_val, 0, 0 );
1699 Debug( LDAP_DEBUG_TRACE, "getdn: dn:id converted to %s\n",
1704 return( LDAP_SUCCESS );