import "github.com/hyperledger/fabric/bccsp"
Copyright IBM Corp. All Rights Reserved.
SPDX-License-Identifier: Apache-2.0
Copyright IBM Corp. 2016 All Rights Reserved.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
aesopts.go bccsp.go ecdsaopts.go hashopts.go idemixerrs.go idemixopts.go keystore.go opts.go
const (
// ECDSA Elliptic Curve Digital Signature Algorithm (key gen, import, sign, verify),
// at default security level.
// Each BCCSP may or may not support default security level. If not supported than
// an error will be returned.
ECDSA = "ECDSA"
// ECDSA Elliptic Curve Digital Signature Algorithm over P-256 curve
ECDSAP256 = "ECDSAP256"
// ECDSA Elliptic Curve Digital Signature Algorithm over P-384 curve
ECDSAP384 = "ECDSAP384"
// ECDSAReRand ECDSA key re-randomization
ECDSAReRand = "ECDSA_RERAND"
// AES Advanced Encryption Standard at the default security level.
// Each BCCSP may or may not support default security level. If not supported than
// an error will be returned.
AES = "AES"
// AES Advanced Encryption Standard at 128 bit security level
AES128 = "AES128"
// AES Advanced Encryption Standard at 192 bit security level
AES192 = "AES192"
// AES Advanced Encryption Standard at 256 bit security level
AES256 = "AES256"
// HMAC keyed-hash message authentication code
HMAC = "HMAC"
// HMACTruncated256 HMAC truncated at 256 bits.
HMACTruncated256 = "HMAC_TRUNCATED_256"
// SHA Secure Hash Algorithm using default family.
// Each BCCSP may or may not support default security level. If not supported than
// an error will be returned.
SHA = "SHA"
// SHA2 is an identifier for SHA2 hash family
SHA2 = "SHA2"
// SHA3 is an identifier for SHA3 hash family
SHA3 = "SHA3"
// SHA256
SHA256 = "SHA256"
// SHA384
SHA384 = "SHA384"
// SHA3_256
SHA3_256 = "SHA3_256"
// SHA3_384
SHA3_384 = "SHA3_384"
// X509Certificate Label for X509 certificate related operation
X509Certificate = "X509Certificate"
)const (
// IDEMIX constant to identify Idemix related algorithms
IDEMIX = "IDEMIX"
)AES128KeyGenOpts contains options for AES key generation at 128 security level
func (opts *AES128KeyGenOpts) Algorithm() string
Algorithm returns the key generation algorithm identifier (to be used).
func (opts *AES128KeyGenOpts) Ephemeral() bool
Ephemeral returns true if the key to generate has to be ephemeral, false otherwise.
AES192KeyGenOpts contains options for AES key generation at 192 security level
func (opts *AES192KeyGenOpts) Algorithm() string
Algorithm returns the key generation algorithm identifier (to be used).
func (opts *AES192KeyGenOpts) Ephemeral() bool
Ephemeral returns true if the key to generate has to be ephemeral, false otherwise.
AES256ImportKeyOpts contains options for importing AES 256 keys.
func (opts *AES256ImportKeyOpts) Algorithm() string
Algorithm returns the key importation algorithm identifier (to be used).
func (opts *AES256ImportKeyOpts) Ephemeral() bool
Ephemeral returns true if the key generated has to be ephemeral, false otherwise.
AES256KeyGenOpts contains options for AES key generation at 256 security level
func (opts *AES256KeyGenOpts) Algorithm() string
Algorithm returns the key generation algorithm identifier (to be used).
func (opts *AES256KeyGenOpts) Ephemeral() bool
Ephemeral returns true if the key to generate has to be ephemeral, false otherwise.
type AESCBCPKCS7ModeOpts struct {
// IV is the initialization vector to be used by the underlying cipher.
// The length of IV must be the same as the Block's block size.
// It is used only if different from nil.
IV []byte
// PRNG is an instance of a PRNG to be used by the underlying cipher.
// It is used only if different from nil.
PRNG io.Reader
}AESCBCPKCS7ModeOpts contains options for AES encryption in CBC mode with PKCS7 padding. Notice that both IV and PRNG can be nil. In that case, the BCCSP implementation is supposed to sample the IV using a cryptographic secure PRNG. Notice also that either IV or PRNG can be different from nil.
AESKeyGenOpts contains options for AES key generation at default security level
func (opts *AESKeyGenOpts) Algorithm() string
Algorithm returns the key generation algorithm identifier (to be used).
func (opts *AESKeyGenOpts) Ephemeral() bool
Ephemeral returns true if the key to generate has to be ephemeral, false otherwise.
type BCCSP interface {
// KeyGen generates a key using opts.
KeyGen(opts KeyGenOpts) (k Key, err error)
// KeyDeriv derives a key from k using opts.
// The opts argument should be appropriate for the primitive used.
KeyDeriv(k Key, opts KeyDerivOpts) (dk Key, err error)
// KeyImport imports a key from its raw representation using opts.
// The opts argument should be appropriate for the primitive used.
KeyImport(raw interface{}, opts KeyImportOpts) (k Key, err error)
// GetKey returns the key this CSP associates to
// the Subject Key Identifier ski.
GetKey(ski []byte) (k Key, err error)
// Hash hashes messages msg using options opts.
// If opts is nil, the default hash function will be used.
Hash(msg []byte, opts HashOpts) (hash []byte, err error)
// GetHash returns and instance of hash.Hash using options opts.
// If opts is nil, the default hash function will be returned.
GetHash(opts HashOpts) (h hash.Hash, err error)
// Sign signs digest using key k.
// The opts argument should be appropriate for the algorithm used.
//
// Note that when a signature of a hash of a larger message is needed,
// the caller is responsible for hashing the larger message and passing
// the hash (as digest).
Sign(k Key, digest []byte, opts SignerOpts) (signature []byte, err error)
// Verify verifies signature against key k and digest
// The opts argument should be appropriate for the algorithm used.
Verify(k Key, signature, digest []byte, opts SignerOpts) (valid bool, err error)
// Encrypt encrypts plaintext using key k.
// The opts argument should be appropriate for the algorithm used.
Encrypt(k Key, plaintext []byte, opts EncrypterOpts) (ciphertext []byte, err error)
// Decrypt decrypts ciphertext using key k.
// The opts argument should be appropriate for the algorithm used.
Decrypt(k Key, ciphertext []byte, opts DecrypterOpts) (plaintext []byte, err error)
}BCCSP is the blockchain cryptographic service provider that offers the implementation of cryptographic standards and algorithms.
type DecrypterOpts interface{}DecrypterOpts contains options for decrypting with a CSP.
ECDSAGoPublicKeyImportOpts contains options for ECDSA key importation from ecdsa.PublicKey
func (opts *ECDSAGoPublicKeyImportOpts) Algorithm() string
Algorithm returns the key importation algorithm identifier (to be used).
func (opts *ECDSAGoPublicKeyImportOpts) Ephemeral() bool
Ephemeral returns true if the key to generate has to be ephemeral, false otherwise.
ECDSAKeyGenOpts contains options for ECDSA key generation.
func (opts *ECDSAKeyGenOpts) Algorithm() string
Algorithm returns the key generation algorithm identifier (to be used).
func (opts *ECDSAKeyGenOpts) Ephemeral() bool
Ephemeral returns true if the key to generate has to be ephemeral, false otherwise.
ECDSAP256KeyGenOpts contains options for ECDSA key generation with curve P-256.
func (opts *ECDSAP256KeyGenOpts) Algorithm() string
Algorithm returns the key generation algorithm identifier (to be used).
func (opts *ECDSAP256KeyGenOpts) Ephemeral() bool
Ephemeral returns true if the key to generate has to be ephemeral, false otherwise.
ECDSAP384KeyGenOpts contains options for ECDSA key generation with curve P-384.
func (opts *ECDSAP384KeyGenOpts) Algorithm() string
Algorithm returns the key generation algorithm identifier (to be used).
func (opts *ECDSAP384KeyGenOpts) Ephemeral() bool
Ephemeral returns true if the key to generate has to be ephemeral, false otherwise.
ECDSAPKIXPublicKeyImportOpts contains options for ECDSA public key importation in PKIX format
func (opts *ECDSAPKIXPublicKeyImportOpts) Algorithm() string
Algorithm returns the key importation algorithm identifier (to be used).
func (opts *ECDSAPKIXPublicKeyImportOpts) Ephemeral() bool
Ephemeral returns true if the key to generate has to be ephemeral, false otherwise.
ECDSAPrivateKeyImportOpts contains options for ECDSA secret key importation in DER format or PKCS#8 format.
func (opts *ECDSAPrivateKeyImportOpts) Algorithm() string
Algorithm returns the key importation algorithm identifier (to be used).
func (opts *ECDSAPrivateKeyImportOpts) Ephemeral() bool
Ephemeral returns true if the key to generate has to be ephemeral, false otherwise.
ECDSAReRandKeyOpts contains options for ECDSA key re-randomization.
func (opts *ECDSAReRandKeyOpts) Algorithm() string
Algorithm returns the key derivation algorithm identifier (to be used).
func (opts *ECDSAReRandKeyOpts) Ephemeral() bool
Ephemeral returns true if the key to generate has to be ephemeral, false otherwise.
func (opts *ECDSAReRandKeyOpts) ExpansionValue() []byte
ExpansionValue returns the re-randomization factor
type EncrypterOpts interface{}EncrypterOpts contains options for encrypting with a CSP.
HMACDeriveKeyOpts contains options for HMAC key derivation.
func (opts *HMACDeriveKeyOpts) Algorithm() string
Algorithm returns the key derivation algorithm identifier (to be used).
func (opts *HMACDeriveKeyOpts) Argument() []byte
Argument returns the argument to be passed to the HMAC
func (opts *HMACDeriveKeyOpts) Ephemeral() bool
Ephemeral returns true if the key to generate has to be ephemeral, false otherwise.
HMACImportKeyOpts contains options for importing HMAC keys.
func (opts *HMACImportKeyOpts) Algorithm() string
Algorithm returns the key importation algorithm identifier (to be used).
func (opts *HMACImportKeyOpts) Ephemeral() bool
Ephemeral returns true if the key generated has to be ephemeral, false otherwise.
HMACTruncated256AESDeriveKeyOpts contains options for HMAC truncated at 256 bits key derivation.
func (opts *HMACTruncated256AESDeriveKeyOpts) Algorithm() string
Algorithm returns the key derivation algorithm identifier (to be used).
func (opts *HMACTruncated256AESDeriveKeyOpts) Argument() []byte
Argument returns the argument to be passed to the HMAC
func (opts *HMACTruncated256AESDeriveKeyOpts) Ephemeral() bool
Ephemeral returns true if the key to generate has to be ephemeral, false otherwise.
type HashOpts interface {
// Algorithm returns the hash algorithm identifier (to be used).
Algorithm() string
}HashOpts contains options for hashing with a CSP.
GetHashOpt returns the HashOpts corresponding to the passed hash function
type IdemixAttribute struct {
// Type is the attribute's type
Type IdemixAttributeType
// Value is the attribute's value
Value interface{}
}IdemixAttributeType represents the type of an idemix attribute
const (
// IdemixHiddenAttribute represents an hidden attribute
IdemixHiddenAttribute IdemixAttributeType = iota
// IdemixStringAttribute represents a sequence of bytes
IdemixBytesAttribute
// IdemixIntAttribute represents an int
IdemixIntAttribute
)type IdemixCRISignerOpts struct {
Epoch int
RevocationAlgorithm RevocationAlgorithm
UnrevokedHandles [][]byte
// H is the hash function to be used
H crypto.Hash
}IdemixCRISignerOpts contains the options to generate an Idemix CRI. The CRI is supposed to be generated by the Issuing authority and can be verified publicly by using the revocation public key.
func (o *IdemixCRISignerOpts) HashFunc() crypto.Hash
type IdemixCredentialRequestSignerOpts struct {
// Attributes contains a list of indices of the attributes to be included in the
// credential. The indices are with the respect to IdemixIssuerKeyGenOpts#AttributeNames.
Attributes []int
// IssuerPK is the public-key of the issuer
IssuerPK Key
// IssuerNonce is generated by the issuer and used by the client to generate the credential request.
// Once the issuer gets the credential requests, it checks that the nonce is the same.
IssuerNonce []byte
// HashFun is the hash function to be used
H crypto.Hash
}IdemixCredentialRequestSignerOpts contains the option to create a Idemix credential request.
func (o *IdemixCredentialRequestSignerOpts) HashFunc() crypto.Hash
func (o *IdemixCredentialRequestSignerOpts) IssuerPublicKey() Key
IssuerPublicKey returns the issuer public key used to derive a new unlinkable pseudonym from a credential secret key
type IdemixCredentialSignerOpts struct {
// Attributes to include in the credentials. IdemixHiddenAttribute is not allowed here
Attributes []IdemixAttribute
// IssuerPK is the public-key of the issuer
IssuerPK Key
// HashFun is the hash function to be used
H crypto.Hash
}IdemixCredentialSignerOpts contains the options to produce a credential starting from a credential request
func (o *IdemixCredentialSignerOpts) HashFunc() crypto.Hash
HashFunc returns an identifier for the hash function used to produce the message passed to Signer.Sign, or else zero to indicate that no hashing was done.
func (o *IdemixCredentialSignerOpts) IssuerPublicKey() Key
const (
IdemixIssuerPublicKeyImporterUnmarshallingError IdemixIIssuerPublicKeyImporterErrorType = iota
IdemixIssuerPublicKeyImporterHashError
IdemixIssuerPublicKeyImporterValidationError
IdemixIssuerPublicKeyImporterNumAttributesError
IdemixIssuerPublicKeyImporterAttributeNameError
)type IdemixIssuerKeyGenOpts struct {
// Temporary tells if the key is ephemeral
Temporary bool
// AttributeNames is a list of attributes
AttributeNames []string
}IdemixIssuerKeyGenOpts contains the options for the Idemix Issuer key-generation. A list of attribytes may be optionally passed
func (*IdemixIssuerKeyGenOpts) Algorithm() string
Algorithm returns the key generation algorithm identifier (to be used).
func (o *IdemixIssuerKeyGenOpts) Ephemeral() bool
Ephemeral returns true if the key to generate has to be ephemeral, false otherwise.
type IdemixIssuerPublicKeyImportOpts struct {
Temporary bool
// AttributeNames is a list of attributes to ensure the import public key has
AttributeNames []string
}IdemixIssuerPublicKeyImportOpts contains the options for importing of an Idemix issuer public key.
func (*IdemixIssuerPublicKeyImportOpts) Algorithm() string
Algorithm returns the key generation algorithm identifier (to be used).
func (o *IdemixIssuerPublicKeyImportOpts) Ephemeral() bool
Ephemeral returns true if the key to generate has to be ephemeral, false otherwise.
type IdemixIssuerPublicKeyImporterError struct {
Type IdemixIIssuerPublicKeyImporterErrorType
ErrorMsg string
Cause error
}func (r *IdemixIssuerPublicKeyImporterError) Error() string
type IdemixNymKeyDerivationOpts struct {
// Temporary tells if the key is ephemeral
Temporary bool
// IssuerPK is the public-key of the issuer
IssuerPK Key
}IdemixNymKeyDerivationOpts contains the options to create a new unlinkable pseudonym from a credential secret key with the respect to the specified issuer public key
func (*IdemixNymKeyDerivationOpts) Algorithm() string
Algorithm returns the key derivation algorithm identifier (to be used).
func (o *IdemixNymKeyDerivationOpts) Ephemeral() bool
Ephemeral returns true if the key to derive has to be ephemeral, false otherwise.
func (o *IdemixNymKeyDerivationOpts) IssuerPublicKey() Key
IssuerPublicKey returns the issuer public key used to derive a new unlinkable pseudonym from a credential secret key
type IdemixNymPublicKeyImportOpts struct {
// Temporary tells if the key is ephemeral
Temporary bool
}IdemixNymPublicKeyImportOpts contains the options to import the public part of a pseudonym
func (*IdemixNymPublicKeyImportOpts) Algorithm() string
Algorithm returns the key derivation algorithm identifier (to be used).
func (o *IdemixNymPublicKeyImportOpts) Ephemeral() bool
Ephemeral returns true if the key to derive has to be ephemeral, false otherwise.
type IdemixNymSignerOpts struct {
// Nym is the pseudonym to be used
Nym Key
// IssuerPK is the public-key of the issuer
IssuerPK Key
// H is the hash function to be used
H crypto.Hash
}IdemixNymSignerOpts contains the options to generate an idemix pseudonym signature.
func (o *IdemixNymSignerOpts) HashFunc() crypto.Hash
HashFunc returns an identifier for the hash function used to produce the message passed to Signer.Sign, or else zero to indicate that no hashing was done.
type IdemixRevocationKeyGenOpts struct {
// Temporary tells if the key is ephemeral
Temporary bool
}IdemixRevocationKeyGenOpts contains the options for the Idemix revocation key-generation.
func (*IdemixRevocationKeyGenOpts) Algorithm() string
Algorithm returns the key generation algorithm identifier (to be used).
func (o *IdemixRevocationKeyGenOpts) Ephemeral() bool
Ephemeral returns true if the key to generate has to be ephemeral, false otherwise.
IdemixRevocationPublicKeyImportOpts contains the options for importing of an Idemix revocation public key.
func (*IdemixRevocationPublicKeyImportOpts) Algorithm() string
Algorithm returns the key generation algorithm identifier (to be used).
func (o *IdemixRevocationPublicKeyImportOpts) Ephemeral() bool
Ephemeral returns true if the key to generate has to be ephemeral, false otherwise.
type IdemixSignerOpts struct {
// Nym is the pseudonym to be used
Nym Key
// IssuerPK is the public-key of the issuer
IssuerPK Key
// Credential is the byte representation of the credential signed by the issuer
Credential []byte
// Attributes specifies which attribute should be disclosed and which not.
// If Attributes[i].Type = IdemixHiddenAttribute
// then the i-th credential attribute should not be disclosed, otherwise the i-th
// credential attribute will be disclosed.
// At verification time, if the i-th attribute is disclosed (Attributes[i].Type != IdemixHiddenAttribute),
// then Attributes[i].Value must be set accordingly.
Attributes []IdemixAttribute
// RhIndex is the index of attribute containing the revocation handler.
// Notice that this attributed cannot be discloused
RhIndex int
// CRI contains the credential revocation information
CRI []byte
// Epoch is the revocation epoch the signature should be produced against
Epoch int
// RevocationPublicKey is the revocation public key
RevocationPublicKey Key
// H is the hash function to be used
H crypto.Hash
}IdemixSignerOpts contains the options to generate an Idemix signature
func (o *IdemixSignerOpts) HashFunc() crypto.Hash
IdemixUserSecretKeyGenOpts contains the options for the generation of an Idemix credential secret key.
func (*IdemixUserSecretKeyGenOpts) Algorithm() string
Algorithm returns the key generation algorithm identifier (to be used).
func (o *IdemixUserSecretKeyGenOpts) Ephemeral() bool
Ephemeral returns true if the key to generate has to be ephemeral, false otherwise.
IdemixUserSecretKeyImportOpts contains the options for importing of an Idemix credential secret key.
func (*IdemixUserSecretKeyImportOpts) Algorithm() string
Algorithm returns the key generation algorithm identifier (to be used).
func (o *IdemixUserSecretKeyImportOpts) Ephemeral() bool
Ephemeral returns true if the key to generate has to be ephemeral, false otherwise.
type Key interface {
// Bytes converts this key to its byte representation,
// if this operation is allowed.
Bytes() ([]byte, error)
// SKI returns the subject key identifier of this key.
SKI() []byte
// Symmetric returns true if this key is a symmetric key,
// false is this key is asymmetric
Symmetric() bool
// Private returns true if this key is a private key,
// false otherwise.
Private() bool
// PublicKey returns the corresponding public key part of an asymmetric public/private key pair.
// This method returns an error in symmetric key schemes.
PublicKey() (Key, error)
}Key represents a cryptographic key
type KeyDerivOpts interface {
// Algorithm returns the key derivation algorithm identifier (to be used).
Algorithm() string
// Ephemeral returns true if the key to derived has to be ephemeral,
// false otherwise.
Ephemeral() bool
}KeyDerivOpts contains options for key-derivation with a CSP.
type KeyGenOpts interface {
// Algorithm returns the key generation algorithm identifier (to be used).
Algorithm() string
// Ephemeral returns true if the key to generate has to be ephemeral,
// false otherwise.
Ephemeral() bool
}KeyGenOpts contains options for key-generation with a CSP.
type KeyImportOpts interface {
// Algorithm returns the key importation algorithm identifier (to be used).
Algorithm() string
// Ephemeral returns true if the key generated has to be ephemeral,
// false otherwise.
Ephemeral() bool
}KeyImportOpts contains options for importing the raw material of a key with a CSP.
type KeyStore interface {
// ReadOnly returns true if this KeyStore is read only, false otherwise.
// If ReadOnly is true then StoreKey will fail.
ReadOnly() bool
// GetKey returns a key object whose SKI is the one passed.
GetKey(ski []byte) (k Key, err error)
// StoreKey stores the key k in this KeyStore.
// If this KeyStore is read only then the method will fail.
StoreKey(k Key) (err error)
}KeyStore represents a storage system for cryptographic keys. It allows to store and retrieve bccsp.Key objects. The KeyStore can be read only, in that case StoreKey will return an error.
RevocationAlgorithm identifies the revocation algorithm
const (
// AlgNoRevocation means no revocation support
AlgNoRevocation RevocationAlgorithm = iota
)type SHA256Opts struct {
}SHA256Opts contains options relating to SHA-256.
func (opts *SHA256Opts) Algorithm() string
Algorithm returns the hash algorithm identifier (to be used).
type SHA384Opts struct {
}SHA384Opts contains options relating to SHA-384.
func (opts *SHA384Opts) Algorithm() string
Algorithm returns the hash algorithm identifier (to be used).
type SHA3_256Opts struct {
}SHA3_256Opts contains options relating to SHA3-256.
func (opts *SHA3_256Opts) Algorithm() string
Algorithm returns the hash algorithm identifier (to be used).
type SHA3_384Opts struct {
}SHA3_384Opts contains options relating to SHA3-384.
func (opts *SHA3_384Opts) Algorithm() string
Algorithm returns the hash algorithm identifier (to be used).
type SHAOpts struct{}SHAOpts contains options for computing SHA.
Algorithm returns the hash algorithm identifier (to be used).
type SignerOpts interface {
crypto.SignerOpts
}SignerOpts contains options for signing with a CSP.
X509PublicKeyImportOpts contains options for importing public keys from an x509 certificate
func (opts *X509PublicKeyImportOpts) Algorithm() string
Algorithm returns the key importation algorithm identifier (to be used).
func (opts *X509PublicKeyImportOpts) Ephemeral() bool
Ephemeral returns true if the key to generate has to be ephemeral, false otherwise.
| Path | Synopsis |
|---|---|
| factory | |
| idemix | |
| idemix/bridge | |
| idemix/handlers | |
| idemix/handlers/mock | Code generated by counterfeiter. |
| mocks | |
| pkcs11 | |
| signer | |
| sw | |
| sw/mocks | |
| utils |
Package bccsp imports 4 packages (graph) and is imported by 240 packages. Updated 2019-12-06. Refresh now. Tools for package owners.