xref: /openbmc/linux/net/tipc/netlink.c (revision 95298d63)
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_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 };
112 
113 /* Properties valid for media, bearer and link */
114 const struct nla_policy tipc_nl_prop_policy[TIPC_NLA_PROP_MAX + 1] = {
115 	[TIPC_NLA_PROP_UNSPEC]		= { .type = NLA_UNSPEC },
116 	[TIPC_NLA_PROP_PRIO]		= { .type = NLA_U32 },
117 	[TIPC_NLA_PROP_TOL]		= { .type = NLA_U32 },
118 	[TIPC_NLA_PROP_WIN]		= { .type = NLA_U32 },
119 	[TIPC_NLA_PROP_MTU]		= { .type = NLA_U32 },
120 	[TIPC_NLA_PROP_BROADCAST]	= { .type = NLA_U32 },
121 	[TIPC_NLA_PROP_BROADCAST_RATIO]	= { .type = NLA_U32 }
122 };
123 
124 const struct nla_policy tipc_nl_bearer_policy[TIPC_NLA_BEARER_MAX + 1]	= {
125 	[TIPC_NLA_BEARER_UNSPEC]	= { .type = NLA_UNSPEC },
126 	[TIPC_NLA_BEARER_NAME]		= { .type = NLA_STRING,
127 					    .len = TIPC_MAX_BEARER_NAME },
128 	[TIPC_NLA_BEARER_PROP]		= { .type = NLA_NESTED },
129 	[TIPC_NLA_BEARER_DOMAIN]	= { .type = NLA_U32 }
130 };
131 
132 const struct nla_policy tipc_nl_media_policy[TIPC_NLA_MEDIA_MAX + 1] = {
133 	[TIPC_NLA_MEDIA_UNSPEC]		= { .type = NLA_UNSPEC },
134 	[TIPC_NLA_MEDIA_NAME]		= { .type = NLA_STRING },
135 	[TIPC_NLA_MEDIA_PROP]		= { .type = NLA_NESTED }
136 };
137 
138 const struct nla_policy tipc_nl_udp_policy[TIPC_NLA_UDP_MAX + 1] = {
139 	[TIPC_NLA_UDP_UNSPEC]	= {.type = NLA_UNSPEC},
140 	[TIPC_NLA_UDP_LOCAL]	= {.type = NLA_BINARY,
141 				   .len = sizeof(struct sockaddr_storage)},
142 	[TIPC_NLA_UDP_REMOTE]	= {.type = NLA_BINARY,
143 				   .len = sizeof(struct sockaddr_storage)},
144 };
145 
146 /* Users of the legacy API (tipc-config) can't handle that we add operations,
147  * so we have a separate genl handling for the new API.
148  */
149 static const struct genl_ops tipc_genl_v2_ops[] = {
150 	{
151 		.cmd	= TIPC_NL_BEARER_DISABLE,
152 		.validate = GENL_DONT_VALIDATE_STRICT | GENL_DONT_VALIDATE_DUMP,
153 		.doit	= tipc_nl_bearer_disable,
154 	},
155 	{
156 		.cmd	= TIPC_NL_BEARER_ENABLE,
157 		.validate = GENL_DONT_VALIDATE_STRICT | GENL_DONT_VALIDATE_DUMP,
158 		.doit	= tipc_nl_bearer_enable,
159 	},
160 	{
161 		.cmd	= TIPC_NL_BEARER_GET,
162 		.validate = GENL_DONT_VALIDATE_STRICT | GENL_DONT_VALIDATE_DUMP,
163 		.doit	= tipc_nl_bearer_get,
164 		.dumpit	= tipc_nl_bearer_dump,
165 	},
166 	{
167 		.cmd	= TIPC_NL_BEARER_ADD,
168 		.validate = GENL_DONT_VALIDATE_STRICT | GENL_DONT_VALIDATE_DUMP,
169 		.doit	= tipc_nl_bearer_add,
170 	},
171 	{
172 		.cmd	= TIPC_NL_BEARER_SET,
173 		.validate = GENL_DONT_VALIDATE_STRICT | GENL_DONT_VALIDATE_DUMP,
174 		.doit	= tipc_nl_bearer_set,
175 	},
176 	{
177 		.cmd	= TIPC_NL_SOCK_GET,
178 		.validate = GENL_DONT_VALIDATE_STRICT | GENL_DONT_VALIDATE_DUMP,
179 		.start = tipc_dump_start,
180 		.dumpit	= tipc_nl_sk_dump,
181 		.done	= tipc_dump_done,
182 	},
183 	{
184 		.cmd	= TIPC_NL_PUBL_GET,
185 		.validate = GENL_DONT_VALIDATE_STRICT |
186 			    GENL_DONT_VALIDATE_DUMP_STRICT,
187 		.dumpit	= tipc_nl_publ_dump,
188 	},
189 	{
190 		.cmd	= TIPC_NL_LINK_GET,
191 		.validate = GENL_DONT_VALIDATE_STRICT,
192 		.doit   = tipc_nl_node_get_link,
193 		.dumpit	= tipc_nl_node_dump_link,
194 	},
195 	{
196 		.cmd	= TIPC_NL_LINK_SET,
197 		.validate = GENL_DONT_VALIDATE_STRICT | GENL_DONT_VALIDATE_DUMP,
198 		.doit	= tipc_nl_node_set_link,
199 	},
200 	{
201 		.cmd	= TIPC_NL_LINK_RESET_STATS,
202 		.validate = GENL_DONT_VALIDATE_STRICT | GENL_DONT_VALIDATE_DUMP,
203 		.doit   = tipc_nl_node_reset_link_stats,
204 	},
205 	{
206 		.cmd	= TIPC_NL_MEDIA_GET,
207 		.validate = GENL_DONT_VALIDATE_STRICT | GENL_DONT_VALIDATE_DUMP,
208 		.doit	= tipc_nl_media_get,
209 		.dumpit	= tipc_nl_media_dump,
210 	},
211 	{
212 		.cmd	= TIPC_NL_MEDIA_SET,
213 		.validate = GENL_DONT_VALIDATE_STRICT | GENL_DONT_VALIDATE_DUMP,
214 		.doit	= tipc_nl_media_set,
215 	},
216 	{
217 		.cmd	= TIPC_NL_NODE_GET,
218 		.validate = GENL_DONT_VALIDATE_STRICT | GENL_DONT_VALIDATE_DUMP,
219 		.dumpit	= tipc_nl_node_dump,
220 	},
221 	{
222 		.cmd	= TIPC_NL_NET_GET,
223 		.validate = GENL_DONT_VALIDATE_STRICT | GENL_DONT_VALIDATE_DUMP,
224 		.dumpit	= tipc_nl_net_dump,
225 	},
226 	{
227 		.cmd	= TIPC_NL_NET_SET,
228 		.validate = GENL_DONT_VALIDATE_STRICT | GENL_DONT_VALIDATE_DUMP,
229 		.doit	= tipc_nl_net_set,
230 	},
231 	{
232 		.cmd	= TIPC_NL_NAME_TABLE_GET,
233 		.validate = GENL_DONT_VALIDATE_STRICT | GENL_DONT_VALIDATE_DUMP,
234 		.dumpit	= tipc_nl_name_table_dump,
235 	},
236 	{
237 		.cmd	= TIPC_NL_MON_SET,
238 		.validate = GENL_DONT_VALIDATE_STRICT | GENL_DONT_VALIDATE_DUMP,
239 		.doit	= tipc_nl_node_set_monitor,
240 	},
241 	{
242 		.cmd	= TIPC_NL_MON_GET,
243 		.validate = GENL_DONT_VALIDATE_STRICT | GENL_DONT_VALIDATE_DUMP,
244 		.doit	= tipc_nl_node_get_monitor,
245 		.dumpit	= tipc_nl_node_dump_monitor,
246 	},
247 	{
248 		.cmd	= TIPC_NL_MON_PEER_GET,
249 		.validate = GENL_DONT_VALIDATE_STRICT |
250 			    GENL_DONT_VALIDATE_DUMP_STRICT,
251 		.dumpit	= tipc_nl_node_dump_monitor_peer,
252 	},
253 	{
254 		.cmd	= TIPC_NL_PEER_REMOVE,
255 		.validate = GENL_DONT_VALIDATE_STRICT | GENL_DONT_VALIDATE_DUMP,
256 		.doit	= tipc_nl_peer_rm,
257 	},
258 #ifdef CONFIG_TIPC_MEDIA_UDP
259 	{
260 		.cmd	= TIPC_NL_UDP_GET_REMOTEIP,
261 		.validate = GENL_DONT_VALIDATE_STRICT |
262 			    GENL_DONT_VALIDATE_DUMP_STRICT,
263 		.dumpit	= tipc_udp_nl_dump_remoteip,
264 	},
265 #endif
266 #ifdef CONFIG_TIPC_CRYPTO
267 	{
268 		.cmd	= TIPC_NL_KEY_SET,
269 		.validate = GENL_DONT_VALIDATE_STRICT | GENL_DONT_VALIDATE_DUMP,
270 		.doit	= tipc_nl_node_set_key,
271 	},
272 	{
273 		.cmd	= TIPC_NL_KEY_FLUSH,
274 		.validate = GENL_DONT_VALIDATE_STRICT | GENL_DONT_VALIDATE_DUMP,
275 		.doit	= tipc_nl_node_flush_key,
276 	},
277 #endif
278 	{
279 		.cmd	= TIPC_NL_ADDR_LEGACY_GET,
280 		.validate = GENL_DONT_VALIDATE_STRICT | GENL_DONT_VALIDATE_DUMP,
281 		.doit	= tipc_nl_net_addr_legacy_get,
282 	},
283 };
284 
285 struct genl_family tipc_genl_family __ro_after_init = {
286 	.name		= TIPC_GENL_V2_NAME,
287 	.version	= TIPC_GENL_V2_VERSION,
288 	.hdrsize	= 0,
289 	.maxattr	= TIPC_NLA_MAX,
290 	.policy		= tipc_nl_policy,
291 	.netnsok	= true,
292 	.module		= THIS_MODULE,
293 	.ops		= tipc_genl_v2_ops,
294 	.n_ops		= ARRAY_SIZE(tipc_genl_v2_ops),
295 };
296 
297 int __init tipc_netlink_start(void)
298 {
299 	int res;
300 
301 	res = genl_register_family(&tipc_genl_family);
302 	if (res) {
303 		pr_err("Failed to register netlink interface\n");
304 		return res;
305 	}
306 	return 0;
307 }
308 
309 void tipc_netlink_stop(void)
310 {
311 	genl_unregister_family(&tipc_genl_family);
312 }
313