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
|
// Copyright 2017 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 awriter
import (
"archive/tar"
"compress/gzip"
"io"
"io/ioutil"
"os"
"path/filepath"
"github.com/mendersoftware/mender-artifact/artifact"
"github.com/mendersoftware/mender-artifact/handlers"
"github.com/pkg/errors"
)
// Writer provides on the fly writing of artifacts metadata file used by
// the Mender client and the server.
type Writer struct {
w io.Writer // underlying writer
signer artifact.Signer
}
func NewWriter(w io.Writer) *Writer {
return &Writer{
w: w,
}
}
func NewWriterSigned(w io.Writer, s artifact.Signer) *Writer {
return &Writer{
w: w,
signer: s,
}
}
type Updates struct {
U []handlers.Composer
}
// Iterate through all data files inside `upd` and calculate checksums.
func calcDataHash(s *artifact.ChecksumStore, upd *Updates) error {
for i, u := range upd.U {
for _, f := range u.GetUpdateFiles() {
ch := artifact.NewWriterChecksum(ioutil.Discard)
df, err := os.Open(f.Name)
if err != nil {
return errors.Wrapf(err, "writer: can not open data file: %v", f)
}
defer df.Close()
if _, err := io.Copy(ch, df); err != nil {
return errors.Wrapf(err, "writer: can not calculate checksum: %v", f)
}
sum := ch.Checksum()
f.Checksum = sum
s.Add(filepath.Join(artifact.UpdatePath(i), filepath.Base(f.Name)), sum)
}
}
return nil
}
func writeTempHeader(s *artifact.ChecksumStore, devices []string, name string,
upd *Updates, scr *artifact.Scripts) (*os.File, error) {
// create temporary header file
f, err := ioutil.TempFile("", "header")
if err != nil {
return nil, errors.New("writer: can not create temporary header file")
}
ch := artifact.NewWriterChecksum(f)
// use function to make sure to close gz and tar before
// calculating checksum
err = func() error {
gz := gzip.NewWriter(ch)
defer gz.Close()
htw := tar.NewWriter(gz)
defer htw.Close()
if err = writeHeader(htw, devices, name, upd, scr); err != nil {
return errors.Wrapf(err, "writer: error writing header")
}
return nil
}()
if err != nil {
return nil, err
}
s.Add("header.tar.gz", ch.Checksum())
return f, nil
}
func WriteSignature(tw *tar.Writer, message []byte,
signer artifact.Signer) error {
if signer == nil {
return nil
}
sig, err := signer.Sign(message)
if err != nil {
return errors.Wrap(err, "writer: can not sign artifact")
}
sw := artifact.NewTarWriterStream(tw)
if err := sw.Write(sig, "manifest.sig"); err != nil {
return errors.Wrap(err, "writer: can not tar signature")
}
return nil
}
func (aw *Writer) WriteArtifact(format string, version int,
devices []string, name string, upd *Updates, scr *artifact.Scripts) error {
if version == 1 && aw.signer != nil {
return errors.New("writer: can not create version 1 signed artifact")
}
s := artifact.NewChecksumStore()
// calculate checksums of all data files
// we need this regardless of which artifact version we are writing
if err := calcDataHash(s, upd); err != nil {
return err
}
// write temporary header (we need to know the size before storing in tar)
tmpHdr, err := writeTempHeader(s, devices, name, upd, scr)
if err != nil {
return err
}
defer os.Remove(tmpHdr.Name())
// mender archive writer
tw := tar.NewWriter(aw.w)
defer tw.Close()
// write version file
inf := artifact.ToStream(&artifact.Info{Version: version, Format: format})
sa := artifact.NewTarWriterStream(tw)
if err := sa.Write(inf, "version"); err != nil {
return errors.Wrapf(err, "writer: can not write version tar header")
}
switch version {
case 2:
// add checksum of `version`
ch := artifact.NewWriterChecksum(ioutil.Discard)
ch.Write(inf)
s.Add("version", ch.Checksum())
// write `manifest` file
sw := artifact.NewTarWriterStream(tw)
if err := sw.Write(s.GetRaw(), "manifest"); err != nil {
return errors.Wrapf(err, "writer: can not write manifest stream")
}
// write signature
if err := WriteSignature(tw, s.GetRaw(), aw.signer); err != nil {
return err
}
// header is written later on
case 1:
// header is written later on
default:
return errors.New("writer: unsupported artifact version")
}
// write header
if _, err := tmpHdr.Seek(0, 0); err != nil {
return errors.Wrapf(err, "writer: error preparing tmp header for writing")
}
fw := artifact.NewTarWriterFile(tw)
if err := fw.Write(tmpHdr, "header.tar.gz"); err != nil {
return errors.Wrapf(err, "writer: can not tar header")
}
// write data files
return writeData(tw, upd)
}
func writeScripts(tw *tar.Writer, scr *artifact.Scripts) error {
sw := artifact.NewTarWriterFile(tw)
for _, script := range scr.Get() {
f, err := os.Open(script)
if err != nil {
return errors.Wrapf(err, "writer: can not open script file: %s", script)
}
defer f.Close()
if err :=
sw.Write(f, filepath.Join("scripts", filepath.Base(script))); err != nil {
return errors.Wrapf(err, "writer: can not store script: %s", script)
}
}
return nil
}
func writeHeader(tw *tar.Writer, devices []string, name string,
updates *Updates, scr *artifact.Scripts) error {
// store header info
hInfo := new(artifact.HeaderInfo)
for _, upd := range updates.U {
hInfo.Updates =
append(hInfo.Updates, artifact.UpdateType{Type: upd.GetType()})
}
hInfo.CompatibleDevices = devices
hInfo.ArtifactName = name
sa := artifact.NewTarWriterStream(tw)
if err := sa.Write(artifact.ToStream(hInfo), "header-info"); err != nil {
return errors.New("writer: can not store header-info")
}
// write scripts
if scr != nil {
if err := writeScripts(tw, scr); err != nil {
return err
}
}
for i, upd := range updates.U {
if err := upd.ComposeHeader(tw, i); err != nil {
return errors.Wrapf(err, "writer: error processing update directory")
}
}
return nil
}
func writeData(tw *tar.Writer, updates *Updates) error {
for i, upd := range updates.U {
if err := upd.ComposeData(tw, i); err != nil {
return errors.Wrapf(err, "writer: error writing data files")
}
}
return nil
}
|