3 * Copyright 1999-2000 The OpenLDAP Foundation, All Rights Reserved.
4 * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
12 #include <ac/socket.h>
13 #include <ac/string.h>
20 #include "ldap_pvt_thread.h"
23 #ifdef HAVE_CYRUS_SASL
27 * Various Cyrus SASL related stuff.
30 #define SASL_MAX_BUFF_SIZE 65536
31 #define SASL_MIN_BUFF_SIZE 4096
33 int ldap_int_sasl_init( void )
35 /* XXX not threadsafe */
36 static int sasl_initialized = 0;
38 static sasl_callback_t client_callbacks[] = {
39 #ifdef SASL_CB_GETREALM
40 { SASL_CB_GETREALM, NULL, NULL },
42 { SASL_CB_USER, NULL, NULL },
43 { SASL_CB_AUTHNAME, NULL, NULL },
44 { SASL_CB_PASS, NULL, NULL },
45 { SASL_CB_ECHOPROMPT, NULL, NULL },
46 { SASL_CB_NOECHOPROMPT, NULL, NULL },
47 { SASL_CB_LIST_END, NULL, NULL }
50 if ( sasl_initialized ) {
60 #endif /* CSRIMALLOC */
64 ldap_pvt_sasl_mutex_new,
65 ldap_pvt_sasl_mutex_lock,
66 ldap_pvt_sasl_mutex_unlock,
67 ldap_pvt_sasl_mutex_dispose );
70 if ( sasl_client_init( client_callbacks ) == SASL_OK ) {
79 * SASL encryption support for LBER Sockbufs
83 sasl_conn_t *sasl_context;
84 Sockbuf_Buf sec_buf_in;
90 sb_sasl_setup( Sockbuf_IO_Desc *sbiod, void *arg )
92 struct sb_sasl_data *p;
94 assert( sbiod != NULL );
96 p = LBER_MALLOC( sizeof( *p ) );
99 p->sasl_context = (sasl_conn_t *)arg;
100 ber_pvt_sb_buf_init( &p->sec_buf_in );
101 ber_pvt_sb_buf_init( &p->buf_in );
102 ber_pvt_sb_buf_init( &p->buf_out );
103 if ( ber_pvt_sb_grow_buffer( &p->sec_buf_in, SASL_MIN_BUFF_SIZE ) < 0 ) {
108 sbiod->sbiod_pvt = p;
114 sb_sasl_remove( Sockbuf_IO_Desc *sbiod )
116 struct sb_sasl_data *p;
118 assert( sbiod != NULL );
120 p = (struct sb_sasl_data *)sbiod->sbiod_pvt;
121 ber_pvt_sb_buf_destroy( &p->sec_buf_in );
122 ber_pvt_sb_buf_destroy( &p->buf_in );
123 ber_pvt_sb_buf_destroy( &p->buf_out );
125 sbiod->sbiod_pvt = NULL;
130 sb_sasl_pkt_length( const char *buf, int debuglevel )
135 assert( buf != NULL );
137 tmp = *((long *)buf);
140 if ( size > SASL_MAX_BUFF_SIZE ) {
141 /* somebody is trying to mess me up. */
142 ber_log_printf( LDAP_DEBUG_ANY, debuglevel,
143 "sb_sasl_pkt_length: received illegal packet length "
144 "of %lu bytes\n", (unsigned long)size );
145 size = 16; /* this should lead to an error. */
148 return size + 4; /* include the size !!! */
151 /* Drop a processed packet from the input buffer */
153 sb_sasl_drop_packet ( Sockbuf_Buf *sec_buf_in, int debuglevel )
157 len = sec_buf_in->buf_ptr - sec_buf_in->buf_end;
159 memmove( sec_buf_in->buf_base, sec_buf_in->buf_base +
160 sec_buf_in->buf_end, len );
163 sec_buf_in->buf_end = sb_sasl_pkt_length( sec_buf_in->buf_base,
167 sec_buf_in->buf_end = 0;
169 sec_buf_in->buf_ptr = len;
173 sb_sasl_read( Sockbuf_IO_Desc *sbiod, void *buf, ber_len_t len)
175 struct sb_sasl_data *p;
176 ber_slen_t ret, bufptr;
178 assert( sbiod != NULL );
179 assert( SOCKBUF_VALID( sbiod->sbiod_sb ) );
181 p = (struct sb_sasl_data *)sbiod->sbiod_pvt;
183 /* Are there anything left in the buffer? */
184 ret = ber_pvt_sb_copy_out( &p->buf_in, buf, len );
191 ber_pvt_sb_buf_destroy( &p->buf_in );
193 /* Read the length of the packet */
194 while ( p->sec_buf_in.buf_ptr < 4 ) {
195 ret = LBER_SBIOD_READ_NEXT( sbiod, p->sec_buf_in.buf_base,
196 4 - p->sec_buf_in.buf_ptr );
198 if ( ( ret < 0 ) && ( errno == EINTR ) )
204 p->sec_buf_in.buf_ptr += ret;
207 /* The new packet always starts at p->sec_buf_in.buf_base */
208 ret = sb_sasl_pkt_length( p->sec_buf_in.buf_base,
209 sbiod->sbiod_sb->sb_debug );
211 /* Grow the packet buffer if neccessary */
212 if ( ( p->sec_buf_in.buf_size < ret ) &&
213 ber_pvt_sb_grow_buffer( &p->sec_buf_in, ret ) < 0 ) {
217 p->sec_buf_in.buf_end = ret;
219 /* Did we read the whole encrypted packet? */
220 while ( p->sec_buf_in.buf_ptr < p->sec_buf_in.buf_end ) {
221 /* No, we have got only a part of it */
222 ret = p->sec_buf_in.buf_end - p->sec_buf_in.buf_ptr;
224 ret = LBER_SBIOD_READ_NEXT( sbiod, p->sec_buf_in.buf_base +
225 p->sec_buf_in.buf_ptr, ret );
227 if ( ( ret < 0 ) && ( errno == EINTR ) )
233 p->sec_buf_in.buf_ptr += ret;
236 /* Decode the packet */
237 ret = sasl_decode( p->sasl_context, p->sec_buf_in.buf_base,
238 p->sec_buf_in.buf_end, &p->buf_in.buf_base,
239 (unsigned *)&p->buf_in.buf_end );
240 if ( ret != SASL_OK ) {
241 ber_log_printf( LDAP_DEBUG_ANY, sbiod->sbiod_sb->sb_debug,
242 "sb_sasl_read: failed to decode packet: %s\n",
243 sasl_errstring( ret, NULL, NULL ) );
244 sb_sasl_drop_packet( &p->sec_buf_in,
245 sbiod->sbiod_sb->sb_debug );
250 /* Drop the packet from the input buffer */
251 sb_sasl_drop_packet( &p->sec_buf_in, sbiod->sbiod_sb->sb_debug );
253 p->buf_in.buf_size = p->buf_in.buf_end;
255 bufptr += ber_pvt_sb_copy_out( &p->buf_in, (char*) buf + bufptr, len );
261 sb_sasl_write( Sockbuf_IO_Desc *sbiod, void *buf, ber_len_t len)
263 struct sb_sasl_data *p;
266 assert( sbiod != NULL );
267 assert( SOCKBUF_VALID( sbiod->sbiod_sb ) );
269 p = (struct sb_sasl_data *)sbiod->sbiod_pvt;
271 /* Are there anything left in the buffer? */
272 if ( p->buf_out.buf_ptr != p->buf_out.buf_end ) {
273 ret = ber_pvt_sb_do_write( sbiod, &p->buf_out );
278 /* now encode the next packet. */
279 ber_pvt_sb_buf_destroy( &p->buf_out );
280 ret = sasl_encode( p->sasl_context, buf, len, &p->buf_out.buf_base,
281 (unsigned *)&p->buf_out.buf_size );
282 if ( ret != SASL_OK ) {
283 ber_log_printf( LDAP_DEBUG_ANY, sbiod->sbiod_sb->sb_debug,
284 "sb_sasl_write: failed to encode packet: %s\n",
285 sasl_errstring( ret, NULL, NULL ) );
288 p->buf_out.buf_end = p->buf_out.buf_size;
290 ret = ber_pvt_sb_do_write( sbiod, &p->buf_out );
297 sb_sasl_ctrl( Sockbuf_IO_Desc *sbiod, int opt, void *arg )
299 struct sb_sasl_data *p;
301 p = (struct sb_sasl_data *)sbiod->sbiod_pvt;
303 if ( opt == LBER_SB_OPT_DATA_READY ) {
304 if ( p->buf_in.buf_ptr != p->buf_in.buf_end )
308 return LBER_SBIOD_CTRL_NEXT( sbiod, opt, arg );
311 Sockbuf_IO ldap_pvt_sockbuf_io_sasl = {
312 sb_sasl_setup, /* sbi_setup */
313 sb_sasl_remove, /* sbi_remove */
314 sb_sasl_ctrl, /* sbi_ctrl */
315 sb_sasl_read, /* sbi_read */
316 sb_sasl_write, /* sbi_write */
320 int ldap_pvt_sasl_install( Sockbuf *sb, void *ctx_arg )
322 Debug( LDAP_DEBUG_TRACE, "ldap_pvt_sasl_install\n",
325 /* don't install the stuff unless security has been negotiated */
327 if ( !ber_sockbuf_ctrl( sb, LBER_SB_OPT_HAS_IO,
328 &ldap_pvt_sockbuf_io_sasl ) )
329 ber_sockbuf_add_io( sb, &ldap_pvt_sockbuf_io_sasl,
330 LBER_SBIOD_LEVEL_APPLICATION, ctx_arg );
336 sasl_err2ldap( int saslerr )
342 rc = LDAP_MORE_RESULTS_TO_RETURN;
345 rc = LDAP_LOCAL_ERROR;
351 rc = LDAP_LOCAL_ERROR;
357 rc = LDAP_AUTH_UNKNOWN;
360 rc = LDAP_AUTH_UNKNOWN;
363 rc = LDAP_PARAM_ERROR;
367 rc = LDAP_AUTH_UNKNOWN;
370 rc = LDAP_LOCAL_ERROR;
374 assert( rc == LDAP_SUCCESS || LDAP_API_ERROR( rc ) );
388 sasl_callback_t *session_callbacks =
389 ber_memcalloc( 2, sizeof( sasl_callback_t ) );
391 if( session_callbacks == NULL ) return LDAP_NO_MEMORY;
393 session_callbacks[0].id = SASL_CB_USER;
394 session_callbacks[0].proc = NULL;
395 session_callbacks[0].context = ld;
397 session_callbacks[1].id = SASL_CB_LIST_END;
398 session_callbacks[1].proc = NULL;
399 session_callbacks[1].context = NULL;
401 assert( lc->lconn_sasl_ctx == NULL );
403 if ( host == NULL ) {
404 ld->ld_errno = LDAP_UNAVAILABLE;
408 rc = sasl_client_new( "ldap", host, session_callbacks,
409 SASL_SECURITY_LAYER, &ctx );
411 if ( rc != SASL_OK ) {
412 ld->ld_errno = sasl_err2ldap( rc );
416 Debug( LDAP_DEBUG_TRACE, "ldap_int_sasl_open: %s\n",
419 lc->lconn_sasl_ctx = ctx;
422 sasl_external_properties_t extprops;
423 memset(&extprops, 0L, sizeof(extprops));
426 (void) sasl_setprop( ctx, SASL_SSF_EXTERNAL,
427 (void *) &extprops );
429 Debug( LDAP_DEBUG_TRACE, "ldap_int_sasl_open: ssf=%ld\n",
436 int ldap_int_sasl_close( LDAP *ld, LDAPConn *lc )
438 sasl_conn_t *ctx = lc->lconn_sasl_ctx;
439 assert( ctx != NULL );
442 sasl_dispose( &ctx );
443 lc->lconn_sasl_ctx = NULL;
454 LDAPControl **sctrls,
455 LDAPControl **cctrls,
457 LDAP_SASL_INTERACT_PROC *interact,
461 const char *mech = NULL;
462 const char *pmech = NULL;
464 sasl_ssf_t *ssf = NULL;
466 sasl_interact_t *prompts = NULL;
471 Debug( LDAP_DEBUG_TRACE, "ldap_int_sasl_bind: %s\n",
472 mechs ? mechs : "<null>", 0, 0 );
474 /* do a quick !LDAPv3 check... ldap_sasl_bind will do the rest. */
475 if (ld->ld_version < LDAP_VERSION3) {
476 ld->ld_errno = LDAP_NOT_SUPPORTED;
480 ber_sockbuf_ctrl( ld->ld_sb, LBER_SB_OPT_GET_FD, &sd );
482 if ( sd == AC_SOCKET_INVALID ) {
483 /* not connected yet */
484 int rc = ldap_open_defconn( ld );
486 if( rc < 0 ) return ld->ld_errno;
487 ber_sockbuf_ctrl( ld->ld_sb, LBER_SB_OPT_GET_FD, &sd );
489 if( sd == AC_SOCKET_INVALID ) {
490 ld->ld_errno = LDAP_UNAVAILABLE;
495 ctx = ld->ld_defconn->lconn_sasl_ctx;
498 ld->ld_errno = LDAP_UNAVAILABLE;
502 /* (re)set security properties */
503 sasl_setprop( ctx, SASL_SEC_PROPS,
504 &ld->ld_options.ldo_sasl_secprops );
510 saslrc = sasl_client_start( ctx,
518 if( pmech == NULL && mech != NULL ) {
521 if( flags != LDAP_SASL_QUIET ) {
523 "SASL/%s authentication started\n",
528 if( saslrc == SASL_INTERACT ) {
530 if( !interact ) break;
531 res = (interact)( ld, flags, defaults, prompts );
532 if( res != LDAP_SUCCESS ) {
536 } while ( saslrc == SASL_INTERACT );
538 ccred.bv_len = credlen;
540 if ( (saslrc != SASL_OK) && (saslrc != SASL_CONTINUE) ) {
541 ld->ld_errno = sasl_err2ldap( saslrc );
546 struct berval *scred;
551 rc = ldap_sasl_bind_s( ld, dn, mech, &ccred, sctrls, cctrls, &scred );
553 if ( ccred.bv_val != NULL ) {
554 LDAP_FREE( ccred.bv_val );
558 if ( rc != LDAP_SUCCESS && rc != LDAP_SASL_BIND_IN_PROGRESS ) {
560 /* and server provided us with data? */
561 Debug( LDAP_DEBUG_TRACE,
562 "ldap_int_sasl_bind: rc=%d sasl=%d len=%ld\n",
563 rc, saslrc, scred->bv_len );
569 if( rc == LDAP_SUCCESS && saslrc == SASL_OK ) {
570 /* we're done, no need to step */
572 /* but server provided us with data! */
573 Debug( LDAP_DEBUG_TRACE,
574 "ldap_int_sasl_bind: rc=%d sasl=%d len=%ld\n",
575 rc, saslrc, scred->bv_len );
577 return ld->ld_errno = LDAP_LOCAL_ERROR;
583 saslrc = sasl_client_step( ctx,
584 (scred == NULL) ? NULL : scred->bv_val,
585 (scred == NULL) ? 0 : scred->bv_len,
590 Debug( LDAP_DEBUG_TRACE, "sasl_client_start: %d\n",
593 if( saslrc == SASL_INTERACT ) {
595 if( !interact ) break;
596 res = (interact)( ld, flags, defaults, prompts );
597 if( res != LDAP_SUCCESS ) {
601 } while ( saslrc == SASL_INTERACT );
603 ccred.bv_len = credlen;
606 if ( (saslrc != SASL_OK) && (saslrc != SASL_CONTINUE) ) {
607 ld->ld_errno = sasl_err2ldap( saslrc );
610 } while ( rc == LDAP_SASL_BIND_IN_PROGRESS );
612 if ( rc != LDAP_SUCCESS ) {
616 if ( saslrc != SASL_OK ) {
617 return ld->ld_errno = sasl_err2ldap( saslrc );
620 if( flags != LDAP_SASL_QUIET ) {
621 saslrc = sasl_getprop( ctx, SASL_USERNAME, (void **) &data );
622 if( saslrc == SASL_OK && data && *data ) {
623 fprintf( stderr, "SASL username: %s\n", data );
626 saslrc = sasl_getprop( ctx, SASL_REALM, (void **) &data );
627 if( saslrc == SASL_OK && data && *data ) {
628 fprintf( stderr, "SASL realm: %s\n", data );
632 saslrc = sasl_getprop( ctx, SASL_SSF, (void **) &ssf );
633 if( saslrc == SASL_OK ) {
634 if( flags != LDAP_SASL_QUIET ) {
635 fprintf( stderr, "SASL SSF: %lu\n",
636 (unsigned long) *ssf );
640 if( flags != LDAP_SASL_QUIET ) {
641 fprintf( stderr, "SASL installing layers\n" );
643 ldap_pvt_sasl_install( ld->ld_sb, ctx );
650 int ldap_pvt_sasl_secprops(
652 sasl_security_properties_t *secprops )
655 char **props = ldap_str2charray( in, "," );
658 sasl_ssf_t max_ssf = 0;
660 sasl_ssf_t min_ssf = 0;
662 unsigned maxbufsize = 0;
663 int got_maxbufsize = 0;
665 if( props == NULL || secprops == NULL ) {
666 return LDAP_PARAM_ERROR;
669 for( i=0; props[i]; i++ ) {
670 if( !strcasecmp(props[i], "none") ) {
673 } else if( !strcasecmp(props[i], "noplain") ) {
675 sflags |= SASL_SEC_NOPLAINTEXT;
677 } else if( !strcasecmp(props[i], "noactive") ) {
679 sflags |= SASL_SEC_NOACTIVE;
681 } else if( !strcasecmp(props[i], "nodict") ) {
683 sflags |= SASL_SEC_NODICTIONARY;
685 } else if( !strcasecmp(props[i], "forwardsec") ) {
687 sflags |= SASL_SEC_FORWARD_SECRECY;
689 } else if( !strcasecmp(props[i], "noanonymous")) {
691 sflags |= SASL_SEC_NOANONYMOUS;
693 } else if( !strcasecmp(props[i], "passcred") ) {
695 sflags |= SASL_SEC_PASS_CREDENTIALS;
697 } else if( !strncasecmp(props[i],
698 "minssf=", sizeof("minssf")) )
700 if( isdigit( props[i][sizeof("minssf")] ) ) {
702 min_ssf = atoi( &props[i][sizeof("minssf")] );
704 return LDAP_NOT_SUPPORTED;
707 } else if( !strncasecmp(props[i],
708 "maxssf=", sizeof("maxssf")) )
710 if( isdigit( props[i][sizeof("maxssf")] ) ) {
712 max_ssf = atoi( &props[i][sizeof("maxssf")] );
714 return LDAP_NOT_SUPPORTED;
717 } else if( !strncasecmp(props[i],
718 "maxbufsize=", sizeof("maxbufsize")) )
720 if( isdigit( props[i][sizeof("maxbufsize")] ) ) {
722 maxbufsize = atoi( &props[i][sizeof("maxbufsize")] );
724 return LDAP_NOT_SUPPORTED;
728 return LDAP_NOT_SUPPORTED;
733 secprops->security_flags = sflags;
736 secprops->min_ssf = min_ssf;
739 secprops->max_ssf = max_ssf;
742 secprops->maxbufsize = maxbufsize;
745 ldap_charray_free( props );
750 ldap_int_sasl_config( struct ldapoptions *lo, int option, const char *arg )
755 case LDAP_OPT_X_SASL_SECPROPS:
756 rc = ldap_pvt_sasl_secprops( arg, &lo->ldo_sasl_secprops );
757 if( rc == LDAP_SUCCESS ) return 0;
764 ldap_int_sasl_get_option( LDAP *ld, int option, void *arg )
770 case LDAP_OPT_X_SASL_MECH: {
771 *(char **)arg = ld->ld_options.ldo_def_sasl_mech
772 ? LDAP_STRDUP( ld->ld_options.ldo_def_sasl_mech ) : NULL;
774 case LDAP_OPT_X_SASL_REALM: {
775 *(char **)arg = ld->ld_options.ldo_def_sasl_realm
776 ? LDAP_STRDUP( ld->ld_options.ldo_def_sasl_realm ) : NULL;
778 case LDAP_OPT_X_SASL_AUTHCID: {
779 *(char **)arg = ld->ld_options.ldo_def_sasl_authcid
780 ? LDAP_STRDUP( ld->ld_options.ldo_def_sasl_authcid ) : NULL;
782 case LDAP_OPT_X_SASL_AUTHZID: {
783 *(char **)arg = ld->ld_options.ldo_def_sasl_authzid
784 ? LDAP_STRDUP( ld->ld_options.ldo_def_sasl_authzid ) : NULL;
787 case LDAP_OPT_X_SASL_SSF: {
792 if( ld->ld_defconn == NULL ) {
796 ctx = ld->ld_defconn->lconn_sasl_ctx;
802 sc = sasl_getprop( ctx, SASL_SSF,
805 if ( sc != SASL_OK ) {
809 *(ber_len_t *)arg = *ssf;
812 case LDAP_OPT_X_SASL_SSF_EXTERNAL:
813 /* this option is write only */
816 case LDAP_OPT_X_SASL_SSF_MIN:
817 *(ber_len_t *)arg = ld->ld_options.ldo_sasl_secprops.min_ssf;
819 case LDAP_OPT_X_SASL_SSF_MAX:
820 *(ber_len_t *)arg = ld->ld_options.ldo_sasl_secprops.max_ssf;
822 case LDAP_OPT_X_SASL_MAXBUFSIZE:
823 *(ber_len_t *)arg = ld->ld_options.ldo_sasl_secprops.maxbufsize;
826 case LDAP_OPT_X_SASL_SECPROPS:
827 /* this option is write only */
837 ldap_int_sasl_set_option( LDAP *ld, int option, void *arg )
843 case LDAP_OPT_X_SASL_SSF:
844 /* This option is read-only */
847 case LDAP_OPT_X_SASL_SSF_EXTERNAL: {
849 sasl_external_properties_t extprops;
852 if( ld->ld_defconn == NULL ) {
856 ctx = ld->ld_defconn->lconn_sasl_ctx;
862 memset(&extprops, 0L, sizeof(extprops));
864 extprops.ssf = * (ber_len_t *) arg;
866 sc = sasl_setprop( ctx, SASL_SSF_EXTERNAL,
867 (void *) &extprops );
869 if ( sc != SASL_OK ) {
874 case LDAP_OPT_X_SASL_SSF_MIN:
875 ld->ld_options.ldo_sasl_secprops.min_ssf = *(ber_len_t *)arg;
877 case LDAP_OPT_X_SASL_SSF_MAX:
878 ld->ld_options.ldo_sasl_secprops.max_ssf = *(ber_len_t *)arg;
880 case LDAP_OPT_X_SASL_MAXBUFSIZE:
881 ld->ld_options.ldo_sasl_secprops.maxbufsize = *(ber_len_t *)arg;
884 case LDAP_OPT_X_SASL_SECPROPS: {
886 sc = ldap_pvt_sasl_secprops( (char *) arg,
887 &ld->ld_options.ldo_sasl_secprops );
889 return sc == LDAP_SUCCESS ? 0 : -1;
898 #ifdef LDAP_R_COMPILE
899 void *ldap_pvt_sasl_mutex_new(void)
901 ldap_pvt_thread_mutex_t *mutex;
903 mutex = (ldap_pvt_thread_mutex_t *) LDAP_MALLOC(
904 sizeof(ldap_pvt_thread_mutex_t) );
906 if ( ldap_pvt_thread_mutex_init( mutex ) == 0 ) {
912 int ldap_pvt_sasl_mutex_lock(void *mutex)
914 return ldap_pvt_thread_mutex_lock( (ldap_pvt_thread_mutex_t *)mutex )
915 ? SASL_FAIL : SASL_OK;
918 int ldap_pvt_sasl_mutex_unlock(void *mutex)
920 return ldap_pvt_thread_mutex_unlock( (ldap_pvt_thread_mutex_t *)mutex )
921 ? SASL_FAIL : SASL_OK;
924 void ldap_pvt_sasl_mutex_dispose(void *mutex)
926 (void) ldap_pvt_thread_mutex_destroy( (ldap_pvt_thread_mutex_t *)mutex );
932 int ldap_int_sasl_init( void )
933 { return LDAP_SUCCESS; }
935 int ldap_int_sasl_close( LDAP *ld, LDAPConn *lc )
936 { return LDAP_SUCCESS; }
943 LDAPControl **sctrls,
944 LDAPControl **cctrls,
946 LDAP_SASL_INTERACT_PROC *interact,
948 { return LDAP_NOT_SUPPORTED; }
949 #endif /* HAVE_CYRUS_SASL */