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