2 * socket.c -- socket library functions
4 * Copyright 1998 by Eric S. Raymond.
5 * For license terms, see the file COPYING in this directory.
12 #include <ctype.h> /* isspace() */
15 #endif /* HAVE_MEMORY_H */
16 #include <sys/types.h>
18 #ifndef HAVE_NET_SOCKET_H
19 #include <sys/socket.h>
21 #include <net/socket.h>
24 #include <netinet/in.h>
25 #ifdef HAVE_ARPA_INET_H
26 #include <arpa/inet.h>
29 #if defined(STDC_HEADERS)
32 #if defined(HAVE_UNISTD_H)
35 #if defined(HAVE_STDARG_H)
40 #if TIME_WITH_SYS_TIME
41 # include <sys/time.h>
45 # include <sys/time.h>
52 #include "fetchmail.h"
53 #include "getaddrinfo.h"
56 /* Defines to allow BeOS and Cygwin to play nice... */
59 #define fm_close(a) closesocket(a)
60 #define fm_write(a,b,c) send(a,b,c,0)
61 #define fm_peek(a,b,c) recv(a,b,c,0)
62 #define fm_read(a,b,c) recv(a,b,c,0)
64 #define fm_close(a) close(a)
65 #define fm_write(a,b,c) write(a,b,c)
66 #define fm_peek(a,b,c) recv(a,b,c, MSG_PEEK)
68 #define fm_read(a,b,c) cygwin_read(a,b,c)
69 static ssize_t cygwin_read(int sock, void *buf, size_t count);
70 #else /* ! __CYGWIN__ */
71 #define fm_read(a,b,c) read(a,b,c)
72 #endif /* __CYGWIN__ */
75 /* We need to define h_errno only if it is not already */
78 #ifdef HAVE_RES_SEARCH
79 /* some versions of FreeBSD should declare this but don't */
82 /* pretend we have h_errno to avoid some #ifdef's later */
86 #endif /* ndef h_errno */
88 #ifdef HAVE_SOCKETPAIR
89 static char *const *parse_plugin(const char *plugin, const char *host, const char *service)
90 { const char **argvec;
92 char *cp, *plugin_copy;
93 unsigned int plugin_copy_len;
94 unsigned int plugin_offset = 0, plugin_copy_offset = 0;
95 unsigned int i, s = 2 * sizeof(char*), host_count = 0, service_count = 0;
96 unsigned int plugin_len = strlen(plugin);
97 unsigned int host_len = strlen(host);
98 unsigned int service_len = strlen(service);
100 for (c = p = plugin; *c; c++)
101 { if (isspace((unsigned char)*c) && !isspace((unsigned char)*p))
103 if (*p == '%' && *c == 'h')
105 if (*p == '%' && *c == 'p')
110 plugin_copy_len = plugin_len + host_len * host_count + service_len * service_count;
111 plugin_copy = malloc(plugin_copy_len + 1);
114 report(stderr, GT_("fetchmail: malloc failed\n"));
118 while (plugin_copy_offset < plugin_copy_len)
119 { if ((plugin[plugin_offset] == '%') && (plugin[plugin_offset + 1] == 'h'))
120 { strcpy(plugin_copy + plugin_copy_offset, host);
122 plugin_copy_offset += host_len;
124 else if ((plugin[plugin_offset] == '%') && (plugin[plugin_offset + 1] == 'p'))
125 { strcpy(plugin_copy + plugin_copy_offset, service);
127 plugin_copy_offset += service_len;
130 { plugin_copy[plugin_copy_offset] = plugin[plugin_offset];
132 plugin_copy_offset++;
135 plugin_copy[plugin_copy_len] = 0;
140 report(stderr, GT_("fetchmail: malloc failed\n"));
143 memset(argvec, 0, s);
144 for (c = p = plugin_copy, i = 0; *c; c++)
145 { if ((!isspace((unsigned char)*c)) && (c == p ? 1 : isspace((unsigned char)*p))) {
151 for (cp = plugin_copy; *cp; cp++)
152 { if (isspace((unsigned char)*cp))
155 return (char *const*)argvec;
158 static int handle_plugin(const char *host,
159 const char *service, const char *plugin)
160 /* get a socket mediated through a given external command */
166 * The author of this code, Felix von Leitner <felix@convergence.de>, says:
167 * he chose socketpair() instead of pipe() because socketpair creates
168 * bidirectional sockets while allegedly some pipe() implementations don't.
170 if (socketpair(AF_UNIX,SOCK_STREAM,0,fds))
172 report(stderr, GT_("fetchmail: socketpair failed\n"));
178 report(stderr, GT_("fetchmail: fork failed\n"));
181 /* fds[1] is the parent's end; close it for proper EOF
183 (void) close(fds[1]);
184 if ( (dup2(fds[0],0) == -1) || (dup2(fds[0],1) == -1) ) {
185 report(stderr, GT_("dup2 failed\n"));
188 /* fds[0] is now connected to 0 and 1; close it */
189 (void) close(fds[0]);
190 if (outlevel >= O_VERBOSE)
191 report(stderr, GT_("running %s (host %s service %s)\n"), plugin, host, service);
192 argvec = parse_plugin(plugin,host,service);
193 execvp(*argvec, argvec);
194 report(stderr, GT_("execvp(%s) failed\n"), *argvec);
197 default: /* parent */
201 /* fds[0] is the child's end; close it for proper EOF detection */
202 (void) close(fds[0]);
205 #endif /* HAVE_SOCKETPAIR */
209 int SockCheckOpen(int fd)
210 /* poll given socket; is it selectable? */
218 FD_ZERO(&r); FD_ZERO(&w); FD_ZERO(&e);
221 tv.tv_sec = 0; tv.tv_usec = 0;
222 rt = select(fd+1, &r, &w, &e, &tv);
223 if (rt == -1 && (errno != EAGAIN && errno != EINTR))
229 #endif /* __UNUSED__ */
231 int UnixOpen(const char *path)
234 struct sockaddr_un ad;
235 memset(&ad, 0, sizeof(ad));
236 ad.sun_family = AF_UNIX;
237 strncpy(ad.sun_path, path, sizeof(ad.sun_path)-1);
239 sock = socket( AF_UNIX, SOCK_STREAM, 0 );
246 /* Socket opened saved. Usefull if connect timeout
247 * because it can be closed.
249 mailserver_socket_temp = sock;
251 if (connect(sock, (struct sockaddr *) &ad, sizeof(ad)) < 0)
254 fm_close(sock); /* don't use SockClose, no traffic yet */
260 /* No connect timeout, then no need to set mailserver_socket_temp */
261 mailserver_socket_temp = -1;
266 int SockOpen(const char *host, const char *service,
269 struct addrinfo *ai, *ai0, req;
272 #ifdef HAVE_SOCKETPAIR
274 return handle_plugin(host,service,plugin);
275 #endif /* HAVE_SOCKETPAIR */
276 memset(&req, 0, sizeof(struct addrinfo));
277 req.ai_socktype = SOCK_STREAM;
279 i = getaddrinfo(host, service, &req, &ai0);
281 report(stderr, GT_("fetchmail: getaddrinfo(\"%s\",\"%s\") error: %s\n"),
282 host, service, gai_strerror(i));
287 for (ai = ai0; ai; ai = ai->ai_next) {
288 i = socket(ai->ai_family, ai->ai_socktype, 0);
292 /* Socket opened saved. Usefull if connect timeout
293 * because it can be closed.
295 mailserver_socket_temp = i;
297 if (connect(i, (struct sockaddr *) ai->ai_addr, ai->ai_addrlen) < 0) {
303 /* No connect timeout, then no need to set mailserver_socket_temp */
304 mailserver_socket_temp = -1;
315 #if defined(HAVE_STDARG_H)
316 int SockPrintf(int sock, const char* format, ...)
319 int SockPrintf(sock,format,va_alist)
328 #if defined(HAVE_STDARG_H)
329 va_start(ap, format) ;
333 vsnprintf(buf, sizeof(buf), format, ap);
335 return SockWrite(sock, buf, strlen(buf));
340 #include <openssl/ssl.h>
341 #include <openssl/err.h>
342 #include <openssl/pem.h>
343 #include <openssl/x509.h>
344 #include <openssl/rand.h>
346 static SSL_CTX *_ctx = NULL;
347 static SSL *_ssl_context[FD_SETSIZE];
349 static SSL *SSLGetContext( int );
350 #endif /* SSL_ENABLE */
352 int SockWrite(int sock, char *buf, int len)
362 if( NULL != ( ssl = SSLGetContext( sock ) ) )
363 n = SSL_write(ssl, buf, len);
365 #endif /* SSL_ENABLE */
366 n = fm_write(sock, buf, len);
376 int SockRead(int sock, char *buf, int len)
378 char *newline, *bp = buf;
380 #ifdef FORCE_STUFFING
381 int maxavailable = 0;
399 * The reason for these gymnastics is that we want two things:
400 * (1) to read \n-terminated lines,
401 * (2) to return the true length of data read, even if the
402 * data coming in has embedded NULS.
405 if( NULL != ( ssl = SSLGetContext( sock ) ) ) {
407 /* OK... SSL_peek works a little different from MSG_PEEK
408 Problem is that SSL_peek can return 0 if there
409 is no data currently available. If, on the other
410 hand, we loose the socket, we also get a zero, but
411 the SSL_read then SEGFAULTS! To deal with this,
412 we'll check the error code any time we get a return
413 of zero from SSL_peek. If we have an error, we bail.
414 If we don't, we read one character in SSL_read and
415 loop. This should continue to work even if they
416 later change the behavior of SSL_peek
417 to "fix" this problem... :-( */
418 if ((n = SSL_peek(ssl, bp, len)) < 0) {
419 (void)SSL_get_error(ssl, n);
422 #ifdef FORCE_STUFFING
426 /* SSL_peek says no data... Does he mean no data
427 or did the connection blow up? If we got an error
429 if( 0 != ( n = SSL_get_error(ssl, n) ) ) {
432 /* We didn't get an error so read at least one
433 character at this point and loop */
435 /* Make sure newline start out NULL!
436 * We don't have a string to pass through
437 * the strchr at this point yet */
439 } else if ((newline = memchr(bp, '\n', n)) != NULL)
440 n = newline - bp + 1;
441 /* Matthias Andree: SSL_read can return 0, in that case
442 * we must cal SSL_get_error to figure if there was
443 * an error or just a "no data" condition */
444 if ((n = SSL_read(ssl, bp, n)) <= 0) {
445 if ((n = SSL_get_error(ssl, n))) {
449 /* Check for case where our single character turned out to
450 * be a newline... (It wasn't going to get caught by
451 * the strchr above if it came from the hack... ). */
452 if( NULL == newline && 1 == n && '\n' == *bp ) {
453 /* Got our newline - this will break
454 out of the loop now */
459 #endif /* SSL_ENABLE */
463 if ((n = fm_read(sock, bp, 1)) <= 0)
465 if ((n = fm_peek(sock, bp, len)) <= 0)
468 #ifdef FORCE_STUFFING
471 if ((newline = memchr(bp, '\n', n)) != NULL)
472 n = newline - bp + 1;
474 if ((n = fm_read(sock, bp, n)) == -1)
476 #endif /* __BEOS__ */
484 #ifdef FORCE_STUFFING /* too ugly to live -- besides, there's IMAP */
485 /* OK, very weird hack coming up here:
486 * When POP3 servers send us a message, they're supposed to
487 * terminate the message with a line containing only a dot. To protect
488 * against lines in the real message that might contain only a dot,
489 * they're supposed to preface any line that starts with a dot with
490 * an additional dot, which will be removed on the client side. That
491 * process, called byte-stuffing (and unstuffing) is really not the
492 * concern of this low-level routine, ordinarily, but there are some
493 * POP servers (and maybe IMAP servers too, who knows) that fail to
494 * do the byte-stuffing, and this routine is the best place to try to
495 * identify and fix that fault.
497 * Since the DOT line is supposed to come only at the end of a
498 * message, the implication is that right after we see it, the server
499 * is supposed to go back to waiting for the next command. There
500 * isn't supposed to be any more data to read after we see the dot.
501 * THEREFORE, if we see more data to be read after something that
502 * looks like the dot line, then probably the server is failing to
503 * do byte-stuffing. In that case, we'll byte-pack it for them so
504 * that the higher-level routines see things as hunky-dorey.
505 * This is not a perfect test or fix by any means (it has an
506 * obvious race condition, for one thing), but it should at least
507 * reduce the nastiness that ensues when people don't know how
508 * to write POP servers.
510 if ((maxavailable > (bp-buf)) &&
517 (buf[1] == '\n')))) {
519 memmove(buf+1, buf, (bp-buf)+1);
523 #endif /* FORCE_STUFFING */
527 int SockPeek(int sock)
528 /* peek at the next socket character without actually reading it */
537 if( NULL != ( ssl = SSLGetContext( sock ) ) ) {
538 n = SSL_peek(ssl, &ch, 1);
540 (void)SSL_get_error(ssl, n);
544 /* This code really needs to implement a "hold back"
545 * to simulate a functioning SSL_peek()... sigh...
546 * Has to be coordinated with the read code above.
547 * Next on the list todo... */
549 /* SSL_peek says 0... Does that mean no data
550 or did the connection blow up? If we got an error
552 if( 0 != ( n = SSL_get_error(ssl, n) ) ) {
556 /* Haven't seen this case actually occur, but...
557 if the problem in SockRead can occur, this should
558 be possible... Just not sure what to do here.
559 This should be a safe "punt" the "peek" but don't
560 "punt" the "session"... */
562 return 0; /* Give him a '\0' character */
566 #endif /* SSL_ENABLE */
567 n = fm_peek(sock, &ch, 1);
579 static char *_ssl_server_cname = NULL;
580 static int _check_fp;
581 static char *_check_digest;
582 static char *_server_label;
583 static int _depth0ck;
584 static int _prev_err;
586 SSL *SSLGetContext( int sock )
588 /* If SSLOpen has never initialized - just return NULL */
592 if( sock < 0 || sock > FD_SETSIZE )
594 return _ssl_context[sock];
598 /* ok_return (preverify_ok) is 1 if this stage of certificate verification
599 passed, or 0 if it failed. This callback lets us display informative
600 errors, and perform additional validation (e.g. CN matches) */
601 static int SSL_verify_callback( int ok_return, X509_STORE_CTX *ctx, int strict )
606 unsigned char digest[EVP_MAX_MD_SIZE];
607 char text[EVP_MAX_MD_SIZE * 3 + 1], *tp, *te;
608 const EVP_MD *digest_tp;
609 unsigned int dsz, i, esz;
610 X509_NAME *subj, *issuer;
612 x509_cert = X509_STORE_CTX_get_current_cert(ctx);
613 err = X509_STORE_CTX_get_error(ctx);
614 depth = X509_STORE_CTX_get_error_depth(ctx);
616 subj = X509_get_subject_name(x509_cert);
617 issuer = X509_get_issuer_name(x509_cert);
619 if (depth == 0 && !_depth0ck) {
622 if (outlevel == O_VERBOSE) {
623 if ((i = X509_NAME_get_text_by_NID(issuer, NID_organizationName, buf, sizeof(buf))) != -1) {
624 report(stdout, GT_("Issuer Organization: %s\n"), buf);
625 if (i >= sizeof(buf) - 1)
626 report(stdout, GT_("Warning: Issuer Organization Name too long (possibly truncated).\n"));
628 report(stdout, GT_("Unknown Organization\n"));
629 if ((i = X509_NAME_get_text_by_NID(issuer, NID_commonName, buf, sizeof(buf))) != -1) {
630 report(stdout, GT_("Issuer CommonName: %s\n"), buf);
631 if (i >= sizeof(buf) - 1)
632 report(stdout, GT_("Warning: Issuer CommonName too long (possibly truncated).\n"));
634 report(stdout, GT_("Unknown Issuer CommonName\n"));
636 if ((i = X509_NAME_get_text_by_NID(subj, NID_commonName, buf, sizeof(buf))) != -1) {
637 if (outlevel == O_VERBOSE)
638 report(stdout, GT_("Server CommonName: %s\n"), buf);
639 if (i >= sizeof(buf) - 1) {
640 /* Possible truncation. In this case, this is a DNS name, so this
641 * is really bad. We do not tolerate this even in the non-strict case. */
642 report(stderr, GT_("Bad certificate: Subject CommonName too long!\n"));
645 if (_ssl_server_cname != NULL) {
647 char *p2 = _ssl_server_cname;
652 n = strlen(p2) - strlen(p1);
656 if (0 != strcasecmp(p1, p2)) {
658 GT_("Server CommonName mismatch: %s != %s\n"),
659 buf, _ssl_server_cname );
660 if (ok_return && strict)
663 } else if (ok_return) {
664 report(stderr, GT_("Server name not set, could not verify certificate!\n"));
665 if (strict) return (0);
668 if (outlevel == O_VERBOSE)
669 report(stdout, GT_("Unknown Server CommonName\n"));
670 if (ok_return && strict) {
671 report(stderr, GT_("Server name not specified in certificate!\n"));
675 /* Print the finger print. Note that on errors, we might print it more than once
676 * normally; we kluge around that by using a global variable. */
679 digest_tp = EVP_md5();
680 if (digest_tp == NULL) {
681 report(stderr, GT_("EVP_md5() failed!\n"));
684 if (!X509_digest(x509_cert, digest_tp, digest, &dsz)) {
685 report(stderr, GT_("Out of memory!\n"));
689 te = text + sizeof(text);
690 for (i = 0; i < dsz; i++) {
691 esz = snprintf(tp, te - tp, i > 0 ? ":%02X" : "%02X", digest[i]);
692 if (esz >= te - tp) {
693 report(stderr, GT_("Digest text buffer too small!\n"));
698 if (outlevel > O_NORMAL)
699 report(stdout, GT_("%s key fingerprint: %s\n"), _server_label, text);
700 if (_check_digest != NULL) {
701 if (strcmp(text, _check_digest) == 0) {
702 if (outlevel > O_NORMAL)
703 report(stdout, GT_("%s fingerprints match.\n"), _server_label);
705 if (outlevel > O_SILENT)
706 report(stderr, GT_("%s fingerprints do not match!\n"), _server_label);
713 if (err != X509_V_OK && err != _prev_err) {
715 report(stderr, GT_("Server certificate verification error: %s\n"), X509_verify_cert_error_string(err));
716 /* We gave the error code, but maybe we can add some more details for debugging */
718 case X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT:
719 X509_NAME_oneline(issuer, buf, sizeof(buf));
720 buf[sizeof(buf) - 1] = '\0';
721 report(stderr, GT_("unknown issuer (first %d characters): %s\n"), sizeof(buf)-1, buf);
730 static int SSL_nock_verify_callback( int ok_return, X509_STORE_CTX *ctx )
732 return SSL_verify_callback(ok_return, ctx, 0);
735 static int SSL_ck_verify_callback( int ok_return, X509_STORE_CTX *ctx )
737 return SSL_verify_callback(ok_return, ctx, 1);
740 /* performs initial SSL handshake over the connected socket
741 * uses SSL *ssl global variable, which is currently defined
744 int SSLOpen(int sock, char *mycert, char *mykey, char *myproto, int certck, char *certpath,
745 char *fingerprint, char *servercname, char *label)
747 struct stat randstat;
750 SSL_load_error_strings();
751 SSLeay_add_ssl_algorithms();
754 if (stat("/dev/random", &randstat) &&
755 stat("/dev/urandom", &randstat)) {
756 /* Neither /dev/random nor /dev/urandom are present, so add
757 entropy to the SSL PRNG a hard way. */
758 for (i = 0; i < 10000 && ! RAND_status (); ++i) {
761 gettimeofday (&tv, 0);
762 buf[0] = tv.tv_usec & 0xF;
763 buf[2] = (tv.tv_usec & 0xF0) >> 4;
764 buf[3] = (tv.tv_usec & 0xF00) >> 8;
765 buf[1] = (tv.tv_usec & 0xF000) >> 12;
766 RAND_add (buf, sizeof buf, 0.1);
769 #endif /* SSL_ENABLE */
772 if( sock < 0 || sock > FD_SETSIZE ) {
773 report(stderr, GT_("File descriptor out of range for SSL") );
778 /* Be picky and make sure the memory is cleared */
779 memset( _ssl_context, 0, sizeof( _ssl_context ) );
781 if(!strcmp("ssl2",myproto)) {
782 _ctx = SSL_CTX_new(SSLv2_client_method());
783 } else if(!strcmp("ssl3",myproto)) {
784 _ctx = SSL_CTX_new(SSLv3_client_method());
785 } else if(!strcmp("tls1",myproto)) {
786 _ctx = SSL_CTX_new(TLSv1_client_method());
787 } else if (!strcmp("ssl23",myproto)) {
790 fprintf(stderr,GT_("Invalid SSL protocol '%s' specified, using default (SSLv23).\n"), myproto);
795 _ctx = SSL_CTX_new(SSLv23_client_method());
798 ERR_print_errors_fp(stderr);
804 SSL_CTX_set_verify(_ctx, SSL_VERIFY_PEER, SSL_ck_verify_callback);
806 /* In this case, we do not fail if verification fails. However,
807 * we provide the callback for output and possible fingerprint checks. */
808 SSL_CTX_set_verify(_ctx, SSL_VERIFY_PEER, SSL_nock_verify_callback);
811 SSL_CTX_load_verify_locations(_ctx, NULL, certpath);
813 _ssl_context[sock] = SSL_new(_ctx);
815 if(_ssl_context[sock] == NULL) {
816 ERR_print_errors_fp(stderr);
820 /* This static is for the verify callback */
821 _ssl_server_cname = servercname;
822 _server_label = label;
824 _check_digest = fingerprint;
828 if( mycert || mykey ) {
830 /* Ok... He has a certificate file defined, so lets declare it. If
831 * he does NOT have a separate certificate and private key file then
832 * assume that it's a combined key and certificate file.
838 SSL_use_certificate_file(_ssl_context[sock], mycert, SSL_FILETYPE_PEM);
839 SSL_use_RSAPrivateKey_file(_ssl_context[sock], mykey, SSL_FILETYPE_PEM);
842 SSL_set_fd(_ssl_context[sock], sock);
844 if(SSL_connect(_ssl_context[sock]) < 1) {
845 ERR_print_errors_fp(stderr);
849 /* Paranoia: was the callback not called as we expected? */
851 report(stderr, GT_("Certificate/fingerprint verification was somehow skipped!\n"));
853 if (fingerprint != NULL || certck) {
854 if( NULL != SSLGetContext( sock ) ) {
855 /* Clean up the SSL stack */
856 SSL_free( _ssl_context[sock] );
857 _ssl_context[sock] = NULL;
867 int SockClose(int sock)
868 /* close a socket gracefully */
871 if( NULL != SSLGetContext( sock ) ) {
872 /* Clean up the SSL stack */
873 SSL_free( _ssl_context[sock] );
874 _ssl_context[sock] = NULL;
880 * This hangs in RedHat 6.2 after fetchmail runs for a while a
881 * FIN_WAIT2 comes up in netstat and fetchmail never returns from
882 * the recv system call. (Reported from jtnews
883 * <jtnews@bellatlantic.net>, Wed, 24 May 2000 21:26:02.)
885 * Half-close the connection first so the other end gets notified.
887 * This stops sends but allows receives (effectively, it sends a
889 if (shutdown(sock, 1) == 0) {
891 /* If there is any data still waiting in the queue, discard it.
892 * Call recv() until either it returns 0 (meaning we received a FIN)
893 * or any error occurs. This makes sure all data sent by the other
894 * side is acknowledged at the TCP level.
896 if (fm_peek(sock, &ch, 1) > 0)
897 while (fm_read(sock, &ch, 1) > 0)
900 #endif /* __UNUSED__ */
902 /* if there's an error closing at this point, not much we can do */
903 return(fm_close(sock)); /* this is guarded */
908 * Workaround Microsoft Winsock recv/WSARecv(..., MSG_PEEK) bug.
909 * See http://sources.redhat.com/ml/cygwin/2001-08/msg00628.html
912 static ssize_t cygwin_read(int sock, void *buf, size_t count)
917 if ((n = read(sock, bp, count)) == -1)
922 if (outlevel >= O_VERBOSE)
923 report(stdout, GT_("Cygwin socket read retry\n"));
924 n2 = read(sock, bp + n, count - n);
925 if (n2 == -1 || n + n2 != count) {
926 report(stderr, GT_("Cygwin socket read retry failed!\n"));
933 #endif /* __CYGWIN__ */
937 * Use the chargen service to test input buffering directly.
938 * You may have to uncomment the `chargen' service description in your
939 * inetd.conf (and then SIGHUP inetd) for this to work. */
942 int sock = SockOpen("localhost", "chargen", NULL);
945 while (SockRead(sock, buf, sizeof(buf)-1))
946 SockWrite(1, buf, strlen(buf));
951 /* socket.c ends here */