@achingbrain/nat-port-mapper v4.0.2
@achingbrain/nat-port-mapper
Port mapping with UPnP and NAT-PMP
About
Enable NAT traversal by mapping public ports to ports on your computer using either UPnP or NAT-PMP.
Example - UPnP NAT
import { upnpNat } from '@achingbrain/nat-port-mapper'
const client = upnpNat()
for await (const gateway of client.findGateways({ signal: AbortSignal.timeout(10000) })) {
// Map public port 1000 to private port 1000 with TCP
await gateway.map(1000, '192.168.1.123', {
protocol: 'tcp'
})
// Map port 3000 to any available host name
for await (const mapping of gateway.mapAll(3000, {
protocol: 'udp'
})) {
console.info(`mapped ${mapping.internalHost}:${mapping.internalPort} to ${mapping.externalHost}:${mapping.externalPort}`)
}
// Unmap previously mapped private port 1000
await gateway.unmap(1000)
// Get external IP
const externalIp = await gateway.externalIp()
console.log('External IP:', externalIp)
// Unmap all mapped ports and cancel any in-flight network operations
await gateway.stop()
}
Example - NAT-PMP
import { pmpNat } from '@achingbrain/nat-port-mapper'
import { gateway4sync } from 'default-gateway'
const gateway = pmpNat(gateway4sync().gateway)
// Map public port 1000 to private port 1000 with TCP
await gateway.map(1000, '192.168.1.123', {
protocol: 'tcp'
})
// Map public port 2000 to private port 3000 with UDP
await gateway.map(3000, '192.168.1.123', {
externalPort: 2000,
protocol: 'udp'
})
// Unmap previously mapped private port 1000
await gateway.unmap(1000)
// Get external IP
const externalIp = await gateway.externalIp()
console.log('External IP:', externalIp)
// Unmap all mapped ports and cancel any in-flight network operations
await gateway.stop()
Credits
Based on alxhotel/nat-api
Additional Information
- http://miniupnp.free.fr/nat-pmp.html
- http://wikipedia.org/wiki/NAT_Port_Mapping_Protocol
- http://tools.ietf.org/html/draft-cheshire-nat-pmp-03
Install
$ npm i @achingbrain/nat-port-mapper
API Docs
License
Licensed under either of
- Apache 2.0, (LICENSE-APACHE / http://www.apache.org/licenses/LICENSE-2.0)
- MIT (LICENSE-MIT / http://opensource.org/licenses/MIT)
Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
11 months ago
11 months ago
11 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
8 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
1 year ago
1 year ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
4 years ago
4 years ago
4 years ago