github.com/quay/claircore@v1.5.28/libvuln/jsonblob/jsonblob.go

// Package jsonblob implements a JSON-backed recording of update operations to
// replay later.
package jsonblob

import (
	"bufio"
	"context"
	"encoding/json"
	"errors"
	"fmt"
	"io"
	"os"
	"sort"
	"sync"
	"time"

	"github.com/google/uuid"

	"github.com/quay/claircore"
	"github.com/quay/claircore/datastore"
	"github.com/quay/claircore/libvuln/driver"
)

var _ datastore.Updater = (*Store)(nil)

// New constructs an empty Store.
func New() (*Store, error) {
	s := Store{}
	s.ops = make(map[string][]driver.UpdateOperation)
	s.entry = make(map[uuid.UUID]*Entry)
	s.latest = make(map[driver.UpdateKind]uuid.UUID)
	return &s, nil
}

// A Store buffers update operations.
//
// Store opens files in the OS-specified "temp" directories. If updates are
// sufficiently large, this may need to be adjusted. See [os.TempDir] for how to
// do so.
type Store struct {
	sync.RWMutex
	entry  map[uuid.UUID]*Entry
	ops    map[string][]driver.UpdateOperation
	latest map[driver.UpdateKind]uuid.UUID
}

// Load reads in all the records serialized in the provided [io.Reader].
func Load(ctx context.Context, r io.Reader) (*Loader, error) {
	l := Loader{
		dec: json.NewDecoder(r),
		cur: uuid.Nil,
	}
	return &l, nil
}

// Loader is an iterator that returns a series of [Entry].
//
// Users should call [*Loader.Next] until it reports false, then check for
// errors via [*Loader.Err].
type Loader struct {
	err error
	e   *Entry

	dec  *json.Decoder
	next *Entry
	de   diskEntry
	cur  uuid.UUID
}

// Next reports whether there's an [Entry] to be processed.
func (l *Loader) Next() bool {
	if l.err != nil {
		return false
	}

	for l.err = l.dec.Decode(&l.de); l.err == nil; l.err = l.dec.Decode(&l.de) {
		id := l.de.Ref
		// If we just hit a new Entry, promote the current one.
		if id != l.cur {
			l.e = l.next
			l.next = &Entry{}
			l.next.Updater = l.de.Updater
			l.next.Fingerprint = l.de.Fingerprint
			l.next.Date = l.de.Date
		}
		switch l.de.Kind {
		case driver.VulnerabilityKind:
			vuln := claircore.Vulnerability{}
			if err := json.Unmarshal(l.de.Vuln.buf, &vuln); err != nil {
				l.err = err
				return false
			}
			l.next.Vuln = append(l.next.Vuln, &vuln)
		case driver.EnrichmentKind:
			en := driver.EnrichmentRecord{}
			if err := json.Unmarshal(l.de.Enrichment.buf, &en); err != nil {
				l.err = err
				return false
			}
			l.next.Enrichment = append(l.next.Enrichment, en)
		}
		// If this was an initial diskEntry, promote the ref.
		if id != l.cur {
			l.cur = id
			// If we have an Entry ready, report that.
			if l.e != nil {
				return true
			}
		}
	}
	l.e = l.next
	return true
}

// Entry returns the latest loaded [Entry].
func (l *Loader) Entry() *Entry {
	return l.e
}

// Err is the latest encountered error.
func (l *Loader) Err() error {
	// Don't report EOF as an error.
	if errors.Is(l.err, io.EOF) {
		return nil
	}
	return l.err
}

// Store writes out the contents of the receiver to the provided [io.Writer].
// It's the inverse of [Load].
//
// Store may only be called once for a series of [Store.UpdateVulnerabilities] and
// [Store.UpdateEnrichments] calls, as it deallocates resources as it writes them.
//
// It should be possible to call this as often as needed to flush resources to
// disk.
func (s *Store) Store(w io.Writer) error {
	s.RLock()
	defer s.RUnlock()
	enc := json.NewEncoder(w)
	enc.SetEscapeHTML(false)
	write := func(id uuid.UUID, e CommonEntry) func(driver.UpdateKind, *os.File, int) error {
		return func(k driver.UpdateKind, f *os.File, ct int) error {
			if f == nil {
				return nil
			}
			defer f.Close()
			shim := newBufShim(f)
			defer shim.Close()
			for i := 0; i < ct; i++ {
				dent := diskEntry{
					CommonEntry: e,
					Ref:         id,
					Kind:        k,
				}
				switch k {
				case driver.EnrichmentKind:
					dent.Enrichment = shim
				case driver.VulnerabilityKind:
					dent.Vuln = shim
				default:
					panic(fmt.Sprintf("programmer error: unknown kind: %v", k))
				}
				if err := enc.Encode(&dent); err != nil {
					return err
				}
			}
			return nil
		}
	}

	for id, e := range s.entry {
		f := write(id, e.CommonEntry)
		verr := f(driver.VulnerabilityKind, e.vulns, e.vulnCt)
		eerr := f(driver.EnrichmentKind, e.enrichments, e.enrichmentCt)
		delete(s.entry, id)
		if err := errors.Join(verr, eerr); err != nil {
			return err
		}
	}
	return nil
}

// BufShim treats every call to [bufShim.MarshalJSON] as a [bufio.Scanner.Scan]
// call.
//
// Note this type is very weird, in that it can only be used for _either_ an
// Unmarshal or a Marshal, not both. Doing both on the same structure will
// silently do the wrong thing.
type bufShim struct {
	s   *bufio.Scanner
	buf []byte
}

func newBufShim(r io.Reader) *bufShim {
	s := new(bufShim)
	s.s = bufio.NewScanner(r)
	s.buf = getBuf()
	s.s.Buffer(s.buf, len(s.buf))
	return s
}

func (s *bufShim) MarshalJSON() ([]byte, error) {
	if !s.s.Scan() {
		return nil, s.s.Err()
	}
	return s.s.Bytes(), nil
}

func (s *bufShim) UnmarshalJSON(b []byte) error {
	s.buf = append(s.buf[0:0], b...)
	return nil
}

func (s *bufShim) Close() error {
	putBuf(s.buf)
	return nil
}

// Entry is a record of all information needed to record a vulnerability at a
// later date.
type Entry struct {
	CommonEntry
	Vuln       []*claircore.Vulnerability
	Enrichment []driver.EnrichmentRecord

	// These are hacks to prevent excessive memory consumption.
	vulns        *os.File
	vulnCt       int
	enrichments  *os.File
	enrichmentCt int
}

// CommonEntry is an embedded type that's shared between the "normal" [Entry] type
// and the on-disk JSON produced by the [Store.Store] method.
type CommonEntry struct {
	Updater     string
	Fingerprint driver.Fingerprint
	Date        time.Time
}

// DiskEntry is a single vulnerability or enrichment. It's made from unpacking an
// Entry's slice and adding an uuid for grouping back into an Entry upon read.
//
// "Vuln" and "Enrichment" are populated from the backing disk immediately
// before being serialized.
type diskEntry struct {
	CommonEntry
	Ref        uuid.UUID
	Vuln       *bufShim `json:",omitempty"`
	Enrichment *bufShim `json:",omitempty"`
	Kind       driver.UpdateKind
}

// Entries returns a map containing all the Entries stored by calls to
// UpdateVulnerabilities.
//
// It is unsafe for modification because it does not return a copy of the map.
func (s *Store) Entries() map[uuid.UUID]*Entry {
	// BUG(hank) [Store.Entries] reports seemingly-empty entries when populated
	// via [Store.UpdateVulnerabilities].
	s.RLock()
	defer s.RUnlock()
	return s.entry
}

// UpdateVulnerabilities records all provided vulnerabilities.
func (s *Store) UpdateVulnerabilities(ctx context.Context, updater string, fingerprint driver.Fingerprint, vulns []*claircore.Vulnerability) (uuid.UUID, error) {
	now := time.Now()
	buf, err := diskBuf(ctx)
	if err != nil {
		return uuid.Nil, err
	}

	enc := json.NewEncoder(buf)
	enc.SetEscapeHTML(false)
	for _, v := range vulns {
		if err := enc.Encode(v); err != nil {
			return uuid.Nil, err
		}
	}
	if _, err := buf.Seek(0, io.SeekStart); err != nil {
		return uuid.Nil, err
	}

	e := Entry{
		vulns:  buf,
		vulnCt: len(vulns),
	}
	e.Date = now
	e.Updater = updater
	e.Fingerprint = fingerprint
	ref := uuid.New()
	s.Lock()
	defer s.Unlock()
	for {
		if _, exist := s.entry[ref]; !exist {
			break
		}
		ref = uuid.New()
	}
	s.entry[ref] = &e
	s.latest[driver.VulnerabilityKind] = ref
	s.ops[updater] = append([]driver.UpdateOperation{{
		Ref:         ref,
		Date:        now,
		Fingerprint: fingerprint,
		Updater:     updater,
		Kind:        driver.VulnerabilityKind,
	}}, s.ops[updater]...)
	return ref, nil
}

// Copyops assumes all locks are taken care of.
func (s *Store) copyops(ty driver.UpdateKind, us ...string) map[string][]driver.UpdateOperation {
	ns := make(map[string]struct{})
	for _, n := range us {
		ns[n] = struct{}{}
	}
	m := make(map[string][]driver.UpdateOperation, len(s.ops))
	for k, v := range s.ops {
		// If we were passed a set of names and this wasn't in it, pass.
		// If we weren't passed a set of names, do the copy for everything.
		if _, ok := ns[k]; len(ns) != 0 && !ok {
			continue
		}
		n := make([]driver.UpdateOperation, len(v))
		copy(n, v)
		// Filter our copy by type, in place.
		i := 0
		for _, op := range n {
			if op.Kind == ty {
				n[i] = op
				i++
			}
		}
		n = n[:i]
		sort.Slice(n, func(i, j int) bool { return n[i].Date.Before(n[j].Date) })
		m[k] = n
	}
	return m
}

// GetUpdateOperations returns a list of UpdateOperations in date descending
// order for the given updaters.
//
// The returned map is keyed by Updater implementation's unique names.
//
// If no updaters are specified, all UpdateOperations are returned.
func (s *Store) GetUpdateOperations(_ context.Context, k driver.UpdateKind, us ...string) (map[string][]driver.UpdateOperation, error) {
	s.RLock()
	defer s.RUnlock()
	return s.copyops(k, us...), nil
}

// GetLatestUpdateRefs reports the latest update reference for every known
// updater.
func (s *Store) GetLatestUpdateRefs(_ context.Context, k driver.UpdateKind) (map[string][]driver.UpdateOperation, error) {
	s.RLock()
	defer s.RUnlock()
	return s.copyops(k), nil
}

// GetLatestUpdateRef reports the latest update reference of any known
// updater.
func (s *Store) GetLatestUpdateRef(_ context.Context, k driver.UpdateKind) (uuid.UUID, error) {
	s.RLock()
	defer s.RUnlock()
	return s.latest[k], nil
}

// DeleteUpdateOperations is unimplemented.
func (s *Store) DeleteUpdateOperations(context.Context, ...uuid.UUID) (int64, error) {
	return 0, nil
}

// GetUpdateDiff is unimplemented.
func (s *Store) GetUpdateDiff(ctx context.Context, prev, cur uuid.UUID) (*driver.UpdateDiff, error) {
	return nil, nil
}

// Initialized implements vulnstore.Updater.
func (s *Store) Initialized(context.Context) (bool, error) {
	s.RLock()
	defer s.RUnlock()
	return len(s.entry) != 0, nil
}

// GC is unimplemented.
func (s *Store) GC(_ context.Context, _ int) (int64, error) {
	return 0, nil
}

// UpdateEnrichments creates a new EnrichmentUpdateOperation, inserts the provided
// EnrichmentRecord(s), and ensures enrichments from previous updates are not
// queries by clients.
func (s *Store) UpdateEnrichments(ctx context.Context, kind string, fp driver.Fingerprint, es []driver.EnrichmentRecord) (uuid.UUID, error) {
	now := time.Now()
	buf, err := diskBuf(ctx)
	if err != nil {
		return uuid.Nil, err
	}

	enc := json.NewEncoder(buf)
	enc.SetEscapeHTML(false)
	for _, v := range es {
		if err := enc.Encode(v); err != nil {
			return uuid.Nil, err
		}
	}
	if _, err := buf.Seek(0, io.SeekStart); err != nil {
		return uuid.Nil, err
	}

	e := Entry{
		enrichments:  buf,
		enrichmentCt: len(es),
	}
	e.Date = now
	e.Updater = kind
	e.Fingerprint = fp
	ref := uuid.New()
	s.Lock()
	defer s.Unlock()
	for {
		if _, exist := s.entry[ref]; !exist {
			break
		}
		ref = uuid.New()
	}
	s.latest[driver.EnrichmentKind] = ref
	s.entry[ref] = &e
	s.ops[kind] = append([]driver.UpdateOperation{{
		Ref:         ref,
		Date:        now,
		Fingerprint: fp,
		Updater:     kind,
		Kind:        driver.EnrichmentKind,
	}}, s.ops[kind]...)
	return ref, nil
}

// RecordUpdaterStatus is unimplemented.
func (s *Store) RecordUpdaterStatus(ctx context.Context, updaterName string, updateTime time.Time, fingerprint driver.Fingerprint, updaterError error) error {
	return nil
}

// RecordUpdaterSetStatus is unimplemented.
func (s *Store) RecordUpdaterSetStatus(ctx context.Context, updaterSet string, updateTime time.Time) error {
	return nil
}

// DeltaUpdateVulnerabilities is a noop
func (s *Store) DeltaUpdateVulnerabilities(ctx context.Context, updater string, fingerprint driver.Fingerprint, vulns []*claircore.Vulnerability, deleted []string) (uuid.UUID, error) {
	return uuid.Nil, nil
}

// UpdateEnrichmentsIter is unimplemented.
func (s *Store) UpdateEnrichmentsIter(_ context.Context, _ string, _ driver.Fingerprint, _ datastore.EnrichmentIter) (uuid.UUID, error) {
	return uuid.Nil, errors.ErrUnsupported
}

// UpdateVulnerabilitiesIter is unimplemented.
func (s *Store) UpdateVulnerabilitiesIter(_ context.Context, _ string, _ driver.Fingerprint, _ datastore.VulnerabilityIter) (uuid.UUID, error) {
	return uuid.Nil, errors.ErrUnsupported
}

var bufPool sync.Pool

func getBuf() []byte {
	const sz = 1 << 20 // 1MiB
	b, ok := bufPool.Get().([]byte)
	if !ok {
		b = make([]byte, sz)
	}
	return b
}
func putBuf(b []byte) {
	bufPool.Put(b)
}