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
|
/* Copyright (C) CZ.NIC, z.s.p.o. <knot-resolver@labs.nic.cz>
* SPDX-License-Identifier: GPL-3.0-or-later
*/
/**
* @file hints.c
* @brief Constructed zone cut from the hosts-like file, see @zonecut.h
*
* The module provides an override for queried address records.
*/
#include <libknot/packet/pkt.h>
#include <libknot/descriptor.h>
#include <ccan/json/json.h>
#include <ucw/mempool.h>
#include <contrib/cleanup.h>
#include <lauxlib.h>
#include "daemon/engine.h"
#include "lib/zonecut.h"
#include "lib/module.h"
#include "lib/layer.h"
#include "lib/rules/api.h"
#include <inttypes.h>
#include <math.h>
/* Defaults */
#define VERBOSE_MSG(qry, ...) kr_log_q(qry, HINT, __VA_ARGS__)
#define ERR_MSG(...) kr_log_error(HINT, "[ ]" __VA_ARGS__)
struct hints_data {
bool use_nodata; /**< See hint_use_nodata() description, exposed via lua. */
uint32_t ttl; /**< TTL used for the hints, exposed via lua. */
kr_rule_opts_t opts; /**< Options used for local-data rules. Not overridable yet. */
};
/** Useful for returning from module properties. */
static char * bool2jsonstr(bool val)
{
char *result = NULL;
if (-1 == asprintf(&result, "{ \"result\": %s }", val ? "true" : "false"))
result = NULL;
return result;
}
static int parse_addr_str(union kr_sockaddr *sa, const char *addr)
{
int family = strchr(addr, ':') ? AF_INET6 : AF_INET;
memset(sa, 0, sizeof(*sa));
sa->ip.sa_family = family;
char *addr_bytes = (/*const*/char *)kr_inaddr(&sa->ip);
if (inet_pton(family, addr, addr_bytes) != 1) {
return kr_error(EILSEQ);
}
return 0;
}
static int add_pair_root(struct kr_zonecut *hints, const char *name, const char *addr)
{
/* Build key */
knot_dname_t key[KNOT_DNAME_MAXLEN];
if (!knot_dname_from_str(key, name, sizeof(key))) {
return kr_error(EINVAL);
}
knot_dname_to_lower(key);
union kr_sockaddr ia;
if (parse_addr_str(&ia, addr) != 0) {
return kr_error(EINVAL);
}
return kr_zonecut_add(hints, key, kr_inaddr(&ia.ip), kr_inaddr_len(&ia.ip));
}
static char* hint_add_hosts(void *env, struct kr_module *module, const char *args)
{
if (!args)
args = "/etc/hosts";
const struct hints_data *data = module->data;
int err = kr_rule_local_hosts(args, data->use_nodata, data->ttl,
KR_RULE_TAGS_ALL, data->opts);
return bool2jsonstr(err == kr_ok());
}
/**
* Set name => address hint.
*
* Input: { name, address }
* Output: { result: bool }
*
*/
static char* hint_set(void *env, struct kr_module *module, const char *args)
{
struct hints_data *data = module->data;
if (!args)
return NULL;
auto_free char *args_copy = strdup(args);
if (!args_copy)
return NULL;
int ret = -1;
char *addr = strchr(args_copy, ' ');
if (addr) {
*addr = '\0';
++addr;
ret = kr_rule_local_address(args_copy, addr,
data->use_nodata, data->ttl, KR_RULE_TAGS_ALL, data->opts);
}
return bool2jsonstr(ret == 0);
}
static char* hint_del(void *env, struct kr_module *module, const char *args)
{
struct hints_data *data = module->data;
if (!args)
return NULL;
auto_free char *args_copy = strdup(args);
if (!args_copy)
return NULL;
int ret = -1;
char *addr = strchr(args_copy, ' ');
if (addr) {
*addr = '\0';
++addr;
}
ret = kr_rule_local_address_del(args_copy, addr, data->use_nodata, KR_RULE_TAGS_ALL);
if (ret)
VERBOSE_MSG(NULL, "hints.del(%s) error: %s\n", args, kr_strerror(ret));
return bool2jsonstr(ret == 0);
}
/** @internal Pack address list into JSON array. */
static JsonNode *pack_addrs(pack_t *pack)
{
char buf[INET6_ADDRSTRLEN];
JsonNode *root = json_mkarray();
uint8_t *addr = pack_head(*pack);
while (addr != pack_tail(*pack)) {
size_t len = pack_obj_len(addr);
int family = len == sizeof(struct in_addr) ? AF_INET : AF_INET6;
if (!inet_ntop(family, pack_obj_val(addr), buf, sizeof(buf))) {
break;
}
json_append_element(root, json_mkstring(buf));
addr = pack_obj_next(addr);
}
return root;
}
/**
* Retrieve address hints, either for given name or for all names.
*
* Input: name
* Output: NULL or "{ address1, address2, ... }"
*/
static char* hint_get(void *env, struct kr_module *module, const char *args)
{
return NULL;
}
/** @internal Pack all hints into serialized JSON. */
static char* pack_hints(struct kr_zonecut *hints) {
char *result = NULL;
JsonNode *root_node = json_mkobject();
trie_it_t *it;
for (it = trie_it_begin(hints->nsset); !trie_it_finished(it); trie_it_next(it)) {
KR_DNAME_GET_STR(nsname_str, (const knot_dname_t *)trie_it_key(it, NULL));
JsonNode *addr_list = pack_addrs((pack_t *)*trie_it_val(it));
if (!addr_list) goto error;
json_append_member(root_node, nsname_str, addr_list);
}
result = json_encode(root_node);
error:
trie_it_free(it);
json_delete(root_node);
return result;
}
static void unpack_hint(struct kr_zonecut *root_hints, JsonNode *table, const char *name)
{
JsonNode *node = NULL;
json_foreach(node, table) {
switch(node->tag) {
case JSON_STRING:
add_pair_root(root_hints, name ? name : node->key, node->string_);
break;
case JSON_ARRAY:
unpack_hint(root_hints, node, name ? name : node->key);
break;
default: continue;
}
}
}
/**
* Get/set root hints set.
*
* Input: { name: [addr_list], ... }
* Output: current list
*
*/
static char* hint_root(void *env, struct kr_module *module, const char *args)
{
struct kr_zonecut *root_hints = &the_resolver->root_hints;
/* Replace root hints if parameter is set */
if (args && args[0] != '\0') {
JsonNode *root_node = json_decode(args);
kr_zonecut_set(root_hints, (const uint8_t *)"");
unpack_hint(root_hints, root_node, NULL);
json_delete(root_node);
}
/* Return current root hints */
return pack_hints(root_hints);
}
static char* hint_root_file(void *env, struct kr_module *module, const char *args)
{
const char *err_msg = engine_hint_root_file(args);
if (err_msg) {
luaL_error(the_engine->L, "error when opening '%s': %s", args, err_msg);
}
return strdup(err_msg ? err_msg : "");
}
static char* hint_use_nodata(void *env, struct kr_module *module, const char *args)
{
struct hints_data *data = module->data;
if (!args) {
return NULL;
}
JsonNode *root_node = json_decode(args);
if (!root_node || root_node->tag != JSON_BOOL) {
json_delete(root_node);
return bool2jsonstr(false);
}
data->use_nodata = root_node->bool_;
json_delete(root_node);
return bool2jsonstr(true);
}
static char* hint_ttl(void *env, struct kr_module *module, const char *args)
{
struct hints_data *data = module->data;
/* Do no change on nonsense TTL values (incl. suspicious floats). */
JsonNode *root_node = args ? json_decode(args) : NULL;
if (root_node && root_node->tag == JSON_NUMBER) {
double ttl_d = root_node->number_;
uint32_t ttl = (uint32_t)round(ttl_d);
if (ttl_d >= 0 && fabs(ttl_d - ttl) * 64 < 1) {
data->ttl = ttl;
}
}
json_delete(root_node);
/* Always return the current TTL setting. Plain number is valid JSON. */
char *result = NULL;
if (-1 == asprintf(&result, "%"PRIu32, data->ttl)) {
result = NULL;
}
return result;
}
/** Basic initialization: get a memory pool, etc. */
KR_EXPORT
int hints_init(struct kr_module *module)
{
static kr_layer_api_t layer = { 0 };
/* Store module reference */
layer.data = module;
module->layer = &layer;
static const struct kr_prop props[] = {
/* TODO(decide): .del() used to work on individual RRs;
* now it deletes whole RRsets. Also, .get() doesn't work at all.
*
* We'll probably be deprecating access direct through these non-declarative
* commands (set, get, del) which are also usable dynamically.
*
* For .set() and .add_hosts() see the RW transaction note at kr_rule_local_data_merge()
*/
{ &hint_set, "set", "Set {name, address} hint.", },
{ &hint_del, "del", "Delete one {name, address} hint or all addresses for the name.", },
{ &hint_get, "get", "Retrieve hint for given name.", },
{ &hint_ttl, "ttl", "Set/get TTL used for the hints.", },
{ &hint_add_hosts, "add_hosts", "Load a file with hosts-like formatting and add contents into hints.", },
{ &hint_root, "root", "Replace root hints set (empty value to return current list).", },
{ &hint_root_file, "root_file", "Replace root hints set from a zonefile.", },
{ &hint_use_nodata, "use_nodata", "Synthesise NODATA if name matches, but type doesn't. True by default.", },
{ NULL, NULL, NULL }
};
module->props = props;
struct hints_data *data = malloc(sizeof(*data));
if (!data)
return kr_error(ENOMEM);
data->use_nodata = true;
data->ttl = KR_RULE_TTL_DEFAULT;
data->opts = KR_RULE_OPTS_DEFAULT;
module->data = data;
return kr_ok();
}
/** Release all resources. */
KR_EXPORT
int hints_deinit(struct kr_module *module)
{
free(module->data);
module->data = NULL;
return kr_ok();
}
/** Drop all hints, and load a hosts file if any was specified.
*
* It seems slightly strange to drop all, but keep doing that for now.
*/
KR_EXPORT
int hints_config(struct kr_module *module, const char *conf)
{
hints_deinit(module);
int err = hints_init(module);
if (err != kr_ok()) {
return err;
}
if (conf && conf[0]) {
const struct hints_data *data = module->data;
return kr_rule_local_hosts(conf,
data->use_nodata, data->ttl, KR_RULE_TAGS_ALL, data->opts);
}
return kr_ok();
}
KR_MODULE_EXPORT(hints)
#undef VERBOSE_MSG
|