https://github.com/talkiq/pystun3

A Python STUN client for getting NAT type and external IP
https://github.com/talkiq/pystun3

Last synced: about 2 months ago
JSON representation

A Python STUN client for getting NAT type and external IP

• Host: GitHub
• URL: https://github.com/talkiq/pystun3
• Owner: talkiq
• License: mit
• Fork: true (jtriley/pystun)
• Created: 2018-06-12T22:12:03.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2024-06-28T13:47:21.000Z (3 months ago)
• Last Synced: 2024-07-11T12:57:27.412Z (2 months ago)
• Language: Python
• Homepage: https://pypi.org/project/pystun3/
• Size: 58.6 KB
• Stars: 128
• Watchers: 9
• Forks: 9
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.rst
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
PyStun3

=======

A Python STUN client for getting NAT type and external IP. Supports Python

versions 2 and 3.

This project has been forked several times:

- `original project by gaohawk`_

- `taken over by jtriley`_

- `forked and patched to support py3 by zoumi`_

- and, finally, forked by `TalkIQ`_

PyStun follows `RFC 3489`_. A server following STUN-bis hasn't been found on

internet so RFC3489 is the only implementation.

Installation

------------

To install the latest version::

    $ pip install pystun3

or download/clone the source and install manually using::

    $ cd /path/to/pystun3/src

    $ python setup.py install

If you're hacking on ``pystun3`` you should use the 'develop' command instead::

    $ python setup.py develop

This will make a link to the sources inside your site-packages directory so

that any changes are immediately available for testing.

Usage

-----

From command line::

    $ pystun3

    NAT Type: Full Cone

    External IP: 

    External Port: 54320

Pass --help for more options::

    % pystun3 --help

    usage: pystun3 [-h] [-d] [-H STUN_HOST] [-P STUN_PORT] [-i SOURCE_IP]

                   [-p SOURCE_PORT] [--version]

    optional arguments:

      -h, --help            show this help message and exit

      -d, --debug           Enable debug logging (default: False)

      -H STUN_HOST, --host STUN_HOST

                            STUN host to use (default: None)

      -P STUN_PORT, --host-port STUN_PORT

                            STUN host port to use (default: 3478)

      -i SOURCE_IP, --interface SOURCE_IP

                            network interface for client (default: 0.0.0.0)

      -p SOURCE_PORT, --port SOURCE_PORT

                            port to listen on for client (default: 54320)

      --version             show program's version number and exit

From Python::

    import stun

    nat_type, external_ip, external_port = stun.get_ip_info()

This will rotate through an internal list of STUN servers until a response is

found. If no response is found you will get ``"Blocked"`` as the ``nat_type``

and ``None`` for ``external_ip`` and ``external_port``.

If you prefer to use a specific STUN server::

    nat_type, external_ip, external_port = stun.get_ip_info(stun_host='stun.ekiga.net')

If you prefer to use a specific STUN server port::

    nat_type, external_ip, external_port = stun.get_ip_info(stun_port=3478)

You may also specify the client interface and port that is used although this

is not needed::

    sip = "0.0.0.0" # interface to listen on (all)

    port = 54320 # port to listen on

    nat_type, external_ip, external_port = stun.get_ip_info(sip, port)

Read the code for more details...

LICENSE

-------

MIT

.. _forked and patched to support py3 by zoumi: https://github.com/zoumi/pystun

.. _original project by gaohawk: http://code.google.com/p/pystun/

.. _RFC 3489: http://www.ietf.org/rfc/rfc3489.txt

.. _taken over by jtriley: https://github.com/jtriley/pystun

.. _TalkIQ: https://github.com/talkiq