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