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
|
package simplestreams
import (
"encoding/json"
"fmt"
"io"
"net/http"
"net/url"
"os"
"path/filepath"
"sort"
"strconv"
"strings"
"time"
"github.com/lxc/incus/v6/shared/api"
"github.com/lxc/incus/v6/shared/osarch"
"github.com/lxc/incus/v6/shared/util"
)
// DownloadableFile represents a file with its URL, hash and size.
type DownloadableFile struct {
Path string
Sha256 string
Size int64
}
// NewClient returns a simplestreams client for the provided stream URL.
func NewClient(url string, httpClient http.Client, useragent string) *SimpleStreams {
return &SimpleStreams{
http: &httpClient,
url: url,
cachedProducts: map[string]*Products{},
useragent: useragent,
}
}
// NewLocalClient returns a simplestreams client for a local filesystem path.
func NewLocalClient(path string) *SimpleStreams {
return &SimpleStreams{
url: path,
cachedProducts: map[string]*Products{},
}
}
// SimpleStreams represents a simplestream client.
type SimpleStreams struct {
http *http.Client
url string
useragent string
cachedStream *Stream
cachedProducts map[string]*Products
cachedImages []api.Image
cachedAliases []extendedAlias
cachePath string
cacheExpiry time.Duration
}
// SetCache configures the on-disk cache.
func (s *SimpleStreams) SetCache(path string, expiry time.Duration) {
s.cachePath = path
s.cacheExpiry = expiry
}
func (s *SimpleStreams) readCache(path string) ([]byte, bool) {
cacheName := filepath.Join(s.cachePath, path)
if s.cachePath == "" {
return nil, false
}
if !util.PathExists(cacheName) {
return nil, false
}
fi, err := os.Stat(cacheName)
if err != nil {
_ = os.Remove(cacheName)
return nil, false
}
body, err := os.ReadFile(cacheName)
if err != nil {
_ = os.Remove(cacheName)
return nil, false
}
expired := time.Since(fi.ModTime()) > s.cacheExpiry
return body, expired
}
// InvalidateCache removes the on-disk cache for the SimpleStreams remote.
func (s *SimpleStreams) InvalidateCache() {
_ = os.RemoveAll(s.cachePath)
}
func (s *SimpleStreams) cachedDownload(path string) ([]byte, error) {
fields := strings.Split(path, "/")
fileName := fields[len(fields)-1]
// Handle local filesystem reads (bypass cache).
if s.http == nil {
body, err := os.ReadFile(path)
if err != nil {
return nil, err
}
if len(body) == 0 {
return nil, fmt.Errorf("Empty index file %q", path)
}
return body, nil
}
// Attempt to get from the cache.
cachedBody, expired := s.readCache(fileName)
if cachedBody != nil && !expired {
return cachedBody, nil
}
// Download from the remote URL.
uri, err := url.JoinPath(s.url, path)
if err != nil {
return nil, err
}
req, err := http.NewRequest("GET", uri, nil)
if err != nil {
return nil, err
}
if s.useragent != "" {
req.Header.Set("User-Agent", s.useragent)
}
r, err := s.http.Do(req)
if err != nil {
// On local connectivity error, return from cache anyway
if cachedBody != nil {
return cachedBody, nil
}
return nil, err
}
defer func() { _ = r.Body.Close() }()
if r.StatusCode != http.StatusOK {
// On local connectivity error, return from cache anyway
if cachedBody != nil {
return cachedBody, nil
}
return nil, fmt.Errorf("Unable to fetch %s: %s", uri, r.Status)
}
body, err := io.ReadAll(r.Body)
if err != nil {
return nil, err
}
if len(body) == 0 {
return nil, fmt.Errorf("No content in download from %q", uri)
}
// Attempt to store in cache
if s.cachePath != "" {
cacheName := filepath.Join(s.cachePath, fileName)
_ = os.Remove(cacheName)
_ = os.WriteFile(cacheName, body, 0o644)
}
return body, nil
}
func (s *SimpleStreams) parseStream() (*Stream, error) {
if s.cachedStream != nil {
return s.cachedStream, nil
}
path := "streams/v1/index.json"
body, err := s.cachedDownload(path)
if err != nil {
return nil, err
}
pathURL, _ := url.JoinPath(s.url, path)
// Parse the idnex
stream := Stream{}
err = json.Unmarshal(body, &stream)
if err != nil {
return nil, fmt.Errorf("Failed decoding stream JSON from %q: %w (%q)", pathURL, err, string(body))
}
s.cachedStream = &stream
return &stream, nil
}
func (s *SimpleStreams) parseProducts(path string) (*Products, error) {
if s.cachedProducts[path] != nil {
return s.cachedProducts[path], nil
}
body, err := s.cachedDownload(path)
if err != nil {
return nil, err
}
// Parse the idnex
products := Products{}
err = json.Unmarshal(body, &products)
if err != nil {
return nil, fmt.Errorf("Failed decoding products JSON from %q: %w", path, err)
}
s.cachedProducts[path] = &products
return &products, nil
}
type extendedAlias struct {
Name string
Alias *api.ImageAliasesEntry
Type string
Architecture string
}
func (s *SimpleStreams) applyAliases(images []api.Image) ([]api.Image, []extendedAlias, error) {
aliasesList := []extendedAlias{}
// Sort the images so we tag the preferred ones
sort.Sort(sortedImages(images))
addAlias := func(imageType string, architecture string, name string, fingerprint string) *api.ImageAlias {
for _, entry := range aliasesList {
if entry.Name == name && entry.Type == imageType && entry.Architecture == architecture {
return nil
}
}
alias := api.ImageAliasesEntry{}
alias.Name = name
alias.Target = fingerprint
alias.Type = imageType
entry := extendedAlias{
Name: name,
Type: imageType,
Alias: &alias,
Architecture: architecture,
}
aliasesList = append(aliasesList, entry)
return &api.ImageAlias{Name: name}
}
architectureName, _ := osarch.ArchitectureGetLocal()
newImages := []api.Image{}
for _, image := range images {
if image.Aliases != nil {
// Build a new list of aliases from the provided ones
aliases := image.Aliases
image.Aliases = nil
for _, entry := range aliases {
// Short
alias := addAlias(image.Type, image.Architecture, entry.Name, image.Fingerprint)
if alias != nil && architectureName == image.Architecture {
image.Aliases = append(image.Aliases, *alias)
}
// Medium
alias = addAlias(image.Type, image.Architecture, fmt.Sprintf("%s/%s", entry.Name, image.Properties["architecture"]), image.Fingerprint)
if alias != nil {
image.Aliases = append(image.Aliases, *alias)
}
}
}
newImages = append(newImages, image)
}
return newImages, aliasesList, nil
}
func (s *SimpleStreams) getImages() ([]api.Image, []extendedAlias, error) {
if s.cachedImages != nil && s.cachedAliases != nil {
return s.cachedImages, s.cachedAliases, nil
}
images := []api.Image{}
// Load the stream data
stream, err := s.parseStream()
if err != nil {
return nil, nil, fmt.Errorf("Failed parsing stream: %w", err)
}
// Iterate through the various indices
for _, entry := range stream.Index {
// We only care about images
if entry.DataType != "image-downloads" {
continue
}
// No point downloading an empty image list
if len(entry.Products) == 0 {
continue
}
products, err := s.parseProducts(entry.Path)
if err != nil {
return nil, nil, fmt.Errorf("Failed parsing products: %w", err)
}
streamImages, _ := products.ToAPI()
images = append(images, streamImages...)
}
// Setup the aliases
images, aliases, err := s.applyAliases(images)
if err != nil {
return nil, nil, fmt.Errorf("Failed applying aliases: %w", err)
}
s.cachedImages = images
s.cachedAliases = aliases
return images, aliases, nil
}
// GetFiles returns a map of files for the provided image fingerprint.
func (s *SimpleStreams) GetFiles(fingerprint string) (map[string]DownloadableFile, error) {
// Load the main stream
stream, err := s.parseStream()
if err != nil {
return nil, err
}
// Iterate through the various indices
for _, entry := range stream.Index {
// We only care about images
if entry.DataType != "image-downloads" {
continue
}
// No point downloading an empty image list
if len(entry.Products) == 0 {
continue
}
products, err := s.parseProducts(entry.Path)
if err != nil {
return nil, err
}
images, downloads := products.ToAPI()
for _, image := range images {
if strings.HasPrefix(image.Fingerprint, fingerprint) {
files := map[string]DownloadableFile{}
for _, path := range downloads[image.Fingerprint] {
if len(path) < 4 {
return nil, fmt.Errorf("Invalid path content: %q", path)
}
size, err := strconv.ParseInt(path[3], 10, 64)
if err != nil {
return nil, err
}
files[path[2]] = DownloadableFile{
Path: path[0],
Sha256: path[1],
Size: size,
}
}
return files, nil
}
}
}
return nil, fmt.Errorf("Couldn't find the requested image")
}
// ListAliases returns a list of image aliases for the provided image fingerprint.
func (s *SimpleStreams) ListAliases() ([]api.ImageAliasesEntry, error) {
_, aliasesList, err := s.getImages()
if err != nil {
return nil, err
}
// Sort the list ahead of dedup
sort.Sort(sortedAliases(aliasesList))
aliases := []api.ImageAliasesEntry{}
for _, entry := range aliasesList {
dup := false
for _, v := range aliases {
if v.Name == entry.Name && v.Type == entry.Type {
dup = true
}
}
if dup {
continue
}
aliases = append(aliases, *entry.Alias)
}
return aliases, nil
}
// ListImages returns a list of images.
func (s *SimpleStreams) ListImages() ([]api.Image, error) {
images, _, err := s.getImages()
return images, err
}
// GetAlias returns an ImageAliasesEntry for the provided alias name.
func (s *SimpleStreams) GetAlias(imageType string, name string) (*api.ImageAliasesEntry, error) {
_, aliasesList, err := s.getImages()
if err != nil {
return nil, err
}
// Sort the list ahead of dedup
sort.Sort(sortedAliases(aliasesList))
var match *api.ImageAliasesEntry
for _, entry := range aliasesList {
if entry.Name != name {
continue
}
if entry.Type != imageType && imageType != "" {
continue
}
if match != nil {
if match.Type != entry.Type {
return nil, fmt.Errorf("More than one match for alias '%s'", name)
}
continue
}
match = entry.Alias
}
if match == nil {
return nil, fmt.Errorf("Alias '%s' doesn't exist", name)
}
return match, nil
}
// GetAliasArchitectures returns a map of architecture / alias entries for an alias.
func (s *SimpleStreams) GetAliasArchitectures(imageType string, name string) (map[string]*api.ImageAliasesEntry, error) {
aliases := map[string]*api.ImageAliasesEntry{}
_, aliasesList, err := s.getImages()
if err != nil {
return nil, err
}
for _, entry := range aliasesList {
if entry.Name != name {
continue
}
if entry.Type != imageType && imageType != "" {
continue
}
if aliases[entry.Architecture] != nil {
return nil, fmt.Errorf("More than one match for alias '%s'", name)
}
aliases[entry.Architecture] = entry.Alias
}
if len(aliases) == 0 {
return nil, fmt.Errorf("Alias '%s' doesn't exist", name)
}
return aliases, nil
}
// GetImage returns an image for the provided image fingerprint.
func (s *SimpleStreams) GetImage(fingerprint string) (*api.Image, error) {
images, _, err := s.getImages()
if err != nil {
return nil, err
}
matches := []api.Image{}
for _, image := range images {
if strings.HasPrefix(image.Fingerprint, fingerprint) {
matches = append(matches, image)
}
}
if len(matches) == 0 {
return nil, fmt.Errorf("The requested image couldn't be found")
} else if len(matches) > 1 {
return nil, fmt.Errorf("More than one match for the provided partial fingerprint")
}
return &matches[0], nil
}
|