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 )
218 p->sec_buf_in.buf_end = ret;
220 /* Did we read the whole encrypted packet? */
221 while ( p->sec_buf_in.buf_ptr < p->sec_buf_in.buf_end ) {
222 /* No, we have got only a part of it */
223 ret = p->sec_buf_in.buf_end - p->sec_buf_in.buf_ptr;
225 ret = LBER_SBIOD_READ_NEXT( sbiod, p->sec_buf_in.buf_base +
226 p->sec_buf_in.buf_ptr, ret );
228 if ( ( ret < 0 ) && ( errno == EINTR ) )
234 p->sec_buf_in.buf_ptr += ret;
237 /* Decode the packet */
238 ret = sasl_decode( p->sasl_context, p->sec_buf_in.buf_base,
239 p->sec_buf_in.buf_end, &p->buf_in.buf_base,
240 (unsigned *)&p->buf_in.buf_end );
241 if ( ret != SASL_OK ) {
242 ber_log_printf( LDAP_DEBUG_ANY, sbiod->sbiod_sb->sb_debug,
243 "sb_sasl_read: failed to decode packet: %s\n",
244 sasl_errstring( ret, NULL, NULL ) );
245 sb_sasl_drop_packet( &p->sec_buf_in,
246 sbiod->sbiod_sb->sb_debug );
251 /* Drop the packet from the input buffer */
252 sb_sasl_drop_packet( &p->sec_buf_in, sbiod->sbiod_sb->sb_debug );
254 p->buf_in.buf_size = p->buf_in.buf_end;
256 bufptr += ber_pvt_sb_copy_out( &p->buf_in, (char*) buf + bufptr, len );
262 sb_sasl_write( Sockbuf_IO_Desc *sbiod, void *buf, ber_len_t len)
264 struct sb_sasl_data *p;
267 assert( sbiod != NULL );
268 assert( SOCKBUF_VALID( sbiod->sbiod_sb ) );
270 p = (struct sb_sasl_data *)sbiod->sbiod_pvt;
272 /* Are there anything left in the buffer? */
273 if ( p->buf_out.buf_ptr != p->buf_out.buf_end ) {
274 ret = ber_pvt_sb_do_write( sbiod, &p->buf_out );
279 /* now encode the next packet. */
280 ber_pvt_sb_buf_destroy( &p->buf_out );
281 ret = sasl_encode( p->sasl_context, buf, len, &p->buf_out.buf_base,
282 (unsigned *)&p->buf_out.buf_size );
283 if ( ret != SASL_OK ) {
284 ber_log_printf( LDAP_DEBUG_ANY, sbiod->sbiod_sb->sb_debug,
285 "sb_sasl_write: failed to encode packet: %s\n",
286 sasl_errstring( ret, NULL, NULL ) );
289 p->buf_out.buf_end = p->buf_out.buf_size;
291 ret = ber_pvt_sb_do_write( sbiod, &p->buf_out );
298 sb_sasl_ctrl( Sockbuf_IO_Desc *sbiod, int opt, void *arg )
300 struct sb_sasl_data *p;
302 p = (struct sb_sasl_data *)sbiod->sbiod_pvt;
304 if ( opt == LBER_SB_OPT_DATA_READY ) {
305 if ( p->buf_in.buf_ptr != p->buf_in.buf_end )
309 return LBER_SBIOD_CTRL_NEXT( sbiod, opt, arg );
312 Sockbuf_IO ldap_pvt_sockbuf_io_sasl = {
313 sb_sasl_setup, /* sbi_setup */
314 sb_sasl_remove, /* sbi_remove */
315 sb_sasl_ctrl, /* sbi_ctrl */
316 sb_sasl_read, /* sbi_read */
317 sb_sasl_write, /* sbi_write */
321 int ldap_pvt_sasl_install( Sockbuf *sb, void *ctx_arg )
323 Debug( LDAP_DEBUG_TRACE, "ldap_pvt_sasl_install\n",
326 /* don't install the stuff unless security has been negotiated */
328 if ( !ber_sockbuf_ctrl( sb, LBER_SB_OPT_HAS_IO,
329 &ldap_pvt_sockbuf_io_sasl ) )
331 ber_sockbuf_add_io( sb, &ldap_pvt_sockbuf_io_sasl,
332 LBER_SBIOD_LEVEL_APPLICATION, ctx_arg );
339 sasl_err2ldap( int saslerr )
345 rc = LDAP_MORE_RESULTS_TO_RETURN;
348 rc = LDAP_LOCAL_ERROR;
354 rc = LDAP_LOCAL_ERROR;
360 rc = LDAP_AUTH_UNKNOWN;
363 rc = LDAP_AUTH_UNKNOWN;
366 rc = LDAP_PARAM_ERROR;
370 rc = LDAP_AUTH_UNKNOWN;
373 rc = LDAP_LOCAL_ERROR;
377 assert( rc == LDAP_SUCCESS || LDAP_API_ERROR( rc ) );
391 sasl_callback_t *session_callbacks =
392 ber_memcalloc( 2, sizeof( sasl_callback_t ) );
394 if( session_callbacks == NULL ) return LDAP_NO_MEMORY;
396 session_callbacks[0].id = SASL_CB_USER;
397 session_callbacks[0].proc = NULL;
398 session_callbacks[0].context = ld;
400 session_callbacks[1].id = SASL_CB_LIST_END;
401 session_callbacks[1].proc = NULL;
402 session_callbacks[1].context = NULL;
404 assert( lc->lconn_sasl_ctx == NULL );
406 if ( host == NULL ) {
407 ld->ld_errno = LDAP_UNAVAILABLE;
411 rc = sasl_client_new( "ldap", host, session_callbacks,
412 SASL_SECURITY_LAYER, &ctx );
414 if ( rc != SASL_OK ) {
415 ld->ld_errno = sasl_err2ldap( rc );
419 Debug( LDAP_DEBUG_TRACE, "ldap_int_sasl_open: %s\n",
422 lc->lconn_sasl_ctx = ctx;
425 sasl_external_properties_t extprops;
426 memset(&extprops, 0L, sizeof(extprops));
429 (void) sasl_setprop( ctx, SASL_SSF_EXTERNAL,
430 (void *) &extprops );
432 Debug( LDAP_DEBUG_TRACE, "ldap_int_sasl_open: ssf=%ld\n",
439 int ldap_int_sasl_close( LDAP *ld, LDAPConn *lc )
441 sasl_conn_t *ctx = lc->lconn_sasl_ctx;
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;
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 ) {
532 if( !interact ) break;
533 res = (interact)( ld, flags, defaults, prompts );
534 if( res != LDAP_SUCCESS ) {
538 } while ( saslrc == SASL_INTERACT );
540 ccred.bv_len = credlen;
542 if ( (saslrc != SASL_OK) && (saslrc != SASL_CONTINUE) ) {
543 ld->ld_errno = sasl_err2ldap( saslrc );
548 struct berval *scred;
553 rc = ldap_sasl_bind_s( ld, dn, mech, &ccred, sctrls, cctrls, &scred );
555 if ( ccred.bv_val != NULL ) {
556 LDAP_FREE( ccred.bv_val );
560 if ( rc != LDAP_SUCCESS && rc != LDAP_SASL_BIND_IN_PROGRESS ) {
562 /* and server provided us with data? */
563 Debug( LDAP_DEBUG_TRACE,
564 "ldap_int_sasl_bind: rc=%d sasl=%d len=%ld\n",
565 rc, saslrc, scred->bv_len );
571 if( rc == LDAP_SUCCESS && saslrc == SASL_OK ) {
572 /* we're done, no need to step */
574 /* but server provided us with data! */
575 Debug( LDAP_DEBUG_TRACE,
576 "ldap_int_sasl_bind: rc=%d sasl=%d len=%ld\n",
577 rc, saslrc, scred->bv_len );
579 return ld->ld_errno = LDAP_LOCAL_ERROR;
585 saslrc = sasl_client_step( ctx,
586 (scred == NULL) ? NULL : scred->bv_val,
587 (scred == NULL) ? 0 : scred->bv_len,
592 Debug( LDAP_DEBUG_TRACE, "sasl_client_start: %d\n",
595 if( saslrc == SASL_INTERACT ) {
597 if( !interact ) break;
598 res = (interact)( ld, flags, defaults, prompts );
599 if( res != LDAP_SUCCESS ) {
603 } while ( saslrc == SASL_INTERACT );
605 ccred.bv_len = credlen;
608 if ( (saslrc != SASL_OK) && (saslrc != SASL_CONTINUE) ) {
609 ld->ld_errno = sasl_err2ldap( saslrc );
612 } while ( rc == LDAP_SASL_BIND_IN_PROGRESS );
614 if ( rc != LDAP_SUCCESS ) {
618 if ( saslrc != SASL_OK ) {
619 return ld->ld_errno = sasl_err2ldap( saslrc );
622 if( flags != LDAP_SASL_QUIET ) {
623 saslrc = sasl_getprop( ctx, SASL_USERNAME, (void **) &data );
624 if( saslrc == SASL_OK && data && *data ) {
625 fprintf( stderr, "SASL username: %s\n", data );
628 saslrc = sasl_getprop( ctx, SASL_REALM, (void **) &data );
629 if( saslrc == SASL_OK && data && *data ) {
630 fprintf( stderr, "SASL realm: %s\n", data );
634 saslrc = sasl_getprop( ctx, SASL_SSF, (void **) &ssf );
635 if( saslrc == SASL_OK ) {
636 if( flags != LDAP_SASL_QUIET ) {
637 fprintf( stderr, "SASL SSF: %lu\n",
638 (unsigned long) *ssf );
642 if( flags != LDAP_SASL_QUIET ) {
643 fprintf( stderr, "SASL installing layers\n" );
645 ldap_pvt_sasl_install( ld->ld_sb, ctx );
652 int ldap_pvt_sasl_secprops(
654 sasl_security_properties_t *secprops )
657 char **props = ldap_str2charray( in, "," );
660 sasl_ssf_t max_ssf = 0;
662 sasl_ssf_t min_ssf = 0;
664 unsigned maxbufsize = 0;
665 int got_maxbufsize = 0;
667 if( props == NULL || secprops == NULL ) {
668 return LDAP_PARAM_ERROR;
671 for( i=0; props[i]; i++ ) {
672 if( !strcasecmp(props[i], "none") ) {
675 } else if( !strcasecmp(props[i], "noplain") ) {
677 sflags |= SASL_SEC_NOPLAINTEXT;
679 } else if( !strcasecmp(props[i], "noactive") ) {
681 sflags |= SASL_SEC_NOACTIVE;
683 } else if( !strcasecmp(props[i], "nodict") ) {
685 sflags |= SASL_SEC_NODICTIONARY;
687 } else if( !strcasecmp(props[i], "forwardsec") ) {
689 sflags |= SASL_SEC_FORWARD_SECRECY;
691 } else if( !strcasecmp(props[i], "noanonymous")) {
693 sflags |= SASL_SEC_NOANONYMOUS;
695 } else if( !strcasecmp(props[i], "passcred") ) {
697 sflags |= SASL_SEC_PASS_CREDENTIALS;
699 } else if( !strncasecmp(props[i],
700 "minssf=", sizeof("minssf")) )
702 if( isdigit( props[i][sizeof("minssf")] ) ) {
704 min_ssf = atoi( &props[i][sizeof("minssf")] );
706 return LDAP_NOT_SUPPORTED;
709 } else if( !strncasecmp(props[i],
710 "maxssf=", sizeof("maxssf")) )
712 if( isdigit( props[i][sizeof("maxssf")] ) ) {
714 max_ssf = atoi( &props[i][sizeof("maxssf")] );
716 return LDAP_NOT_SUPPORTED;
719 } else if( !strncasecmp(props[i],
720 "maxbufsize=", sizeof("maxbufsize")) )
722 if( isdigit( props[i][sizeof("maxbufsize")] ) ) {
724 maxbufsize = atoi( &props[i][sizeof("maxbufsize")] );
726 return LDAP_NOT_SUPPORTED;
730 return LDAP_NOT_SUPPORTED;
735 secprops->security_flags = sflags;
738 secprops->min_ssf = min_ssf;
741 secprops->max_ssf = max_ssf;
744 secprops->maxbufsize = maxbufsize;
747 ldap_charray_free( props );
752 ldap_int_sasl_config( struct ldapoptions *lo, int option, const char *arg )
757 case LDAP_OPT_X_SASL_SECPROPS:
758 rc = ldap_pvt_sasl_secprops( arg, &lo->ldo_sasl_secprops );
759 if( rc == LDAP_SUCCESS ) return 0;
766 ldap_int_sasl_get_option( LDAP *ld, int option, void *arg )
772 case LDAP_OPT_X_SASL_MECH: {
773 *(char **)arg = ld->ld_options.ldo_def_sasl_mech
774 ? LDAP_STRDUP( ld->ld_options.ldo_def_sasl_mech ) : NULL;
776 case LDAP_OPT_X_SASL_REALM: {
777 *(char **)arg = ld->ld_options.ldo_def_sasl_realm
778 ? LDAP_STRDUP( ld->ld_options.ldo_def_sasl_realm ) : NULL;
780 case LDAP_OPT_X_SASL_AUTHCID: {
781 *(char **)arg = ld->ld_options.ldo_def_sasl_authcid
782 ? LDAP_STRDUP( ld->ld_options.ldo_def_sasl_authcid ) : NULL;
784 case LDAP_OPT_X_SASL_AUTHZID: {
785 *(char **)arg = ld->ld_options.ldo_def_sasl_authzid
786 ? LDAP_STRDUP( ld->ld_options.ldo_def_sasl_authzid ) : NULL;
789 case LDAP_OPT_X_SASL_SSF: {
794 if( ld->ld_defconn == NULL ) {
798 ctx = ld->ld_defconn->lconn_sasl_ctx;
804 sc = sasl_getprop( ctx, SASL_SSF,
807 if ( sc != SASL_OK ) {
811 *(ber_len_t *)arg = *ssf;
814 case LDAP_OPT_X_SASL_SSF_EXTERNAL:
815 /* this option is write only */
818 case LDAP_OPT_X_SASL_SSF_MIN:
819 *(ber_len_t *)arg = ld->ld_options.ldo_sasl_secprops.min_ssf;
821 case LDAP_OPT_X_SASL_SSF_MAX:
822 *(ber_len_t *)arg = ld->ld_options.ldo_sasl_secprops.max_ssf;
824 case LDAP_OPT_X_SASL_MAXBUFSIZE:
825 *(ber_len_t *)arg = ld->ld_options.ldo_sasl_secprops.maxbufsize;
828 case LDAP_OPT_X_SASL_SECPROPS:
829 /* this option is write only */
839 ldap_int_sasl_set_option( LDAP *ld, int option, void *arg )
845 case LDAP_OPT_X_SASL_SSF:
846 /* This option is read-only */
849 case LDAP_OPT_X_SASL_SSF_EXTERNAL: {
851 sasl_external_properties_t extprops;
854 if( ld->ld_defconn == NULL ) {
858 ctx = ld->ld_defconn->lconn_sasl_ctx;
864 memset(&extprops, 0L, sizeof(extprops));
866 extprops.ssf = * (ber_len_t *) arg;
868 sc = sasl_setprop( ctx, SASL_SSF_EXTERNAL,
869 (void *) &extprops );
871 if ( sc != SASL_OK ) {
876 case LDAP_OPT_X_SASL_SSF_MIN:
877 ld->ld_options.ldo_sasl_secprops.min_ssf = *(ber_len_t *)arg;
879 case LDAP_OPT_X_SASL_SSF_MAX:
880 ld->ld_options.ldo_sasl_secprops.max_ssf = *(ber_len_t *)arg;
882 case LDAP_OPT_X_SASL_MAXBUFSIZE:
883 ld->ld_options.ldo_sasl_secprops.maxbufsize = *(ber_len_t *)arg;
886 case LDAP_OPT_X_SASL_SECPROPS: {
888 sc = ldap_pvt_sasl_secprops( (char *) arg,
889 &ld->ld_options.ldo_sasl_secprops );
891 return sc == LDAP_SUCCESS ? 0 : -1;
900 #ifdef LDAP_R_COMPILE
901 void *ldap_pvt_sasl_mutex_new(void)
903 ldap_pvt_thread_mutex_t *mutex;
905 mutex = (ldap_pvt_thread_mutex_t *) LDAP_MALLOC(
906 sizeof(ldap_pvt_thread_mutex_t) );
908 if ( ldap_pvt_thread_mutex_init( mutex ) == 0 ) {
914 int ldap_pvt_sasl_mutex_lock(void *mutex)
916 return ldap_pvt_thread_mutex_lock( (ldap_pvt_thread_mutex_t *)mutex )
917 ? SASL_FAIL : SASL_OK;
920 int ldap_pvt_sasl_mutex_unlock(void *mutex)
922 return ldap_pvt_thread_mutex_unlock( (ldap_pvt_thread_mutex_t *)mutex )
923 ? SASL_FAIL : SASL_OK;
926 void ldap_pvt_sasl_mutex_dispose(void *mutex)
928 (void) ldap_pvt_thread_mutex_destroy( (ldap_pvt_thread_mutex_t *)mutex );
934 int ldap_int_sasl_init( void )
935 { return LDAP_SUCCESS; }
937 int ldap_int_sasl_close( LDAP *ld, LDAPConn *lc )
938 { return LDAP_SUCCESS; }
945 LDAPControl **sctrls,
946 LDAPControl **cctrls,
948 LDAP_SASL_INTERACT_PROC *interact,
950 { return LDAP_NOT_SUPPORTED; }
951 #endif /* HAVE_CYRUS_SASL */