CryptoSuite (java-sdk 3.8.0 API)

java.lang.Object
- org.fisco.bcos.sdk.v3.crypto.CryptoSuite

public class CryptoSuite
extends java.lang.Object

字段概要

字段
限定符和类型字段和说明

int cryptoTypeConfig

Hash hashImpl

Signature signatureImpl

字段
限定符和类型	字段和说明
`int`	`cryptoTypeConfig`
`Hash`	`hashImpl`
`Signature`	`signatureImpl`

构造器概要

构造器
构造器和说明
`CryptoSuite(int cryptoTypeConfig)` Init the common crypto implementation according to the crypto type
`CryptoSuite(int cryptoTypeConfig, ConfigOption configOption)` init CryptoSuite
`CryptoSuite(int cryptoTypeConfig, CryptoKeyPair cryptoKeyPair)`
`CryptoSuite(int cryptoTypeConfig, java.lang.String hexedPrivateKey)`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`void`	`destroy()`
`CryptoKeyPair`	`generateRandomKeyPair()` Create key pair
`ConfigOption`	`getConfig()` Get configuration
`CryptoKeyPair`	`getCryptoKeyPair()` Get the key pair of the CryptoSuite
`int`	`getCryptoTypeConfig()`
`Hash`	`getHashImpl()` Get hash function, which is relate to the configured CryptoType
`CryptoKeyPair`	`getKeyPairFactory()` Get key pair factory
`Signature`	`getSignatureImpl()`
`byte[]`	`hash(byte[] inputBytes)` Call hash function
`java.lang.String`	`hash(java.lang.String inputData)` Call hash function
`void`	`initCryptoSuite(int cryptoTypeConfig)`
`void`	`loadAccount(java.lang.String accountFileFormat, java.lang.String accountFilePath, java.lang.String password)` Load account from file
`CryptoKeyPair`	`loadHsmKeyPair()` Create key pair from a private key string
`CryptoKeyPair`	`loadKeyPair(java.security.KeyPair keyPair)` Create CryptoKeyPair type key pair from KeyPair type key pair
`CryptoKeyPair`	`loadKeyPair(java.lang.String hexedPrivateKey)` Create key pair from a private key string
`java.lang.String`	`recoverAddress(byte[] msgHash, SignatureResult signature)` recover address from signature
`java.lang.String`	`recoverAddress(java.lang.String msgHash, SignatureResult signature)` recover address from signature
`void`	`setConfig(ConfigOption config)` Set config
`void`	`setCryptoKeyPair(CryptoKeyPair cryptoKeyPair)` Set the key pair in CryptoSuite
`SignatureResult`	`sign(byte[] message, CryptoKeyPair keyPair)` Do signature
`java.lang.String`	`sign(KeyTool keyTool, java.lang.String message)` Do signature, used in AMOP private topic verification procedure
`SignatureResult`	`sign(java.lang.String message, CryptoKeyPair keyPair)` Do signature
`boolean`	`verify(KeyTool keyTool, byte[] message, byte[] signature)` Verify signature, used in AMOP private topic verification procedure
`boolean`	`verify(KeyTool keyTool, java.lang.String message, java.lang.String signature)` Verify signature, used in AMOP private topic verification procedure
`boolean`	`verify(java.lang.String publicKey, byte[] message, byte[] signature)` Verify signature
`boolean`	`verify(java.lang.String publicKey, java.lang.String message, java.lang.String signature)` Verify signature

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - cryptoTypeConfig
```
public int cryptoTypeConfig
```
  - signatureImpl
```
public Signature signatureImpl
```
  - hashImpl
```
public Hash hashImpl
```
- 构造器详细资料
  - CryptoSuite
```
public CryptoSuite(int cryptoTypeConfig,
                   CryptoKeyPair cryptoKeyPair)
```
  - CryptoSuite
```
public CryptoSuite(int cryptoTypeConfig,
                   java.lang.String hexedPrivateKey)
```
  - CryptoSuite
```
public CryptoSuite(int cryptoTypeConfig,
                   ConfigOption configOption)
```
    init CryptoSuite
    
    参数:
    
    cryptoTypeConfig - the crypto type, e.g. ECDSA_TYPE or SM_TYPE
    
    configOption - the configuration of account.
  - CryptoSuite
```
public CryptoSuite(int cryptoTypeConfig)
```
    Init the common crypto implementation according to the crypto type
    
    参数:
    
    cryptoTypeConfig - the crypto type config number
- 方法详细资料
  - initCryptoSuite
```
public void initCryptoSuite(int cryptoTypeConfig)
```
  - loadAccount
```
public void loadAccount(java.lang.String accountFileFormat,
                        java.lang.String accountFilePath,
                        java.lang.String password)
```
    Load account from file
    
    参数:
    
    accountFileFormat - file format, e.g. p21, pem
    
    accountFilePath - file path
    
    password - password of the key file
  - setConfig
```
public void setConfig(ConfigOption config)
```
    Set config
    
    参数:
    
    config - ConfigOption type configuration
  - getCryptoTypeConfig
```
public int getCryptoTypeConfig()
```
  - getSignatureImpl
```
public Signature getSignatureImpl()
```
  - getHashImpl
```
public Hash getHashImpl()
```
    Get hash function, which is relate to the configured CryptoType
    
    返回:
    
    the hash function
  - hash
```
public java.lang.String hash(java.lang.String inputData)
```
    Call hash function
    
    参数:
    
    inputData - string type input data
    
    返回:
    
    the hash digest of input data
  - hash
```
public byte[] hash(byte[] inputBytes)
```
    Call hash function
    
    参数:
    
    inputBytes - byte array type input data
    
    返回:
    
    the hashed string
  - sign
```
public SignatureResult sign(byte[] message,
                            CryptoKeyPair keyPair)
```
    Do signature
    
    参数:
    
    message - byte array type input string, must be a digest
    
    keyPair - key pair used to do signature
    
    返回:
    
    the signature errorCode
  - sign
```
public SignatureResult sign(java.lang.String message,
                            CryptoKeyPair keyPair)
```
    Do signature
    
    参数:
    
    message - string type input message, must be a digest
    
    keyPair - key pair used to do signature
    
    返回:
    
    the signature errorCode
  - sign
```
public java.lang.String sign(KeyTool keyTool,
                             java.lang.String message)
```
    Do signature, used in AMOP private topic verification procedure
    
    参数:
    
    keyTool - the key
    
    message - the string type input message, must be a digest
    
    返回:
    
    the string type signature
  - verify
```
public boolean verify(KeyTool keyTool,
                      java.lang.String message,
                      java.lang.String signature)
```
    Verify signature, used in AMOP private topic verification procedure
    
    参数:
    
    keyTool - the key
    
    message - the string type input message, must be a digest
    
    signature - the string type signature
    
    返回:
    
    the verify errorCode
  - verify
```
public boolean verify(KeyTool keyTool,
                      byte[] message,
                      byte[] signature)
```
    Verify signature, used in AMOP private topic verification procedure
    
    参数:
    
    keyTool - the key
    
    message - the byte array type input message, must be a digest
    
    signature - the byte array type signature
    
    返回:
    
    the verify errorCode
  - verify
```
public boolean verify(java.lang.String publicKey,
                      java.lang.String message,
                      java.lang.String signature)
```
    Verify signature
    
    参数:
    
    publicKey - the string type public key
    
    message - the string type input message, must be a digest
    
    signature - the string type signature
    
    返回:
    
    the verify errorCode
  - verify
```
public boolean verify(java.lang.String publicKey,
                      byte[] message,
                      byte[] signature)
```
    Verify signature
    
    参数:
    
    publicKey - the string type public key
    
    message - the byte array type input message, must be a digest
    
    signature - the byte array type signature
    
    返回:
    
    the verify errorCode
  - recoverAddress
```
public java.lang.String recoverAddress(java.lang.String msgHash,
                                       SignatureResult signature)
```
    recover address from signature
    
    参数:
    
    msgHash - the message hash, must be a digest
    
    signature - the signature to be recovered
    
    返回:
    
    the public key whitch can verify signature.
  - recoverAddress
```
public java.lang.String recoverAddress(byte[] msgHash,
                                       SignatureResult signature)
```
    recover address from signature
    
    参数:
    
    msgHash - the byte array type message hash, must be a digest
    
    signature - the byte array type signature to be recovered
    
    返回:
    
    the public key whitch can verify signature.
  - generateRandomKeyPair
```
public CryptoKeyPair generateRandomKeyPair()
```
    Create key pair
    
    返回:
    
    a generated key pair
  - loadKeyPair
```
public CryptoKeyPair loadKeyPair(java.security.KeyPair keyPair)
```
    Create CryptoKeyPair type key pair from KeyPair type key pair
    
    参数:
    
    keyPair - key pair
    
    返回:
    
    CryptoKeyPair type key pair
  - loadKeyPair
```
public CryptoKeyPair loadKeyPair(java.lang.String hexedPrivateKey)
```
    Create key pair from a private key string
    
    参数:
    
    hexedPrivateKey - a hex string of private key
    
    返回:
    
    CryptoKeyPair type key pair
  - loadHsmKeyPair
```
public CryptoKeyPair loadHsmKeyPair()
```
    Create key pair from a private key string
    
    返回:
    
    CryptoKeyPair type key pair
  - setCryptoKeyPair
```
public void setCryptoKeyPair(CryptoKeyPair cryptoKeyPair)
```
    Set the key pair in CryptoSuite
    
    参数:
    
    cryptoKeyPair - set the CryptoKeyPair object
  - getCryptoKeyPair
```
public CryptoKeyPair getCryptoKeyPair()
```
    Get the key pair of the CryptoSuite
    
    返回:
    
    CrytoKeyPair type key pair
  - getConfig
```
public ConfigOption getConfig()
```
    Get configuration
    
    返回:
    
    ConfigOption
  - getKeyPairFactory
```
public CryptoKeyPair getKeyPairFactory()
```
    Get key pair factory
    
    返回:
    
    CryptoKeyPair
  - destroy
```
public void destroy()
```

类 CryptoSuite

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

cryptoTypeConfig

signatureImpl

hashImpl

构造器详细资料

CryptoSuite

CryptoSuite

CryptoSuite

CryptoSuite

方法详细资料

initCryptoSuite

loadAccount

setConfig

getCryptoTypeConfig

getSignatureImpl

getHashImpl

hash

hash

sign

sign

sign

verify

verify

verify

verify

recoverAddress

recoverAddress

generateRandomKeyPair

loadKeyPair

loadKeyPair

loadHsmKeyPair

setCryptoKeyPair

getCryptoKeyPair

getConfig

getKeyPairFactory

destroy