https://github.com/ic4j/ic4j-internetidentity
Library for access to the IC Internet Identity
https://github.com/ic4j/ic4j-internetidentity
android dfinity icp java
Last synced: 5 months ago
JSON representation
Library for access to the IC Internet Identity
- Host: GitHub
- URL: https://github.com/ic4j/ic4j-internetidentity
- Owner: ic4j
- License: apache-2.0
- Created: 2022-05-19T19:39:25.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2025-05-23T18:01:58.000Z (about 1 year ago)
- Last Synced: 2025-05-23T19:18:16.664Z (about 1 year ago)
- Topics: android, dfinity, icp, java
- Language: Java
- Homepage:
- Size: 128 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## Internet Identity Java Service
Providing an implementation of ICP Internet Identity Service, this Java library enables developers to register new users, add or remove devices, and authenticate client applications on the Internet Computer. More information can be found in the Internet Identity specification on the GitHub repository at https://github.com/dfinity/internet-identity/blob/main/docs/internet-identity-spec.adoc#the-internet-identity-specification.
To test the Internet Identity Service locally, install the local Internet Identity dApp and configure custom Java properties with the ii.location and ii.canister values pointing to the local instance.
https://github.com/dfinity/internet-identity/tree/main/demos/using-dev-build
To use Internet Identity Service create InternetIdentityService object. Define your own properties if you want to use local instance of the service.
```
Security.addProvider(new BouncyCastleProvider());
BasicIdentity identity = BasicIdentity.fromPEMFile(Paths.get(pemFile));
Properties env = InternetIdentityService.getIIProperties();
String iiLocation = env.getProperty("ii.location");
ReplicaTransport transport = ReplicaApacheHttpTransport.create(iiLocation);
Agent agent = new AgentBuilder().transport(transport).identity(identity).build();
InternetIdentityService InternetIdentityService = InternetIdentityService.create(agent, env);
```
Then call Internet Identity Service methods. Combine methods to create flow defined in the specification.
https://github.com/dfinity/internet-identity/blob/main/docs/internet-identity-spec.adoc#flows
```
byte[] sessionKey = identity.derEncodedPublickey;
CompletableFuture challengeResponse = internetIdentityService.createChallenge();
Challenge challenge = challengeResponse.get();
// convert byte[] to a BufferedImage
BufferedImage captchaImage = internetIdentityService.getCaptchaImage(challenge);
ChallengeResult challengeResult = new ChallengeResult();
challengeResult.challengeKey = challenge.challengeKey;
// set captcha characters from the png image
challengeResult.chars = "a";
DeviceData device = new DeviceData();
device.alias = "Device 1";
device.pubkey = sessionKey;
Purpose purpose = Purpose.authentication;
device.purpose = purpose;
KeyType keyType = KeyType.platform;
device.keyType = keyType;
CompletableFuture registerResponse = internetIdentityService.register(device,
challengeResult);
RegisterResponse register = registerResponse.get();
Long userNumber = register.registeredValue.userNumber;
String frontendHostname = "http://0.0.0.0:8000/?canisterId=rdmx6-jaaaa-aaaaa-aaadq-cai&id=renrk-eyaaa-aaaaa-aaada-cai";
CompletableFuture response = internetIdentityService
.prepareDelegation(userNumber, frontendHostname, sessionKey, Optional.empty());
PrepareDelegationResponse prepareDelegationResponse = response.get();
GetDelegationResponse getDelegationResponse = internetIdentityService.getDelegation(userNumber,
frontendHostname, sessionKey, prepareDelegationResponse.timestamp);
Principal principal = internetIdentityService.getPrincipal(userNumber, frontendHostname);
// generate a new device key pair
KeyPair keyPair = InternetIdentityService.generateSessionKey();
device.alias = "Device 2";
device.pubkey = keyPair.getPublic().getEncoded();
Long enterDeviceRegistrationModeResponse = internetIdentityService.enterDeviceRegistrationMode(userNumber)
.get();
AddTentativeDeviceResponse addTentativeDeviceResponse = internetIdentityService
.addTentativeDevice(userNumber, device).get();
VerifyTentativeDeviceResponse verifyTentativeDeviceResponse = internetIdentityService
.verifyTentativeDevice(userNumber, addTentativeDeviceResponse.addedTentatively.verificationCode)
.get();
internetIdentityService.exitDeviceRegistrationMode(userNumber);
internetIdentityService.add(userNumber, device);
DeviceData[] deviceData = internetIdentityService.lookup(userNumber);
IdentityAnchorInfo identityAnchorInfoResponse = internetIdentityService.getAnchorInfo(userNumber).get();
internetIdentityService.remove(userNumber, device.pubkey);
InternetIdentityStats stats = internetIdentityService.stats();
```
# Downloads / Accessing Binaries
To add Java IC4J Internet Identity Service library to your Java project use Maven or Gradle import from Maven Central.
https://search.maven.org/artifact/ic4j/ic4j-internetidentity/0.7.5/jar
```
org.ic4j
ic4j-internetidentity
0.7.5
```
```
implementation 'org.ic4j:ic4j-internetidentity:0.7.5'
```
# Build
You need JDK 8+ to build IC4J Internet Identity Service.