-
Notifications
You must be signed in to change notification settings - Fork 22
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: Public key store/cache for Observer
Implemented a public key storage and cache for the Observer. When verifying a witness proof, the Observer will load the public key of the signer from the cache/database. If it doesn't exist in the DB then the public key is retrieved using the public key fetcher. Also enhanced the BDD test so that, when creating DIDs on multiple targets, the target will be greylisted if it is down and the create will be performed on another target. closes #1261 Signed-off-by: Bob Stasyszyn <Bob.Stasyszyn@securekey.com>
- Loading branch information
1 parent
4425233
commit f71bd68
Showing
9 changed files
with
431 additions
and
33 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,151 @@ | ||
| /* | ||
| Copyright SecureKey Technologies Inc. All Rights Reserved. | ||
| SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
|
|
||
| package publickey | ||
|
|
||
| import ( | ||
| "encoding/json" | ||
| "errors" | ||
| "fmt" | ||
|
|
||
| "github.com/bluele/gcache" | ||
| "github.com/hyperledger/aries-framework-go/pkg/doc/signature/verifier" | ||
| "github.com/hyperledger/aries-framework-go/pkg/doc/verifiable" | ||
| "github.com/hyperledger/aries-framework-go/spi/storage" | ||
| "github.com/trustbloc/edge-core/pkg/log" | ||
| ) | ||
|
|
||
| var logger = log.New("public-key-store") | ||
|
|
||
| const ( | ||
| storeName = "public-key" | ||
| maxCacheSize = 1000 | ||
| ) | ||
|
|
||
| // Store manages a persistent store of public keys for issuers. The store also caches | ||
| // the public keys for better performance. | ||
| type Store struct { | ||
| cache gcache.Cache | ||
| store storage.Store | ||
| fetchPublicKey verifiable.PublicKeyFetcher | ||
| } | ||
|
|
||
| type cacheKey struct { | ||
| issuerID string | ||
| keyID string | ||
| } | ||
|
|
||
| // New returns a new public key store. | ||
| func New(p storage.Provider, fetchPublicKey verifiable.PublicKeyFetcher) (*Store, error) { | ||
| s, err := p.OpenStore(storeName) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("open store [%s]: %w", storeName, err) | ||
| } | ||
|
|
||
| pkStore := &Store{ | ||
| store: s, | ||
| fetchPublicKey: fetchPublicKey, | ||
| } | ||
|
|
||
| pkCache := gcache.New(maxCacheSize).ARC(). | ||
| LoaderFunc( | ||
| func(k interface{}) (interface{}, error) { | ||
| ck := k.(cacheKey) //nolint:errcheck,forcetypeassert | ||
|
|
||
| return pkStore.get(ck.issuerID, ck.keyID) | ||
| }, | ||
| ).Build() | ||
|
|
||
| pkStore.cache = pkCache | ||
|
|
||
| logger.Infof("Created public key store [%s]", storeName) | ||
|
|
||
| return pkStore, nil | ||
| } | ||
|
|
||
| // GetPublicKey returns the public key for the given issuer and key ID. | ||
| func (c *Store) GetPublicKey(issuerID, keyID string) (*verifier.PublicKey, error) { | ||
| pk, err := c.cache.Get(cacheKey{issuerID, keyID}) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| return pk.(*verifier.PublicKey), nil | ||
| } | ||
|
|
||
| func (c *Store) get(issuerID, keyID string) (*verifier.PublicKey, error) { | ||
| logger.Infof("Loading public key into cache for issuer [%s], key ID [%s]", | ||
| issuerID, keyID) | ||
|
|
||
| pk, err := c.getFromDB(issuerID, keyID) | ||
| if err == nil { | ||
| return pk, nil | ||
| } | ||
|
|
||
| if !errors.Is(err, storage.ErrDataNotFound) { | ||
| return nil, fmt.Errorf("get from DB: %w", err) | ||
| } | ||
|
|
||
| logger.Infof("Public key not found in storage. Fetching public key from server for issuer [%s], key ID [%s]", | ||
| issuerID, keyID) | ||
|
|
||
| // Public key not found in storage. Retrieve it from the server. | ||
| pk, err = c.fetchPublicKey(issuerID, keyID) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("fetch public key from server - issuer [%s], key ID [%s]: %w", | ||
| issuerID, keyID, err) | ||
| } | ||
|
|
||
| err = c.putToDB(issuerID, keyID, pk) | ||
| if err != nil { | ||
| // We couldn't store the public key but this shouldn't result in a client error. Just log a warning. | ||
| logger.Warnf("Error storing public key for issuer [%s], key ID [%s]: %s", issuerID, keyID, err) | ||
| } | ||
|
|
||
| return pk, nil | ||
| } | ||
|
|
||
| func (c *Store) getFromDB(issuerID, keyID string) (*verifier.PublicKey, error) { | ||
| key := fmt.Sprintf("%s-%s", issuerID, keyID) | ||
|
|
||
| pkBytes, err := c.store.Get(key) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("get key - issuer [%s], key ID [%s]: %w", issuerID, keyID, err) | ||
| } | ||
|
|
||
| logger.Infof("Public key found in storage for issuer [%s], key ID [%s]", issuerID, keyID) | ||
|
|
||
| pk := &verifier.PublicKey{} | ||
|
|
||
| err = json.Unmarshal(pkBytes, pk) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("unmarshal public key - issuer [%s], key ID [%s]: %w", | ||
| issuerID, keyID, err) | ||
| } | ||
|
|
||
| return pk, nil | ||
| } | ||
|
|
||
| func (c *Store) putToDB(issuerID, keyID string, pk *verifier.PublicKey) error { | ||
| key := fmt.Sprintf("%s-%s", issuerID, keyID) | ||
|
|
||
| pkBytes, err := json.Marshal(pk) | ||
| if err != nil { | ||
| return fmt.Errorf("marshal public key - issuer [%s], key ID [%s]: %w", | ||
| issuerID, keyID, err) | ||
| } | ||
|
|
||
| logger.Infof("Storing public key for issuer [%s], key ID [%s]", | ||
| issuerID, keyID) | ||
|
|
||
| err = c.store.Put(key, pkBytes) | ||
| if err != nil { | ||
| return fmt.Errorf("store public key - issuer [%s], key ID [%s]: %w", | ||
| issuerID, keyID, err) | ||
| } | ||
|
|
||
| return nil | ||
| } |
Oops, something went wrong.