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 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609
|
package main
import (
"bytes"
"errors"
"fmt"
"io"
"io/fs"
"net/http"
"net/url"
"os"
"path/filepath"
"slices"
"strings"
"time"
"github.com/gorilla/mux"
"github.com/pkg/sftp"
internalInstance "github.com/lxc/incus/v6/internal/instance"
"github.com/lxc/incus/v6/internal/server/instance"
"github.com/lxc/incus/v6/internal/server/lifecycle"
"github.com/lxc/incus/v6/internal/server/request"
"github.com/lxc/incus/v6/internal/server/response"
"github.com/lxc/incus/v6/internal/server/state"
"github.com/lxc/incus/v6/shared/api"
"github.com/lxc/incus/v6/shared/logger"
"github.com/lxc/incus/v6/shared/revert"
)
func instanceFileHandler(d *Daemon, r *http.Request) response.Response {
s := d.State()
projectName := request.ProjectParam(r)
name, err := url.PathUnescape(mux.Vars(r)["name"])
if err != nil {
return response.SmartError(err)
}
if internalInstance.IsSnapshot(name) {
return response.BadRequest(errors.New("Invalid instance name"))
}
// Redirect to correct server if needed.
resp, err := forwardedResponseIfInstanceIsRemote(s, r, projectName, name)
if err != nil {
return response.SmartError(err)
}
if resp != nil {
return resp
}
// Load the instance.
inst, err := instance.LoadByProjectAndName(s, projectName, name)
if err != nil {
return response.SmartError(err)
}
// Parse and cleanup the path.
path := r.FormValue("path")
if path == "" {
return response.BadRequest(errors.New("Missing path argument"))
}
if !strings.HasPrefix(path, "/") {
path = "/" + path
}
switch r.Method {
case "GET":
return instanceFileGet(s, inst, path, r)
case "HEAD":
return instanceFileHead(s, inst, path, r)
case "POST":
return instanceFilePost(s, inst, path, r)
case "DELETE":
return instanceFileDelete(s, inst, path, r)
default:
return response.NotFound(fmt.Errorf("Method %q not found", r.Method))
}
}
// swagger:operation GET /1.0/instances/{name}/files instances instance_files_get
//
// Get a file
//
// Gets the file content. If it's a directory, a json list of files will be returned instead.
//
// ---
// produces:
// - application/json
// - application/octet-stream
// parameters:
// - in: query
// name: path
// description: Path to the file
// type: string
// example: default
// - in: query
// name: project
// description: Project name
// type: string
// example: default
// responses:
// "200":
// description: Raw file or directory listing
// headers:
// X-Incus-uid:
// description: File owner UID
// schema:
// type: integer
// X-Incus-gid:
// description: File owner GID
// schema:
// type: integer
// X-Incus-mode:
// description: Mode mask
// schema:
// type: integer
// X-Incus-modified:
// description: Last modified date
// schema:
// type: string
// X-Incus-type:
// description: Type of file (file, symlink or directory)
// schema:
// type: string
// content:
// application/octet-stream:
// schema:
// type: string
// example: some-text
// application/json:
// schema:
// type: array
// items:
// type: string
// example: |-
// [
// "/etc",
// "/home"
// ]
// "400":
// $ref: "#/responses/BadRequest"
// "403":
// $ref: "#/responses/Forbidden"
// "404":
// $ref: "#/responses/NotFound"
// "500":
// $ref: "#/responses/InternalServerError"
func instanceFileGet(s *state.State, inst instance.Instance, path string, r *http.Request) response.Response {
reverter := revert.New()
defer reverter.Fail()
// Get a SFTP client.
client, err := inst.FileSFTP()
if err != nil {
return response.InternalError(err)
}
reverter.Add(func() { _ = client.Close() })
// Get the file stats.
stat, err := client.Lstat(path)
if err != nil {
return response.SmartError(err)
}
fileType := "file"
if stat.Mode().IsDir() {
fileType = "directory"
} else if stat.Mode()&os.ModeSymlink == os.ModeSymlink {
fileType = "symlink"
}
fs := stat.Sys().(*sftp.FileStat)
// Prepare the response.
headers := map[string]string{
"X-Incus-uid": fmt.Sprintf("%d", fs.UID),
"X-Incus-gid": fmt.Sprintf("%d", fs.GID),
"X-Incus-mode": fmt.Sprintf("%04o", stat.Mode().Perm()),
"X-Incus-modified": stat.ModTime().UTC().String(),
"X-Incus-type": fileType,
}
if fileType == "file" {
// Open the file.
file, err := client.Open(path)
if err != nil {
return response.SmartError(err)
}
reverter.Add(func() { _ = file.Close() })
// Setup cleanup logic.
cleanup := reverter.Clone()
reverter.Success()
// Make a file response struct.
files := make([]response.FileResponseEntry, 1)
files[0].Identifier = filepath.Base(path)
files[0].Filename = filepath.Base(path)
files[0].File = file
files[0].FileSize = stat.Size()
files[0].FileModified = stat.ModTime()
files[0].Cleanup = func() {
cleanup.Fail()
}
s.Events.SendLifecycle(inst.Project().Name, lifecycle.InstanceFileRetrieved.Event(inst, logger.Ctx{"path": path}))
return response.FileResponse(r, files, headers)
} else if fileType == "symlink" {
// Find symlink target.
target, err := client.ReadLink(path)
if err != nil {
return response.SmartError(err)
}
// If not an absolute symlink, need to mangle to something
// relative to the source path. This is required because there
// is no sftp function to get the final target path and RealPath doesn't
// allow specifying the path to resolve from.
if !strings.HasPrefix(target, "/") {
target = filepath.Join(filepath.Dir(path), target)
}
// Convert to absolute path.
target, err = client.RealPath(target)
if err != nil {
return response.SmartError(err)
}
// Make a file response struct.
files := make([]response.FileResponseEntry, 1)
files[0].Identifier = filepath.Base(path)
files[0].Filename = filepath.Base(path)
files[0].File = bytes.NewReader([]byte(target))
files[0].FileModified = time.Now()
files[0].FileSize = int64(len(target))
s.Events.SendLifecycle(inst.Project().Name, lifecycle.InstanceFileRetrieved.Event(inst, logger.Ctx{"path": path}))
return response.FileResponse(r, files, headers)
} else if fileType == "directory" {
dirEnts := []string{}
// List the directory.
entries, err := client.ReadDir(path)
if err != nil {
return response.SmartError(err)
}
for _, entry := range entries {
dirEnts = append(dirEnts, entry.Name())
}
s.Events.SendLifecycle(inst.Project().Name, lifecycle.InstanceFileRetrieved.Event(inst, logger.Ctx{"path": path}))
return response.SyncResponseHeaders(true, dirEnts, headers)
} else {
return response.InternalError(fmt.Errorf("Bad file type: %s", fileType))
}
}
// swagger:operation HEAD /1.0/instances/{name}/files instances instance_files_head
//
// Get metadata for a file
//
// Gets the file or directory metadata.
//
// ---
// parameters:
// - in: query
// name: path
// description: Path to the file
// type: string
// example: default
// - in: query
// name: project
// description: Project name
// type: string
// example: default
// responses:
// "200":
// description: Raw file or directory listing
// headers:
// X-Incus-uid:
// description: File owner UID
// schema:
// type: integer
// X-Incus-gid:
// description: File owner GID
// schema:
// type: integer
// X-Incus-mode:
// description: Mode mask
// schema:
// type: integer
// X-Incus-modified:
// description: Last modified date
// schema:
// type: string
// X-Incus-type:
// description: Type of file (file, symlink or directory)
// schema:
// type: string
// "400":
// $ref: "#/responses/BadRequest"
// "403":
// $ref: "#/responses/Forbidden"
// "404":
// $ref: "#/responses/NotFound"
// "500":
// $ref: "#/responses/InternalServerError"
func instanceFileHead(_ *state.State, inst instance.Instance, path string, _ *http.Request) response.Response {
reverter := revert.New()
defer reverter.Fail()
// Get a SFTP client.
client, err := inst.FileSFTP()
if err != nil {
return response.InternalError(err)
}
reverter.Add(func() { _ = client.Close() })
// Get the file stats.
stat, err := client.Lstat(path)
if err != nil {
return response.SmartError(err)
}
fileType := "file"
if stat.Mode().IsDir() {
fileType = "directory"
} else if stat.Mode()&os.ModeSymlink == os.ModeSymlink {
fileType = "symlink"
}
fs := stat.Sys().(*sftp.FileStat)
// Prepare the response.
headers := map[string]string{
"X-Incus-uid": fmt.Sprintf("%d", fs.UID),
"X-Incus-gid": fmt.Sprintf("%d", fs.GID),
"X-Incus-mode": fmt.Sprintf("%04o", stat.Mode().Perm()),
"X-Incus-modified": stat.ModTime().UTC().String(),
"X-Incus-type": fileType,
}
if fileType == "file" {
headers["Content-Type"] = "application/octet-stream"
headers["Content-Length"] = fmt.Sprintf("%d", stat.Size())
}
// Return an empty body (per RFC for HEAD).
return response.ManualResponse(func(w http.ResponseWriter) error {
// Set the headers.
for k, v := range headers {
w.Header().Set(k, v)
}
// Flush the connection.
w.WriteHeader(http.StatusOK)
return nil
})
}
// swagger:operation POST /1.0/instances/{name}/files instances instance_files_post
//
// Create or replace a file
//
// Creates a new file in the instance.
//
// ---
// consumes:
// - application/octet-stream
// produces:
// - application/json
// parameters:
// - in: query
// name: path
// description: Path to the file
// type: string
// example: default
// - in: query
// name: project
// description: Project name
// type: string
// example: default
// - in: body
// name: raw_file
// description: Raw file content
// - in: header
// name: X-Incus-uid
// description: File owner UID
// schema:
// type: integer
// example: 1000
// - in: header
// name: X-Incus-gid
// description: File owner GID
// schema:
// type: integer
// example: 1000
// - in: header
// name: X-Incus-mode
// description: File mode
// schema:
// type: integer
// example: 0644
// - in: header
// name: X-Incus-type
// description: Type of file (file, symlink or directory)
// schema:
// type: string
// example: file
// - in: header
// name: X-Incus-write
// description: Write mode (overwrite or append)
// schema:
// type: string
// example: overwrite
// responses:
// "200":
// $ref: "#/responses/EmptySyncResponse"
// "400":
// $ref: "#/responses/BadRequest"
// "403":
// $ref: "#/responses/Forbidden"
// "404":
// $ref: "#/responses/NotFound"
// "500":
// $ref: "#/responses/InternalServerError"
func instanceFilePost(s *state.State, inst instance.Instance, path string, r *http.Request) response.Response {
// Get a SFTP client.
client, err := inst.FileSFTP()
if err != nil {
return response.InternalError(err)
}
defer func() { _ = client.Close() }()
// Extract file ownership and mode from headers
uid, gid, mode, type_, write := api.ParseFileHeaders(r.Header)
if !slices.Contains([]string{"overwrite", "append"}, write) {
return response.BadRequest(fmt.Errorf("Bad file write mode: %s", write))
}
// Check if the file already exists.
_, err = client.Stat(path)
exists := err == nil
if type_ == "file" {
fileMode := os.O_RDWR
if write == "overwrite" {
fileMode |= os.O_CREATE | os.O_TRUNC
}
// Open/create the file.
file, err := client.OpenFile(path, fileMode)
if err != nil {
return response.SmartError(err)
}
defer func() { _ = file.Close() }()
// Go to the end of the file.
_, err = file.Seek(0, io.SeekEnd)
if err != nil {
return response.InternalError(err)
}
// Transfer the file into the instance.
_, err = io.Copy(file, r.Body)
if err != nil {
return response.InternalError(err)
}
if !exists {
// Set file permissions.
if mode >= 0 {
err = file.Chmod(fs.FileMode(mode))
if err != nil {
return response.SmartError(err)
}
}
// Set file ownership.
if uid >= 0 || gid >= 0 {
err = file.Chown(int(uid), int(gid))
if err != nil {
return response.SmartError(err)
}
}
}
s.Events.SendLifecycle(inst.Project().Name, lifecycle.InstanceFilePushed.Event(inst, logger.Ctx{"path": path}))
return response.EmptySyncResponse
} else if type_ == "symlink" {
// Figure out target.
target, err := io.ReadAll(r.Body)
if err != nil {
return response.InternalError(err)
}
// Check if already setup.
currentTarget, err := client.ReadLink(path)
if err == nil && currentTarget == string(target) {
return response.EmptySyncResponse
}
// Create the symlink.
err = client.Symlink(string(target), path)
if err != nil {
return response.SmartError(err)
}
s.Events.SendLifecycle(inst.Project().Name, lifecycle.InstanceFilePushed.Event(inst, logger.Ctx{"path": path}))
return response.EmptySyncResponse
} else if type_ == "directory" {
// Check if it already exists.
if exists {
return response.EmptySyncResponse
}
// Create the directory.
err = client.Mkdir(path)
if err != nil {
return response.SmartError(err)
}
// Set file permissions.
if mode < 0 {
// Default mode for directories (sftp doesn't know about umask).
mode = 0o755
}
err = client.Chmod(path, fs.FileMode(mode))
if err != nil {
return response.SmartError(err)
}
// Set file ownership.
if uid >= 0 || gid >= 0 {
err = client.Chown(path, int(uid), int(gid))
if err != nil {
return response.SmartError(err)
}
}
s.Events.SendLifecycle(inst.Project().Name, lifecycle.InstanceFilePushed.Event(inst, logger.Ctx{"path": path}))
return response.EmptySyncResponse
} else {
return response.BadRequest(fmt.Errorf("Bad file type: %s", type_))
}
}
// swagger:operation DELETE /1.0/instances/{name}/files instances instance_files_delete
//
// Delete a file
//
// Removes the file.
//
// ---
// produces:
// - application/json
// parameters:
// - in: query
// name: path
// description: Path to the file
// type: string
// example: default
// - in: query
// name: project
// description: Project name
// type: string
// example: default
// responses:
// "200":
// $ref: "#/responses/EmptySyncResponse"
// "400":
// $ref: "#/responses/BadRequest"
// "403":
// $ref: "#/responses/Forbidden"
// "404":
// $ref: "#/responses/NotFound"
// "500":
// $ref: "#/responses/InternalServerError"
func instanceFileDelete(s *state.State, inst instance.Instance, path string, _ *http.Request) response.Response {
// Get a SFTP client.
client, err := inst.FileSFTP()
if err != nil {
return response.InternalError(err)
}
defer func() { _ = client.Close() }()
// Delete the file.
err = client.Remove(path)
if err != nil {
return response.SmartError(err)
}
s.Events.SendLifecycle(inst.Project().Name, lifecycle.InstanceFileDeleted.Event(inst, logger.Ctx{"path": path}))
return response.EmptySyncResponse
}
|