badkeys

README

Bad Keys

This is a partial Go implementation of Hanno Böck's badkeys project.

The major differences include:

• This project does not implement weak prime detection.

• This project is missing other badkeys detections:

  • Fermat
  • Patterns
  • ROCA
  • RSA Invalid
  • RSA Warnings
  • Shared Primes
  • Small Factors
  • XZ Backdoor

Documentation

Index

• Constants
• func GetExecutableDir() string
• func GetExecutablePath() string
• func PrefixFromPublicKey(pub any) ([]byte, error)
• type Blocklist
  • func NewBlocklist() *Blocklist
  • func (tset *Blocklist) FindBlock(k []byte) ([]byte, error)
  • func (tset *Blocklist) LookupPrefix(sum []byte) (*Result, error)
• type Cache
  • func NewCache(lgr *logrus.Logger) *Cache
  • func (cache *Cache) CreateFile(path string) (io.WriteCloser, error)
  • func (cache *Cache) CurrentMetadata() (*Meta, error)
  • func (cache *Cache) DownloadAndValidateXZ(u string, hash string, path string) error
  • func (cache *Cache) GetCacheDir() string
  • func (cache *Cache) LoadBlocklist() (*Blocklist, error)
  • func (cache *Cache) OpenFile(path string) (io.ReadCloser, error)
  • func (cache *Cache) RemoveFile(path string) error
  • func (cache *Cache) RenameFile(src string, dst string) error
  • func (cache *Cache) SetCacheDir(s string)
  • func (cache *Cache) Update() (string, string, error)
• type Dirs
• type Meta
  • func ReadBadKeysManifest(r io.Reader) (*Meta, error)
• type Paths
• type Repo
• type Repos
• type Result
  • func (r *Result) GetID() string
  • func (r *Result) GetURL() string

Constants

const BadKeysMetaURL = "https://update.badkeys.info/v0/badkeysdata.json"

const BlockHashPrefix = 15

const BlockLength = 16

const CacheFileBlocklist = "blocklist.dat"

const CacheFileLookup = "lookup.txt"

const CacheFileMetadata = "badkeysdata.json"

const HTTPDataDownloadTimeout = time.Hour

const HTTPMetaDownloadTimeout = time.Second * 30

const MaxLookupLine = 4096

const MaxResponseSize = 1024 * 1024 * 512 // Adjust if the block list becomes larger

Functions

func GetExecutableDir

func GetExecutableDir() string

GetExecutableDir returns the full path to the running binary's directory

func GetExecutablePath

func GetExecutablePath() string

GetExecutablePath returns the full path to the running binary

func PrefixFromPublicKey

func PrefixFromPublicKey(pub any) ([]byte, error)

PrefixFromPublicKey implements the badkeys `blocklistmaker` hashing method

Types

type Blocklist

type Blocklist struct {
	Meta          *Meta
	Blocks        []byte
	Repos         Repos
	LookupMap     map[uint64][]int
	LookupStrings []string
	Error         error
}

func NewBlocklist

func NewBlocklist() *Blocklist

func (*Blocklist) FindBlock

func (tset *Blocklist) FindBlock(k []byte) ([]byte, error)

func (*Blocklist) LookupPrefix

func (tset *Blocklist) LookupPrefix(sum []byte) (*Result, error)

type Cache

type Cache struct {
	sync.Mutex
	Blocklist *Blocklist
	LoadError error
	// contains filtered or unexported fields
}

func NewCache

func NewCache(lgr *logrus.Logger) *Cache

func (*Cache) CreateFile

func (cache *Cache) CreateFile(path string) (io.WriteCloser, error)

CreateFile returns a writer for the given cache file name

func (*Cache) CurrentMetadata

func (cache *Cache) CurrentMetadata() (*Meta, error)

func (*Cache) DownloadAndValidateXZ

func (cache *Cache) DownloadAndValidateXZ(u string, hash string, path string) error

func (*Cache) GetCacheDir

func (cache *Cache) GetCacheDir() string

GetCacheDir returns the location of the badkeys block tables

func (*Cache) LoadBlocklist

func (cache *Cache) LoadBlocklist() (*Blocklist, error)

LoadBlocklist loads the blocklist from disk if necessary

func (*Cache) OpenFile

func (cache *Cache) OpenFile(path string) (io.ReadCloser, error)

OpenFile returns a reader for the given cache file name

func (*Cache) RemoveFile

func (cache *Cache) RemoveFile(path string) error

RemoveFile deletes a file from the cache

func (*Cache) RenameFile

func (cache *Cache) RenameFile(src string, dst string) error

RenameFile replaces one file with another in the caache

func (*Cache) SetCacheDir

func (cache *Cache) SetCacheDir(s string)

SetCacheDir sets the location of the badkeys block tables

func (*Cache) Update

func (cache *Cache) Update() (string, string, error)

type Dirs

type Dirs []string

type Meta

type Meta struct {
	BKFormat        int    `json:"bkformat,omitempty"`
	Date            string `json:"date,omitempty"`
	BlocklistURL    string `json:"blocklist_url,omitempty"`
	BlocklistSHA256 string `json:"blocklist_sha256,omitempty"`
	LookupURL       string `json:"lookup_url,omitempty"`
	LookupSHA256    string `json:"lookup_sha256,omitempty"`
	Blocklists      []Repo `json:"blocklists,omitempty"`
}

func ReadBadKeysManifest

func ReadBadKeysManifest(r io.Reader) (*Meta, error)

type Paths

type Paths []string

type Repo

type Repo struct {
	ID   int    `json:"id,omitempty"`
	Name string `json:"name,omitempty"`
	Type string `json:"type,omitempty"`
	Repo string `json:"repo,omitempty"`
	Path string `json:"path,omitempty"`
}

type Repos

type Repos map[int]Repo

type Result

type Result struct {
	Repo     string
	RepoID   int8
	RepoType string
	RepoPath string
	RepoName string
	KeyPath  string
	Private  bool
	Hash     string
}

func (*Result) GetID

func (r *Result) GetID() string

func (*Result) GetURL

func (r *Result) GetURL() string