remote.h

Go to the documentation of this file.

/*
 * daemon/remote.h - remote control for the unbound daemon.
 *
 * Copyright (c) 2008, NLnet Labs. All rights reserved.
 *
 * This software is open source.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 
 * Redistributions of source code must retain the above copyright notice,
 * this list of conditions and the following disclaimer.
 * 
 * Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 * 
 * Neither the name of the NLNET LABS nor the names of its contributors may
 * be used to endorse or promote products derived from this software without
 * specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
 * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

 
#ifndef DAEMON_REMOTE_H
#define DAEMON_REMOTE_H
#ifdef HAVE_OPENSSL_SSL_H
#include "openssl/ssl.h"
#endif
struct config_file;
struct listen_list;
struct listen_port;
struct worker;
struct comm_reply;
struct comm_point;
struct daemon_remote;

#define REMOTE_CONTROL_TCP_TIMEOUT 120000

struct rc_state {
    struct rc_state* next;
    struct comm_point* c;
    enum { rc_none, rc_hs_read, rc_hs_write } shake_state;
#ifdef HAVE_SSL
    SSL* ssl;
#endif
        int fd;
    struct daemon_remote* rc;
};

struct daemon_remote {
    struct worker* worker;
    struct listen_list* accept_list;
    /* if certificates are used */
    int use_cert;
    int active;
    int max_active;
    struct rc_state* busy_list;
#ifdef HAVE_SSL
    SSL_CTX* ctx;
#endif
};

struct remote_stream {
#ifdef HAVE_SSL
    SSL* ssl;
#endif
    int fd;
};
typedef struct remote_stream RES;

struct daemon_remote* daemon_remote_create(struct config_file* cfg);

void daemon_remote_delete(struct daemon_remote* rc);

void daemon_remote_clear(struct daemon_remote* rc);

struct listen_port* daemon_remote_open_ports(struct config_file* cfg);

int daemon_remote_open_accept(struct daemon_remote* rc, 
    struct listen_port* ports, struct worker* worker);

void daemon_remote_stop_accept(struct daemon_remote* rc);

void daemon_remote_start_accept(struct daemon_remote* rc);

void daemon_remote_exec(struct worker* worker);
 
#ifdef HAVE_SSL
int ssl_print_text(RES* ssl, const char* text);

int ssl_printf(RES* ssl, const char* format, ...)
        ATTR_FORMAT(printf, 2, 3);

int ssl_read_line(RES* ssl, char* buf, size_t max);
#endif /* HAVE_SSL */
 
#endif /* DAEMON_REMOTE_H */