apkutils

README

Go alpine APK Utils

go-apkutils is a library written in go for parsing and extracting content from APKs.

Overview

go-apkutils provides a few interfaces for handling alpine APK packages and APKINDEX files.

There is a highlevel Apk and ApkIndex struct that provides access to package and index information.

1. Extract metadata from an apk package file

	f, err := os.Open("curl-7.83.1-r1.apk")
	if err != nil {
		panic(err)
	}
	apk, err := apk.ReadApk(f)
	if err != nil {
		panic(err)
	}
	fmt.Println(apk)

2. Read apk index files

	f, err := os.Open("APKINDEX")
	if err != nil {
		panic(err)
	}
	index, err := index.ReadApkIndex(f)
	if err != nil {
		panic(err)
	}
	fmt.Println(index.Entries)

3. Write apk index files

    // List of apk names
    apkFile := []string{
        "curl-7.83.1-r1.apk",
        "gvim-8.2.5000-r0.apk",
        "strace-5.17-r0.apk",
    }
    // Create APKINDEX file
    f, err := os.OpenFile("APKINDEX.test", os.O_RDWR|os.O_CREATE, 0644)
    if err != nil {
        log.Fatalln("Error opening APKINDEX file:", err)
    }
    // Create a writer
    w := index.NewWriter(f)
    defer w.Close()
    for _, filePath := range apkFile {
        f, err := os.Open(filePath)
        if err != nil {
            log.Fatalln("Error opening file:", err)
        }
        apkFile, err := apk.ReadApk(f)
        if err != nil {
            log.Fatalln("Error reading apk file:", err)
        }
        w.WriteApk(apkFile)
    }
    w.Close()

Documentation

Index

• Constants
• func ReadGzipHeader(buf []byte) bool
• func TarGzip(filename string, b []byte, writeEOFTar bool) (int, []byte, error)
• type ApkFile
  • func (apkFile *ApkFile) ToIndexEntry() string
• type ApkIndex
• type IndexEntry
  • func (entry *IndexEntry) String() string
• type PkgInfo

Constants

const (
	GzipID1     = 0x1f
	GzipID2     = 0x8b
	GzipDeflate = 8
)

Functions

func ReadGzipHeader

func ReadGzipHeader(buf []byte) bool

func TarGzip

func TarGzip(filename string, b []byte, writeEOFTar bool) (int, []byte, error)

Types

type ApkFile

type ApkFile struct {
	PullChecksum string
	PkgInfo      *PkgInfo
	PkgFileSize  int
}

func (*ApkFile) ToIndexEntry

func (apkFile *ApkFile) ToIndexEntry() string

type ApkIndex

type ApkIndex struct {
	Entries []*IndexEntry
}

ApkIndex is an APKINDEX header and payload

type IndexEntry

type IndexEntry struct {
	PullChecksum         string
	PackageName          string
	PackageVersion       string
	PackageArchitecture  string
	PackageSize          string
	PackageInstalledSize string
	PackageDescription   string
	PackageUrl           string
	PackageLicense       string
	PackageOrigin        string
	PackageMaintainer    string
	BuildTimeStamp       string
	GitCommitAport       string
	PullDependencies     string
	PackageProvides      string
}

func (*IndexEntry) String

func (entry *IndexEntry) String() string

type PkgInfo

type PkgInfo struct {
	PkgName       string
	PkgVer        string
	PkgDesc       string
	PkgUrl        string
	PkgBuildDate  string
	PkgPackager   string
	PkgSize       string
	PkgArch       string
	PkgOrigin     string
	PkgCommit     string
	PkgMaintainer string
	PkgLicense    string
	PkgProvides   []string
	PkgDepends    []string
	PkgDataHash   string
}