enobufs / stun

STUN server using node.js

STUN server for Node.js

Looking for older implementation? Go to legacy branch.

Overview

STUN (Simple Traversal of UDP through NAT: RFC3489) is a protocol that allows a client node to obtain an external IP address and port number assigned by a NAT the client is behind. It can also identify behavioral type of the NAT.

System requirement

• Node.js v0.10.x or above
• Two IP addresses on the same machine (for server)

Installation

$ npm install -g node-stun

Usage

How to run STUN server

Place a config file named as node-stun.ini in your current directory. The config file should look like following. (These local loopback addresses should be routable public IP addresses in the real settings, of course)

[primary]
host = 127.0.0.1

[secondary]
host = 127.0.0.2

On Mac, you can add another loopback address by typing:

$ sudo ifconfig lo0 alias 127.0.0.2 up

The start STUN server:

$ node-stun-server

How to run STUN client

In another terminal, type:

$ node-stun-client -s 127.0.0.1

If successful, you should see the following on your console:

Complete(0): Open NB=I EF=I (Open to internet) mapped=127.0.0.1:61072 rtt=0

API

(TODO: Will finalize the API in the next release)

Limitations

• Current implementation does not support RFC 5389
• Following attributes are not supported
  • RESPONSE-ADDRESS
  • USERNAME
  • PASSWORD
  • MESSAGE-INTEGRITY
  • ERROR-CODE
  • UNKNOWN-ATTRIBUTE
  • REFLECTED-FROM
  • XOR-MAPPED-ADDRESS (RFC3489bis)

Public STUN servers that work with this STUN client

Last tested on Jan 24, 2018

• sip1.lakedestiny.cordiaip.com
• stun.callwithus.com
• stun.counterpath.net
• stun.ideasip.com
• stun.internetcalls.com
• stun.sipgate.net
• stun.stunprotocol.org
• stun.voip.aebc.com
• stun.voipbuster.com
• stun.voxgratia.org
• stun.xten.com

License

  Copyright (c) 2011 Yutaka Takeda <yt0916 at gmail.com>
  MIT Lincesed
 
  Permission is hereby granted, free of charge, to any person obtaining
  a copy of this software and associated documentation files (the "Software"),
  to deal in the Software without restriction, including without limitation
  the rights to use, copy, modify, merge, publish, distribute, sublicense,
  and/or sell copies of the Software, and to permit persons to whom the
  Software is furnished to do so, subject to the following conditions:
 
  The above copyright notice and this permission notice shall be included in
  all copies or substantial portions of the Software.

  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
  IN THE SOFTWARE.

stun's Issues

Add package.json?

Hi, there's currently no package.json for this. Would it be possible to add one?

I was going to create a PR, but I wasn't sure what you would want to use for the version etc.

Please help

Do you have also a TURN SERVER?

Code under 'lib' should not depend on specific implementation of config

• Params should be passed in via constructor or instance methods
• Config loading should be done in bin/server.js so that use can choose their own config strategy when use API.

Is it mandatory having two public IPs?

Hi Yutaka,

I'm using a MCU to establish WebRTC connections between clients. The server is publicly available to the clients. The question is in a direct connection between client and server (no NAT or firewall) do I still need two IP addresses on the server?

Error: bind EADDRINUSE $myIP:3342

@keyneom https://github.com/keyneom/stun

myIP="169.149.12.16"

# stunsrv $myIP $myIP 3342 5589 $myIP $myIP
Starting Server . . .
soc[0] listening on $myIP:3342
soc[1] listening on $myIP:5589
events.js:167
      throw er; // Unhandled 'error' event
      ^

Error: bind EADDRINUSE $myIP:3342
    at state.handle.lookup (dgram.js:242:18)
    at process._tickCallback (internal/process/next_tick.js:63:19)
    at Function.Module.runMain (internal/modules/cjs/loader.js:745:11)
    at startup (internal/bootstrap/node.js:283:19)
    at bootstrapNodeJSCore (internal/bootstrap/node.js:743:3)
Emitted 'error' event at:
    at state.handle.lookup (dgram.js:243:14)
    at process._tickCallback (internal/process/next_tick.js:63:19)
    [... lines matching original stack trace ...]
    at bootstrapNodeJSCore (internal/bootstrap/node.js:743:3)

Can't connect using stun in some cases that google's stun server can facilitate

I did a test with 3 different node.js stun servers: stun, node-stun, and ministun. All had the same properties on the cases I tested on. The case they all failed was when I tried to connect a phone on its mobile network to a desktop client (which was also the machine hosting the stun server and coordination server). This case worked fine when I used stun:stun.l.google.com:19302 however, so I'm not sure if there's some functionality these modules aren't implementing, if they all have similar bugs, or if something else is going on. In any case, it feels like a rather large hole in the abilities of all of these stun server modules and finding a way to support that case would be a great way to differentiate this module vs the rest.

Here's the code I was testing with, and a readme that detailed the cases and the restults for each module:

node-stun-code.zip

I created similar issues on the other repos as well:

• nodertc/stun#38
• noahlevenson/ministun#3

hi i want to create applications based on your stuncode

please reach me here [email protected] as i can do good gui

http://livebroadcast.in/broadcast/pro.php this is one way as i am trying to make it on mediaserver

how can we add this stun to Swift 3 iOS?

how can we add stun server locally to iPhone So that we can use it without internet. How can we add the Files to Swift project .

Document what the purpose of the secondary config is vs primary.

Its not clear to me why the config has primary config and secondary. What's the purpose of that? Could you please document it?

Is it possible to connect when it reports 'All sockets closed.'

When it completes, it suggests the following info.

Complete(0): Open NB=I EF=I (Open to internet) mapped=144.214.112.87:59390 rtt=0
All sockets closed.

Is it possible to keep the socket open?

Please permit only a single IP

While the STUN protocol does require the use of two IP addresses for determination of NAT type, in practice, most clients don't need or use this.

I would appreciate a configuration option "useSingleMode" or such, so that the server will not attempt to bind to a secondary IP.

I tried doing this, which matches what freeswitch does:

primary: {
        host: '127.0.0.1',
        port: '3478'
    },
    secondary: {
        host: '127.0.0.1',
        port: '3479'
    },
}

But this library attempts to bind to 127.0.0.1:3478 twice, which errors out.

What's kind of uri address have got this node-stun server on a local desktop?

Hi, I'm wondering about the uri address of this node-stun. How it should be looking? Where the place for ice config options.

Suggestion: self configuration using available interfaces

I've thinking that it would be useful to have a zero configuration fallback (in the case the .ini file is missing or even if some parameter in it is set to 'automatic') so the system retrieves the list of available network interfaces and uses that information to self-configure.
If you like the idea, I can work on that and pull it when it's ready.