2 Bacula® - The Network Backup Solution
4 Copyright (C) 2000-2008 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 and included
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 Kern Sibbald.
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
45 #define INADDR_NONE -1
49 #define socketRead(fd, buf, len) recv(fd, buf, len, 0)
50 #define socketWrite(fd, buf, len) send(fd, buf, len, 0)
51 #define socketClose(fd) closesocket(fd)
53 #define socketRead(fd, buf, len) read(fd, buf, len)
54 #define socketWrite(fd, buf, len) write(fd, buf, len)
55 #define socketClose(fd) close(fd)
58 static pthread_mutex_t ip_mutex = PTHREAD_MUTEX_INITIALIZER;
61 * Read a nbytes from the network.
62 * It is possible that the total bytes require in several
66 int32_t read_nbytes(BSOCK * bsock, char *ptr, int32_t nbytes)
73 return (tls_bsock_readn(bsock, ptr, nbytes));
80 nread = socketRead(bsock->m_fd, ptr, nleft);
81 if (bsock->is_timed_out() || bsock->is_terminated()) {
88 if (errno == EAGAIN) {
89 bmicrosleep(0, 200000); /* try again in 200ms */
94 return nread; /* error, or EOF */
99 return nbytes - nleft; /* return >= 0 */
103 * Write nbytes to the network.
104 * It may require several writes.
107 int32_t write_nbytes(BSOCK * bsock, char *ptr, int32_t nbytes)
109 int32_t nleft, nwritten;
111 if (bsock->is_spooling()) {
112 nwritten = fwrite(ptr, 1, nbytes, bsock->m_spool_fd);
113 if (nwritten != nbytes) {
115 bsock->b_errno = errno;
116 Qmsg1(bsock->jcr(), M_FATAL, 0, _("Attr spool write error. ERR=%s\n"),
118 Dmsg2(400, "nwritten=%d nbytes=%d.\n", nwritten, nbytes);
119 errno = bsock->b_errno;
128 return (tls_bsock_writen(bsock, ptr, nbytes));
130 #endif /* HAVE_TLS */
136 nwritten = socketWrite(bsock->m_fd, ptr, nleft);
137 if (bsock->is_timed_out() || bsock->is_terminated()) {
140 } while (nwritten == -1 && errno == EINTR);
142 * If connection is non-blocking, we will get EAGAIN, so
143 * use select() to keep from consuming all the CPU
146 if (nwritten == -1 && errno == EAGAIN) {
151 FD_SET((unsigned)bsock->m_fd, &fdset);
154 select(bsock->m_fd + 1, NULL, &fdset, NULL, &tv);
158 return nwritten; /* error */
163 return nbytes - nleft;
167 * Receive a message from the other end. Each message consists of
168 * two packets. The first is a header that contains the size
169 * of the data that follows in the second packet.
170 * Returns number of bytes read (may return zero)
171 * Returns -1 on signal (BNET_SIGNAL)
172 * Returns -2 on hard end of file (BNET_HARDEOF)
173 * Returns -3 on error (BNET_ERROR)
175 * Unfortunately, it is a bit complicated because we have these
178 * 2. Signal including end of data stream
179 * 3. Hard end of file
181 * Using is_bnet_stop() and is_bnet_error() you can figure this all out.
183 int32_t bnet_recv(BSOCK * bsock)
185 return bsock->recv();
190 * Return 1 if there are errors on this bsock or it is closed,
191 * i.e. stop communicating on this line.
193 bool is_bnet_stop(BSOCK * bsock)
195 return bsock->is_stop();
199 * Return number of errors on socket
201 int is_bnet_error(BSOCK * bsock)
203 return bsock->is_error();
207 * Call here after error during closing to suppress error
208 * messages which are due to the other end shutting down too.
210 void bnet_suppress_error_messages(BSOCK * bsock, bool flag)
212 bsock->m_suppress_error_msgs = flag;
216 * Send a message over the network. The send consists of
217 * two network packets. The first is sends a 32 bit integer containing
218 * the length of the data packet which follows.
220 * Returns: false on failure
223 bool bnet_send(BSOCK *bsock)
225 return bsock->send();
230 * Establish a TLS connection -- server side
231 * Returns: true on success
235 bool bnet_tls_server(TLS_CONTEXT *ctx, BSOCK * bsock, alist *verify_list)
238 JCR *jcr = bsock->jcr();
240 tls = new_tls_connection(ctx, bsock->m_fd);
242 Qmsg0(bsock->jcr(), M_FATAL, 0, _("TLS connection initialization failed.\n"));
248 /* Initiate TLS Negotiation */
249 if (!tls_bsock_accept(bsock)) {
250 Qmsg0(bsock->jcr(), M_FATAL, 0, _("TLS Negotiation failed.\n"));
255 if (!tls_postconnect_verify_cn(jcr, tls, verify_list)) {
256 Qmsg1(bsock->jcr(), M_FATAL, 0, _("TLS certificate verification failed."
257 " Peer certificate did not match a required commonName\n"),
262 Dmsg0(50, "TLS server negotiation established.\n");
266 free_tls_connection(tls);
272 * Establish a TLS connection -- client side
273 * Returns: true on success
276 bool bnet_tls_client(TLS_CONTEXT *ctx, BSOCK * bsock, alist *verify_list)
279 JCR *jcr = bsock->jcr();
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(jcr, 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(jcr, tls, bsock->host())) {
305 Qmsg1(bsock->jcr(), M_FATAL, 0, _("TLS host certificate verification failed. Host name \"%s\" did not match presented certificate\n"),
310 Dmsg0(50, "TLS client negotiation established.\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)
344 return bsock->wait_data(sec);
348 * As above, but returns on interrupt
350 int bnet_wait_data_intr(BSOCK * bsock, int sec)
352 return bsock->wait_data_intr(sec);
355 #ifndef NETDB_INTERNAL
356 #define NETDB_INTERNAL -1 /* See errno. */
358 #ifndef NETDB_SUCCESS
359 #define NETDB_SUCCESS 0 /* No problem. */
361 #ifndef HOST_NOT_FOUND
362 #define HOST_NOT_FOUND 1 /* Authoritative Answer Host not found. */
365 #define TRY_AGAIN 2 /* Non-Authoritative Host not found, or SERVERFAIL. */
368 #define NO_RECOVERY 3 /* Non recoverable errors, FORMERR, REFUSED, NOTIMP. */
371 #define NO_DATA 4 /* Valid name, no data record of requested type. */
375 * Get human readable error for gethostbyname()
377 static const char *gethost_strerror()
383 msg = be.bstrerror();
386 msg = _("No problem.");
389 msg = _("Authoritative answer for host not found.");
392 msg = _("Non-authoritative for host not found, or ServerFail.");
395 msg = _("Non-recoverable errors, FORMERR, REFUSED, or NOTIMP.");
398 msg = _("Valid name, no data record of resquested type.");
401 msg = _("Unknown error.");
409 static IPADDR *add_any(int family)
411 IPADDR *addr = New(IPADDR(family));
412 addr->set_type(IPADDR::R_MULTIPLE);
413 addr->set_addr_any();
417 static const char *resolv_host(int family, const char *host, dlist * addr_list)
422 P(ip_mutex); /* gethostbyname() is not thread safe */
423 #ifdef HAVE_GETHOSTBYNAME2
424 if ((hp = gethostbyname2(host, family)) == NULL) {
426 if ((hp = gethostbyname(host)) == NULL) {
428 /* may be the strerror give not the right result -:( */
429 errmsg = gethost_strerror();
434 for (p = hp->h_addr_list; *p != 0; p++) {
435 IPADDR *addr = New(IPADDR(hp->h_addrtype));
436 addr->set_type(IPADDR::R_MULTIPLE);
437 if (addr->get_family() == AF_INET) {
438 addr->set_addr4((struct in_addr*)*p);
442 addr->set_addr6((struct in6_addr*)*p);
445 addr_list->append(addr);
453 * i host = 0 mean INADDR_ANY only ipv4
455 dlist *bnet_host2ipaddrs(const char *host, int family, const char **errstr)
457 struct in_addr inaddr;
461 struct in6_addr inaddr6;
464 dlist *addr_list = New(dlist(addr, &addr->link));
465 if (!host || host[0] == '\0') {
467 addr_list->append(add_any(family));
469 addr_list->append(add_any(AF_INET));
471 addr_list->append(add_any(AF_INET6));
474 } else if (inet_aton(host, &inaddr)) { /* MA Bug 4 */
475 addr = New(IPADDR(AF_INET));
476 addr->set_type(IPADDR::R_MULTIPLE);
477 addr->set_addr4(&inaddr);
478 addr_list->append(addr);
481 if (inet_pton(AF_INET6, host, &inaddr6) > 1) {
482 addr = New(IPADDR(AF_INET6));
483 addr->set_type(IPADDR::R_MULTIPLE);
484 addr->set_addr6(&inaddr6);
485 addr_list->append(addr);
490 errmsg = resolv_host(family, host, addr_list);
493 free_addresses(addr_list);
498 /* We try to resolv host for ipv6 and ipv4, the connection procedure
499 * will try to reach the host for each protocols. We report only "Host
500 * not found" ipv4 message (no need to have ipv6 and ipv4 messages).
502 resolv_host(AF_INET6, host, addr_list);
504 errmsg = resolv_host(AF_INET, host, addr_list);
506 if (addr_list->size() == 0) {
508 free_addresses(addr_list);
517 * This is the "old" way of opening a connection. The preferred way is
518 * now to do what this subroutine does, but inline. That allows the
519 * connect() call to return error status, ...
521 BSOCK *bnet_connect(JCR * jcr, int retry_interval, utime_t max_retry_time,
523 const char *name, char *host, char *service, int port,
526 BSOCK *bsock = new_bsock();
527 if (!bsock->connect(jcr, retry_interval, max_retry_time, heart_beat,
528 name, host, service, port, verbose)) {
538 * Return the string for the error that occurred
539 * on the socket. Only the first error is retained.
541 const char *bnet_strerror(BSOCK * bsock)
543 return bsock->bstrerror();
547 * Format and send a message
548 * Returns: false on error
551 bool bnet_fsend(BSOCK * bs, const char *fmt, ...)
556 if (bs->errors || bs->is_terminated()) {
559 /* This probably won't work, but we vsnprintf, then if we
560 * get a negative length or a length greater than our buffer
561 * (depending on which library is used), the printf was truncated, so
562 * get a bigger buffer and try again.
565 maxlen = sizeof_pool_memory(bs->msg) - 1;
566 va_start(arg_ptr, fmt);
567 bs->msglen = bvsnprintf(bs->msg, maxlen, fmt, arg_ptr);
569 if (bs->msglen > 0 && bs->msglen < (maxlen - 5)) {
572 bs->msg = realloc_pool_memory(bs->msg, maxlen + maxlen / 2);
577 int bnet_get_peer(BSOCK *bs, char *buf, socklen_t buflen)
579 return bs->get_peer(buf, buflen);
583 * Set the network buffer size, suggested size is in size.
584 * Actual size obtained is returned in bs->msglen
586 * Returns: 0 on failure
589 bool bnet_set_buffer_size(BSOCK * bs, uint32_t size, int rw)
591 return bs->set_buffer_size(size, rw);
595 * Set socket non-blocking
596 * Returns previous socket flag
598 int bnet_set_nonblocking(BSOCK *bsock)
600 return bsock->set_nonblocking();
604 * Set socket blocking
605 * Returns previous socket flags
607 int bnet_set_blocking(BSOCK *bsock)
609 return bsock->set_blocking();
613 * Restores socket flags
615 void bnet_restore_blocking (BSOCK *bsock, int flags)
617 bsock->restore_blocking(flags);
622 * Send a network "signal" to the other end
623 * This consists of sending a negative packet length
625 * Returns: false on failure
628 bool bnet_sig(BSOCK * bs, int signal)
630 return bs->signal(signal);
634 * Convert a network "signal" code into
635 * human readable ASCII.
637 const char *bnet_sig_to_ascii(BSOCK * bs)
640 switch (bs->msglen) {
642 return "BNET_EOD"; /* end of data stream */
644 return "BNET_EOD_POLL";
646 return "BNET_STATUS";
648 return "BNET_TERMINATE"; /* terminate connection */
652 return "BNET_HEARTBEAT";
653 case BNET_HB_RESPONSE:
654 return "BNET_HB_RESPONSE";
656 return "BNET_PROMPT";
658 sprintf(buf, _("Unknown sig %d"), (int)bs->msglen);
663 /* Initialize internal socket structure.
664 * This probably should be done in net_open
666 BSOCK *init_bsock(JCR * jcr, int sockfd, const char *who, const char *host, int port,
667 struct sockaddr *client_addr)
669 Dmsg3(100, "who=%s host=%s port=%d\n", who, host, port);
670 BSOCK *bsock = (BSOCK *)malloc(sizeof(BSOCK));
671 memset(bsock, 0, sizeof(BSOCK));
672 bsock->m_fd = sockfd;
675 bsock->m_blocking = 1;
676 bsock->msg = get_pool_memory(PM_MESSAGE);
677 bsock->errmsg = get_pool_memory(PM_MESSAGE);
678 bsock->set_who(bstrdup(who));
679 bsock->set_host(bstrdup(host));
680 bsock->set_port(port);
681 memset(&bsock->peer_addr, 0, sizeof(bsock->peer_addr));
682 memcpy(&bsock->client_addr, client_addr, sizeof(bsock->client_addr));
684 * ****FIXME**** reduce this to a few hours once
685 * heartbeats are implemented
687 bsock->timeout = 60 * 60 * 6 * 24; /* 6 days timeout */
692 BSOCK *dup_bsock(BSOCK *osock)
694 BSOCK *bsock = (BSOCK *)malloc(sizeof(BSOCK));
695 memcpy(bsock, osock, sizeof(BSOCK));
696 bsock->msg = get_pool_memory(PM_MESSAGE);
697 bsock->errmsg = get_pool_memory(PM_MESSAGE);
699 bsock->set_who(bstrdup(osock->who()));
702 bsock->set_host(bstrdup(osock->host()));
704 if (osock->src_addr) {
705 bsock->src_addr = New( IPADDR( *(osock->src_addr)) );
711 /* Close the network connection */
712 void bnet_close(BSOCK * bsock)
717 void term_bsock(BSOCK * bsock)