2 Bacula® - The Network Backup Solution
4 Copyright (C) 2000-2006 Free Software Foundation Europe e.V.
6 The main author of Bacula is Kern Sibbald, with contributions from
7 many others, a complete list can be found in the file AUTHORS.
8 This program is Free Software; you can redistribute it and/or
9 modify it under the terms of version two of the GNU General Public
10 License as published by the Free Software Foundation plus additions
11 that are listed in the file LICENSE.
13 This program is distributed in the hope that it will be useful, but
14 WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program; if not, write to the Free Software
20 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
23 Bacula® is a registered trademark of John Walker.
24 The licensor of Bacula is the Free Software Foundation Europe
25 (FSFE), Fiduciary Program, Sumatrastrasse 25, 8006 Zürich,
26 Switzerland, email:ftf@fsfeurope.org.
29 * Network Utility Routines
33 * Adapted and enhanced for Bacula, originally written
34 * for inclusion in the Apcupsd package
44 extern time_t watchdog_time;
47 #define INADDR_NONE -1
51 #define socketRead(fd, buf, len) recv(fd, buf, len, 0)
52 #define socketWrite(fd, buf, len) send(fd, buf, len, 0)
53 #define socketClose(fd) closesocket(fd)
55 #define socketRead(fd, buf, len) read(fd, buf, len)
56 #define socketWrite(fd, buf, len) write(fd, buf, len)
57 #define socketClose(fd) close(fd)
60 static pthread_mutex_t ip_mutex = PTHREAD_MUTEX_INITIALIZER;
63 * Read a nbytes from the network.
64 * It is possible that the total bytes require in several
68 int32_t read_nbytes(BSOCK * bsock, char *ptr, int32_t nbytes)
75 return (tls_bsock_readn(bsock, ptr, nbytes));
82 nread = socketRead(bsock->m_fd, ptr, nleft);
83 if (bsock->is_timed_out() || bsock->is_terminated()) {
90 if (errno == EAGAIN) {
91 bmicrosleep(0, 200000); /* try again in 200ms */
96 return nread; /* error, or EOF */
101 return nbytes - nleft; /* return >= 0 */
105 * Write nbytes to the network.
106 * It may require several writes.
109 int32_t write_nbytes(BSOCK * bsock, char *ptr, int32_t nbytes)
111 int32_t nleft, nwritten;
113 if (bsock->m_spool) {
114 nwritten = fwrite(ptr, 1, nbytes, bsock->m_spool_fd);
115 if (nwritten != nbytes) {
117 bsock->b_errno = errno;
118 Qmsg1(bsock->jcr(), M_FATAL, 0, _("Attr spool write error. ERR=%s\n"),
120 Dmsg2(400, "nwritten=%d nbytes=%d.\n", nwritten, nbytes);
121 errno = bsock->b_errno;
130 return (tls_bsock_writen(bsock, ptr, nbytes));
132 #endif /* HAVE_TLS */
138 nwritten = socketWrite(bsock->m_fd, ptr, nleft);
139 if (bsock->is_timed_out() || bsock->is_terminated()) {
142 } while (nwritten == -1 && errno == EINTR);
144 * If connection is non-blocking, we will get EAGAIN, so
145 * use select() to keep from consuming all the CPU
148 if (nwritten == -1 && errno == EAGAIN) {
153 FD_SET((unsigned)bsock->m_fd, &fdset);
156 select(bsock->m_fd + 1, NULL, &fdset, NULL, &tv);
160 return nwritten; /* error */
165 return nbytes - nleft;
169 * Receive a message from the other end. Each message consists of
170 * two packets. The first is a header that contains the size
171 * of the data that follows in the second packet.
172 * Returns number of bytes read (may return zero)
173 * Returns -1 on signal (BNET_SIGNAL)
174 * Returns -2 on hard end of file (BNET_HARDEOF)
175 * Returns -3 on error (BNET_ERROR)
177 * Unfortunately, it is a bit complicated because we have these
180 * 2. Signal including end of data stream
181 * 3. Hard end of file
183 * Using is_bnet_stop() and is_bnet_error() you can figure this all out.
185 int32_t bnet_recv(BSOCK * bsock)
187 return bsock->recv();
192 * Return 1 if there are errors on this bsock or it is closed,
193 * i.e. stop communicating on this line.
195 bool is_bnet_stop(BSOCK * bsock)
197 return bsock->errors || bsock->is_terminated();
201 * Return number of errors on socket
203 int is_bnet_error(BSOCK * bsock)
205 errno = bsock->b_errno;
206 return bsock->errors;
210 * Call here after error during closing to suppress error
211 * messages which are due to the other end shutting down too.
213 void bnet_suppress_error_messages(BSOCK * bsock, bool flag)
215 bsock->m_suppress_error_msgs = flag;
219 * Send a message over the network. The send consists of
220 * two network packets. The first is sends a 32 bit integer containing
221 * the length of the data packet which follows.
223 * Returns: false on failure
226 bool bnet_send(BSOCK *bsock)
228 return bsock->send();
233 * Establish a TLS connection -- server side
234 * Returns: true on success
238 bool bnet_tls_server(TLS_CONTEXT *ctx, BSOCK * bsock, alist *verify_list)
242 tls = new_tls_connection(ctx, bsock->m_fd);
244 Qmsg0(bsock->jcr(), M_FATAL, 0, _("TLS connection initialization failed.\n"));
250 /* Initiate TLS Negotiation */
251 if (!tls_bsock_accept(bsock)) {
252 Qmsg0(bsock->jcr(), M_FATAL, 0, _("TLS Negotiation failed.\n"));
257 if (!tls_postconnect_verify_cn(tls, verify_list)) {
258 Qmsg1(bsock->jcr(), M_FATAL, 0, _("TLS certificate verification failed."
259 " Peer certificate did not match a required commonName\n"),
267 free_tls_connection(tls);
273 * Establish a TLS connection -- client side
274 * Returns: true on success
277 bool bnet_tls_client(TLS_CONTEXT *ctx, BSOCK * bsock, alist *verify_list)
281 tls = new_tls_connection(ctx, bsock->m_fd);
283 Qmsg0(bsock->jcr(), M_FATAL, 0, _("TLS connection initialization failed.\n"));
289 /* Initiate TLS Negotiation */
290 if (!tls_bsock_connect(bsock)) {
294 /* If there's an Allowed CN verify list, use that to validate the remote
295 * certificate's CN. Otherwise, we use standard host/CN matching. */
297 if (!tls_postconnect_verify_cn(tls, verify_list)) {
298 Qmsg1(bsock->jcr(), M_FATAL, 0, _("TLS certificate verification failed."
299 " Peer certificate did not match a required commonName\n"),
304 if (!tls_postconnect_verify_host(tls, bsock->host())) {
305 Qmsg1(bsock->jcr(), M_FATAL, 0, _("TLS host certificate verification failed. Host %s did not match presented certificate\n"),
314 free_tls_connection(tls);
320 bool bnet_tls_server(TLS_CONTEXT *ctx, BSOCK * bsock, alist *verify_list)
322 Jmsg(bsock->jcr(), M_ABORT, 0, _("TLS enabled but not configured.\n"));
326 bool bnet_tls_client(TLS_CONTEXT *ctx, BSOCK * bsock, alist *verify_list)
328 Jmsg(bsock->jcr(), M_ABORT, 0, _("TLS enable but not configured.\n"));
332 #endif /* HAVE_TLS */
335 * Wait for a specified time for data to appear on
336 * the BSOCK connection.
338 * Returns: 1 if data available
342 int bnet_wait_data(BSOCK * bsock, int sec)
348 FD_SET((unsigned)bsock->m_fd, &fdset);
352 switch (select(bsock->m_fd + 1, &fdset, NULL, NULL, &tv)) {
353 case 0: /* timeout */
357 bsock->b_errno = errno;
358 if (errno == EINTR) {
361 return -1; /* error return */
370 * As above, but returns on interrupt
372 int bnet_wait_data_intr(BSOCK * bsock, int sec)
378 FD_SET((unsigned)bsock->m_fd, &fdset);
381 switch (select(bsock->m_fd + 1, &fdset, NULL, NULL, &tv)) {
382 case 0: /* timeout */
386 bsock->b_errno = errno;
387 return -1; /* error return */
394 #ifndef NETDB_INTERNAL
395 #define NETDB_INTERNAL -1 /* See errno. */
397 #ifndef NETDB_SUCCESS
398 #define NETDB_SUCCESS 0 /* No problem. */
400 #ifndef HOST_NOT_FOUND
401 #define HOST_NOT_FOUND 1 /* Authoritative Answer Host not found. */
404 #define TRY_AGAIN 2 /* Non-Authoritative Host not found, or SERVERFAIL. */
407 #define NO_RECOVERY 3 /* Non recoverable errors, FORMERR, REFUSED, NOTIMP. */
410 #define NO_DATA 4 /* Valid name, no data record of requested type. */
414 * Get human readable error for gethostbyname()
416 static const char *gethost_strerror()
422 msg = be.bstrerror();
425 msg = _("No problem.");
428 msg = _("Authoritative answer for host not found.");
431 msg = _("Non-authoritative for host not found, or ServerFail.");
434 msg = _("Non-recoverable errors, FORMERR, REFUSED, or NOTIMP.");
437 msg = _("Valid name, no data record of resquested type.");
440 msg = _("Unknown error.");
448 static IPADDR *add_any(int family)
450 IPADDR *addr = New(IPADDR(family));
451 addr->set_type(IPADDR::R_MULTIPLE);
452 addr->set_addr_any();
456 static const char *resolv_host(int family, const char *host, dlist * addr_list)
461 P(ip_mutex); /* gethostbyname() is not thread safe */
462 #ifdef HAVE_GETHOSTBYNAME2
463 if ((hp = gethostbyname2(host, family)) == NULL) {
465 if ((hp = gethostbyname(host)) == NULL) {
467 /* may be the strerror give not the right result -:( */
468 errmsg = gethost_strerror();
473 for (p = hp->h_addr_list; *p != 0; p++) {
474 IPADDR *addr = New(IPADDR(hp->h_addrtype));
475 addr->set_type(IPADDR::R_MULTIPLE);
476 if (addr->get_family() == AF_INET) {
477 addr->set_addr4((struct in_addr*)*p);
481 addr->set_addr6((struct in6_addr*)*p);
484 addr_list->append(addr);
492 * i host = 0 mean INADDR_ANY only ipv4
494 dlist *bnet_host2ipaddrs(const char *host, int family, const char **errstr)
496 struct in_addr inaddr;
500 struct in6_addr inaddr6;
503 dlist *addr_list = New(dlist(addr, &addr->link));
504 if (!host || host[0] == '\0') {
506 addr_list->append(add_any(family));
508 addr_list->append(add_any(AF_INET));
510 addr_list->append(add_any(AF_INET6));
513 } else if (inet_aton(host, &inaddr)) { /* MA Bug 4 */
514 addr = New(IPADDR(AF_INET));
515 addr->set_type(IPADDR::R_MULTIPLE);
516 addr->set_addr4(&inaddr);
517 addr_list->append(addr);
520 if (inet_pton(AF_INET6, host, &inaddr6) > 1) {
521 addr = New(IPADDR(AF_INET6));
522 addr->set_type(IPADDR::R_MULTIPLE);
523 addr->set_addr6(&inaddr6);
524 addr_list->append(addr);
529 errmsg = resolv_host(family, host, addr_list);
532 free_addresses(addr_list);
536 errmsg = resolv_host(AF_INET, host, addr_list);
539 errmsg = resolv_host(AF_INET6, host, addr_list);
544 free_addresses(addr_list);
553 * Open a TCP connection to the UPS network server
555 * Returns BSOCK * pointer on success
558 static BSOCK *bnet_open(JCR *jcr, const char *name, char *host, char *service,
559 int port, utime_t heart_beat, int *fatal)
564 bool connected = false;
570 * Fill in the structure serv_addr with the address of
571 * the server that we want to connect with.
573 if ((addr_list = bnet_host2ipaddrs(host, 0, &errstr)) == NULL) {
574 /* Note errstr is not malloc'ed */
575 Qmsg2(jcr, M_ERROR, 0, _("gethostbyname() for host \"%s\" failed: ERR=%s\n"),
577 Dmsg2(100, "bnet_host2ipaddrs() for host %s failed: ERR=%s\n",
583 foreach_dlist(ipaddr, addr_list) {
584 ipaddr->set_port_net(htons(port));
585 char allbuf[256 * 10];
587 Dmsg2(100, "Current %sAll %s\n",
588 ipaddr->build_address_str(curbuf, sizeof(curbuf)),
589 build_addresses_str(addr_list, allbuf, sizeof(allbuf)));
590 /* Open a TCP socket */
591 if ((sockfd = socket(ipaddr->get_family(), SOCK_STREAM, 0)) < 0) {
595 Pmsg3(000, _("Socket open error. proto=%d port=%d. ERR=%s\n"),
596 ipaddr->get_family(), ipaddr->get_port_host_order(), be.bstrerror());
600 * Keep socket from timing out from inactivity
602 if (setsockopt(sockfd, SOL_SOCKET, SO_KEEPALIVE, (sockopt_val_t)&turnon, sizeof(turnon)) < 0) {
604 Qmsg1(jcr, M_WARNING, 0, _("Cannot set SO_KEEPALIVE on socket: %s\n"),
607 #if defined(TCP_KEEPIDLE)
610 if (setsockopt(sockfd, IPPROTO_IP, TCP_KEEPIDLE, (sockopt_val_t)&opt, sizeof(opt)) < 0) {
612 Qmsg1(jcr, M_WARNING, 0, _("Cannot set SO_KEEPIDLE on socket: %s\n"),
618 /* connect to server */
619 if (connect(sockfd, ipaddr->get_sockaddr(), ipaddr->get_sockaddr_len()) < 0) {
630 free_addresses(addr_list);
631 errno = save_errno | b_errno_win32;
635 * Keep socket from timing out from inactivity
636 * Do this a second time out of paranoia
638 if (setsockopt(sockfd, SOL_SOCKET, SO_KEEPALIVE, (sockopt_val_t)&turnon, sizeof(turnon)) < 0) {
640 Qmsg1(jcr, M_WARNING, 0, _("Cannot set SO_KEEPALIVE on socket: %s\n"),
643 BSOCK* ret = init_bsock(jcr, sockfd, name, host, port, ipaddr->get_sockaddr());
644 free_addresses(addr_list);
650 BSOCK *bnet_connect(JCR * jcr, int retry_interval, utime_t max_retry_time,
652 const char *name, char *host, char *service, int port,
655 BSOCK *bsock = new BSOCK();
656 if (!bsock->connect(jcr, retry_interval, max_retry_time, heart_beat,
657 name, host, service, port, verbose)) {
667 * Try to connect to host for max_retry_time at retry_time intervals.
669 BSOCK *bnet_connect(JCR * jcr, int retry_interval, utime_t max_retry_time,
671 const char *name, char *host, char *service, int port,
677 time_t begin_time = time(NULL);
679 btimer_t *tid = NULL;
681 /* Try to trap out of OS call when time expires */
682 if (max_retry_time) {
683 tid = start_thread_timer(pthread_self(), (uint32_t)max_retry_time);
686 for (i = 0; (bsock = bnet_open(jcr, name, host, service, port, heart_beat, &fatal)) == NULL;
687 i -= retry_interval) {
689 if (fatal || (jcr && job_canceled(jcr))) {
693 Dmsg4(100, "Unable to connect to %s on %s:%d. ERR=%s\n",
694 name, host, port, be.bstrerror());
696 i = 60 * 5; /* complain again in 5 minutes */
698 Qmsg4(jcr, M_WARNING, 0, _(
699 "Could not connect to %s on %s:%d. ERR=%s\n"
700 "Retrying ...\n"), name, host, port, be.bstrerror());
702 bmicrosleep(retry_interval, 0);
704 if (begin_time + max_retry_time <= now) {
705 Qmsg4(jcr, M_FATAL, 0, _("Unable to connect to %s on %s:%d. ERR=%s\n"),
706 name, host, port, be.bstrerror());
714 stop_thread_timer(tid);
721 * Return the string for the error that occurred
722 * on the socket. Only the first error is retained.
724 const char *bnet_strerror(BSOCK * bsock)
727 if (bsock->errmsg == NULL) {
728 bsock->errmsg = get_pool_memory(PM_MESSAGE);
730 pm_strcpy(bsock->errmsg, be.bstrerror(bsock->b_errno));
731 return bsock->errmsg;
735 * Format and send a message
736 * Returns: false on error
739 bool bnet_fsend(BSOCK * bs, const char *fmt, ...)
744 if (bs->errors || bs->is_terminated()) {
747 /* This probably won't work, but we vsnprintf, then if we
748 * get a negative length or a length greater than our buffer
749 * (depending on which library is used), the printf was truncated, so
750 * get a bigger buffer and try again.
753 maxlen = sizeof_pool_memory(bs->msg) - 1;
754 va_start(arg_ptr, fmt);
755 bs->msglen = bvsnprintf(bs->msg, maxlen, fmt, arg_ptr);
757 if (bs->msglen > 0 && bs->msglen < (maxlen - 5)) {
760 bs->msg = realloc_pool_memory(bs->msg, maxlen + maxlen / 2);
765 int bnet_get_peer(BSOCK *bs, char *buf, socklen_t buflen)
767 return bs->get_peer(buf, buflen);
771 * Set the network buffer size, suggested size is in size.
772 * Actual size obtained is returned in bs->msglen
774 * Returns: 0 on failure
777 bool bnet_set_buffer_size(BSOCK * bs, uint32_t size, int rw)
779 return bs->set_buffer_size(size, rw);
783 * Set socket non-blocking
784 * Returns previous socket flag
786 int bnet_set_nonblocking(BSOCK *bsock)
788 return bsock->set_nonblocking();
792 * Set socket blocking
793 * Returns previous socket flags
795 int bnet_set_blocking(BSOCK *bsock)
797 return bsock->set_blocking();
801 * Restores socket flags
803 void bnet_restore_blocking (BSOCK *bsock, int flags)
805 bsock->restore_blocking(flags);
810 * Send a network "signal" to the other end
811 * This consists of sending a negative packet length
813 * Returns: false on failure
816 bool bnet_sig(BSOCK * bs, int signal)
818 return bs->signal(signal);
822 * Convert a network "signal" code into
823 * human readable ASCII.
825 const char *bnet_sig_to_ascii(BSOCK * bs)
828 switch (bs->msglen) {
830 return "BNET_EOD"; /* end of data stream */
832 return "BNET_EOD_POLL";
834 return "BNET_STATUS";
836 return "BNET_TERMINATE"; /* terminate connection */
840 return "BNET_HEARTBEAT";
841 case BNET_HB_RESPONSE:
842 return "BNET_HB_RESPONSE";
844 return "BNET_PROMPT";
846 sprintf(buf, _("Unknown sig %d"), (int)bs->msglen);
852 /* Initialize internal socket structure.
853 * This probably should be done in net_open
855 BSOCK *init_bsock(JCR * jcr, int sockfd, const char *who, const char *host, int port,
856 struct sockaddr *client_addr)
858 Dmsg3(100, "who=%s host=%s port=%d\n", who, host, port);
859 BSOCK *bsock = (BSOCK *)malloc(sizeof(BSOCK));
860 memset(bsock, 0, sizeof(BSOCK));
861 bsock->m_fd = sockfd;
864 bsock->m_blocking = 1;
865 bsock->msg = get_pool_memory(PM_MESSAGE);
866 bsock->errmsg = get_pool_memory(PM_MESSAGE);
867 bsock->set_who(bstrdup(who));
868 bsock->set_host(bstrdup(host));
869 bsock->set_port(port);
870 memset(&bsock->peer_addr, 0, sizeof(bsock->peer_addr));
871 memcpy(&bsock->client_addr, client_addr, sizeof(bsock->client_addr));
873 * ****FIXME**** reduce this to a few hours once
874 * heartbeats are implemented
876 bsock->timeout = 60 * 60 * 6 * 24; /* 6 days timeout */
881 BSOCK *dup_bsock(BSOCK * osock)
883 BSOCK *bsock = (BSOCK *)malloc(sizeof(BSOCK));
884 memcpy(bsock, osock, sizeof(BSOCK));
885 bsock->msg = get_pool_memory(PM_MESSAGE);
886 bsock->errmsg = get_pool_memory(PM_MESSAGE);
888 bsock->set_who(bstrdup(osock->who()));
891 bsock->set_host(bstrdup(osock->host()));
893 bsock->m_duped = true;
897 /* Close the network connection */
898 void bnet_close(BSOCK * bsock)
900 bsock->close(); /* this calls destroy */
903 void term_bsock(BSOCK * bsock)