Merge pull request #3 from BSNDA/hotfix2022_4_29

Hotfix2022 4 29

Author: gaokanxue

README.md

@@ -3,7 +3,7 @@
 Decentralized Identifiers refers to a decentralized on-chain mapping of the identity of the real entity, where any individual/organization/entity can create and manage their own digital identities on the blockchain. The traditional identity authentication system has problems such as centralized authentication, identity data security, duplicate authentication, multi-location authentication, etc. With the promotion and application of blockchain technology in various industries, DID will be used more and more widely.
 
 ## BSN DID Overview
-BSN DID takes blockchain technology as the cornerstone and W3C DID as the specification to provide digital identity and digital credential interaction for individuals/organizations, and the BSN opens DID services to the public through BSN gateway. It consists of three main parts: SDK, Service and Smart Contract. The SDK can be integrated into developers' projects; the Service handles the business logic and connects the Identity Hub and the chain nodes; the smart contract is deployed on the blockchain, and the Service makes contract method calls.
+BSN DID takes blockchain technology as the cornerstone and W3C DID as the specification to provide digital identity and digital credential interaction for individuals/organizations, and the BSN opens DID services to the public through BSN gateway. It consists of three main parts: SDK, Service and Smart Contract. The SDK can be integrated into developers' projects; the Service handles the business logic and connects the Identity Hub and the chain nodes; the smart contract is deployed on the blockchain, and the Service makes contract method calls.
 
 
 ![BSN DID data flow structure](bsn-did.png)
@@ -16,16 +16,16 @@ BSN currently provides a Java-based SDK, developers can quickly and easily acces
 ### Access Parameters
 - Gateway address
 
-	BSN China: `https://didservice.bsngate.com:18602`
+  BSN China: `https://didservice.bsngate.com:18602`
 
-	BSN International: `https://did.bsngate.com:18602`
+  BSN International: `https://did.bsngate.com:18602`
 
 - Public Test Parameters
 
-	`PROJECTID：8320935187`
-	
-	`TOKEN:3wxYHXwAm57grc9JUr2zrPHt9HC`
-	
+  `PROJECTID：8320935187`
+
+  `TOKEN:3wxYHXwAm57grc9JUr2zrPHt9HC`
+
 ### Steps to Use
 
 1. Compile and package the source code into a jar file named did-sdk-1.0.jar.
@@ -34,11 +34,11 @@ BSN currently provides a Java-based SDK, developers can quickly and easily acces
 
 3. Create an instance of DidClient, e.g.:
 
-	`DidClient didClient = new DidClient(URL, PROJECTID, TOKEN);`
-	
+   `DidClient didClient = new DidClient(URL, PROJECTID, TOKEN);`
+
 4. Call the methods within the SDK, such as:
 
-	`DidDataWrapper didData = didClient.createDid(true);`
+   `DidDataWrapper didData = didClient.createDid(true);`
 
 ### FAQ
 
@@ -63,8 +63,8 @@ The credential template belongs to the issuer and needs to be public and transpa
 
 1) After issuing the credential, the issuer directly returns the digital credential to the user and the user keeps it by himself.
 
-2) The credential is stored in the Identity Hub provided by the BSN. Each credential of each user can be stored in the Identity Hub (hereinafter referred to as Hub) with full access control by the user, and the content of the credential is encrypted so that only the user can parse the plaintext with his private key. 
-There are two ways to store credentials in the Hub: the user gets the credentials and registers on the Hub, and then calls the saveResource method to complete the storage; the issuer stores the credentials on behalf of the user, which requires the user to authorize access permissions to the issuer first, and the issuer can register on the Hub in advance to get its own ID in the Hub and present it to the user in the client. In this way, the user can create access permissions for the issuer, and the client provides markers to identify that the user needs to store the credentials in the Hub after the issuer has issued them, then the issuer can directly call the saveResource method after issuing the credentials to complete the storage action on behalf of the user.
+2) The credential is stored in the Identity Hub provided by the BSN. Each credential of each user can be stored in the Identity Hub (hereinafter referred to as Hub) with full access control by the user, and the content of the credential is encrypted so that only the user can parse the plaintext with his private key.
+   There are two ways to store credentials in the Hub: the user gets the credentials and registers on the Hub, and then calls the saveResource method to complete the storage; the issuer stores the credentials on behalf of the user, which requires the user to authorize access permissions to the issuer first, and the issuer can register on the Hub in advance to get its own ID in the Hub and present it to the user in the client. In this way, the user can create access permissions for the issuer, and the client provides markers to identify that the user needs to store the credentials in the Hub after the issuer has issued them, then the issuer can directly call the saveResource method after issuing the credentials to complete the storage action on behalf of the user.
 
 
       

pom.xml

@@ -29,7 +29,7 @@
 		<dependency>
 			<groupId>com.alibaba</groupId>
 			<artifactId>fastjson</artifactId>
-			<version>1.2.47</version>
+			<version>1.2.83</version>
 		</dependency>
 		<dependency>
 			<groupId>org.bouncycastle</groupId>
@@ -88,6 +88,7 @@
 			<version>4.13.2</version>
 			<scope>test</scope>
 		</dependency>
+
 	</dependencies>
 
 	<build>

src/main/java/com/reddate/did/sdk/constant/ErrorMessage.java

@@ -2,63 +2,63 @@
 
 public enum ErrorMessage {
 
-	UNKNOWN_ERROR(9999, "service error: "),
+	UNKNOWN_ERROR(9999, "Unknown exception "),
 
-	PARAMETER_IS_EMPTY(1001, " is empty"),
+	PARAMETER_IS_EMPTY(1001, "is null"),
 
-	PUBLIC_AND_PRIVATE_KEY_MISMATCH(1021, "public key and private key do not match"),
+	PUBLIC_AND_PRIVATE_KEY_MISMATCH(1021, "Public and private keys do not match"),
 
-	GENERATE_DID_FAIL(1044, "generate DID failed"),
+	GENERATE_DID_FAIL(1044, "Failed to generate the DID"),
 
-	ENCRYPT_KEY_FAILED(1337, "encrypt key failed"),
+	ENCRYPT_KEY_FAILED(1337, "Failed to encrypt the key"),
 
-	SIGNATURE_FAILED(1338, "signature failed"),
+	SIGNATURE_FAILED(1029, "Failed to sign the data"),
 
-	PRIVATE_KEY_ILLEGAL_FORMAT(1025, "private key is illegal format"),
+	PRIVATE_KEY_ILLEGAL_FORMAT(1304, "Private key format is invalid"),
 
-	CPT_NOT_EXIST(1060, "CPT is not exist"),
+	CPT_NOT_EXIST(1060, "CPT does not exist"),
 
-	DID_NOT_EXIST(1041, "DID not exist"),
+	DID_NOT_EXIST(1041, "DID does not exist"),
 
-	CPT_AND_ISSUER_CANNOT_MATCH(1062, "issuer and CPT's publisherDid are not equals"),
+	CPT_AND_ISSUER_CANNOT_MATCH(1062, "privateKey does not match issuerDid"),
 
-	QUERY_GRANT_ENCPY_KEY_FAILED(1501, "query grant resource's encryption key failed"),
+	QUERY_GRANT_ENCPY_KEY_FAILED(1501, "Failed to query the encryption key of the granted resource"),
 
-	DECRPTY_GRANT_KEY_FAILED(1502, "decrypt resource's encryption key failed"),
+//	DECRPTY_GRANT_KEY_FAILED(1502, "Failed to decrypt the key of the granted resource"),
 
-	RESOURCE_NOT_EISTS(1503, "resource is not exist"),
+	RESOURCE_NOT_EISTS(1418, "Resource does not exist"),
 
-	RECOVERY_KEY_INCORRECT(1504, "recovery key pair is incorrect, can not reset DID auth"),
+	RECOVERY_KEY_INCORRECT(1504, " mismatch"),
 
-	PRK_PUK_NOT_MATCH(1505, "primary private key and public key do not match"),
+	PRK_PUK_NOT_MATCH(1306, " format is invalid"),
 
-	INVALID_DID(1043, "DID is illegal format"),
+	INVALID_DID(1043, "Invalid DID"),
 
 	DECRYPT_KEY_FAILED(1455, "decrypt encptyKey failed"),
 
 	DECRYPT_CONTENT_FAILED(1456, "decrypt content failed"),
 
-	CREAT_KEY_FAIL(1085, "create key failed"),
+	CREAT_KEY_FAIL(1085, "Failed to create the key pair"),
 
-	HASH_DID_FAIL(1086, "calculate did identifier failed"),
+	HASH_DID_FAIL(1086, "Failed to calculate the DID"),
 
-	SIGN_DID_FAIL(1087, "calculate did document sign failed"),
+//	SIGN_DID_FAIL(1087, "Failed to calculate the DID Document signature"),
 
-	CREATE_DID_DOC_FAIL(1088, "create document failed"),
+	CREATE_DID_DOC_FAIL(1088, "Failed to create the DID Document"),
 
-	MNEM_IS_EMPTY(1090, "mnemonic is empty"),
+	MNEM_IS_EMPTY(1090, "The mnemonic is empty"),
 
-	VALIDATE_SIGN_ERROR(1422, "verify signature failed"), 
+	VALIDATE_SIGN_ERROR(1422, "Signature verification failed"),
 
-	DECRYPT_FAILED(1365, "decrypt failed"),
+	DECRYPT_FAILED(1365, "Failed to decrypt the data"),
 
-	ENCRYPT_FAILED(1366, "encrypt failed"),
+	ENCRYPT_FAILED(1366, "Failed to encrypt the data"),
 
-	SAVE_RESOURCE_ERROR(1408, "save resource failed"),
+	SAVE_RESOURCE_ERROR(1408, "Failed to save the resource"),
 
-	 USER_NOT_EXISTS(1423, "user is not registered"),
+	 USER_NOT_EXISTS(1423, "The user is not registered"),
 
-	CRYPTO_TYPE_INCORRECT(1466, "crypto type is illegal format"),
+	CRYPTO_TYPE_INCORRECT(1466, "Crypto type format is invalid"),
 	;
 
 	private Integer code;

src/main/java/com/reddate/did/sdk/param/req/Operation.java

@@ -21,5 +21,9 @@ public enum Operation {
 	/**
 	 * Delete permission
 	 */
-	DELETE
+	DELETE,
+	/**
+	 * Transfer permission
+	 */
+	TRANSFER
 }

src/main/java/com/reddate/did/sdk/protocol/response/ResultData.java

@@ -60,7 +60,7 @@ public void setData(T data) {
 	public static <T> ResultData<T> success(T data) {
 		ResultData<T> result = new ResultData<>();
 		result.setCode(0);
-		result.setMsg("success");
+		result.setMsg("Success");
 		result.setData(data);
 		return result;
 	}

src/main/java/com/reddate/did/sdk/service/AuthIssuerService.java

@@ -53,16 +53,16 @@ public AuthIssuerService(String url, String projectId, String token, CryptoType
 	public boolean registerAuthIssuer(RegisterAuthorityIssuer register) {
 
 		if (ObjectUtil.isEmpty(register)) {
-			throw new DidException(ErrorMessage.PARAMETER_IS_EMPTY.getCode(), "register is empty");
+			throw new DidException(ErrorMessage.PARAMETER_IS_EMPTY.getCode(), "register is null");
 		}
 		if (StringUtils.isBlank(register.getName())) {
-			throw new DidException(ErrorMessage.PARAMETER_IS_EMPTY.getCode(), "register.name is empty");
+			throw new DidException(ErrorMessage.PARAMETER_IS_EMPTY.getCode(), "register.name is null");
 		}
 		if (StringUtils.isBlank(register.getDid())) {
-			throw new DidException(ErrorMessage.PARAMETER_IS_EMPTY.getCode(), "register.did is empty");
+			throw new DidException(ErrorMessage.PARAMETER_IS_EMPTY.getCode(), "register.did is null");
 		}
 		if (StringUtils.isBlank(register.getPrivateKey())) {
-			throw new DidException(ErrorMessage.PARAMETER_IS_EMPTY.getCode(), "register.privateKey is empty");
+			throw new DidException(ErrorMessage.PARAMETER_IS_EMPTY.getCode(), "register.privateKey is null");
 		}
 		RegisterAuthorityIssuerWrapper req = new RegisterAuthorityIssuerWrapper();
 		req.setDid(register.getDid());
@@ -101,13 +101,13 @@ public boolean registerAuthIssuer(RegisterAuthorityIssuer register) {
 	public Pages<AuthorityIssuer> queryAuthIssuerList(AuthIssuer query) {
 
 		if (ObjectUtil.isEmpty(query)) {
-			throw new DidException(ErrorMessage.PARAMETER_IS_EMPTY.getCode(), "query is empty");
+			throw new DidException(ErrorMessage.PARAMETER_IS_EMPTY.getCode(), "query is null");
 		}
 		if (query.getPage() == null) {
-			throw new DidException(ErrorMessage.PARAMETER_IS_EMPTY.getCode(), "page is empty");
+			throw new DidException(ErrorMessage.PARAMETER_IS_EMPTY.getCode(), "page is null");
 		}
 		if (query.getSize() == null) {
-			throw new DidException(ErrorMessage.PARAMETER_IS_EMPTY.getCode(), "size is empty");
+			throw new DidException(ErrorMessage.PARAMETER_IS_EMPTY.getCode(), "size is null");
 		}
 
 		AuthIssuerListWrapper authIssuerListWrapper = new AuthIssuerListWrapper();
@@ -136,22 +136,22 @@ public Pages<AuthorityIssuer> queryAuthIssuerList(AuthIssuer query) {
 	 */
 	public CptBaseInfo registerCpt(RegisterCpt registerCpt) {
 		if (ObjectUtil.isEmpty(registerCpt)) {
-			throw new DidException(ErrorMessage.PARAMETER_IS_EMPTY.getCode(), "registerCpt is empty");
+			throw new DidException(ErrorMessage.PARAMETER_IS_EMPTY.getCode(), "registerCpt is null");
 		}
 		if (StringUtils.isBlank(registerCpt.getDescription())) {
-			throw new DidException(ErrorMessage.PARAMETER_IS_EMPTY.getCode(), "description is empty");
+			throw new DidException(ErrorMessage.PARAMETER_IS_EMPTY.getCode(), "description is null");
 		}
 		if (StringUtils.isBlank(registerCpt.getTitle())) {
-			throw new DidException(ErrorMessage.PARAMETER_IS_EMPTY.getCode(), "title is empty");
+			throw new DidException(ErrorMessage.PARAMETER_IS_EMPTY.getCode(), "title is null");
 		}
 		if (StringUtils.isBlank(registerCpt.getPrivateKey())) {
-			throw new DidException(ErrorMessage.PARAMETER_IS_EMPTY.getCode(), "privateKey is empty");
+			throw new DidException(ErrorMessage.PARAMETER_IS_EMPTY.getCode(), "privateKey is null");
 		}
 		if (StringUtils.isBlank(registerCpt.getType())) {
-			throw new DidException(ErrorMessage.PARAMETER_IS_EMPTY.getCode(), "type is empty");
+			throw new DidException(ErrorMessage.PARAMETER_IS_EMPTY.getCode(), "type is null");
 		}
 		if (StringUtils.isBlank(registerCpt.getDid())) {
-			throw new DidException(ErrorMessage.PARAMETER_IS_EMPTY.getCode(), "did is empty");
+			throw new DidException(ErrorMessage.PARAMETER_IS_EMPTY.getCode(), "did is null");
 		}
 		CptJsonSchemaUtils.validateJsonSchema(registerCpt.getCptJsonSchema());
 
@@ -207,21 +207,21 @@ public CptBaseInfo registerCpt(RegisterCpt registerCpt) {
 	 * Query all registered CPT templates under the issuer according to the DID
 	 * identifier of the issuer.
 	 * 
-	 * @param query Page information and authority issuer
+	 * @param queryCpt Page information and authority issuer
 	 * @return Return the CPT template list
 	 */
 	public Pages<CptInfo> queryCptListByDid(QueryCpt queryCpt) {
 		if (ObjectUtil.isEmpty(queryCpt)) {
-			throw new DidException(ErrorMessage.PARAMETER_IS_EMPTY.getCode(), "queryCpt is empty");
+			throw new DidException(ErrorMessage.PARAMETER_IS_EMPTY.getCode(), "queryCpt is null");
 		}
 		if (StringUtils.isBlank(queryCpt.getDid())) {
-			throw new DidException(ErrorMessage.PARAMETER_IS_EMPTY.getCode(), "did is empty");
+			throw new DidException(ErrorMessage.PARAMETER_IS_EMPTY.getCode(), "did is null");
 		}
 		if (ObjectUtil.isEmpty(queryCpt.getPage())) {
-			throw new DidException(ErrorMessage.PARAMETER_IS_EMPTY.getCode(), "page is empty");
+			throw new DidException(ErrorMessage.PARAMETER_IS_EMPTY.getCode(), "page is null");
 		}
 		if (ObjectUtil.isEmpty(queryCpt.getSize())) {
-			throw new DidException(ErrorMessage.PARAMETER_IS_EMPTY.getCode(), "size is empty");
+			throw new DidException(ErrorMessage.PARAMETER_IS_EMPTY.getCode(), "size is null");
 		}
 		RequestParam<QueryCptListWrapper> reqParam = new RequestParam<>(this.getProjectId(), queryCpt.getDid());
 		QueryCptListWrapper queryCptListWrapper = new QueryCptListWrapper();
@@ -245,7 +245,7 @@ public Pages<CptInfo> queryCptListByDid(QueryCpt queryCpt) {
 	 */
 	public CptInfo queryCptById(Long cptId) {
 		if (cptId == null) {
-			throw new DidException(ErrorMessage.PARAMETER_IS_EMPTY.getCode(), "cptId is empty");
+			throw new DidException(ErrorMessage.PARAMETER_IS_EMPTY.getCode(), "cptId is null");
 		}
 		RequestParam<QueryCptByIdWrapper> reqParam = new RequestParam<>(this.getProjectId(), null);
 		QueryCptByIdWrapper query = new QueryCptByIdWrapper();
@@ -267,25 +267,25 @@ public CptInfo queryCptById(Long cptId) {
 	 */
 	public CptBaseInfo updateCpt(RegisterCpt registerCpt) {
 		if (ObjectUtil.isEmpty(registerCpt)) {
-			throw new DidException(ErrorMessage.PARAMETER_IS_EMPTY.getCode(), "registerCpt is empty");
+			throw new DidException(ErrorMessage.PARAMETER_IS_EMPTY.getCode(), "registerCpt is null");
 		}
 		if (ObjectUtil.isEmpty(registerCpt.getCptId())) {
-			throw new DidException(ErrorMessage.PARAMETER_IS_EMPTY.getCode(), "cptId is empty");
+			throw new DidException(ErrorMessage.PARAMETER_IS_EMPTY.getCode(), "cptId is null");
 		}
 		if (StringUtils.isBlank(registerCpt.getDescription())) {
-			throw new DidException(ErrorMessage.PARAMETER_IS_EMPTY.getCode(), "description is empty");
+			throw new DidException(ErrorMessage.PARAMETER_IS_EMPTY.getCode(), "description is null");
 		}
 		if (StringUtils.isBlank(registerCpt.getTitle())) {
-			throw new DidException(ErrorMessage.PARAMETER_IS_EMPTY.getCode(), "title is empty");
+			throw new DidException(ErrorMessage.PARAMETER_IS_EMPTY.getCode(), "title is null");
 		}
 		if (StringUtils.isBlank(registerCpt.getPrivateKey())) {
-			throw new DidException(ErrorMessage.PARAMETER_IS_EMPTY.getCode(), "privateKey is empty");
+			throw new DidException(ErrorMessage.PARAMETER_IS_EMPTY.getCode(), "privateKey is null");
 		}
 		if (StringUtils.isBlank(registerCpt.getType())) {
-			throw new DidException(ErrorMessage.PARAMETER_IS_EMPTY.getCode(), "type is empty");
+			throw new DidException(ErrorMessage.PARAMETER_IS_EMPTY.getCode(), "type is null");
 		}
 		if (StringUtils.isBlank(registerCpt.getDid())) {
-			throw new DidException(ErrorMessage.PARAMETER_IS_EMPTY.getCode(), "did is empty");
+			throw new DidException(ErrorMessage.PARAMETER_IS_EMPTY.getCode(), "did is null");
 		}
 		CptJsonSchemaUtils.validateJsonSchema(registerCpt.getCptJsonSchema());