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 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590
|
package incus
import (
"bytes"
"context"
"encoding/json"
"errors"
"fmt"
"io"
"net/http"
neturl "net/url"
"slices"
"strings"
"sync"
"time"
"github.com/gorilla/websocket"
"github.com/lxc/incus/v6/shared/api"
"github.com/lxc/incus/v6/shared/logger"
"github.com/lxc/incus/v6/shared/tcp"
)
// ProtocolIncus represents an Incus API server.
type ProtocolIncus struct {
ctx context.Context
server *api.Server
ctxConnected context.Context
ctxConnectedCancel context.CancelFunc
// eventConns contains event listener connections associated to a project name (or empty for all projects).
eventConns map[string]*websocket.Conn
// eventConnsLock controls write access to the eventConns.
eventConnsLock sync.Mutex
// eventListeners is a slice of event listeners associated to a project name (or empty for all projects).
eventListeners map[string][]*EventListener
eventListenersLock sync.Mutex
// skipEvents tracks whether we were configured not to connect to the events endpoint
skipEvents bool
http *http.Client
httpCertificate string
httpBaseURL neturl.URL
httpUnixPath string
httpProtocol string
httpUserAgent string
requireAuthenticated bool
clusterTarget string
project string
oidcClient *oidcClient
tempPath string
}
// Disconnect gets rid of any background goroutines.
func (r *ProtocolIncus) Disconnect() {
if r.ctxConnected.Err() != nil {
r.ctxConnectedCancel()
}
}
// GetConnectionInfo returns the basic connection information used to interact with the server.
func (r *ProtocolIncus) GetConnectionInfo() (*ConnectionInfo, error) {
info := ConnectionInfo{}
info.Certificate = r.httpCertificate
info.Protocol = "incus"
info.URL = r.httpBaseURL.String()
info.SocketPath = r.httpUnixPath
info.Project = r.project
if info.Project == "" {
info.Project = api.ProjectDefaultName
}
info.Target = r.clusterTarget
if info.Target == "" && r.server != nil {
info.Target = r.server.Environment.ServerName
}
urls := []string{}
if r.httpProtocol == "https" {
urls = append(urls, r.httpBaseURL.String())
}
if r.server != nil && len(r.server.Environment.Addresses) > 0 {
for _, addr := range r.server.Environment.Addresses {
if strings.HasPrefix(addr, ":") {
continue
}
url := fmt.Sprintf("https://%s", addr)
if !slices.Contains(urls, url) {
urls = append(urls, url)
}
}
}
info.Addresses = urls
return &info, nil
}
// isSameServer compares the calling ProtocolIncus object with the provided server object to check if they are the same server.
// It verifies the equality based on their connection information (Protocol, Certificate, Project, and Target).
func (r *ProtocolIncus) isSameServer(server Server) bool {
// Short path checking if the two structs are identical.
if r == server {
return true
}
// Short path if either of the structs are nil.
if r == nil || server == nil {
return false
}
// When dealing with uninitialized servers, we can't safely compare.
if r.server == nil {
return false
}
// Get the connection info from both servers.
srcInfo, err := r.GetConnectionInfo()
if err != nil {
return false
}
dstInfo, err := server.GetConnectionInfo()
if err != nil {
return false
}
// Check whether we're dealing with the same server.
return srcInfo.Protocol == dstInfo.Protocol && srcInfo.Certificate == dstInfo.Certificate &&
srcInfo.Project == dstInfo.Project && srcInfo.Target == dstInfo.Target
}
// GetHTTPClient returns the http client used for the connection. This can be used to set custom http options.
func (r *ProtocolIncus) GetHTTPClient() (*http.Client, error) {
if r.http == nil {
return nil, errors.New("HTTP client isn't set, bad connection")
}
return r.http, nil
}
// DoHTTP performs a Request, using OIDC authentication if set.
func (r *ProtocolIncus) DoHTTP(req *http.Request) (*http.Response, error) {
r.addClientHeaders(req)
if r.oidcClient != nil {
return r.oidcClient.do(req)
}
resp, err := r.http.Do(req)
if resp != nil && resp.StatusCode == http.StatusUseProxy && req.GetBody != nil {
// Reset the request body.
body, err := req.GetBody()
if err != nil {
return nil, err
}
req.Body = body
// Retry the request.
return r.http.Do(req)
}
return resp, err
}
// DoWebsocket performs a websocket connection, using OIDC authentication if set.
func (r *ProtocolIncus) DoWebsocket(dialer websocket.Dialer, uri string, req *http.Request) (*websocket.Conn, *http.Response, error) {
r.addClientHeaders(req)
if r.oidcClient != nil {
return r.oidcClient.dial(dialer, uri, req)
}
return dialer.Dial(uri, req.Header)
}
// addClientHeaders sets headers from client settings.
// User-Agent (if r.httpUserAgent is set).
// X-Incus-authenticated (if r.requireAuthenticated is set).
// OIDC Authorization header (if r.oidcClient is set).
func (r *ProtocolIncus) addClientHeaders(req *http.Request) {
if r.httpUserAgent != "" {
req.Header.Set("User-Agent", r.httpUserAgent)
}
if r.requireAuthenticated {
req.Header.Set("X-Incus-authenticated", "true")
}
if r.oidcClient != nil {
req.Header.Set("Authorization", fmt.Sprintf("Bearer %s", r.oidcClient.getAccessToken()))
}
}
// RequireAuthenticated sets whether we expect to be authenticated with the server.
func (r *ProtocolIncus) RequireAuthenticated(authenticated bool) {
r.requireAuthenticated = authenticated
}
// RawQuery allows directly querying the Incus API
//
// This should only be used by internal Incus tools.
func (r *ProtocolIncus) RawQuery(method string, path string, data any, ETag string) (*api.Response, string, error) {
// Generate the URL
url := fmt.Sprintf("%s%s", r.httpBaseURL.String(), path)
return r.rawQuery(method, url, data, ETag)
}
// RawWebsocket allows directly connection to Incus API websockets
//
// This should only be used by internal Incus tools.
func (r *ProtocolIncus) RawWebsocket(path string) (*websocket.Conn, error) {
return r.websocket(path)
}
// RawOperation allows direct querying of an Incus API endpoint returning
// background operations.
func (r *ProtocolIncus) RawOperation(method string, path string, data any, ETag string) (Operation, string, error) {
return r.queryOperation(method, path, data, ETag)
}
// Internal functions.
func incusParseResponse(resp *http.Response) (*api.Response, string, error) {
// Get the ETag
etag := resp.Header.Get("ETag")
// Decode the response
decoder := json.NewDecoder(resp.Body)
response := api.Response{}
err := decoder.Decode(&response)
if err != nil {
// Check the return value for a cleaner error
if resp.StatusCode != http.StatusOK {
return nil, "", fmt.Errorf("Failed to fetch %s: %s", resp.Request.URL.String(), resp.Status)
}
return nil, "", err
}
// Handle errors
if response.Type == api.ErrorResponse {
return &response, "", api.StatusErrorf(resp.StatusCode, "%v", response.Error)
}
return &response, etag, nil
}
// rawQuery is a method that sends an HTTP request to the Incus server with the provided method, URL, data, and ETag.
// It processes the request based on the data's type and handles the HTTP response, returning parsed results or an error if it occurs.
func (r *ProtocolIncus) rawQuery(method string, url string, data any, ETag string) (*api.Response, string, error) {
var req *http.Request
var err error
// Log the request
logger.Debug("Sending request to Incus", logger.Ctx{
"method": method,
"url": url,
"etag": ETag,
})
// Get a new HTTP request setup
if data != nil {
switch data := data.(type) {
case io.Reader:
// Some data to be sent along with the request
req, err = http.NewRequestWithContext(r.ctx, method, url, io.NopCloser(data))
if err != nil {
return nil, "", err
}
req.GetBody = func() (io.ReadCloser, error) { return io.NopCloser(data), nil }
// Set the encoding accordingly
req.Header.Set("Content-Type", "application/octet-stream")
default:
// Encode the provided data
buf := bytes.Buffer{}
err := json.NewEncoder(&buf).Encode(data)
if err != nil {
return nil, "", err
}
// Some data to be sent along with the request
// Use a reader since the request body needs to be seekable
req, err = http.NewRequestWithContext(r.ctx, method, url, bytes.NewReader(buf.Bytes()))
if err != nil {
return nil, "", err
}
req.GetBody = func() (io.ReadCloser, error) { return io.NopCloser(bytes.NewReader(buf.Bytes())), nil }
// Set the encoding accordingly
req.Header.Set("Content-Type", "application/json")
// Log the data
logger.Debugf("%s", logger.Pretty(data))
}
} else {
// No data to be sent along with the request
req, err = http.NewRequestWithContext(r.ctx, method, url, nil)
if err != nil {
return nil, "", err
}
}
// Set the ETag
if ETag != "" {
req.Header.Set("If-Match", ETag)
}
// Send the request
resp, err := r.DoHTTP(req)
if err != nil {
return nil, "", err
}
defer func() { _ = resp.Body.Close() }()
return incusParseResponse(resp)
}
// setURLQueryAttributes modifies the supplied URL's query string with the client's current target and project.
func (r *ProtocolIncus) setURLQueryAttributes(apiURL *neturl.URL) {
// Extract query fields and update for cluster targeting or project
values := apiURL.Query()
if r.clusterTarget != "" {
if values.Get("target") == "" {
values.Set("target", r.clusterTarget)
}
}
if r.project != "" {
if values.Get("project") == "" && values.Get("all-projects") == "" {
values.Set("project", r.project)
}
}
apiURL.RawQuery = values.Encode()
}
func (r *ProtocolIncus) setQueryAttributes(uri string) (string, error) {
// Parse the full URI
fields, err := neturl.Parse(uri)
if err != nil {
return "", err
}
r.setURLQueryAttributes(fields)
return fields.String(), nil
}
func (r *ProtocolIncus) query(method string, path string, data any, ETag string) (*api.Response, string, error) {
// Generate the URL
url := fmt.Sprintf("%s/1.0%s", r.httpBaseURL.String(), path)
// Add project/target
url, err := r.setQueryAttributes(url)
if err != nil {
return nil, "", err
}
// Run the actual query
return r.rawQuery(method, url, data, ETag)
}
// queryStruct sends a query to the Incus server, then converts the response metadata into the specified target struct.
// The function logs the retrieved data, returns the etag of the response, and handles any errors during this process.
func (r *ProtocolIncus) queryStruct(method string, path string, data any, ETag string, target any) (string, error) {
resp, etag, err := r.query(method, path, data, ETag)
if err != nil {
return "", err
}
err = resp.MetadataAsStruct(&target)
if err != nil {
return "", err
}
// Log the data
logger.Debugf("Got response struct from Incus")
logger.Debugf("%s", logger.Pretty(target))
return etag, nil
}
// queryOperation sends a query to the Incus server and then converts the response metadata into an Operation object.
// It sets up an early event listener, performs the query, processes the response, and manages the lifecycle of the event listener.
func (r *ProtocolIncus) queryOperation(method string, path string, data any, ETag string) (Operation, string, error) {
// Attempt to setup an early event listener
var listener *EventListener
skipListener := r.skipEvents
if !skipListener {
var err error
listener, err = r.GetEvents()
if err != nil {
if api.StatusErrorCheck(err, http.StatusForbidden) {
skipListener = true
}
listener = nil
}
}
// Send the query
resp, etag, err := r.query(method, path, data, ETag)
if err != nil {
if listener != nil {
listener.Disconnect()
}
return nil, "", err
}
// Get to the operation
respOperation, err := resp.MetadataAsOperation()
if err != nil {
if listener != nil {
listener.Disconnect()
}
return nil, "", err
}
// Setup an Operation wrapper
op := operation{
Operation: *respOperation,
r: r,
listener: listener,
skipListener: skipListener,
chActive: make(chan bool),
}
// Log the data
logger.Debugf("Got operation from Incus")
logger.Debugf("%s", logger.Pretty(op.Operation))
return &op, etag, nil
}
// rawWebsocket creates a websocket connection to the provided URL using the underlying HTTP transport of the ProtocolIncus receiver.
// It sets up the request headers, manages the connection handshake, sets TCP timeouts, and handles any errors that may occur during these operations.
func (r *ProtocolIncus) rawWebsocket(url string) (*websocket.Conn, error) {
// Grab the http transport handler
httpTransport, err := r.getUnderlyingHTTPTransport()
if err != nil {
return nil, err
}
// Setup a new websocket dialer based on it
dialer := websocket.Dialer{
NetDialTLSContext: httpTransport.DialTLSContext,
NetDialContext: httpTransport.DialContext,
TLSClientConfig: httpTransport.TLSClientConfig,
Proxy: httpTransport.Proxy,
HandshakeTimeout: time.Second * 5,
}
// Create temporary http.Request using the http url, not the ws one, so that we can add the client headers
// for the websocket request.
req := &http.Request{URL: &r.httpBaseURL, Header: http.Header{}}
// Establish the connection
conn, resp, err := r.DoWebsocket(dialer, url, req)
if err != nil {
if resp != nil {
apiResp, _, parseErr := incusParseResponse(resp)
if parseErr != nil {
err = errors.Join(err, parseErr)
}
if apiResp != nil && apiResp.Error != "" {
err = errors.Join(err, errors.New(apiResp.Error))
}
}
return nil, err
}
// Set TCP timeout options.
remoteTCP, _ := tcp.ExtractConn(conn.UnderlyingConn())
if remoteTCP != nil {
err = tcp.SetTimeouts(remoteTCP, 0)
if err != nil {
logger.Warn("Failed setting TCP timeouts on remote connection", logger.Ctx{"err": err})
}
}
// Log the data
logger.Debugf("Connected to the websocket: %v", url)
return conn, nil
}
// websocket generates a websocket URL based on the provided path and the base URL of the ProtocolIncus receiver.
// It then leverages the rawWebsocket method to establish and return a websocket connection to the generated URL.
func (r *ProtocolIncus) websocket(path string) (*websocket.Conn, error) {
// Generate the URL
var url string
if r.httpBaseURL.Scheme == "https" {
url = fmt.Sprintf("wss://%s/1.0%s", r.httpBaseURL.Host, path)
} else {
url = fmt.Sprintf("ws://%s/1.0%s", r.httpBaseURL.Host, path)
}
return r.rawWebsocket(url)
}
// WithContext returns a client that will add context.Context.
func (r *ProtocolIncus) WithContext(ctx context.Context) InstanceServer {
rr := r
rr.ctx = ctx
return rr
}
// getUnderlyingHTTPTransport returns the *http.Transport used by the http client. If the http
// client was initialized with a HTTPTransporter, it returns the wrapped *http.Transport.
func (r *ProtocolIncus) getUnderlyingHTTPTransport() (*http.Transport, error) {
switch t := r.http.Transport.(type) {
case *http.Transport:
return t, nil
case HTTPTransporter:
return t.Transport(), nil
default:
return nil, fmt.Errorf("Unexpected http.Transport type, %T", r)
}
}
// getSourceImageConnectionInfo returns the connection information for the source image.
// The returned `info` is nil if the source image is local. In this process, the `instSrc`
// is also updated with the minimal source fields.
func (r *ProtocolIncus) getSourceImageConnectionInfo(source ImageServer, image api.Image, instSrc *api.InstanceSource) (info *ConnectionInfo, err error) {
// Set the minimal source fields
instSrc.Type = "image"
// Optimization for the local image case
if r.isSameServer(source) {
// Always use fingerprints for local case
instSrc.Fingerprint = image.Fingerprint
instSrc.Alias = ""
return nil, nil
}
// Minimal source fields for remote image
instSrc.Mode = "pull"
// If we have an alias and the image is public, use that
if instSrc.Alias != "" && image.Public {
instSrc.Fingerprint = ""
} else {
instSrc.Fingerprint = image.Fingerprint
instSrc.Alias = ""
}
// Get source server connection information
info, err = source.GetConnectionInfo()
if err != nil {
return nil, err
}
instSrc.Protocol = info.Protocol
instSrc.Certificate = info.Certificate
// Generate secret token if needed
if !image.Public {
secret, err := source.GetImageSecret(image.Fingerprint)
if err != nil {
return nil, err
}
instSrc.Secret = secret
}
return info, nil
}
|