com.taobao.api.security

Class SecurityClient

java.lang.Object

com.taobao.api.security.SecurityClient

All Implemented Interfaces:

SecurityConstants

public class SecurityClient
extends Object
implements SecurityConstants

加、解密客户端(单例使用，不要初始化多个)

Since:

2016年2月26日 下午5:15:17

Author:

changchun

Field Summary

Fields inherited from interface com.taobao.api.security.SecurityConstants

BETA_STATUS, CURRENT, CURRENT_NICK_ENCRYPT_TYPE, CURRENT_PHONE_ENCRYPT_TYPE, CURRENT_RECEIVER_NAME_ENCRYPT_TYPE, DEFAULT_ENCRYPT_SLIDE_SIZE, DEFAULT_INDEX_ENCRYPT_COMPRESS_LEN, DEFAULT_INTERVAL, DEFAULT_MAX_INTERVAL, ENCRYPT_INDEX_COMPRESS_LEN, ENCRYPT_SLIDE_SIZE, INDEX_ENCRYPT_TYPE, NICK, NICK_SEPARATOR, NICK_SEPARATOR_CHAR, NORMAL, NORMAL_ENCRYPT_TYPE, NORMAL_SEPARATOR, NORMAL_SEPARATOR_CHAR, PHONE, PHONE_SEPARATOR, PHONE_SEPARATOR_CHAR, PREVIOUS, PREVIOUS_NICK_ENCRYPT_TYPE, PREVIOUS_PHONE_ENCRYPT_TYPE, PREVIOUS_RECEIVER_NAME_ENCRYPT_TYPE, PUBLISH_STATUS, RECEIVER_NAME, SEARCH, SIMPLE, SIMPLE_CHAR, SIMPLE_SEPARATOR, UNDERLINE

Constructor Summary

Constructors

Constructor and Description
SecurityClient(DefaultTaobaoClient taobaoClient, String randomNum)
SecurityClient(DefaultTaobaoClient taobaoClient, String randomNum, boolean streetest)
SecurityClient(DefaultTaobaoClient taobaoClient, String randomNum, int corePoolSize, int maxPoolSize, int maxQueue, boolean streetest)

Method Summary

Modifier and Type	Method and Description
Map<String,String>	decrypt(List<String> dataList, String type) 批量解密（所有用户共用秘钥）
Map<String,String>	decrypt(List<String> dataList, String type, String session) 批量解密（每个用户单独分配秘钥）
String	decrypt(String data, String type) 解密（所有用户共用秘钥）
String	decrypt(String data, String type, String session) 解密（每个用户单独分配秘钥）
Map<String,String>	encrypt(List<String> dataList, String type) 批量加密（所有用户共用秘钥）
Map<String,String>	encrypt(List<String> dataList, String type, String session) 批量加密（每个用户单独分配秘钥）
String	encrypt(String data, String type) 加密（所有用户共用秘钥）
String	encrypt(String data, String type, String session) 加密（每个用户单独分配秘钥）
String	encryptPrevious(String data, String type) 用老秘钥加密，只在秘钥升级时使用（所有用户共用秘钥）
String	encryptPrevious(String data, String type, String session) 用老秘钥加密，只在秘钥升级时使用（每个用户单独分配秘钥）
static String	generateCustomerSession(long userId) 生成自定义session，提供给自主账号使用
void	initSecret() 初始化秘钥（如果半小时内会调用加、解密方法，建议先初始化秘钥）。所有用户共用秘钥
void	initSecret(String session) 初始化秘钥（如果半小时内会调用加、解密方法，建议先初始化秘钥）。每个用户单独分配秘钥
static boolean	isEncryptData(List<String> dataList, String type) 判断list元素是否全部为密文数据
static boolean	isEncryptData(String data, String type) 判断是否密文数据
static boolean	isPartEncryptData(List<String> dataList, String type) 判断list元素是否存在密文数据。只要有一个是密文，则返回true
String	search(String data, String type) 密文检索（所有用户共用秘钥）
String	search(String data, String type, String session) 密文检索（每个用户单独分配秘钥）
String	searchPrevious(String data, String type) 密文检索,在秘钥升级场景下兼容查询（所有用户共用秘钥）
String	searchPrevious(String data, String type, String session) 密文检索,在秘钥升级场景下兼容查询（每个用户单独分配秘钥）
void	setRandomNum(String randomNum)
static void	shutdown() Deprecated.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SecurityClient

public SecurityClient(DefaultTaobaoClient taobaoClient,
                      String randomNum)

Parameters:

defaultTaobaoClient - serverUrl必须是https协议

randomNum - 伪随机码

SecurityClient

public SecurityClient(DefaultTaobaoClient taobaoClient,
                      String randomNum,
                      boolean streetest)

Parameters:

defaultTaobaoClient - serverUrl必须是https协议

randomNum - 伪随机码

streetest - 是否全链路压测

SecurityClient

public SecurityClient(DefaultTaobaoClient taobaoClient,
                      String randomNum,
                      int corePoolSize,
                      int maxPoolSize,
                      int maxQueue,
                      boolean streetest)

Parameters:

taobaoClient - serverUrl必须是https协议

randomNum - 伪随机码

corePoolSize - 核心线程数

maxPoolSize - 最大线程数

maxQueue - 线程池最大队列

streetest - 是否全链路压测

Method Detail

initSecret

public void initSecret()
                throws ApiException

初始化秘钥（如果半小时内会调用加、解密方法，建议先初始化秘钥）。所有用户共用秘钥

Throws:

ApiException

setRandomNum

public void setRandomNum(String randomNum)

initSecret

public void initSecret(String session)
                throws ApiException

初始化秘钥（如果半小时内会调用加、解密方法，建议先初始化秘钥）。每个用户单独分配秘钥

Parameters:

session -

Throws:

ApiException

decrypt

public Map<String,String> decrypt(List<String> dataList,
                                  String type)
                           throws SecretException

批量解密（所有用户共用秘钥）

Parameters:

dataList -

type -

Throws:

SecretException

See Also:

decrypt(List, String, String)

decrypt

public Map<String,String> decrypt(List<String> dataList,
                                  String type,
                                  String session)
                           throws SecretException

批量解密（每个用户单独分配秘钥）

Parameters:

dataList -

type -

session -

Returns:

key=密文数据，value=明文数据

Throws:

SecretException

See Also:

decrypt(String, String, String)

decrypt

public String decrypt(String data,
                      String type)
               throws SecretException

解密（所有用户共用秘钥）

Parameters:

data -

type -

Returns:

Throws:

SecretException

See Also:

decrypt(String, String, String)

decrypt

public String decrypt(String data,
                      String type,
                      String session)
               throws SecretException

解密（每个用户单独分配秘钥）

Parameters:

data - 密文数据 手机号码格式：$手机号码前3位明文$base64(encrypt(phone后8位))$111$ simple格式：~base64(encrypt(nick))~111~

type - 解密字段类型(例如：simple\phone)

session - 用户身份,用户级加密必填

Returns:

Throws:

SecretException

isEncryptData

public static boolean isEncryptData(List<String> dataList,
                                    String type)
                             throws SecretException

判断list元素是否全部为密文数据

Parameters:

dataList -

type - 加密字段类型(例如：simple\phone)

Returns:

Throws:

SecretException

See Also:

isEncryptData(String, String)

isPartEncryptData

public static boolean isPartEncryptData(List<String> dataList,
                                        String type)
                                 throws SecretException

判断list元素是否存在密文数据。只要有一个是密文，则返回true

Parameters:

dataList -

type - 加密字段类型(例如：simple\phone)

Returns:

Throws:

SecretException

isEncryptData

public static boolean isEncryptData(String data,
                                    String type)
                             throws SecretException

判断是否密文数据

Parameters:

data -

type - 加密字段类型(例如：simple\phone)

Returns:

Throws:

SecretException

encrypt

public String encrypt(String data,
                      String type)
               throws SecretException

加密（所有用户共用秘钥）

Parameters:

data -

type -

Returns:

Throws:

SecretException

See Also:

encrypt(String, String, String, Long)

encryptPrevious

public String encryptPrevious(String data,
                              String type)
                       throws SecretException

用老秘钥加密，只在秘钥升级时使用（所有用户共用秘钥）

Parameters:

data -

type -

Returns:

Throws:

SecretException

See Also:

encrypt(String, String, String, Long)

encrypt

public String encrypt(String data,
                      String type,
                      String session)
               throws SecretException

加密（每个用户单独分配秘钥）

Returns:

Throws:

SecretException

See Also:

encrypt(String, String, String, Long)

encryptPrevious

public String encryptPrevious(String data,
                              String type,
                              String session)
                       throws SecretException

用老秘钥加密，只在秘钥升级时使用（每个用户单独分配秘钥）

Returns:

Throws:

SecretException

See Also:

encrypt(String, String, String, Long)

search

public String search(String data,
                     String type)
              throws SecretException

密文检索（所有用户共用秘钥）

Returns:

Throws:

SecretException

See Also:

search(String, String, String, Long)

searchPrevious

public String searchPrevious(String data,
                             String type)
                      throws SecretException

密文检索,在秘钥升级场景下兼容查询（所有用户共用秘钥）

Returns:

Throws:

SecretException

See Also:

search(String, String, String, Long)

search

public String search(String data,
                     String type,
                     String session)
              throws SecretException

密文检索（每个用户单独分配秘钥）

Returns:

Throws:

SecretException

See Also:

search(String, String, String, Long)

searchPrevious

public String searchPrevious(String data,
                             String type,
                             String session)
                      throws SecretException

密文检索,在秘钥升级场景下兼容查询（每个用户单独分配秘钥）

Returns:

Throws:

SecretException

See Also:

search(String, String, String, Long)

encrypt

public Map<String,String> encrypt(List<String> dataList,
                                  String type)
                           throws SecretException

批量加密（所有用户共用秘钥）

Parameters:

dataList -

type -

Returns:

Throws:

SecretException

See Also:

encrypt(List, String, String)

encrypt

public Map<String,String> encrypt(List<String> dataList,
                                  String type,
                                  String session)
                           throws SecretException

批量加密（每个用户单独分配秘钥）

Parameters:

dataList -

type -

session -

Returns:

key=明文数据，value=密文数据

Throws:

SecretException

See Also:

encrypt(String, String, String, Long)

generateCustomerSession

public static String generateCustomerSession(long userId)

生成自定义session，提供给自主账号使用

Parameters:

userId -

Returns:

shutdown

@Deprecated
public static void shutdown()

Deprecated.