账户密钥管理工具¶

标签：java-sdk 设置账户

Java SDK提供账户管理接口，支持以下功能：

账户加载: 从指定路径加载账户，同时支持pem和p12格式的账户文件加载，也支持加载十六进制的私钥字符串
账户生成: 随机生成账户公私钥对
账户保存: 保存账户信息
提供加载p12和pem文件解析的接口

注解

Java SDK提供了接口级别的账户生成方法，工具级别的账户生成脚本请参考 get_account.sh脚本 .

1. 账户加载¶

Java SDK的org.fisco.bcos.sdk.v3.crypto.CryptoSuite提供账户加载功能，默认从配置文件的[account]配置项加载交易发送账户，具体请参考这里.

1.1 从十六进制私钥字符串加载账户¶

从十六进制私钥字符串加载账户的示例如下：

/* 示例一：创建cryptoSuite，通过CryptoSuite加载私钥字符串 ****/
// cryptoType: 用于需要指定加载的私钥类型
// hexPrivateKey: 十六进制的私钥字符串
public CryptoKeyPair loadAccountFromHexPrivateKey(int cryptoType, String hexPrivateKey)
{
    // 根据cryptoType创建cryptoSuite，cryptoType目前支持：
    // 1. CryptoType.ECDSA_TYPE: 用于创建非国密类型的CryptoSuite
    // 2. CryptoType.SM_TYPE:    用于创建国密类型的CryptoSuite
    CryptoSuite cryptoSuite = new CryptoSuite(cryptoType);
    // 从十六进制私钥字符串hexPrivateKey加载私钥对象
    return cryptoSuite.getKeyPairFactory().createKeyPair(hexPrivateKey);
}

/* 示例二：直接加载非国密私钥 ****/
public CryptoKeyPair loadECDSAAccountFromHexPrivateKey(String hexPrivateKey)
{
    // 创建国密类型的KeyFactory
    ECDSAKeyPair keyFacotry = new ECDSAKeyPair();
    // 从十六进制字符串加载hexPrivateKey
    return keyFacotry.createKeyPair(hexPrivateKey);
}

/* 示例三：直接加载国密私钥 ****/
public CryptoKeyPair loadGMAccountFromHexPrivateKey(String hexPrivateKey)
{
    // 创建国密类型的KeyFactory
    SM2KeyPair keyFacotry = new SM2KeyPair();
    // 从十六进制字符串加载hexPrivateKey
    return keyFacotry.createKeyPair(hexPrivateKey);
}

1.2 从大整数私钥加载账户¶

从大整数私钥加载账户的示例如下：

/* 示例一：创建cryptoSuite，通过CryptoSuite加载私钥字符串 ****/
// cryptoType: 用于需要指定加载的私钥类型
// privateKey: 私钥
public CryptoKeyPair loadAccountFromHexPrivateKey(int cryptoType, BigInteger privateKey)
{
    // 根据cryptoType创建cryptoSuite，cryptoType目前支持：
    // 1. CryptoType.ECDSA_TYPE: 用于创建非国密类型的CryptoSuite
    // 2. CryptoType.SM_TYPE:    用于创建国密类型的CryptoSuite
    CryptoSuite cryptoSuite = new CryptoSuite(cryptoType);
    // 从十六进制私钥字符串hexPrivateKey加载私钥对象
    return cryptoSuite.getKeyPairFactory().createKeyPair(privateKey);
}

/* 示例二：直接加载非国密私钥 ****/
public CryptoKeyPair loadECDSAAccountFromHexPrivateKey(BigInteger privateKey)
{
    // 创建国密类型的KeyFactory
    ECDSAKeyPair keyFacotry = new ECDSAKeyPair();
    // 从十六进制字符串加载hexPrivateKey
    return keyFacotry.createKeyPair(privateKey);
}

/* 示例三：直接加载国密私钥 ****/
public CryptoKeyPair loadGMAccountFromHexPrivateKey(BigInteger privateKey)
{
    // 创建国密类型的KeyFactory
    SM2KeyPair keyFacotry = new SM2KeyPair();
    // 从十六进制字符串加载hexPrivateKey
    return keyFacotry.createKeyPair(privateKey);
}

1.3 从pem文件加载账户¶

从指定pem账户文件加载交易发送账户的示例如下(client初始化方法请参考快速入门)：

// 从pemAccountFilePath指定路径加载pem账户文件，并将其设置为交易发送账户
public void loadPemAccount(Client client, String pemAccountFilePath)
{
    // 通过client获取CryptoSuite对象
    CryptoSuite cryptoSuite = client.getCryptoSuite();
    // 加载pem账户文件
    cryptoSuite.loadAccount("pem", pemAccountFilePath, null);
}

1.4 从p12文件加载账户¶

从指定的p12账户文件加载交易发送账户的示例如下：

// 从p12AccountFilePath指定的路径加载p12账户文件，并将其设置为交易发送账户
public void loadP12Account(Client client, String p12AccountFilePath, String password)
{
    // 通过client获取CryptoSuite对象
    CryptoSuite cryptoSuite = client.getCryptoSuite();
    // 加载pem账户文件
    cryptoSuite.loadAccount("p12", p12AccountFilePath, password);
}

2. 账户生成¶

Java SDK的org.fisco.bcos.sdk.v3.crypto.CryptoSuite提供了账户生成功能。

随机生成非国密账户示例如下：

// 创建非国密类型的CryptoSuite
CryptoSuite cryptoSuite = new CryptoSuite(CryptoType.ECDSA_TYPE);
// 随机生成非国密公私钥对
CryptoKeyPair cryptoKeyPair = cryptoSuite.generateRandomKeyPair();
// 获取账户地址
String accountAddress = cryptoKeyPair.getAddress();

随机生成国密账户示例如下：

// 创建国密类型的CryptoSuite
CryptoSuite cryptoSuite = new CryptoSuite(CryptoType.SM_TYPE);
// 随机生成国密公私钥对
CryptoKeyPair cryptoKeyPair = cryptoSuite.generateRandomKeyPair();
// 获取账户地址
String accountAddress = cryptoKeyPair.getAddress();

3. 账户保存¶

当没有自定义加载账户，也没有通过配置文件配置账户信息时(账户配置请参考这里)，Java SDK会随机生成账户发送交易，Java SDK的org.fisco.bcos.sdk.v3.crypto.CryptoSuite提供账户保存功能，可将随机生成的账户保存在指定路径。

以pem的格式保存账户文件到指定路径的示例如下：

// 将随机生成的账户信息保存在pemFilePath指定的路径
public void saveAccountWithPem(CryptoKeyPair cryptoKeyPair, String pemFilePath)
{
    // 以pem的格式保存账户文件到pemFilePath路径
    cryptoKeyPair.storeKeyPairWithPem(pemFilePath);
}

// 将随机生成的账户信息保存在账户配置${keyStoreDir}指定的目录下
public void saveAccountWithPemToKeyStoreDir(CryptoKeyPair cryptoKeyPair)
{
    // 账户文件名为${accountAddress}.pem
    cryptoKeyPair.storeKeyPairWithPemFormat();
}

以p12的格式保存账户文件到指定路径的示例如下：

public void saveAccountWithP12(CryptoKeyPair cryptoKeyPair, String p12FilePath, String password)
{
    // 以p12的格式将账户文件保存到p12FilePath路径
    cryptoKeyPair.storeKeyPairWithP12(p12FilePath, password);
}

// 将随机生成的账户信息保存在账户配置${keyStoreDir}指定的目录下
public void saveAccountWithP12ToKeyStoreDir(CryptoKeyPair cryptoKeyPair, String password)
{
    // 账户文件名为${accountAddress}.p12
    cryptoKeyPair.storeKeyPairWithP12Format(password);
}

Java SDK随机生成的账户信息可通过如下方法获取：

public CryptoKeyPair getCreatedCryptoKeyPair(Client client)
{
    return client.getCryptoSuite().getCryptoKeyPair();
}

4. `p12`和`pem`文件解析接口¶

Java SDK的org.fisco.bcos.sdk.v3.crypto.keystore.KeyTool提供p12和pem文件解析接口。

4.1 `pem`账户文件解析接口¶

从指定文件加载pem文件示例如下：

public KeyTool loadPem(String pemFilePath)
{
    return new PEMKeyStore(pemFilePath);
}

4.2 `p12`账户文件解析接口¶

从指定文件加载pem文件示例如下：

public KeyTool loadP12(String p12FilePath, String password)
{
    return new P12KeyStore(p12FilePath, password);
}

4.3 通过`KeyTool`获取`KeyPair`对象¶

pem和p12解析后生成的KeyTool对象提供了访问公私钥信息的接口如下：

// 获取公私钥对信息
public KeyPair getKeyPair();

此外，org.fisco.bcos.sdk.v3.crypto.CryptoSuite也提供了将java.security.KeyPair类型的公私钥信息转换为CryptoKeyPair的功能，示例如下：

// KeyTool中维护的是非国密公私钥信息
public CryptoKeyPair loadKeyStore(KeyTool keyTool)
{
    KeyPair keyPair = keyTool.getKeyPair();
    CryptoSuite cryptoSuite = new CryptoSuite(CryptoType.ECDSA_TYPE);
    return cryptoSuite.createKeyPair(keyPair);
}

// KeyTool中维护的是国密公私钥信息
public CryptoKeyPair loadGMKeyStore(KeyTool gmKeyTool)
{
    KeyPair keyPair = gmKeyTool.getKeyPair();
    CryptoSuite cryptoSuite = new CryptoSuite(CryptoType.SM_TYPE);
    return cryptoSuite.createKeyPair(keyPair);
}