1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634
|
/*
* Copyright (C), 2000-2006 by the monit project group.
* All Rights Reserved.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License as
* published by the Free Software Foundation; either version 2 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software Foundation,
* Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
#include "config.h"
#ifdef HAVE_SYS_TYPES_H
#include <sys/types.h>
#endif
#ifdef HAVE_STRING_H
#include <string.h>
#endif
#ifdef HAVE_SYS_SOCKET_H
#include <sys/socket.h>
#endif
#ifdef HAVE_STRINGS_H
#include <strings.h>
#endif
#ifdef HAVE_UNISTD_H
#include <unistd.h>
#endif
#include "net.h"
#include "ssl.h"
#include "monitor.h"
#include "socket.h"
/**
* Implementation of the socket interface.
*
* @author Jan-Henrik Haukeland, <hauk@tildeslash.com>
* @version \$Id: socket.c,v 1.56 2006/01/01 22:44:02 martinp Exp $
* @file
*/
/* ------------------------------------------------------------- Definitions */
#define TYPE_LOCAL 0
#define TYPE_ACCEPT 1
#define RBUFFER_SIZE 1024
struct Socket_T {
int port;
int type;
int socket;
char *host;
Port_T Port;
int timeout;
int connection_type;
ssl_connection *ssl;
ssl_server_connection *sslserver;
int length;
int offset;
unsigned char buffer[RBUFFER_SIZE+1];
};
/* -------------------------------------------------------------- Prototypes */
static int fill(Socket_T S, int timeout);
/* ------------------------------------------------------------------ Public */
/**
* Create a new Socket opened against host:port. The returned Socket
* is a connected socket. This method can be used to create either TCP
* or UDP sockets and the type parameter is used to select the socket
* type. If the use_ssl parameter is TRUE the socket is created using
* SSL. Only TCP sockets may use SSL.
* @param host The remote host to open the Socket against. The host
* may be a hostname found in the DNS or an IP address string.
* @param port The port number to connect to
* @param type The socket type to use (SOCKET_TCP or SOCKET_UPD)
* @param use_ssl If TRUE the socket is created supporting SSL
* @param timeout The timeout value in seconds
* @return The connected Socket or NULL if an error occurred
*/
Socket_T socket_new(const char *host, int port, int type, int use_ssl,
int timeout) {
Ssl_T ssl= {use_ssl, SSL_VERSION_AUTO, NULL};
return socket_create_t(host, port, type, ssl, timeout);
}
/**
* Factory method for creating a new Socket from a monit Port object
* @param port The port object to create a socket from
* @return The connected Socket or NULL if an error occurred
*/
Socket_T socket_create(void *port) {
int s;
Port_T p= port;
ASSERT(port);
if((s= create_generic_socket(p)) != -1) {
Socket_T S= NULL;
NEW(S);
S->socket= s;
S->length= 0;
S->offset= 0;
S->type= p->type;
S->port= p->port;
S->timeout= p->timeout;
S->connection_type= TYPE_LOCAL;
if(p->family==AF_UNIX) {
S->host= xstrdup(LOCALHOST);
} else {
S->host= xstrdup(p->hostname);
}
if(p->SSL.use_ssl) {
if(! (S->ssl= new_ssl_connection(NULL, p->SSL.version))) {
goto ssl_error;
}
if(! embed_ssl_socket(S->ssl, S->socket)) {
goto ssl_error;
}
if(p->SSL.certmd5) {
if(! check_ssl_md5sum(S->ssl, p->SSL.certmd5)) {
goto ssl_error;
}
}
}
S->Port= port;
return S;
ssl_error:
socket_free(&S);
return NULL;
}
return NULL;
}
/**
* Create a new Socket opened against host:port with an explicit
* ssl value for connect and read. Otherwise, same as socket_new()
* @param host The remote host to open the Socket against. The host
* may be a hostname found in the DNS or an IP address string.
* @param port The port number to connect to
* @param type The socket type to use (SOCKET_TCP or SOCKET_UPD)
* @param use_ssl if TRUE the socket is created supporting SSL
* @param timeout The timeout value in seconds
* @return The connected Socket or NULL if an error occurred
*/
Socket_T socket_create_t(const char *host, int port, int type, Ssl_T ssl,
int timeout) {
int s;
int proto= type==SOCKET_UDP?SOCK_DGRAM:SOCK_STREAM;
ASSERT(host);
ASSERT((type==SOCKET_UDP)||(type==SOCKET_TCP));
if(ssl.use_ssl) {
ASSERT(type==SOCKET_TCP);
}
ASSERT(timeout>0);
if((s= create_socket(host, port, proto, timeout)) != -1) {
Socket_T S= NULL;
NEW(S);
S->socket= s;
S->length= 0;
S->offset= 0;
S->port= port;
S->type= proto;
S->timeout= timeout;
S->host= xstrdup(host);
S->connection_type= TYPE_LOCAL;
if(ssl.use_ssl) {
if(! (S->ssl= new_ssl_connection(NULL, ssl.version))) {
goto ssl_error;
}
if(! embed_ssl_socket(S->ssl, S->socket)) {
goto ssl_error;
}
if(ssl.certmd5) {
if(! check_ssl_md5sum(S->ssl, ssl.certmd5)) {
goto ssl_error;
}
}
}
return S;
ssl_error:
socket_free(&S);
return NULL;
}
return NULL;
}
/**
* Factory method for creating a Socket object from an accepted
* socket. The given socket must be a socket created from accept(2).
* If the sslserver context is non-null the socket will support
* ssl. This method does only support TCP sockets.
* @param socket The accepted socket
* @param remote_host The remote host from where the socket connection
* originated
* @param port The localhost port number from where the connection
* arrived.
* @param sslserver A ssl server connection context, may be NULL
* @return A Socket or NULL if an error occurred
*/
Socket_T socket_create_a(int socket, const char *remote_host,
int port, void *sslserver) {
Socket_T S;
ASSERT(socket>=0);
ASSERT(remote_host);
NEW(S);
S->length= 0;
S->offset= 0;
S->port= port;
S->socket= socket;
S->type= SOCK_STREAM;
S->timeout= NET_TIMEOUT;
S->host= xstrdup(remote_host);
S->connection_type= TYPE_ACCEPT;
if(sslserver) {
S->sslserver= sslserver;
if(! (S->ssl= insert_accepted_ssl_socket(S->sslserver))) {
goto ssl_error;
}
if(! embed_accepted_ssl_socket(S->ssl, S->socket)) {
goto ssl_error;
}
}
return S;
ssl_error:
socket_free(&S);
return NULL;
}
/**
* Destroy a Socket object. Close the socket and release allocated
* resources.
* @param S A Socket object reference
*/
void socket_free(Socket_T *S) {
ASSERT(S && *S);
#ifdef HAVE_OPENSSL
if((*S)->ssl && (*S)->ssl->handler) {
if((*S)->connection_type==TYPE_LOCAL) {
close_ssl_socket((*S)->ssl);
delete_ssl_socket((*S)->ssl);
} else if((*S)->connection_type==TYPE_ACCEPT && (*S)->sslserver) {
close_accepted_ssl_socket((*S)->sslserver, (*S)->ssl);
}
}
#endif
close_socket((*S)->socket);
FREE((*S)->host);
FREE(*S);
}
/* ------------------------------------------------------------ Properties */
/**
* Returns TRUE if the socket is ready for i|o
* @param S A Socket object
* @return TRUE if the socket is ready otherwise FALSE
*/
int socket_is_ready(Socket_T S) {
ASSERT(S);
switch(S->type) {
case SOCK_STREAM:
return check_socket(S->socket);
case SOCK_DGRAM:
return check_udp_socket(S->socket);
default:
break;
}
return FALSE;
}
/**
* Get the underlying socket descriptor
* @param S A Socket object
* @return The socket descriptor
*/
int socket_get_socket(Socket_T S) {
ASSERT(S);
return S->socket;
}
/**
* Get the type of this socket.
* @param S A Socket object
* @return The socket type
*/
int socket_get_type(Socket_T S) {
ASSERT(S);
return S->type;
}
/**
* Get the Port object used to create this socket. If no Port object
* was used this method returns NULL.
* @param S A Socket object
* @return The Port object or NULL
*/
void *socket_get_Port(Socket_T S) {
ASSERT(S);
return S->Port;
}
/**
* Get the remote port number the socket is connected to
* @param S A Socket object
* @return The remote host's port number
*/
int socket_get_remote_port(Socket_T S) {
ASSERT(S);
return S->port;
}
/**
* Get the remote host this socket is connected to. The host is either
* a host name in DNS or an IP address string.
* @param S A Socket object
* @return The remote host
*/
const char *socket_get_remote_host(Socket_T S) {
ASSERT(S);
return S->host;
}
/* ---------------------------------------------------------------- Public */
/**
* Writes a character string. Use this function to send text based
* messages to a client.
* @param S A Socket_T object
* @param m A String to send to the client
* @return The bytes sent or -1 if an error occured
*/
int socket_print(Socket_T S, const char *m, ...) {
int n;
long l;
va_list ap;
char *buf= NULL;
ASSERT(S);
ASSERT(m);
va_start(ap, m);
buf= Util_formatString(m, ap, &l);
va_end(ap);
n= socket_write(S, buf, l);
FREE(buf);
return n;
}
/**
* Write size bytes from the buffer b.
* @param S A Socket_T object
* @param b The data to be written
* @param size The size of the data in b
* @return The bytes sent or -1 if an error occured
*/
int socket_write(Socket_T S, void *b, int size) {
int n= 0;
void *p= b;
ASSERT(S);
/* Clear any extra data read from the server */
socket_reset(S);
while(size > 0) {
if(S->ssl) {
n= send_ssl_socket(S->ssl, p, size, S->timeout);
} else {
if(S->type==SOCK_DGRAM)
n= udp_write(S->socket, p, size, S->timeout);
else
n= sock_write(S->socket, p, size, S->timeout);
}
if(n <= 0) break;
p+= n;
size-= n;
}
if(n < 0) {
/* No write or a partial write is an error */
return -1;
}
return (int)(p - b);
}
/**
* Read a single byte. The byte is returned as an int in the range 0
* to 255.
* @param S A Socket_T object
* @return The byte read, or -1 if the end of the stream has been reached
*/
int socket_read_byte(Socket_T S) {
ASSERT(S);
if(S->offset >= S->length) {
if(fill(S, S->timeout) <= 0)
return -1;
}
return S->buffer[S->offset++];
}
/**
* Reads size bytes and stores them into the byte buffer pointed to by b.
* @param S A Socket_T object
* @param b A Byte buffer
* @param size The size of the buffer b
* @return The bytes read or -1 if an error occured
*/
int socket_read(Socket_T S, void *b, int size) {
int c;
unsigned char *p= b;
ASSERT(S);
while((size-- > 0) && ((c= socket_read_byte(S)) >= 0)) {
*p++= c;
}
return (int)p - (int)b;
}
/**
* Reads in at most one less than size <code>characters</code> and
* stores them into the buffer pointed to by s. Reading stops after
* an EOF or a newline. If a newline is read, it is stored into the
* buffer. A '\0' is stored after the last character in the buffer.
* @param S A Socket_T object
* @param s A character buffer to store the string in
* @param size The size of the string buffer, s
* @return s on success, and NULL on error or when end of file occurs
* while no characters have been read.
*/
char *socket_readln(Socket_T S, char *s, int size) {
int c;
unsigned char *p= (unsigned char *)s;
ASSERT(S);
while(--size && ((c= socket_read_byte(S)) > 0)) {
*p++= c;
if(c == '\n' || c == '\0')
break;
}
*p= 0;
if(*s)
return s;
return NULL;
}
/**
* Clears any data that exists in the input buffer
* @param S A Socket_T object
*/
void socket_reset(Socket_T S) {
ASSERT(S);
/* Also throw away any pending incomming data */
while(fill(S, 0) > 0);
S->offset= 0;
S->length= 0;
}
/* --------------------------------------------------------------- Private */
/*
* Fill the internal buffer. If an error occurs or if the read
* operation timed out -1 is returned.
* @param S A Socket object
* @param timeout The number of seconds to wait for data to be read
* @return TRUE (the length of data read) or -1 if an error occured
*/
static int fill(Socket_T S, int timeout) {
int n;
S->offset= 0;
S->length= 0;
/* Optimizing, assuming a request/response pattern and that a udp_write
was issued before we are called, we don't have to wait for data */
if(S->type==SOCK_DGRAM) timeout= 0;
/* Read as much as we can, but only block on the first read */
while(RBUFFER_SIZE > S->length) {
if(S->ssl) {
n= recv_ssl_socket(S->ssl, &S->buffer[S->length],
RBUFFER_SIZE-S->length, timeout);
} else {
n= sock_read(S->socket, &S->buffer[S->length],
RBUFFER_SIZE-S->length, timeout);
}
timeout= 0;
if(n > 0) {
S->length+= n;
continue;
}
if(n==0) break;
if(n < 0) {
if(errno == EAGAIN || errno == EWOULDBLOCK || S->type==SOCK_DGRAM) break;
return -1;
}
}
return S->length;
}
|