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 | */ |
Andreas Traczyk | 9e064bf | 2024-09-05 16:10:11 -0400 | [diff] [blame] | 17 | |
Morteza Namvar | 5f63952 | 2023-07-04 17:08:58 -0400 | [diff] [blame] | 18 | #include "upnp/mapping.h" |
Adrien Béraud | 33a03ba | 2023-06-21 11:35:54 -0400 | [diff] [blame] | 19 | #include "igd.h" |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 20 | |
Adrien Béraud | 1ae60aa | 2023-07-07 09:55:09 -0400 | [diff] [blame] | 21 | namespace dhtnet { |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 22 | namespace upnp { |
| 23 | |
Adrien Beraud | a8731ac | 2023-08-17 12:19:39 -0400 | [diff] [blame] | 24 | using namespace std::literals; |
| 25 | |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 26 | Mapping::Mapping(PortType type, uint16_t portExternal, uint16_t portInternal, bool available) |
| 27 | : type_(type) |
| 28 | , externalPort_(portExternal) |
| 29 | , internalPort_(portInternal) |
| 30 | , internalAddr_() |
| 31 | , igd_() |
| 32 | , available_(available) |
| 33 | , state_(MappingState::PENDING) |
| 34 | , notifyCb_(nullptr) |
| 35 | , autoUpdate_(false) |
François-Simon Fauteux-Chapleau | fd29c1d | 2024-05-30 16:48:26 -0400 | [diff] [blame] | 36 | , renewalTime_(sys_clock::time_point::max()) |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 37 | {} |
| 38 | |
| 39 | Mapping::Mapping(const Mapping& other) |
| 40 | { |
Adrien Béraud | 024c46f | 2024-03-02 23:53:18 -0500 | [diff] [blame] | 41 | std::lock_guard lock(other.mutex_); |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 42 | |
| 43 | internalAddr_ = other.internalAddr_; |
| 44 | internalPort_ = other.internalPort_; |
| 45 | externalPort_ = other.externalPort_; |
| 46 | type_ = other.type_; |
| 47 | igd_ = other.igd_; |
| 48 | available_ = other.available_; |
| 49 | state_ = other.state_; |
| 50 | notifyCb_ = other.notifyCb_; |
| 51 | autoUpdate_ = other.autoUpdate_; |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 52 | renewalTime_ = other.renewalTime_; |
François-Simon Fauteux-Chapleau | fd29c1d | 2024-05-30 16:48:26 -0400 | [diff] [blame] | 53 | expiryTime_ = other.expiryTime_; |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 54 | } |
| 55 | |
| 56 | void |
| 57 | Mapping::updateFrom(const Mapping::sharedPtr_t& other) |
| 58 | { |
| 59 | updateFrom(*other); |
| 60 | } |
| 61 | |
| 62 | void |
| 63 | Mapping::updateFrom(const Mapping& other) |
| 64 | { |
| 65 | if (type_ != other.type_) { |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 66 | return; |
| 67 | } |
| 68 | |
| 69 | internalAddr_ = std::move(other.internalAddr_); |
| 70 | internalPort_ = other.internalPort_; |
| 71 | externalPort_ = other.externalPort_; |
| 72 | igd_ = other.igd_; |
| 73 | state_ = other.state_; |
| 74 | } |
| 75 | |
| 76 | void |
| 77 | Mapping::setAvailable(bool val) |
| 78 | { |
Adrien Béraud | 024c46f | 2024-03-02 23:53:18 -0500 | [diff] [blame] | 79 | std::lock_guard lock(mutex_); |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 80 | available_ = val; |
| 81 | } |
| 82 | |
| 83 | void |
| 84 | Mapping::setState(const MappingState& state) |
| 85 | { |
Adrien Béraud | 024c46f | 2024-03-02 23:53:18 -0500 | [diff] [blame] | 86 | std::lock_guard lock(mutex_); |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 87 | state_ = state; |
| 88 | } |
| 89 | |
| 90 | const char* |
| 91 | Mapping::getStateStr() const |
| 92 | { |
Adrien Béraud | 024c46f | 2024-03-02 23:53:18 -0500 | [diff] [blame] | 93 | std::lock_guard lock(mutex_); |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 94 | return getStateStr(state_); |
| 95 | } |
| 96 | |
| 97 | std::string |
| 98 | Mapping::toString(bool extraInfo) const |
| 99 | { |
Adrien Béraud | 024c46f | 2024-03-02 23:53:18 -0500 | [diff] [blame] | 100 | std::lock_guard lock(mutex_); |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 101 | std::ostringstream descr; |
| 102 | descr << UPNP_MAPPING_DESCRIPTION_PREFIX << "-" << getTypeStr(type_); |
| 103 | descr << ":" << std::to_string(internalPort_); |
| 104 | |
| 105 | if (extraInfo) { |
| 106 | descr << " (state=" << getStateStr(state_) |
| 107 | << ", auto-update=" << (autoUpdate_ ? "YES" : "NO") << ")"; |
| 108 | } |
| 109 | |
| 110 | return descr.str(); |
| 111 | } |
| 112 | |
| 113 | bool |
| 114 | Mapping::isValid() const |
| 115 | { |
Adrien Béraud | 024c46f | 2024-03-02 23:53:18 -0500 | [diff] [blame] | 116 | std::lock_guard lock(mutex_); |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 117 | if (state_ == MappingState::FAILED) |
| 118 | return false; |
| 119 | if (internalPort_ == 0) |
| 120 | return false; |
| 121 | if (externalPort_ == 0) |
| 122 | return false; |
| 123 | if (not igd_ or not igd_->isValid()) |
| 124 | return false; |
| 125 | IpAddr intAddr(internalAddr_); |
| 126 | return intAddr and not intAddr.isLoopback(); |
| 127 | } |
| 128 | |
| 129 | bool |
| 130 | Mapping::hasValidHostAddress() const |
| 131 | { |
Adrien Béraud | 024c46f | 2024-03-02 23:53:18 -0500 | [diff] [blame] | 132 | std::lock_guard lock(mutex_); |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 133 | |
| 134 | IpAddr intAddr(internalAddr_); |
| 135 | return intAddr and not intAddr.isLoopback(); |
| 136 | } |
| 137 | |
| 138 | bool |
| 139 | Mapping::hasPublicAddress() const |
| 140 | { |
Adrien Béraud | 024c46f | 2024-03-02 23:53:18 -0500 | [diff] [blame] | 141 | std::lock_guard lock(mutex_); |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 142 | |
| 143 | return igd_ and igd_->getPublicIp() and not igd_->getPublicIp().isPrivate(); |
| 144 | } |
| 145 | |
| 146 | Mapping::key_t |
| 147 | Mapping::getMapKey() const |
| 148 | { |
Adrien Béraud | 024c46f | 2024-03-02 23:53:18 -0500 | [diff] [blame] | 149 | std::lock_guard lock(mutex_); |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 150 | |
| 151 | key_t mapKey = internalPort_; |
| 152 | if (type_ == PortType::UDP) |
| 153 | mapKey |= 1 << (sizeof(uint16_t) * 8); |
| 154 | return mapKey; |
| 155 | } |
| 156 | |
| 157 | PortType |
| 158 | Mapping::getTypeFromMapKey(key_t key) |
| 159 | { |
| 160 | return (key >> (sizeof(uint16_t) * 8)) ? PortType::UDP : PortType::TCP; |
| 161 | } |
| 162 | |
| 163 | std::string |
| 164 | Mapping::getExternalAddress() const |
| 165 | { |
Adrien Béraud | 024c46f | 2024-03-02 23:53:18 -0500 | [diff] [blame] | 166 | std::lock_guard lock(mutex_); |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 167 | if (igd_) |
| 168 | return igd_->getPublicIp().toString(); |
| 169 | return {}; |
| 170 | } |
| 171 | |
| 172 | void |
| 173 | Mapping::setExternalPort(uint16_t port) |
| 174 | { |
Adrien Béraud | 024c46f | 2024-03-02 23:53:18 -0500 | [diff] [blame] | 175 | std::lock_guard lock(mutex_); |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 176 | externalPort_ = port; |
| 177 | } |
| 178 | |
| 179 | uint16_t |
| 180 | Mapping::getExternalPort() const |
| 181 | { |
Adrien Béraud | 024c46f | 2024-03-02 23:53:18 -0500 | [diff] [blame] | 182 | std::lock_guard lock(mutex_); |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 183 | return externalPort_; |
| 184 | } |
| 185 | |
| 186 | std::string |
| 187 | Mapping::getExternalPortStr() const |
| 188 | { |
Adrien Béraud | 024c46f | 2024-03-02 23:53:18 -0500 | [diff] [blame] | 189 | std::lock_guard lock(mutex_); |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 190 | return std::to_string(externalPort_); |
| 191 | } |
| 192 | |
| 193 | void |
| 194 | Mapping::setInternalAddress(const std::string& addr) |
| 195 | { |
Adrien Béraud | 024c46f | 2024-03-02 23:53:18 -0500 | [diff] [blame] | 196 | std::lock_guard lock(mutex_); |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 197 | internalAddr_ = addr; |
| 198 | } |
| 199 | |
| 200 | std::string |
| 201 | Mapping::getInternalAddress() const |
| 202 | { |
Adrien Béraud | 024c46f | 2024-03-02 23:53:18 -0500 | [diff] [blame] | 203 | std::lock_guard lock(mutex_); |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 204 | return internalAddr_; |
| 205 | } |
| 206 | |
| 207 | void |
| 208 | Mapping::setInternalPort(uint16_t port) |
| 209 | { |
Adrien Béraud | 024c46f | 2024-03-02 23:53:18 -0500 | [diff] [blame] | 210 | std::lock_guard lock(mutex_); |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 211 | internalPort_ = port; |
| 212 | } |
| 213 | |
| 214 | uint16_t |
| 215 | Mapping::getInternalPort() const |
| 216 | { |
Adrien Béraud | 024c46f | 2024-03-02 23:53:18 -0500 | [diff] [blame] | 217 | std::lock_guard lock(mutex_); |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 218 | return internalPort_; |
| 219 | } |
| 220 | |
| 221 | std::string |
| 222 | Mapping::getInternalPortStr() const |
| 223 | { |
Adrien Béraud | 024c46f | 2024-03-02 23:53:18 -0500 | [diff] [blame] | 224 | std::lock_guard lock(mutex_); |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 225 | return std::to_string(internalPort_); |
| 226 | } |
| 227 | |
| 228 | PortType |
| 229 | Mapping::getType() const |
| 230 | { |
Adrien Béraud | 024c46f | 2024-03-02 23:53:18 -0500 | [diff] [blame] | 231 | std::lock_guard lock(mutex_); |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 232 | return type_; |
| 233 | } |
| 234 | |
| 235 | const char* |
| 236 | Mapping::getTypeStr() const |
| 237 | { |
Adrien Béraud | 024c46f | 2024-03-02 23:53:18 -0500 | [diff] [blame] | 238 | std::lock_guard lock(mutex_); |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 239 | return getTypeStr(type_); |
| 240 | } |
| 241 | |
| 242 | bool |
| 243 | Mapping::isAvailable() const |
| 244 | { |
Adrien Béraud | 024c46f | 2024-03-02 23:53:18 -0500 | [diff] [blame] | 245 | std::lock_guard lock(mutex_); |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 246 | return available_; |
| 247 | } |
| 248 | |
| 249 | std::shared_ptr<IGD> |
| 250 | Mapping::getIgd() const |
| 251 | { |
Adrien Béraud | 024c46f | 2024-03-02 23:53:18 -0500 | [diff] [blame] | 252 | std::lock_guard lock(mutex_); |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 253 | return igd_; |
| 254 | } |
| 255 | |
| 256 | NatProtocolType |
| 257 | Mapping::getProtocol() const |
| 258 | { |
Adrien Béraud | 024c46f | 2024-03-02 23:53:18 -0500 | [diff] [blame] | 259 | std::lock_guard lock(mutex_); |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 260 | if (igd_) |
| 261 | return igd_->getProtocol(); |
| 262 | return NatProtocolType::UNKNOWN; |
| 263 | } |
Adrien Beraud | a8731ac | 2023-08-17 12:19:39 -0400 | [diff] [blame] | 264 | |
| 265 | std::string_view |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 266 | Mapping::getProtocolName() const |
| 267 | { |
Adrien Beraud | a8731ac | 2023-08-17 12:19:39 -0400 | [diff] [blame] | 268 | switch(getProtocol()) { |
| 269 | case NatProtocolType::NAT_PMP: |
| 270 | return "NAT-PMP"sv; |
| 271 | case NatProtocolType::PUPNP: |
| 272 | return "PUPNP"sv; |
| 273 | default: |
| 274 | return "UNKNOWN"sv; |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 275 | } |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 276 | } |
| 277 | |
| 278 | void |
| 279 | Mapping::setIgd(const std::shared_ptr<IGD>& igd) |
| 280 | { |
Adrien Béraud | 024c46f | 2024-03-02 23:53:18 -0500 | [diff] [blame] | 281 | std::lock_guard lock(mutex_); |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 282 | igd_ = igd; |
| 283 | } |
| 284 | |
| 285 | MappingState |
| 286 | Mapping::getState() const |
| 287 | { |
Adrien Béraud | 024c46f | 2024-03-02 23:53:18 -0500 | [diff] [blame] | 288 | std::lock_guard lock(mutex_); |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 289 | return state_; |
| 290 | } |
| 291 | |
| 292 | Mapping::NotifyCallback |
| 293 | Mapping::getNotifyCallback() const |
| 294 | { |
Adrien Béraud | 024c46f | 2024-03-02 23:53:18 -0500 | [diff] [blame] | 295 | std::lock_guard lock(mutex_); |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 296 | return notifyCb_; |
| 297 | } |
| 298 | |
| 299 | void |
| 300 | Mapping::setNotifyCallback(NotifyCallback cb) |
| 301 | { |
Adrien Béraud | 024c46f | 2024-03-02 23:53:18 -0500 | [diff] [blame] | 302 | std::lock_guard lock(mutex_); |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 303 | notifyCb_ = std::move(cb); |
| 304 | } |
| 305 | |
| 306 | void |
| 307 | Mapping::enableAutoUpdate(bool enable) |
| 308 | { |
Adrien Béraud | 024c46f | 2024-03-02 23:53:18 -0500 | [diff] [blame] | 309 | std::lock_guard lock(mutex_); |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 310 | autoUpdate_ = enable; |
| 311 | } |
| 312 | |
| 313 | bool |
| 314 | Mapping::getAutoUpdate() const |
| 315 | { |
Adrien Béraud | 024c46f | 2024-03-02 23:53:18 -0500 | [diff] [blame] | 316 | std::lock_guard lock(mutex_); |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 317 | return autoUpdate_; |
| 318 | } |
| 319 | |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 320 | sys_clock::time_point |
| 321 | Mapping::getRenewalTime() const |
| 322 | { |
Adrien Béraud | 024c46f | 2024-03-02 23:53:18 -0500 | [diff] [blame] | 323 | std::lock_guard lock(mutex_); |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 324 | return renewalTime_; |
| 325 | } |
| 326 | |
| 327 | void |
| 328 | Mapping::setRenewalTime(sys_clock::time_point time) |
| 329 | { |
Adrien Béraud | 024c46f | 2024-03-02 23:53:18 -0500 | [diff] [blame] | 330 | std::lock_guard lock(mutex_); |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 331 | renewalTime_ = time; |
| 332 | } |
François-Simon Fauteux-Chapleau | fd29c1d | 2024-05-30 16:48:26 -0400 | [diff] [blame] | 333 | |
| 334 | sys_clock::time_point |
| 335 | Mapping::getExpiryTime() const |
| 336 | { |
| 337 | std::lock_guard lock(mutex_); |
| 338 | return expiryTime_; |
| 339 | } |
| 340 | |
| 341 | void |
| 342 | Mapping::setExpiryTime(sys_clock::time_point time) |
| 343 | { |
| 344 | std::lock_guard lock(mutex_); |
| 345 | expiryTime_ = time; |
| 346 | } |
Adrien Béraud | 612b55b | 2023-05-29 10:42:04 -0400 | [diff] [blame] | 347 | |
| 348 | } // namespace upnp |
Sébastien Blin | 464bdff | 2023-07-19 08:02:53 -0400 | [diff] [blame] | 349 | } // namespace dhtnet |