summaryrefslogtreecommitdiffhomepage
path: root/dhcpv4/option_relay_agent_information.go
blob: 63162a4876becb363793a5bfa6181f8a8ce43c27 (plain)
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
package dhcpv4

import (
	"fmt"
)

// RelayOptions is like Options, but stringifies using the Relay Agent Specific
// option space.
type RelayOptions struct {
	Options
}

var relayHumanizer = OptionHumanizer{
	ValueHumanizer: func(code OptionCode, data []byte) fmt.Stringer {
		return OptionGeneric{data}
	},
	CodeHumanizer: func(c uint8) OptionCode {
		return GenericOptionCode(c)
	},
}

// String prints the contained options using Relay Agent-specific option code parsing.
func (r RelayOptions) String() string {
	return r.Options.ToString(relayHumanizer)
}

// FromBytes parses relay agent options from data.
func (r *RelayOptions) FromBytes(data []byte) error {
	r.Options = make(Options)
	return r.Options.FromBytes(data)
}

// OptRelayAgentInfo returns a new DHCP Relay Agent Info option.
//
// The relay agent info option is described by RFC 3046.
func OptRelayAgentInfo(o ...Option) Option {
	return Option{Code: OptionRelayAgentInformation, Value: RelayOptions{OptionsFromList(o...)}}
}

type raiSubOptionCode uint8

func (o raiSubOptionCode) Code() uint8 {
	return uint8(o)
}

func (o raiSubOptionCode) String() string {
	if s, ok := raiSubOptionCodeToString[o]; ok {
		return s
	}
	return fmt.Sprintf("unknown (%d)", o)
}

// Option 82 Relay Agention Information Sub Options
const (
	AgentCircuitIDSubOption                raiSubOptionCode = 1   // RFC 3046
	AgentRemoteIDSubOption                 raiSubOptionCode = 2   // RFC 3046
	DOCSISDeviceClassSubOption             raiSubOptionCode = 4   // RFC 3256
	LinkSelectionSubOption                 raiSubOptionCode = 5   // RFC 3527
	SubscriberIDSubOption                  raiSubOptionCode = 6   // RFC 3993
	RADIUSAttributesSubOption              raiSubOptionCode = 7   // RFC 4014
	AuthenticationSubOption                raiSubOptionCode = 8   // RFC 4030
	VendorSpecificInformationSubOption     raiSubOptionCode = 9   // RFC 4243
	RelayAgentFlagsSubOption               raiSubOptionCode = 10  // RFC 5010
	ServerIdentifierOverrideSubOption      raiSubOptionCode = 11  // RFC 5107
	VirtualSubnetSelectionSubOption        raiSubOptionCode = 151 // RFC 6607
	VirtualSubnetSelectionControlSubOption raiSubOptionCode = 152 // RFC 6607
)

var raiSubOptionCodeToString = map[raiSubOptionCode]string{
	AgentCircuitIDSubOption:                "Agent Circuit ID Sub-option",
	AgentRemoteIDSubOption:                 "Agent Remote ID Sub-option",
	DOCSISDeviceClassSubOption:             "DOCSIS Device Class Sub-option",
	LinkSelectionSubOption:                 "Link Selection Sub-option",
	SubscriberIDSubOption:                  "Subscriber ID Sub-option",
	RADIUSAttributesSubOption:              "RADIUS Attributes Sub-option",
	AuthenticationSubOption:                "Authentication Sub-option",
	VendorSpecificInformationSubOption:     "Vendor Specific Sub-option",
	RelayAgentFlagsSubOption:               "Relay Agent Flags Sub-option",
	ServerIdentifierOverrideSubOption:      "Server Identifier Override Sub-option",
	VirtualSubnetSelectionSubOption:        "Virtual Subnet Selection Sub-option",
	VirtualSubnetSelectionControlSubOption: "Virtual Subnet Selection Control Sub-option",
}