VBoxManageNATNetwork.cpp@ 60422

Last change on this file since 60422 was 57358, checked in by vboxsync, 9 years ago
*: scm cleanup run.
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 15.3 KB

Line
1	/* $Id: VBoxManageNATNetwork.cpp 57358 2015-08-14 15:16:38Z vboxsync $ */
2	/** @file
3	* VBoxManage - Implementation of NAT Network command command.
4	*/
5
6	/*
7	* Copyright (C) 2006-2013 Oracle Corporation
8	*
9	* This file is part of VirtualBox Open Source Edition (OSE), as
10	* available from http://www.virtualbox.org. This file is free software;
11	* you can redistribute it and/or modify it under the terms of the GNU
12	* General Public License (GPL) as published by the Free Software
13	* Foundation, in version 2 as it comes in the "COPYING" file of the
14	* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
15	* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
16	*/
17
18
19	/*********************************************************************************************************************************
20	* Header Files *
21	*********************************************************************************************************************************/
22	#ifndef VBOX_ONLY_DOCS
23
24	#include <VBox/com/com.h>
25	#include <VBox/com/array.h>
26	#include <VBox/com/ErrorInfo.h>
27	#include <VBox/com/errorprint.h>
28	#include <VBox/com/VirtualBox.h>
29	#endif /* !VBOX_ONLY_DOCS */
30
31	#ifndef RT_OS_WINDOWS
32	# include <netinet/in.h>
33	#else
34	/* from <ws2ipdef.h> */
35	# define INET6_ADDRSTRLEN 65
36	#endif
37
38	#define IPv6
39
40	#include <iprt/cdefs.h>
41	#include <iprt/cidr.h>
42	#include <iprt/param.h>
43	#include <iprt/path.h>
44	#include <iprt/stream.h>
45	#include <iprt/string.h>
46	#include <iprt/net.h>
47	#include <iprt/getopt.h>
48	#include <iprt/ctype.h>
49
50	#include <VBox/log.h>
51
52	#include <vector>
53	#include <string>
54
55	#include "VBoxManage.h"
56	#include "VBoxPortForwardString.h"
57
58	#ifndef VBOX_ONLY_DOCS
59
60	using namespace com;
61
62	typedef enum
63	{
64	OP_ADD = 1000,
65	OP_REMOVE,
66	OP_MODIFY,
67	OP_START,
68	OP_STOP
69	} OPCODE;
70
71	typedef struct PFNAME2DELETE
72	{
73	char szName[PF_NAMELEN];
74	bool fIPv6;
75	} PFNAME2DELETE, *PPFNAME2DELETE;
76
77	typedef std::vector<PFNAME2DELETE> VPF2DELETE;
78	typedef VPF2DELETE::const_iterator VPF2DELETEITERATOR;
79
80	typedef std::vector<PORTFORWARDRULE> VPF2ADD;
81	typedef VPF2ADD::const_iterator VPF2ADDITERATOR;
82
83	typedef std::vector<std::string> LOOPBACK2DELETEADD;
84	typedef LOOPBACK2DELETEADD::iterator LOOPBACK2DELETEADDITERATOR;
85
86	static RTEXITCODE handleOp(HandlerArg *a, OPCODE enmCode)
87	{
88	if (a->argc - 1 <= 1)
89	return errorSyntax(USAGE_NATNETWORK, "Not enough parameters");
90
91	const char *pNetName = NULL;
92	const char *pNetworkCidr = NULL;
93	int enable = -1;
94	int dhcp = -1;
95	int ipv6 = -1;
96
97	VPF2DELETE vPfName2Delete;
98	VPF2ADD vPf2Add;
99
100	LOOPBACK2DELETEADD vLoopback2Delete;
101	LOOPBACK2DELETEADD vLoopback2Add;
102
103	LONG loopback6Offset = 0; /* ignore me */
104
105	static const RTGETOPTDEF g_aNATNetworkIPOptions[] =
106	{
107	{ "--netname", 't', RTGETOPT_REQ_STRING },
108	{ "--network", 'n', RTGETOPT_REQ_STRING },
109	{ "--dhcp", 'h', RTGETOPT_REQ_BOOL },
110	{ "--ipv6", '6', RTGETOPT_REQ_BOOL },
111	{ "--enable", 'e', RTGETOPT_REQ_NOTHING },
112	{ "--disable", 'd', RTGETOPT_REQ_NOTHING },
113	{ "--port-forward-4", 'p', RTGETOPT_REQ_STRING },
114	{ "--port-forward-6", 'P', RTGETOPT_REQ_STRING },
115	{ "--loopback-4", 'l', RTGETOPT_REQ_STRING },
116	{ "--loopback-6", 'L', RTGETOPT_REQ_STRING },
117	};
118
119	int c;
120	RTGETOPTUNION ValueUnion;
121	RTGETOPTSTATE GetState;
122	RTGetOptInit(&GetState, a->argc, a->argv, g_aNATNetworkIPOptions,
123	enmCode != OP_REMOVE ? RT_ELEMENTS(g_aNATNetworkIPOptions) : 4, /* we use only --netname and --ifname for remove*/
124	1, RTGETOPTINIT_FLAGS_NO_STD_OPTS);
125	while ((c = RTGetOpt(&GetState, &ValueUnion)) != 0)
126	{
127	switch (c)
128	{
129	case 't': // --netname
130	if (pNetName)
131	return errorSyntax(USAGE_NATNETWORK, "You can only specify --netname only once.");
132	pNetName = ValueUnion.psz;
133	break;
134
135	case 'n': // --network
136	if (pNetworkCidr)
137	return errorSyntax(USAGE_NATNETWORK, "You can only specify --network only once.");
138	pNetworkCidr = ValueUnion.psz;
139	break;
140
141	case 'e': // --enable
142	if (enable >= 0)
143	return errorSyntax(USAGE_NATNETWORK, "You can specify either --enable or --disable once.");
144	enable = 1;
145	break;
146
147	case 'd': // --disable
148	if (enable >= 0)
149	return errorSyntax(USAGE_NATNETWORK, "You can specify either --enable or --disable once.");
150	enable = 0;
151	break;
152
153	case 'h':
154	if (dhcp != -1)
155	return errorSyntax(USAGE_NATNETWORK, "You can specify --dhcp only once.");
156	dhcp = ValueUnion.f;
157	break;
158
159	case '6':
160	if (ipv6 != -1)
161	return errorSyntax(USAGE_NATNETWORK, "You can specify --ipv6 only once.");
162	ipv6 = ValueUnion.f;
163	break;
164
165	case 'L': /* ipv6 loopback */
166	case 'l': /* ipv4 loopback */
167	if (RTStrCmp(ValueUnion.psz, "delete") == 0)
168	{
169	/* deletion */
170	if (enmCode != OP_MODIFY)
171	errorSyntax(USAGE_NATNETWORK,
172	"loopback couldn't be deleted on modified\n");
173	if (c == 'L')
174	loopback6Offset = -1;
175	else
176	{
177	int vrc;
178	RTGETOPTUNION Addr2Delete;
179	vrc = RTGetOptFetchValue(&GetState,
180	&Addr2Delete,
181	RTGETOPT_REQ_STRING);
182	if (RT_FAILURE(vrc))
183	return errorSyntax(USAGE_NATNETWORK,
184	"Not enough parmaters\n");
185
186	vLoopback2Delete.push_back(std::string(Addr2Delete.psz));
187	}
188	}
189	else
190	{
191	/* addition */
192	if (c == 'L')
193	loopback6Offset = ValueUnion.u32;
194	else
195	vLoopback2Add.push_back(std::string(ValueUnion.psz));
196	}
197	break;
198
199	case 'P': /* ipv6 portforwarding*/
200	case 'p': /* ipv4 portforwarding */
201	{
202	if (RTStrCmp(ValueUnion.psz, "delete") != 0)
203	{
204	/* addition */
205	/* netPfStrToPf will clean up the Pfr */
206	PORTFORWARDRULE Pfr;
207	int irc = netPfStrToPf(ValueUnion.psz, (c == 'P'), &Pfr);
208	if (RT_FAILURE(irc))
209	return errorSyntax(USAGE_NATNETWORK, "Invalid port-forward rule %s\n", ValueUnion.psz);
210
211	vPf2Add.push_back(Pfr);
212	}
213	else
214	{
215	/* deletion */
216	if (enmCode != OP_MODIFY)
217	return errorSyntax(USAGE_NATNETWORK,
218	"Port-forward could be deleted on modify \n");
219
220	RTGETOPTUNION NamePf2DeleteUnion;
221	int vrc = RTGetOptFetchValue(&GetState, &NamePf2DeleteUnion, RTGETOPT_REQ_STRING);
222	if (RT_FAILURE(vrc))
223	return errorSyntax(USAGE_NATNETWORK, "Not enough parmaters\n");
224
225	if (strlen(NamePf2DeleteUnion.psz) > PF_NAMELEN)
226	return errorSyntax(USAGE_NATNETWORK, "Port-forward rule name is too long\n");
227
228	PFNAME2DELETE Name2Delete;
229	RT_ZERO(Name2Delete);
230	RTStrCopy(Name2Delete.szName, PF_NAMELEN, NamePf2DeleteUnion.psz);
231	Name2Delete.fIPv6 = (c == 'P');
232	vPfName2Delete.push_back(Name2Delete);
233	}
234	break;
235	}
236
237	default:
238	return errorGetOpt(USAGE_NATNETWORK, c, &ValueUnion);
239	}
240	}
241
242	if (!pNetName)
243	return errorSyntax(USAGE_NATNETWORK, "You need to specify the --netname option");
244	/* verification */
245	switch (enmCode)
246	{
247	case OP_ADD:
248	if (!pNetworkCidr)
249	return errorSyntax(USAGE_NATNETWORK, "You need to specify the --network option");
250	break;
251	case OP_MODIFY:
252	case OP_REMOVE:
253	case OP_START:
254	case OP_STOP:
255	break;
256	default:
257	AssertMsgFailedReturn(("Unknown operation (:%d)", enmCode), RTEXITCODE_FAILURE);
258	}
259
260	HRESULT rc;
261	Bstr NetName;
262	NetName = Bstr(pNetName);
263
264	ComPtr<INATNetwork> net;
265	rc = a->virtualBox->FindNATNetworkByName(NetName.mutableRaw(), net.asOutParam());
266	if (enmCode == OP_ADD)
267	{
268	if (SUCCEEDED(rc))
269	return errorArgument("NATNetwork server already exists");
270
271	CHECK_ERROR(a->virtualBox, CreateNATNetwork(NetName.raw(), net.asOutParam()));
272	if (FAILED(rc))
273	return errorArgument("Failed to create the NAT network service");
274	}
275	else if (FAILED(rc))
276	return errorArgument("NATNetwork server does not exist");
277
278	switch (enmCode)
279	{
280	case OP_ADD:
281	case OP_MODIFY:
282	{
283	if (pNetworkCidr)
284	{
285	CHECK_ERROR(net, COMSETTER(Network)(Bstr(pNetworkCidr).raw()));
286	if (FAILED(rc))
287	return errorArgument("Failed to set configuration");
288	}
289	if (dhcp >= 0)
290	{
291	CHECK_ERROR(net, COMSETTER(NeedDhcpServer) ((BOOL)dhcp));
292	if (FAILED(rc))
293	return errorArgument("Failed to set configuration");
294	}
295
296	if (ipv6 >= 0)
297	{
298	CHECK_ERROR(net, COMSETTER(IPv6Enabled) ((BOOL)ipv6));
299	if (FAILED(rc))
300	return errorArgument("Failed to set configuration");
301	}
302
303	if (!vPfName2Delete.empty())
304	{
305	VPF2DELETEITERATOR it;
306	for (it = vPfName2Delete.begin(); it != vPfName2Delete.end(); ++it)
307	{
308	CHECK_ERROR(net, RemovePortForwardRule((BOOL)(*it).fIPv6,
309	Bstr((*it).szName).raw()));
310	if (FAILED(rc))
311	return errorArgument("Failed to delete pf");
312	}
313	}
314
315	if (!vPf2Add.empty())
316	{
317	VPF2ADDITERATOR it;
318	for (it = vPf2Add.begin(); it != vPf2Add.end(); ++it)
319	{
320	NATProtocol_T proto = NATProtocol_TCP;
321	if ((*it).iPfrProto == IPPROTO_TCP)
322	proto = NATProtocol_TCP;
323	else if ((*it).iPfrProto == IPPROTO_UDP)
324	proto = NATProtocol_UDP;
325	else
326	continue; /* XXX: warning here. */
327
328	CHECK_ERROR(net, AddPortForwardRule((BOOL)(*it).fPfrIPv6,
329	Bstr((*it).szPfrName).raw(),
330	proto,
331	Bstr((*it).szPfrHostAddr).raw(),
332	(*it).u16PfrHostPort,
333	Bstr((*it).szPfrGuestAddr).raw(),
334	(*it).u16PfrGuestPort));
335	if (FAILED(rc))
336	return errorArgument("Failed to add pf");
337	}
338	}
339
340	if (loopback6Offset)
341	{
342	if (loopback6Offset == -1)
343	loopback6Offset = 0; /* deletion */
344
345	CHECK_ERROR_RET(net, COMSETTER(LoopbackIp6)(loopback6Offset), RTEXITCODE_FAILURE);
346	}
347
348	/* addLocalMapping (hostid, offset) */
349	if (!vLoopback2Add.empty())
350	{
351	/* we're expecting stings 127.0.0.1=5 */
352	LOOPBACK2DELETEADDITERATOR it;
353	for (it = vLoopback2Add.begin();
354	it != vLoopback2Add.end();
355	++it)
356	{
357	std::string address, strOffset;
358	size_t pos = it->find('=');
359	LONG lOffset = 0;
360	Bstr bstrAddress;
361
362	AssertReturn(pos != std::string::npos, errorArgument("invalid loopback string"));
363
364	address = it->substr(0, pos);
365	strOffset = it->substr(pos + 1);
366
367	lOffset = RTStrToUInt32(strOffset.c_str());
368	AssertReturn(lOffset > 0, errorArgument("invalid loopback string"));
369
370	bstrAddress = Bstr(address.c_str());
371
372	CHECK_ERROR_RET(net, AddLocalMapping(bstrAddress.raw(), lOffset), RTEXITCODE_FAILURE);
373	}
374	}
375
376	if (!vLoopback2Delete.empty())
377	{
378	/* we're expecting stings 127.0.0.1 */
379	LOOPBACK2DELETEADDITERATOR it;
380	for (it = vLoopback2Add.begin();
381	it != vLoopback2Add.end();
382	++it)
383	{
384	Bstr bstrAddress;
385	bstrAddress = Bstr(it->c_str());
386
387	CHECK_ERROR_RET(net, AddLocalMapping(bstrAddress.raw(), 0), RTEXITCODE_FAILURE);
388	}
389	}
390
391	if (enable >= 0)
392	{
393	CHECK_ERROR(net, COMSETTER(Enabled) ((BOOL)enable));
394	if (FAILED(rc))
395	return errorArgument("Failed to set configuration");
396	}
397	break;
398	}
399	case OP_REMOVE:
400	{
401	CHECK_ERROR(a->virtualBox, RemoveNATNetwork(net));
402	if (FAILED(rc))
403	return errorArgument("Failed to remove nat network");
404	break;
405	}
406	case OP_START:
407	{
408	CHECK_ERROR(net, Start(Bstr("whatever").raw()));
409	if (FAILED(rc))
410	return errorArgument("Failed to start network");
411	break;
412	}
413	case OP_STOP:
414	{
415	CHECK_ERROR(net, Stop());
416	if (FAILED(rc))
417	return errorArgument("Failed to start network");
418	break;
419	}
420	default:;
421	}
422	return RTEXITCODE_SUCCESS;
423	}
424
425
426	RTEXITCODE handleNATNetwork(HandlerArg *a)
427	{
428	if (a->argc < 1)
429	return errorSyntax(USAGE_NATNETWORK, "Not enough parameters");
430
431	RTEXITCODE rcExit;
432	if (strcmp(a->argv[0], "modify") == 0)
433	rcExit = handleOp(a, OP_MODIFY);
434	else if (strcmp(a->argv[0], "add") == 0)
435	rcExit = handleOp(a, OP_ADD);
436	else if (strcmp(a->argv[0], "remove") == 0)
437	rcExit = handleOp(a, OP_REMOVE);
438	else if (strcmp(a->argv[0], "start") == 0)
439	rcExit = handleOp(a, OP_START);
440	else if (strcmp(a->argv[0], "stop") == 0)
441	rcExit = handleOp(a, OP_STOP);
442	else
443	rcExit = errorSyntax(USAGE_NATNETWORK, "Invalid parameter '%s'", Utf8Str(a->argv[0]).c_str());
444	return rcExit;
445	}
446
447	#endif /* !VBOX_ONLY_DOCS */

Note: See TracBrowser for help on using the repository browser.

source: vbox/trunk/src/VBox/Frontends/VBoxManage/VBoxManageNATNetwork.cpp@ 60422

Download in other formats: