clair/api/router.go

// Copyright 2015 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 api

import (
	"net/http"
	"strings"
	"time"

	"github.com/coreos/clair/api/logic"
	"github.com/coreos/clair/api/wrappers"
	"github.com/julienschmidt/httprouter"
)

// VersionRouter is an HTTP router that forwards requests to the appropriate
// router depending on the API version specified in the requested URI.
type VersionRouter map[string]*httprouter.Router

// NewVersionRouter instantiates a VersionRouter and every sub-routers that are
// necessary to handle supported API versions.
func NewVersionRouter(to time.Duration) *VersionRouter {
	return &VersionRouter{
		"/v1": NewRouterV1(to),
	}
}

// ServeHTTP forwards requests to the appropriate router depending on the API
// version specified in the requested URI and remove the version information
// from the request URL.Path, without modifying the request uRequestURI.
func (vs VersionRouter) ServeHTTP(w http.ResponseWriter, r *http.Request) {
	urlStr := r.URL.String()
	var version string
	if len(urlStr) >= 3 {
		version = urlStr[:3]
	}
	if router, _ := vs[version]; router != nil {
		// Remove the version number from the request path to let the router do its
		// job but do not update the RequestURI
		r.URL.Path = strings.Replace(r.URL.Path, version, "", 1)
		router.ServeHTTP(w, r)
		return
	}
	http.NotFound(w, r)
}

// NewRouterV1 creates a new router for the API (Version 1)
func NewRouterV1(to time.Duration) *httprouter.Router {
	router := httprouter.New()
	wrap := func(fn httprouter.Handle) httprouter.Handle {
		return wrappers.Log(wrappers.TimeOut(to, fn))
	}

	// General
	router.GET("/versions", wrap(logic.GETVersions))
	router.GET("/health", wrap(logic.GETHealth))

	// Layers
	router.POST("/layers", wrap(logic.POSTLayers))
	router.GET("/layers/:id/os", wrap(logic.GETLayersOS))
	router.GET("/layers/:id/parent", wrap(logic.GETLayersParent))
	router.GET("/layers/:id/packages", wrap(logic.GETLayersPackages))
	router.GET("/layers/:id/packages/diff", wrap(logic.GETLayersPackagesDiff))
	router.GET("/layers/:id/vulnerabilities", wrap(logic.GETLayersVulnerabilities))
	router.GET("/layers/:id/vulnerabilities/diff", wrap(logic.GETLayersVulnerabilitiesDiff))
	// # Batch version of "/layers/:id/vulnerabilities"
	router.POST("/batch/layers/vulnerabilities", wrap(logic.POSTBatchLayersVulnerabilities))

	// Vulnerabilities
	router.POST("/vulnerabilities", wrap(logic.POSTVulnerabilities))
	router.PUT("/vulnerabilities/:id", wrap(logic.PUTVulnerabilities))
	router.GET("/vulnerabilities/:id", wrap(logic.GETVulnerabilities))
	router.DELETE("/vulnerabilities/:id", wrap(logic.DELVulnerabilities))
	router.GET("/vulnerabilities/:id/introducing-layers", wrap(logic.GETVulnerabilitiesIntroducingLayers))
	router.POST("/vulnerabilities/:id/affected-layers", wrap(logic.POSTVulnerabilitiesAffectedLayers))

	return router
}

// NewHealthRouter creates a new router that only serve the Health function on /
func NewHealthRouter() *httprouter.Router {
	router := httprouter.New()
	router.GET("/", logic.GETHealth)
	return router
}