* README: Update to reflect reality.
[NetworkManager.git] / README
1 THEORY OF OPERATION:
2
3 NetworkManager attempts to keep an active network connection available at all
4 times.  The point of NetworkManager is to make networking configuration and
5 setup as painless and automatic as possible.  If using DHCP, NetworkManager is
6 _intended_ to replace default routes, obtain IP addresses from a DHCP server,
7 and change nameservers whenever it sees fit.  In effect, the goal of
8 NetworkManager is to make networking Just Work.  If you have special needs,
9 we'd like to hear about them, but understand that NetworkManager is not
10 intended to serve the needs of all users.
11
12
13 From a list of all adapters currently installed on the system, NetworkManager
14 will first try a wired and then a wireless adapter.  Wireless adapters that
15 support wireless scanning are preferred over ones that cannot.  NetworkManager
16 does not try to keep a connection up as long as possible, meaning that plugging
17 into a wired network will switch the connection to the wired network away from
18 the wireless one.
19
20 For wireless networking support, NetworkManager keeps a list of wireless
21 networks, the preferred list.  Preferred Networks are wireless networks that
22 the user has explicitly made NetworkManager associate with at some previous
23 time.  So if the user walks into a Starbucks and explicitly asks NetworkManager to associate with that Starbucks network, NetworkManager will remember the
24 Starbucks network information from that point on.  Upon returning to that
25 Starbucks, NetworkManager will attempt to associate _automatically_ with the
26 Starbucks network since it is now in the Preferred Networks list.  The point of
27 this is to ensure that only the user can determine which wireless networks to
28 associate with, and that the user is aware which networks are security risks
29 and which are not.
30
31
32 STRUCTURE:
33
34 NetworkManager runs as a root-user system level daemon, since it
35 must manipulate hardware directly.  It communicates over DBUS with a
36 desktop-level per-user process, nm-applet.  Since Preferred Networks are
37 user-specific, there must be some mechanism of getting this information
38 per-user.  NetworkManager cannot store that information as it is user-specific,
39 and therefore communicates over DBUS to the user daemon which provides those
40 lists.  NetworkManager also provides an API over DBUS for any DBUS-aware
41 application to determine the current state of the network, including available
42 wireless networks the computer is aware of and specific details about those
43 networks.  This API also provides the means for forcing NetworkManager to
44 associate with a specific wireless network.  Use of DBUS allows separation of
45 NetworkManager, which requires no user-interface, and the parts of the user
46 interface which might be desktop environment specific.
47
48 The nm-applet provides a DBUS service called NetworkManagerInfo, which should
49 provide to NetworkManager the Preferred Networks lists upon request.  It also
50 should be able to display a dialog to retrieve a WEP/WPA key or passphrase from
51 the user when NetworkManager requests it.  The GNOME version of
52 NetworkManagerInfo, for example, stores Preferred Networks in GConf and
53 WEP/WPA keys in gnome-keyring, and proxies that information to NetworkManager
54 upon request.