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
|
// Copyright 2024 The Update Framework Authors
//
// 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
//
// SPDX-License-Identifier: Apache-2.0
//
package config
import (
"net/url"
"os"
"github.com/theupdateframework/go-tuf/v2/metadata/fetcher"
)
type UpdaterConfig struct {
// TUF configuration
MaxRootRotations int64
MaxDelegations int
RootMaxLength int64
TimestampMaxLength int64
SnapshotMaxLength int64
TargetsMaxLength int64
// Updater configuration
Fetcher fetcher.Fetcher
LocalTrustedRoot []byte
LocalMetadataDir string
LocalTargetsDir string
RemoteMetadataURL string
RemoteTargetsURL string
DisableLocalCache bool
PrefixTargetsWithHash bool
// UnsafeLocalMode only uses the metadata as written on disk
// if the metadata is incomplete, calling updater.Refresh will fail
UnsafeLocalMode bool
}
// New creates a new UpdaterConfig instance used by the Updater to
// store configuration
func New(remoteURL string, rootBytes []byte) (*UpdaterConfig, error) {
// Default URL for target files - <metadata-url>/targets
targetsURL, err := url.JoinPath(remoteURL, "targets")
if err != nil {
return nil, err
}
return &UpdaterConfig{
// TUF configuration
MaxRootRotations: 256,
MaxDelegations: 32,
RootMaxLength: 512000, // bytes
TimestampMaxLength: 16384, // bytes
SnapshotMaxLength: 2000000, // bytes
TargetsMaxLength: 5000000, // bytes
// Updater configuration
Fetcher: &fetcher.DefaultFetcher{}, // use the default built-in download fetcher
LocalTrustedRoot: rootBytes, // trusted root.json
RemoteMetadataURL: remoteURL, // URL of where the TUF metadata is
RemoteTargetsURL: targetsURL, // URL of where the target files should be downloaded from
DisableLocalCache: false, // enable local caching of trusted metadata
PrefixTargetsWithHash: true, // use hash-prefixed target files with consistent snapshots
UnsafeLocalMode: false,
}, nil
}
func (cfg *UpdaterConfig) EnsurePathsExist() error {
if cfg.DisableLocalCache {
return nil
}
for _, path := range []string{cfg.LocalMetadataDir, cfg.LocalTargetsDir} {
if err := os.MkdirAll(path, os.ModePerm); err != nil {
return err
}
}
return nil
}
|
