Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2004-2023 Savoir-faire Linux Inc. |
| 3 | * |
Adrien Béraud | cb75362 | 2023-07-17 22:32:49 -0400 | [diff] [blame] | 4 | * This program is free software: you can redistribute it and/or modify |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 5 | * it under the terms of the GNU General Public License as published by |
Adrien Béraud | cb75362 | 2023-07-17 22:32:49 -0400 | [diff] [blame] | 6 | * the Free Software Foundation, either version 3 of the License, or |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 7 | * (at your option) any later version. |
| 8 | * |
| 9 | * This program is distributed in the hope that it will be useful, |
| 10 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
Adrien Béraud | cb75362 | 2023-07-17 22:32:49 -0400 | [diff] [blame] | 11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 12 | * GNU General Public License for more details. |
| 13 | * |
| 14 | * You should have received a copy of the GNU General Public License |
Adrien Béraud | cb75362 | 2023-07-17 22:32:49 -0400 | [diff] [blame] | 15 | * along with this program. If not, see <https://www.gnu.org/licenses/>. |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 16 | */ |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 17 | #include "nat_pmp.h" |
Sébastien Blin | 4cf587e | 2024-03-08 16:00:18 -0500 | [diff] [blame^] | 18 | #include <poll.h> |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 19 | |
| 20 | #if HAVE_LIBNATPMP |
| 21 | |
Adrien Béraud | 1ae60aa | 2023-07-07 09:55:09 -0400 | [diff] [blame] | 22 | namespace dhtnet { |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 23 | namespace upnp { |
| 24 | |
Adrien Béraud | 370257c | 2023-08-15 20:53:09 -0400 | [diff] [blame] | 25 | NatPmp::NatPmp(const std::shared_ptr<asio::io_context>& ctx, const std::shared_ptr<dht::log::Logger>& logger) |
| 26 | : UPnPProtocol(logger), ioContext(ctx), searchForIgdTimer_(*ctx) |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 27 | { |
Morteza Namvar | 5f63952 | 2023-07-04 17:08:58 -0400 | [diff] [blame] | 28 | // JAMI_DBG("NAT-PMP: Instance [%p] created", this); |
Adrien Béraud | 370257c | 2023-08-15 20:53:09 -0400 | [diff] [blame] | 29 | ioContext->dispatch([this] { |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 30 | igd_ = std::make_shared<PMPIGD>(); |
| 31 | }); |
| 32 | } |
| 33 | |
| 34 | NatPmp::~NatPmp() |
| 35 | { |
Morteza Namvar | 5f63952 | 2023-07-04 17:08:58 -0400 | [diff] [blame] | 36 | // JAMI_DBG("NAT-PMP: Instance [%p] destroyed", this); |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 37 | } |
| 38 | |
| 39 | void |
| 40 | NatPmp::initNatPmp() |
| 41 | { |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 42 | initialized_ = false; |
| 43 | |
| 44 | { |
| 45 | std::lock_guard<std::mutex> lock(natpmpMutex_); |
| 46 | hostAddress_ = ip_utils::getLocalAddr(AF_INET); |
| 47 | } |
| 48 | |
| 49 | // Local address must be valid. |
| 50 | if (not getHostAddress() or getHostAddress().isLoopback()) { |
Adrien Béraud | 17765bd | 2023-08-22 21:02:38 -0400 | [diff] [blame] | 51 | if (logger_) logger_->warn("NAT-PMP: Does not have a valid local address!"); |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 52 | return; |
| 53 | } |
| 54 | |
| 55 | assert(igd_); |
| 56 | if (igd_->isValid()) { |
| 57 | igd_->setValid(false); |
| 58 | processIgdUpdate(UpnpIgdEvent::REMOVED); |
| 59 | } |
| 60 | |
| 61 | igd_->setLocalIp(IpAddr()); |
| 62 | igd_->setPublicIp(IpAddr()); |
| 63 | igd_->setUID(""); |
| 64 | |
Adrien Béraud | 17765bd | 2023-08-22 21:02:38 -0400 | [diff] [blame] | 65 | if (logger_) logger_->debug("NAT-PMP: Trying to initialize IGD"); |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 66 | |
| 67 | int err = initnatpmp(&natpmpHdl_, 0, 0); |
| 68 | |
| 69 | if (err < 0) { |
Adrien Béraud | 17765bd | 2023-08-22 21:02:38 -0400 | [diff] [blame] | 70 | if (logger_) logger_->warn("NAT-PMP: Initializing IGD using default gateway failed!"); |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 71 | const auto& localGw = ip_utils::getLocalGateway(); |
| 72 | if (not localGw) { |
Adrien Béraud | 17765bd | 2023-08-22 21:02:38 -0400 | [diff] [blame] | 73 | if (logger_) logger_->warn("NAT-PMP: Couldn't find valid gateway on local host"); |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 74 | err = NATPMP_ERR_CANNOTGETGATEWAY; |
| 75 | } else { |
Adrien Béraud | 17765bd | 2023-08-22 21:02:38 -0400 | [diff] [blame] | 76 | if (logger_) logger_->warn("NAT-PMP: Trying to initialize using detected gateway {}", |
| 77 | localGw.toString()); |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 78 | struct in_addr inaddr; |
| 79 | inet_pton(AF_INET, localGw.toString().c_str(), &inaddr); |
| 80 | err = initnatpmp(&natpmpHdl_, 1, inaddr.s_addr); |
| 81 | } |
| 82 | } |
| 83 | |
| 84 | if (err < 0) { |
Adrien Béraud | 17765bd | 2023-08-22 21:02:38 -0400 | [diff] [blame] | 85 | if (logger_) logger_->error("NAT-PMP: Can't initialize libnatpmp -> {}", getNatPmpErrorStr(err)); |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 86 | return; |
| 87 | } |
| 88 | |
| 89 | char addrbuf[INET_ADDRSTRLEN]; |
| 90 | inet_ntop(AF_INET, &natpmpHdl_.gateway, addrbuf, sizeof(addrbuf)); |
| 91 | IpAddr igdAddr(addrbuf); |
Adrien Béraud | 17765bd | 2023-08-22 21:02:38 -0400 | [diff] [blame] | 92 | if (logger_) logger_->debug("NAT-PMP: Initialized on gateway {}", igdAddr.toString()); |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 93 | |
| 94 | // Set the local (gateway) address. |
| 95 | igd_->setLocalIp(igdAddr); |
| 96 | // NAT-PMP protocol does not have UID, but we will set generic |
| 97 | // one debugging purposes. |
| 98 | igd_->setUID("NAT-PMP Gateway"); |
| 99 | |
| 100 | // Search and set the public address. |
| 101 | getIgdPublicAddress(); |
| 102 | |
| 103 | // Update and notify. |
| 104 | if (igd_->isValid()) { |
| 105 | initialized_ = true; |
| 106 | processIgdUpdate(UpnpIgdEvent::ADDED); |
| 107 | }; |
| 108 | } |
| 109 | |
| 110 | void |
| 111 | NatPmp::setObserver(UpnpMappingObserver* obs) |
| 112 | { |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 113 | observer_ = obs; |
| 114 | } |
| 115 | |
| 116 | void |
| 117 | NatPmp::terminate(std::condition_variable& cv) |
| 118 | { |
Adrien Béraud | 7a82bee | 2023-08-30 10:26:45 -0400 | [diff] [blame] | 119 | if (logger_) logger_->debug("NAT-PMP: Terminate instance {}", fmt::ptr(this)); |
| 120 | |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 121 | initialized_ = false; |
| 122 | observer_ = nullptr; |
| 123 | |
Adrien Béraud | 7a82bee | 2023-08-30 10:26:45 -0400 | [diff] [blame] | 124 | std::lock_guard<std::mutex> lock(natpmpMutex_); |
| 125 | shutdownComplete_ = true; |
| 126 | cv.notify_one(); |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 127 | } |
| 128 | |
| 129 | void |
| 130 | NatPmp::terminate() |
| 131 | { |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 132 | std::condition_variable cv {}; |
| 133 | |
Adrien Béraud | 370257c | 2023-08-15 20:53:09 -0400 | [diff] [blame] | 134 | ioContext->dispatch([&] { |
| 135 | terminate(cv); |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 136 | }); |
| 137 | |
Adrien Béraud | 7a82bee | 2023-08-30 10:26:45 -0400 | [diff] [blame] | 138 | std::unique_lock<std::mutex> lk(natpmpMutex_); |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 139 | if (cv.wait_for(lk, std::chrono::seconds(10), [this] { return shutdownComplete_; })) { |
Adrien Béraud | 17765bd | 2023-08-22 21:02:38 -0400 | [diff] [blame] | 140 | if (logger_) logger_->debug("NAT-PMP: Shutdown completed"); |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 141 | } else { |
Adrien Béraud | 17765bd | 2023-08-22 21:02:38 -0400 | [diff] [blame] | 142 | if (logger_) logger_->error("NAT-PMP: Shutdown timed-out"); |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 143 | } |
| 144 | } |
| 145 | |
| 146 | const IpAddr |
| 147 | NatPmp::getHostAddress() const |
| 148 | { |
| 149 | std::lock_guard<std::mutex> lock(natpmpMutex_); |
| 150 | return hostAddress_; |
| 151 | } |
| 152 | |
| 153 | void |
| 154 | NatPmp::clearIgds() |
| 155 | { |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 156 | bool do_close = false; |
| 157 | |
| 158 | if (igd_) { |
| 159 | if (igd_->isValid()) { |
| 160 | do_close = true; |
| 161 | } |
| 162 | igd_->setValid(false); |
| 163 | } |
| 164 | |
| 165 | initialized_ = false; |
Adrien Béraud | 370257c | 2023-08-15 20:53:09 -0400 | [diff] [blame] | 166 | searchForIgdTimer_.cancel(); |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 167 | |
| 168 | igdSearchCounter_ = 0; |
| 169 | |
| 170 | if (do_close) { |
| 171 | closenatpmp(&natpmpHdl_); |
| 172 | memset(&natpmpHdl_, 0, sizeof(natpmpHdl_)); |
| 173 | } |
| 174 | } |
| 175 | |
| 176 | void |
| 177 | NatPmp::searchForIgd() |
| 178 | { |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 179 | if (not initialized_) { |
| 180 | initNatPmp(); |
| 181 | } |
| 182 | |
| 183 | // Schedule a retry in case init failed. |
| 184 | if (not initialized_) { |
| 185 | if (igdSearchCounter_++ < MAX_RESTART_SEARCH_RETRIES) { |
Adrien Béraud | 17765bd | 2023-08-22 21:02:38 -0400 | [diff] [blame] | 186 | if (logger_) logger_->debug("NAT-PMP: Start search for IGDs. Attempt {}", igdSearchCounter_); |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 187 | |
| 188 | // Cancel the current timer (if any) and re-schedule. |
Adrien Béraud | 370257c | 2023-08-15 20:53:09 -0400 | [diff] [blame] | 189 | searchForIgdTimer_.expires_after(NATPMP_SEARCH_RETRY_UNIT * igdSearchCounter_); |
Sébastien Blin | d1e018c | 2023-09-01 09:15:12 -0400 | [diff] [blame] | 190 | searchForIgdTimer_.async_wait([w=weak()](const asio::error_code& ec) { |
| 191 | if (!ec) { |
| 192 | if (auto shared = w.lock()) |
| 193 | shared->searchForIgd(); |
| 194 | } |
Adrien Béraud | 370257c | 2023-08-15 20:53:09 -0400 | [diff] [blame] | 195 | }); |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 196 | } else { |
Adrien Béraud | 17765bd | 2023-08-22 21:02:38 -0400 | [diff] [blame] | 197 | if (logger_) logger_->warn("NAT-PMP: Setup failed after {} trials. NAT-PMP will be disabled!", |
| 198 | MAX_RESTART_SEARCH_RETRIES); |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 199 | } |
| 200 | } |
| 201 | } |
| 202 | |
| 203 | std::list<std::shared_ptr<IGD>> |
| 204 | NatPmp::getIgdList() const |
| 205 | { |
| 206 | std::lock_guard<std::mutex> lock(natpmpMutex_); |
| 207 | std::list<std::shared_ptr<IGD>> igdList; |
| 208 | if (igd_->isValid()) |
| 209 | igdList.emplace_back(igd_); |
| 210 | return igdList; |
| 211 | } |
| 212 | |
| 213 | bool |
| 214 | NatPmp::isReady() const |
| 215 | { |
| 216 | if (observer_ == nullptr) { |
Adrien Béraud | 17765bd | 2023-08-22 21:02:38 -0400 | [diff] [blame] | 217 | if (logger_) logger_->error("NAT-PMP: the observer is not set!"); |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 218 | return false; |
| 219 | } |
| 220 | |
| 221 | // Must at least have a valid local address. |
| 222 | if (not getHostAddress() or getHostAddress().isLoopback()) |
| 223 | return false; |
| 224 | |
| 225 | return igd_ and igd_->isValid(); |
| 226 | } |
| 227 | |
| 228 | void |
| 229 | NatPmp::incrementErrorsCounter(const std::shared_ptr<IGD>& igdIn) |
| 230 | { |
| 231 | if (not validIgdInstance(igdIn)) { |
| 232 | return; |
| 233 | } |
| 234 | |
| 235 | if (not igd_->isValid()) { |
| 236 | // Already invalid. Nothing to do. |
| 237 | return; |
| 238 | } |
| 239 | |
| 240 | if (not igd_->incrementErrorsCounter()) { |
| 241 | // Disable this IGD. |
| 242 | igd_->setValid(false); |
| 243 | // Notify the listener. |
Adrien Béraud | 17765bd | 2023-08-22 21:02:38 -0400 | [diff] [blame] | 244 | if (logger_) logger_->warn("NAT-PMP: No more valid IGD!"); |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 245 | |
| 246 | processIgdUpdate(UpnpIgdEvent::INVALID_STATE); |
| 247 | } |
| 248 | } |
| 249 | |
| 250 | void |
| 251 | NatPmp::requestMappingAdd(const Mapping& mapping) |
| 252 | { |
| 253 | // Process on nat-pmp thread. |
Adrien Béraud | 370257c | 2023-08-15 20:53:09 -0400 | [diff] [blame] | 254 | /*if (not isValidThread()) { |
| 255 | ioContext->post([w = weak(), mapping] { |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 256 | if (auto pmpThis = w.lock()) { |
| 257 | pmpThis->requestMappingAdd(mapping); |
| 258 | } |
| 259 | }); |
| 260 | return; |
Adrien Béraud | 370257c | 2023-08-15 20:53:09 -0400 | [diff] [blame] | 261 | }*/ |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 262 | |
| 263 | Mapping map(mapping); |
| 264 | assert(map.getIgd()); |
| 265 | auto err = addPortMapping(map); |
| 266 | if (err < 0) { |
Adrien Béraud | 17765bd | 2023-08-22 21:02:38 -0400 | [diff] [blame] | 267 | if (logger_) logger_->warn("NAT-PMP: Request for mapping {} on {} failed with error {:d}: {}", |
| 268 | map.toString(), |
| 269 | igd_->toString(), |
| 270 | err, |
| 271 | getNatPmpErrorStr(err)); |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 272 | |
| 273 | if (isErrorFatal(err)) { |
| 274 | // Fatal error, increment the counter. |
| 275 | incrementErrorsCounter(igd_); |
| 276 | } |
| 277 | // Notify the listener. |
| 278 | processMappingRequestFailed(std::move(map)); |
| 279 | } else { |
Adrien Béraud | 17765bd | 2023-08-22 21:02:38 -0400 | [diff] [blame] | 280 | if (logger_) logger_->debug("NAT-PMP: Request for mapping {:s} on {:s} succeeded", |
| 281 | map.toString(), |
| 282 | igd_->toString()); |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 283 | // Notify the listener. |
| 284 | processMappingAdded(std::move(map)); |
| 285 | } |
| 286 | } |
| 287 | |
| 288 | void |
| 289 | NatPmp::requestMappingRenew(const Mapping& mapping) |
| 290 | { |
| 291 | // Process on nat-pmp thread. |
Adrien Béraud | 370257c | 2023-08-15 20:53:09 -0400 | [diff] [blame] | 292 | /*if (not isValidThread()) { |
| 293 | ioContext->post([w = weak(), mapping] { |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 294 | if (auto pmpThis = w.lock()) { |
| 295 | pmpThis->requestMappingRenew(mapping); |
| 296 | } |
| 297 | }); |
| 298 | return; |
Adrien Béraud | 370257c | 2023-08-15 20:53:09 -0400 | [diff] [blame] | 299 | }*/ |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 300 | |
| 301 | Mapping map(mapping); |
| 302 | auto err = addPortMapping(map); |
| 303 | if (err < 0) { |
Adrien Béraud | 17765bd | 2023-08-22 21:02:38 -0400 | [diff] [blame] | 304 | if (logger_) logger_->warn("NAT-PMP: Renewal request for mapping {} on {} failed with error {:d}: {}", |
| 305 | map.toString().c_str(), |
| 306 | igd_->toString().c_str(), |
| 307 | err, |
| 308 | getNatPmpErrorStr(err)); |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 309 | // Notify the listener. |
| 310 | processMappingRequestFailed(std::move(map)); |
| 311 | |
| 312 | if (isErrorFatal(err)) { |
| 313 | // Fatal error, increment the counter. |
| 314 | incrementErrorsCounter(igd_); |
| 315 | } |
| 316 | } else { |
Adrien Béraud | 17765bd | 2023-08-22 21:02:38 -0400 | [diff] [blame] | 317 | if (logger_) logger_->debug("NAT-PMP: Renewal request for mapping {} on {} succeeded", |
| 318 | map.toString().c_str(), |
| 319 | igd_->toString().c_str()); |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 320 | // Notify the listener. |
| 321 | processMappingRenewed(map); |
| 322 | } |
| 323 | } |
| 324 | |
| 325 | int |
| 326 | NatPmp::readResponse(natpmp_t& handle, natpmpresp_t& response) |
| 327 | { |
| 328 | int err = 0; |
| 329 | unsigned readRetriesCounter = 0; |
| 330 | |
| 331 | while (true) { |
| 332 | if (readRetriesCounter++ > MAX_READ_RETRIES) { |
| 333 | err = NATPMP_ERR_SOCKETERROR; |
| 334 | break; |
| 335 | } |
| 336 | |
Sébastien Blin | 4cf587e | 2024-03-08 16:00:18 -0500 | [diff] [blame^] | 337 | struct pollfd fds; |
| 338 | fds.fd = handle.s; |
| 339 | fds.events = POLLIN; |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 340 | struct timeval timeout; |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 341 | getnatpmprequesttimeout(&handle, &timeout); |
Sébastien Blin | 4cf587e | 2024-03-08 16:00:18 -0500 | [diff] [blame^] | 342 | uint64_t millis = (timeout.tv_sec * (uint64_t)1000) + (timeout.tv_usec / 1000); |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 343 | // Wait for data. |
Sébastien Blin | 4cf587e | 2024-03-08 16:00:18 -0500 | [diff] [blame^] | 344 | if (poll(&fds, 1, millis) == -1) { |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 345 | err = NATPMP_ERR_SOCKETERROR; |
| 346 | break; |
| 347 | } |
| 348 | |
| 349 | // Read the data. |
| 350 | err = readnatpmpresponseorretry(&handle, &response); |
| 351 | |
| 352 | if (err == NATPMP_TRYAGAIN) { |
| 353 | std::this_thread::sleep_for(std::chrono::milliseconds(TIMEOUT_BEFORE_READ_RETRY)); |
| 354 | } else { |
| 355 | break; |
| 356 | } |
| 357 | } |
| 358 | |
| 359 | return err; |
| 360 | } |
| 361 | |
| 362 | int |
| 363 | NatPmp::sendMappingRequest(const Mapping& mapping, uint32_t& lifetime) |
| 364 | { |
Adrien Béraud | 370257c | 2023-08-15 20:53:09 -0400 | [diff] [blame] | 365 | //CHECK_VALID_THREAD(); |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 366 | |
| 367 | int err = sendnewportmappingrequest(&natpmpHdl_, |
| 368 | mapping.getType() == PortType::UDP ? NATPMP_PROTOCOL_UDP |
| 369 | : NATPMP_PROTOCOL_TCP, |
| 370 | mapping.getInternalPort(), |
| 371 | mapping.getExternalPort(), |
| 372 | lifetime); |
| 373 | |
| 374 | if (err < 0) { |
Adrien Béraud | 17765bd | 2023-08-22 21:02:38 -0400 | [diff] [blame] | 375 | if (logger_) logger_->error("NAT-PMP: Send mapping request failed with error {} {:d}", |
| 376 | getNatPmpErrorStr(err), |
| 377 | errno); |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 378 | return err; |
| 379 | } |
| 380 | |
| 381 | unsigned readRetriesCounter = 0; |
| 382 | |
| 383 | while (readRetriesCounter++ < MAX_READ_RETRIES) { |
| 384 | // Read the response |
| 385 | natpmpresp_t response; |
| 386 | err = readResponse(natpmpHdl_, response); |
| 387 | |
| 388 | if (err < 0) { |
Adrien Béraud | 17765bd | 2023-08-22 21:02:38 -0400 | [diff] [blame] | 389 | if (logger_) logger_->warn("NAT-PMP: Read response on IGD {} failed with error {}", |
| 390 | igd_->toString(), |
| 391 | getNatPmpErrorStr(err)); |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 392 | } else if (response.type != NATPMP_RESPTYPE_TCPPORTMAPPING |
| 393 | and response.type != NATPMP_RESPTYPE_UDPPORTMAPPING) { |
Adrien Béraud | 17765bd | 2023-08-22 21:02:38 -0400 | [diff] [blame] | 394 | if (logger_) logger_->error("NAT-PMP: Unexpected response type ({:d}) for mapping {} from IGD {}.", |
| 395 | response.type, |
| 396 | mapping.toString(), |
| 397 | igd_->toString()); |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 398 | // Try to read again. |
| 399 | continue; |
| 400 | } |
| 401 | |
| 402 | lifetime = response.pnu.newportmapping.lifetime; |
| 403 | // Done. |
| 404 | break; |
| 405 | } |
| 406 | |
| 407 | return err; |
| 408 | } |
| 409 | |
| 410 | int |
| 411 | NatPmp::addPortMapping(Mapping& mapping) |
| 412 | { |
| 413 | auto const& igdIn = mapping.getIgd(); |
| 414 | assert(igdIn); |
| 415 | assert(igdIn->getProtocol() == NatProtocolType::NAT_PMP); |
| 416 | |
| 417 | if (not igdIn->isValid() or not validIgdInstance(igdIn)) { |
| 418 | mapping.setState(MappingState::FAILED); |
| 419 | return NATPMP_ERR_INVALIDARGS; |
| 420 | } |
| 421 | |
| 422 | mapping.setInternalAddress(getHostAddress().toString()); |
| 423 | |
| 424 | uint32_t lifetime = MAPPING_ALLOCATION_LIFETIME; |
| 425 | int err = sendMappingRequest(mapping, lifetime); |
| 426 | |
| 427 | if (err < 0) { |
| 428 | mapping.setState(MappingState::FAILED); |
| 429 | return err; |
| 430 | } |
| 431 | |
| 432 | // Set the renewal time and update. |
| 433 | mapping.setRenewalTime(sys_clock::now() + std::chrono::seconds(lifetime * 4 / 5)); |
| 434 | mapping.setState(MappingState::OPEN); |
| 435 | |
| 436 | return 0; |
| 437 | } |
| 438 | |
| 439 | void |
| 440 | NatPmp::requestMappingRemove(const Mapping& mapping) |
| 441 | { |
Adrien Béraud | 370257c | 2023-08-15 20:53:09 -0400 | [diff] [blame] | 442 | ioContext->dispatch([w = weak(), mapping] { |
| 443 | if (auto pmpThis = w.lock()) { |
| 444 | Mapping map {mapping}; |
| 445 | pmpThis->removePortMapping(map); |
| 446 | } |
| 447 | }); |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 448 | } |
| 449 | |
| 450 | void |
| 451 | NatPmp::removePortMapping(Mapping& mapping) |
| 452 | { |
| 453 | auto igdIn = mapping.getIgd(); |
| 454 | assert(igdIn); |
| 455 | if (not igdIn->isValid()) { |
| 456 | return; |
| 457 | } |
| 458 | |
| 459 | if (not validIgdInstance(igdIn)) { |
| 460 | return; |
| 461 | } |
| 462 | |
| 463 | Mapping mapToRemove(mapping); |
| 464 | |
| 465 | uint32_t lifetime = 0; |
| 466 | int err = sendMappingRequest(mapping, lifetime); |
| 467 | |
| 468 | if (err < 0) { |
| 469 | // Nothing to do if the request fails, just log the error. |
Adrien Béraud | 17765bd | 2023-08-22 21:02:38 -0400 | [diff] [blame] | 470 | if (logger_) logger_->warn("NAT-PMP: Send remove request failed with error {}. Ignoring", |
| 471 | getNatPmpErrorStr(err)); |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 472 | } |
| 473 | |
| 474 | // Update and notify the listener. |
| 475 | mapToRemove.setState(MappingState::FAILED); |
| 476 | processMappingRemoved(std::move(mapToRemove)); |
| 477 | } |
| 478 | |
| 479 | void |
| 480 | NatPmp::getIgdPublicAddress() |
| 481 | { |
Adrien Béraud | 370257c | 2023-08-15 20:53:09 -0400 | [diff] [blame] | 482 | //CHECK_VALID_THREAD(); |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 483 | |
| 484 | // Set the public address for this IGD if it does not |
| 485 | // have one already. |
| 486 | if (igd_->getPublicIp()) { |
Adrien Béraud | 17765bd | 2023-08-22 21:02:38 -0400 | [diff] [blame] | 487 | if (logger_) logger_->warn("NAT-PMP: IGD {} already have a public address ({})", |
| 488 | igd_->toString(), |
| 489 | igd_->getPublicIp().toString()); |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 490 | return; |
| 491 | } |
| 492 | assert(igd_->getProtocol() == NatProtocolType::NAT_PMP); |
| 493 | |
| 494 | int err = sendpublicaddressrequest(&natpmpHdl_); |
| 495 | |
| 496 | if (err < 0) { |
Adrien Béraud | 17765bd | 2023-08-22 21:02:38 -0400 | [diff] [blame] | 497 | if (logger_) logger_->error("NAT-PMP: send public address request on IGD {} failed with error: {}", |
| 498 | igd_->toString(), |
| 499 | getNatPmpErrorStr(err)); |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 500 | |
| 501 | if (isErrorFatal(err)) { |
| 502 | // Fatal error, increment the counter. |
| 503 | incrementErrorsCounter(igd_); |
| 504 | } |
| 505 | return; |
| 506 | } |
| 507 | |
| 508 | natpmpresp_t response; |
| 509 | err = readResponse(natpmpHdl_, response); |
| 510 | |
| 511 | if (err < 0) { |
Adrien Béraud | 17765bd | 2023-08-22 21:02:38 -0400 | [diff] [blame] | 512 | if (logger_) logger_->warn("NAT-PMP: Read response on IGD {} failed - {}", |
| 513 | igd_->toString(), |
| 514 | getNatPmpErrorStr(err)); |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 515 | return; |
| 516 | } |
| 517 | |
| 518 | if (response.type != NATPMP_RESPTYPE_PUBLICADDRESS) { |
Adrien Béraud | 17765bd | 2023-08-22 21:02:38 -0400 | [diff] [blame] | 519 | if (logger_) logger_->error("NAT-PMP: Unexpected response type ({:d}) for public address request from IGD {}.", |
| 520 | response.type, |
| 521 | igd_->toString()); |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 522 | return; |
| 523 | } |
| 524 | |
| 525 | IpAddr publicAddr(response.pnu.publicaddress.addr); |
| 526 | |
| 527 | if (not publicAddr) { |
Adrien Béraud | 17765bd | 2023-08-22 21:02:38 -0400 | [diff] [blame] | 528 | if (logger_) logger_->error("NAT-PMP: IGD {} returned an invalid public address {}", |
| 529 | igd_->toString(), |
| 530 | publicAddr.toString()); |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 531 | } |
| 532 | |
| 533 | // Update. |
| 534 | igd_->setPublicIp(publicAddr); |
| 535 | igd_->setValid(true); |
| 536 | |
Adrien Béraud | 17765bd | 2023-08-22 21:02:38 -0400 | [diff] [blame] | 537 | if (logger_) logger_->debug("NAT-PMP: Setting IGD {} public address to {}", |
| 538 | igd_->toString(), |
| 539 | igd_->getPublicIp().toString()); |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 540 | } |
| 541 | |
| 542 | void |
| 543 | NatPmp::removeAllMappings() |
| 544 | { |
Adrien Béraud | 370257c | 2023-08-15 20:53:09 -0400 | [diff] [blame] | 545 | //CHECK_VALID_THREAD(); |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 546 | |
Adrien Béraud | 17765bd | 2023-08-22 21:02:38 -0400 | [diff] [blame] | 547 | if (logger_) logger_->warn("NAT-PMP: Send request to close all existing mappings to IGD {}", |
| 548 | igd_->toString().c_str()); |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 549 | |
| 550 | int err = sendnewportmappingrequest(&natpmpHdl_, NATPMP_PROTOCOL_TCP, 0, 0, 0); |
| 551 | if (err < 0) { |
Adrien Béraud | 17765bd | 2023-08-22 21:02:38 -0400 | [diff] [blame] | 552 | if (logger_) logger_->warn("NAT-PMP: Send close all TCP mappings request failed with error {}", |
| 553 | getNatPmpErrorStr(err)); |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 554 | } |
| 555 | err = sendnewportmappingrequest(&natpmpHdl_, NATPMP_PROTOCOL_UDP, 0, 0, 0); |
| 556 | if (err < 0) { |
Adrien Béraud | 17765bd | 2023-08-22 21:02:38 -0400 | [diff] [blame] | 557 | if (logger_) logger_->warn("NAT-PMP: Send close all UDP mappings request failed with error {}", |
| 558 | getNatPmpErrorStr(err)); |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 559 | } |
| 560 | } |
| 561 | |
| 562 | const char* |
| 563 | NatPmp::getNatPmpErrorStr(int errorCode) const |
| 564 | { |
| 565 | #ifdef ENABLE_STRNATPMPERR |
| 566 | return strnatpmperr(errorCode); |
| 567 | #else |
| 568 | switch (errorCode) { |
| 569 | case NATPMP_ERR_INVALIDARGS: |
| 570 | return "INVALIDARGS"; |
| 571 | break; |
| 572 | case NATPMP_ERR_SOCKETERROR: |
| 573 | return "SOCKETERROR"; |
| 574 | break; |
| 575 | case NATPMP_ERR_CANNOTGETGATEWAY: |
| 576 | return "CANNOTGETGATEWAY"; |
| 577 | break; |
| 578 | case NATPMP_ERR_CLOSEERR: |
| 579 | return "CLOSEERR"; |
| 580 | break; |
| 581 | case NATPMP_ERR_RECVFROM: |
| 582 | return "RECVFROM"; |
| 583 | break; |
| 584 | case NATPMP_ERR_NOPENDINGREQ: |
| 585 | return "NOPENDINGREQ"; |
| 586 | break; |
| 587 | case NATPMP_ERR_NOGATEWAYSUPPORT: |
| 588 | return "NOGATEWAYSUPPORT"; |
| 589 | break; |
| 590 | case NATPMP_ERR_CONNECTERR: |
| 591 | return "CONNECTERR"; |
| 592 | break; |
| 593 | case NATPMP_ERR_WRONGPACKETSOURCE: |
| 594 | return "WRONGPACKETSOURCE"; |
| 595 | break; |
| 596 | case NATPMP_ERR_SENDERR: |
| 597 | return "SENDERR"; |
| 598 | break; |
| 599 | case NATPMP_ERR_FCNTLERROR: |
| 600 | return "FCNTLERROR"; |
| 601 | break; |
| 602 | case NATPMP_ERR_GETTIMEOFDAYERR: |
| 603 | return "GETTIMEOFDAYERR"; |
| 604 | break; |
| 605 | case NATPMP_ERR_UNSUPPORTEDVERSION: |
| 606 | return "UNSUPPORTEDVERSION"; |
| 607 | break; |
| 608 | case NATPMP_ERR_UNSUPPORTEDOPCODE: |
| 609 | return "UNSUPPORTEDOPCODE"; |
| 610 | break; |
| 611 | case NATPMP_ERR_UNDEFINEDERROR: |
| 612 | return "UNDEFINEDERROR"; |
| 613 | break; |
| 614 | case NATPMP_ERR_NOTAUTHORIZED: |
| 615 | return "NOTAUTHORIZED"; |
| 616 | break; |
| 617 | case NATPMP_ERR_NETWORKFAILURE: |
| 618 | return "NETWORKFAILURE"; |
| 619 | break; |
| 620 | case NATPMP_ERR_OUTOFRESOURCES: |
| 621 | return "OUTOFRESOURCES"; |
| 622 | break; |
| 623 | case NATPMP_TRYAGAIN: |
| 624 | return "TRYAGAIN"; |
| 625 | break; |
| 626 | default: |
| 627 | return "UNKNOWNERR"; |
| 628 | break; |
| 629 | } |
| 630 | #endif |
| 631 | } |
| 632 | |
| 633 | bool |
| 634 | NatPmp::isErrorFatal(int error) |
| 635 | { |
| 636 | switch (error) { |
| 637 | case NATPMP_ERR_INVALIDARGS: |
| 638 | case NATPMP_ERR_SOCKETERROR: |
| 639 | case NATPMP_ERR_CANNOTGETGATEWAY: |
| 640 | case NATPMP_ERR_CLOSEERR: |
| 641 | case NATPMP_ERR_RECVFROM: |
| 642 | case NATPMP_ERR_NOGATEWAYSUPPORT: |
| 643 | case NATPMP_ERR_CONNECTERR: |
| 644 | case NATPMP_ERR_SENDERR: |
| 645 | case NATPMP_ERR_UNDEFINEDERROR: |
| 646 | case NATPMP_ERR_UNSUPPORTEDVERSION: |
| 647 | case NATPMP_ERR_UNSUPPORTEDOPCODE: |
| 648 | case NATPMP_ERR_NOTAUTHORIZED: |
| 649 | case NATPMP_ERR_NETWORKFAILURE: |
| 650 | case NATPMP_ERR_OUTOFRESOURCES: |
| 651 | return true; |
| 652 | default: |
| 653 | return false; |
| 654 | } |
| 655 | } |
| 656 | |
| 657 | bool |
| 658 | NatPmp::validIgdInstance(const std::shared_ptr<IGD>& igdIn) |
| 659 | { |
| 660 | if (igd_.get() != igdIn.get()) { |
Adrien Béraud | 17765bd | 2023-08-22 21:02:38 -0400 | [diff] [blame] | 661 | if (logger_) logger_->error("NAT-PMP: IGD ({}) does not match local instance ({})", |
| 662 | igdIn->toString(), |
| 663 | igd_->toString()); |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 664 | return false; |
| 665 | } |
| 666 | |
| 667 | return true; |
| 668 | } |
| 669 | |
| 670 | void |
| 671 | NatPmp::processIgdUpdate(UpnpIgdEvent event) |
| 672 | { |
| 673 | if (igd_->isValid()) { |
| 674 | // Remove all current mappings if any. |
| 675 | removeAllMappings(); |
| 676 | } |
| 677 | |
| 678 | if (observer_ == nullptr) |
| 679 | return; |
| 680 | // Process the response on the context thread. |
Sébastien Blin | f6baf4b | 2024-01-03 15:51:36 -0500 | [diff] [blame] | 681 | ioContext->post([w = weak(), event] { |
| 682 | if (auto shared = w.lock()) { |
| 683 | if (!shared->shutdownComplete_) { |
| 684 | shared->observer_->onIgdUpdated(shared->igd_, event); |
| 685 | } |
| 686 | } |
| 687 | }); |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 688 | } |
| 689 | |
| 690 | void |
| 691 | NatPmp::processMappingAdded(const Mapping& map) |
| 692 | { |
| 693 | if (observer_ == nullptr) |
| 694 | return; |
| 695 | |
| 696 | // Process the response on the context thread. |
Sébastien Blin | f6baf4b | 2024-01-03 15:51:36 -0500 | [diff] [blame] | 697 | ioContext->post([w=weak(), map] { |
| 698 | if (auto shared = w.lock()) { |
| 699 | if (!shared->shutdownComplete_) { |
| 700 | shared->observer_->onMappingAdded(shared->igd_, map); |
| 701 | } |
| 702 | } |
| 703 | }); |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 704 | } |
| 705 | |
| 706 | void |
| 707 | NatPmp::processMappingRequestFailed(const Mapping& map) |
| 708 | { |
| 709 | if (observer_ == nullptr) |
| 710 | return; |
| 711 | |
| 712 | // Process the response on the context thread. |
Sébastien Blin | f6baf4b | 2024-01-03 15:51:36 -0500 | [diff] [blame] | 713 | ioContext->post([w=weak(), map] { |
| 714 | if (auto shared = w.lock()) { |
| 715 | if (!shared->shutdownComplete_) { |
| 716 | shared->observer_->onMappingRequestFailed(map); |
| 717 | } |
| 718 | } |
| 719 | }); |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 720 | } |
| 721 | |
| 722 | void |
| 723 | NatPmp::processMappingRenewed(const Mapping& map) |
| 724 | { |
| 725 | if (observer_ == nullptr) |
| 726 | return; |
| 727 | |
| 728 | // Process the response on the context thread. |
Sébastien Blin | f6baf4b | 2024-01-03 15:51:36 -0500 | [diff] [blame] | 729 | ioContext->post([w=weak(), map] { |
| 730 | if (auto shared = w.lock()) { |
| 731 | if (!shared->shutdownComplete_) { |
| 732 | shared->observer_->onMappingRenewed(shared->igd_, map); |
| 733 | } |
| 734 | } |
| 735 | }); |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 736 | } |
| 737 | |
| 738 | void |
| 739 | NatPmp::processMappingRemoved(const Mapping& map) |
| 740 | { |
| 741 | if (observer_ == nullptr) |
| 742 | return; |
| 743 | |
| 744 | // Process the response on the context thread. |
Sébastien Blin | f6baf4b | 2024-01-03 15:51:36 -0500 | [diff] [blame] | 745 | ioContext->post([w=weak(), map] { |
| 746 | if (auto shared = w.lock()) { |
| 747 | if (!shared->shutdownComplete_) { |
| 748 | shared->observer_->onMappingRemoved(shared->igd_, map); |
| 749 | } |
| 750 | } |
| 751 | }); |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 752 | } |
| 753 | |
| 754 | } // namespace upnp |
Sébastien Blin | 464bdff | 2023-07-19 08:02:53 -0400 | [diff] [blame] | 755 | } // namespace dhtnet |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 756 | |
| 757 | #endif //-- #if HAVE_LIBNATPMP |