Merge pull request #295 from Concordium/identity-request

Identity request

CHANGELOG.md

@@ -4,6 +4,7 @@
 - Purge remaining usages of V1 GRPC API.
 - Added support for android through an AAR artifact.
 - Added `ConcordiumHdWallet` class for deriving Concordium specific keys and randomness from a seed phrase.
+- Added `Identity` class with method `createIdentityRequest` for creating identity requests.
 
 ## 6.0.0
 - Added method `waitUntilFinalized` for waiting until a given transaction is finalized.

concordium-sdk/src/main/java/com/concordium/sdk/crypto/CryptoJniNative.java

@@ -1,5 +1,6 @@
 package com.concordium.sdk.crypto;
 
+import com.concordium.sdk.crypto.wallet.IdentityRequestInput;
 import com.concordium.sdk.crypto.wallet.Network;
 import com.concordium.sdk.crypto.wallet.StringResult;
 import com.concordium.sdk.exceptions.JNIError;
@@ -258,4 +259,13 @@ public static String getVerifiableCredentialBackupEncryptionKey(String seedAsHex
         return getVerifiableCredentialBackupEncryptionKey(seedAsHex, network.getValue());
     }
     private static native String getVerifiableCredentialBackupEncryptionKey(String seedAsHex, String netAsStr);
+
+    /**
+     * Creates an identity request that is to be sent to an identity provider when
+     * creating a new identity.
+     * @param input {@link IdentityRequestInput} serialized as JSON
+     * @return JSON representing {@link StringResult}. If successful the field 'result' contains the identity request as JSON.
+     * If not successful, the 'err' field contains a {@link JNIError} detailing what went wrong.
+     */
+    public static native String createIdentityRequestV1(String input);
 }

concordium-sdk/src/main/java/com/concordium/sdk/crypto/pointchevalsanders/PSPublicKey.java

@@ -1,10 +1,11 @@
 package com.concordium.sdk.crypto.pointchevalsanders;
 
 import com.fasterxml.jackson.annotation.JsonCreator;
+import com.fasterxml.jackson.annotation.JsonValue;
+
 import lombok.AccessLevel;
 import lombok.EqualsAndHashCode;
 import lombok.RequiredArgsConstructor;
-import lombok.ToString;
 import org.apache.commons.codec.DecoderException;
 import org.apache.commons.codec.binary.Hex;
 
@@ -15,7 +16,6 @@
  */
 @RequiredArgsConstructor(access = AccessLevel.PRIVATE)
 @EqualsAndHashCode
-@ToString
 public class PSPublicKey {
 
     /**
@@ -39,4 +39,10 @@ public static PSPublicKey from(final byte[] bytes) {
     public byte[] getBytes() {
         return Arrays.copyOf(bytes, bytes.length);
     }
+
+    @Override
+    @JsonValue
+    public String toString() {
+        return Hex.encodeHexString(this.bytes);
+    }
 }

concordium-sdk/src/main/java/com/concordium/sdk/crypto/wallet/ConcordiumHdWallet.java

@@ -13,6 +13,7 @@
 
 import com.concordium.sdk.crypto.CryptoJniNative;
 import com.concordium.sdk.crypto.NativeResolver;
+import com.concordium.sdk.crypto.bls.BLSSecretKey;
 import com.concordium.sdk.crypto.ed25519.ED25519PublicKey;
 import com.concordium.sdk.crypto.ed25519.ED25519SecretKey;
 import com.concordium.sdk.exceptions.CryptoJniException;
@@ -169,28 +170,28 @@ public ED25519PublicKey getAccountPublicKey(int identityProviderIndex, int ident
      * Derives id cred sec for a specific identity.
      * @param identityProviderIndex the index of the identity provider interpreted as a u32.
      * @param identityIndex the index of the identity interpreted as a u32.
-     * @return id cred sec encoded as a hex string
+     * @return id cred sec
      */
-    public String getIdCredSec(int identityProviderIndex, int identityIndex) {
+    public BLSSecretKey getIdCredSec(int identityProviderIndex, int identityIndex) {
         String idCredSec = getStringResult((String seedAsHex, Network network) -> {
             return CryptoJniNative.getIdCredSec(seedAsHex, network, identityProviderIndex, identityIndex);
         });
 
-        return idCredSec;
+        return BLSSecretKey.from(idCredSec);
     }
 
     /**
      * Derives the PRF key for a specific identity.
      * @param identityProviderIndex the index of the identity provider interpreted as a u32.
      * @param identityIndex the index of the identity interpreted as a u32.
-     * @return a PRF key encoded as a hex string
+     * @return a PRF key
      */
-    public String getPrfKey(int identityProviderIndex, int identityIndex) {
+    public BLSSecretKey getPrfKey(int identityProviderIndex, int identityIndex) {
         String prfKey = getStringResult((String seedAsHex, Network network) -> {
             return CryptoJniNative.getPrfKey(seedAsHex, network, identityProviderIndex, identityIndex);
         });
 
-        return prfKey;
+        return BLSSecretKey.from(prfKey);
     }
 
     /**

concordium-sdk/src/main/java/com/concordium/sdk/crypto/wallet/Identity.java

@@ -0,0 +1,31 @@
+package com.concordium.sdk.crypto.wallet;
+
+import com.concordium.sdk.crypto.CryptoJniNative;
+import com.concordium.sdk.exceptions.CryptoJniException;
+import com.concordium.sdk.serializing.JsonMapper;
+import com.fasterxml.jackson.core.JsonProcessingException;
+
+public class Identity {
+
+    /**
+     * Creates an identity request that is to be sent to an identity provider when
+     * creating a new identity.
+     * @param input the input required to generate an identity request
+     * @return an identity request serialized as JSON
+     */
+    public static String createIdentityRequest(IdentityRequestInput input) {
+        StringResult result = null;
+        try {
+            String jsonStr = CryptoJniNative.createIdentityRequestV1(JsonMapper.INSTANCE.writeValueAsString(input));
+            result = JsonMapper.INSTANCE.readValue(jsonStr, StringResult.class);
+        } catch (JsonProcessingException e) { 
+            throw new RuntimeException(e);
+        }
+
+        if (!result.isSuccess()) {
+            throw CryptoJniException.from(result.getErr());
+        }
+
+        return result.getResult();
+    }
+}

concordium-sdk/src/main/java/com/concordium/sdk/crypto/wallet/IdentityRequestInput.java

@@ -0,0 +1,37 @@
+package com.concordium.sdk.crypto.wallet;
+
+import java.util.Map;
+
+import com.concordium.sdk.crypto.bls.BLSSecretKey;
+import com.concordium.sdk.responses.blocksummary.updates.queues.AnonymityRevokerInfo;
+import com.concordium.sdk.responses.blocksummary.updates.queues.IdentityProviderInfo;
+import com.concordium.sdk.responses.cryptographicparameters.CryptographicParameters;
+
+import lombok.Builder;
+import lombok.Getter;
+import lombok.NonNull;
+
+@Getter
+@Builder
+public class IdentityRequestInput {
+
+    @NonNull
+    private final CryptographicParameters globalContext;
+
+    @NonNull
+    private final Map<String, AnonymityRevokerInfo> arsInfos;
+
+    @NonNull
+    private final IdentityProviderInfo ipInfo;
+
+    private final long arThreshold;
+
+    @NonNull
+    private final BLSSecretKey idCredSec;
+
+    @NonNull
+    private final BLSSecretKey prfKey;
+
+    @NonNull
+    private final String blindingRandomness;
+}

concordium-sdk/src/main/java/com/concordium/sdk/responses/blocksummary/updates/queues/AnonymityRevokerInfo.java

@@ -3,7 +3,10 @@
 import com.concordium.grpc.v2.ArInfo;
 import com.concordium.sdk.crypto.elgamal.ElgamalPublicKey;
 import com.concordium.sdk.types.UInt32;
+import com.fasterxml.jackson.annotation.JsonProperty;
+
 import lombok.*;
+import lombok.extern.jackson.Jacksonized;
 
 /**
  * Anonymity revoker info
@@ -20,11 +23,14 @@ public final class AnonymityRevokerInfo {
     /**
      * A description of the anonymity revoker
      */
+    @JsonProperty("arDescription")
     private final Description description;
 
+    @JsonProperty("arPublicKey")
     private final ElgamalPublicKey anonymityRevokerPublicKey;
     @Builder
-    public AnonymityRevokerInfo(int arIdentity, Description description, ElgamalPublicKey arPublicKey) {
+    @Jacksonized
+    public AnonymityRevokerInfo(int arIdentity, @JsonProperty("arDescription") Description description, ElgamalPublicKey arPublicKey) {
         this.arIdentity = UInt32.from(arIdentity);
         this.description = description;
         this.anonymityRevokerPublicKey = arPublicKey;

concordium-sdk/src/main/java/com/concordium/sdk/responses/blocksummary/updates/queues/Description.java

@@ -1,15 +1,17 @@
 package com.concordium.sdk.responses.blocksummary.updates.queues;
 
 import lombok.*;
+import lombok.extern.jackson.Jacksonized;
 
 /**
- * A description contains meta information about an {@link IdentityProviderInfo} or {@link AnonymityRevokerInfo}
+ * A description contains meta information about an {@link IdentityProviderInfo}
+ * or {@link AnonymityRevokerInfo}
  */
 @ToString
 @EqualsAndHashCode
 @Getter
 @Builder
-@RequiredArgsConstructor
+@Jacksonized
 public class Description {
     private final String name;
     private final String url;

concordium-sdk/src/main/java/com/concordium/sdk/responses/blocksummary/updates/queues/IdentityProviderInfo.java

@@ -4,10 +4,13 @@
 import com.concordium.sdk.crypto.ed25519.ED25519PublicKey;
 import com.concordium.sdk.crypto.pointchevalsanders.PSPublicKey;
 import com.concordium.sdk.types.UInt32;
+import com.fasterxml.jackson.annotation.JsonProperty;
+
 import lombok.Builder;
 import lombok.EqualsAndHashCode;
 import lombok.Getter;
 import lombok.ToString;
+import lombok.extern.jackson.Jacksonized;
 
 /**
  * Identity provider info
@@ -18,12 +21,15 @@
 public final class IdentityProviderInfo {
 
     private final UInt32 ipIdentity;
+    @JsonProperty("ipDescription")
     private final Description description;
     private final ED25519PublicKey ipCdiVerifyKey;
     private final PSPublicKey ipVerifyKey;
 
     @Builder
+    @Jacksonized
     public IdentityProviderInfo(int ipIdentity,
+                                @JsonProperty("ipDescription")
                                 Description description,
                                 ED25519PublicKey ipCdiVerifyKey,
                                 PSPublicKey ipVerifyKey) {

concordium-sdk/src/main/java/com/concordium/sdk/responses/cryptographicparameters/CryptographicParameters.java

@@ -4,13 +4,15 @@
 import com.concordium.sdk.crypto.pedersencommitment.PedersenCommitmentKey;
 import lombok.Builder;
 import lombok.Data;
+import lombok.extern.jackson.Jacksonized;
 
 /**
  * A Set of Cryptographic parameters that are particular to the chain and
  * shared by everybody who interacts with the chain.
  */
 @Data
 @Builder
+@Jacksonized
 public final class CryptographicParameters {
 
     /**

concordium-sdk/src/main/java/com/concordium/sdk/types/UInt32.java

@@ -4,10 +4,18 @@
 import lombok.Getter;
 import lombok.val;
 
+import java.io.IOException;
 import java.nio.ByteBuffer;
 
+import com.fasterxml.jackson.core.JsonGenerator;
+import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.databind.SerializerProvider;
+import com.fasterxml.jackson.databind.annotation.JsonSerialize;
+import com.fasterxml.jackson.databind.ser.std.StdSerializer;
+
 @EqualsAndHashCode
 @Getter
+@JsonSerialize(using = UInt32.UInt32Serializer.class)
 public final class UInt32 {
     public static final int BYTES = Integer.BYTES;
     final int value;
@@ -50,4 +58,26 @@ public static UInt32 fromBytes(ByteBuffer source) {
     public String toString() {
         return String.valueOf(value);
     }
+
+    /**
+     * A custom Jackson serializer is provided that makes the UInt32 JSON serialization
+     * compatible with the JSON format expected by the Rust libraries.
+     */
+    static class UInt32Serializer extends StdSerializer<UInt32> {
+
+        public UInt32Serializer() {
+            this(null);
+        }
+
+        public UInt32Serializer(Class<UInt32> t) {
+            super(t);
+        }
+
+        @Override
+        public void serialize(
+                UInt32 uint, JsonGenerator jgen, SerializerProvider provider)
+                throws IOException, JsonProcessingException {
+            jgen.writeRawValue(Integer.toUnsignedString(uint.getValue()));
+        }
+    }
 }

concordium-sdk/src/test/java/com/concordium/sdk/crypto/wallet/ConcordiumHdWalletTest.java

@@ -105,7 +105,7 @@ public void testMainnetPublicAndSigningKeyMatch() throws UnsupportedEncodingExce
     public void testMainnetIdCredSec() {
         ConcordiumHdWallet wallet = ConcordiumHdWallet.fromHex(TEST_SEED, Network.MAINNET);
 
-        String idCredSec = wallet.getIdCredSec(2, 115);
+        String idCredSec = wallet.getIdCredSec(2, 115).toString();
 
         assertEquals("33b9d19b2496f59ed853eb93b9d374482d2e03dd0a12e7807929d6ee54781bb1", idCredSec);
     }
@@ -114,7 +114,7 @@ public void testMainnetIdCredSec() {
     public void testMainnetPrfKey() {
         ConcordiumHdWallet wallet = ConcordiumHdWallet.fromHex(TEST_SEED, Network.MAINNET);
 
-        String prfKey = wallet.getPrfKey(3, 35);
+        String prfKey = wallet.getPrfKey(3, 35).toString();
 
         assertEquals("4409e2e4acffeae641456b5f7406ecf3e1e8bd3472e2df67a9f1e8574f211bc5", prfKey);
     }