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