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>
19 #include "ldap_pvt_thread.h"
22 #ifdef HAVE_CYRUS_SASL
26 * Various Cyrus SASL related stuff.
29 #define SASL_MAX_BUFF_SIZE 65536
30 #define SASL_MIN_BUFF_SIZE 4096
32 int ldap_int_sasl_init( void )
34 /* XXX not threadsafe */
35 static int sasl_initialized = 0;
37 static sasl_callback_t client_callbacks[] = {
38 #ifdef SASL_CB_GETREALM
39 { SASL_CB_GETREALM, NULL, NULL },
41 { SASL_CB_USER, NULL, NULL },
42 { SASL_CB_AUTHNAME, NULL, NULL },
43 { SASL_CB_PASS, NULL, NULL },
44 { SASL_CB_ECHOPROMPT, NULL, NULL },
45 { SASL_CB_NOECHOPROMPT, NULL, NULL },
46 { SASL_CB_LIST_END, NULL, NULL }
49 if ( sasl_initialized ) {
59 #endif /* CSRIMALLOC */
63 ldap_pvt_sasl_mutex_new,
64 ldap_pvt_sasl_mutex_lock,
65 ldap_pvt_sasl_mutex_unlock,
66 ldap_pvt_sasl_mutex_dispose );
69 if ( sasl_client_init( client_callbacks ) == SASL_OK ) {
78 * SASL encryption support for LBER Sockbufs
82 sasl_conn_t *sasl_context;
83 Sockbuf_Buf sec_buf_in;
89 sb_sasl_setup( Sockbuf_IO_Desc *sbiod, void *arg )
91 struct sb_sasl_data *p;
93 assert( sbiod != NULL );
95 p = LBER_MALLOC( sizeof( *p ) );
98 p->sasl_context = (sasl_conn_t *)arg;
99 ber_pvt_sb_buf_init( &p->sec_buf_in );
100 ber_pvt_sb_buf_init( &p->buf_in );
101 ber_pvt_sb_buf_init( &p->buf_out );
102 if ( ber_pvt_sb_grow_buffer( &p->sec_buf_in, SASL_MIN_BUFF_SIZE ) < 0 ) {
107 sbiod->sbiod_pvt = p;
113 sb_sasl_remove( Sockbuf_IO_Desc *sbiod )
115 struct sb_sasl_data *p;
117 assert( sbiod != NULL );
119 p = (struct sb_sasl_data *)sbiod->sbiod_pvt;
120 ber_pvt_sb_buf_destroy( &p->sec_buf_in );
121 ber_pvt_sb_buf_destroy( &p->buf_in );
122 ber_pvt_sb_buf_destroy( &p->buf_out );
124 sbiod->sbiod_pvt = NULL;
129 sb_sasl_pkt_length( const char *buf, int debuglevel )
134 assert( buf != NULL );
136 tmp = *((long *)buf);
139 if ( size > SASL_MAX_BUFF_SIZE ) {
140 /* somebody is trying to mess me up. */
141 ber_log_printf( LDAP_DEBUG_ANY, debuglevel,
142 "sb_sasl_pkt_length: received illegal packet length "
143 "of %lu bytes\n", (unsigned long)size );
144 size = 16; /* this should lead to an error. */
147 return size + 4; /* include the size !!! */
150 /* Drop a processed packet from the input buffer */
152 sb_sasl_drop_packet ( Sockbuf_Buf *sec_buf_in, int debuglevel )
156 len = sec_buf_in->buf_ptr - sec_buf_in->buf_end;
158 memmove( sec_buf_in->buf_base, sec_buf_in->buf_base +
159 sec_buf_in->buf_end, len );
162 sec_buf_in->buf_end = sb_sasl_pkt_length( sec_buf_in->buf_base,
166 sec_buf_in->buf_end = 0;
168 sec_buf_in->buf_ptr = len;
172 sb_sasl_read( Sockbuf_IO_Desc *sbiod, void *buf, ber_len_t len)
174 struct sb_sasl_data *p;
175 ber_slen_t ret, bufptr;
177 assert( sbiod != NULL );
178 assert( SOCKBUF_VALID( sbiod->sbiod_sb ) );
180 p = (struct sb_sasl_data *)sbiod->sbiod_pvt;
182 /* Are there anything left in the buffer? */
183 ret = ber_pvt_sb_copy_out( &p->buf_in, buf, len );
190 ber_pvt_sb_buf_destroy( &p->buf_in );
192 /* Read the length of the packet */
193 while ( p->sec_buf_in.buf_ptr < 4 ) {
194 ret = LBER_SBIOD_READ_NEXT( sbiod, p->sec_buf_in.buf_base,
195 4 - p->sec_buf_in.buf_ptr );
197 if ( ( ret < 0 ) && ( errno == EINTR ) )
203 p->sec_buf_in.buf_ptr += ret;
206 /* The new packet always starts at p->sec_buf_in.buf_base */
207 ret = sb_sasl_pkt_length( p->sec_buf_in.buf_base,
208 sbiod->sbiod_sb->sb_debug );
210 /* Grow the packet buffer if neccessary */
211 if ( ( p->sec_buf_in.buf_size < ret ) &&
212 ber_pvt_sb_grow_buffer( &p->sec_buf_in, ret ) < 0 ) {
216 p->sec_buf_in.buf_end = ret;
218 /* Did we read the whole encrypted packet? */
219 while ( p->sec_buf_in.buf_ptr < p->sec_buf_in.buf_end ) {
220 /* No, we have got only a part of it */
221 ret = p->sec_buf_in.buf_end - p->sec_buf_in.buf_ptr;
223 ret = LBER_SBIOD_READ_NEXT( sbiod, p->sec_buf_in.buf_base +
224 p->sec_buf_in.buf_ptr, ret );
226 if ( ( ret < 0 ) && ( errno == EINTR ) )
232 p->sec_buf_in.buf_ptr += ret;
235 /* Decode the packet */
236 ret = sasl_decode( p->sasl_context, p->sec_buf_in.buf_base,
237 p->sec_buf_in.buf_end, &p->buf_in.buf_base,
238 (unsigned *)&p->buf_in.buf_end );
239 if ( ret != SASL_OK ) {
240 ber_log_printf( LDAP_DEBUG_ANY, sbiod->sbiod_sb->sb_debug,
241 "sb_sasl_read: failed to decode packet: %s\n",
242 sasl_errstring( ret, NULL, NULL ) );
243 sb_sasl_drop_packet( &p->sec_buf_in,
244 sbiod->sbiod_sb->sb_debug );
249 /* Drop the packet from the input buffer */
250 sb_sasl_drop_packet( &p->sec_buf_in, sbiod->sbiod_sb->sb_debug );
252 p->buf_in.buf_size = p->buf_in.buf_end;
254 bufptr += ber_pvt_sb_copy_out( &p->buf_in, (char*) buf + bufptr, len );
260 sb_sasl_write( Sockbuf_IO_Desc *sbiod, void *buf, ber_len_t len)
262 struct sb_sasl_data *p;
265 assert( sbiod != NULL );
266 assert( SOCKBUF_VALID( sbiod->sbiod_sb ) );
268 p = (struct sb_sasl_data *)sbiod->sbiod_pvt;
270 /* Are there anything left in the buffer? */
271 if ( p->buf_out.buf_ptr != p->buf_out.buf_end ) {
272 ret = ber_pvt_sb_do_write( sbiod, &p->buf_out );
277 /* now encode the next packet. */
278 ber_pvt_sb_buf_destroy( &p->buf_out );
279 ret = sasl_encode( p->sasl_context, buf, len, &p->buf_out.buf_base,
280 (unsigned *)&p->buf_out.buf_size );
281 if ( ret != SASL_OK ) {
282 ber_log_printf( LDAP_DEBUG_ANY, sbiod->sbiod_sb->sb_debug,
283 "sb_sasl_write: failed to encode packet: %s\n",
284 sasl_errstring( ret, NULL, NULL ) );
287 p->buf_out.buf_end = p->buf_out.buf_size;
289 ret = ber_pvt_sb_do_write( sbiod, &p->buf_out );
296 sb_sasl_ctrl( Sockbuf_IO_Desc *sbiod, int opt, void *arg )
298 struct sb_sasl_data *p;
300 p = (struct sb_sasl_data *)sbiod->sbiod_pvt;
302 if ( opt == LBER_SB_OPT_DATA_READY ) {
303 if ( p->buf_in.buf_ptr != p->buf_in.buf_end )
307 return LBER_SBIOD_CTRL_NEXT( sbiod, opt, arg );
310 Sockbuf_IO ldap_pvt_sockbuf_io_sasl = {
311 sb_sasl_setup, /* sbi_setup */
312 sb_sasl_remove, /* sbi_remove */
313 sb_sasl_ctrl, /* sbi_ctrl */
314 sb_sasl_read, /* sbi_read */
315 sb_sasl_write, /* sbi_write */
319 int ldap_pvt_sasl_install( Sockbuf *sb, void *ctx_arg )
321 Debug( LDAP_DEBUG_TRACE, "ldap_pvt_sasl_install\n",
324 /* don't install the stuff unless security has been negotiated */
326 if ( !ber_sockbuf_ctrl( sb, LBER_SB_OPT_HAS_IO,
327 &ldap_pvt_sockbuf_io_sasl ) )
328 ber_sockbuf_add_io( sb, &ldap_pvt_sockbuf_io_sasl,
329 LBER_SBIOD_LEVEL_APPLICATION, ctx_arg );
335 sasl_err2ldap( int saslerr )
341 rc = LDAP_MORE_RESULTS_TO_RETURN;
344 rc = LDAP_LOCAL_ERROR;
350 rc = LDAP_LOCAL_ERROR;
356 rc = LDAP_AUTH_UNKNOWN;
359 rc = LDAP_AUTH_UNKNOWN;
362 rc = LDAP_PARAM_ERROR;
366 rc = LDAP_AUTH_UNKNOWN;
369 rc = LDAP_LOCAL_ERROR;
373 assert( rc == LDAP_SUCCESS || LDAP_API_ERROR( rc ) );
387 sasl_callback_t *session_callbacks =
388 ber_memcalloc( 2, sizeof( sasl_callback_t ) );
390 if( session_callbacks == NULL ) return LDAP_NO_MEMORY;
392 session_callbacks[0].id = SASL_CB_USER;
393 session_callbacks[0].proc = NULL;
394 session_callbacks[0].context = ld;
396 session_callbacks[1].id = SASL_CB_LIST_END;
397 session_callbacks[1].proc = NULL;
398 session_callbacks[1].context = NULL;
400 assert( lc->lconn_sasl_ctx == NULL );
402 if ( host == NULL ) {
403 ld->ld_errno = LDAP_UNAVAILABLE;
407 rc = sasl_client_new( "ldap", host, session_callbacks,
408 SASL_SECURITY_LAYER, &ctx );
410 if ( rc != SASL_OK ) {
411 ld->ld_errno = sasl_err2ldap( rc );
415 Debug( LDAP_DEBUG_TRACE, "ldap_int_sasl_open: %s\n",
418 lc->lconn_sasl_ctx = ctx;
421 sasl_external_properties_t extprops;
422 memset(&extprops, 0L, sizeof(extprops));
425 (void) sasl_setprop( ctx, SASL_SSF_EXTERNAL,
426 (void *) &extprops );
428 Debug( LDAP_DEBUG_TRACE, "ldap_int_sasl_open: ssf=%ld\n",
435 int ldap_int_sasl_close( LDAP *ld, LDAPConn *lc )
437 sasl_conn_t *ctx = lc->lconn_sasl_ctx;
438 assert( ctx != NULL );
441 sasl_dispose( &ctx );
442 lc->lconn_sasl_ctx = NULL;
453 LDAPControl **sctrls,
454 LDAPControl **cctrls,
456 LDAP_SASL_INTERACT_PROC *interact,
460 const char *mech = NULL;
461 const char *pmech = NULL;
463 sasl_ssf_t *ssf = NULL;
465 sasl_interact_t *prompts = NULL;
470 Debug( LDAP_DEBUG_TRACE, "ldap_int_sasl_bind: %s\n",
471 mechs ? mechs : "<null>", 0, 0 );
473 /* do a quick !LDAPv3 check... ldap_sasl_bind will do the rest. */
474 if (ld->ld_version < LDAP_VERSION3) {
475 ld->ld_errno = LDAP_NOT_SUPPORTED;
479 ber_sockbuf_ctrl( ld->ld_sb, LBER_SB_OPT_GET_FD, &sd );
481 if ( sd == AC_SOCKET_INVALID ) {
482 /* not connected yet */
483 int rc = ldap_open_defconn( ld );
485 if( rc < 0 ) return ld->ld_errno;
486 ber_sockbuf_ctrl( ld->ld_sb, LBER_SB_OPT_GET_FD, &sd );
488 if( sd == AC_SOCKET_INVALID ) {
489 ld->ld_errno = LDAP_UNAVAILABLE;
494 ctx = ld->ld_defconn->lconn_sasl_ctx;
497 ld->ld_errno = LDAP_UNAVAILABLE;
501 /* (re)set security properties */
502 sasl_setprop( ctx, SASL_SEC_PROPS,
503 &ld->ld_options.ldo_sasl_secprops );
509 saslrc = sasl_client_start( ctx,
517 if( pmech == NULL && mech != NULL ) {
520 if( flags != LDAP_SASL_QUIET ) {
522 "SASL/%s authentication started\n",
527 if( saslrc == SASL_INTERACT ) {
529 if( !interact ) break;
530 res = (interact)( ld, flags, defaults, prompts );
531 if( res != LDAP_SUCCESS ) {
535 } while ( saslrc == SASL_INTERACT );
537 ccred.bv_len = credlen;
539 if ( (saslrc != SASL_OK) && (saslrc != SASL_CONTINUE) ) {
540 ld->ld_errno = sasl_err2ldap( saslrc );
545 struct berval *scred;
550 rc = ldap_sasl_bind_s( ld, dn, mech, &ccred, sctrls, cctrls, &scred );
552 if ( ccred.bv_val != NULL ) {
553 LDAP_FREE( ccred.bv_val );
557 if ( rc != LDAP_SUCCESS && rc != LDAP_SASL_BIND_IN_PROGRESS ) {
561 if( rc == LDAP_SUCCESS && saslrc == SASL_OK ) {
562 /* we're done, no need to step */
564 /* but server provided us with data! */
565 Debug( LDAP_DEBUG_TRACE,
566 "ldap_int_sasl_bind: rc=%d sasl=%d len=%ld\n",
567 rc, saslrc, scred->bv_len );
569 return ld->ld_errno = LDAP_LOCAL_ERROR;
575 saslrc = sasl_client_step( ctx,
576 (scred == NULL) ? NULL : scred->bv_val,
577 (scred == NULL) ? 0 : scred->bv_len,
582 Debug( LDAP_DEBUG_TRACE, "sasl_client_start: %d\n",
585 if( saslrc == SASL_INTERACT ) {
587 if( !interact ) break;
588 res = (interact)( ld, flags, defaults, prompts );
589 if( res != LDAP_SUCCESS ) {
593 } while ( saslrc == SASL_INTERACT );
595 ccred.bv_len = credlen;
598 if ( (saslrc != SASL_OK) && (saslrc != SASL_CONTINUE) ) {
599 ld->ld_errno = sasl_err2ldap( saslrc );
602 } while ( rc == LDAP_SASL_BIND_IN_PROGRESS );
604 if ( rc != LDAP_SUCCESS ) {
608 if ( saslrc != SASL_OK ) {
609 return ld->ld_errno = sasl_err2ldap( saslrc );
612 /* likely should add a quiet option */
614 if( flags != LDAP_SASL_QUIET ) {
615 saslrc = sasl_getprop( ctx, SASL_USERNAME, (void **) &data );
616 if( saslrc == SASL_OK && data && *data ) {
617 fprintf( stderr, "SASL username: %s\n", data );
620 saslrc = sasl_getprop( ctx, SASL_REALM, (void **) &data );
621 if( saslrc == SASL_OK && data && *data ) {
622 fprintf( stderr, "SASL realm: %s\n", data );
626 saslrc = sasl_getprop( ctx, SASL_SSF, (void **) &ssf );
627 if( saslrc == SASL_OK ) {
628 if( flags != LDAP_SASL_QUIET ) {
629 fprintf( stderr, "SASL SSF: %lu\n",
630 (unsigned long) *ssf );
634 if( flags != LDAP_SASL_QUIET ) {
635 fprintf( stderr, "SASL installing layers\n" );
637 ldap_pvt_sasl_install( ld->ld_sb, ctx );
644 int ldap_pvt_sasl_secprops(
646 sasl_security_properties_t *secprops )
649 char **props = ldap_str2charray( in, "," );
657 int got_maxbufsize = 0;
659 if( props == NULL || secprops == NULL ) {
660 return LDAP_PARAM_ERROR;
663 for( i=0; props[i]; i++ ) {
664 if( !strcasecmp(props[i], "none") ) {
667 } else if( !strcasecmp(props[i], "noplain") ) {
669 sflags |= SASL_SEC_NOPLAINTEXT;
671 } else if( !strcasecmp(props[i], "noactive") ) {
673 sflags |= SASL_SEC_NOACTIVE;
675 } else if( !strcasecmp(props[i], "nodict") ) {
677 sflags |= SASL_SEC_NODICTIONARY;
679 } else if( !strcasecmp(props[i], "forwardsec") ) {
681 sflags |= SASL_SEC_FORWARD_SECRECY;
683 } else if( !strcasecmp(props[i], "noanonymous")) {
685 sflags |= SASL_SEC_NOANONYMOUS;
687 } else if( !strcasecmp(props[i], "passcred") ) {
689 sflags |= SASL_SEC_PASS_CREDENTIALS;
691 } else if( !strncasecmp(props[i],
692 "minssf=", sizeof("minssf")) )
694 if( isdigit( props[i][sizeof("minssf")] ) ) {
696 min_ssf = atoi( &props[i][sizeof("minssf")] );
698 return LDAP_NOT_SUPPORTED;
701 } else if( !strncasecmp(props[i],
702 "maxssf=", sizeof("maxssf")) )
704 if( isdigit( props[i][sizeof("maxssf")] ) ) {
706 max_ssf = atoi( &props[i][sizeof("maxssf")] );
708 return LDAP_NOT_SUPPORTED;
711 } else if( !strncasecmp(props[i],
712 "maxbufsize=", sizeof("maxbufsize")) )
714 if( isdigit( props[i][sizeof("maxbufsize")] ) ) {
716 maxbufsize = atoi( &props[i][sizeof("maxbufsize")] );
718 return LDAP_NOT_SUPPORTED;
722 return LDAP_NOT_SUPPORTED;
727 secprops->security_flags = sflags;
730 secprops->min_ssf = min_ssf;
733 secprops->max_ssf = max_ssf;
736 secprops->maxbufsize = maxbufsize;
739 ldap_charray_free( props );
744 ldap_int_sasl_config( struct ldapoptions *lo, int option, const char *arg )
749 case LDAP_OPT_X_SASL_SECPROPS:
750 rc = ldap_pvt_sasl_secprops( arg, &lo->ldo_sasl_secprops );
751 if( rc == LDAP_SUCCESS ) return 0;
758 ldap_int_sasl_get_option( LDAP *ld, int option, void *arg )
764 case LDAP_OPT_X_SASL_MECH: {
765 *(char **)arg = ld->ld_options.ldo_def_sasl_mech
766 ? LDAP_STRDUP( ld->ld_options.ldo_def_sasl_mech ) : NULL;
768 case LDAP_OPT_X_SASL_REALM: {
769 *(char **)arg = ld->ld_options.ldo_def_sasl_realm
770 ? LDAP_STRDUP( ld->ld_options.ldo_def_sasl_realm ) : NULL;
772 case LDAP_OPT_X_SASL_AUTHCID: {
773 *(char **)arg = ld->ld_options.ldo_def_sasl_authcid
774 ? LDAP_STRDUP( ld->ld_options.ldo_def_sasl_authcid ) : NULL;
776 case LDAP_OPT_X_SASL_AUTHZID: {
777 *(char **)arg = ld->ld_options.ldo_def_sasl_authzid
778 ? LDAP_STRDUP( ld->ld_options.ldo_def_sasl_authzid ) : NULL;
781 case LDAP_OPT_X_SASL_SSF: {
786 if( ld->ld_defconn == NULL ) {
790 ctx = ld->ld_defconn->lconn_sasl_ctx;
796 sc = sasl_getprop( ctx, SASL_SSF,
799 if ( sc != SASL_OK ) {
803 *(ber_len_t *)arg = *ssf;
806 case LDAP_OPT_X_SASL_SSF_EXTERNAL:
807 /* this option is write only */
810 case LDAP_OPT_X_SASL_SSF_MIN:
811 *(ber_len_t *)arg = ld->ld_options.ldo_sasl_secprops.min_ssf;
813 case LDAP_OPT_X_SASL_SSF_MAX:
814 *(ber_len_t *)arg = ld->ld_options.ldo_sasl_secprops.max_ssf;
816 case LDAP_OPT_X_SASL_MAXBUFSIZE:
817 *(ber_len_t *)arg = ld->ld_options.ldo_sasl_secprops.maxbufsize;
820 case LDAP_OPT_X_SASL_SECPROPS:
821 /* this option is write only */
831 ldap_int_sasl_set_option( LDAP *ld, int option, void *arg )
837 case LDAP_OPT_X_SASL_SSF:
838 /* This option is read-only */
841 case LDAP_OPT_X_SASL_SSF_EXTERNAL: {
843 sasl_external_properties_t extprops;
846 if( ld->ld_defconn == NULL ) {
850 ctx = ld->ld_defconn->lconn_sasl_ctx;
856 memset(&extprops, 0L, sizeof(extprops));
858 extprops.ssf = * (ber_len_t *) arg;
860 sc = sasl_setprop( ctx, SASL_SSF_EXTERNAL,
861 (void *) &extprops );
863 if ( sc != SASL_OK ) {
868 case LDAP_OPT_X_SASL_SSF_MIN:
869 ld->ld_options.ldo_sasl_secprops.min_ssf = *(ber_len_t *)arg;
871 case LDAP_OPT_X_SASL_SSF_MAX:
872 ld->ld_options.ldo_sasl_secprops.max_ssf = *(ber_len_t *)arg;
874 case LDAP_OPT_X_SASL_MAXBUFSIZE:
875 ld->ld_options.ldo_sasl_secprops.maxbufsize = *(ber_len_t *)arg;
878 case LDAP_OPT_X_SASL_SECPROPS: {
880 sc = ldap_pvt_sasl_secprops( (char *) arg,
881 &ld->ld_options.ldo_sasl_secprops );
883 return sc == LDAP_SUCCESS ? 0 : -1;
892 #ifdef LDAP_R_COMPILE
893 void *ldap_pvt_sasl_mutex_new(void)
895 ldap_pvt_thread_mutex_t *mutex;
897 mutex = (ldap_pvt_thread_mutex_t *) LDAP_MALLOC(
898 sizeof(ldap_pvt_thread_mutex_t) );
900 if ( ldap_pvt_thread_mutex_init( mutex ) == 0 ) {
906 int ldap_pvt_sasl_mutex_lock(void *mutex)
908 return ldap_pvt_thread_mutex_lock( (ldap_pvt_thread_mutex_t *)mutex )
909 ? SASL_FAIL : SASL_OK;
912 int ldap_pvt_sasl_mutex_unlock(void *mutex)
914 return ldap_pvt_thread_mutex_unlock( (ldap_pvt_thread_mutex_t *)mutex )
915 ? SASL_FAIL : SASL_OK;
918 void ldap_pvt_sasl_mutex_dispose(void *mutex)
920 (void) ldap_pvt_thread_mutex_destroy( (ldap_pvt_thread_mutex_t *)mutex );
926 int ldap_int_sasl_init( void )
927 { return LDAP_SUCCESS; }
929 int ldap_int_sasl_close( LDAP *ld, LDAPConn *lc )
930 { return LDAP_SUCCESS; }
937 LDAPControl **sctrls,
938 LDAPControl **cctrls,
940 LDAP_SASL_INTERACT_PROC *interact,
942 { return LDAP_NOT_SUPPORTED; }
943 #endif /* HAVE_CYRUS_SASL */