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 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656
|
// Copyright (c) 2018-2023, Sylabs Inc. All rights reserved.
// This software is licensed under a 3-clause BSD license. Please consult the
// LICENSE.md file distributed with the sources of this project regarding your
// rights to use or distribute this software.
package client
import (
"context"
"encoding/json"
"errors"
"fmt"
"io"
"net/http"
"net/url"
"strings"
jsonresp "github.com/sylabs/json-resp"
"golang.org/x/sync/errgroup"
)
const (
// minimumPartSize is the minimum size of a part in a multipart upload;
// this liberty is taken by defining this value on the client-side to
// prevent a round-trip to the server. The server will return HTTP status
// 400 if the requested multipart upload size is less than 5MiB.
minimumPartSize = 64 * 1024 * 1024
// OptionS3Compliant indicates a 100% S3 compatible object store is being used by backend library server
OptionS3Compliant = "s3compliant"
)
// UploadCallback defines an interface used to perform a call-out to
// set up the source file Reader.
type UploadCallback interface {
// Initializes the callback given a file size and source file Reader
InitUpload(int64, io.Reader)
// (optionally) can return a proxied Reader
GetReader() io.Reader
// TerminateUpload is called if the upload operation is interrupted before completion
Terminate()
// called when the upload operation is complete
Finish()
}
// Default upload callback
type defaultUploadCallback struct {
r io.Reader
}
func (c *defaultUploadCallback) InitUpload(_ int64, r io.Reader) {
c.r = r
}
func (c *defaultUploadCallback) GetReader() io.Reader {
return c.r
}
func (c *defaultUploadCallback) Terminate() {
}
func (c *defaultUploadCallback) Finish() {
}
// calculateChecksums uses a TeeReader to calculate MD5 and SHA256
// checksums concurrently
func calculateChecksums(r io.Reader) (string, string, int64, error) {
pr, pw := io.Pipe()
tr := io.TeeReader(r, pw)
var g errgroup.Group
var md5checksum string
var sha256checksum string
var fileSize int64
// compute MD5 checksum for comparison with S3 checksum
g.Go(func() error {
// The pipe writer must be closed so sha256 computation gets EOF and will
// complete.
defer pw.Close()
var err error
md5checksum, fileSize, err = md5sum(tr)
if err != nil {
return fmt.Errorf("error calculating MD5 checksum: %w", err)
}
return nil
})
// Compute sha256
g.Go(func() error {
var err error
sha256checksum, _, err = sha256sum(pr)
if err != nil {
return fmt.Errorf("error calculating SHA checksum: %w", err)
}
return nil
})
err := g.Wait()
return md5checksum, sha256checksum, fileSize, err
}
// UploadImage will push a specified image from an io.ReadSeeker up to the
// Container Library, The timeout value for this operation is set within
// the context. It is recommended to use a large value (ie. 1800 seconds) to
// prevent timeout when uploading large images.
func (c *Client) UploadImage(ctx context.Context, r io.ReadSeeker, path, arch string, tags []string, description string, callback UploadCallback) (*UploadImageComplete, error) {
if !IsLibraryPushRef(path) {
return nil, fmt.Errorf("%w: malformed image path: %s", errBadRequest, path)
}
entityName, collectionName, containerName, parsedTags := ParseLibraryPath(path)
if len(parsedTags) != 0 {
return nil, fmt.Errorf("%w: malformed image path: %s", errBadRequest, path)
}
// calculate sha256 and md5 checksums
md5Checksum, imageHash, fileSize, err := calculateChecksums(r)
if err != nil {
return nil, fmt.Errorf("error calculating checksums: %w", err)
}
// rollback to top of file
if _, err = r.Seek(0, io.SeekStart); err != nil {
return nil, fmt.Errorf("error seeking to start stream: %w", err)
}
c.Logger.Logf("Image hash computed as %s", imageHash)
if err := c.ociUploadImage(ctx, r, fileSize, strings.TrimPrefix(path, "library://"), arch, tags, description, "sha256."+imageHash, callback); err == nil {
return nil, nil
} else if !errors.Is(err, errOCIDownloadNotSupported) {
// Return OCI upload error or fallback to legacy download
return nil, err
}
c.Logger.Log("Fallback to (legacy) library upload")
// Find or create entity
entity, err := c.getEntity(ctx, entityName)
if err != nil {
if !errors.Is(err, ErrNotFound) {
return nil, err
}
c.Logger.Logf("Entity %s does not exist in library - creating it.", entityName)
entity, err = c.createEntity(ctx, entityName)
if err != nil {
return nil, err
}
}
// Find or create collection
qualifiedCollectionName := fmt.Sprintf("%s/%s", entityName, collectionName)
collection, err := c.getCollection(ctx, qualifiedCollectionName)
if err != nil {
if !errors.Is(err, ErrNotFound) {
return nil, err
}
// create collection
c.Logger.Logf("Collection %s does not exist in library - creating it.", collectionName)
collection, err = c.createCollection(ctx, collectionName, entity.ID)
if err != nil {
return nil, err
}
}
// Find or create container
computedName := fmt.Sprintf("%s/%s", qualifiedCollectionName, containerName)
container, err := c.getContainer(ctx, computedName)
if err != nil {
if !errors.Is(err, ErrNotFound) {
return nil, err
}
// Create container
c.Logger.Logf("Container %s does not exist in library - creating it.", containerName)
container, err = c.createContainer(ctx, containerName, collection.ID)
if err != nil {
return nil, err
}
}
// Find or create image
image, err := c.GetImage(ctx, arch, computedName+":"+"sha256."+imageHash)
if err != nil {
if !errors.Is(err, ErrNotFound) {
return nil, err
}
// Create image
c.Logger.Logf("Image %s does not exist in library - creating it.", imageHash)
image, err = c.createImage(ctx, "sha256."+imageHash, container.ID, description)
if err != nil {
return nil, err
}
}
var res *UploadImageComplete
if !image.Uploaded {
// upload image
if callback == nil {
// use default (noop) upload callback
callback = &defaultUploadCallback{r: r}
}
metadata := map[string]string{
"sha256sum": imageHash,
"md5sum": md5Checksum,
}
res, err = c.postFileWrapper(ctx, r, fileSize, image.ID, callback, metadata)
if err != nil {
return nil, err
}
} else {
c.Logger.Logf("Image is already present in the library - not uploading.")
}
// set tags on image
c.Logger.Logf("Setting tags against uploaded image")
if c.apiAtLeast(ctx, APIVersionV2ArchTags) {
if err := c.setTagsV2(ctx, container.ID, arch, image.ID, append(tags, parsedTags...)); err != nil {
return nil, err
}
return res, nil
}
c.Logger.Logf("This library does not support multiple architectures per tag.")
c.Logger.Logf("This tag will replace any already uploaded with the same name.")
if err := c.setTags(ctx, container.ID, image.ID, append(tags, parsedTags...)); err != nil {
return nil, err
}
return res, nil
}
func (c *Client) postFileWrapper(ctx context.Context, r io.ReadSeeker, fileSize int64, imageID string, callback UploadCallback, metadata map[string]string) (*UploadImageComplete, error) {
var err error
// use callback to set up source file reader
callback.InitUpload(fileSize, r)
var res *UploadImageComplete
c.Logger.Log("Now uploading to the library")
if c.apiAtLeast(ctx, APIVersionV2Upload) {
// use v2 post file api. Send both md5 and sha256 checksums. If the
// remote does not support sha256, it will be ignored and fallback
// to md5. If the remote is aware of sha256, will be used and md5
// will be ignored.
res, err = c.postFileV2(ctx, r, fileSize, imageID, callback, metadata)
} else {
// fallback to legacy upload
res, err = c.postFile(ctx, fileSize, imageID, callback)
}
if err != nil {
callback.Terminate()
c.Logger.Log("Upload terminated due to error")
} else {
callback.Finish()
c.Logger.Log("Upload completed OK")
}
return res, err
}
func (c *Client) postFile(ctx context.Context, fileSize int64, imageID string, callback UploadCallback) (*UploadImageComplete, error) {
postURL := "v1/imagefile/" + imageID
c.Logger.Logf("postFile calling %s", postURL)
// Make an upload request
req, err := c.newRequest(ctx, http.MethodPost, postURL, "", callback.GetReader())
if err != nil {
return nil, err
}
// Content length is required by the API
req.ContentLength = fileSize
res, err := c.HTTPClient.Do(req)
if err != nil {
return nil, fmt.Errorf("error uploading file to server: %w", err)
}
defer res.Body.Close()
if res.StatusCode != http.StatusOK {
if err := jsonresp.ReadError(res.Body); err != nil {
return nil, fmt.Errorf("sending file did not succeed: %w", err)
}
return nil, fmt.Errorf("%w: sending file did not succeed: http status code %d", errHTTP, res.StatusCode)
}
return nil, nil
}
// postFileV2 uses V2 API to upload images to SCS library server. This is
// a three step operation: "create" upload image request, which returns a
// URL to issue an http PUT operation against, and then finally calls the
// completion endpoint once upload is complete.
func (c *Client) postFileV2(ctx context.Context, r io.ReadSeeker, fileSize int64, imageID string, callback UploadCallback, metadata map[string]string) (*UploadImageComplete, error) {
if fileSize > minimumPartSize {
// only attempt multipart upload if size greater than S3 minimum
c.Logger.Log("Attempting to use multipart uploader")
var err error
var res *UploadImageComplete
res, err = c.postFileV2Multipart(ctx, r, fileSize, imageID, callback)
if err != nil {
// if the error is anything other than ErrNotFound, fallback to legacy (single part)
// uploader.
if !errors.Is(err, ErrNotFound) {
return nil, err
}
// fallthrough to legacy (single part) uploader
} else {
// multipart upload successful
return res, nil
}
}
// fallback to legacy uploader
c.Logger.Log("Using legacy (single part) uploader")
return c.legacyPostFileV2(ctx, fileSize, imageID, callback, metadata)
}
// uploadManager contains common params for multipart part function
type uploadManager struct {
Source io.ReadSeeker
Size int64
ImageID string
UploadID string
}
func (c *Client) postFileV2Multipart(ctx context.Context, r io.ReadSeeker, fileSize int64, imageID string, callback UploadCallback) (*UploadImageComplete, error) {
// initiate multipart upload with backend to determine number of expected
// parts and part size
response, err := c.startMultipartUpload(ctx, fileSize, imageID)
if err != nil {
c.Logger.Logf("Error starting multipart upload: %v", err)
return nil, err
}
c.Logger.Logf("Multi-part upload: ID=[%s] totalParts=[%d] partSize=[%d]", response.UploadID, response.TotalParts, fileSize)
// Enable S3 compliance mode by default
val := response.Options[OptionS3Compliant]
s3Compliant := val == "" || val == "true"
c.Logger.Logf("S3 compliant option: %v", s3Compliant)
// maintain list of completed parts which will be passed to the completion function
completedParts := []CompletedPart{}
bytesRemaining := fileSize
for nPart := 1; nPart <= response.TotalParts; nPart++ {
partSize := getPartSize(bytesRemaining, response.PartSize)
c.Logger.Logf("Uploading part %d (%d bytes)", nPart, partSize)
mgr := &uploadManager{
Source: r,
Size: partSize,
ImageID: imageID,
UploadID: response.UploadID,
}
// include "X-Amz-Content-Sha256" header only if object store is 100% S3 compatible
etag, err := c.multipartUploadPart(ctx, nPart, mgr, callback, s3Compliant)
if err != nil {
// error uploading part
c.Logger.Logf("Error uploading part %d: %v", nPart, err)
if err := c.abortMultipartUpload(ctx, mgr); err != nil {
c.Logger.Logf("Error aborting multipart upload: %v", err)
}
return nil, err
}
// append completed part info to list
completedParts = append(completedParts, CompletedPart{PartNumber: nPart, Token: etag})
// decrement upload bytes remaining
bytesRemaining -= partSize
}
c.Logger.Logf("Uploaded %d parts", response.TotalParts)
return c.completeMultipartUpload(ctx, &completedParts, &uploadManager{
ImageID: imageID,
UploadID: response.UploadID,
})
}
// getPartSize returns number of bytes to read for "next" part. This value will
// never exceed the S3 maximum
func getPartSize(bytesRemaining int64, partSize int64) int64 {
if bytesRemaining > int64(partSize) {
return partSize
}
return bytesRemaining
}
func (c *Client) startMultipartUpload(ctx context.Context, fileSize int64, imageID string) (MultipartUpload, error) {
// attempt to initiate multipart upload
postURL := fmt.Sprintf("v2/imagefile/%s/_multipart", imageID)
c.Logger.Logf("startMultipartUpload calling %s", postURL)
body := MultipartUploadStartRequest{
Size: fileSize,
}
objJSON, err := c.apiCreate(ctx, postURL, body)
if err != nil {
return MultipartUpload{}, err
}
var res MultipartUploadStartResponse
if err := json.Unmarshal(objJSON, &res); err != nil {
return MultipartUpload{}, err
}
return res.Data, nil
}
// remoteSHA256ChecksumSupport parses the 'X-Amz-SignedHeaders' from the
// presigned PUT URL query string to determine if 'x-amz-content-sha256' is
// present. If 'x-amz-content-sha256' is present, the remote is expecting the
// SHA256 checksum in the headers of the presigned PUT URL request.
func remoteSHA256ChecksumSupport(u *url.URL) bool {
hdr := u.Query()["X-Amz-SignedHeaders"]
if len(hdr) < 1 {
return false
}
for _, h := range strings.Split(hdr[0], ";") {
if h == "x-amz-content-sha256" {
return true
}
}
return false
}
func (c *Client) legacyPostFileV2(ctx context.Context, fileSize int64, imageID string, callback UploadCallback, metadata map[string]string) (*UploadImageComplete, error) {
postURL := fmt.Sprintf("v2/imagefile/%s", imageID)
c.Logger.Logf("legacyPostFileV2 calling %s", postURL)
// issue upload request (POST) to obtain presigned S3 URL
body := UploadImageRequest{
Size: fileSize,
SHA256Checksum: metadata["sha256sum"],
MD5Checksum: metadata["md5sum"],
}
objJSON, err := c.apiCreate(ctx, postURL, body)
if err != nil {
return nil, err
}
var res UploadImageResponse
if err := json.Unmarshal(objJSON, &res); err != nil {
return nil, err
}
// upload (PUT) directly to S3 presigned URL provided above
presignedURL := res.Data.UploadURL
if presignedURL == "" {
return nil, errGettingPresignedURL
}
parsedURL, err := url.Parse(presignedURL)
if err != nil {
return nil, errParsingPresignedURL
}
// parse presigned URL to determine if we need to send sha256 checksum
useSHA256Checksum := remoteSHA256ChecksumSupport(parsedURL)
req, err := http.NewRequestWithContext(ctx, http.MethodPut, presignedURL, callback.GetReader())
if err != nil {
return nil, fmt.Errorf("error creating request: %w", err)
}
req.ContentLength = fileSize
req.Header.Set("Content-Type", "application/octet-stream")
if useSHA256Checksum {
req.Header.Set("x-amz-content-sha256", metadata["sha256sum"])
}
resp, err := c.HTTPClient.Do(req)
callback.Finish()
if err != nil {
return nil, fmt.Errorf("error uploading image: %w", err)
}
defer resp.Body.Close()
if resp.StatusCode != http.StatusOK {
return nil, fmt.Errorf("%w: error uploading image: HTTP status %d", errHTTP, resp.StatusCode)
}
// send (PUT) image upload completion
objJSON, err = c.apiUpdate(ctx, postURL+"/_complete", UploadImageCompleteRequest{})
if err != nil {
return nil, fmt.Errorf("error sending upload complete request: %w", err)
}
if len(objJSON) == 0 {
// success w/o detailed upload complete response
return nil, nil
}
var uploadResp UploadImageCompleteResponse
if err := json.Unmarshal(objJSON, &uploadResp); err != nil {
return nil, fmt.Errorf("error decoding upload response: %w", err)
}
return &uploadResp.Data, nil
}
func getPartSHA256Sum(r io.Reader, size int64) (string, error) {
// calculate sha256sum of part
tmpChunk := io.LimitReader(r, size)
chunkHash, _, err := sha256sum(tmpChunk)
return chunkHash, err
}
func (c *Client) multipartUploadPart(ctx context.Context, partNumber int, m *uploadManager, callback UploadCallback, includeSHA256ChecksumHeader bool) (string, error) {
var chunkHash string
var err error
if includeSHA256ChecksumHeader {
// calculate sha256sum of part being uploaded
chunkHash, err = getPartSHA256Sum(m.Source, int64(m.Size))
if err != nil {
c.Logger.Logf("Error calculating SHA256 checksum: %v", err)
return "", err
}
// rollback file pointer to beginning of part
if _, err := m.Source.Seek(-(int64(m.Size)), io.SeekCurrent); err != nil {
c.Logger.Logf("Error repositioning file pointer: %v", err)
return "", err
}
}
// send request to cloud-library for presigned PUT url
uri := fmt.Sprintf("v2/imagefile/%s/_multipart", m.ImageID)
c.Logger.Logf("multipartUploadPart calling %s", uri)
objJSON, err := c.apiUpdate(ctx, uri, UploadImagePartRequest{
PartSize: m.Size,
UploadID: m.UploadID,
PartNumber: partNumber,
SHA256Checksum: chunkHash,
})
if err != nil {
return "", err
}
var res UploadImagePartResponse
if err := json.Unmarshal(objJSON, &res); err != nil {
return "", err
}
// send request to S3
req, err := http.NewRequestWithContext(ctx, http.MethodPut, res.Data.PresignedURL, io.LimitReader(callback.GetReader(), m.Size))
if err != nil {
return "", fmt.Errorf("error creating request: %w", err)
}
// add headers to be signed
req.ContentLength = m.Size
if includeSHA256ChecksumHeader {
req.Header.Add("x-amz-content-sha256", chunkHash)
}
resp, err := c.HTTPClient.Do(req)
if err != nil {
c.Logger.Logf("Failure uploading to presigned URL: %w", err)
return "", err
}
defer resp.Body.Close()
// process response from S3
if resp.StatusCode != http.StatusOK {
c.Logger.Logf("Object store returned an error: %d", resp.StatusCode)
return "", fmt.Errorf("%w: object store returned an error: %d", errHTTP, resp.StatusCode)
}
etag := resp.Header.Get("ETag")
c.Logger.Logf("Part %d accepted (ETag: %s)", partNumber, etag)
return etag, nil
}
func (c *Client) completeMultipartUpload(ctx context.Context, completedParts *[]CompletedPart, m *uploadManager) (*UploadImageComplete, error) {
c.Logger.Logf("Completing multipart upload: %s", m.UploadID)
uri := fmt.Sprintf("v2/imagefile/%s/_multipart_complete", m.ImageID)
c.Logger.Logf("completeMultipartUpload calling %s", uri)
body := CompleteMultipartUploadRequest{
UploadID: m.UploadID,
CompletedParts: *completedParts,
}
objJSON, err := c.apiUpdate(ctx, uri, body)
if err != nil {
c.Logger.Logf("Error completing multipart upload: %v", err)
return nil, err
}
var res CompleteMultipartUploadResponse
if err := json.Unmarshal(objJSON, &res); err != nil {
c.Logger.Logf("Error decoding complete multipart upload request: %v", err)
return nil, err
}
if res.Data.ContainerURL == "" {
// success w/o detailed upload complete response
return nil, nil
}
return &res.Data, nil
}
func (c *Client) abortMultipartUpload(ctx context.Context, m *uploadManager) error {
c.Logger.Logf("Aborting multipart upload ID: %s", m.UploadID)
uri := fmt.Sprintf("v2/imagefile/%s/_multipart_abort", m.ImageID)
c.Logger.Logf("abortMultipartUpload calling %s", uri)
body := AbortMultipartUploadRequest{
UploadID: m.UploadID,
}
if _, err := c.apiUpdate(ctx, uri, body); err != nil {
c.Logger.Logf("error aborting multipart upload: %v", err)
return err
}
return nil
}
|