Home | History | Annotate | Line # | Download | only in npf
npf_ctl.c revision 1.40.2.1
      1  1.40.2.1     skrll /*	$NetBSD: npf_ctl.c,v 1.40.2.1 2015/04/06 15:18:22 skrll Exp $	*/
      2       1.1     rmind 
      3       1.1     rmind /*-
      4      1.33     rmind  * Copyright (c) 2009-2014 The NetBSD Foundation, Inc.
      5       1.1     rmind  * All rights reserved.
      6       1.1     rmind  *
      7       1.1     rmind  * This material is based upon work partially supported by The
      8       1.1     rmind  * NetBSD Foundation under a contract with Mindaugas Rasiukevicius.
      9       1.1     rmind  *
     10       1.1     rmind  * Redistribution and use in source and binary forms, with or without
     11       1.1     rmind  * modification, are permitted provided that the following conditions
     12       1.1     rmind  * are met:
     13       1.1     rmind  * 1. Redistributions of source code must retain the above copyright
     14       1.1     rmind  *    notice, this list of conditions and the following disclaimer.
     15       1.1     rmind  * 2. Redistributions in binary form must reproduce the above copyright
     16       1.1     rmind  *    notice, this list of conditions and the following disclaimer in the
     17       1.1     rmind  *    documentation and/or other materials provided with the distribution.
     18       1.1     rmind  *
     19       1.1     rmind  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
     20       1.1     rmind  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
     21       1.1     rmind  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
     22       1.1     rmind  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
     23       1.1     rmind  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
     24       1.1     rmind  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
     25       1.1     rmind  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
     26       1.1     rmind  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
     27       1.1     rmind  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
     28       1.1     rmind  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     29       1.1     rmind  * POSSIBILITY OF SUCH DAMAGE.
     30       1.1     rmind  */
     31       1.1     rmind 
     32       1.1     rmind /*
     33       1.1     rmind  * NPF device control.
     34       1.1     rmind  *
     35       1.1     rmind  * Implementation of (re)loading, construction of tables and rules.
     36       1.1     rmind  * NPF proplib(9) dictionary consumer.
     37       1.1     rmind  */
     38       1.1     rmind 
     39       1.1     rmind #include <sys/cdefs.h>
     40  1.40.2.1     skrll __KERNEL_RCSID(0, "$NetBSD: npf_ctl.c,v 1.40.2.1 2015/04/06 15:18:22 skrll Exp $");
     41       1.1     rmind 
     42       1.1     rmind #include <sys/param.h>
     43       1.1     rmind #include <sys/conf.h>
     44      1.21     rmind #include <sys/kmem.h>
     45      1.21     rmind #include <net/bpf.h>
     46       1.1     rmind 
     47       1.1     rmind #include <prop/proplib.h>
     48       1.1     rmind 
     49       1.1     rmind #include "npf_impl.h"
     50      1.34     rmind #include "npf_conn.h"
     51       1.1     rmind 
     52      1.12     rmind #if defined(DEBUG) || defined(DIAGNOSTIC)
     53      1.12     rmind #define	NPF_ERR_DEBUG(e) \
     54      1.12     rmind 	prop_dictionary_set_cstring_nocopy((e), "source-file", __FILE__); \
     55      1.12     rmind 	prop_dictionary_set_uint32((e), "source-line", __LINE__);
     56      1.12     rmind #else
     57      1.12     rmind #define	NPF_ERR_DEBUG(e)
     58      1.12     rmind #endif
     59      1.12     rmind 
     60       1.1     rmind /*
     61       1.1     rmind  * npfctl_switch: enable or disable packet inspection.
     62       1.1     rmind  */
     63       1.1     rmind int
     64       1.1     rmind npfctl_switch(void *data)
     65       1.1     rmind {
     66       1.1     rmind 	const bool onoff = *(int *)data ? true : false;
     67       1.1     rmind 	int error;
     68       1.1     rmind 
     69       1.1     rmind 	if (onoff) {
     70       1.1     rmind 		/* Enable: add pfil hooks. */
     71      1.31     rmind 		error = npf_pfil_register(false);
     72       1.1     rmind 	} else {
     73       1.1     rmind 		/* Disable: remove pfil hooks. */
     74      1.31     rmind 		npf_pfil_unregister(false);
     75       1.1     rmind 		error = 0;
     76       1.1     rmind 	}
     77       1.1     rmind 	return error;
     78       1.1     rmind }
     79       1.1     rmind 
     80       1.6     rmind static int __noinline
     81      1.33     rmind npf_mk_table_entries(npf_table_t *t, prop_array_t entries)
     82      1.33     rmind {
     83      1.33     rmind 	prop_object_iterator_t eit;
     84      1.33     rmind 	prop_dictionary_t ent;
     85      1.33     rmind 	int error = 0;
     86      1.33     rmind 
     87      1.39     rmind 	if (prop_object_type(entries) != PROP_TYPE_ARRAY) {
     88      1.39     rmind 		return EINVAL;
     89      1.39     rmind 	}
     90      1.33     rmind 	eit = prop_array_iterator(entries);
     91      1.33     rmind 	while ((ent = prop_object_iterator_next(eit)) != NULL) {
     92      1.33     rmind 		const npf_addr_t *addr;
     93      1.33     rmind 		npf_netmask_t mask;
     94      1.33     rmind 		int alen;
     95      1.33     rmind 
     96      1.33     rmind 		/* Get address and mask.  Add a table entry. */
     97      1.33     rmind 		prop_object_t obj = prop_dictionary_get(ent, "addr");
     98      1.33     rmind 		addr = (const npf_addr_t *)prop_data_data_nocopy(obj);
     99      1.33     rmind 		prop_dictionary_get_uint8(ent, "mask", &mask);
    100      1.33     rmind 		alen = prop_data_size(obj);
    101      1.33     rmind 
    102      1.33     rmind 		error = npf_table_insert(t, alen, addr, mask);
    103      1.33     rmind 		if (error)
    104      1.33     rmind 			break;
    105      1.33     rmind 	}
    106      1.33     rmind 	prop_object_iterator_release(eit);
    107      1.33     rmind 	return error;
    108      1.33     rmind }
    109      1.33     rmind 
    110      1.33     rmind static int __noinline
    111      1.12     rmind npf_mk_tables(npf_tableset_t *tblset, prop_array_t tables,
    112      1.12     rmind     prop_dictionary_t errdict)
    113       1.1     rmind {
    114       1.1     rmind 	prop_object_iterator_t it;
    115       1.1     rmind 	prop_dictionary_t tbldict;
    116       1.1     rmind 	int error = 0;
    117       1.1     rmind 
    118       1.1     rmind 	/* Tables - array. */
    119      1.12     rmind 	if (prop_object_type(tables) != PROP_TYPE_ARRAY) {
    120      1.12     rmind 		NPF_ERR_DEBUG(errdict);
    121       1.1     rmind 		return EINVAL;
    122      1.12     rmind 	}
    123       1.1     rmind 
    124       1.1     rmind 	it = prop_array_iterator(tables);
    125       1.1     rmind 	while ((tbldict = prop_object_iterator_next(it)) != NULL) {
    126      1.32     rmind 		const char *name;
    127       1.1     rmind 		npf_table_t *t;
    128       1.1     rmind 		u_int tid;
    129       1.1     rmind 		int type;
    130       1.1     rmind 
    131       1.1     rmind 		/* Table - dictionary. */
    132       1.1     rmind 		if (prop_object_type(tbldict) != PROP_TYPE_DICTIONARY) {
    133      1.12     rmind 			NPF_ERR_DEBUG(errdict);
    134       1.1     rmind 			error = EINVAL;
    135       1.1     rmind 			break;
    136       1.1     rmind 		}
    137       1.1     rmind 
    138      1.32     rmind 		/* Table name, ID and type.  Validate them. */
    139      1.32     rmind 		if (!prop_dictionary_get_cstring_nocopy(tbldict, "name", &name)) {
    140      1.32     rmind 			NPF_ERR_DEBUG(errdict);
    141      1.32     rmind 			error = EINVAL;
    142      1.32     rmind 			break;
    143      1.32     rmind 		}
    144       1.6     rmind 		prop_dictionary_get_uint32(tbldict, "id", &tid);
    145       1.6     rmind 		prop_dictionary_get_int32(tbldict, "type", &type);
    146      1.32     rmind 		error = npf_table_check(tblset, name, tid, type);
    147      1.32     rmind 		if (error) {
    148      1.32     rmind 			NPF_ERR_DEBUG(errdict);
    149       1.1     rmind 			break;
    150      1.32     rmind 		}
    151       1.1     rmind 
    152      1.33     rmind 		/* Get the entries or binary data. */
    153      1.39     rmind 		prop_array_t ents = prop_dictionary_get(tbldict, "entries");
    154      1.33     rmind 		prop_object_t obj = prop_dictionary_get(tbldict, "data");
    155      1.33     rmind 		void *blob = prop_data_data(obj);
    156      1.33     rmind 		size_t size = prop_data_size(obj);
    157      1.33     rmind 
    158      1.33     rmind 		if (type == NPF_TABLE_CDB && (blob == NULL || size == 0)) {
    159      1.33     rmind 			NPF_ERR_DEBUG(errdict);
    160      1.33     rmind 			error = EINVAL;
    161      1.33     rmind 			break;
    162      1.33     rmind 		}
    163      1.34     rmind 		if (type == NPF_TABLE_HASH) {
    164      1.34     rmind 			size = 1024; /* XXX */
    165      1.34     rmind 		}
    166      1.33     rmind 
    167       1.1     rmind 		/* Create and insert the table. */
    168      1.33     rmind 		t = npf_table_create(name, tid, type, blob, size);
    169       1.1     rmind 		if (t == NULL) {
    170      1.12     rmind 			NPF_ERR_DEBUG(errdict);
    171       1.1     rmind 			error = ENOMEM;
    172       1.1     rmind 			break;
    173       1.1     rmind 		}
    174       1.1     rmind 		error = npf_tableset_insert(tblset, t);
    175       1.1     rmind 		KASSERT(error == 0);
    176       1.1     rmind 
    177      1.39     rmind 		if (ents && (error = npf_mk_table_entries(t, ents)) != 0) {
    178      1.12     rmind 			NPF_ERR_DEBUG(errdict);
    179       1.1     rmind 			break;
    180       1.1     rmind 		}
    181       1.1     rmind 	}
    182       1.1     rmind 	prop_object_iterator_release(it);
    183       1.1     rmind 	/*
    184       1.4     rmind 	 * Note: in a case of error, caller will free the tableset.
    185       1.1     rmind 	 */
    186       1.1     rmind 	return error;
    187       1.1     rmind }
    188       1.1     rmind 
    189       1.5     rmind static npf_rproc_t *
    190      1.21     rmind npf_mk_singlerproc(prop_dictionary_t rpdict)
    191       1.5     rmind {
    192       1.5     rmind 	prop_object_iterator_t it;
    193      1.21     rmind 	prop_dictionary_t extdict;
    194      1.18     rmind 	prop_array_t extlist;
    195       1.5     rmind 	npf_rproc_t *rp;
    196      1.18     rmind 
    197      1.18     rmind 	extlist = prop_dictionary_get(rpdict, "extcalls");
    198      1.18     rmind 	if (prop_object_type(extlist) != PROP_TYPE_ARRAY) {
    199      1.18     rmind 		return NULL;
    200      1.18     rmind 	}
    201      1.18     rmind 
    202      1.18     rmind 	rp = npf_rproc_create(rpdict);
    203      1.21     rmind 	if (rp == NULL) {
    204      1.18     rmind 		return NULL;
    205      1.18     rmind 	}
    206      1.21     rmind 
    207      1.18     rmind 	it = prop_array_iterator(extlist);
    208      1.18     rmind 	while ((extdict = prop_object_iterator_next(it)) != NULL) {
    209      1.21     rmind 		const char *name;
    210      1.21     rmind 
    211      1.18     rmind 		if (!prop_dictionary_get_cstring_nocopy(extdict,
    212      1.18     rmind 		    "name", &name) || npf_ext_construct(name, rp, extdict)) {
    213      1.18     rmind 			npf_rproc_release(rp);
    214      1.18     rmind 			rp = NULL;
    215      1.18     rmind 			break;
    216      1.18     rmind 		}
    217      1.18     rmind 	}
    218      1.18     rmind 	prop_object_iterator_release(it);
    219      1.21     rmind 	return rp;
    220      1.21     rmind }
    221      1.21     rmind 
    222      1.21     rmind static int __noinline
    223      1.21     rmind npf_mk_rprocs(npf_rprocset_t *rpset, prop_array_t rprocs,
    224      1.21     rmind     prop_dictionary_t errdict)
    225      1.21     rmind {
    226      1.21     rmind 	prop_object_iterator_t it;
    227      1.21     rmind 	prop_dictionary_t rpdict;
    228      1.21     rmind 	int error = 0;
    229      1.21     rmind 
    230      1.21     rmind 	it = prop_array_iterator(rprocs);
    231      1.21     rmind 	while ((rpdict = prop_object_iterator_next(it)) != NULL) {
    232      1.21     rmind 		npf_rproc_t *rp;
    233      1.18     rmind 
    234      1.21     rmind 		if ((rp = npf_mk_singlerproc(rpdict)) == NULL) {
    235      1.21     rmind 			NPF_ERR_DEBUG(errdict);
    236      1.21     rmind 			error = EINVAL;
    237      1.21     rmind 			break;
    238      1.21     rmind 		}
    239      1.21     rmind 		npf_rprocset_insert(rpset, rp);
    240       1.5     rmind 	}
    241      1.21     rmind 	prop_object_iterator_release(it);
    242      1.21     rmind 	return error;
    243       1.5     rmind }
    244       1.5     rmind 
    245      1.24  christos static npf_alg_t *
    246      1.24  christos npf_mk_singlealg(prop_dictionary_t aldict)
    247      1.24  christos {
    248      1.24  christos 	const char *name;
    249      1.24  christos 
    250      1.24  christos 	if (!prop_dictionary_get_cstring_nocopy(aldict, "name", &name))
    251      1.24  christos 		return NULL;
    252      1.24  christos 	return npf_alg_construct(name);
    253      1.24  christos }
    254      1.24  christos 
    255      1.24  christos static int __noinline
    256      1.24  christos npf_mk_algs(prop_array_t alglist, prop_dictionary_t errdict)
    257      1.24  christos {
    258      1.24  christos 	prop_object_iterator_t it;
    259      1.24  christos 	prop_dictionary_t nadict;
    260      1.24  christos 	int error = 0;
    261      1.24  christos 
    262      1.24  christos 	it = prop_array_iterator(alglist);
    263      1.24  christos 	while ((nadict = prop_object_iterator_next(it)) != NULL) {
    264      1.24  christos 		if (npf_mk_singlealg(nadict) == NULL) {
    265      1.24  christos 			NPF_ERR_DEBUG(errdict);
    266      1.24  christos 			error = EINVAL;
    267      1.24  christos 			break;
    268      1.24  christos 		}
    269      1.24  christos 	}
    270      1.24  christos 	prop_object_iterator_release(it);
    271      1.24  christos 	return error;
    272      1.24  christos }
    273      1.24  christos 
    274       1.6     rmind static int __noinline
    275      1.21     rmind npf_mk_code(prop_object_t obj, int type, void **code, size_t *csize,
    276      1.12     rmind     prop_dictionary_t errdict)
    277      1.12     rmind {
    278      1.21     rmind 	const void *cptr;
    279      1.21     rmind 	size_t clen;
    280      1.21     rmind 	void *bc;
    281      1.12     rmind 
    282      1.29     rmind 	if (type != NPF_CODE_BPF) {
    283      1.29     rmind 		return ENOTSUP;
    284      1.29     rmind 	}
    285      1.21     rmind 	cptr = prop_data_data_nocopy(obj);
    286      1.21     rmind 	if (cptr == NULL || (clen = prop_data_size(obj)) == 0) {
    287      1.12     rmind 		NPF_ERR_DEBUG(errdict);
    288      1.21     rmind 		return EINVAL;
    289      1.12     rmind 	}
    290      1.29     rmind 	if (!npf_bpf_validate(cptr, clen)) {
    291      1.29     rmind 		NPF_ERR_DEBUG(errdict);
    292      1.29     rmind 		return EINVAL;
    293      1.12     rmind 	}
    294      1.21     rmind 	bc = kmem_alloc(clen, KM_SLEEP);
    295      1.21     rmind 	memcpy(bc, cptr, clen);
    296      1.21     rmind 
    297      1.21     rmind 	*code = bc;
    298      1.21     rmind 	*csize = clen;
    299      1.12     rmind 	return 0;
    300      1.12     rmind }
    301      1.12     rmind 
    302      1.12     rmind static int __noinline
    303      1.21     rmind npf_mk_singlerule(prop_dictionary_t rldict, npf_rprocset_t *rpset,
    304      1.21     rmind     npf_rule_t **rlret, prop_dictionary_t errdict)
    305       1.1     rmind {
    306      1.21     rmind 	npf_rule_t *rl;
    307      1.21     rmind 	const char *rname;
    308       1.1     rmind 	prop_object_t obj;
    309      1.21     rmind 	int p, error = 0;
    310       1.1     rmind 
    311       1.1     rmind 	/* Rule - dictionary. */
    312      1.12     rmind 	if (prop_object_type(rldict) != PROP_TYPE_DICTIONARY) {
    313      1.12     rmind 		NPF_ERR_DEBUG(errdict);
    314       1.1     rmind 		return EINVAL;
    315      1.12     rmind 	}
    316      1.21     rmind 	if ((rl = npf_rule_alloc(rldict)) == NULL) {
    317      1.21     rmind 		NPF_ERR_DEBUG(errdict);
    318      1.21     rmind 		return EINVAL;
    319      1.21     rmind 	}
    320       1.1     rmind 
    321      1.21     rmind 	/* Assign rule procedure, if any. */
    322      1.21     rmind 	if (prop_dictionary_get_cstring_nocopy(rldict, "rproc", &rname)) {
    323      1.21     rmind 		npf_rproc_t *rp;
    324      1.21     rmind 
    325      1.21     rmind 		if (rpset == NULL) {
    326      1.21     rmind 			error = EINVAL;
    327      1.21     rmind 			goto err;
    328      1.21     rmind 		}
    329      1.21     rmind 		if ((rp = npf_rprocset_lookup(rpset, rname)) == NULL) {
    330      1.18     rmind 			NPF_ERR_DEBUG(errdict);
    331      1.18     rmind 			error = EINVAL;
    332      1.18     rmind 			goto err;
    333      1.18     rmind 		}
    334      1.21     rmind 		npf_rule_setrproc(rl, rp);
    335      1.18     rmind 	}
    336      1.18     rmind 
    337      1.21     rmind 	/* Filter code (binary data). */
    338      1.21     rmind 	if ((obj = prop_dictionary_get(rldict, "code")) != NULL) {
    339      1.21     rmind 		int type;
    340      1.21     rmind 		size_t len;
    341      1.21     rmind 		void *code;
    342      1.21     rmind 
    343      1.21     rmind 		prop_dictionary_get_int32(rldict, "code-type", &type);
    344      1.21     rmind 		error = npf_mk_code(obj, type, &code, &len, errdict);
    345      1.12     rmind 		if (error) {
    346      1.12     rmind 			goto err;
    347       1.4     rmind 		}
    348      1.21     rmind 		npf_rule_setcode(rl, type, code, len);
    349       1.1     rmind 	}
    350       1.1     rmind 
    351      1.21     rmind 	*rlret = rl;
    352       1.6     rmind 	return 0;
    353      1.12     rmind err:
    354      1.21     rmind 	npf_rule_free(rl);
    355      1.37     rmind 	prop_dictionary_get_int32(rldict, "prio", &p); /* XXX */
    356      1.12     rmind 	prop_dictionary_set_int32(errdict, "id", p);
    357      1.12     rmind 	return error;
    358       1.6     rmind }
    359       1.6     rmind 
    360       1.6     rmind static int __noinline
    361      1.21     rmind npf_mk_rules(npf_ruleset_t *rlset, prop_array_t rules, npf_rprocset_t *rpset,
    362      1.12     rmind     prop_dictionary_t errdict)
    363       1.6     rmind {
    364       1.6     rmind 	prop_object_iterator_t it;
    365       1.6     rmind 	prop_dictionary_t rldict;
    366      1.21     rmind 	int error;
    367       1.6     rmind 
    368       1.6     rmind 	if (prop_object_type(rules) != PROP_TYPE_ARRAY) {
    369      1.12     rmind 		NPF_ERR_DEBUG(errdict);
    370       1.6     rmind 		return EINVAL;
    371       1.6     rmind 	}
    372       1.5     rmind 
    373       1.4     rmind 	error = 0;
    374       1.1     rmind 	it = prop_array_iterator(rules);
    375       1.1     rmind 	while ((rldict = prop_object_iterator_next(it)) != NULL) {
    376      1.21     rmind 		npf_rule_t *rl = NULL;
    377       1.1     rmind 
    378       1.1     rmind 		/* Generate a single rule. */
    379      1.21     rmind 		error = npf_mk_singlerule(rldict, rpset, &rl, errdict);
    380       1.6     rmind 		if (error) {
    381       1.1     rmind 			break;
    382       1.6     rmind 		}
    383       1.6     rmind 		npf_ruleset_insert(rlset, rl);
    384       1.1     rmind 	}
    385       1.1     rmind 	prop_object_iterator_release(it);
    386       1.1     rmind 	/*
    387       1.4     rmind 	 * Note: in a case of error, caller will free the ruleset.
    388       1.1     rmind 	 */
    389       1.1     rmind 	return error;
    390       1.1     rmind }
    391       1.1     rmind 
    392       1.6     rmind static int __noinline
    393      1.12     rmind npf_mk_natlist(npf_ruleset_t *nset, prop_array_t natlist,
    394      1.12     rmind     prop_dictionary_t errdict)
    395       1.1     rmind {
    396       1.1     rmind 	prop_object_iterator_t it;
    397       1.1     rmind 	prop_dictionary_t natdict;
    398       1.1     rmind 	int error;
    399       1.1     rmind 
    400       1.1     rmind 	/* NAT policies - array. */
    401      1.12     rmind 	if (prop_object_type(natlist) != PROP_TYPE_ARRAY) {
    402      1.12     rmind 		NPF_ERR_DEBUG(errdict);
    403       1.1     rmind 		return EINVAL;
    404      1.12     rmind 	}
    405       1.1     rmind 
    406       1.4     rmind 	error = 0;
    407       1.1     rmind 	it = prop_array_iterator(natlist);
    408       1.1     rmind 	while ((natdict = prop_object_iterator_next(it)) != NULL) {
    409      1.21     rmind 		npf_rule_t *rl = NULL;
    410       1.1     rmind 		npf_natpolicy_t *np;
    411       1.1     rmind 
    412       1.1     rmind 		/* NAT policy - dictionary. */
    413       1.1     rmind 		if (prop_object_type(natdict) != PROP_TYPE_DICTIONARY) {
    414      1.12     rmind 			NPF_ERR_DEBUG(errdict);
    415       1.1     rmind 			error = EINVAL;
    416       1.1     rmind 			break;
    417       1.1     rmind 		}
    418       1.1     rmind 
    419       1.1     rmind 		/*
    420       1.1     rmind 		 * NAT policies are standard rules, plus additional
    421       1.1     rmind 		 * information for translation.  Make a rule.
    422       1.1     rmind 		 */
    423      1.12     rmind 		error = npf_mk_singlerule(natdict, NULL, &rl, errdict);
    424       1.6     rmind 		if (error) {
    425       1.1     rmind 			break;
    426       1.6     rmind 		}
    427       1.6     rmind 		npf_ruleset_insert(nset, rl);
    428       1.6     rmind 
    429       1.6     rmind 		/* If rule is named, it is a group with NAT policies. */
    430       1.6     rmind 		if (prop_dictionary_get(natdict, "name") &&
    431       1.6     rmind 		    prop_dictionary_get(natdict, "subrules")) {
    432       1.6     rmind 			continue;
    433       1.6     rmind 		}
    434       1.1     rmind 
    435       1.1     rmind 		/* Allocate a new NAT policy and assign to the rule. */
    436       1.5     rmind 		np = npf_nat_newpolicy(natdict, nset);
    437       1.1     rmind 		if (np == NULL) {
    438      1.12     rmind 			NPF_ERR_DEBUG(errdict);
    439       1.1     rmind 			error = ENOMEM;
    440       1.1     rmind 			break;
    441       1.1     rmind 		}
    442       1.1     rmind 		npf_rule_setnat(rl, np);
    443       1.1     rmind 	}
    444       1.1     rmind 	prop_object_iterator_release(it);
    445       1.1     rmind 	/*
    446       1.1     rmind 	 * Note: in a case of error, caller will free entire NAT ruleset
    447       1.1     rmind 	 * with assigned NAT policies.
    448       1.1     rmind 	 */
    449       1.1     rmind 	return error;
    450       1.1     rmind }
    451       1.1     rmind 
    452       1.1     rmind /*
    453      1.35     rmind  * npf_mk_connlist: import a list of connections and load them.
    454      1.35     rmind  */
    455      1.35     rmind static int __noinline
    456      1.35     rmind npf_mk_connlist(prop_array_t conlist, npf_ruleset_t *natlist,
    457      1.35     rmind     npf_conndb_t **conndb, prop_dictionary_t errdict)
    458      1.35     rmind {
    459      1.35     rmind 	prop_dictionary_t condict;
    460      1.35     rmind 	prop_object_iterator_t it;
    461      1.35     rmind 	npf_conndb_t *cd;
    462      1.40     rmind 	int error = 0;
    463      1.35     rmind 
    464      1.35     rmind 	/* Connection list - array */
    465      1.35     rmind 	if (prop_object_type(conlist) != PROP_TYPE_ARRAY) {
    466      1.35     rmind 		NPF_ERR_DEBUG(errdict);
    467      1.35     rmind 		return EINVAL;
    468      1.35     rmind 	}
    469      1.35     rmind 
    470      1.35     rmind 	/* Create a connection database. */
    471      1.35     rmind 	cd = npf_conndb_create();
    472      1.35     rmind 	it = prop_array_iterator(conlist);
    473      1.35     rmind 	while ((condict = prop_object_iterator_next(it)) != NULL) {
    474      1.35     rmind 		/* Connection - dictionary. */
    475      1.35     rmind 		if (prop_object_type(condict) != PROP_TYPE_DICTIONARY) {
    476      1.35     rmind 			NPF_ERR_DEBUG(errdict);
    477      1.35     rmind 			error = EINVAL;
    478      1.35     rmind 			break;
    479      1.35     rmind 		}
    480      1.40     rmind 		/* Construct and insert the connection. */
    481      1.35     rmind 		error = npf_conn_import(cd, condict, natlist);
    482      1.35     rmind 		if (error) {
    483      1.35     rmind 			NPF_ERR_DEBUG(errdict);
    484      1.35     rmind 			break;
    485      1.35     rmind 		}
    486      1.35     rmind 	}
    487      1.35     rmind 	prop_object_iterator_release(it);
    488      1.35     rmind 	if (error) {
    489      1.36     rmind 		npf_conn_gc(cd, true, false);
    490      1.35     rmind 		npf_conndb_destroy(cd);
    491      1.35     rmind 	} else {
    492      1.35     rmind 		*conndb = cd;
    493      1.35     rmind 	}
    494      1.35     rmind 	return error;
    495      1.35     rmind }
    496      1.35     rmind 
    497      1.35     rmind /*
    498      1.35     rmind  * npfctl_load: store passed data i.e. update settings, create passed
    499       1.1     rmind  * tables, rules and atomically activate all them.
    500       1.1     rmind  */
    501       1.1     rmind int
    502      1.35     rmind npfctl_load(u_long cmd, void *data)
    503       1.1     rmind {
    504      1.12     rmind 	struct plistref *pref = data;
    505      1.14     rmind 	prop_dictionary_t npf_dict, errdict;
    506      1.35     rmind 	prop_array_t alglist, natlist, tables, rprocs, rules, conlist;
    507       1.1     rmind 	npf_tableset_t *tblset = NULL;
    508      1.21     rmind 	npf_rprocset_t *rpset = NULL;
    509       1.1     rmind 	npf_ruleset_t *rlset = NULL;
    510       1.1     rmind 	npf_ruleset_t *nset = NULL;
    511      1.35     rmind 	npf_conndb_t *conndb = NULL;
    512      1.20     rmind 	uint32_t ver = 0;
    513      1.21     rmind 	size_t nitems;
    514      1.11     rmind 	bool flush;
    515       1.1     rmind 	int error;
    516       1.1     rmind 
    517       1.1     rmind 	/* Retrieve the dictionary. */
    518      1.15     rmind #ifndef _NPF_TESTING
    519      1.14     rmind 	error = prop_dictionary_copyin_ioctl(pref, cmd, &npf_dict);
    520       1.1     rmind 	if (error)
    521       1.1     rmind 		return error;
    522       1.1     rmind #else
    523      1.15     rmind 	npf_dict = (prop_dictionary_t)pref;
    524       1.1     rmind #endif
    525      1.15     rmind 
    526      1.20     rmind 	/* Dictionary for error reporting and version check. */
    527      1.12     rmind 	errdict = prop_dictionary_create();
    528      1.20     rmind 	prop_dictionary_get_uint32(npf_dict, "version", &ver);
    529      1.20     rmind 	if (ver != NPF_VERSION) {
    530      1.20     rmind 		error = EPROGMISMATCH;
    531      1.20     rmind 		goto fail;
    532      1.20     rmind 	}
    533      1.12     rmind 
    534      1.24  christos 	/* ALGs. */
    535      1.24  christos 	alglist = prop_dictionary_get(npf_dict, "algs");
    536      1.24  christos 	error = npf_mk_algs(alglist, errdict);
    537      1.24  christos 	if (error) {
    538      1.24  christos 		goto fail;
    539      1.24  christos 	}
    540      1.24  christos 
    541       1.1     rmind 	/* NAT policies. */
    542      1.37     rmind 	natlist = prop_dictionary_get(npf_dict, "nat");
    543      1.30     rmind 	if ((nitems = prop_array_count(natlist)) > NPF_MAX_RULES) {
    544      1.39     rmind 		error = E2BIG;
    545      1.30     rmind 		goto fail;
    546      1.30     rmind 	}
    547      1.21     rmind 
    548      1.21     rmind 	nset = npf_ruleset_create(nitems);
    549      1.12     rmind 	error = npf_mk_natlist(nset, natlist, errdict);
    550      1.10     rmind 	if (error) {
    551       1.1     rmind 		goto fail;
    552      1.10     rmind 	}
    553       1.1     rmind 
    554       1.1     rmind 	/* Tables. */
    555      1.14     rmind 	tables = prop_dictionary_get(npf_dict, "tables");
    556      1.32     rmind 	if ((nitems = prop_array_count(tables)) > NPF_MAX_TABLES) {
    557      1.39     rmind 		error = E2BIG;
    558      1.32     rmind 		goto fail;
    559      1.32     rmind 	}
    560      1.32     rmind 	tblset = npf_tableset_create(nitems);
    561      1.12     rmind 	error = npf_mk_tables(tblset, tables, errdict);
    562      1.10     rmind 	if (error) {
    563       1.1     rmind 		goto fail;
    564      1.10     rmind 	}
    565       1.1     rmind 
    566      1.21     rmind 	/* Rule procedures. */
    567      1.32     rmind 	rprocs = prop_dictionary_get(npf_dict, "rprocs");
    568      1.32     rmind 	if ((nitems = prop_array_count(rprocs)) > NPF_MAX_RPROCS) {
    569      1.39     rmind 		error = E2BIG;
    570      1.32     rmind 		goto fail;
    571      1.32     rmind 	}
    572      1.21     rmind 	rpset = npf_rprocset_create();
    573      1.21     rmind 	error = npf_mk_rprocs(rpset, rprocs, errdict);
    574      1.21     rmind 	if (error) {
    575      1.21     rmind 		goto fail;
    576      1.21     rmind 	}
    577      1.21     rmind 
    578      1.21     rmind 	/* Rules. */
    579      1.14     rmind 	rules = prop_dictionary_get(npf_dict, "rules");
    580      1.30     rmind 	if ((nitems = prop_array_count(rules)) > NPF_MAX_RULES) {
    581      1.39     rmind 		error = E2BIG;
    582      1.30     rmind 		goto fail;
    583      1.30     rmind 	}
    584      1.21     rmind 
    585      1.21     rmind 	rlset = npf_ruleset_create(nitems);
    586      1.21     rmind 	error = npf_mk_rules(rlset, rules, rpset, errdict);
    587      1.10     rmind 	if (error) {
    588       1.1     rmind 		goto fail;
    589      1.10     rmind 	}
    590       1.1     rmind 
    591      1.35     rmind 	/* Connections (if loading any). */
    592      1.35     rmind 	if ((conlist = prop_dictionary_get(npf_dict, "conn-list")) != NULL) {
    593      1.35     rmind 		error = npf_mk_connlist(conlist, nset, &conndb, errdict);
    594      1.35     rmind 		if (error) {
    595      1.35     rmind 			goto fail;
    596      1.35     rmind 		}
    597      1.35     rmind 	}
    598      1.35     rmind 
    599      1.11     rmind 	flush = false;
    600      1.14     rmind 	prop_dictionary_get_bool(npf_dict, "flush", &flush);
    601      1.11     rmind 
    602       1.1     rmind 	/*
    603      1.35     rmind 	 * Finally - perform the load.
    604       1.1     rmind 	 */
    605      1.38     rmind 	npf_config_load(rlset, tblset, nset, rpset, conndb, flush);
    606      1.11     rmind 
    607       1.1     rmind 	/* Done.  Since data is consumed now, we shall not destroy it. */
    608       1.1     rmind 	tblset = NULL;
    609      1.21     rmind 	rpset = NULL;
    610       1.1     rmind 	rlset = NULL;
    611       1.1     rmind 	nset = NULL;
    612       1.1     rmind fail:
    613       1.1     rmind 	/*
    614       1.1     rmind 	 * Note: destroy rulesets first, to drop references to the tableset.
    615       1.1     rmind 	 */
    616      1.21     rmind 	KASSERT(error == 0 || (nset || rpset || rlset || tblset));
    617       1.1     rmind 	if (nset) {
    618       1.1     rmind 		npf_ruleset_destroy(nset);
    619       1.1     rmind 	}
    620       1.1     rmind 	if (rlset) {
    621       1.1     rmind 		npf_ruleset_destroy(rlset);
    622       1.1     rmind 	}
    623      1.21     rmind 	if (rpset) {
    624      1.21     rmind 		npf_rprocset_destroy(rpset);
    625      1.21     rmind 	}
    626       1.1     rmind 	if (tblset) {
    627       1.1     rmind 		npf_tableset_destroy(tblset);
    628       1.1     rmind 	}
    629      1.38     rmind 	prop_object_release(npf_dict);
    630      1.12     rmind 
    631      1.12     rmind 	/* Error report. */
    632      1.18     rmind #ifndef _NPF_TESTING
    633      1.12     rmind 	prop_dictionary_set_int32(errdict, "errno", error);
    634      1.12     rmind 	prop_dictionary_copyout_ioctl(pref, cmd, errdict);
    635      1.18     rmind 	prop_object_release(errdict);
    636      1.18     rmind 	error = 0;
    637      1.13     rmind #endif
    638      1.18     rmind 	return error;
    639       1.6     rmind }
    640       1.6     rmind 
    641      1.21     rmind /*
    642      1.35     rmind  * npfctl_save: export the config dictionary as it was submitted,
    643      1.35     rmind  * including the current snapshot of the connections.  Additionally,
    644      1.35     rmind  * indicate whether the ruleset is currently active.
    645      1.35     rmind  */
    646      1.35     rmind int
    647      1.35     rmind npfctl_save(u_long cmd, void *data)
    648      1.35     rmind {
    649      1.35     rmind 	struct plistref *pref = data;
    650      1.38     rmind 	prop_array_t rulelist, natlist, tables, rprocs, conlist;
    651      1.38     rmind 	prop_dictionary_t npf_dict = NULL;
    652      1.35     rmind 	int error;
    653      1.35     rmind 
    654      1.38     rmind 	rulelist = prop_array_create();
    655      1.38     rmind 	natlist = prop_array_create();
    656      1.38     rmind 	tables = prop_array_create();
    657      1.38     rmind 	rprocs = prop_array_create();
    658      1.35     rmind 	conlist = prop_array_create();
    659      1.35     rmind 
    660      1.37     rmind 	/*
    661      1.37     rmind 	 * Serialise the connections and NAT policies.
    662      1.37     rmind 	 */
    663      1.37     rmind 	npf_config_enter();
    664      1.37     rmind 	error = npf_conndb_export(conlist);
    665      1.37     rmind 	if (error) {
    666      1.37     rmind 		goto out;
    667      1.37     rmind 	}
    668      1.38     rmind 	error = npf_ruleset_export(npf_config_ruleset(), rulelist);
    669      1.38     rmind 	if (error) {
    670      1.38     rmind 		goto out;
    671      1.38     rmind 	}
    672      1.37     rmind 	error = npf_ruleset_export(npf_config_natset(), natlist);
    673      1.35     rmind 	if (error) {
    674      1.35     rmind 		goto out;
    675      1.35     rmind 	}
    676      1.38     rmind 	error = npf_tableset_export(npf_config_tableset(), tables);
    677      1.38     rmind 	if (error) {
    678      1.38     rmind 		goto out;
    679      1.38     rmind 	}
    680      1.38     rmind 	error = npf_rprocset_export(npf_config_rprocs(), rprocs);
    681      1.38     rmind 	if (error) {
    682      1.38     rmind 		goto out;
    683      1.38     rmind 	}
    684      1.39     rmind 	prop_array_t alglist = npf_alg_export();
    685      1.39     rmind 
    686      1.38     rmind 	npf_dict = prop_dictionary_create();
    687      1.38     rmind 	prop_dictionary_set_uint32(npf_dict, "version", NPF_VERSION);
    688      1.39     rmind 	prop_dictionary_set_and_rel(npf_dict, "algs", alglist);
    689      1.38     rmind 	prop_dictionary_set_and_rel(npf_dict, "rules", rulelist);
    690      1.37     rmind 	prop_dictionary_set_and_rel(npf_dict, "nat", natlist);
    691      1.38     rmind 	prop_dictionary_set_and_rel(npf_dict, "tables", tables);
    692      1.38     rmind 	prop_dictionary_set_and_rel(npf_dict, "rprocs", rprocs);
    693      1.37     rmind 	prop_dictionary_set_and_rel(npf_dict, "conn-list", conlist);
    694      1.35     rmind 	prop_dictionary_set_bool(npf_dict, "active", npf_pfil_registered_p());
    695      1.35     rmind 	error = prop_dictionary_copyout_ioctl(pref, cmd, npf_dict);
    696      1.35     rmind out:
    697      1.35     rmind 	npf_config_exit();
    698      1.37     rmind 
    699      1.38     rmind 	if (!npf_dict) {
    700      1.38     rmind 		prop_object_release(rulelist);
    701      1.38     rmind 		prop_object_release(natlist);
    702      1.38     rmind 		prop_object_release(tables);
    703      1.38     rmind 		prop_object_release(rprocs);
    704      1.37     rmind 		prop_object_release(conlist);
    705      1.38     rmind 	} else {
    706      1.38     rmind 		prop_object_release(npf_dict);
    707      1.37     rmind 	}
    708      1.35     rmind 	return error;
    709      1.35     rmind }
    710      1.35     rmind 
    711      1.35     rmind /*
    712      1.21     rmind  * npfctl_rule: add or remove dynamic rules in the specified ruleset.
    713      1.21     rmind  */
    714      1.14     rmind int
    715      1.21     rmind npfctl_rule(u_long cmd, void *data)
    716      1.14     rmind {
    717      1.14     rmind 	struct plistref *pref = data;
    718      1.21     rmind 	prop_dictionary_t npf_rule, retdict = NULL;
    719      1.21     rmind 	npf_ruleset_t *rlset;
    720      1.21     rmind 	npf_rule_t *rl = NULL;
    721      1.21     rmind 	const char *ruleset_name;
    722      1.21     rmind 	uint32_t rcmd = 0;
    723      1.14     rmind 	int error;
    724      1.14     rmind 
    725      1.21     rmind 	error = prop_dictionary_copyin_ioctl(pref, cmd, &npf_rule);
    726      1.21     rmind 	if (error) {
    727      1.21     rmind 		return error;
    728      1.21     rmind 	}
    729      1.21     rmind 	prop_dictionary_get_uint32(npf_rule, "command", &rcmd);
    730      1.21     rmind 	if (!prop_dictionary_get_cstring_nocopy(npf_rule,
    731      1.21     rmind 	    "ruleset-name", &ruleset_name)) {
    732      1.27     rmind 		error = EINVAL;
    733      1.27     rmind 		goto out;
    734      1.21     rmind 	}
    735      1.21     rmind 
    736      1.21     rmind 	if (rcmd == NPF_CMD_RULE_ADD) {
    737      1.27     rmind 		retdict = prop_dictionary_create();
    738      1.27     rmind 		if (npf_mk_singlerule(npf_rule, NULL, &rl, retdict) != 0) {
    739      1.27     rmind 			error = EINVAL;
    740      1.27     rmind 			goto out;
    741      1.21     rmind 		}
    742      1.21     rmind 	}
    743      1.21     rmind 
    744      1.21     rmind 	npf_config_enter();
    745      1.21     rmind 	rlset = npf_config_ruleset();
    746      1.21     rmind 
    747      1.21     rmind 	switch (rcmd) {
    748      1.21     rmind 	case NPF_CMD_RULE_ADD: {
    749      1.21     rmind 		if ((error = npf_ruleset_add(rlset, ruleset_name, rl)) == 0) {
    750      1.21     rmind 			/* Success. */
    751      1.23     rmind 			uint64_t id = npf_rule_getid(rl);
    752      1.23     rmind 			prop_dictionary_set_uint64(retdict, "id", id);
    753      1.21     rmind 			rl = NULL;
    754      1.21     rmind 		}
    755      1.21     rmind 		break;
    756      1.21     rmind 	}
    757      1.21     rmind 	case NPF_CMD_RULE_REMOVE: {
    758      1.23     rmind 		uint64_t id;
    759      1.21     rmind 
    760      1.23     rmind 		if (!prop_dictionary_get_uint64(npf_rule, "id", &id)) {
    761      1.21     rmind 			error = EINVAL;
    762      1.21     rmind 			break;
    763      1.21     rmind 		}
    764      1.23     rmind 		error = npf_ruleset_remove(rlset, ruleset_name, id);
    765      1.21     rmind 		break;
    766      1.21     rmind 	}
    767      1.21     rmind 	case NPF_CMD_RULE_REMKEY: {
    768      1.21     rmind 		prop_object_t obj = prop_dictionary_get(npf_rule, "key");
    769      1.21     rmind 		const void *key = prop_data_data_nocopy(obj);
    770      1.21     rmind 		size_t len = prop_data_size(obj);
    771      1.21     rmind 
    772      1.21     rmind 		if (len == 0 || len > NPF_RULE_MAXKEYLEN) {
    773      1.21     rmind 			error = EINVAL;
    774      1.21     rmind 			break;
    775      1.21     rmind 		}
    776      1.22     rmind 		error = npf_ruleset_remkey(rlset, ruleset_name, key, len);
    777      1.22     rmind 		break;
    778      1.22     rmind 	}
    779      1.22     rmind 	case NPF_CMD_RULE_LIST: {
    780      1.22     rmind 		retdict = npf_ruleset_list(rlset, ruleset_name);
    781  1.40.2.1     skrll 		if (!retdict) {
    782  1.40.2.1     skrll 			error = ESRCH;
    783  1.40.2.1     skrll 		}
    784      1.22     rmind 		break;
    785      1.22     rmind 	}
    786      1.22     rmind 	case NPF_CMD_RULE_FLUSH: {
    787      1.22     rmind 		error = npf_ruleset_flush(rlset, ruleset_name);
    788      1.21     rmind 		break;
    789      1.21     rmind 	}
    790      1.21     rmind 	default:
    791      1.21     rmind 		error = EINVAL;
    792      1.21     rmind 		break;
    793      1.21     rmind 	}
    794      1.22     rmind 
    795      1.22     rmind 	/* Destroy any removed rules. */
    796      1.22     rmind 	if (!error && rcmd != NPF_CMD_RULE_ADD && rcmd != NPF_CMD_RULE_LIST) {
    797      1.22     rmind 		npf_config_sync();
    798      1.22     rmind 		npf_ruleset_gc(rlset);
    799      1.22     rmind 	}
    800      1.21     rmind 	npf_config_exit();
    801      1.14     rmind 
    802      1.21     rmind 	if (rl) {
    803  1.40.2.1     skrll 		KASSERT(error);
    804      1.21     rmind 		npf_rule_free(rl);
    805      1.21     rmind 	}
    806      1.27     rmind out:
    807      1.21     rmind 	if (retdict) {
    808      1.21     rmind 		prop_object_release(npf_rule);
    809      1.21     rmind 		prop_dictionary_copyout_ioctl(pref, cmd, retdict);
    810      1.21     rmind 		prop_object_release(retdict);
    811      1.21     rmind 	}
    812      1.14     rmind 	return error;
    813      1.14     rmind }
    814      1.14     rmind 
    815       1.6     rmind /*
    816       1.2     rmind  * npfctl_table: add, remove or query entries in the specified table.
    817       1.1     rmind  *
    818       1.1     rmind  * For maximum performance, interface is avoiding proplib(3)'s overhead.
    819       1.1     rmind  */
    820       1.1     rmind int
    821       1.1     rmind npfctl_table(void *data)
    822       1.1     rmind {
    823      1.19     rmind 	const npf_ioctl_table_t *nct = data;
    824      1.32     rmind 	char tname[NPF_TABLE_MAXNAMELEN];
    825      1.32     rmind 	npf_tableset_t *ts;
    826      1.32     rmind 	npf_table_t *t;
    827      1.32     rmind 	int s, error;
    828      1.32     rmind 
    829      1.32     rmind 	error = copyinstr(nct->nct_name, tname, sizeof(tname), NULL);
    830      1.32     rmind 	if (error) {
    831      1.32     rmind 		return error;
    832      1.32     rmind 	}
    833       1.1     rmind 
    834      1.32     rmind 	s = npf_config_read_enter(); /* XXX */
    835      1.32     rmind 	ts = npf_config_tableset();
    836      1.32     rmind 	if ((t = npf_tableset_getbyname(ts, tname)) == NULL) {
    837      1.32     rmind 		npf_config_read_exit(s);
    838      1.32     rmind 		return EINVAL;
    839      1.32     rmind 	}
    840      1.21     rmind 
    841      1.21     rmind 	switch (nct->nct_cmd) {
    842      1.21     rmind 	case NPF_CMD_TABLE_LOOKUP:
    843      1.32     rmind 		error = npf_table_lookup(t, nct->nct_data.ent.alen,
    844      1.32     rmind 		    &nct->nct_data.ent.addr);
    845      1.20     rmind 		break;
    846      1.21     rmind 	case NPF_CMD_TABLE_ADD:
    847      1.32     rmind 		error = npf_table_insert(t, nct->nct_data.ent.alen,
    848      1.32     rmind 		    &nct->nct_data.ent.addr, nct->nct_data.ent.mask);
    849       1.1     rmind 		break;
    850      1.21     rmind 	case NPF_CMD_TABLE_REMOVE:
    851      1.32     rmind 		error = npf_table_remove(t, nct->nct_data.ent.alen,
    852      1.32     rmind 		    &nct->nct_data.ent.addr, nct->nct_data.ent.mask);
    853      1.19     rmind 		break;
    854      1.21     rmind 	case NPF_CMD_TABLE_LIST:
    855      1.32     rmind 		error = npf_table_list(t, nct->nct_data.buf.buf,
    856      1.32     rmind 		    nct->nct_data.buf.len);
    857       1.1     rmind 		break;
    858      1.25     rmind 	case NPF_CMD_TABLE_FLUSH:
    859      1.32     rmind 		error = npf_table_flush(t);
    860      1.25     rmind 		break;
    861       1.1     rmind 	default:
    862      1.19     rmind 		error = EINVAL;
    863      1.19     rmind 		break;
    864       1.1     rmind 	}
    865      1.32     rmind 	npf_config_read_exit(s);
    866      1.21     rmind 
    867       1.1     rmind 	return error;
    868       1.1     rmind }
    869