Security News
New Proposed CISA Mandate Would Require Critical Infrastructure to Report Ransom Payments Within 24 Hours
CISA has proposed a set of new rules that would require critical infrastructure to report cyber incidents and ransom payments.
nat-api
Advanced tools
Port mapping with UPnP and NAT-PMP
Weekly downloads
Readme
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!')
})
// Get external IP
client.externalIp(function(err, ip) {
if (err) return console.log('Error', err)
console.log('External IP:', ip)
})
// Destroy object
client.destroy()
client = new NatAPI([opts])
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 // Enable PMP (default: false)
}
If gateway
is not set, then nat-api
will get the default gateway based on the current network interface.
client.map(port, [callback])
port
: Public and private portscallback
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.
client.map(publicPort, privatePort, [callback])
publicPort
: Public portprivatePort
: Private portcallback
This is another quick way of mapping publciPort
to privatePort
with any protocol (UDP and TCP).
client.map(opts, [callback])
opts
:publicPort
: Public portprivatePort
: Private portprotocol
: Port protocol (UDP
, TCP
or null
for both)ttl
: Overwrite the default TTL in seconds.description
: Description of the port mappingcallback
client.unmap(port, [callback])
Unmap any port that has the public port or private port equal to port
.
client.unmap(publicPort, privatePort, [callback])
Unmap any port that has the public port or private port equal to publicPort
and privatePort
, respectively.
client.unmap(opts, [callback])
Unmap any port that contains the parameters provided in opts
.
client.externalIp([callback])
callback(err, ip)
Get the external IP address.
client.destroy([callback])
Destroy the client. Unmaps all the ports open with nat-api
and cleans up large data structure resources.
MIT. Copyright (c) Alex
FAQs
Port mapping with UPnP and NAT-PMP
The npm package nat-api receives a total of 383 weekly downloads. As such, nat-api popularity was classified as not popular.
We found that nat-api demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
CISA has proposed a set of new rules that would require critical infrastructure to report cyber incidents and ransom payments.
Security News
Redis is no longer OSS, breaking its explicit commitment to remain under the BSD 3-Clause License forever. This has angered contributors who are now working to fork the software.
Product
Socket AI now enables 'AI detected potential malware' alerts by default, ensuring users benefit from AI-powered state-of-the-art malware detection without needing to opt-in.