diff options
author | gVisor bot <gvisor-bot@google.com> | 2019-06-02 06:44:55 +0000 |
---|---|---|
committer | gVisor bot <gvisor-bot@google.com> | 2019-06-02 06:44:55 +0000 |
commit | ceb0d792f328d1fc0692197d8856a43c3936a571 (patch) | |
tree | 83155f302eff44a78bcc30a3a08f4efe59a79379 /pkg/control/server/server.go | |
parent | deb7ecf1e46862d54f4b102f2d163cfbcfc37f3b (diff) | |
parent | 216da0b733dbed9aad9b2ab92ac75bcb906fd7ee (diff) |
Merge 216da0b7 (automated)
Diffstat (limited to 'pkg/control/server/server.go')
-rw-r--r-- | pkg/control/server/server.go | 160 |
1 files changed, 160 insertions, 0 deletions
diff --git a/pkg/control/server/server.go b/pkg/control/server/server.go new file mode 100644 index 000000000..1a15da1a8 --- /dev/null +++ b/pkg/control/server/server.go @@ -0,0 +1,160 @@ +// Copyright 2018 The gVisor Authors. +// +// 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. + +/* +Package server provides a basic control server interface. + +Note that no objects are registered by default. Users must provide their own +implementations of the control interface. +*/ +package server + +import ( + "os" + "sync" + + "gvisor.googlesource.com/gvisor/pkg/log" + "gvisor.googlesource.com/gvisor/pkg/unet" + "gvisor.googlesource.com/gvisor/pkg/urpc" +) + +// curUID is the unix user ID of the user that the control server is running as. +var curUID = os.Getuid() + +// Server is a basic control server. +type Server struct { + // socket is our bound socket. + socket *unet.ServerSocket + + // server is our rpc server. + server *urpc.Server + + // wg waits for the accept loop to terminate. + wg sync.WaitGroup +} + +// New returns a new bound control server. +func New(socket *unet.ServerSocket) *Server { + return &Server{ + socket: socket, + server: urpc.NewServer(), + } +} + +// FD returns the file descriptor that the server is running on. +func (s *Server) FD() int { + return s.socket.FD() +} + +// Wait waits for the main server goroutine to exit. This should be +// called after a call to Serve. +func (s *Server) Wait() { + s.wg.Wait() +} + +// Stop stops the server. Note that this function should only be called once +// and the server should not be used afterwards. +func (s *Server) Stop() { + s.socket.Close() + s.wg.Wait() + + // This will cause existing clients to be terminated safely. + s.server.Stop() +} + +// StartServing starts listening for connect and spawns the main service +// goroutine for handling incoming control requests. StartServing does not +// block; to wait for the control server to exit, call Wait. +func (s *Server) StartServing() error { + // Actually start listening. + if err := s.socket.Listen(); err != nil { + return err + } + + s.wg.Add(1) + go func() { // S/R-SAFE: does not impact state directly. + s.serve() + s.wg.Done() + }() + + return nil +} + +// serve is the body of the main service goroutine. It handles incoming control +// connections and dispatches requests to registered objects. +func (s *Server) serve() { + for { + // Accept clients. + conn, err := s.socket.Accept() + if err != nil { + return + } + + ucred, err := conn.GetPeerCred() + if err != nil { + log.Warningf("Control couldn't get credentials: %s", err.Error()) + conn.Close() + continue + } + + // Only allow this user and root. + if int(ucred.Uid) != curUID && ucred.Uid != 0 { + // Authentication failed. + log.Warningf("Control auth failure: other UID = %d, current UID = %d", ucred.Uid, curUID) + conn.Close() + continue + } + + // Handle the connection non-blockingly. + s.server.StartHandling(conn) + } +} + +// Register registers a specific control interface with the server. +func (s *Server) Register(obj interface{}) { + s.server.Register(obj) +} + +// CreateFromFD creates a new control bound to the given 'fd'. It has no +// registered interfaces and will not start serving until StartServing is +// called. +func CreateFromFD(fd int) (*Server, error) { + socket, err := unet.NewServerSocket(fd) + if err != nil { + return nil, err + } + return New(socket), nil +} + +// Create creates a new control server with an abstract unix socket +// with the given address, which must must be unique and a valid +// abstract socket name. +func Create(addr string) (*Server, error) { + socket, err := unet.Bind(addr, false) + if err != nil { + return nil, err + } + return New(socket), nil +} + +// CreateSocket creates a socket that can be used with control server, +// but doesn't start control server. 'addr' must be a valid and unique +// abstract socket name. Returns socket's FD, -1 in case of error. +func CreateSocket(addr string) (int, error) { + socket, err := unet.Bind(addr, false) + if err != nil { + return -1, err + } + return socket.Release() +} |