special_keys.go

// Copyright 2015 Keybase, Inc. All rights reserved. Use of
// this source code is governed by the included BSD license.

package libkb

import (
	keybase1 "github.com/keybase/client/go/protocol/keybase1"
)

// SpecialKeyRing holds blessed keys, like the one Keybase uses to sign
// its Merkle Root.
type SpecialKeyRing struct {
	Contextified

	// Cache of keys that are used in verifying the root
	keys map[keybase1.KID]GenericKey

	// The only ones allowed for this purpose
	validKIDs map[keybase1.KID]bool
}

// NewSpecialKeyRing allocates a new SpecialKeyRing with the given
// vector of KIDs. For NaCl keys, it will actually import those
// keys into the Keyring.
func NewSpecialKeyRing(v []keybase1.KID, g *GlobalContext) *SpecialKeyRing {
	ret := &SpecialKeyRing{
		keys:         make(map[keybase1.KID]GenericKey),
		validKIDs:    make(map[keybase1.KID]bool),
		Contextified: NewContextified(g),
	}
	for _, kid := range v {
		if key, _ := ImportKeypairFromKID(kid); key != nil {
			ret.keys[kid] = key
		}
		ret.validKIDs[kid] = true
	}
	return ret

}

// IsValidKID returns if this KID is valid (blessed) according to this Keyring
func (sk *SpecialKeyRing) IsValidKID(kid keybase1.KID) bool {
	val, found := sk.validKIDs[kid]
	return val && found
}

func LoadPGPKeyFromLocalDB(k keybase1.KID, g *GlobalContext) (*PGPKeyBundle, error) {
	dbobj, err := g.LocalDb.Get(DbKey{
		Typ: DBPGPKey,
		Key: k.String(),
	})
	if err != nil {
		return nil, err
	}
	if dbobj == nil {
		return nil, nil
	}
	kb, w, err := GetOneKey(dbobj)
	w.Warn(g)
	return kb, err
}

// Load takes a blessed KID and returns, if possible, the GenericKey
// associated with that KID, for signature verification. If the key isn't
// found in memory or on disk (in the case of PGP), then it will attempt
// to fetch the key from the keybase server.
func (sk *SpecialKeyRing) Load(m MetaContext, kid keybase1.KID) (GenericKey, error) {

	m.Debug("+ SpecialKeyRing.Load(%s)", kid)

	if !sk.IsValidKID(kid) {
		err := UnknownSpecialKIDError{kid}
		return nil, err
	}

	if key, found := sk.keys[kid]; found {
		m.Debug("- SpecialKeyRing.Load(%s) -> hit inmem cache", kid)
		return key, nil
	}

	key, err := LoadPGPKeyFromLocalDB(kid, m.G())

	if err != nil || key == nil {

		m.Debug("| Load(%s) going to network", kid)
		var res *APIRes
		res, err = sk.G().API.Get(m, APIArg{
			Endpoint:    "key/special",
			SessionType: APISessionTypeNONE,
			Args: HTTPArgs{
				"kid": S{kid.String()},
			},
		})
		var w *Warnings
		if err == nil {
			key, w, err = GetOneKey(res.Body.AtKey("bundle"))
		}
		if err == nil {
			w.Warn(sk.G())

			if e2 := key.StoreToLocalDb(m.G()); e2 != nil {
				m.Warning("Failed to store key: %s", e2)
			}
		}
	} else {
		m.Debug("| Load(%s) hit DB-backed cache", kid)
	}

	if err == nil && key != nil {
		sk.keys[kid] = key
	}

	m.Debug("- SpecialKeyRing.Load(%s)", kid)

	return key, err
}