xref: /linux/net/tipc/netlink.c (revision 86b0c540e2ea397cde021eecd24145f7c16a3d4e)
1 /*
2  * net/tipc/netlink.c: TIPC configuration handling
3  *
4  * Copyright (c) 2005-2006, 2014, Ericsson AB
5  * Copyright (c) 2005-2007, Wind River Systems
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions are met:
10  *
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  * 3. Neither the names of the copyright holders nor the names of its
17  *    contributors may be used to endorse or promote products derived from
18  *    this software without specific prior written permission.
19  *
20  * Alternatively, this software may be distributed under the terms of the
21  * GNU General Public License ("GPL") version 2 as published by the Free
22  * Software Foundation.
23  *
24  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
25  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
28  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
29  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
30  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
31  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
32  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
33  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
34  * POSSIBILITY OF SUCH DAMAGE.
35  */
36 
37 #include "core.h"
38 #include "socket.h"
39 #include "name_table.h"
40 #include "bearer.h"
41 #include "link.h"
42 #include "node.h"
43 #include "net.h"
44 #include "udp_media.h"
45 #include <net/genetlink.h>
46 
47 static const struct nla_policy tipc_nl_policy[TIPC_NLA_MAX + 1] = {
48 	[TIPC_NLA_UNSPEC]	= { .type = NLA_UNSPEC, },
49 	[TIPC_NLA_BEARER]	= { .type = NLA_NESTED, },
50 	[TIPC_NLA_SOCK]		= { .type = NLA_NESTED, },
51 	[TIPC_NLA_PUBL]		= { .type = NLA_NESTED, },
52 	[TIPC_NLA_LINK]		= { .type = NLA_NESTED, },
53 	[TIPC_NLA_MEDIA]	= { .type = NLA_NESTED, },
54 	[TIPC_NLA_NODE]		= { .type = NLA_NESTED, },
55 	[TIPC_NLA_NET]		= { .type = NLA_NESTED, },
56 	[TIPC_NLA_NAME_TABLE]	= { .type = NLA_NESTED, },
57 	[TIPC_NLA_MON]		= { .type = NLA_NESTED, },
58 };
59 
60 const struct nla_policy
61 tipc_nl_name_table_policy[TIPC_NLA_NAME_TABLE_MAX + 1] = {
62 	[TIPC_NLA_NAME_TABLE_UNSPEC]	= { .type = NLA_UNSPEC },
63 	[TIPC_NLA_NAME_TABLE_PUBL]	= { .type = NLA_NESTED }
64 };
65 
66 const struct nla_policy tipc_nl_monitor_policy[TIPC_NLA_MON_MAX + 1] = {
67 	[TIPC_NLA_MON_UNSPEC]			= { .type = NLA_UNSPEC },
68 	[TIPC_NLA_MON_REF]			= { .type = NLA_U32 },
69 	[TIPC_NLA_MON_ACTIVATION_THRESHOLD]	= { .type = NLA_U32 },
70 };
71 
72 const struct nla_policy tipc_nl_sock_policy[TIPC_NLA_SOCK_MAX + 1] = {
73 	[TIPC_NLA_SOCK_UNSPEC]		= { .type = NLA_UNSPEC },
74 	[TIPC_NLA_SOCK_ADDR]		= { .type = NLA_U32 },
75 	[TIPC_NLA_SOCK_REF]		= { .type = NLA_U32 },
76 	[TIPC_NLA_SOCK_CON]		= { .type = NLA_NESTED },
77 	[TIPC_NLA_SOCK_HAS_PUBL]	= { .type = NLA_FLAG }
78 };
79 
80 const struct nla_policy tipc_nl_net_policy[TIPC_NLA_NET_MAX + 1] = {
81 	[TIPC_NLA_NET_UNSPEC]		= { .type = NLA_UNSPEC },
82 	[TIPC_NLA_NET_ID]		= { .type = NLA_U32 },
83 	[TIPC_NLA_NET_ADDR]		= { .type = NLA_U32 },
84 	[TIPC_NLA_NET_NODEID]		= { .type = NLA_U64 },
85 	[TIPC_NLA_NET_NODEID_W1]	= { .type = NLA_U64 },
86 	[TIPC_NLA_NET_ADDR_LEGACY]	= { .type = NLA_FLAG }
87 };
88 
89 const struct nla_policy tipc_nl_link_policy[TIPC_NLA_LINK_MAX + 1] = {
90 	[TIPC_NLA_LINK_UNSPEC]		= { .type = NLA_UNSPEC },
91 	[TIPC_NLA_LINK_NAME]		= { .type = NLA_NUL_STRING,
92 					    .len = TIPC_MAX_LINK_NAME },
93 	[TIPC_NLA_LINK_MTU]		= { .type = NLA_U32 },
94 	[TIPC_NLA_LINK_BROADCAST]	= { .type = NLA_FLAG },
95 	[TIPC_NLA_LINK_UP]		= { .type = NLA_FLAG },
96 	[TIPC_NLA_LINK_ACTIVE]		= { .type = NLA_FLAG },
97 	[TIPC_NLA_LINK_PROP]		= { .type = NLA_NESTED },
98 	[TIPC_NLA_LINK_STATS]		= { .type = NLA_NESTED },
99 	[TIPC_NLA_LINK_RX]		= { .type = NLA_U32 },
100 	[TIPC_NLA_LINK_TX]		= { .type = NLA_U32 }
101 };
102 
103 const struct nla_policy tipc_nl_node_policy[TIPC_NLA_NODE_MAX + 1] = {
104 	[TIPC_NLA_NODE_UNSPEC]		= { .type = NLA_UNSPEC },
105 	[TIPC_NLA_NODE_ADDR]		= { .type = NLA_U32 },
106 	[TIPC_NLA_NODE_UP]		= { .type = NLA_FLAG },
107 	[TIPC_NLA_NODE_ID]		= { .type = NLA_BINARY,
108 					    .len = TIPC_NODEID_LEN},
109 	[TIPC_NLA_NODE_KEY]		= { .type = NLA_BINARY,
110 					    .len = TIPC_AEAD_KEY_SIZE_MAX},
111 	[TIPC_NLA_NODE_KEY_MASTER]	= { .type = NLA_FLAG },
112 	[TIPC_NLA_NODE_REKEYING]	= { .type = NLA_U32 },
113 };
114 
115 /* Properties valid for media, bearer and link */
116 const struct nla_policy tipc_nl_prop_policy[TIPC_NLA_PROP_MAX + 1] = {
117 	[TIPC_NLA_PROP_UNSPEC]		= { .type = NLA_UNSPEC },
118 	[TIPC_NLA_PROP_PRIO]		= { .type = NLA_U32 },
119 	[TIPC_NLA_PROP_TOL]		= { .type = NLA_U32 },
120 	[TIPC_NLA_PROP_WIN]		= { .type = NLA_U32 },
121 	[TIPC_NLA_PROP_MTU]		= { .type = NLA_U32 },
122 	[TIPC_NLA_PROP_BROADCAST]	= { .type = NLA_U32 },
123 	[TIPC_NLA_PROP_BROADCAST_RATIO]	= { .type = NLA_U32 }
124 };
125 
126 const struct nla_policy tipc_nl_bearer_policy[TIPC_NLA_BEARER_MAX + 1]	= {
127 	[TIPC_NLA_BEARER_UNSPEC]	= { .type = NLA_UNSPEC },
128 	[TIPC_NLA_BEARER_NAME]		= { .type = NLA_NUL_STRING,
129 					    .len = TIPC_MAX_BEARER_NAME },
130 	[TIPC_NLA_BEARER_PROP]		= { .type = NLA_NESTED },
131 	[TIPC_NLA_BEARER_DOMAIN]	= { .type = NLA_U32 }
132 };
133 
134 const struct nla_policy tipc_nl_media_policy[TIPC_NLA_MEDIA_MAX + 1] = {
135 	[TIPC_NLA_MEDIA_UNSPEC]		= { .type = NLA_UNSPEC },
136 	[TIPC_NLA_MEDIA_NAME]		= { .type = NLA_STRING },
137 	[TIPC_NLA_MEDIA_PROP]		= { .type = NLA_NESTED }
138 };
139 
140 const struct nla_policy tipc_nl_udp_policy[TIPC_NLA_UDP_MAX + 1] = {
141 	[TIPC_NLA_UDP_UNSPEC]	= {.type = NLA_UNSPEC},
142 	[TIPC_NLA_UDP_LOCAL]	= {.type = NLA_BINARY,
143 				   .len = sizeof(struct sockaddr_storage)},
144 	[TIPC_NLA_UDP_REMOTE]	= {.type = NLA_BINARY,
145 				   .len = sizeof(struct sockaddr_storage)},
146 };
147 
148 /* Users of the legacy API (tipc-config) can't handle that we add operations,
149  * so we have a separate genl handling for the new API.
150  */
151 static const struct genl_ops tipc_genl_v2_ops[] = {
152 	{
153 		.cmd	= TIPC_NL_BEARER_DISABLE,
154 		.validate = GENL_DONT_VALIDATE_STRICT | GENL_DONT_VALIDATE_DUMP,
155 		.flags	= GENL_UNS_ADMIN_PERM,
156 		.doit	= tipc_nl_bearer_disable,
157 	},
158 	{
159 		.cmd	= TIPC_NL_BEARER_ENABLE,
160 		.validate = GENL_DONT_VALIDATE_STRICT | GENL_DONT_VALIDATE_DUMP,
161 		.flags	= GENL_UNS_ADMIN_PERM,
162 		.doit	= tipc_nl_bearer_enable,
163 	},
164 	{
165 		.cmd	= TIPC_NL_BEARER_GET,
166 		.validate = GENL_DONT_VALIDATE_STRICT | GENL_DONT_VALIDATE_DUMP,
167 		.doit	= tipc_nl_bearer_get,
168 		.dumpit	= tipc_nl_bearer_dump,
169 	},
170 	{
171 		.cmd	= TIPC_NL_BEARER_ADD,
172 		.validate = GENL_DONT_VALIDATE_STRICT | GENL_DONT_VALIDATE_DUMP,
173 		.flags	= GENL_UNS_ADMIN_PERM,
174 		.doit	= tipc_nl_bearer_add,
175 	},
176 	{
177 		.cmd	= TIPC_NL_BEARER_SET,
178 		.validate = GENL_DONT_VALIDATE_STRICT | GENL_DONT_VALIDATE_DUMP,
179 		.flags	= GENL_UNS_ADMIN_PERM,
180 		.doit	= tipc_nl_bearer_set,
181 	},
182 	{
183 		.cmd	= TIPC_NL_SOCK_GET,
184 		.validate = GENL_DONT_VALIDATE_STRICT | GENL_DONT_VALIDATE_DUMP,
185 		.start = tipc_dump_start,
186 		.dumpit	= tipc_nl_sk_dump,
187 		.done	= tipc_dump_done,
188 	},
189 	{
190 		.cmd	= TIPC_NL_PUBL_GET,
191 		.validate = GENL_DONT_VALIDATE_STRICT |
192 			    GENL_DONT_VALIDATE_DUMP_STRICT,
193 		.dumpit	= tipc_nl_publ_dump,
194 	},
195 	{
196 		.cmd	= TIPC_NL_LINK_GET,
197 		.validate = GENL_DONT_VALIDATE_STRICT,
198 		.doit   = tipc_nl_node_get_link,
199 		.dumpit	= tipc_nl_node_dump_link,
200 	},
201 	{
202 		.cmd	= TIPC_NL_LINK_SET,
203 		.validate = GENL_DONT_VALIDATE_STRICT | GENL_DONT_VALIDATE_DUMP,
204 		.flags	= GENL_UNS_ADMIN_PERM,
205 		.doit	= tipc_nl_node_set_link,
206 	},
207 	{
208 		.cmd	= TIPC_NL_LINK_RESET_STATS,
209 		.validate = GENL_DONT_VALIDATE_STRICT | GENL_DONT_VALIDATE_DUMP,
210 		.flags	= GENL_UNS_ADMIN_PERM,
211 		.doit   = tipc_nl_node_reset_link_stats,
212 	},
213 	{
214 		.cmd	= TIPC_NL_MEDIA_GET,
215 		.validate = GENL_DONT_VALIDATE_STRICT | GENL_DONT_VALIDATE_DUMP,
216 		.doit	= tipc_nl_media_get,
217 		.dumpit	= tipc_nl_media_dump,
218 	},
219 	{
220 		.cmd	= TIPC_NL_MEDIA_SET,
221 		.validate = GENL_DONT_VALIDATE_STRICT | GENL_DONT_VALIDATE_DUMP,
222 		.flags	= GENL_UNS_ADMIN_PERM,
223 		.doit	= tipc_nl_media_set,
224 	},
225 	{
226 		.cmd	= TIPC_NL_NODE_GET,
227 		.validate = GENL_DONT_VALIDATE_STRICT | GENL_DONT_VALIDATE_DUMP,
228 		.dumpit	= tipc_nl_node_dump,
229 	},
230 	{
231 		.cmd	= TIPC_NL_NET_GET,
232 		.validate = GENL_DONT_VALIDATE_STRICT | GENL_DONT_VALIDATE_DUMP,
233 		.dumpit	= tipc_nl_net_dump,
234 	},
235 	{
236 		.cmd	= TIPC_NL_NET_SET,
237 		.validate = GENL_DONT_VALIDATE_STRICT | GENL_DONT_VALIDATE_DUMP,
238 		.flags	= GENL_UNS_ADMIN_PERM,
239 		.doit	= tipc_nl_net_set,
240 	},
241 	{
242 		.cmd	= TIPC_NL_NAME_TABLE_GET,
243 		.validate = GENL_DONT_VALIDATE_STRICT | GENL_DONT_VALIDATE_DUMP,
244 		.dumpit	= tipc_nl_name_table_dump,
245 	},
246 	{
247 		.cmd	= TIPC_NL_MON_SET,
248 		.validate = GENL_DONT_VALIDATE_STRICT | GENL_DONT_VALIDATE_DUMP,
249 		.flags	= GENL_UNS_ADMIN_PERM,
250 		.doit	= tipc_nl_node_set_monitor,
251 	},
252 	{
253 		.cmd	= TIPC_NL_MON_GET,
254 		.validate = GENL_DONT_VALIDATE_STRICT | GENL_DONT_VALIDATE_DUMP,
255 		.doit	= tipc_nl_node_get_monitor,
256 		.dumpit	= tipc_nl_node_dump_monitor,
257 	},
258 	{
259 		.cmd	= TIPC_NL_MON_PEER_GET,
260 		.validate = GENL_DONT_VALIDATE_STRICT |
261 			    GENL_DONT_VALIDATE_DUMP_STRICT,
262 		.dumpit	= tipc_nl_node_dump_monitor_peer,
263 	},
264 	{
265 		.cmd	= TIPC_NL_PEER_REMOVE,
266 		.validate = GENL_DONT_VALIDATE_STRICT | GENL_DONT_VALIDATE_DUMP,
267 		.flags	= GENL_UNS_ADMIN_PERM,
268 		.doit	= tipc_nl_peer_rm,
269 	},
270 #ifdef CONFIG_TIPC_MEDIA_UDP
271 	{
272 		.cmd	= TIPC_NL_UDP_GET_REMOTEIP,
273 		.validate = GENL_DONT_VALIDATE_STRICT |
274 			    GENL_DONT_VALIDATE_DUMP_STRICT,
275 		.dumpit	= tipc_udp_nl_dump_remoteip,
276 	},
277 #endif
278 #ifdef CONFIG_TIPC_CRYPTO
279 	{
280 		.cmd	= TIPC_NL_KEY_SET,
281 		.validate = GENL_DONT_VALIDATE_STRICT | GENL_DONT_VALIDATE_DUMP,
282 		.flags	= GENL_UNS_ADMIN_PERM,
283 		.doit	= tipc_nl_node_set_key,
284 	},
285 	{
286 		.cmd	= TIPC_NL_KEY_FLUSH,
287 		.validate = GENL_DONT_VALIDATE_STRICT | GENL_DONT_VALIDATE_DUMP,
288 		.flags	= GENL_UNS_ADMIN_PERM,
289 		.doit	= tipc_nl_node_flush_key,
290 	},
291 #endif
292 	{
293 		.cmd	= TIPC_NL_ADDR_LEGACY_GET,
294 		.validate = GENL_DONT_VALIDATE_STRICT | GENL_DONT_VALIDATE_DUMP,
295 		.doit	= tipc_nl_net_addr_legacy_get,
296 	},
297 };
298 
299 struct genl_family tipc_genl_family __ro_after_init = {
300 	.name		= TIPC_GENL_V2_NAME,
301 	.version	= TIPC_GENL_V2_VERSION,
302 	.hdrsize	= 0,
303 	.maxattr	= TIPC_NLA_MAX,
304 	.policy		= tipc_nl_policy,
305 	.netnsok	= true,
306 	.module		= THIS_MODULE,
307 	.ops		= tipc_genl_v2_ops,
308 	.n_ops		= ARRAY_SIZE(tipc_genl_v2_ops),
309 	.resv_start_op	= TIPC_NL_ADDR_LEGACY_GET + 1,
310 };
311 
312 int __init tipc_netlink_start(void)
313 {
314 	int res;
315 
316 	res = genl_register_family(&tipc_genl_family);
317 	if (res) {
318 		pr_err("Failed to register netlink interface\n");
319 		return res;
320 	}
321 	return 0;
322 }
323 
324 void tipc_netlink_stop(void)
325 {
326 	genl_unregister_family(&tipc_genl_family);
327 }
328