Fast port mapping with UPnP and NAT-PMP in NodeJS.

Required: NodeJS >= 10

npm install nat-api

const NatAPI = require('nat-api')

const client = new NatAPI()

// Map public port 1000 to private port 1000 with UDP and TCP
client.map(1000, function (err) {
  if (err) return console.log('Error', err)
  console.log('Port mapped!')
})

// Map public port 2000 to private port 3000 with UDP and TCP
client.map(2000, 3000, function (err) {
  if (err) return console.log('Error', err)
  console.log('Port mapped!')
})

// Map public port 4000 to private port 5000 with only UDP
client.map({ publicPort: 4000, privatePort: 5000, ttl: 1800, protocol: 'UDP' }, function (err) {
  if (err) return console.log('Error', err)
  console.log('Port mapped!')
})

// Unmap port public and private port 1000 with UDP and TCP
client.unmap(1000, function (err) {
  if (err) return console.log('Error', err)
  console.log('Port unmapped!') 
})

// Destroy object
client.destroy()

Create a new nat-api instance.

If opts is specified, then the default options (shown below) will be overridden.

{
  ttl: 1200, // Time to live of each port mapping in seconds (default: 1200)
  autoUpdate: true, // Refresh all the port mapping to keep them from expiring (default: true)
  gateway: '192.168.1.1' // Default gateway (default: null)
  enablePMP: false // PMP is not enable by default
}

If gateway is not set, then nat-api will get the default gateway based on the current network interface.

• port: Public and private ports
• callback

This method will use port por mapping the public port to the same private port.

It uses the default TTL and creates a map for UDP and TCP.

• publicPort: Public port
• privatePort: Private port
• callback

This is another quick way of mapping publciPort to privatePort with any protocol (UDP and TCP).

• opts:

• publicPort: Public port
• privatePort: Private port
• protocol: Port protocol (UDP, TCP or null for both)
• ttl: Overwrite the default TTL in seconds.
• description: Description of the port mapping

• callback

Unmap any port that has the public port or private port equal to port.

Unmap any port that has the public port or private port equal to publicPort and privatePort, respectively.

Unmap any port that contains the parameters provided in opts.

Destroy the client. Unmaps all the ports open with nat-api and cleans up large data structure resources.

• 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

MIT. Copyright (c) Alex