1 /* 2 * daemon/remote.h - remote control for the unbound daemon. 3 * 4 * Copyright (c) 2008, NLnet Labs. All rights reserved. 5 * 6 * This software is open source. 7 * 8 * Redistribution and use in source and binary forms, with or without 9 * modification, are permitted provided that the following conditions 10 * are met: 11 * 12 * Redistributions of source code must retain the above copyright notice, 13 * this list of conditions and the following disclaimer. 14 * 15 * Redistributions in binary form must reproduce the above copyright notice, 16 * this list of conditions and the following disclaimer in the documentation 17 * and/or other materials provided with the distribution. 18 * 19 * Neither the name of the NLNET LABS nor the names of its contributors may 20 * be used to endorse or promote products derived from this software without 21 * specific prior written permission. 22 * 23 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 24 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 25 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 26 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 27 * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 28 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED 29 * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 30 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF 31 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING 32 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 33 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 34 */ 35 36 /** 37 * \file 38 * 39 * This file contains the remote control functionality for the daemon. 40 * The remote control can be performed using either the commandline 41 * unbound-control tool, or a SSLv3/TLS capable web browser. 42 * The channel is secured using SSLv3 or TLSv1, and certificates. 43 * Both the server and the client(control tool) have their own keys. 44 */ 45 46 #ifndef DAEMON_REMOTE_H 47 #define DAEMON_REMOTE_H 48 #ifdef HAVE_OPENSSL_SSL_H 49 #include "openssl/ssl.h" 50 #endif 51 struct config_file; 52 struct listen_list; 53 struct listen_port; 54 struct worker; 55 struct comm_reply; 56 struct comm_point; 57 struct daemon_remote; 58 59 /** number of seconds timeout on incoming remote control handshake */ 60 #define REMOTE_CONTROL_TCP_TIMEOUT 120 61 62 /** 63 * a busy control command connection, SSL state 64 */ 65 struct rc_state { 66 /** the next item in list */ 67 struct rc_state* next; 68 /** the commpoint */ 69 struct comm_point* c; 70 /** in the handshake part */ 71 enum { rc_none, rc_hs_read, rc_hs_write } shake_state; 72 #ifdef HAVE_SSL 73 /** the ssl state */ 74 SSL* ssl; 75 #endif 76 /** the rc this is part of */ 77 struct daemon_remote* rc; 78 }; 79 80 /** 81 * The remote control tool state. 82 * The state is only created for the first thread, other threads 83 * are called from this thread. Only the first threads listens to 84 * the control port. The other threads do not, but are called on the 85 * command channel(pipe) from the first thread. 86 */ 87 struct daemon_remote { 88 /** the worker for this remote control */ 89 struct worker* worker; 90 /** commpoints for accepting remote control connections */ 91 struct listen_list* accept_list; 92 /* if certificates are used */ 93 int use_cert; 94 /** number of active commpoints that are handling remote control */ 95 int active; 96 /** max active commpoints */ 97 int max_active; 98 /** current commpoints busy; should be a short list, malloced */ 99 struct rc_state* busy_list; 100 #ifdef HAVE_SSL 101 /** the SSL context for creating new SSL streams */ 102 SSL_CTX* ctx; 103 #endif 104 }; 105 106 /** 107 * Create new remote control state for the daemon. 108 * @param cfg: config file with key file settings. 109 * @return new state, or NULL on failure. 110 */ 111 struct daemon_remote* daemon_remote_create(struct config_file* cfg); 112 113 /** 114 * remote control state to delete. 115 * @param rc: state to delete. 116 */ 117 void daemon_remote_delete(struct daemon_remote* rc); 118 119 /** 120 * remote control state to clear up. Busy and accept points are closed. 121 * Does not delete the rc itself, or the ssl context (with its keys). 122 * @param rc: state to clear. 123 */ 124 void daemon_remote_clear(struct daemon_remote* rc); 125 126 /** 127 * Open and create listening ports for remote control. 128 * @param cfg: config options. 129 * @return list of ports or NULL on failure. 130 * can be freed with listening_ports_free(). 131 */ 132 struct listen_port* daemon_remote_open_ports(struct config_file* cfg); 133 134 /** 135 * Setup comm points for accepting remote control connections. 136 * @param rc: state 137 * @param ports: already opened ports. 138 * @param worker: worker with communication base. and links to command channels. 139 * @return false on error. 140 */ 141 int daemon_remote_open_accept(struct daemon_remote* rc, 142 struct listen_port* ports, struct worker* worker); 143 144 /** 145 * Stop accept handlers for TCP (until enabled again) 146 * @param rc: state 147 */ 148 void daemon_remote_stop_accept(struct daemon_remote* rc); 149 150 /** 151 * Stop accept handlers for TCP (until enabled again) 152 * @param rc: state 153 */ 154 void daemon_remote_start_accept(struct daemon_remote* rc); 155 156 /** 157 * Handle nonthreaded remote cmd execution. 158 * @param worker: this worker (the remote worker). 159 */ 160 void daemon_remote_exec(struct worker* worker); 161 162 #ifdef HAVE_SSL 163 /** 164 * Print fixed line of text over ssl connection in blocking mode 165 * @param ssl: print to 166 * @param text: the text. 167 * @return false on connection failure. 168 */ 169 int ssl_print_text(SSL* ssl, const char* text); 170 171 /** 172 * printf style printing to the ssl connection 173 * @param ssl: the SSL connection to print to. Blocking. 174 * @param format: printf style format string. 175 * @return success or false on a network failure. 176 */ 177 int ssl_printf(SSL* ssl, const char* format, ...) 178 ATTR_FORMAT(printf, 2, 3); 179 180 /** 181 * Read until \n is encountered 182 * If SSL signals EOF, the string up to then is returned (without \n). 183 * @param ssl: the SSL connection to read from. blocking. 184 * @param buf: buffer to read to. 185 * @param max: size of buffer. 186 * @return false on connection failure. 187 */ 188 int ssl_read_line(SSL* ssl, char* buf, size_t max); 189 #endif /* HAVE_SSL */ 190 191 #endif /* DAEMON_REMOTE_H */ 192