PKI: Enable full usage of REST API to install participation keys (#4002)

* Migrate goal account commands to REST API (#3916)
* PKI: 3924 handle stateproof in rest api goal (#3950)

Some additional refactoring:
* Remove Node Key Monitoring Function
* Removes function which calls loadParticipationKeys() every 60 seconds
  since MakeFull() for the FullNode does the same thing

Co-authored-by: Will Winder <[email protected]>

Author: AlgoStephenAkiki

cmd/goal/account.go

@@ -18,10 +18,12 @@ package libgoal
 
 import (
 	"encoding/json"
+	"errors"
 	"fmt"
 	"io/ioutil"
 	"os"
 	"path/filepath"
+	"time"
 
 	algodclient "github.com/algorand/go-algorand/daemon/algod/api/client"
 	v2 "github.com/algorand/go-algorand/daemon/algod/api/server/v2"
@@ -938,6 +940,30 @@ func (c *Client) GetPendingTransactionsByAddress(addr string, maxTxns uint64) (r
 	return
 }
 
+// VerifyParticipationKey checks if a given participationID is installed in a loop until timeout has elapsed.
+func (c *Client) VerifyParticipationKey(timeout time.Duration, participationID string) error {
+	start := time.Now()
+
+	for {
+		keysResp, err := c.GetParticipationKeys()
+		if err != nil {
+			return err
+		}
+		for _, key := range keysResp {
+			if key.Id == participationID {
+				// Installation successful.
+				return nil
+			}
+		}
+
+		if time.Since(start) > timeout {
+			return errors.New("timeout waiting for key to appear")
+		}
+
+		time.Sleep(1 * time.Second)
+	}
+}
+
 // AddParticipationKey takes a participation key file and sends it to the node.
 // The key will be loaded into the system when the function returns successfully.
 func (c *Client) AddParticipationKey(keyfile string) (resp generated.PostParticipationResponse, err error) {

libgoal/libgoal.go

@@ -18,7 +18,6 @@ package libgoal
 
 import (
 	"fmt"
-	"io/ioutil"
 	"math"
 	"os"
 	"path/filepath"
@@ -27,76 +26,34 @@ import (
 	"github.com/algorand/go-algorand/daemon/algod/api/server/v2/generated"
 	"github.com/algorand/go-algorand/data/account"
 	"github.com/algorand/go-algorand/data/basics"
-	"github.com/algorand/go-algorand/protocol"
 	"github.com/algorand/go-algorand/util/db"
 )
 
 // chooseParticipation chooses which participation keys to use for going online
 // based on the address, round number, and available participation databases
-func (c *Client) chooseParticipation(address basics.Address, round basics.Round) (part account.Participation, err error) {
-	genID, err := c.GenesisID()
+func (c *Client) chooseParticipation(address basics.Address, round basics.Round) (part generated.ParticipationKey, err error) {
+	parts, err := c.ListParticipationKeys()
 	if err != nil {
 		return
 	}
 
-	// Get a list of files in the participation keys directory
-	keyDir := filepath.Join(c.DataDir(), genID)
-	files, err := ioutil.ReadDir(keyDir)
-	if err != nil {
-		return
-	}
-	// This lambda will be used for finding the desired file.
-	checkIfFileIsDesiredKey := func(file os.FileInfo, expiresAfter basics.Round) (part account.Participation, err error) {
-		var handle db.Accessor
-		var partCandidate account.PersistedParticipation
-
-		// If it can't be a participation key database, skip it
-		if !config.IsPartKeyFilename(file.Name()) {
-			return
-		}
-
-		filename := file.Name()
-
-		// Fetch a handle to this database
-		handle, err = db.MakeErasableAccessor(filepath.Join(keyDir, filename))
-		if err != nil {
-			// Couldn't open it, skip it
-			return
-		}
-
-		// Fetch an account.Participation from the database
-		partCandidate, err = account.RestoreParticipation(handle)
-		if err != nil {
-			// Couldn't read it, skip it
-			handle.Close()
-			return
-		}
-		defer partCandidate.Close()
-
-		// Return the Participation valid for this round that relates to the passed address
+	// Loop through each of the participation keys; pick the one that expires farthest in the future.
+	var expiry uint64 = 0
+	for _, info := range parts {
+		// Choose the Participation valid for this round that relates to the passed address
 		// that expires farthest in the future.
 		// Note that algod will sign votes with all possible Participations. so any should work
 		// in the short-term.
 		// In the future we should allow the user to specify exactly which partkeys to register.
-		if partCandidate.FirstValid <= round && round <= partCandidate.LastValid && partCandidate.Parent == address && partCandidate.LastValid > expiresAfter {
-			part = partCandidate.Participation
+		if info.Key.VoteFirstValid <= uint64(round) && uint64(round) <= info.Key.VoteLastValid && info.Address == address.String() && info.Key.VoteLastValid > expiry {
+			part = info
+			expiry = part.Key.VoteLastValid
 		}
-		return
-	}
 
-	// Loop through each of the files; pick the one that expires farthest in the future.
-	var expiry basics.Round
-	for _, info := range files {
-		// Use above lambda so the deferred handle closure happens each loop
-		partCandidate, err := checkIfFileIsDesiredKey(info, expiry)
-		if err == nil && (!partCandidate.Parent.IsZero()) {
-			part = partCandidate
-			expiry = part.LastValid
-		}
 	}
-	if part.Parent.IsZero() {
+	if part.Address == "" {
 		// Couldn't find one
-		err = fmt.Errorf("Couldn't find a participation key database for address %v valid at round %v in directory %v", address.GetUserAddress(), round, keyDir)
+		err = fmt.Errorf("couldn't find a participation key database for address %v valid at round %v in participation registry", address.GetUserAddress(), round)
 		return
 	}
 	return
@@ -117,8 +74,12 @@ func (c *Client) GenParticipationKeys(address string, firstValid, lastValid, key
 }
 
 // GenParticipationKeysTo creates a .partkey database for a given address, fills
-// it with keys, and saves it in the specified output directory.
+// it with keys, and saves it in the specified output directory. If the output
+// directory is empty, the key will be installed.
 func (c *Client) GenParticipationKeysTo(address string, firstValid, lastValid, keyDilution uint64, outDir string) (part account.Participation, filePath string, err error) {
+
+	install := outDir == ""
+
 	// Parse the address
 	parsedAddr, err := basics.UnmarshalChecksumAddress(address)
 	if err != nil {
@@ -127,16 +88,9 @@ func (c *Client) GenParticipationKeysTo(address string, firstValid, lastValid, k
 
 	firstRound, lastRound := basics.Round(firstValid), basics.Round(lastValid)
 
-	// If output directory wasn't specified, store it in the current ledger directory.
-	if outDir == "" {
-		// Get the GenesisID for use in the participation key path
-		var genID string
-		genID, err = c.GenesisID()
-		if err != nil {
-			return
-		}
-
-		outDir = filepath.Join(c.DataDir(), genID)
+	// If we are installing, generate in the temp dir
+	if install {
+		outDir = os.TempDir()
 	}
 	// Connect to the database
 	partKeyPath, err := participationKeysPath(outDir, parsedAddr, firstRound, lastRound)
@@ -152,6 +106,14 @@ func (c *Client) GenParticipationKeysTo(address string, firstValid, lastValid, k
 		return
 	}
 
+	// If the key is being installed, remove it afterwards.
+	if install {
+		// Explicitly ignore any errors
+		defer func(name string) {
+			_ = os.Remove(name)
+		}(partKeyPath)
+	}
+
 	partdb, err := db.MakeErasableAccessor(partKeyPath)
 	if err != nil {
 		return
@@ -165,79 +127,15 @@ func (c *Client) GenParticipationKeysTo(address string, firstValid, lastValid, k
 	newPart, err := account.FillDBWithParticipationKeys(partdb, parsedAddr, firstRound, lastRound, keyDilution)
 	part = newPart.Participation
 	partdb.Close()
-	return part, partKeyPath, err
-}
-
-// InstallParticipationKeys creates a .partkey database for a given address,
-// based on an existing database from inputfile.  On successful install, it
-// deletes the input file.
-func (c *Client) InstallParticipationKeys(inputfile string) (part account.Participation, filePath string, err error) {
-	proto, ok := c.consensus[protocol.ConsensusCurrentVersion]
-	if !ok {
-		err = fmt.Errorf("Unknown consensus protocol %s", protocol.ConsensusCurrentVersion)
-		return
-	}
-
-	// Get the GenesisID for use in the participation key path
-	var genID string
-	genID, err = c.GenesisID()
-	if err != nil {
-		return
-	}
-
-	outDir := filepath.Join(c.DataDir(), genID)
-
-	inputdb, err := db.MakeErasableAccessor(inputfile)
-	if err != nil {
-		return
-	}
-	defer inputdb.Close()
-
-	partkey, err := account.RestoreParticipationWithSecrets(inputdb)
-	if err != nil {
-		return
-	}
-
-	if partkey.Parent == (basics.Address{}) {
-		err = fmt.Errorf("Cannot install partkey with missing (zero) parent address")
-		return
-	}
-
-	newdbpath, err := participationKeysPath(outDir, partkey.Parent, partkey.FirstValid, partkey.LastValid)
-	if err != nil {
-		return
-	}
 
-	newdb, err := db.MakeErasableAccessor(newdbpath)
 	if err != nil {
 		return
 	}
 
-	newpartkey := partkey
-	newpartkey.Store = newdb
-	err = newpartkey.PersistWithSecrets()
-	if err != nil {
-		newpartkey.Close()
-		return
+	if install {
+		_, err = c.AddParticipationKey(partKeyPath)
 	}
-
-	// After successful install, remove the input copy of the
-	// partkey so that old keys cannot be recovered after they
-	// are used by algod.  We try to delete the data inside
-	// sqlite first, so the key material is zeroed out from
-	// disk blocks, but regardless of whether that works, we
-	// delete the input file.  The consensus protocol version
-	// is irrelevant for the maxuint64 round number we pass in.
-	errCh := partkey.DeleteOldKeys(basics.Round(math.MaxUint64), proto)
-	err = <-errCh
-	if err != nil {
-		newpartkey.Close()
-		return
-	}
-	os.Remove(inputfile)
-	part = newpartkey.Participation
-	newpartkey.Close()
-	return part, newdbpath, nil
+	return part, partKeyPath, err
 }
 
 // ListParticipationKeys returns the available participation keys,
@@ -249,49 +147,3 @@ func (c *Client) ListParticipationKeys() (partKeyFiles generated.ParticipationKe
 	}
 	return
 }
-
-// ListParticipationKeyFiles returns the available participation keys,
-// as a map from database filename to Participation key object.
-func (c *Client) ListParticipationKeyFiles() (partKeyFiles map[string]account.Participation, err error) {
-	genID, err := c.GenesisID()
-	if err != nil {
-		return
-	}
-
-	// Get a list of files in the participation keys directory
-	keyDir := filepath.Join(c.DataDir(), genID)
-	files, err := ioutil.ReadDir(keyDir)
-	if err != nil {
-		return
-	}
-
-	partKeyFiles = make(map[string]account.Participation)
-	for _, file := range files {
-		// If it can't be a participation key database, skip it
-		if !config.IsPartKeyFilename(file.Name()) {
-			continue
-		}
-
-		filename := file.Name()
-
-		// Fetch a handle to this database
-		handle, err := db.MakeErasableAccessor(filepath.Join(keyDir, filename))
-		if err != nil {
-			// Couldn't open it, skip it
-			continue
-		}
-
-		// Fetch an account.Participation from the database
-		part, err := account.RestoreParticipation(handle)
-		if err != nil {
-			// Couldn't read it, skip it
-			handle.Close()
-			continue
-		}
-
-		partKeyFiles[filename] = part.Participation
-		part.Close()
-	}
-
-	return
-}