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
|
package dhcpv6
import (
"fmt"
"strings"
"github.com/u-root/uio/uio"
)
// Option is an interface that all DHCPv6 options adhere to.
type Option interface {
Code() OptionCode
ToBytes() []byte
String() string
FromBytes([]byte) error
}
type OptionGeneric struct {
OptionCode OptionCode
OptionData []byte
}
func (og *OptionGeneric) Code() OptionCode {
return og.OptionCode
}
func (og *OptionGeneric) ToBytes() []byte {
return og.OptionData
}
func (og *OptionGeneric) String() string {
if len(og.OptionData) == 0 {
return og.OptionCode.String()
}
return fmt.Sprintf("%s: %v", og.OptionCode, og.OptionData)
}
// FromBytes resets OptionData to p.
func (og *OptionGeneric) FromBytes(p []byte) error {
og.OptionData = append([]byte(nil), p...)
return nil
}
// ParseOption parses data according to the given code.
//
// Parse a sequence of bytes as a single DHCPv6 option.
// Returns the option structure, or an error if any.
func ParseOption(code OptionCode, optData []byte) (Option, error) {
var opt Option
switch code {
case OptionClientID:
opt = &optClientID{}
case OptionServerID:
opt = &optServerID{}
case OptionIANA:
opt = &OptIANA{}
case OptionIATA:
opt = &OptIATA{}
case OptionIAAddr:
opt = &OptIAAddress{}
case OptionORO:
opt = &optRequestedOption{}
case OptionElapsedTime:
opt = &optElapsedTime{}
case OptionRelayMsg:
opt = &optRelayMsg{}
case OptionStatusCode:
opt = &OptStatusCode{}
case OptionUserClass:
opt = &OptUserClass{}
case OptionVendorClass:
opt = &OptVendorClass{}
case OptionVendorOpts:
opt = &OptVendorOpts{}
case OptionInterfaceID:
opt = &optInterfaceID{}
case OptionDNSRecursiveNameServer:
opt = &optDNS{}
case OptionDomainSearchList:
opt = &optDomainSearchList{}
case OptionIAPD:
opt = &OptIAPD{}
case OptionIAPrefix:
opt = &OptIAPrefix{}
case OptionInformationRefreshTime:
opt = &optInformationRefreshTime{}
case OptionRemoteID:
opt = &OptRemoteID{}
case OptionFQDN:
opt = &OptFQDN{}
case OptionNTPServer:
opt = &OptNTPServer{}
case OptionBootfileURL:
opt = &optBootFileURL{}
case OptionBootfileParam:
opt = &optBootFileParam{}
case OptionClientArchType:
opt = &optClientArchType{}
case OptionNII:
opt = &OptNetworkInterfaceID{}
case OptionClientLinkLayerAddr:
opt = &optClientLinkLayerAddress{}
case OptionDHCPv4Msg:
opt = &OptDHCPv4Msg{}
case OptionDHCP4oDHCP6Server:
opt = &OptDHCP4oDHCP6Server{}
case Option4RD:
opt = &Opt4RD{}
case Option4RDMapRule:
opt = &Opt4RDMapRule{}
case Option4RDNonMapRule:
opt = &Opt4RDNonMapRule{}
case OptionRelayPort:
opt = &optRelayPort{}
default:
opt = &OptionGeneric{OptionCode: code}
}
return opt, opt.FromBytes(optData)
}
type longStringer interface {
LongString(spaceIndent int) string
}
// Options is a collection of options.
type Options []Option
// LongString prints options with indentation of at least spaceIndent spaces.
func (o Options) LongString(spaceIndent int) string {
indent := strings.Repeat(" ", spaceIndent)
var s strings.Builder
if len(o) == 0 {
s.WriteString("[]")
} else {
s.WriteString("[\n")
for _, opt := range o {
s.WriteString(indent)
s.WriteString(" ")
if ls, ok := opt.(longStringer); ok {
s.WriteString(ls.LongString(spaceIndent + 2))
} else {
s.WriteString(opt.String())
}
s.WriteString("\n")
}
s.WriteString(indent)
s.WriteString("]")
}
return s.String()
}
// Get returns all options matching the option code.
func (o Options) Get(code OptionCode) []Option {
var ret []Option
for _, opt := range o {
if opt.Code() == code {
ret = append(ret, opt)
}
}
return ret
}
// GetOne returns the first option matching the option code.
func (o Options) GetOne(code OptionCode) Option {
for _, opt := range o {
if opt.Code() == code {
return opt
}
}
return nil
}
// Add appends one option.
func (o *Options) Add(option Option) {
*o = append(*o, option)
}
// Del deletes all options matching the option code.
func (o *Options) Del(code OptionCode) {
newOpts := make(Options, 0, len(*o))
for _, opt := range *o {
if opt.Code() != code {
newOpts = append(newOpts, opt)
}
}
*o = newOpts
}
// Update replaces the first option of the same type as the specified one.
func (o *Options) Update(option Option) {
for idx, opt := range *o {
if opt.Code() == option.Code() {
(*o)[idx] = option
// don't look further
return
}
}
// if not found, add it
o.Add(option)
}
// ToBytes marshals all options to bytes.
func (o Options) ToBytes() []byte {
buf := uio.NewBigEndianBuffer(nil)
for _, opt := range o {
buf.Write16(uint16(opt.Code()))
val := opt.ToBytes()
buf.Write16(uint16(len(val)))
buf.WriteBytes(val)
}
return buf.Data()
}
// FromBytes reads data into o and returns an error if the options are not a
// valid serialized representation of DHCPv6 options per RFC 3315.
func (o *Options) FromBytes(data []byte) error {
return o.FromBytesWithParser(data, ParseOption)
}
// OptionParser is a function signature for option parsing
type OptionParser func(code OptionCode, data []byte) (Option, error)
// FromBytesWithParser parses Options from byte sequences using the parsing
// function that is passed in as a paremeter
func (o *Options) FromBytesWithParser(data []byte, parser OptionParser) error {
if *o == nil {
*o = make(Options, 0, 10)
}
if len(data) == 0 {
// no options, no party
return nil
}
buf := uio.NewBigEndianBuffer(data)
for buf.Has(4) {
code := OptionCode(buf.Read16())
length := int(buf.Read16())
// Consume, but do not Copy. Each parser will make a copy of
// pertinent data.
optData := buf.Consume(length)
opt, err := parser(code, optData)
if err != nil {
return err
}
*o = append(*o, opt)
}
return buf.FinError()
}
|