Darin Petkov | 50308cd | 2011-06-01 18:25:07 -0700 | [diff] [blame] | 1 | // Copyright (c) 2011 The Chromium OS Authors. All rights reserved. |
| 2 | // Use of this source code is governed by a BSD-style license that can be |
| 3 | // found in the LICENSE file. |
| 4 | |
| 5 | #include "shill/dhcp_config.h" |
| 6 | |
Darin Petkov | e7cb7f8 | 2011-06-03 13:21:51 -0700 | [diff] [blame] | 7 | #include <arpa/inet.h> |
| 8 | |
Darin Petkov | 92c4390 | 2011-06-09 20:46:06 -0700 | [diff] [blame] | 9 | #include <base/file_util.h> |
Darin Petkov | 50308cd | 2011-06-01 18:25:07 -0700 | [diff] [blame] | 10 | #include <base/logging.h> |
Darin Petkov | 92c4390 | 2011-06-09 20:46:06 -0700 | [diff] [blame] | 11 | #include <base/stringprintf.h> |
Chris Masone | 43b48a1 | 2011-07-01 13:37:07 -0700 | [diff] [blame] | 12 | #include <chromeos/dbus/service_constants.h> |
Darin Petkov | d1b715b | 2011-06-02 21:21:22 -0700 | [diff] [blame] | 13 | |
| 14 | #include "shill/dhcpcd_proxy.h" |
| 15 | #include "shill/dhcp_provider.h" |
Darin Petkov | 3258a81 | 2011-06-23 11:28:45 -0700 | [diff] [blame] | 16 | #include "shill/glib.h" |
Paul Stewart | 1d18e8c | 2011-07-15 11:00:31 -0700 | [diff] [blame] | 17 | #include "shill/ip_address.h" |
Darin Petkov | aceede3 | 2011-07-18 15:32:38 -0700 | [diff] [blame] | 18 | #include "shill/proxy_factory.h" |
Darin Petkov | 50308cd | 2011-06-01 18:25:07 -0700 | [diff] [blame] | 19 | |
Darin Petkov | e7cb7f8 | 2011-06-03 13:21:51 -0700 | [diff] [blame] | 20 | using std::string; |
| 21 | using std::vector; |
| 22 | |
Darin Petkov | 50308cd | 2011-06-01 18:25:07 -0700 | [diff] [blame] | 23 | namespace shill { |
| 24 | |
Darin Petkov | e7cb7f8 | 2011-06-03 13:21:51 -0700 | [diff] [blame] | 25 | const char DHCPConfig::kConfigurationKeyBroadcastAddress[] = "BroadcastAddress"; |
| 26 | const char DHCPConfig::kConfigurationKeyDNS[] = "DomainNameServers"; |
| 27 | const char DHCPConfig::kConfigurationKeyDomainName[] = "DomainName"; |
| 28 | const char DHCPConfig::kConfigurationKeyDomainSearch[] = "DomainSearch"; |
| 29 | const char DHCPConfig::kConfigurationKeyIPAddress[] = "IPAddress"; |
| 30 | const char DHCPConfig::kConfigurationKeyMTU[] = "InterfaceMTU"; |
| 31 | const char DHCPConfig::kConfigurationKeyRouters[] = "Routers"; |
| 32 | const char DHCPConfig::kConfigurationKeySubnetCIDR[] = "SubnetCIDR"; |
Darin Petkov | d1b715b | 2011-06-02 21:21:22 -0700 | [diff] [blame] | 33 | const char DHCPConfig::kDHCPCDPath[] = "/sbin/dhcpcd"; |
Darin Petkov | 92c4390 | 2011-06-09 20:46:06 -0700 | [diff] [blame] | 34 | const char DHCPConfig::kDHCPCDPathFormatLease[] = "var/run/dhcpcd-%s.lease"; |
| 35 | const char DHCPConfig::kDHCPCDPathFormatPID[] = "var/run/dhcpcd-%s.pid"; |
Darin Petkov | f9b0ca8 | 2011-06-20 12:10:23 -0700 | [diff] [blame] | 36 | const char DHCPConfig::kReasonBound[] = "BOUND"; |
| 37 | const char DHCPConfig::kReasonFail[] = "FAIL"; |
| 38 | const char DHCPConfig::kReasonRebind[] = "REBIND"; |
| 39 | const char DHCPConfig::kReasonReboot[] = "REBOOT"; |
| 40 | const char DHCPConfig::kReasonRenew[] = "RENEW"; |
| 41 | |
Darin Petkov | e7cb7f8 | 2011-06-03 13:21:51 -0700 | [diff] [blame] | 42 | |
Chris Masone | 19e3040 | 2011-07-19 15:48:47 -0700 | [diff] [blame^] | 43 | DHCPConfig::DHCPConfig(ControlInterface *control_interface, |
| 44 | DHCPProvider *provider, |
Darin Petkov | f65e928 | 2011-06-21 14:29:56 -0700 | [diff] [blame] | 45 | const string &device_name, |
Darin Petkov | 3258a81 | 2011-06-23 11:28:45 -0700 | [diff] [blame] | 46 | GLib *glib) |
Chris Masone | 19e3040 | 2011-07-19 15:48:47 -0700 | [diff] [blame^] | 47 | : IPConfig(control_interface, device_name), |
Darin Petkov | d1b715b | 2011-06-02 21:21:22 -0700 | [diff] [blame] | 48 | provider_(provider), |
Darin Petkov | f7897bc | 2011-06-08 17:13:36 -0700 | [diff] [blame] | 49 | pid_(0), |
Darin Petkov | 92c4390 | 2011-06-09 20:46:06 -0700 | [diff] [blame] | 50 | child_watch_tag_(0), |
| 51 | root_("/"), |
Darin Petkov | f7897bc | 2011-06-08 17:13:36 -0700 | [diff] [blame] | 52 | glib_(glib) { |
Chris Masone | 27c4aa5 | 2011-07-02 13:10:14 -0700 | [diff] [blame] | 53 | store_.RegisterConstString(flimflam::kAddressProperty, |
| 54 | &(properties().address)); |
Darin Petkov | f65e928 | 2011-06-21 14:29:56 -0700 | [diff] [blame] | 55 | VLOG(2) << __func__ << ": " << device_name; |
Darin Petkov | 50308cd | 2011-06-01 18:25:07 -0700 | [diff] [blame] | 56 | } |
| 57 | |
| 58 | DHCPConfig::~DHCPConfig() { |
Darin Petkov | f65e928 | 2011-06-21 14:29:56 -0700 | [diff] [blame] | 59 | VLOG(2) << __func__ << ": " << device_name(); |
Darin Petkov | 92c4390 | 2011-06-09 20:46:06 -0700 | [diff] [blame] | 60 | |
| 61 | // Don't leave behind dhcpcd running. |
| 62 | Stop(); |
| 63 | |
Darin Petkov | 98dd6a0 | 2011-06-10 15:12:57 -0700 | [diff] [blame] | 64 | // Make sure we don't get any callbacks to the destroyed instance. |
Darin Petkov | 92c4390 | 2011-06-09 20:46:06 -0700 | [diff] [blame] | 65 | CleanupClientState(); |
Darin Petkov | d1b715b | 2011-06-02 21:21:22 -0700 | [diff] [blame] | 66 | } |
| 67 | |
Darin Petkov | 92c4390 | 2011-06-09 20:46:06 -0700 | [diff] [blame] | 68 | bool DHCPConfig::RequestIP() { |
Darin Petkov | f65e928 | 2011-06-21 14:29:56 -0700 | [diff] [blame] | 69 | VLOG(2) << __func__ << ": " << device_name(); |
Darin Petkov | d1b715b | 2011-06-02 21:21:22 -0700 | [diff] [blame] | 70 | if (!pid_) { |
| 71 | return Start(); |
| 72 | } |
| 73 | if (!proxy_.get()) { |
Darin Petkov | 98dd6a0 | 2011-06-10 15:12:57 -0700 | [diff] [blame] | 74 | LOG(ERROR) << "Unable to request IP before acquiring destination."; |
| 75 | return Restart(); |
Darin Petkov | d1b715b | 2011-06-02 21:21:22 -0700 | [diff] [blame] | 76 | } |
Darin Petkov | 92c4390 | 2011-06-09 20:46:06 -0700 | [diff] [blame] | 77 | return RenewIP(); |
Darin Petkov | d1b715b | 2011-06-02 21:21:22 -0700 | [diff] [blame] | 78 | } |
| 79 | |
Darin Petkov | 92c4390 | 2011-06-09 20:46:06 -0700 | [diff] [blame] | 80 | bool DHCPConfig::RenewIP() { |
Darin Petkov | f65e928 | 2011-06-21 14:29:56 -0700 | [diff] [blame] | 81 | VLOG(2) << __func__ << ": " << device_name(); |
Darin Petkov | 98dd6a0 | 2011-06-10 15:12:57 -0700 | [diff] [blame] | 82 | if (!pid_) { |
| 83 | return false; |
| 84 | } |
| 85 | if (!proxy_.get()) { |
| 86 | LOG(ERROR) << "Unable to renew IP before acquiring destination."; |
Darin Petkov | d1b715b | 2011-06-02 21:21:22 -0700 | [diff] [blame] | 87 | return false; |
| 88 | } |
Darin Petkov | aceede3 | 2011-07-18 15:32:38 -0700 | [diff] [blame] | 89 | proxy_->Rebind(device_name()); |
Darin Petkov | d1b715b | 2011-06-02 21:21:22 -0700 | [diff] [blame] | 90 | return true; |
| 91 | } |
| 92 | |
Darin Petkov | 92c4390 | 2011-06-09 20:46:06 -0700 | [diff] [blame] | 93 | bool DHCPConfig::ReleaseIP() { |
Darin Petkov | f65e928 | 2011-06-21 14:29:56 -0700 | [diff] [blame] | 94 | VLOG(2) << __func__ << ": " << device_name(); |
Darin Petkov | 98dd6a0 | 2011-06-10 15:12:57 -0700 | [diff] [blame] | 95 | if (!pid_) { |
| 96 | return true; |
| 97 | } |
| 98 | if (!proxy_.get()) { |
| 99 | LOG(ERROR) << "Unable to release IP before acquiring destination."; |
| 100 | return false; |
| 101 | } |
Darin Petkov | aceede3 | 2011-07-18 15:32:38 -0700 | [diff] [blame] | 102 | proxy_->Release(device_name()); |
Darin Petkov | 98dd6a0 | 2011-06-10 15:12:57 -0700 | [diff] [blame] | 103 | Stop(); |
| 104 | return true; |
Darin Petkov | 92c4390 | 2011-06-09 20:46:06 -0700 | [diff] [blame] | 105 | } |
| 106 | |
Darin Petkov | aceede3 | 2011-07-18 15:32:38 -0700 | [diff] [blame] | 107 | void DHCPConfig::InitProxy(const char *service) { |
Darin Petkov | d1b715b | 2011-06-02 21:21:22 -0700 | [diff] [blame] | 108 | if (!proxy_.get()) { |
Darin Petkov | aceede3 | 2011-07-18 15:32:38 -0700 | [diff] [blame] | 109 | proxy_.reset(ProxyFactory::factory()->CreateDHCPProxy(service)); |
Darin Petkov | d1b715b | 2011-06-02 21:21:22 -0700 | [diff] [blame] | 110 | } |
| 111 | } |
| 112 | |
Darin Petkov | f9b0ca8 | 2011-06-20 12:10:23 -0700 | [diff] [blame] | 113 | void DHCPConfig::ProcessEventSignal(const string &reason, |
Darin Petkov | e7cb7f8 | 2011-06-03 13:21:51 -0700 | [diff] [blame] | 114 | const Configuration &configuration) { |
| 115 | LOG(INFO) << "Event reason: " << reason; |
Darin Petkov | f9b0ca8 | 2011-06-20 12:10:23 -0700 | [diff] [blame] | 116 | if (reason == kReasonFail) { |
| 117 | LOG(ERROR) << "Received failure event from DHCP client."; |
| 118 | UpdateProperties(IPConfig::Properties(), false); |
Darin Petkov | e7cb7f8 | 2011-06-03 13:21:51 -0700 | [diff] [blame] | 119 | return; |
| 120 | } |
Darin Petkov | f9b0ca8 | 2011-06-20 12:10:23 -0700 | [diff] [blame] | 121 | if (reason != kReasonBound && |
| 122 | reason != kReasonRebind && |
| 123 | reason != kReasonReboot && |
| 124 | reason != kReasonRenew) { |
| 125 | LOG(WARNING) << "Event ignored."; |
| 126 | return; |
| 127 | } |
| 128 | IPConfig::Properties properties; |
| 129 | CHECK(ParseConfiguration(configuration, &properties)); |
| 130 | UpdateProperties(properties, true); |
Darin Petkov | e7cb7f8 | 2011-06-03 13:21:51 -0700 | [diff] [blame] | 131 | } |
| 132 | |
Darin Petkov | d1b715b | 2011-06-02 21:21:22 -0700 | [diff] [blame] | 133 | bool DHCPConfig::Start() { |
Darin Petkov | f65e928 | 2011-06-21 14:29:56 -0700 | [diff] [blame] | 134 | VLOG(2) << __func__ << ": " << device_name(); |
Darin Petkov | d1b715b | 2011-06-02 21:21:22 -0700 | [diff] [blame] | 135 | |
Darin Petkov | 98dd6a0 | 2011-06-10 15:12:57 -0700 | [diff] [blame] | 136 | char *argv[4] = { |
| 137 | const_cast<char *>(kDHCPCDPath), |
| 138 | const_cast<char *>("-B"), // foreground |
Darin Petkov | f65e928 | 2011-06-21 14:29:56 -0700 | [diff] [blame] | 139 | const_cast<char *>(device_name().c_str()), |
Darin Petkov | 98dd6a0 | 2011-06-10 15:12:57 -0700 | [diff] [blame] | 140 | NULL |
| 141 | }; |
| 142 | char *envp[1] = { NULL }; |
Darin Petkov | d1b715b | 2011-06-02 21:21:22 -0700 | [diff] [blame] | 143 | |
Darin Petkov | 98dd6a0 | 2011-06-10 15:12:57 -0700 | [diff] [blame] | 144 | CHECK(!pid_); |
Darin Petkov | f7897bc | 2011-06-08 17:13:36 -0700 | [diff] [blame] | 145 | if (!glib_->SpawnAsync(NULL, |
| 146 | argv, |
| 147 | envp, |
| 148 | G_SPAWN_DO_NOT_REAP_CHILD, |
| 149 | NULL, |
| 150 | NULL, |
Darin Petkov | 98dd6a0 | 2011-06-10 15:12:57 -0700 | [diff] [blame] | 151 | &pid_, |
Darin Petkov | f7897bc | 2011-06-08 17:13:36 -0700 | [diff] [blame] | 152 | NULL)) { |
Darin Petkov | d1b715b | 2011-06-02 21:21:22 -0700 | [diff] [blame] | 153 | LOG(ERROR) << "Unable to spawn " << kDHCPCDPath; |
| 154 | return false; |
| 155 | } |
Darin Petkov | d1b715b | 2011-06-02 21:21:22 -0700 | [diff] [blame] | 156 | LOG(INFO) << "Spawned " << kDHCPCDPath << " with pid: " << pid_; |
Darin Petkov | f7897bc | 2011-06-08 17:13:36 -0700 | [diff] [blame] | 157 | provider_->BindPID(pid_, this); |
Darin Petkov | 98dd6a0 | 2011-06-10 15:12:57 -0700 | [diff] [blame] | 158 | CHECK(!child_watch_tag_); |
| 159 | child_watch_tag_ = glib_->ChildWatchAdd(pid_, ChildWatchCallback, this); |
Darin Petkov | d1b715b | 2011-06-02 21:21:22 -0700 | [diff] [blame] | 160 | return true; |
Darin Petkov | 50308cd | 2011-06-01 18:25:07 -0700 | [diff] [blame] | 161 | } |
| 162 | |
Darin Petkov | 92c4390 | 2011-06-09 20:46:06 -0700 | [diff] [blame] | 163 | void DHCPConfig::Stop() { |
| 164 | if (pid_) { |
| 165 | VLOG(2) << "Terminating " << pid_; |
| 166 | PLOG_IF(ERROR, kill(pid_, SIGTERM) < 0); |
| 167 | } |
| 168 | } |
| 169 | |
Darin Petkov | 98dd6a0 | 2011-06-10 15:12:57 -0700 | [diff] [blame] | 170 | bool DHCPConfig::Restart() { |
| 171 | // Check to ensure that this instance doesn't get destroyed in the middle of |
| 172 | // this call. If stopping a running client while there's only one reference to |
| 173 | // this instance, we will end up destroying it when the PID is unbound from |
| 174 | // the Provider. Since the Provider doesn't invoke Restart, this would mean |
| 175 | // that Restart was erroneously executed through a bare reference. |
| 176 | CHECK(!pid_ || !HasOneRef()); |
| 177 | Stop(); |
| 178 | if (pid_) { |
| 179 | provider_->UnbindPID(pid_); |
| 180 | } |
| 181 | CleanupClientState(); |
| 182 | return Start(); |
| 183 | } |
| 184 | |
Darin Petkov | e7cb7f8 | 2011-06-03 13:21:51 -0700 | [diff] [blame] | 185 | string DHCPConfig::GetIPv4AddressString(unsigned int address) { |
| 186 | char str[INET_ADDRSTRLEN]; |
| 187 | if (inet_ntop(AF_INET, &address, str, arraysize(str))) { |
| 188 | return str; |
| 189 | } |
| 190 | LOG(ERROR) << "Unable to convert IPv4 address to string: " << address; |
| 191 | return ""; |
| 192 | } |
| 193 | |
| 194 | bool DHCPConfig::ParseConfiguration(const Configuration& configuration, |
| 195 | IPConfig::Properties *properties) { |
| 196 | VLOG(2) << __func__; |
Chris Masone | 43b48a1 | 2011-07-01 13:37:07 -0700 | [diff] [blame] | 197 | properties->method = flimflam::kTypeDHCP; |
Paul Stewart | 1d18e8c | 2011-07-15 11:00:31 -0700 | [diff] [blame] | 198 | properties->address_family = IPAddress::kAddressFamilyIPv4; |
Darin Petkov | e7cb7f8 | 2011-06-03 13:21:51 -0700 | [diff] [blame] | 199 | for (Configuration::const_iterator it = configuration.begin(); |
| 200 | it != configuration.end(); ++it) { |
| 201 | const string &key = it->first; |
| 202 | const DBus::Variant &value = it->second; |
| 203 | VLOG(2) << "Processing key: " << key; |
| 204 | if (key == kConfigurationKeyIPAddress) { |
| 205 | properties->address = GetIPv4AddressString(value.reader().get_uint32()); |
| 206 | if (properties->address.empty()) { |
| 207 | return false; |
| 208 | } |
| 209 | } else if (key == kConfigurationKeySubnetCIDR) { |
| 210 | properties->subnet_cidr = value.reader().get_byte(); |
| 211 | } else if (key == kConfigurationKeyBroadcastAddress) { |
| 212 | properties->broadcast_address = |
| 213 | GetIPv4AddressString(value.reader().get_uint32()); |
| 214 | if (properties->broadcast_address.empty()) { |
| 215 | return false; |
| 216 | } |
| 217 | } else if (key == kConfigurationKeyRouters) { |
Darin Petkov | f7897bc | 2011-06-08 17:13:36 -0700 | [diff] [blame] | 218 | vector<unsigned int> routers = value.operator vector<unsigned int>(); |
Darin Petkov | e7cb7f8 | 2011-06-03 13:21:51 -0700 | [diff] [blame] | 219 | if (routers.empty()) { |
| 220 | LOG(ERROR) << "No routers provided."; |
| 221 | return false; |
| 222 | } |
| 223 | properties->gateway = GetIPv4AddressString(routers[0]); |
| 224 | if (properties->gateway.empty()) { |
| 225 | return false; |
| 226 | } |
| 227 | } else if (key == kConfigurationKeyDNS) { |
Darin Petkov | f7897bc | 2011-06-08 17:13:36 -0700 | [diff] [blame] | 228 | vector<unsigned int> servers = value.operator vector<unsigned int>(); |
Darin Petkov | e7cb7f8 | 2011-06-03 13:21:51 -0700 | [diff] [blame] | 229 | for (vector<unsigned int>::const_iterator it = servers.begin(); |
| 230 | it != servers.end(); ++it) { |
| 231 | string server = GetIPv4AddressString(*it); |
| 232 | if (server.empty()) { |
| 233 | return false; |
| 234 | } |
| 235 | properties->dns_servers.push_back(server); |
| 236 | } |
| 237 | } else if (key == kConfigurationKeyDomainName) { |
| 238 | properties->domain_name = value.reader().get_string(); |
| 239 | } else if (key == kConfigurationKeyDomainSearch) { |
Darin Petkov | f7897bc | 2011-06-08 17:13:36 -0700 | [diff] [blame] | 240 | properties->domain_search = value.operator vector<string>(); |
Darin Petkov | e7cb7f8 | 2011-06-03 13:21:51 -0700 | [diff] [blame] | 241 | } else if (key == kConfigurationKeyMTU) { |
| 242 | int mtu = value.reader().get_uint16(); |
| 243 | if (mtu >= 576) { |
| 244 | properties->mtu = mtu; |
| 245 | } |
| 246 | } else { |
| 247 | VLOG(2) << "Key ignored."; |
| 248 | } |
| 249 | } |
| 250 | return true; |
| 251 | } |
| 252 | |
Darin Petkov | 92c4390 | 2011-06-09 20:46:06 -0700 | [diff] [blame] | 253 | void DHCPConfig::ChildWatchCallback(GPid pid, gint status, gpointer data) { |
| 254 | VLOG(2) << "pid " << pid << " exit status " << status; |
| 255 | DHCPConfig *config = reinterpret_cast<DHCPConfig *>(data); |
| 256 | config->child_watch_tag_ = 0; |
Darin Petkov | 92c4390 | 2011-06-09 20:46:06 -0700 | [diff] [blame] | 257 | CHECK_EQ(pid, config->pid_); |
Darin Petkov | 92c4390 | 2011-06-09 20:46:06 -0700 | [diff] [blame] | 258 | config->CleanupClientState(); |
| 259 | |
| 260 | // |config| instance may be destroyed after this call. |
| 261 | config->provider_->UnbindPID(pid); |
| 262 | } |
| 263 | |
| 264 | void DHCPConfig::CleanupClientState() { |
Darin Petkov | 98dd6a0 | 2011-06-10 15:12:57 -0700 | [diff] [blame] | 265 | if (child_watch_tag_) { |
| 266 | glib_->SourceRemove(child_watch_tag_); |
| 267 | child_watch_tag_ = 0; |
| 268 | } |
| 269 | if (pid_) { |
| 270 | glib_->SpawnClosePID(pid_); |
| 271 | pid_ = 0; |
| 272 | } |
Darin Petkov | f9b0ca8 | 2011-06-20 12:10:23 -0700 | [diff] [blame] | 273 | proxy_.reset(); |
Darin Petkov | 92c4390 | 2011-06-09 20:46:06 -0700 | [diff] [blame] | 274 | file_util::Delete(root_.Append(base::StringPrintf(kDHCPCDPathFormatLease, |
Darin Petkov | f65e928 | 2011-06-21 14:29:56 -0700 | [diff] [blame] | 275 | device_name().c_str())), |
Darin Petkov | 92c4390 | 2011-06-09 20:46:06 -0700 | [diff] [blame] | 276 | false); |
| 277 | file_util::Delete(root_.Append(base::StringPrintf(kDHCPCDPathFormatPID, |
Darin Petkov | f65e928 | 2011-06-21 14:29:56 -0700 | [diff] [blame] | 278 | device_name().c_str())), |
Darin Petkov | 92c4390 | 2011-06-09 20:46:06 -0700 | [diff] [blame] | 279 | false); |
| 280 | } |
| 281 | |
Darin Petkov | 50308cd | 2011-06-01 18:25:07 -0700 | [diff] [blame] | 282 | } // namespace shill |