github.com/igggame/nebulas-go@v2.1.0+incompatible/crypto/keystore/provider.go (about)

     1  // Copyright (C) 2017 go-nebulas authors
     2  //
     3  // This file is part of the go-nebulas library.
     4  //
     5  // the go-nebulas library is free software: you can redistribute it and/or modify
     6  // it under the terms of the GNU General Public License as published by
     7  // the Free Software Foundation, either version 3 of the License, or
     8  // (at your option) any later version.
     9  //
    10  // the go-nebulas library is distributed in the hope that it will be useful,
    11  // but WITHOUT ANY WARRANTY; without even the implied warranty of
    12  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    13  // GNU General Public License for more details.
    14  //
    15  // You should have received a copy of the GNU General Public License
    16  // along with the go-nebulas library.  If not, see <http://www.gnu.org/licenses/>.
    17  //
    18  
    19  package keystore
    20  
    21  // Provider class represents a "provider" for the
    22  // Security API, where a provider implements some or all parts of
    23  // Security. Services that a provider may implement include:
    24  // Algorithms
    25  // Key generation, conversion, and management facilities (such as for
    26  // algorithm-specific keys).
    27  // Each provider has a name and a version number, and is configured
    28  // in each runtime it is installed in.
    29  type Provider interface {
    30  
    31  	// Aliases all alias in provider save
    32  	Aliases() []string
    33  
    34  	// SetKey assigns the given key (that has already been protected) to the given alias.
    35  	SetKey(a string, key Key, passphrase []byte) error
    36  
    37  	// GetKey returns the key associated with the given alias, using the given
    38  	// password to recover it.
    39  	GetKey(a string, passphrase []byte) (Key, error)
    40  
    41  	// Delete remove key
    42  	Delete(a string) error
    43  
    44  	// ContainsAlias check provider contains key
    45  	ContainsAlias(a string) (bool, error)
    46  
    47  	// Clear all entries in provider
    48  	Clear() error
    49  }