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;
347 rc = LDAP_LOCAL_ERROR;
353 rc = LDAP_AUTH_UNKNOWN;
356 rc = LDAP_AUTH_UNKNOWN;
359 rc = LDAP_PARAM_ERROR;
363 rc = LDAP_AUTH_UNKNOWN;
366 rc = LDAP_LOCAL_ERROR;
370 assert( rc == LDAP_SUCCESS || LDAP_API_ERROR( rc ) );
384 sasl_callback_t *session_callbacks =
385 ber_memcalloc( 2, sizeof( sasl_callback_t ) );
387 if( session_callbacks == NULL ) return LDAP_NO_MEMORY;
389 session_callbacks[0].id = SASL_CB_USER;
390 session_callbacks[0].proc = NULL;
391 session_callbacks[0].context = ld;
393 session_callbacks[1].id = SASL_CB_LIST_END;
394 session_callbacks[1].proc = NULL;
395 session_callbacks[1].context = NULL;
397 assert( lc->lconn_sasl_ctx == NULL );
399 if ( host == NULL ) {
400 ld->ld_errno = LDAP_UNAVAILABLE;
404 rc = sasl_client_new( "ldap", host,
406 #ifdef LDAP_SASL_SECURITY_LAYER
413 if ( rc != SASL_OK ) {
414 ld->ld_errno = sasl_err2ldap( rc );
418 Debug( LDAP_DEBUG_TRACE, "ldap_int_sasl_open: %s\n",
421 lc->lconn_sasl_ctx = ctx;
424 sasl_external_properties_t extprops;
425 memset(&extprops, 0L, sizeof(extprops));
428 (void) sasl_setprop( ctx, SASL_SSF_EXTERNAL,
429 (void *) &extprops );
431 Debug( LDAP_DEBUG_TRACE, "ldap_int_sasl_open: ssf=%ld\n",
438 int ldap_int_sasl_close( LDAP *ld, LDAPConn *lc )
440 sasl_conn_t *ctx = lc->lconn_sasl_ctx;
441 assert( ctx != NULL );
444 sasl_dispose( &ctx );
445 lc->lconn_sasl_ctx = NULL;
456 LDAPControl **sctrls,
457 LDAPControl **cctrls,
459 LDAP_SASL_INTERACT_PROC *interact,
463 const char *mech = NULL;
464 const char *pmech = NULL;
466 sasl_ssf_t *ssf = NULL;
468 sasl_interact_t *prompts = NULL;
470 struct berval ccred, *scred;
473 Debug( LDAP_DEBUG_TRACE, "ldap_int_sasl_bind: %s\n",
474 mechs ? mechs : "<null>", 0, 0 );
476 /* do a quick !LDAPv3 check... ldap_sasl_bind will do the rest. */
477 if (ld->ld_version < LDAP_VERSION3) {
478 ld->ld_errno = LDAP_NOT_SUPPORTED;
482 ber_sockbuf_ctrl( ld->ld_sb, LBER_SB_OPT_GET_FD, &sd );
484 if ( sd == AC_SOCKET_INVALID ) {
485 /* not connected yet */
486 int rc = ldap_open_defconn( ld );
488 if( rc < 0 ) return ld->ld_errno;
489 ber_sockbuf_ctrl( ld->ld_sb, LBER_SB_OPT_GET_FD, &sd );
491 if( sd == AC_SOCKET_INVALID ) {
492 ld->ld_errno = LDAP_UNAVAILABLE;
497 ctx = ld->ld_defconn->lconn_sasl_ctx;
500 ld->ld_errno = LDAP_UNAVAILABLE;
504 /* (re)set security properties */
505 sasl_setprop( ctx, SASL_SEC_PROPS,
506 &ld->ld_options.ldo_sasl_secprops );
512 saslrc = sasl_client_start( ctx,
520 if( pmech == NULL && mech != NULL ) {
523 if( flags != LDAP_SASL_QUIET ) {
525 "SASL/%s authentication started\n",
530 if( saslrc == SASL_INTERACT ) {
531 if( !interact ) break;
532 rc = (interact)( ld, flags, defaults, prompts );
533 if( rc != LDAP_SUCCESS ) {
537 } while ( saslrc == SASL_INTERACT );
539 ccred.bv_len = credlen;
541 if ( (saslrc != SASL_OK) && (saslrc != SASL_CONTINUE) ) {
542 ld->ld_errno = sasl_err2ldap( saslrc );
551 rc = ldap_sasl_bind_s( ld, dn, mech, &ccred, sctrls, cctrls, &scred );
553 if ( rc == LDAP_SUCCESS ) {
555 } else if ( rc != LDAP_SASL_BIND_IN_PROGRESS ) {
556 if ( ccred.bv_val != NULL ) {
557 LDAP_FREE( ccred.bv_val );
562 if ( ccred.bv_val != NULL ) {
563 LDAP_FREE( ccred.bv_val );
568 saslrc = sasl_client_step( ctx,
569 (scred == NULL) ? NULL : scred->bv_val,
570 (scred == NULL) ? 0 : scred->bv_len,
575 Debug( LDAP_DEBUG_TRACE, "sasl_client_start: %d\n",
578 if( saslrc == SASL_INTERACT ) {
580 if( !interact ) break;
581 rc = (interact)( ld, flags, defaults, prompts );
582 if( res != LDAP_SUCCESS ) {
586 } while ( saslrc == SASL_INTERACT );
588 ccred.bv_len = credlen;
591 if ( (saslrc != SASL_OK) && (saslrc != SASL_CONTINUE) ) {
592 ld->ld_errno = sasl_err2ldap( saslrc );
595 } while ( rc == LDAP_SASL_BIND_IN_PROGRESS );
597 assert ( rc == LDAP_SUCCESS );
599 /* likely should add a quiet option */
601 if( flags != LDAP_SASL_QUIET ) {
602 saslrc = sasl_getprop( ctx, SASL_USERNAME, (void **) &data );
603 if( saslrc == SASL_OK ) {
604 fprintf( stderr, "SASL username: %s\n", data );
607 saslrc = sasl_getprop( ctx, SASL_REALM, (void **) &data );
608 if( saslrc == SASL_OK ) {
609 fprintf( stderr, "SASL realm: %s\n", data );
613 saslrc = sasl_getprop( ctx, SASL_SSF, (void **) &ssf );
614 if( saslrc == SASL_OK ) {
615 if( flags != LDAP_SASL_QUIET ) {
616 fprintf( stderr, "SASL SSF: %lu\n",
617 (unsigned long) *ssf );
620 #ifdef LDAP_SASL_SECURITY_LAYER
622 if( flags != LDAP_SASL_QUIET ) {
623 fprintf( stderr, "SASL installing layers\n" );
625 ldap_pvt_sasl_install( ld->ld_sb, ctx );
633 int ldap_pvt_sasl_secprops(
635 sasl_security_properties_t *secprops )
638 char **props = ldap_str2charray( in, "," );
646 int got_maxbufsize = 0;
648 if( props == NULL || secprops == NULL ) {
649 return LDAP_PARAM_ERROR;
652 for( i=0; props[i]; i++ ) {
653 if( !strcasecmp(props[i], "none") ) {
656 } else if( !strcasecmp(props[i], "noplain") ) {
658 sflags |= SASL_SEC_NOPLAINTEXT;
660 } else if( !strcasecmp(props[i], "noactive") ) {
662 sflags |= SASL_SEC_NOACTIVE;
664 } else if( !strcasecmp(props[i], "nodict") ) {
666 sflags |= SASL_SEC_NODICTIONARY;
668 } else if( !strcasecmp(props[i], "forwardsec") ) {
670 sflags |= SASL_SEC_FORWARD_SECRECY;
672 } else if( !strcasecmp(props[i], "noanonymous")) {
674 sflags |= SASL_SEC_NOANONYMOUS;
676 } else if( !strcasecmp(props[i], "passcred") ) {
678 sflags |= SASL_SEC_PASS_CREDENTIALS;
680 } else if( !strncasecmp(props[i],
681 "minssf=", sizeof("minssf")) )
683 if( isdigit( props[i][sizeof("minssf")] ) ) {
685 min_ssf = atoi( &props[i][sizeof("minssf")] );
687 return LDAP_NOT_SUPPORTED;
690 } else if( !strncasecmp(props[i],
691 "maxssf=", sizeof("maxssf")) )
693 if( isdigit( props[i][sizeof("maxssf")] ) ) {
695 max_ssf = atoi( &props[i][sizeof("maxssf")] );
697 return LDAP_NOT_SUPPORTED;
700 } else if( !strncasecmp(props[i],
701 "maxbufsize=", sizeof("maxbufsize")) )
703 if( isdigit( props[i][sizeof("maxbufsize")] ) ) {
705 maxbufsize = atoi( &props[i][sizeof("maxbufsize")] );
707 return LDAP_NOT_SUPPORTED;
711 return LDAP_NOT_SUPPORTED;
716 secprops->security_flags = sflags;
719 secprops->min_ssf = min_ssf;
722 secprops->max_ssf = max_ssf;
725 secprops->maxbufsize = maxbufsize;
728 ldap_charray_free( props );
733 ldap_int_sasl_config( struct ldapoptions *lo, int option, const char *arg )
738 case LDAP_OPT_X_SASL_SECPROPS:
739 rc = ldap_pvt_sasl_secprops( arg, &lo->ldo_sasl_secprops );
740 if( rc == LDAP_SUCCESS ) return 0;
747 ldap_int_sasl_get_option( LDAP *ld, int option, void *arg )
753 case LDAP_OPT_X_SASL_MECH: {
754 *(char **)arg = ld->ld_options.ldo_def_sasl_mech
755 ? LDAP_STRDUP( ld->ld_options.ldo_def_sasl_mech ) : NULL;
757 case LDAP_OPT_X_SASL_REALM: {
758 *(char **)arg = ld->ld_options.ldo_def_sasl_realm
759 ? LDAP_STRDUP( ld->ld_options.ldo_def_sasl_realm ) : NULL;
761 case LDAP_OPT_X_SASL_AUTHCID: {
762 *(char **)arg = ld->ld_options.ldo_def_sasl_authcid
763 ? LDAP_STRDUP( ld->ld_options.ldo_def_sasl_authcid ) : NULL;
765 case LDAP_OPT_X_SASL_AUTHZID: {
766 *(char **)arg = ld->ld_options.ldo_def_sasl_authzid
767 ? LDAP_STRDUP( ld->ld_options.ldo_def_sasl_authzid ) : NULL;
770 case LDAP_OPT_X_SASL_SSF: {
775 if( ld->ld_defconn == NULL ) {
779 ctx = ld->ld_defconn->lconn_sasl_ctx;
785 sc = sasl_getprop( ctx, SASL_SSF,
788 if ( sc != SASL_OK ) {
792 *(ber_len_t *)arg = *ssf;
795 case LDAP_OPT_X_SASL_SSF_EXTERNAL:
796 /* this option is write only */
799 case LDAP_OPT_X_SASL_SSF_MIN:
800 *(ber_len_t *)arg = ld->ld_options.ldo_sasl_secprops.min_ssf;
802 case LDAP_OPT_X_SASL_SSF_MAX:
803 *(ber_len_t *)arg = ld->ld_options.ldo_sasl_secprops.max_ssf;
805 case LDAP_OPT_X_SASL_MAXBUFSIZE:
806 *(ber_len_t *)arg = ld->ld_options.ldo_sasl_secprops.maxbufsize;
809 case LDAP_OPT_X_SASL_SECPROPS:
810 /* this option is write only */
820 ldap_int_sasl_set_option( LDAP *ld, int option, void *arg )
826 case LDAP_OPT_X_SASL_SSF:
827 /* This option is read-only */
830 case LDAP_OPT_X_SASL_SSF_EXTERNAL: {
832 sasl_external_properties_t extprops;
835 if( ld->ld_defconn == NULL ) {
839 ctx = ld->ld_defconn->lconn_sasl_ctx;
845 memset(&extprops, 0L, sizeof(extprops));
847 extprops.ssf = * (ber_len_t *) arg;
849 sc = sasl_setprop( ctx, SASL_SSF_EXTERNAL,
850 (void *) &extprops );
852 if ( sc != SASL_OK ) {
857 case LDAP_OPT_X_SASL_SSF_MIN:
858 ld->ld_options.ldo_sasl_secprops.min_ssf = *(ber_len_t *)arg;
860 case LDAP_OPT_X_SASL_SSF_MAX:
861 ld->ld_options.ldo_sasl_secprops.max_ssf = *(ber_len_t *)arg;
863 case LDAP_OPT_X_SASL_MAXBUFSIZE:
864 ld->ld_options.ldo_sasl_secprops.maxbufsize = *(ber_len_t *)arg;
867 case LDAP_OPT_X_SASL_SECPROPS: {
869 sc = ldap_pvt_sasl_secprops( (char *) arg,
870 &ld->ld_options.ldo_sasl_secprops );
872 return sc == LDAP_SUCCESS ? 0 : -1;
881 #ifdef LDAP_R_COMPILE
882 void *ldap_pvt_sasl_mutex_new(void)
884 ldap_pvt_thread_mutex_t *mutex;
886 mutex = (ldap_pvt_thread_mutex_t *) LDAP_MALLOC(
887 sizeof(ldap_pvt_thread_mutex_t) );
889 if ( ldap_pvt_thread_mutex_init( mutex ) == 0 ) {
895 int ldap_pvt_sasl_mutex_lock(void *mutex)
897 return ldap_pvt_thread_mutex_lock( (ldap_pvt_thread_mutex_t *)mutex )
898 ? SASL_FAIL : SASL_OK;
901 int ldap_pvt_sasl_mutex_unlock(void *mutex)
903 return ldap_pvt_thread_mutex_unlock( (ldap_pvt_thread_mutex_t *)mutex )
904 ? SASL_FAIL : SASL_OK;
907 void ldap_pvt_sasl_mutex_dispose(void *mutex)
909 (void) ldap_pvt_thread_mutex_destroy( (ldap_pvt_thread_mutex_t *)mutex );
915 int ldap_int_sasl_init( void )
916 { return LDAP_SUCCESS; }
918 int ldap_int_sasl_close( LDAP *ld, LDAPConn *lc )
919 { return LDAP_SUCCESS; }
926 LDAPControl **sctrls,
927 LDAPControl **cctrls )
928 { return LDAP_NOT_SUPPORTED; }
929 #endif /* HAVE_CYRUS_SASL */