Name

lua-resty-dhcp

Table of Contents

• Status
• Synopsis
• Description
• Installation
• Bugs and Patches
• Author
• Copyright and License
• See Also

Status

This library is already usable though still highly experimental.

The Lua API is still in flux and may change in the near future without notice.

Back to TOC

Synopsis

stream {
    server {
        listen 10.0.0.1:67 udp;

        content_by_lua_block {
            local dhcpd = require "resty.dhcp.server"

            local function dhcpd_callback(op, packet, options)
                return {
                    yiaddr = "10.10.0.5",
                    options = {
                        subnet_mask = "255.255.255.0",
                        broadcast_address = "10.10.10.255",
                        router = {"10.10.10.1", "10.10.10.2"},
                        domain_name = "openresty.com",
                        hostname = "agentzh.openresty.com",
                        address_lease_time = 86400,
                        renewal_time = 3600,
                        ipxe = {
                            no_proxydhcp = 1
                        }
                    }
                }
            end

            local ok, err = dhcpd.serve(dhcpd_callback)
            if not ok then
                ngx.log(ngx.ERR, err)
            end
        }
    }
}

Back to TOC

Description

This library provides a simple and not by any means complete implementation of the dhcp packet/protocol. Most of the options are defined as void at this stage, and will need a typedef to be usable. Please create a pull request if you do so.

Back to TOC

Installation

Copy the contents of the lib directory to a path in ngx-lua's search path or define the path in nginx's configuration:

# nginx.conf
stream {
    lua_package_path "${prefix}/lib/?.lua;;";
}

And then load the module provided by this library in Lua. For example,

local dhcpd = require "resty.dhcp.server"

or use packet directly:

local dhcp_packet = require "resty.dhcp.packet"

Back to TOC

Bugs and Patches

Please report bugs or submit patches by

Creating a ticket on the GitHub Issue Tracker,

Back to TOC

Author

Bjørnar Ness bjornar.ness@gmail.com

Back to TOC

Copyright and License

This module is licensed under the BSD license.

Copyright (C) 2016-2017, by Bjørnar Ness

All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

• Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

• Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Back to TOC

See Also

• module [resty.tftp]: https://github.com/bjne/lua-resty-tftp
• the ngx_stream_lua module: https://github.com/openresty/stream-lua-nginx-module
• OpenResty: https://openresty.org/

Back to TOC