lxc: Ensure the client supports event handler authentication

In many cases, we call `AddHandler` directly after creating an operation, expecting it to support connection to an events websocket. This won't be the case if the client is unable to authenticate with that endpoint. Signed-off-by: Max Asnaashari <max.asnaashari@canonical.com>
canonical · Mar 18, 2024 · c3a3f44 · c3a3f44
1 parent 861f757
commit c3a3f44
Show file tree

Hide file tree

Showing 18 changed files with 163 additions and 100 deletions.
diff --git a/client/lxd_containers.go b/client/lxd_containers.go
@@ -207,8 +207,10 @@ func (r *ProtocolLXD) tryCreateContainer(req api.ContainersPost, urls []string)
 
  rop.targetOp = op
 
- for _, handler := range rop.handlers {
- _, _ = rop.targetOp.AddHandler(handler)
+ if r.supportsAuthentication {
+ for _, handler := range rop.handlers {
+ _, _ = rop.targetOp.AddHandler(handler)
+ }
  }
 
  err = rop.targetOp.Wait()
@@ -570,8 +572,10 @@ func (r *ProtocolLXD) tryMigrateContainer(source InstanceServer, name string, re
 
  rop.targetOp = op
 
- for _, handler := range rop.handlers {
- _, _ = rop.targetOp.AddHandler(handler)
+ if source.SupportsAuthentication() {
+ for _, handler := range rop.handlers {
+ _, _ = rop.targetOp.AddHandler(handler)
+ }
  }
 
  err = rop.targetOp.Wait()
@@ -1262,8 +1266,10 @@ func (r *ProtocolLXD) tryMigrateContainerSnapshot(source InstanceServer, contain
 
  rop.targetOp = op
 
- for _, handler := range rop.handlers {
- _, _ = rop.targetOp.AddHandler(handler)
+ if source.SupportsAuthentication() {
+ for _, handler := range rop.handlers {
+ _, _ = rop.targetOp.AddHandler(handler)
+ }
  }
 
  err = rop.targetOp.Wait()

diff --git a/client/lxd_images.go b/client/lxd_images.go
@@ -653,8 +653,10 @@ func (r *ProtocolLXD) tryCopyImage(req api.ImagesPost, urls []string) (RemoteOpe
  rop.targetOp = op
  rop.handlerLock.Unlock()
 
- for _, handler := range rop.handlers {
- _, _ = rop.targetOp.AddHandler(handler)
+ if r.supportsAuthentication {
+ for _, handler := range rop.handlers {
+ _, _ = rop.targetOp.AddHandler(handler)
+ }
  }
 
  err = rop.targetOp.Wait()
@@ -854,8 +856,10 @@ func (r *ProtocolLXD) CopyImage(source ImageServer, image api.Image, args *Image
  rop.targetOp = op
  rop.handlerLock.Unlock()
 
- for _, handler := range rop.handlers {
- _, _ = rop.targetOp.AddHandler(handler)
+ if r.supportsAuthentication {
+ for _, handler := range rop.handlers {
+ _, _ = rop.targetOp.AddHandler(handler)
+ }
  }
 
  err = rop.targetOp.Wait()

diff --git a/client/lxd_instances.go b/client/lxd_instances.go
@@ -266,8 +266,10 @@ func (r *ProtocolLXD) tryRebuildInstance(instanceName string, req api.InstanceRe
  rop.targetOp = op
  rop.handlerLock.Unlock()
 
- for _, handler := range rop.handlers {
- _, _ = rop.targetOp.AddHandler(handler)
+ if r.supportsAuthentication {
+ for _, handler := range rop.handlers {
+ _, _ = rop.targetOp.AddHandler(handler)
+ }
  }
 
  err = rop.targetOp.Wait()
@@ -754,8 +756,10 @@ func (r *ProtocolLXD) tryCreateInstance(req api.InstancesPost, urls []string, op
  rop.targetOp = op
  rop.handlerLock.Unlock()
 
- for _, handler := range rop.handlers {
- _, _ = rop.targetOp.AddHandler(handler)
+ if r.supportsAuthentication {
+ for _, handler := range rop.handlers {
+ _, _ = rop.targetOp.AddHandler(handler)
+ }
  }
 
  err = rop.targetOp.Wait()
@@ -1111,8 +1115,10 @@ func (r *ProtocolLXD) tryMigrateInstance(source InstanceServer, name string, req
 
  rop.targetOp = op
 
- for _, handler := range rop.handlers {
- _, _ = rop.targetOp.AddHandler(handler)
+ if source.SupportsAuthentication() {
+ for _, handler := range rop.handlers {
+ _, _ = rop.targetOp.AddHandler(handler)
+ }
  }
 
  err = rop.targetOp.Wait()
@@ -2110,8 +2116,10 @@ func (r *ProtocolLXD) tryMigrateInstanceSnapshot(source InstanceServer, instance
 
  rop.targetOp = op
 
- for _, handler := range rop.handlers {
- _, _ = rop.targetOp.AddHandler(handler)
+ if source.SupportsAuthentication() {
+ for _, handler := range rop.handlers {
+ _, _ = rop.targetOp.AddHandler(handler)
+ }
  }
 
  err = rop.targetOp.Wait()

diff --git a/client/lxd_storage_volumes.go b/client/lxd_storage_volumes.go
@@ -438,8 +438,10 @@ func (r *ProtocolLXD) tryMigrateStoragePoolVolume(source InstanceServer, pool st
  chDone: make(chan bool),
  }
 
- for _, handler := range rop.handlers {
- _, _ = rop.targetOp.AddHandler(handler)
+ if source.SupportsAuthentication() {
+ for _, handler := range rop.handlers {
+ _, _ = rop.targetOp.AddHandler(handler)
+ }
  }
 
  err = rop.targetOp.Wait()
@@ -500,8 +502,10 @@ func (r *ProtocolLXD) tryCreateStoragePoolVolume(pool string, req api.StorageVol
  chDone: make(chan bool),
  }
 
- for _, handler := range rop.handlers {
- _, _ = rop.targetOp.AddHandler(handler)
+ if r.SupportsAuthentication() {
+ for _, handler := range rop.handlers {
+ _, _ = rop.targetOp.AddHandler(handler)
+ }
  }
 
  err = rop.targetOp.Wait()

diff --git a/lxc-to-lxd/main_migrate.go b/lxc-to-lxd/main_migrate.go
@@ -463,10 +463,12 @@ func convertContainer(d lxd.ContainerServer, container *liblxc.Container, storag
  }
 
  progress := cli.ProgressRenderer{Format: "Transferring container: %s"}
- _, err = op.AddHandler(progress.UpdateOp)
- if err != nil {
- progress.Done("")
- return err
+ if d.SupportsAuthentication() {
+ _, err = op.AddHandler(progress.UpdateOp)
+ if err != nil {
+ progress.Done("")
+ return err
+ }
  }
 
  rootfs, _ := getRootfs(conf)

diff --git a/lxc/action.go b/lxc/action.go
@@ -183,10 +183,12 @@ func (c *cmdAction) doActionAll(action string, resource remoteResource) error {
  Quiet: c.global.flagQuiet,
  }
 
- _, err = op.AddHandler(progress.UpdateOp)
- if err != nil {
- progress.Done("")
- return err
+ if d.SupportsAuthentication() {
+ _, err = op.AddHandler(progress.UpdateOp)
+ if err != nil {
+ progress.Done("")
+ return err
+ }
  }
 
  err = cli.CancelableWait(op, &progress)
@@ -274,10 +276,12 @@ func (c *cmdAction) doAction(action string, conf *config.Config, nameArg string)
  Quiet: c.global.flagQuiet,
  }
 
- _, err = op.AddHandler(progress.UpdateOp)
- if err != nil {
- progress.Done("")
- return err
+ if d.SupportsAuthentication() {
+ _, err = op.AddHandler(progress.UpdateOp)
+ if err != nil {
+ progress.Done("")
+ return err
+ }
  }
 
  // Wait for operation to finish

diff --git a/lxc/cluster.go b/lxc/cluster.go
@@ -1254,10 +1254,12 @@ func (c *cmdClusterEvacuateAction) Run(cmd *cobra.Command, args []string) error
  Quiet: c.global.flagQuiet,
  }
 
- _, err = op.AddHandler(progress.UpdateOp)
- if err != nil {
- progress.Done("")
- return err
+ if resource.server.SupportsAuthentication() {
+ _, err = op.AddHandler(progress.UpdateOp)
+ if err != nil {
+ progress.Done("")
+ return err
+ }
  }
 
  err = op.Wait()

diff --git a/lxc/copy.go b/lxc/copy.go
@@ -337,10 +337,12 @@ func (c *cmdCopy) copyInstance(conf *config.Config, sourceResource string, destR
  Quiet: c.global.flagQuiet,
  }
 
- _, err = op.AddHandler(progress.UpdateOp)
- if err != nil {
- progress.Done("")
- return err
+ if dest.SupportsAuthentication() {
+ _, err = op.AddHandler(progress.UpdateOp)
+ if err != nil {
+ progress.Done("")
+ return err
+ }
  }
 
  // Wait for the copy to complete
@@ -381,10 +383,12 @@ func (c *cmdCopy) copyInstance(conf *config.Config, sourceResource string, destR
  Quiet: c.global.flagQuiet,
  }
 
- _, err = op.AddHandler(progress.UpdateOp)
- if err != nil {
- progress.Done("")
- return err
+ if dest.SupportsAuthentication() {
+ _, err = op.AddHandler(progress.UpdateOp)
+ if err != nil {
+ progress.Done("")
+ return err
+ }
  }
 
  // Wait for the copy to complete

diff --git a/lxc/export.go b/lxc/export.go
@@ -87,10 +87,12 @@ func (c *cmdExport) Run(cmd *cobra.Command, args []string) error {
  Quiet: c.global.flagQuiet,
  }
 
- _, err = op.AddHandler(progress.UpdateOp)
- if err != nil {
- progress.Done("")
- return err
+ if d.SupportsAuthentication() {
+ _, err = op.AddHandler(progress.UpdateOp)
+ if err != nil {
+ progress.Done("")
+ return err
+ }
  }
 
  // Wait until backup is done

diff --git a/lxc/image.go b/lxc/image.go
@@ -264,10 +264,12 @@ func (c *cmdImageCopy) Run(cmd *cobra.Command, args []string) error {
  Quiet: c.global.flagQuiet,
  }
 
- _, err = op.AddHandler(progress.UpdateOp)
- if err != nil {
- progress.Done("")
- return err
+ if destinationServer.SupportsAuthentication() {
+ _, err = op.AddHandler(progress.UpdateOp)
+ if err != nil {
+ progress.Done("")
+ return err
+ }
  }
 
  // Wait for operation to finish
@@ -1373,9 +1375,11 @@ func (c *cmdImageRefresh) Run(cmd *cobra.Command, args []string) error {
  }
 
  // Register progress handler
- _, err = op.AddHandler(progress.UpdateOp)
- if err != nil {
- return err
+ if resource.server.SupportsAuthentication() {
+ _, err = op.AddHandler(progress.UpdateOp)
+ if err != nil {
+ return err
+ }
  }
 
  // Wait for the refresh to happen

diff --git a/lxc/init.go b/lxc/init.go
@@ -361,10 +361,12 @@ func (c *cmdInit) create(conf *config.Config, args []string) (lxd.InstanceServer
  Quiet: c.global.flagQuiet,
  }
 
- _, err = op.AddHandler(progress.UpdateOp)
- if err != nil {
- progress.Done("")
- return nil, "", err
+ if d.SupportsAuthentication() {
+ _, err = op.AddHandler(progress.UpdateOp)
+ if err != nil {
+ progress.Done("")
+ return nil, "", err
+ }
  }
 
  err = cli.CancelableWait(op, &progress)

diff --git a/lxc/launch.go b/lxc/launch.go
@@ -92,10 +92,12 @@ func (c *cmdLaunch) Run(cmd *cobra.Command, args []string) error {
  Quiet: c.global.flagQuiet,
  }
 
- _, err = op.AddHandler(progress.UpdateOp)
- if err != nil {
- progress.Done("")
- return err
+ if d.SupportsAuthentication() {
+ _, err = op.AddHandler(progress.UpdateOp)
+ if err != nil {
+ progress.Done("")
+ return err
+ }
  }
 
  // Wait for operation to finish

diff --git a/lxc/move.go b/lxc/move.go
@@ -315,11 +315,14 @@ func moveClusterInstance(conf *config.Config, sourceResource string, destResourc
  Quiet: quiet,
  }
 
- _, err = op.AddHandler(progress.UpdateOp)
- if err != nil {
- progress.Done("")
- return err
+ if source.SupportsAuthentication() {
+ _, err = op.AddHandler(progress.UpdateOp)
+ if err != nil {
+ progress.Done("")
+ return err
+ }
  }
+
  // Wait for the move to complete
  err = cli.CancelableWait(op, &progress)
  if err != nil {

diff --git a/lxc/publish.go b/lxc/publish.go
@@ -254,10 +254,12 @@ func (c *cmdPublish) Run(cmd *cobra.Command, args []string) error {
  Quiet: c.global.flagQuiet,
  }
 
- _, err = op.AddHandler(progress.UpdateOp)
- if err != nil {
- progress.Done("")
- return err
+ if s.SupportsAuthentication() {
+ _, err = op.AddHandler(progress.UpdateOp)
+ if err != nil {
+ progress.Done("")
+ return err
+ }
  }
 
  // Wait for the copy to complete