Initial commit

Author: knqyf263

.gitignore

@@ -10,3 +10,4 @@
 
 # Output of the go coverage tool, specifically when used with LiteIDE
 *.out
+.idea

analyzer/analyzer.go

@@ -0,0 +1,95 @@
+package analyzer
+
+import (
+	"os"
+	"path/filepath"
+
+	"github.com/knqyf263/fanal/extractor"
+	"github.com/pkg/errors"
+)
+
+var (
+	osAnalyzers  []OSAnalyzer
+	pkgAnalyzers []PkgAnalyzer
+
+	// ErrUnknownOS occurs when unknown OS is analyzed.
+	ErrUnknownOS = errors.New("Unknown OS")
+	// ErrPkgAnalysis occurs when the analysis of packages is failed.
+	ErrPkgAnalysis = errors.New("Failed to analyze packages")
+)
+
+type OSAnalyzer interface {
+	Analyze(extractor.FilesMap) (OS, error)
+	RequiredFiles() []string
+}
+
+type PkgAnalyzer interface {
+	Analyze(extractor.FilesMap) ([]Package, error)
+	RequiredFiles() []string
+}
+
+type OS struct {
+	Name   string
+	Family string
+}
+
+type Package struct {
+	Name    string
+	Version string
+	Release string
+	Epoch   int
+}
+
+func RegisterOSAnalyzer(analyzer OSAnalyzer) {
+	osAnalyzers = append(osAnalyzers, analyzer)
+}
+
+func RegisterPkgAnalyzer(analyzer PkgAnalyzer) {
+	pkgAnalyzers = append(pkgAnalyzers, analyzer)
+}
+
+func RequiredFilenames() []string {
+	filenames := []string{}
+	for _, analyzer := range osAnalyzers {
+		filenames = append(filenames, analyzer.RequiredFiles()...)
+	}
+	for _, analyzer := range pkgAnalyzers {
+		filenames = append(filenames, analyzer.RequiredFiles()...)
+	}
+	return filenames
+}
+
+func Analyze(dir string) (filesMap extractor.FilesMap, err error) {
+	extractor := extractor.DockerExtractor{}
+	file, _ := os.Open(filepath.Join(dir, "layer.tar"))
+
+	filesMap, err = extractor.ExtractFiles(file, RequiredFilenames())
+	if err != nil {
+		return nil, errors.Wrap(err, "Failed to extract files")
+	}
+	return filesMap, nil
+}
+
+func GetOS(filesMap extractor.FilesMap) (OS, error) {
+	for _, analyzer := range osAnalyzers {
+		os, err := analyzer.Analyze(filesMap)
+		if err != nil {
+			continue
+		}
+		return os, nil
+	}
+	return OS{}, ErrUnknownOS
+
+}
+
+func GetPackages(filesMap extractor.FilesMap) ([]Package, error) {
+	for _, analyzer := range pkgAnalyzers {
+		pkgs, err := analyzer.Analyze(filesMap)
+		if err != nil {
+			continue
+		}
+		return pkgs, nil
+	}
+	return nil, ErrUnknownOS
+
+}

analyzer/os/alpine/alpine.go

@@ -0,0 +1,37 @@
+package alpine
+
+import (
+	"bufio"
+	"bytes"
+	"errors"
+	"fmt"
+
+	"github.com/knqyf263/fanal/analyzer"
+	"github.com/knqyf263/fanal/extractor"
+)
+
+func init() {
+	analyzer.RegisterOSAnalyzer(&alpineOSAnalyzer{})
+}
+
+type alpineOSAnalyzer struct{}
+
+func (a alpineOSAnalyzer) Analyze(filesMap extractor.FilesMap) (analyzer.OS, error) {
+	for _, filename := range a.RequiredFiles() {
+		file, ok := filesMap[filename]
+		if !ok {
+			continue
+		}
+		scanner := bufio.NewScanner(bytes.NewBuffer(file))
+		for scanner.Scan() {
+			// TODO
+			line := scanner.Text()
+			fmt.Println(line)
+		}
+	}
+	return analyzer.OS{}, errors.New("alpine: Not match")
+}
+
+func (a alpineOSAnalyzer) RequiredFiles() []string {
+	return []string{"etc/alpine-release"}
+}

analyzer/pkg/apk/apk.go

@@ -0,0 +1,37 @@
+package apk
+
+import (
+	"bufio"
+	"bytes"
+	"fmt"
+
+	"github.com/knqyf263/fanal/analyzer"
+	"github.com/knqyf263/fanal/extractor"
+	"github.com/pkg/errors"
+)
+
+func init() {
+	analyzer.RegisterPkgAnalyzer(&alpinePkgAnalyzer{})
+}
+
+type alpinePkgAnalyzer struct{}
+
+func (a alpinePkgAnalyzer) Analyze(filesMap extractor.FilesMap) ([]analyzer.Package, error) {
+	for _, filename := range a.RequiredFiles() {
+		file, ok := filesMap[filename]
+		if !ok {
+			continue
+		}
+		scanner := bufio.NewScanner(bytes.NewBuffer(file))
+		for scanner.Scan() {
+			// TODO
+			line := scanner.Text()
+			fmt.Println(line)
+		}
+	}
+	return []analyzer.Package{}, errors.New("alpine: Not match")
+}
+
+func (a alpinePkgAnalyzer) RequiredFiles() []string {
+	return []string{"lib/apk/db/installed"}
+}

cmd/fanal/main.go

@@ -0,0 +1,21 @@
+package main
+
+import (
+	"log"
+	"os"
+
+	"github.com/knqyf263/fanal/analyzer"
+	_ "github.com/knqyf263/fanal/analyzer/os/alpine"
+	_ "github.com/knqyf263/fanal/analyzer/pkg/apk"
+)
+
+func main() {
+	dir, err := os.Getwd()
+	if err != nil {
+		log.Fatal(err)
+	}
+
+	files, _ := analyzer.Analyze(dir)
+	analyzer.GetOS(files)
+	analyzer.GetPackages(files)
+}

extractor/docker.go

@@ -0,0 +1,51 @@
+package extractor
+
+import (
+	"archive/tar"
+	"io"
+	"io/ioutil"
+	"path"
+)
+
+type DockerExtractor struct{}
+
+func (d DockerExtractor) ExtractFiles(layer io.ReadCloser, filenames []string) (FilesMap, error) {
+	data := make(map[string][]byte)
+
+	tr := tar.NewReader(layer)
+	for {
+		hdr, err := tr.Next()
+		if err == io.EOF {
+			break
+		}
+		if err != nil {
+			return data, ErrCouldNotExtract
+		}
+
+		// Get element filename
+		filename := hdr.Name
+		filename = path.Clean(filename)
+
+		// Determine if we should extract the element
+		extract := false
+		for _, s := range filenames {
+			if s == filename {
+				extract = true
+				break
+			}
+		}
+
+		if !extract {
+			continue
+		}
+
+		// Extract the element
+		if hdr.Typeflag == tar.TypeSymlink || hdr.Typeflag == tar.TypeLink || hdr.Typeflag == tar.TypeReg {
+			d, _ := ioutil.ReadAll(tr)
+			data[filename] = d
+		}
+	}
+
+	return data, nil
+
+}

extractor/extractor.go

@@ -0,0 +1,18 @@
+package extractor
+
+import (
+	"io"
+
+	"github.com/pkg/errors"
+)
+
+var (
+	// ErrCouldNotExtract occurs when an extraction fails.
+	ErrCouldNotExtract = errors.New("Could not extract the archive")
+)
+
+type FilesMap map[string][]byte
+
+type Extractor interface {
+	ExtractFiles(layer io.ReadCloser, filenames []string) (FilesMap, error)
+}