nat - implements NAT handling facilities

Copyright (c) 2016-2019 Benoît Chesneau.

Version: 0.4.0

nat

Library that implements NAT facilities.

Currently supported protocols:

• natpmp
• UPNP v1
• UPNP v2

Usage

Discover the NAT gateway:

You should start by discovering the NAT gateway if it exists:

1> {ok, Ctx} = nat:discover().
{ok,{natupnp_v1,{nat_upnp,"http://192.168.1.254:5678/control/wan_ip_connection",
                          "192.168.1.22"}}}

If OK you will be able to use the context in other functions. For example to get the external gateway:

2> nat:get_external_address(Ctx).
{ok,"88.163.70.217"}

And the local IP associated to this:

3> nat:get_internal_address(Ctx).
{ok,"192.168.1.22"}

Map an External IP Address

{ok, Ctx} = nat:discover(),
Protocol = tcp,
InternalPort = 80,
ExternalPortRequest = 8080,
Lifetime = 3600,

{ok, Since, InternalPort, ExternalPortRequest, MappingLifetime} = \
    nat:add_port_mapping(Ctx, Protocol, InternalPort, ExternalPortRequest, Lifetime).

This map the port 80 to the port 8080.

Note: pass 0 to the ExternalPortRequest to ask to the router to create a dynamic port.

Remove a port mapping

ok = nat:delete_port_mapping(Ctx, Protocol, InternalPort, ExternalPort)

Contribute

For issues, comments or feedback please create an issue.

Modules