1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282
|
// Copyright 2018-present the CoreDHCP Authors. All rights reserved
// This source code is licensed under the MIT license found in the
// LICENSE file in the root directory of this source tree.
// Package file enables static mapping of MAC <--> IP addresses.
// The mapping is stored in a text file, where each mapping is described by one line containing
// two fields separated by spaces: MAC address, and IP address. For example:
//
// $ cat file_leases.txt
// 00:11:22:33:44:55 10.0.0.1
// 01:23:45:67:89:01 10.0.10.10
//
// To specify the plugin configuration in the server6/server4 sections of the config file, just
// pass the leases file name as plugin argument, e.g.:
//
// $ cat config.yml
//
// server6:
// ...
// plugins:
// - file: "file_leases.txt" [autorefresh]
// ...
//
// If the file path is not absolute, it is relative to the cwd where coredhcp is run.
//
// Optionally, when the 'autorefresh' argument is given, the plugin will try to refresh
// the lease mapping during runtime whenever the lease file is updated.
package file
import (
"bytes"
"errors"
"fmt"
"net"
"os"
"strings"
"sync"
"time"
"github.com/coredhcp/coredhcp/handler"
"github.com/coredhcp/coredhcp/logger"
"github.com/coredhcp/coredhcp/plugins"
"github.com/fsnotify/fsnotify"
"github.com/insomniacslk/dhcp/dhcpv4"
"github.com/insomniacslk/dhcp/dhcpv6"
)
const (
autoRefreshArg = "autorefresh"
)
var log = logger.GetLogger("plugins/file")
// Plugin wraps plugin registration information
var Plugin = plugins.Plugin{
Name: "file",
Setup6: setup6,
Setup4: setup4,
}
var recLock sync.RWMutex
// StaticRecords holds a MAC -> IP address mapping
var StaticRecords map[string]net.IP
// DHCPv6Records and DHCPv4Records are mappings between MAC addresses in
// form of a string, to network configurations.
var (
DHCPv6Records map[string]net.IP
DHCPv4Records map[string]net.IP
)
// LoadDHCPv4Records loads the DHCPv4Records global map with records stored on
// the specified file. The records have to be one per line, a mac address and an
// IPv4 address.
func LoadDHCPv4Records(filename string) (map[string]net.IP, error) {
log.Infof("reading leases from %s", filename)
data, err := os.ReadFile(filename)
if err != nil {
return nil, err
}
records := make(map[string]net.IP)
for _, lineBytes := range bytes.Split(data, []byte{'\n'}) {
line := string(lineBytes)
if len(line) == 0 {
continue
}
if strings.HasPrefix(line, "#") {
continue
}
tokens := strings.Fields(line)
if len(tokens) != 2 {
return nil, fmt.Errorf("malformed line, want 2 fields, got %d: %s", len(tokens), line)
}
hwaddr, err := net.ParseMAC(tokens[0])
if err != nil {
return nil, fmt.Errorf("malformed hardware address: %s", tokens[0])
}
ipaddr := net.ParseIP(tokens[1])
if ipaddr.To4() == nil {
return nil, fmt.Errorf("expected an IPv4 address, got: %v", ipaddr)
}
records[hwaddr.String()] = ipaddr
}
return records, nil
}
// LoadDHCPv6Records loads the DHCPv6Records global map with records stored on
// the specified file. The records have to be one per line, a mac address and an
// IPv6 address.
func LoadDHCPv6Records(filename string) (map[string]net.IP, error) {
log.Infof("reading leases from %s", filename)
data, err := os.ReadFile(filename)
if err != nil {
return nil, err
}
records := make(map[string]net.IP)
for _, lineBytes := range bytes.Split(data, []byte{'\n'}) {
line := string(lineBytes)
if len(line) == 0 {
continue
}
if strings.HasPrefix(line, "#") {
continue
}
tokens := strings.Fields(line)
if len(tokens) != 2 {
return nil, fmt.Errorf("malformed line, want 2 fields, got %d: %s", len(tokens), line)
}
hwaddr, err := net.ParseMAC(tokens[0])
if err != nil {
return nil, fmt.Errorf("malformed hardware address: %s", tokens[0])
}
ipaddr := net.ParseIP(tokens[1])
if ipaddr.To16() == nil || ipaddr.To4() != nil {
return nil, fmt.Errorf("expected an IPv6 address, got: %v", ipaddr)
}
records[hwaddr.String()] = ipaddr
}
return records, nil
}
// Handler6 handles DHCPv6 packets for the file plugin
func Handler6(req, resp dhcpv6.DHCPv6) (dhcpv6.DHCPv6, bool) {
m, err := req.GetInnerMessage()
if err != nil {
log.Errorf("BUG: could not decapsulate: %v", err)
return nil, true
}
if m.Options.OneIANA() == nil {
log.Debug("No address requested")
return resp, false
}
mac, err := dhcpv6.ExtractMAC(req)
if err != nil {
log.Warningf("Could not find client MAC, passing")
return resp, false
}
log.Debugf("looking up an IP address for MAC %s", mac.String())
recLock.RLock()
defer recLock.RUnlock()
ipaddr, ok := StaticRecords[mac.String()]
if !ok {
log.Warningf("MAC address %s is unknown", mac.String())
return resp, false
}
log.Debugf("found IP address %s for MAC %s", ipaddr, mac.String())
resp.AddOption(&dhcpv6.OptIANA{
IaId: m.Options.OneIANA().IaId,
Options: dhcpv6.IdentityOptions{Options: []dhcpv6.Option{
&dhcpv6.OptIAAddress{
IPv6Addr: ipaddr,
PreferredLifetime: 3600 * time.Second,
ValidLifetime: 3600 * time.Second,
},
}},
})
return resp, false
}
// Handler4 handles DHCPv4 packets for the file plugin
func Handler4(req, resp *dhcpv4.DHCPv4) (*dhcpv4.DHCPv4, bool) {
recLock.RLock()
defer recLock.RUnlock()
ipaddr, ok := StaticRecords[req.ClientHWAddr.String()]
if !ok {
log.Warningf("MAC address %s is unknown", req.ClientHWAddr.String())
return resp, false
}
resp.YourIPAddr = ipaddr
log.Debugf("found IP address %s for MAC %s", ipaddr, req.ClientHWAddr.String())
return resp, true
}
func setup6(args ...string) (handler.Handler6, error) {
h6, _, err := setupFile(true, args...)
return h6, err
}
func setup4(args ...string) (handler.Handler4, error) {
_, h4, err := setupFile(false, args...)
return h4, err
}
func setupFile(v6 bool, args ...string) (handler.Handler6, handler.Handler4, error) {
var err error
if len(args) < 1 {
return nil, nil, errors.New("need a file name")
}
filename := args[0]
if filename == "" {
return nil, nil, errors.New("got empty file name")
}
// load initial database from lease file
if err = loadFromFile(v6, filename); err != nil {
return nil, nil, err
}
// when the 'autorefresh' argument was passed, watch the lease file for
// changes and reload the lease mapping on any event
if len(args) > 1 && args[1] == autoRefreshArg {
// creates a new file watcher
watcher, err := fsnotify.NewWatcher()
if err != nil {
return nil, nil, fmt.Errorf("failed to create watcher: %w", err)
}
// have file watcher watch over lease file
if err = watcher.Add(filename); err != nil {
return nil, nil, fmt.Errorf("failed to watch %s: %w", filename, err)
}
// very simple watcher on the lease file to trigger a refresh on any event
// on the file
go func() {
for range watcher.Events {
err := loadFromFile(v6, filename)
if err != nil {
log.Warningf("failed to refresh from %s: %s", filename, err)
continue
}
log.Infof("updated to %d leases from %s", len(StaticRecords), filename)
}
}()
}
log.Infof("loaded %d leases from %s", len(StaticRecords), filename)
return Handler6, Handler4, nil
}
func loadFromFile(v6 bool, filename string) error {
var err error
var records map[string]net.IP
var protver int
if v6 {
protver = 6
records, err = LoadDHCPv6Records(filename)
} else {
protver = 4
records, err = LoadDHCPv4Records(filename)
}
if err != nil {
return fmt.Errorf("failed to load DHCPv%d records: %w", protver, err)
}
recLock.Lock()
defer recLock.Unlock()
StaticRecords = records
return nil
}
|