1 /* tls.c - Handle tls/ssl. */
3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
5 * Copyright 1998-2017 The OpenLDAP Foundation.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted only as authorized by the OpenLDAP
12 * A copy of this license is available in the file LICENSE in the
13 * top-level directory of the distribution or, alternatively, at
14 * <http://www.OpenLDAP.org/license.html>.
16 /* ACKNOWLEDGEMENTS: restructured by Howard Chu.
20 #include "ldap_config.h"
24 #include <ac/stdlib.h>
26 #include <ac/socket.h>
27 #include <ac/string.h>
30 #include <ac/unistd.h>
32 #include <ac/dirent.h>
40 static tls_impl *tls_imp = &ldap_int_tls_impl;
41 #define HAS_TLS( sb ) ber_sockbuf_ctrl( sb, LBER_SB_OPT_HAS_IO, \
42 (void *)tls_imp->ti_sbio )
47 #define LDAP_USE_NON_BLOCKING_TLS
50 /* RFC2459 minimum required set of supported attribute types
53 typedef struct oid_name {
58 static oid_name oids[] = {
59 { BER_BVC("2.5.4.3"), BER_BVC("cn") },
60 { BER_BVC("2.5.4.4"), BER_BVC("sn") },
61 { BER_BVC("2.5.4.6"), BER_BVC("c") },
62 { BER_BVC("2.5.4.7"), BER_BVC("l") },
63 { BER_BVC("2.5.4.8"), BER_BVC("st") },
64 { BER_BVC("2.5.4.10"), BER_BVC("o") },
65 { BER_BVC("2.5.4.11"), BER_BVC("ou") },
66 { BER_BVC("2.5.4.12"), BER_BVC("title") },
67 { BER_BVC("2.5.4.41"), BER_BVC("name") },
68 { BER_BVC("2.5.4.42"), BER_BVC("givenName") },
69 { BER_BVC("2.5.4.43"), BER_BVC("initials") },
70 { BER_BVC("2.5.4.44"), BER_BVC("generationQualifier") },
71 { BER_BVC("2.5.4.46"), BER_BVC("dnQualifier") },
72 { BER_BVC("1.2.840.113549.1.9.1"), BER_BVC("email") },
73 { BER_BVC("0.9.2342.19200300.100.1.25"), BER_BVC("dc") },
74 { BER_BVNULL, BER_BVNULL }
80 ldap_pvt_tls_ctx_free ( void *c )
83 tls_imp->ti_ctx_free( c );
87 tls_ctx_ref( tls_ctx *ctx )
91 tls_imp->ti_ctx_ref( ctx );
96 * an extra mutex for the default ctx.
98 static ldap_pvt_thread_mutex_t tls_def_ctx_mutex;
102 ldap_int_tls_destroy( struct ldapoptions *lo )
104 if ( lo->ldo_tls_ctx ) {
105 ldap_pvt_tls_ctx_free( lo->ldo_tls_ctx );
106 lo->ldo_tls_ctx = NULL;
109 if ( lo->ldo_tls_certfile ) {
110 LDAP_FREE( lo->ldo_tls_certfile );
111 lo->ldo_tls_certfile = NULL;
113 if ( lo->ldo_tls_keyfile ) {
114 LDAP_FREE( lo->ldo_tls_keyfile );
115 lo->ldo_tls_keyfile = NULL;
117 if ( lo->ldo_tls_dhfile ) {
118 LDAP_FREE( lo->ldo_tls_dhfile );
119 lo->ldo_tls_dhfile = NULL;
121 if ( lo->ldo_tls_ecname ) {
122 LDAP_FREE( lo->ldo_tls_ecname );
123 lo->ldo_tls_ecname = NULL;
125 if ( lo->ldo_tls_cacertfile ) {
126 LDAP_FREE( lo->ldo_tls_cacertfile );
127 lo->ldo_tls_cacertfile = NULL;
129 if ( lo->ldo_tls_cacertdir ) {
130 LDAP_FREE( lo->ldo_tls_cacertdir );
131 lo->ldo_tls_cacertdir = NULL;
133 if ( lo->ldo_tls_ciphersuite ) {
134 LDAP_FREE( lo->ldo_tls_ciphersuite );
135 lo->ldo_tls_ciphersuite = NULL;
137 if ( lo->ldo_tls_crlfile ) {
138 LDAP_FREE( lo->ldo_tls_crlfile );
139 lo->ldo_tls_crlfile = NULL;
144 * Tear down the TLS subsystem. Should only be called once.
147 ldap_pvt_tls_destroy( void )
149 struct ldapoptions *lo = LDAP_INT_GLOBAL_OPT();
151 ldap_int_tls_destroy( lo );
153 tls_imp->ti_tls_destroy();
157 * Initialize a particular TLS implementation.
158 * Called once per implementation.
161 tls_init(tls_impl *impl )
163 static int tls_initialized = 0;
165 if ( !tls_initialized++ ) {
166 #ifdef LDAP_R_COMPILE
167 ldap_pvt_thread_mutex_init( &tls_def_ctx_mutex );
171 if ( impl->ti_inited++ ) return 0;
173 #ifdef LDAP_R_COMPILE
176 return impl->ti_tls_init();
180 * Initialize TLS subsystem. Called once per implementation.
183 ldap_pvt_tls_init( void )
185 return tls_init( tls_imp );
189 * initialize a new TLS context
192 ldap_int_tls_init_ctx( struct ldapoptions *lo, int is_server )
195 tls_impl *ti = tls_imp;
196 struct ldaptls lts = lo->ldo_tls_info;
198 if ( lo->ldo_tls_ctx )
203 if ( is_server && !lts.lt_certfile && !lts.lt_keyfile &&
204 !lts.lt_cacertfile && !lts.lt_cacertdir &&
205 !lts.lt_cacert.bv_val && !lts.lt_cert.bv_val &&
206 !lts.lt_key.bv_val ) {
207 /* minimum configuration not provided */
208 return LDAP_NOT_SUPPORTED;
212 /* This ASCII/EBCDIC handling is a real pain! */
213 if ( lts.lt_ciphersuite ) {
214 lts.lt_ciphersuite = LDAP_STRDUP( lts.lt_ciphersuite );
215 __atoe( lts.lt_ciphersuite );
217 if ( lts.lt_cacertfile ) {
218 lts.lt_cacertfile = LDAP_STRDUP( lts.lt_cacertfile );
219 __atoe( lts.lt_cacertfile );
221 if ( lts.lt_certfile ) {
222 lts.lt_certfile = LDAP_STRDUP( lts.lt_certfile );
223 __atoe( lts.lt_certfile );
225 if ( lts.lt_keyfile ) {
226 lts.lt_keyfile = LDAP_STRDUP( lts.lt_keyfile );
227 __atoe( lts.lt_keyfile );
229 if ( lts.lt_crlfile ) {
230 lts.lt_crlfile = LDAP_STRDUP( lts.lt_crlfile );
231 __atoe( lts.lt_crlfile );
233 if ( lts.lt_cacertdir ) {
234 lts.lt_cacertdir = LDAP_STRDUP( lts.lt_cacertdir );
235 __atoe( lts.lt_cacertdir );
237 if ( lts.lt_dhfile ) {
238 lts.lt_dhfile = LDAP_STRDUP( lts.lt_dhfile );
239 __atoe( lts.lt_dhfile );
241 if ( lts.lt_ecname ) {
242 lts.lt_ecname = LDAP_STRDUP( lts.lt_ecname );
243 __atoe( lts.lt_ecname );
246 lo->ldo_tls_ctx = ti->ti_ctx_new( lo );
247 if ( lo->ldo_tls_ctx == NULL ) {
248 Debug( LDAP_DEBUG_ANY,
249 "TLS: could not allocate default ctx.\n",
255 rc = ti->ti_ctx_init( lo, <s, is_server );
258 if ( rc < 0 && lo->ldo_tls_ctx != NULL ) {
259 ldap_pvt_tls_ctx_free( lo->ldo_tls_ctx );
260 lo->ldo_tls_ctx = NULL;
263 LDAP_FREE( lts.lt_ciphersuite );
264 LDAP_FREE( lts.lt_cacertfile );
265 LDAP_FREE( lts.lt_certfile );
266 LDAP_FREE( lts.lt_keyfile );
267 LDAP_FREE( lts.lt_crlfile );
268 LDAP_FREE( lts.lt_cacertdir );
269 LDAP_FREE( lts.lt_dhfile );
270 LDAP_FREE( lts.lt_ecname );
276 * initialize the default context
279 ldap_pvt_tls_init_def_ctx( int is_server )
281 struct ldapoptions *lo = LDAP_INT_GLOBAL_OPT();
283 LDAP_MUTEX_LOCK( &tls_def_ctx_mutex );
284 rc = ldap_int_tls_init_ctx( lo, is_server );
285 LDAP_MUTEX_UNLOCK( &tls_def_ctx_mutex );
290 alloc_handle( void *ctx_arg, int is_server )
298 struct ldapoptions *lo = LDAP_INT_GLOBAL_OPT();
299 if ( ldap_pvt_tls_init_def_ctx( is_server ) < 0 ) return NULL;
300 ctx = lo->ldo_tls_ctx;
303 ssl = tls_imp->ti_session_new( ctx, is_server );
305 Debug( LDAP_DEBUG_ANY,"TLS: can't create ssl handle.\n",0,0,0);
312 update_flags( Sockbuf *sb, tls_session * ssl, int rc )
314 sb->sb_trans_needs_read = 0;
315 sb->sb_trans_needs_write = 0;
317 return tls_imp->ti_session_upflags( sb, ssl, rc );
321 * Call this to do a TLS connect on a sockbuf. ctx_arg can be
322 * a SSL_CTX * or NULL, in which case the default ctx is used.
326 * 0 - Success. Connection is ready for communication.
327 * <0 - Error. Can't create a TLS stream.
328 * >0 - Partial success.
329 * Do a select (using information from lber_pvt_sb_needs_{read,write}
334 ldap_int_tls_connect( LDAP *ld, LDAPConn *conn )
336 Sockbuf *sb = conn->lconn_sb;
338 tls_session *ssl = NULL;
340 if ( HAS_TLS( sb )) {
341 ber_sockbuf_ctrl( sb, LBER_SB_OPT_GET_SSL, (void *)&ssl );
343 struct ldapoptions *lo;
346 ctx = ld->ld_options.ldo_tls_ctx;
348 ssl = alloc_handle( ctx, 0 );
350 if ( ssl == NULL ) return -1;
353 ber_sockbuf_add_io( sb, &ber_sockbuf_io_debug,
354 LBER_SBIOD_LEVEL_TRANSPORT, (void *)"tls_" );
356 ber_sockbuf_add_io( sb, tls_imp->ti_sbio,
357 LBER_SBIOD_LEVEL_TRANSPORT, (void *)ssl );
359 lo = LDAP_INT_GLOBAL_OPT();
361 ctx = lo->ldo_tls_ctx;
362 ld->ld_options.ldo_tls_ctx = ctx;
365 if ( ld->ld_options.ldo_tls_connect_cb )
366 ld->ld_options.ldo_tls_connect_cb( ld, ssl, ctx,
367 ld->ld_options.ldo_tls_connect_arg );
368 if ( lo && lo->ldo_tls_connect_cb && lo->ldo_tls_connect_cb !=
369 ld->ld_options.ldo_tls_connect_cb )
370 lo->ldo_tls_connect_cb( ld, ssl, ctx, lo->ldo_tls_connect_arg );
373 err = tls_imp->ti_session_connect( ld, ssl );
376 errno = WSAGetLastError();
382 if ( update_flags( sb, ssl, err )) {
386 msg = tls_imp->ti_session_errmsg( ssl, err, buf, sizeof(buf) );
388 if ( ld->ld_error ) {
389 LDAP_FREE( ld->ld_error );
391 ld->ld_error = LDAP_STRDUP( msg );
393 if ( ld->ld_error ) __etoa(ld->ld_error);
397 Debug( LDAP_DEBUG_ANY,"TLS: can't connect: %s.\n",
398 ld->ld_error ? ld->ld_error : "" ,0,0);
400 ber_sockbuf_remove_io( sb, tls_imp->ti_sbio,
401 LBER_SBIOD_LEVEL_TRANSPORT );
403 ber_sockbuf_remove_io( sb, &ber_sockbuf_io_debug,
404 LBER_SBIOD_LEVEL_TRANSPORT );
413 * Call this to do a TLS accept on a sockbuf.
414 * Everything else is the same as with tls_connect.
417 ldap_pvt_tls_accept( Sockbuf *sb, void *ctx_arg )
420 tls_session *ssl = NULL;
422 if ( HAS_TLS( sb )) {
423 ber_sockbuf_ctrl( sb, LBER_SB_OPT_GET_SSL, (void *)&ssl );
425 ssl = alloc_handle( ctx_arg, 1 );
426 if ( ssl == NULL ) return -1;
429 ber_sockbuf_add_io( sb, &ber_sockbuf_io_debug,
430 LBER_SBIOD_LEVEL_TRANSPORT, (void *)"tls_" );
432 ber_sockbuf_add_io( sb, tls_imp->ti_sbio,
433 LBER_SBIOD_LEVEL_TRANSPORT, (void *)ssl );
436 err = tls_imp->ti_session_accept( ssl );
439 errno = WSAGetLastError();
444 if ( update_flags( sb, ssl, err )) return 1;
446 if ( DebugTest( LDAP_DEBUG_ANY ) ) {
448 msg = tls_imp->ti_session_errmsg( ssl, err, buf, sizeof(buf) );
449 Debug( LDAP_DEBUG_ANY,"TLS: can't accept: %s.\n",
450 msg ? msg : "(unknown)", 0, 0 );
453 ber_sockbuf_remove_io( sb, tls_imp->ti_sbio,
454 LBER_SBIOD_LEVEL_TRANSPORT );
456 ber_sockbuf_remove_io( sb, &ber_sockbuf_io_debug,
457 LBER_SBIOD_LEVEL_TRANSPORT );
465 ldap_pvt_tls_inplace ( Sockbuf *sb )
467 return HAS_TLS( sb ) ? 1 : 0;
471 ldap_tls_inplace( LDAP *ld )
475 if ( ld->ld_defconn && ld->ld_defconn->lconn_sb ) {
476 sb = ld->ld_defconn->lconn_sb;
478 } else if ( ld->ld_sb ) {
485 return ldap_pvt_tls_inplace( sb );
489 ldap_pvt_tls_get_peer_dn( void *s, struct berval *dn,
490 LDAPDN_rewrite_dummy *func, unsigned flags )
492 tls_session *session = s;
496 rc = tls_imp->ti_session_peer_dn( session, &bvdn );
499 rc = ldap_X509dn2bv( &bvdn, dn,
500 (LDAPDN_rewrite_func *)func, flags);
505 ldap_pvt_tls_check_hostname( LDAP *ld, void *s, const char *name_in )
507 tls_session *session = s;
509 return tls_imp->ti_session_chkhost( ld, session, name_in );
513 ldap_pvt_tls_config( LDAP *ld, int option, const char *arg )
518 case LDAP_OPT_X_TLS_CACERTFILE:
519 case LDAP_OPT_X_TLS_CACERTDIR:
520 case LDAP_OPT_X_TLS_CERTFILE:
521 case LDAP_OPT_X_TLS_KEYFILE:
522 case LDAP_OPT_X_TLS_RANDOM_FILE:
523 case LDAP_OPT_X_TLS_CIPHER_SUITE:
524 case LDAP_OPT_X_TLS_DHFILE:
525 case LDAP_OPT_X_TLS_CRLFILE: /* GnuTLS only */
526 return ldap_pvt_tls_set_option( ld, option, (void *) arg );
528 case LDAP_OPT_X_TLS_REQUIRE_CERT:
531 if ( strcasecmp( arg, "never" ) == 0 ) {
532 i = LDAP_OPT_X_TLS_NEVER ;
534 } else if ( strcasecmp( arg, "demand" ) == 0 ) {
535 i = LDAP_OPT_X_TLS_DEMAND ;
537 } else if ( strcasecmp( arg, "allow" ) == 0 ) {
538 i = LDAP_OPT_X_TLS_ALLOW ;
540 } else if ( strcasecmp( arg, "try" ) == 0 ) {
541 i = LDAP_OPT_X_TLS_TRY ;
543 } else if ( ( strcasecmp( arg, "hard" ) == 0 ) ||
544 ( strcasecmp( arg, "on" ) == 0 ) ||
545 ( strcasecmp( arg, "yes" ) == 0) ||
546 ( strcasecmp( arg, "true" ) == 0 ) )
548 i = LDAP_OPT_X_TLS_HARD ;
552 return ldap_pvt_tls_set_option( ld, option, &i );
555 case LDAP_OPT_X_TLS_PROTOCOL_MIN: {
558 l = strtol( arg, &next, 10 );
559 if ( l < 0 || l > 0xff || next == arg ||
560 ( *next != '\0' && *next != '.' ) )
565 l = strtol( arg, &next, 10 );
566 if ( l < 0 || l > 0xff || next == arg || *next != '\0' )
570 return ldap_pvt_tls_set_option( ld, option, &i );
572 #ifdef HAVE_OPENSSL_CRL
573 case LDAP_OPT_X_TLS_CRLCHECK: /* OpenSSL only */
575 if ( strcasecmp( arg, "none" ) == 0 ) {
576 i = LDAP_OPT_X_TLS_CRL_NONE ;
577 } else if ( strcasecmp( arg, "peer" ) == 0 ) {
578 i = LDAP_OPT_X_TLS_CRL_PEER ;
579 } else if ( strcasecmp( arg, "all" ) == 0 ) {
580 i = LDAP_OPT_X_TLS_CRL_ALL ;
583 return ldap_pvt_tls_set_option( ld, option, &i );
592 ldap_pvt_tls_get_option( LDAP *ld, int option, void *arg )
594 struct ldapoptions *lo;
596 if( option == LDAP_OPT_X_TLS_PACKAGE ) {
597 *(char **)arg = LDAP_STRDUP( tls_imp->ti_name );
602 assert( LDAP_VALID( ld ) );
604 if( !LDAP_VALID( ld ) ) {
605 return LDAP_OPT_ERROR;
608 lo = &ld->ld_options;
611 /* Get pointer to global option structure */
612 lo = LDAP_INT_GLOBAL_OPT();
614 return LDAP_NO_MEMORY;
620 *(int *)arg = lo->ldo_tls_mode;
622 case LDAP_OPT_X_TLS_CTX:
623 *(void **)arg = lo->ldo_tls_ctx;
624 if ( lo->ldo_tls_ctx ) {
625 tls_ctx_ref( lo->ldo_tls_ctx );
628 case LDAP_OPT_X_TLS_CACERTFILE:
629 *(char **)arg = lo->ldo_tls_cacertfile ?
630 LDAP_STRDUP( lo->ldo_tls_cacertfile ) : NULL;
632 case LDAP_OPT_X_TLS_CACERTDIR:
633 *(char **)arg = lo->ldo_tls_cacertdir ?
634 LDAP_STRDUP( lo->ldo_tls_cacertdir ) : NULL;
636 case LDAP_OPT_X_TLS_CERTFILE:
637 *(char **)arg = lo->ldo_tls_certfile ?
638 LDAP_STRDUP( lo->ldo_tls_certfile ) : NULL;
640 case LDAP_OPT_X_TLS_KEYFILE:
641 *(char **)arg = lo->ldo_tls_keyfile ?
642 LDAP_STRDUP( lo->ldo_tls_keyfile ) : NULL;
644 case LDAP_OPT_X_TLS_DHFILE:
645 *(char **)arg = lo->ldo_tls_dhfile ?
646 LDAP_STRDUP( lo->ldo_tls_dhfile ) : NULL;
648 case LDAP_OPT_X_TLS_ECNAME:
649 *(char **)arg = lo->ldo_tls_ecname ?
650 LDAP_STRDUP( lo->ldo_tls_ecname ) : NULL;
652 case LDAP_OPT_X_TLS_CRLFILE: /* GnuTLS only */
653 *(char **)arg = lo->ldo_tls_crlfile ?
654 LDAP_STRDUP( lo->ldo_tls_crlfile ) : NULL;
656 case LDAP_OPT_X_TLS_REQUIRE_CERT:
657 *(int *)arg = lo->ldo_tls_require_cert;
659 #ifdef HAVE_OPENSSL_CRL
660 case LDAP_OPT_X_TLS_CRLCHECK: /* OpenSSL only */
661 *(int *)arg = lo->ldo_tls_crlcheck;
664 case LDAP_OPT_X_TLS_CIPHER_SUITE:
665 *(char **)arg = lo->ldo_tls_ciphersuite ?
666 LDAP_STRDUP( lo->ldo_tls_ciphersuite ) : NULL;
668 case LDAP_OPT_X_TLS_PROTOCOL_MIN:
669 *(int *)arg = lo->ldo_tls_protocol_min;
671 case LDAP_OPT_X_TLS_RANDOM_FILE:
672 *(char **)arg = lo->ldo_tls_randfile ?
673 LDAP_STRDUP( lo->ldo_tls_randfile ) : NULL;
675 case LDAP_OPT_X_TLS_SSL_CTX: {
678 LDAPConn *conn = ld->ld_defconn;
679 if ( conn != NULL ) {
680 Sockbuf *sb = conn->lconn_sb;
681 retval = ldap_pvt_tls_sb_ctx( sb );
684 *(void **)arg = retval;
687 case LDAP_OPT_X_TLS_CONNECT_CB:
688 *(LDAP_TLS_CONNECT_CB **)arg = lo->ldo_tls_connect_cb;
690 case LDAP_OPT_X_TLS_CONNECT_ARG:
691 *(void **)arg = lo->ldo_tls_connect_arg;
693 case LDAP_OPT_X_TLS_VERSION: {
695 const char *retval = NULL;
697 LDAPConn *conn = ld->ld_defconn;
698 if ( conn != NULL ) {
699 Sockbuf *sb = conn->lconn_sb;
700 sess = ldap_pvt_tls_sb_ctx( sb );
702 retval = ldap_pvt_tls_get_version( sess );
705 *(char **)arg = retval ? LDAP_STRDUP( retval ) : NULL;
708 case LDAP_OPT_X_TLS_CIPHER: {
710 const char *retval = NULL;
712 LDAPConn *conn = ld->ld_defconn;
713 if ( conn != NULL ) {
714 Sockbuf *sb = conn->lconn_sb;
715 sess = ldap_pvt_tls_sb_ctx( sb );
717 retval = ldap_pvt_tls_get_cipher( sess );
720 *(char **)arg = retval ? LDAP_STRDUP( retval ) : NULL;
723 case LDAP_OPT_X_TLS_PEERCERT: {
725 struct berval *bv = arg;
729 LDAPConn *conn = ld->ld_defconn;
730 if ( conn != NULL ) {
731 Sockbuf *sb = conn->lconn_sb;
732 sess = ldap_pvt_tls_sb_ctx( sb );
734 return ldap_pvt_tls_get_peercert( sess, bv );
739 case LDAP_OPT_X_TLS_CACERT: {
740 struct berval *bv = arg;
741 if ( lo->ldo_tls_cacert.bv_val ) {
742 ber_dupbv( bv, &lo->ldo_tls_cacert );
748 case LDAP_OPT_X_TLS_CERT: {
749 struct berval *bv = arg;
750 if ( lo->ldo_tls_cert.bv_val ) {
751 ber_dupbv( bv, &lo->ldo_tls_cert );
757 case LDAP_OPT_X_TLS_KEY: {
758 struct berval *bv = arg;
759 if ( lo->ldo_tls_key.bv_val ) {
760 ber_dupbv( bv, &lo->ldo_tls_key );
774 ldap_pvt_tls_set_option( LDAP *ld, int option, void *arg )
776 struct ldapoptions *lo;
779 assert( LDAP_VALID( ld ) );
781 if( !LDAP_VALID( ld ) ) {
782 return LDAP_OPT_ERROR;
785 lo = &ld->ld_options;
788 /* Get pointer to global option structure */
789 lo = LDAP_INT_GLOBAL_OPT();
791 return LDAP_NO_MEMORY;
797 if ( !arg ) return -1;
799 switch( *(int *) arg ) {
800 case LDAP_OPT_X_TLS_NEVER:
801 case LDAP_OPT_X_TLS_DEMAND:
802 case LDAP_OPT_X_TLS_ALLOW:
803 case LDAP_OPT_X_TLS_TRY:
804 case LDAP_OPT_X_TLS_HARD:
806 lo->ldo_tls_mode = *(int *)arg;
813 case LDAP_OPT_X_TLS_CTX:
814 if ( lo->ldo_tls_ctx )
815 ldap_pvt_tls_ctx_free( lo->ldo_tls_ctx );
816 lo->ldo_tls_ctx = arg;
817 tls_ctx_ref( lo->ldo_tls_ctx );
819 case LDAP_OPT_X_TLS_CONNECT_CB:
820 lo->ldo_tls_connect_cb = (LDAP_TLS_CONNECT_CB *)arg;
822 case LDAP_OPT_X_TLS_CONNECT_ARG:
823 lo->ldo_tls_connect_arg = arg;
825 case LDAP_OPT_X_TLS_CACERTFILE:
826 if ( lo->ldo_tls_cacertfile ) LDAP_FREE( lo->ldo_tls_cacertfile );
827 lo->ldo_tls_cacertfile = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
829 case LDAP_OPT_X_TLS_CACERTDIR:
830 if ( lo->ldo_tls_cacertdir ) LDAP_FREE( lo->ldo_tls_cacertdir );
831 lo->ldo_tls_cacertdir = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
833 case LDAP_OPT_X_TLS_CERTFILE:
834 if ( lo->ldo_tls_certfile ) LDAP_FREE( lo->ldo_tls_certfile );
835 lo->ldo_tls_certfile = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
837 case LDAP_OPT_X_TLS_KEYFILE:
838 if ( lo->ldo_tls_keyfile ) LDAP_FREE( lo->ldo_tls_keyfile );
839 lo->ldo_tls_keyfile = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
841 case LDAP_OPT_X_TLS_DHFILE:
842 if ( lo->ldo_tls_dhfile ) LDAP_FREE( lo->ldo_tls_dhfile );
843 lo->ldo_tls_dhfile = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
845 case LDAP_OPT_X_TLS_ECNAME:
846 if ( lo->ldo_tls_ecname ) LDAP_FREE( lo->ldo_tls_ecname );
847 lo->ldo_tls_ecname = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
849 case LDAP_OPT_X_TLS_CRLFILE: /* GnuTLS only */
850 if ( lo->ldo_tls_crlfile ) LDAP_FREE( lo->ldo_tls_crlfile );
851 lo->ldo_tls_crlfile = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
853 case LDAP_OPT_X_TLS_REQUIRE_CERT:
854 if ( !arg ) return -1;
855 switch( *(int *) arg ) {
856 case LDAP_OPT_X_TLS_NEVER:
857 case LDAP_OPT_X_TLS_DEMAND:
858 case LDAP_OPT_X_TLS_ALLOW:
859 case LDAP_OPT_X_TLS_TRY:
860 case LDAP_OPT_X_TLS_HARD:
861 lo->ldo_tls_require_cert = * (int *) arg;
865 #ifdef HAVE_OPENSSL_CRL
866 case LDAP_OPT_X_TLS_CRLCHECK: /* OpenSSL only */
867 if ( !arg ) return -1;
868 switch( *(int *) arg ) {
869 case LDAP_OPT_X_TLS_CRL_NONE:
870 case LDAP_OPT_X_TLS_CRL_PEER:
871 case LDAP_OPT_X_TLS_CRL_ALL:
872 lo->ldo_tls_crlcheck = * (int *) arg;
877 case LDAP_OPT_X_TLS_CIPHER_SUITE:
878 if ( lo->ldo_tls_ciphersuite ) LDAP_FREE( lo->ldo_tls_ciphersuite );
879 lo->ldo_tls_ciphersuite = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
882 case LDAP_OPT_X_TLS_PROTOCOL_MIN:
883 if ( !arg ) return -1;
884 lo->ldo_tls_protocol_min = *(int *)arg;
886 case LDAP_OPT_X_TLS_RANDOM_FILE:
889 if ( lo->ldo_tls_randfile ) LDAP_FREE (lo->ldo_tls_randfile );
890 lo->ldo_tls_randfile = arg ? LDAP_STRDUP( (char *) arg ) : NULL;
892 case LDAP_OPT_X_TLS_NEWCTX:
893 if ( !arg ) return -1;
894 if ( lo->ldo_tls_ctx )
895 ldap_pvt_tls_ctx_free( lo->ldo_tls_ctx );
896 lo->ldo_tls_ctx = NULL;
897 return ldap_int_tls_init_ctx( lo, *(int *)arg );
898 case LDAP_OPT_X_TLS_CACERT:
899 if ( lo->ldo_tls_cacert.bv_val )
900 LDAP_FREE( lo->ldo_tls_cacert.bv_val );
902 lo->ldo_tls_cacert.bv_len = ((struct berval *)arg)->bv_len;
903 lo->ldo_tls_cacert.bv_val = LDAP_MALLOC( lo->ldo_tls_cacert.bv_len );
904 if ( !lo->ldo_tls_cacert.bv_val )
906 AC_MEMCPY( lo->ldo_tls_cacert.bv_val, ((struct berval *)arg)->bv_val, lo->ldo_tls_cacert.bv_len );
908 BER_BVZERO( &lo->ldo_tls_cacert );
911 case LDAP_OPT_X_TLS_CERT:
912 if ( lo->ldo_tls_cert.bv_val )
913 LDAP_FREE( lo->ldo_tls_cert.bv_val );
915 lo->ldo_tls_cert.bv_len = ((struct berval *)arg)->bv_len;
916 lo->ldo_tls_cert.bv_val = LDAP_MALLOC( lo->ldo_tls_cert.bv_len );
917 if ( !lo->ldo_tls_cert.bv_val )
919 AC_MEMCPY( lo->ldo_tls_cert.bv_val, ((struct berval *)arg)->bv_val, lo->ldo_tls_cert.bv_len );
921 BER_BVZERO( &lo->ldo_tls_cert );
924 case LDAP_OPT_X_TLS_KEY:
925 if ( lo->ldo_tls_key.bv_val )
926 LDAP_FREE( lo->ldo_tls_key.bv_val );
928 lo->ldo_tls_key.bv_len = ((struct berval *)arg)->bv_len;
929 lo->ldo_tls_key.bv_val = LDAP_MALLOC( lo->ldo_tls_key.bv_len );
930 if ( !lo->ldo_tls_key.bv_val )
932 AC_MEMCPY( lo->ldo_tls_key.bv_val, ((struct berval *)arg)->bv_val, lo->ldo_tls_key.bv_len );
934 BER_BVZERO( &lo->ldo_tls_key );
944 ldap_int_tls_start ( LDAP *ld, LDAPConn *conn, LDAPURLDesc *srv )
950 #ifdef LDAP_USE_NON_BLOCKING_TLS
951 struct timeval start_time_tv, tv, tv0;
952 ber_socket_t sd = AC_SOCKET_ERROR;
953 #endif /* LDAP_USE_NON_BLOCKING_TLS */
956 return LDAP_PARAM_ERROR;
960 host = srv->lud_host;
962 host = conn->lconn_server->lud_host;
965 /* avoid NULL host */
970 (void) tls_init( tls_imp );
972 #ifdef LDAP_USE_NON_BLOCKING_TLS
974 * Use non-blocking io during SSL Handshake when a timeout is configured
976 if ( ld->ld_options.ldo_tm_net.tv_sec >= 0 ) {
977 ber_sockbuf_ctrl( ld->ld_sb, LBER_SB_OPT_SET_NONBLOCK, sb );
978 ber_sockbuf_ctrl( sb, LBER_SB_OPT_GET_FD, &sd );
979 tv = ld->ld_options.ldo_tm_net;
981 #ifdef HAVE_GETTIMEOFDAY
982 gettimeofday( &start_time_tv, NULL );
983 #else /* ! HAVE_GETTIMEOFDAY */
984 time( &start_time_tv.tv_sec );
985 start_time_tv.tv_usec = 0;
986 #endif /* ! HAVE_GETTIMEOFDAY */
989 #endif /* LDAP_USE_NON_BLOCKING_TLS */
991 ld->ld_errno = LDAP_SUCCESS;
992 ret = ldap_int_tls_connect( ld, conn );
994 #ifdef LDAP_USE_NON_BLOCKING_TLS
995 while ( ret > 0 ) { /* this should only happen for non-blocking io */
998 if ( sb->sb_trans_needs_read ) {
1000 } else if ( sb->sb_trans_needs_write ) {
1003 Debug( LDAP_DEBUG_TRACE, "ldap_int_tls_start: ldap_int_tls_connect needs %s\n",
1004 wr ? "write": "read", 0, 0);
1006 ret = ldap_int_poll( ld, sd, &tv, wr);
1008 ld->ld_errno = LDAP_TIMEOUT;
1011 /* ldap_int_poll called ldap_pvt_ndelay_off */
1012 ber_sockbuf_ctrl( ld->ld_sb, LBER_SB_OPT_SET_NONBLOCK, sb );
1013 ret = ldap_int_tls_connect( ld, conn );
1014 if ( ret > 0 ) { /* need to call tls_connect once more */
1015 struct timeval curr_time_tv, delta_tv;
1017 /* This is mostly copied from result.c:wait4msg(), should
1018 * probably be moved into a separate function */
1019 #ifdef HAVE_GETTIMEOFDAY
1020 gettimeofday( &curr_time_tv, NULL );
1021 #else /* ! HAVE_GETTIMEOFDAY */
1022 time( &curr_time_tv.tv_sec );
1023 curr_time_tv.tv_usec = 0;
1024 #endif /* ! HAVE_GETTIMEOFDAY */
1026 /* delta = curr - start */
1027 delta_tv.tv_sec = curr_time_tv.tv_sec - start_time_tv.tv_sec;
1028 delta_tv.tv_usec = curr_time_tv.tv_usec - start_time_tv.tv_usec;
1029 if ( delta_tv.tv_usec < 0 ) {
1031 delta_tv.tv_usec += 1000000;
1035 if ( ( tv0.tv_sec < delta_tv.tv_sec ) ||
1036 ( ( tv0.tv_sec == delta_tv.tv_sec ) &&
1037 ( tv0.tv_usec < delta_tv.tv_usec ) ) )
1040 ld->ld_errno = LDAP_TIMEOUT;
1043 /* timeout -= delta_time */
1044 tv0.tv_sec -= delta_tv.tv_sec;
1045 tv0.tv_usec -= delta_tv.tv_usec;
1046 if ( tv0.tv_usec < 0 ) {
1048 tv0.tv_usec += 1000000;
1050 start_time_tv.tv_sec = curr_time_tv.tv_sec;
1051 start_time_tv.tv_usec = curr_time_tv.tv_usec;
1054 Debug( LDAP_DEBUG_TRACE, "ldap_int_tls_start: ld %p %ld s %ld us to go\n",
1055 (void *)ld, (long) tv.tv_sec, (long) tv.tv_usec );
1059 if ( ld->ld_options.ldo_tm_net.tv_sec >= 0 ) {
1060 ber_sockbuf_ctrl( ld->ld_sb, LBER_SB_OPT_SET_NONBLOCK, NULL );
1062 #endif /* LDAP_USE_NON_BLOCKING_TLS */
1065 if ( ld->ld_errno == LDAP_SUCCESS )
1066 ld->ld_errno = LDAP_CONNECT_ERROR;
1067 return (ld->ld_errno);
1070 ssl = ldap_pvt_tls_sb_ctx( sb );
1071 assert( ssl != NULL );
1074 * compare host with name(s) in certificate
1076 if (ld->ld_options.ldo_tls_require_cert != LDAP_OPT_X_TLS_NEVER &&
1077 ld->ld_options.ldo_tls_require_cert != LDAP_OPT_X_TLS_ALLOW) {
1078 ld->ld_errno = ldap_pvt_tls_check_hostname( ld, ssl, host );
1079 if (ld->ld_errno != LDAP_SUCCESS) {
1080 return ld->ld_errno;
1084 return LDAP_SUCCESS;
1088 ldap_pvt_tls_sb_ctx( Sockbuf *sb )
1092 ber_sockbuf_ctrl( sb, LBER_SB_OPT_GET_SSL, (void *)&p );
1097 ldap_pvt_tls_get_strength( void *s )
1099 tls_session *session = s;
1101 return tls_imp->ti_session_strength( session );
1105 ldap_pvt_tls_get_my_dn( void *s, struct berval *dn, LDAPDN_rewrite_dummy *func, unsigned flags )
1107 tls_session *session = s;
1108 struct berval der_dn;
1111 rc = tls_imp->ti_session_my_dn( session, &der_dn );
1112 if ( rc == LDAP_SUCCESS )
1113 rc = ldap_X509dn2bv(&der_dn, dn, (LDAPDN_rewrite_func *)func, flags );
1118 ldap_pvt_tls_get_unique( void *s, struct berval *buf, int is_server )
1120 tls_session *session = s;
1121 return tls_imp->ti_session_unique( session, buf, is_server );
1125 ldap_pvt_tls_get_version( void *s )
1127 tls_session *session = s;
1128 return tls_imp->ti_session_version( session );
1132 ldap_pvt_tls_get_cipher( void *s )
1134 tls_session *session = s;
1135 return tls_imp->ti_session_cipher( session );
1139 ldap_pvt_tls_get_peercert( void *s, struct berval *der )
1141 tls_session *session = s;
1142 return tls_imp->ti_session_peercert( session, der );
1144 #endif /* HAVE_TLS */
1147 ldap_start_tls( LDAP *ld,
1148 LDAPControl **serverctrls,
1149 LDAPControl **clientctrls,
1152 return ldap_extended_operation( ld, LDAP_EXOP_START_TLS,
1153 NULL, serverctrls, clientctrls, msgidp );
1157 ldap_install_tls( LDAP *ld )
1160 return LDAP_NOT_SUPPORTED;
1162 if ( ldap_tls_inplace( ld ) ) {
1163 return LDAP_LOCAL_ERROR;
1166 return ldap_int_tls_start( ld, ld->ld_defconn, NULL );
1171 ldap_start_tls_s ( LDAP *ld,
1172 LDAPControl **serverctrls,
1173 LDAPControl **clientctrls )
1176 return LDAP_NOT_SUPPORTED;
1179 char *rspoid = NULL;
1180 struct berval *rspdata = NULL;
1182 /* XXYYZ: this initiates operation only on default connection! */
1184 if ( ldap_tls_inplace( ld ) ) {
1185 return LDAP_LOCAL_ERROR;
1188 rc = ldap_extended_operation_s( ld, LDAP_EXOP_START_TLS,
1189 NULL, serverctrls, clientctrls, &rspoid, &rspdata );
1191 if ( rspoid != NULL ) {
1195 if ( rspdata != NULL ) {
1196 ber_bvfree( rspdata );
1199 if ( rc == LDAP_SUCCESS ) {
1200 rc = ldap_int_tls_start( ld, ld->ld_defconn, NULL );
1207 /* These tags probably all belong in lber.h, but they're
1208 * not normally encountered when processing LDAP, so maybe
1209 * they belong somewhere else instead.
1212 #define LBER_TAG_OID ((ber_tag_t) 0x06UL)
1214 /* Tags for string types used in a DirectoryString.
1216 * Note that IA5string is not one of the defined choices for
1217 * DirectoryString in X.520, but it gets used for email AVAs.
1219 #define LBER_TAG_UTF8 ((ber_tag_t) 0x0cUL)
1220 #define LBER_TAG_PRINTABLE ((ber_tag_t) 0x13UL)
1221 #define LBER_TAG_TELETEX ((ber_tag_t) 0x14UL)
1222 #define LBER_TAG_IA5 ((ber_tag_t) 0x16UL)
1223 #define LBER_TAG_UNIVERSAL ((ber_tag_t) 0x1cUL)
1224 #define LBER_TAG_BMP ((ber_tag_t) 0x1eUL)
1227 find_oid( struct berval *oid )
1231 for ( i=0; !BER_BVISNULL( &oids[i].oid ); i++ ) {
1232 if ( oids[i].oid.bv_len != oid->bv_len ) continue;
1233 if ( !strcmp( oids[i].oid.bv_val, oid->bv_val ))
1239 /* Converts BER Bitstring value to LDAP BitString value (RFC4517)
1244 * berValue and ldapValue should not be NULL
1247 #define BITS_PER_BYTE 8
1248 #define SQUOTE_LENGTH 1
1249 #define B_CHAR_LENGTH 1
1250 #define STR_OVERHEAD (2*SQUOTE_LENGTH + B_CHAR_LENGTH)
1253 der_to_ldap_BitString (struct berval *berValue,
1254 struct berval *ldapValue)
1256 ber_len_t bitPadding=0;
1257 ber_len_t bits, maxBits;
1260 ber_len_t bitLength;
1262 unsigned char* valPtr;
1264 ldapValue->bv_len=0;
1265 ldapValue->bv_val=NULL;
1267 /* Gets padding and points to binary data */
1268 valLen=berValue->bv_len;
1269 valPtr=(unsigned char*)berValue->bv_val;
1271 bitPadding=(ber_len_t)(valPtr[0]);
1275 /* If Block is non DER encoding fixes to DER encoding */
1276 if (bitPadding >= BITS_PER_BYTE) {
1277 if (valLen*BITS_PER_BYTE > bitPadding ) {
1278 valLen-=(bitPadding/BITS_PER_BYTE);
1279 bitPadding%=BITS_PER_BYTE;
1285 /* Just in case bad encoding */
1286 if (valLen*BITS_PER_BYTE < bitPadding ) {
1291 /* Gets buffer to hold RFC4517 Bit String format */
1292 bitLength=valLen*BITS_PER_BYTE-bitPadding;
1293 tmpStr=LDAP_MALLOC(bitLength + STR_OVERHEAD + 1);
1296 return LDAP_NO_MEMORY;
1298 ldapValue->bv_val=tmpStr;
1299 ldapValue->bv_len=bitLength + STR_OVERHEAD;
1301 /* Formatting in '*binary-digit'B format */
1302 maxBits=BITS_PER_BYTE;
1307 maxBits-=bitPadding;
1308 for (bits=0; bits<maxBits; bits++) {
1323 return LDAP_SUCCESS;
1326 /* Convert a structured DN from an X.509 certificate into an LDAPV3 DN.
1327 * x509_name must be raw DER. If func is non-NULL, the
1328 * constructed DN will use numeric OIDs to identify attributeTypes,
1329 * and the func() will be invoked to rewrite the DN with the given
1332 * Otherwise the DN will use shortNames from a hardcoded table.
1335 ldap_X509dn2bv( void *x509_name, struct berval *bv, LDAPDN_rewrite_func *func,
1340 LDAPAVA *newAVA, *baseAVA;
1341 BerElementBuffer berbuf;
1342 BerElement *ber = (BerElement *)&berbuf;
1343 char oids[8192], *oidptr = oids, *oidbuf = NULL;
1345 char *dn_end, *rdn_end;
1346 int i, navas, nrdns, rc = LDAP_SUCCESS;
1347 size_t dnsize, oidrem = sizeof(oids), oidsize = 0;
1353 struct berval Oid, Val, oid2, *in = x509_name;
1355 assert( bv != NULL );
1363 /* A DN is a SEQUENCE of RDNs. An RDN is a SET of AVAs.
1364 * An AVA is a SEQUENCE of attr and value.
1365 * Count the number of AVAs and RDNs
1367 ber_init2( ber, in, LBER_USE_DER );
1368 tag = ber_peek_tag( ber, &len );
1369 if ( tag != LBER_SEQUENCE )
1370 return LDAP_DECODING_ERROR;
1372 for ( tag = ber_first_element( ber, &len, &dn_end );
1374 tag = ber_next_element( ber, &len, dn_end )) {
1376 for ( tag = ber_first_element( ber, &len, &rdn_end );
1377 tag == LBER_SEQUENCE;
1378 tag = ber_next_element( ber, &len, rdn_end )) {
1379 tag = ber_skip_tag( ber, &len );
1380 ber_skip_data( ber, len );
1385 /* Allocate the DN/RDN/AVA stuff as a single block */
1386 dnsize = sizeof(LDAPRDN) * (nrdns+1);
1387 dnsize += sizeof(LDAPAVA *) * (navas+nrdns);
1388 dnsize += sizeof(LDAPAVA) * navas;
1389 if (dnsize > sizeof(ptrs)) {
1390 newDN = (LDAPDN)LDAP_MALLOC( dnsize );
1391 if ( newDN == NULL )
1392 return LDAP_NO_MEMORY;
1394 newDN = (LDAPDN)(char *)ptrs;
1397 newDN[nrdns] = NULL;
1398 newRDN = (LDAPRDN)(newDN + nrdns+1);
1399 newAVA = (LDAPAVA *)(newRDN + navas + nrdns);
1402 /* Rewind and start extracting */
1405 tag = ber_first_element( ber, &len, &dn_end );
1406 for ( i = nrdns - 1; i >= 0; i-- ) {
1409 for ( tag = ber_first_element( ber, &len, &rdn_end );
1410 tag == LBER_SEQUENCE;
1411 tag = ber_next_element( ber, &len, rdn_end )) {
1414 tag = ber_skip_tag( ber, &len );
1415 tag = ber_get_stringbv( ber, &Oid, LBER_BV_NOTERM );
1416 if ( tag != LBER_TAG_OID ) {
1417 rc = LDAP_DECODING_ERROR;
1421 oid2.bv_val = oidptr;
1422 oid2.bv_len = oidrem;
1423 if ( ber_decode_oid( &Oid, &oid2 ) < 0 ) {
1424 rc = LDAP_DECODING_ERROR;
1427 oidname = find_oid( &oid2 );
1429 newAVA->la_attr = oid2;
1430 oidptr += oid2.bv_len + 1;
1431 oidrem -= oid2.bv_len + 1;
1433 /* Running out of OID buffer space? */
1435 if ( oidsize == 0 ) {
1436 oidsize = sizeof(oids) * 2;
1438 oidbuf = LDAP_MALLOC( oidsize );
1439 if ( oidbuf == NULL ) goto nomem;
1443 oidbuf = LDAP_REALLOC( oidbuf, oidsize*2 );
1444 if ( oidbuf == NULL ) goto nomem;
1445 /* Buffer moved! Fix AVA pointers */
1446 if ( old != oidbuf ) {
1448 long dif = oidbuf - old;
1450 for (a=baseAVA; a<=newAVA; a++){
1451 if (a->la_attr.bv_val >= old &&
1452 a->la_attr.bv_val <= (old + oidsize))
1453 a->la_attr.bv_val += dif;
1456 oidptr = oidbuf + oidsize - oidrem;
1463 newAVA->la_attr = oidname->oid;
1465 newAVA->la_attr = oidname->name;
1468 newAVA->la_private = NULL;
1469 newAVA->la_flags = LDAP_AVA_STRING;
1470 tag = ber_get_stringbv( ber, &Val, LBER_BV_NOTERM );
1472 case LBER_TAG_UNIVERSAL:
1473 /* This uses 32-bit ISO 10646-1 */
1474 csize = 4; goto to_utf8;
1476 /* This uses 16-bit ISO 10646-1 */
1477 csize = 2; goto to_utf8;
1478 case LBER_TAG_TELETEX:
1479 /* This uses 8-bit, assume ISO 8859-1 */
1481 to_utf8: rc = ldap_ucs_to_utf8s( &Val, csize, &newAVA->la_value );
1482 newAVA->la_flags |= LDAP_AVA_NONPRINTABLE;
1484 newAVA->la_flags |= LDAP_AVA_FREE_VALUE;
1485 if (rc != LDAP_SUCCESS) goto nomem;
1488 newAVA->la_flags |= LDAP_AVA_NONPRINTABLE;
1489 /* This is already in UTF-8 encoding */
1491 case LBER_TAG_PRINTABLE:
1492 /* These are always 7-bit strings */
1493 newAVA->la_value = Val;
1495 case LBER_BITSTRING:
1496 /* X.690 bitString value converted to RFC4517 Bit String */
1497 rc = der_to_ldap_BitString( &Val, &newAVA->la_value );
1500 /* Not a string type at all */
1501 newAVA->la_flags = 0;
1502 newAVA->la_value = Val;
1508 tag = ber_next_element( ber, &len, dn_end );
1512 rc = func( newDN, flags, NULL );
1513 if ( rc != LDAP_SUCCESS )
1517 rc = ldap_dn2bv_x( newDN, bv, LDAP_DN_FORMAT_LDAPV3, NULL );
1520 for (;baseAVA < newAVA; baseAVA++) {
1521 if (baseAVA->la_flags & LDAP_AVA_FREE_ATTR)
1522 LDAP_FREE( baseAVA->la_attr.bv_val );
1523 if (baseAVA->la_flags & LDAP_AVA_FREE_VALUE)
1524 LDAP_FREE( baseAVA->la_value.bv_val );
1528 LDAP_FREE( oidbuf );
1529 if ( newDN != (LDAPDN)(char *) ptrs )