2019-04-29 21:25:05 +00:00
|
|
|
// Copyright 2018 The gVisor Authors.
|
2018-07-09 21:03:03 +00:00
|
|
|
//
|
|
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
|
|
// you may not use this file except in compliance with the License.
|
|
|
|
// You may obtain a copy of the License at
|
|
|
|
//
|
|
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
//
|
|
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
|
|
// See the License for the specific language governing permissions and
|
|
|
|
// limitations under the License.
|
2018-05-02 05:50:55 +00:00
|
|
|
|
2019-02-22 21:33:49 +00:00
|
|
|
// Package icmp contains the implementation of the ICMP and IPv6-ICMP transport
|
2018-05-02 05:50:55 +00:00
|
|
|
// protocols for use in ping. To use it in the networking stack, this package
|
|
|
|
// must be added to the project, and
|
2019-02-22 21:33:49 +00:00
|
|
|
// activated on the stack by passing icmp.ProtocolName (or "icmp") and/or
|
|
|
|
// icmp.ProtocolName6 (or "icmp6") as one of the transport protocols when
|
2018-05-02 05:50:55 +00:00
|
|
|
// calling stack.New(). Then endpoints can be created by passing
|
2019-02-22 21:33:49 +00:00
|
|
|
// icmp.ProtocolNumber or icmp.ProtocolNumber6 as the transport protocol number
|
2018-05-02 05:50:55 +00:00
|
|
|
// when calling Stack.NewEndpoint().
|
2019-02-22 21:33:49 +00:00
|
|
|
package icmp
|
2018-05-02 05:50:55 +00:00
|
|
|
|
|
|
|
import (
|
|
|
|
"encoding/binary"
|
|
|
|
"fmt"
|
|
|
|
|
2019-06-13 23:49:09 +00:00
|
|
|
"gvisor.dev/gvisor/pkg/tcpip"
|
|
|
|
"gvisor.dev/gvisor/pkg/tcpip/buffer"
|
|
|
|
"gvisor.dev/gvisor/pkg/tcpip/header"
|
|
|
|
"gvisor.dev/gvisor/pkg/tcpip/stack"
|
|
|
|
"gvisor.dev/gvisor/pkg/tcpip/transport/raw"
|
|
|
|
"gvisor.dev/gvisor/pkg/waiter"
|
2018-05-02 05:50:55 +00:00
|
|
|
)
|
|
|
|
|
|
|
|
const (
|
2019-02-22 21:33:49 +00:00
|
|
|
// ProtocolName4 is the string representation of the icmp protocol name.
|
|
|
|
ProtocolName4 = "icmp4"
|
2018-05-02 05:50:55 +00:00
|
|
|
|
|
|
|
// ProtocolNumber4 is the ICMP protocol number.
|
|
|
|
ProtocolNumber4 = header.ICMPv4ProtocolNumber
|
|
|
|
|
2019-02-22 21:33:49 +00:00
|
|
|
// ProtocolName6 is the string representation of the icmp protocol name.
|
|
|
|
ProtocolName6 = "icmp6"
|
2018-05-02 05:50:55 +00:00
|
|
|
|
|
|
|
// ProtocolNumber6 is the IPv6-ICMP protocol number.
|
|
|
|
ProtocolNumber6 = header.ICMPv6ProtocolNumber
|
|
|
|
)
|
|
|
|
|
2019-02-27 22:30:20 +00:00
|
|
|
// protocol implements stack.TransportProtocol.
|
2018-05-02 05:50:55 +00:00
|
|
|
type protocol struct {
|
|
|
|
number tcpip.TransportProtocolNumber
|
|
|
|
}
|
|
|
|
|
|
|
|
// Number returns the ICMP protocol number.
|
|
|
|
func (p *protocol) Number() tcpip.TransportProtocolNumber {
|
|
|
|
return p.number
|
|
|
|
}
|
|
|
|
|
|
|
|
func (p *protocol) netProto() tcpip.NetworkProtocolNumber {
|
|
|
|
switch p.number {
|
|
|
|
case ProtocolNumber4:
|
|
|
|
return header.IPv4ProtocolNumber
|
|
|
|
case ProtocolNumber6:
|
|
|
|
return header.IPv6ProtocolNumber
|
|
|
|
}
|
|
|
|
panic(fmt.Sprint("unknown protocol number: ", p.number))
|
|
|
|
}
|
|
|
|
|
2019-02-27 22:30:20 +00:00
|
|
|
// NewEndpoint creates a new icmp endpoint. It implements
|
|
|
|
// stack.TransportProtocol.NewEndpoint.
|
2018-05-02 05:50:55 +00:00
|
|
|
func (p *protocol) NewEndpoint(stack *stack.Stack, netProto tcpip.NetworkProtocolNumber, waiterQueue *waiter.Queue) (tcpip.Endpoint, *tcpip.Error) {
|
|
|
|
if netProto != p.netProto() {
|
|
|
|
return nil, tcpip.ErrUnknownProtocol
|
|
|
|
}
|
2019-04-02 18:12:29 +00:00
|
|
|
return newEndpoint(stack, netProto, p.number, waiterQueue)
|
2019-02-27 22:30:20 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
// NewRawEndpoint creates a new raw icmp endpoint. It implements
|
|
|
|
// stack.TransportProtocol.NewRawEndpoint.
|
|
|
|
func (p *protocol) NewRawEndpoint(stack *stack.Stack, netProto tcpip.NetworkProtocolNumber, waiterQueue *waiter.Queue) (tcpip.Endpoint, *tcpip.Error) {
|
|
|
|
if netProto != p.netProto() {
|
|
|
|
return nil, tcpip.ErrUnknownProtocol
|
|
|
|
}
|
2019-04-02 18:12:29 +00:00
|
|
|
return raw.NewEndpoint(stack, netProto, p.number, waiterQueue)
|
2018-05-02 05:50:55 +00:00
|
|
|
}
|
|
|
|
|
2019-02-22 21:33:49 +00:00
|
|
|
// MinimumPacketSize returns the minimum valid icmp packet size.
|
2018-05-02 05:50:55 +00:00
|
|
|
func (p *protocol) MinimumPacketSize() int {
|
|
|
|
switch p.number {
|
|
|
|
case ProtocolNumber4:
|
2019-07-16 20:02:30 +00:00
|
|
|
return header.ICMPv4MinimumSize
|
2018-05-02 05:50:55 +00:00
|
|
|
case ProtocolNumber6:
|
|
|
|
return header.ICMPv6EchoMinimumSize
|
|
|
|
}
|
|
|
|
panic(fmt.Sprint("unknown protocol number: ", p.number))
|
|
|
|
}
|
|
|
|
|
2019-07-16 20:02:30 +00:00
|
|
|
// ParsePorts in case of ICMP sets src to 0, dst to ICMP ID, and err to nil.
|
2018-09-04 21:30:15 +00:00
|
|
|
func (p *protocol) ParsePorts(v buffer.View) (src, dst uint16, err *tcpip.Error) {
|
|
|
|
switch p.number {
|
|
|
|
case ProtocolNumber4:
|
2019-07-16 20:02:30 +00:00
|
|
|
return 0, binary.BigEndian.Uint16(v[header.ICMPv4PayloadOffset:]), nil
|
2018-09-04 21:30:15 +00:00
|
|
|
case ProtocolNumber6:
|
|
|
|
return 0, binary.BigEndian.Uint16(v[header.ICMPv6MinimumSize:]), nil
|
|
|
|
}
|
|
|
|
panic(fmt.Sprint("unknown protocol number: ", p.number))
|
2018-05-02 05:50:55 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
// HandleUnknownDestinationPacket handles packets targeted at this protocol but
|
|
|
|
// that don't match any existing endpoint.
|
2018-09-13 04:57:04 +00:00
|
|
|
func (p *protocol) HandleUnknownDestinationPacket(*stack.Route, stack.TransportEndpointID, buffer.VectorisedView) bool {
|
2018-05-02 05:50:55 +00:00
|
|
|
return true
|
|
|
|
}
|
|
|
|
|
|
|
|
// SetOption implements TransportProtocol.SetOption.
|
|
|
|
func (p *protocol) SetOption(option interface{}) *tcpip.Error {
|
|
|
|
return tcpip.ErrUnknownProtocolOption
|
|
|
|
}
|
|
|
|
|
|
|
|
// Option implements TransportProtocol.Option.
|
|
|
|
func (p *protocol) Option(option interface{}) *tcpip.Error {
|
|
|
|
return tcpip.ErrUnknownProtocolOption
|
|
|
|
}
|
|
|
|
|
|
|
|
func init() {
|
|
|
|
stack.RegisterTransportProtocolFactory(ProtocolName4, func() stack.TransportProtocol {
|
|
|
|
return &protocol{ProtocolNumber4}
|
|
|
|
})
|
|
|
|
|
2018-09-04 21:30:15 +00:00
|
|
|
stack.RegisterTransportProtocolFactory(ProtocolName6, func() stack.TransportProtocol {
|
|
|
|
return &protocol{ProtocolNumber6}
|
|
|
|
})
|
2018-05-02 05:50:55 +00:00
|
|
|
}
|