2017-01-15 15:52:13 +00:00
|
|
|
// Copyright 2017 clair authors
|
2016-01-19 20:16:45 +00:00
|
|
|
//
|
|
|
|
// 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.
|
|
|
|
|
2017-01-19 18:42:37 +00:00
|
|
|
// Package database defines the Clair's models and a common interface for
|
|
|
|
// database implementations.
|
2015-11-13 19:11:28 +00:00
|
|
|
package database
|
|
|
|
|
2016-01-08 19:42:07 +00:00
|
|
|
import (
|
|
|
|
"errors"
|
2016-05-02 22:33:03 +00:00
|
|
|
"fmt"
|
2016-01-08 19:42:07 +00:00
|
|
|
"time"
|
2018-09-07 20:12:19 +00:00
|
|
|
|
|
|
|
"github.com/coreos/clair/pkg/pagination"
|
2016-01-08 19:42:07 +00:00
|
|
|
)
|
2015-11-13 19:11:28 +00:00
|
|
|
|
|
|
|
var (
|
2017-07-26 23:20:19 +00:00
|
|
|
// ErrBackendException is an error that occurs when the database backend
|
|
|
|
// does not work properly (ie. unreachable).
|
|
|
|
ErrBackendException = errors.New("database: an error occurred when querying the backend")
|
2016-01-08 16:17:32 +00:00
|
|
|
|
2015-11-13 19:11:28 +00:00
|
|
|
// ErrInconsistent is an error that occurs when a database consistency check
|
2017-01-15 15:52:13 +00:00
|
|
|
// fails (i.e. when an entity which is supposed to be unique is detected
|
|
|
|
// twice)
|
2015-11-13 19:11:28 +00:00
|
|
|
ErrInconsistent = errors.New("database: inconsistent database")
|
2018-10-08 14:42:17 +00:00
|
|
|
|
|
|
|
// ErrInvalidParameters is an error that occurs when the parameters are not valid.
|
|
|
|
ErrInvalidParameters = errors.New("database: parameters are not valid")
|
|
|
|
|
|
|
|
// ErrMissingEntities is an error that occurs when an associated immutable
|
|
|
|
// entity doesn't exist in the database. This error can indicate a wrong
|
|
|
|
// implementation or corrupted database.
|
|
|
|
ErrMissingEntities = errors.New("database: associated immutable entities are missing in the database")
|
2015-11-13 19:11:28 +00:00
|
|
|
)
|
|
|
|
|
2017-01-27 01:14:44 +00:00
|
|
|
// RegistrableComponentConfig is a configuration block that can be used to
|
|
|
|
// determine which registrable component should be initialized and pass custom
|
|
|
|
// configuration to it.
|
|
|
|
type RegistrableComponentConfig struct {
|
|
|
|
Type string
|
|
|
|
Options map[string]interface{}
|
|
|
|
}
|
|
|
|
|
2016-05-02 22:33:03 +00:00
|
|
|
var drivers = make(map[string]Driver)
|
|
|
|
|
2017-07-26 23:20:19 +00:00
|
|
|
// Driver is a function that opens a Datastore specified by its database driver
|
|
|
|
// type and specific configuration.
|
2017-01-27 01:14:44 +00:00
|
|
|
type Driver func(RegistrableComponentConfig) (Datastore, error)
|
2016-05-02 22:33:03 +00:00
|
|
|
|
|
|
|
// Register makes a Constructor available by the provided name.
|
|
|
|
//
|
|
|
|
// If this function is called twice with the same name or if the Constructor is
|
|
|
|
// nil, it panics.
|
|
|
|
func Register(name string, driver Driver) {
|
|
|
|
if driver == nil {
|
|
|
|
panic("database: could not register nil Driver")
|
|
|
|
}
|
|
|
|
if _, dup := drivers[name]; dup {
|
|
|
|
panic("database: could not register duplicate Driver: " + name)
|
|
|
|
}
|
|
|
|
drivers[name] = driver
|
|
|
|
}
|
|
|
|
|
|
|
|
// Open opens a Datastore specified by a configuration.
|
2017-01-27 01:14:44 +00:00
|
|
|
func Open(cfg RegistrableComponentConfig) (Datastore, error) {
|
2016-05-02 22:33:03 +00:00
|
|
|
driver, ok := drivers[cfg.Type]
|
|
|
|
if !ok {
|
|
|
|
return nil, fmt.Errorf("database: unknown Driver %q (forgotten configuration or import?)", cfg.Type)
|
|
|
|
}
|
|
|
|
return driver(cfg)
|
|
|
|
}
|
|
|
|
|
2017-07-26 23:20:19 +00:00
|
|
|
// Session contains the required operations on a persistent data store for a
|
|
|
|
// Clair deployment.
|
|
|
|
//
|
|
|
|
// Session is started by Datastore.Begin and terminated with Commit or Rollback.
|
|
|
|
// Besides Commit and Rollback, other functions cannot be called after the
|
|
|
|
// session is terminated.
|
|
|
|
// Any function is not guaranteed to be called successfully if there's a session
|
|
|
|
// failure.
|
|
|
|
type Session interface {
|
|
|
|
// Commit commits changes to datastore.
|
2017-01-15 15:52:13 +00:00
|
|
|
//
|
2017-07-26 23:20:19 +00:00
|
|
|
// Commit call after Rollback does no-op.
|
|
|
|
Commit() error
|
|
|
|
|
|
|
|
// Rollback drops changes to datastore.
|
2017-01-15 15:52:13 +00:00
|
|
|
//
|
2017-07-26 23:20:19 +00:00
|
|
|
// Rollback call after Commit does no-op.
|
|
|
|
Rollback() error
|
|
|
|
|
|
|
|
// UpsertAncestry inserts or replaces an ancestry and its namespaced
|
|
|
|
// features and processors used to scan the ancestry.
|
2018-09-07 15:31:35 +00:00
|
|
|
UpsertAncestry(Ancestry) error
|
2017-07-26 23:20:19 +00:00
|
|
|
|
2018-09-07 15:31:35 +00:00
|
|
|
// FindAncestry retrieves an ancestry with all detected
|
2018-09-05 15:34:49 +00:00
|
|
|
// namespaced features. If the ancestry is not found, return false.
|
2018-09-07 15:31:35 +00:00
|
|
|
FindAncestry(name string) (ancestry Ancestry, found bool, err error)
|
2017-07-26 23:20:19 +00:00
|
|
|
|
2018-10-08 14:42:17 +00:00
|
|
|
// PersistDetector inserts a slice of detectors if not in the database.
|
|
|
|
PersistDetectors(detectors []Detector) error
|
|
|
|
|
2017-07-26 23:20:19 +00:00
|
|
|
// PersistFeatures inserts a set of features if not in the database.
|
|
|
|
PersistFeatures(features []Feature) error
|
2015-11-13 19:11:28 +00:00
|
|
|
|
2017-07-26 23:20:19 +00:00
|
|
|
// PersistNamespacedFeatures inserts a set of namespaced features if not in
|
|
|
|
// the database.
|
|
|
|
PersistNamespacedFeatures([]NamespacedFeature) error
|
|
|
|
|
|
|
|
// CacheAffectedNamespacedFeatures relates the namespaced features with the
|
|
|
|
// vulnerabilities affecting these features.
|
2017-01-15 15:52:13 +00:00
|
|
|
//
|
2017-07-26 23:20:19 +00:00
|
|
|
// NOTE(Sida): it's not necessary for every database implementation and so
|
|
|
|
// this function may have a better home.
|
|
|
|
CacheAffectedNamespacedFeatures([]NamespacedFeature) error
|
|
|
|
|
|
|
|
// FindAffectedNamespacedFeatures retrieves a set of namespaced features
|
|
|
|
// with affecting vulnerabilities.
|
|
|
|
FindAffectedNamespacedFeatures(features []NamespacedFeature) ([]NullableAffectedNamespacedFeature, error)
|
|
|
|
|
|
|
|
// PersistNamespaces inserts a set of namespaces if not in the database.
|
|
|
|
PersistNamespaces([]Namespace) error
|
2016-02-12 21:24:37 +00:00
|
|
|
|
2018-10-08 14:42:17 +00:00
|
|
|
// PersistLayer appends a layer's content in the database.
|
2017-01-15 15:52:13 +00:00
|
|
|
//
|
2018-10-08 14:42:17 +00:00
|
|
|
// If any feature, namespace, or detector is not in the database, it returns not found error.
|
|
|
|
PersistLayer(hash string, features []LayerFeature, namespaces []LayerNamespace, detectedBy []Detector) error
|
2017-07-26 23:20:19 +00:00
|
|
|
|
2018-09-11 20:09:08 +00:00
|
|
|
// FindLayer returns a layer with all detected features and
|
2017-07-26 23:20:19 +00:00
|
|
|
// namespaces.
|
2018-09-11 20:09:08 +00:00
|
|
|
FindLayer(hash string) (layer Layer, found bool, err error)
|
2017-07-26 23:20:19 +00:00
|
|
|
|
|
|
|
// InsertVulnerabilities inserts a set of UNIQUE vulnerabilities with
|
|
|
|
// affected features into database, assuming that all vulnerabilities
|
|
|
|
// provided are NOT in database and all vulnerabilities' namespaces are
|
|
|
|
// already in the database.
|
|
|
|
InsertVulnerabilities([]VulnerabilityWithAffected) error
|
|
|
|
|
|
|
|
// FindVulnerability retrieves a set of Vulnerabilities with affected
|
|
|
|
// features.
|
|
|
|
FindVulnerabilities([]VulnerabilityID) ([]NullableVulnerability, error)
|
|
|
|
|
|
|
|
// DeleteVulnerability removes a set of Vulnerabilities assuming that the
|
|
|
|
// requested vulnerabilities are in the database.
|
|
|
|
DeleteVulnerabilities([]VulnerabilityID) error
|
2016-02-02 18:29:59 +00:00
|
|
|
|
2017-07-26 23:20:19 +00:00
|
|
|
// InsertVulnerabilityNotifications inserts a set of unique vulnerability
|
|
|
|
// notifications into datastore, assuming that they are not in the database.
|
|
|
|
InsertVulnerabilityNotifications([]VulnerabilityNotification) error
|
|
|
|
|
|
|
|
// FindNewNotification retrieves a notification, which has never been
|
|
|
|
// notified or notified before a certain time.
|
|
|
|
FindNewNotification(notifiedBefore time.Time) (hook NotificationHook, found bool, err error)
|
|
|
|
|
|
|
|
// FindVulnerabilityNotification retrieves a vulnerability notification with
|
|
|
|
// affected ancestries affected by old or new vulnerability.
|
2017-01-15 15:52:13 +00:00
|
|
|
//
|
2017-07-26 23:20:19 +00:00
|
|
|
// Because the number of affected ancestries maybe large, they are paginated
|
2018-10-08 14:42:17 +00:00
|
|
|
// and their pages are specified by the pagination token, which should be
|
|
|
|
// considered first page when it's empty.
|
2018-09-07 20:12:19 +00:00
|
|
|
FindVulnerabilityNotification(name string, limit int, oldVulnerabilityPage pagination.Token, newVulnerabilityPage pagination.Token) (noti VulnerabilityNotificationWithVulnerable, found bool, err error)
|
2017-07-26 23:20:19 +00:00
|
|
|
|
2018-09-11 18:24:09 +00:00
|
|
|
// MarkNotificationAsRead marks a Notification as notified now, assuming
|
2017-07-26 23:20:19 +00:00
|
|
|
// the requested notification is in the database.
|
2018-09-11 18:24:09 +00:00
|
|
|
MarkNotificationAsRead(name string) error
|
2017-07-26 23:20:19 +00:00
|
|
|
|
|
|
|
// DeleteNotification removes a Notification in the database.
|
2016-01-21 23:09:23 +00:00
|
|
|
DeleteNotification(name string) error
|
2015-11-16 21:22:16 +00:00
|
|
|
|
2017-07-26 23:20:19 +00:00
|
|
|
// UpdateKeyValue stores or updates a simple key/value pair.
|
|
|
|
UpdateKeyValue(key, value string) error
|
2016-02-12 21:24:37 +00:00
|
|
|
|
2017-07-26 23:20:19 +00:00
|
|
|
// FindKeyValue retrieves a value from the given key.
|
|
|
|
FindKeyValue(key string) (value string, found bool, err error)
|
2015-11-13 19:11:28 +00:00
|
|
|
|
2019-01-07 19:19:36 +00:00
|
|
|
// Lock acquires or renews a lock in the database with the given name, owner
|
|
|
|
// and duration without blocking. After the specified duration, the lock
|
|
|
|
// expires if it hasn't already been unlocked in order to prevent a deadlock.
|
2017-01-15 15:52:13 +00:00
|
|
|
//
|
2019-01-07 19:19:36 +00:00
|
|
|
// If the acquisition of a lock is not successful, expiration should be
|
|
|
|
// the time that existing lock expires.
|
2017-07-26 23:20:19 +00:00
|
|
|
Lock(name string, owner string, duration time.Duration, renew bool) (success bool, expiration time.Time, err error)
|
2016-02-12 21:24:37 +00:00
|
|
|
|
|
|
|
// Unlock releases an existing Lock.
|
2017-07-26 23:20:19 +00:00
|
|
|
Unlock(name, owner string) error
|
|
|
|
}
|
|
|
|
|
|
|
|
// Datastore represents a persistent data store
|
|
|
|
type Datastore interface {
|
|
|
|
// Begin starts a session to change.
|
|
|
|
Begin() (Session, error)
|
2015-11-13 19:11:28 +00:00
|
|
|
|
2016-02-12 21:24:37 +00:00
|
|
|
// Ping returns the health status of the database.
|
2016-01-22 20:57:57 +00:00
|
|
|
Ping() bool
|
2016-02-12 21:24:37 +00:00
|
|
|
|
2017-01-15 15:52:13 +00:00
|
|
|
// Close closes the database and frees any allocated resource.
|
2015-12-28 20:03:29 +00:00
|
|
|
Close()
|
2015-11-13 19:11:28 +00:00
|
|
|
}
|