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
|
// Copyright 2022 Northern.tech AS
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package handlers
import (
"encoding/json"
"fmt"
"io"
"path/filepath"
"github.com/pkg/errors"
"github.com/mendersoftware/mender-artifact/artifact"
)
type ModuleImage struct {
version int
updateType string
files [](*DataFile)
typeInfoV3 *artifact.TypeInfoV3
metaData map[string]interface{}
// If this is an augmented ModuleImage instance, pointer to the
// original. This is nil, if this instance is the original.
original ArtifactUpdate
installerBase
}
func NewModuleImage(updateType string) *ModuleImage {
mi := ModuleImage{
version: 3,
updateType: updateType,
}
return &mi
}
func NewAugmentedModuleImage(orig ArtifactUpdate, updateType string) *ModuleImage {
mi := NewModuleImage(updateType)
mi.original = orig
return mi
}
func (img *ModuleImage) NewAugmentedInstance(orig ArtifactUpdate) (Installer, error) {
newImg := img.NewInstance().(*ModuleImage)
newImg.original = orig
return newImg, nil
}
func (img *ModuleImage) NewInstance() Installer {
newImg := ModuleImage{
version: img.version,
installerBase: img.installerBase,
updateType: img.updateType,
}
return &newImg
}
func (img *ModuleImage) GetVersion() int {
return img.version
}
func (img *ModuleImage) GetUpdateType() *string {
updateType := img.updateType
return &updateType
}
func (img *ModuleImage) GetUpdateOriginalType() *string {
if img.original != nil {
return img.original.GetUpdateType()
} else {
noType := ""
return &noType
}
}
func (img *ModuleImage) GetUpdateFiles() [](*DataFile) {
if img.original == nil {
return img.files
} else {
return img.original.GetUpdateFiles()
}
}
func (img *ModuleImage) GetUpdateAugmentFiles() [](*DataFile) {
if img.original == nil {
// Not an augmented updater.
return []*DataFile{}
} else {
return img.files
}
}
func (img *ModuleImage) SetUpdateFiles(files [](*DataFile)) error {
if img.original == nil {
img.files = files
return nil
} else {
return img.original.SetUpdateFiles(files)
}
}
func (img *ModuleImage) SetUpdateAugmentFiles(files [](*DataFile)) error {
if img.original == nil {
if len(files) > 0 {
return errors.New("Cannot add augmented files to non-augmented Payload")
}
} else {
img.files = files
}
return nil
}
func (img *ModuleImage) GetUpdateAllFiles() [](*DataFile) {
files := img.GetUpdateFiles()
augmentFiles := img.GetUpdateAugmentFiles()
allFiles := make([](*DataFile), 0, len(files)+len(augmentFiles))
for n := range files {
allFiles = append(allFiles, files[n])
}
for n := range augmentFiles {
allFiles = append(allFiles, augmentFiles[n])
}
return allFiles
}
func (img *ModuleImage) GetUpdateOriginalDepends() artifact.TypeInfoDepends {
if img.original == nil {
return img.typeInfoV3.ArtifactDepends
} else {
return img.original.GetUpdateOriginalDepends()
}
}
func (img *ModuleImage) GetUpdateOriginalProvides() artifact.TypeInfoProvides {
if img.original == nil {
return img.typeInfoV3.ArtifactProvides
} else {
return img.original.GetUpdateOriginalProvides()
}
}
func (img *ModuleImage) GetUpdateOriginalMetaData() map[string]interface{} {
if img.original == nil {
return img.metaData
} else {
return img.original.GetUpdateOriginalMetaData()
}
}
func (img *ModuleImage) GetUpdateOriginalClearsProvides() []string {
if img.original == nil {
if img.typeInfoV3 == nil {
return nil
}
return img.typeInfoV3.ClearsArtifactProvides
} else {
return img.original.GetUpdateOriginalClearsProvides()
}
}
func (img *ModuleImage) setUpdateOriginalMetaData(metaData map[string]interface{}) error {
if img.original == nil {
img.metaData = metaData
return nil
} else {
return errors.New("Cannot set original meta-data after augmented instance has been created")
}
}
func (img *ModuleImage) GetUpdateAugmentDepends() artifact.TypeInfoDepends {
if img.original == nil {
ret := make(artifact.TypeInfoDepends)
return ret
} else {
return img.typeInfoV3.ArtifactDepends
}
}
func (img *ModuleImage) GetUpdateAugmentProvides() artifact.TypeInfoProvides {
if img.original == nil {
ret := make(artifact.TypeInfoProvides)
return ret
} else {
return img.typeInfoV3.ArtifactProvides
}
}
func (img *ModuleImage) GetUpdateAugmentMetaData() map[string]interface{} {
if img.original == nil {
return make(map[string]interface{})
} else {
return img.metaData
}
}
func (img *ModuleImage) GetUpdateAugmentClearsProvides() []string {
if img.original == nil {
return nil
} else {
if img.typeInfoV3 == nil {
return nil
}
return img.typeInfoV3.ClearsArtifactProvides
}
}
func (img *ModuleImage) setUpdateAugmentMetaData(metaData map[string]interface{}) error {
if img.original == nil {
if len(metaData) > 0 {
return errors.New("Tried to set augmented meta-data on a non-augmented Payload")
}
} else {
img.metaData = metaData
// Check that we can merge original and augmented meta data.
_, err := mergeJsonStructures(
img.GetUpdateOriginalMetaData(),
img.GetUpdateAugmentMetaData(),
)
if err != nil {
return err
}
}
return nil
}
// Copies JSON structures, with the additional restriction that lists cannot
// contain any object or list.
func jsonDeepCopy(src interface{}) (interface{}, error) {
switch item := src.(type) {
case map[string]interface{}:
dst := make(map[string]interface{})
for key := range item {
obj, err := jsonDeepCopy(item[key])
if err != nil {
return nil, errors.Wrap(err, key)
}
dst[key] = obj
}
return dst, nil
case []interface{}:
dst := make([]interface{}, 0, len(item))
for n := range item {
switch item[n].(type) {
case map[string]interface{}, []interface{}:
return nil, errors.New("List cannot contain JSON object or list")
}
dst = append(dst, item[n])
}
return dst, nil
default:
return src, nil
}
}
func mergeJsonStructures(orig, override map[string]interface{}) (map[string]interface{}, error) {
// TODO: this function needs to take security into account. See the
// 'PermittedAugmentedHeaders' section of the update modules spec.
copy, err := jsonDeepCopy(orig)
if err != nil {
return nil, err
}
merged := copy.(map[string]interface{})
for key := range override {
if _, ok := merged[key]; !ok {
merged[key], err = jsonDeepCopy(override[key])
if err != nil {
return nil, errors.Wrap(err, key)
}
continue
}
switch overrideValue := override[key].(type) {
case map[string]interface{}:
var origValue map[string]interface{}
var ok bool
if origValue, ok = orig[key].(map[string]interface{}); !ok {
return nil, fmt.Errorf("%s: Cannot combine JSON object with non-object.", key)
}
var err error
merged[key], err = mergeJsonStructures(origValue, overrideValue)
if err != nil {
return nil, errors.Wrap(err, key)
}
continue
case []interface{}:
if _, ok := orig[key].([]interface{}); !ok {
return nil, fmt.Errorf("%s: Type conflict: list/non-list", key)
}
// fall through to bottom
default:
if _, ok := orig[key].(map[string]interface{}); ok {
return nil, fmt.Errorf("%s: Type conflict: object/non-object", key)
}
if _, ok := orig[key].([]interface{}); ok {
return nil, fmt.Errorf("%s: Type conflict: list/non-list", key)
}
// fall through to bottom
}
obj, err := jsonDeepCopy(override[key])
if err != nil {
return nil, errors.Wrap(err, key)
}
merged[key] = obj
}
return merged, nil
}
// Transforms JSON from structs into a generic map[string]interface{}
// structure. It's a bit heavy handed, but allows us to use mergeJsonStructures,
// since this function would be complicated to reimplement for specific
// structures.
func transformStructToGenericMap(data interface{}) (map[string]interface{}, error) {
origJson, err := json.Marshal(data)
if err != nil {
return nil, err
}
var generic map[string]interface{}
err = json.Unmarshal(origJson, &generic)
if err != nil {
return nil, err
}
return generic, nil
}
// Inverse of the above function.
func transformGenericMapToStruct(src map[string]interface{}, dst interface{}) error {
origJson, err := json.Marshal(src)
if err != nil {
return err
}
err = json.Unmarshal(origJson, dst)
if err != nil {
return err
}
return nil
}
func (img *ModuleImage) GetUpdateDepends() (artifact.TypeInfoDepends, error) {
orig, err := transformStructToGenericMap(img.GetUpdateOriginalDepends())
if err != nil {
return nil, err
}
augm, err := transformStructToGenericMap(img.GetUpdateAugmentDepends())
if err != nil {
return nil, err
}
merged, err := mergeJsonStructures(orig, augm)
if err != nil {
return nil, err
}
var depends artifact.TypeInfoDepends
err = transformGenericMapToStruct(merged, &depends)
if err != nil {
return nil, err
}
return merged, nil
}
func (img *ModuleImage) GetUpdateProvides() (artifact.TypeInfoProvides, error) {
orig, err := transformStructToGenericMap(img.GetUpdateOriginalProvides())
if err != nil {
return nil, err
}
augm, err := transformStructToGenericMap(img.GetUpdateAugmentProvides())
if err != nil {
return nil, err
}
merged, err := mergeJsonStructures(orig, augm)
if err != nil {
return nil, err
}
var provides artifact.TypeInfoProvides
err = transformGenericMapToStruct(merged, &provides)
if err != nil {
return nil, err
}
return provides, nil
}
func (img *ModuleImage) GetUpdateMetaData() (map[string]interface{}, error) {
merged, err := mergeJsonStructures(
img.GetUpdateOriginalMetaData(),
img.GetUpdateAugmentMetaData(),
)
if err != nil {
return nil, err
}
return merged, nil
}
func (img *ModuleImage) GetUpdateClearsProvides() []string {
if img.typeInfoV3 == nil || img.typeInfoV3.ClearsArtifactProvides == nil {
if img.original != nil {
return img.original.GetUpdateOriginalClearsProvides()
} else {
return nil
}
}
return img.typeInfoV3.ClearsArtifactProvides
}
func (img *ModuleImage) ComposeHeader(args *ComposeHeaderArgs) error {
if img.version < 3 {
return errors.New(
"artifact version < 3 in ModuleImage.ComposeHeader. This is a bug in the application",
)
}
img.typeInfoV3 = args.TypeInfoV3
path := artifact.UpdateHeaderPath(args.No)
if err := writeTypeInfoV3(&WriteInfoArgs{
tarWriter: args.TarWriter,
dir: path,
typeinfov3: args.TypeInfoV3,
}); err != nil {
return errors.Wrap(err, "ComposeHeader: ")
}
if len(args.MetaData) > 0 {
sw := artifact.NewTarWriterStream(args.TarWriter)
data, err := json.Marshal(args.MetaData)
if err != nil {
return errors.Wrap(
err,
"MetaData field unmarshalable. This is a bug in the application",
)
}
if err = sw.Write(data, filepath.Join(path, "meta-data")); err != nil {
return errors.Wrap(err, "Payload: can not store meta-data")
}
}
return nil
}
func (img *ModuleImage) ReadHeader(r io.Reader, path string, version int, augmented bool) error {
// Check that augmented flag and our image original instance match.
if augmented != (img.original != nil) {
return errors.New("ModuleImage.ReadHeader called with unexpected augmented parameter")
}
img.version = version
switch {
case filepath.Base(path) == "type-info":
dec := json.NewDecoder(r)
err := dec.Decode(&img.typeInfoV3)
if err != nil {
return errors.Wrap(err, "error reading type-info")
}
case filepath.Base(path) == "meta-data":
dec := json.NewDecoder(r)
var data interface{}
err := dec.Decode(&data)
if err == io.EOF {
break
} else if err != nil {
return errors.Wrap(err, "error reading meta-data")
}
jsonObj, ok := data.(map[string]interface{})
if !ok {
return errors.New("Top level object in meta-data must be a JSON object")
}
if augmented {
err = img.setUpdateAugmentMetaData(jsonObj)
} else {
err = img.setUpdateOriginalMetaData(jsonObj)
}
if err != nil {
return err
}
default:
return errors.Errorf("Payload: unsupported file: %v", path)
}
return nil
}
func (img *ModuleImage) GetUpdateOriginalTypeInfoWriter() io.Writer {
if img.original != nil {
return img.original.GetUpdateOriginalTypeInfoWriter()
} else {
return img.typeInfoV3
}
}
func (img *ModuleImage) GetUpdateAugmentTypeInfoWriter() io.Writer {
if img.original != nil {
return img.typeInfoV3
} else {
return nil
}
}
|