ZoroAPI (mychainx-sdk-java-all 0.10.2.24.9 API)

java.lang.Object
- com.alipay.mychain.zoro.ZoroAPI

```
public class ZoroAPI
extends Object
```
版本:

$Id: ZoroAPI.java, v 0.1 2019-01-16 14:38 blma Exp $$

作者:

baoli.mbl

构造器概要

构造器
构造器和说明

ZoroAPI()

构造器
构造器和说明
`ZoroAPI()`

方法概要

所有方法静态方法具体方法
限定符和类型	方法和说明
`static List<String>`	`decrypt(List<String> ciphertextList, String envelop, byte[] keyName, byte[] password)` Returns an list of plaintext string which is decrypted from ciphertextList.
`static String`	`decrypt(String ciphertext, String envelop, byte[] keyName, byte[] password)` Returns an plaintext string which is decrypted from ciphertext.
`static List<Note>`	`decryptAndVerifyCommitment(List<String> commitmentList, List<String> encryptedValueList, List<String> encryptedBlindFactorList, String envelop, byte[] keyName, byte[] password)` Decrypts the encrypted blind factor and value of each pedersen commitment and verify the commitment is whether matched or not.
`static Note`	`decryptAndVerifyCommitment(String commitment, String encryptedValue, String encryptedBlindFactor, String envelop, byte[] keyName, byte[] password)` Decrypts the encrypted blind factor and value of a pedersen commitment and verify the commitment is whether matched or not.
`static String`	`ecdsaSign(byte[] message, byte[] keyName, byte[] password)` Returns the signature of a message.
`static boolean`	`ecdsaverify(ECPublicKey pubkey, byte[] message, String signature)` Verify the signature based on public key and message.
`static String`	`generateBlindFactor()` Return a 32-bytes blind factor encoded by Base64
`static void`	`initZoroCryptoSpi(CryptoServiceSpi cryptoServiceSpi)`
`static void`	`initZoroKeyManagementSpi(KeyManagementSpi keyManagementSpi)`
`static String`	`mapPlainToPrivacy(Object obj)` Returns an json string which is encrypted from obj.
`static <T> T`	`mapPlainToPrivacy(Object obj, Class<T> clazz)` Returns an encrypted object which is encrypted from obj.
`static <T> T`	`mapPlainToPrivacyIndirectly(Object obj, Class<T> clazz)` Returns an encrypted object which is encrypted from obj.
`static <T> T`	`mapPrivacyToPlain(Object obj, Class<T> clazz, String selfId, byte[] keyName, byte[] password)` Returns an plaintext object which is decrypted from obj.
`static boolean`	`verifyCommitment(String commitment, String blindFactor, long value)` Verify commitment is correct with plain blind factor and plain value.
`static Note`	`verifyCommitmentChange(String pc, String blindFactor, long value, byte[] keyName, byte[] password, List<? extends EncryptedTuple> positiveTuples, List<? extends EncryptedTuple> negativeTuples)`
`static Note`	`verifyCommitmentChange(String pc, String blindFactor, long value, List<? extends PlainTuple> positiveTuples, List<? extends PlainTuple> negativeTuples)` verify commitment change and accumulate blind factor and value

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

- 构造器详细资料
  - ZoroAPI
```
public ZoroAPI()
```
- 方法详细资料
  - initZoroKeyManagementSpi
```
public static void initZoroKeyManagementSpi(KeyManagementSpi keyManagementSpi)
                                     throws ZoroException
```
    参数:
    
    keyManagementSpi - the Key Management Spi, not null
    
    抛出:
    
    ZoroException
  - initZoroCryptoSpi
```
public static void initZoroCryptoSpi(CryptoServiceSpi cryptoServiceSpi)
                              throws ZoroException
```
    参数:
    
    cryptoServiceSpi - the Crypto Service Spi, not null
    
    抛出:
    
    ZoroException
  - generateBlindFactor
```
public static String generateBlindFactor()
                                  throws ZoroException
```
    Return a 32-bytes blind factor encoded by Base64
    
    返回:
    
    java.lang.String
    
    抛出:
    
    ZoroException
  - mapPlainToPrivacy
```
public static <T> T mapPlainToPrivacy(Object obj,
                                      Class<T> clazz)
                               throws ZoroException
```
    Returns an encrypted object which is encrypted from obj. The returned object is specified or described by the clazz. The encryption rules is described by annotations ApplyEnvelope, CommitmentRelation and ProofList.
    
    参数:
    
    obj - the object to be encrypted
    
    clazz - describe an encrypted object
    
    返回:
    
    T the encrypted object which is encrypted from obj
    
    抛出:
    
    ZoroException
  - mapPlainToPrivacy
```
public static String mapPlainToPrivacy(Object obj)
                                throws ZoroException
```
    Returns an json string which is encrypted from obj. The encryption rules is described by annotations ApplyEnvelope, CommitmentRelation and ProofList.
    
    参数:
    
    obj - the object to be encrypted
    
    返回:
    
    java.lang.String the json string which is encrypted from obj
    
    抛出:
    
    ZoroException
  - mapPlainToPrivacyIndirectly
```
public static <T> T mapPlainToPrivacyIndirectly(Object obj,
                                                Class<T> clazz)
                                         throws ZoroException
```
    Returns an encrypted object which is encrypted from obj. The returned object is specified or described by the clazz. The encryption rules is described by annotations ApplyEnvelope, CommitmentRelation and ProofList.
    This method is implemented using fastjson, and its function is the same as mapPlainToPrivacy() with the sane parameters.
    
    参数:
    
    obj - the object to be encrypted
    
    clazz - describe an encrypted object
    
    返回:
    
    the encrypted object which is encrypted from obj
    
    抛出:
    
    ZoroException
  - mapPrivacyToPlain
```
public static <T> T mapPrivacyToPlain(Object obj,
                                      Class<T> clazz,
                                      String selfId,
                                      byte[] keyName,
                                      byte[] password)
                               throws ZoroException
```
    Returns an plaintext object which is decrypted from obj. The returned object is specified or described by the clazz. The encryption rules is described by annotations ApplyEnvelope. Because there is consistent one-to-one match between plaintext and ciphertext, the clazz can be the same as the class of obj.
    
    参数:
    
    obj - the object to be decrypted
    
    clazz - describe an plaintext object
    
    selfId - the id of the caller, also is the member id
    
    keyName - the keyname of the caller, which is used to get the real private key
    
    password - the password of the caller, which is used to get the real private key
    
    返回:
    
    T the plaintext object is decrypted from obj
    
    抛出:
    
    ZoroException
  - decrypt
```
public static String decrypt(String ciphertext,
                             String envelop,
                             byte[] keyName,
                             byte[] password)
                      throws ZoroException
```
    Returns an plaintext string which is decrypted from ciphertext.
    
    参数:
    
    ciphtetext - the ciphertext need to be decrypted
    
    envelop - the corresponding envelop for ciphertext
    
    keyName - the keyname of the caller, which is used to get the real private key
    
    password - the password of the caller, which is used to get the real private key
    
    返回:
    
    java.lang.String the plaintext string decrypted from ciphertext
    
    抛出:
    
    ZoroException
  - decrypt
```
public static List<String> decrypt(List<String> ciphertextList,
                                   String envelop,
                                   byte[] keyName,
                                   byte[] password)
                            throws ZoroException
```
    Returns an list of plaintext string which is decrypted from ciphertextList.
    
    参数:
    
    ciphertextList - the list of ciphertext need to be decrypted
    
    envelop - the corresponding envelop for ciphertext
    
    keyName - the keyname of the caller, which is used to get the real private key
    
    password - the password of the caller, which is used to get the real private key
    
    返回:
    
    java.util.List the list of plaintext string
    
    抛出:
    
    ZoroException
  - decryptAndVerifyCommitment
```
public static List<Note> decryptAndVerifyCommitment(List<String> commitmentList,
                                                    List<String> encryptedValueList,
                                                    List<String> encryptedBlindFactorList,
                                                    String envelop,
                                                    byte[] keyName,
                                                    byte[] password)
                                             throws ZoroException
```
    Decrypts the encrypted blind factor and value of each pedersen commitment and verify the commitment is whether matched or not. Also, constructs a Note object for each pedersen commitment and returns.
    
    参数:
    
    commitmentList - a list of pedersen commitment
    
    encryptedValueList - a list of encrypted blind factor
    
    encryptedBlindFactorList - a list of encrypted value
    
    envelop - the corresponding envelop for encrypted blind factor and value
    
    keyName - the keyname of the caller, which is used to get the real private key
    
    password - the password of the caller, which is used to get the real private key
    
    返回:
    
    java.util.List a list of Note
    
    抛出:
    
    ZoroException
    
    另请参阅:
    
    Note
  - decryptAndVerifyCommitment
```
public static Note decryptAndVerifyCommitment(String commitment,
                                              String encryptedValue,
                                              String encryptedBlindFactor,
                                              String envelop,
                                              byte[] keyName,
                                              byte[] password)
                                       throws ZoroException
```
    Decrypts the encrypted blind factor and value of a pedersen commitment and verify the commitment is whether matched or not. Also, constructs a Note object for the pedersen commitment and returns.
    
    参数:
    
    commitment - a pedersen commitment
    
    encryptedValue - an encrypted blind factor
    
    encryptedBlindFactor - an encrypted value
    
    envelop - the corresponding envelop for encrypted blind factor and value
    
    keyName - the keyname of the caller, which is used to get the real private key
    
    password - the password of the caller, which is used to get the real private key
    
    返回:
    
    com.alipay.mychain.zoro.annotation.privacy.Note a Note
    
    抛出:
    
    ZoroException
    
    另请参阅:
    
    Note
  - verifyCommitment
```
public static boolean verifyCommitment(String commitment,
                                       String blindFactor,
                                       long value)
                                throws ZoroException
```
    Verify commitment is correct with plain blind factor and plain value.
    
    参数:
    
    commitment - a pedersen commitment
    
    blindFactor - a blind factor
    
    value - a value
    
    返回:
    
    boolean true for correct, false for the others
    
    抛出:
    
    ZoroException
  - verifyCommitmentChange
```
public static Note verifyCommitmentChange(String pc,
                                          String blindFactor,
                                          long value,
                                          byte[] keyName,
                                          byte[] password,
                                          List<? extends EncryptedTuple> positiveTuples,
                                          List<? extends EncryptedTuple> negativeTuples)
                                   throws ZoroException
```
    参数:
    
    -
    
    pc - a pedersen commitment, the final commitment
    
    r - a init plain blind factor
    
    v - a init plain value
    
    keyName - the keyname of the caller, which is used to get the real private key
    
    password - the password of the caller, which is used to get the real private key
    
    positiveTuples - positive tuples
    
    negativeTuples - negative tuples
    
    返回:
    
    com.alipay.mychain.zoro.annotation.privacy.Note a Note
    
    抛出:
    
    ZoroException
    
    另请参阅:
    
    Note, EncryptedTuple
  - verifyCommitmentChange
```
public static Note verifyCommitmentChange(String pc,
                                          String blindFactor,
                                          long value,
                                          List<? extends PlainTuple> positiveTuples,
                                          List<? extends PlainTuple> negativeTuples)
                                   throws ZoroException
```
    verify commitment change and accumulate blind factor and value
    
    参数:
    
    pc - a pedersen commitment, the final commitment
    
    blindFactor - a init plain blind factor
    
    value - a init plain value
    
    positiveTuples - positive tuples
    
    negativeTuples - negative tuples
    
    返回:
    
    com.alipay.mychain.zoro.annotation.privacy.Note a Note
    
    抛出:
    
    ZoroException
    
    另请参阅:
    
    Note, PlainTuple
  - ecdsaSign
```
public static String ecdsaSign(byte[] message,
                               byte[] keyName,
                               byte[] password)
                        throws ZoroException
```
    Returns the signature of a message.
    
    参数:
    
    message - the message to be signed
    
    keyName - the keyname of the caller, which is used to get the real private key
    
    password - the password of the caller, which is used to get the real private key
    
    返回:
    
    java.lang.String the signature of the message
    
    抛出:
    
    ZoroException
  - ecdsaverify
```
public static boolean ecdsaverify(ECPublicKey pubkey,
                                  byte[] message,
                                  String signature)
                           throws ZoroException
```
    Verify the signature based on public key and message.
    
    参数:
    
    pubkey - the public key
    
    message - the message is sighed
    
    signature - the corresponding signature for message
    
    返回:
    
    boolean true for correct, false for the others
    
    抛出:
    
    ZoroException

类 ZoroAPI

构造器概要

方法概要

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

构造器详细资料

ZoroAPI

方法详细资料

initZoroKeyManagementSpi

initZoroCryptoSpi

generateBlindFactor

mapPlainToPrivacy

mapPlainToPrivacy

mapPlainToPrivacyIndirectly

mapPrivacyToPlain

decrypt

decrypt

decryptAndVerifyCommitment

decryptAndVerifyCommitment

verifyCommitment

verifyCommitmentChange

verifyCommitmentChange

ecdsaSign

ecdsaverify