74 lines
2.2 KiB
Go
74 lines
2.2 KiB
Go
// Copyright 2017 clair 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.
|
|
|
|
// Package vulnsrc exposes functions to dynamically register vulnerability
|
|
// sources used to update a Clair database.
|
|
package vulnsrc
|
|
|
|
import (
|
|
"errors"
|
|
|
|
"github.com/coreos/clair/database"
|
|
)
|
|
|
|
var (
|
|
// Updaters is the list of registered Updaters.
|
|
Updaters = make(map[string]Updater)
|
|
|
|
// ErrFilesystem is returned when a fetcher fails to interact with the local filesystem.
|
|
ErrFilesystem = errors.New("vulnsrc: something went wrong when interacting with the fs")
|
|
|
|
// ErrGitFailure is returned when a fetcher fails to interact with git.
|
|
ErrGitFailure = errors.New("vulnsrc: something went wrong when interacting with git")
|
|
)
|
|
|
|
// Updater represents anything that can fetch vulnerabilities and insert them
|
|
// into a Clair datastore.
|
|
type Updater interface {
|
|
// Update gets vulnerability updates.
|
|
Update(database.Datastore) (UpdateResponse, error)
|
|
|
|
// Clean deletes any allocated resources.
|
|
// It is invoked when Clair stops.
|
|
Clean()
|
|
}
|
|
|
|
// UpdateResponse represents the sum of results of an update.
|
|
type UpdateResponse struct {
|
|
FlagName string
|
|
FlagValue string
|
|
Notes []string
|
|
Vulnerabilities []database.Vulnerability
|
|
}
|
|
|
|
// RegisterUpdater makes an Updater available by the provided name.
|
|
//
|
|
// If RegisterUpdater is called twice with the same name, the name is blank, or
|
|
// if the provided Updater is nil, this function panics.
|
|
func RegisterUpdater(name string, u Updater) {
|
|
if name == "" {
|
|
panic("vulnsrc: could not register an Updater with an empty name")
|
|
}
|
|
|
|
if u == nil {
|
|
panic("vulnsrc: could not register a nil Updater")
|
|
}
|
|
|
|
if _, dup := Updaters[name]; dup {
|
|
panic("vulnsrc: RegisterUpdater called twice for " + name)
|
|
}
|
|
|
|
Updaters[name] = u
|
|
}
|