2005-02-25 Dan Williams <dcbw@redhat.com>
[NetworkManager.git] / README
1 THEORY OF OPERATION:
2
3 NetworkManager attempts to keep an active network connection available at all
4 times.  It is intended only for the desktop use-case, and is not intended for
5 usage on servers.  At this time, it does not support static IP addresses on
6 network interfaces, and requires DHCP to be used instead.  The point of
7 NetworkManager is to make networking configuration and setup as painless and
8 automatic as possible.  If using DHCP, NetworkManager is _intended_ to replace
9 default routes, obtain IP addresses from a DHCP server, and change nameservers
10 whenever it sees fit.  If you have special needs, we'd like to hear about them,
11 but understand that NetworkManager is not intended to serve the needs of all
12 users.
13
14   
15 From a list of all adapters currently installed on the system, NetworkManager
16 will first try a wired and then a wireless adapter.  Wireless adapters that
17 support wireless scanning are preferred over ones that cannot.  NetworkManager
18 does not try to keep a connection up as long as possible, meaning that plugging
19 into a wired network will switch the connection to the wired network away from
20 the wireless one.
21
22 For wireless networking support, NetworkManager keeps two lists of wireless
23 networks: a Trusted list, and a Preferred list.  The Trusted list contains
24 networks the user specifically adds to it, while the preferred list contains
25 networks the user forces NetworkManager to connect to.  For example, while the
26 company's wireless network and WEP/WPA key would be preloaded into the Trusted
27 Networks list, if the user wished to use the wireless network in a Starbucks,
28 the user would explicitly tell NetworkManager to associate with that network.
29 NetworkManager does not try to use _any_ available network in the area (a
30 possible security risk), but will associate with any Trusted Network first, and
31 Preferred Networks later.  Preferred Networks are ones the user has explicitly
32 made NetworkManager associate with at some previous time.  So if the user walks
33 into a Starbucks and explicitly asks NetworkManager to associate with that
34 Starbucks network, NetworkManager will remember the Starbucks network
35 information from that point on.  Upon returning to that Starbucks,
36 NetworkManager will attempt to associate _automatically_ with the Starbucks
37 network since it is now in the Preferred Networks list.  The point of this is to
38 ensure that only the user can determine which wireless networks to associate
39 with, and that the user is aware which networks are security risks and which
40 are not.
41
42 STRUCTURE:
43
44 NetworkManager runs as a root-user system level daemon, since it must manipulate
45 hardware directly.  It communicates over DBUS with at least one other daemon,
46 the info-daemon.  Since Trusted and Preferred Networks are user-specific, there
47 must be some mechanism of getting this information per-user.  NetworkManager
48 cannot store that information as it is user-specific, and therefore communicates
49 over DBUS to the info-daemon which provides those lists.  NetworkManager also
50 provides an API over DBUS for any DBUS-aware application to determine the
51 current state of the network, including available wireless networks the computer
52 is aware of and specific details about those networks.  This API also provides
53 the means for forcing NetworkManager to associate with a specific wireless
54 network.  Use of DBUS allows separation of NetworkManager, which requires no
55 user-interface, and the parts of the user interface which might be desktop
56 environment specific.
57
58 The info-daemon provides a DBUS service called NetworkManagerInfo, which should
59 provide to NetworkManager the Trusted and Preferred Networks lists upon request.
60 It also should be able to display a dialog to retrieve a WEP/WPA key or
61 passphrase from the user when NetworkManager requests it.  The GNOME version of
62 NetworkManagerInfo, for example, stores Trusted and Preferred Networks in GConf,
63 and proxies that information to NetworkManager upon request.
64
65 Other UI bits might include a user-visible application (for example, the
66 included GNOME Panel applet) providing a list of available wireless networks to
67 the user and a means to manually select one to associate with.
68
69