This java library provides a suite of convenience functions intended to simplify the integration of Hydro's Raindrop authentication into your project.
For more details, please check Hydrogen Raindrop Api Docs
- hydro-oauth2-java 1.0.0
- unirest-java 1.4.9
- Java 1.8
- Maven 3
Current version is 1.0.0-SNAPSHOT. Will be published in maven central after release. (it depends hydro raindrop api)
You can also install manually:
git clone https://github.com/serkanalgl/hydro-raindrop-java.git
cd hydro-raindrop-java
mvn clean installTo instantiate a new RaindropPartnerConfig object:
try{
RaindropPartnerConfig config =
new RaindropPartnerConfig.Builder("client id", "client secret", Environment.PRODUCTION)
.setApplicationId("application id")
.build();
}catch (Exception e) {
//something went wrong
}
You must pass a config object with the following values:
clientId(required): Your OAuth id for the Hydro APIclientSecret(required): Your OAuth secret for the Hydro APIenvironment(default: SANDBOX):Environment.SANDBOX|Environment.PRODUCTIONapplicationId(required): Your application id for the Hydro API
To instantiate a new RaindropClient object:
RaindropClient client = new Raindrop().client(config);
To register a user, you will need to collect the HydroID that identifies them on the Hydro app and map it to your application.
try{
BaseResponse response = client.registerUser(hydroId);
}catch (RaindropException e) {
//something went worng
}
BaseResponseresponse.getStatus(): Returns a 200 if the user has been successfully mapped to your application.response.getMessage(): Success/Error message
This method generates 6-digit number using with SecureRandom which are for users will type into their Hydro mobile app.
try{
Integer message = client.generateMessage();
}catch (RaindropException e) {
//something went worng
}
When the users enter that message into their mobile device, the API will verify that the correct user signed the message against the information stored on the blockchain.
try{
VerifySignature response = client.verifySignature(hydroId, message);
}catch (RaindropException e) {
//something went worng
}
VerifySignatureresponse.isVerified(): Successful verifications will returntrueresponse.getVerificationId(): A UUID for this verification attempt.response.getTimestamp(): The time of this verification attempt.
For a variety of reasons, a user may want to disable MFA or may delete their account on your platform.
try{
BaseResponse response = client.deleteUser(hydroId);
}catch (RaindropException e) {
//something went worng
}
BaseResponseresponse.getStatus(): Returns a 200 deleting their mapping to your application.response.getMessage(): Success/Error message
To instantiate a new RaindropPartnerConfig object:
try{
RaindropPartnerConfig config =
new RaindropPartnerConfig.Builder("client id", "client secret", Environment.PRODUCTION).build();
}catch (Exception e) {
//something went wrong
}
You must pass a config object with the following values:
clientId(required): Your OAuth id for the Hydro APIclientSecret(required): Your OAuth secret for the Hydro APIenvironment(default: SANDBOX):Environment.SANDBOX|Environment.PRODUCTION
To instantiate a new RaindropClient object:
RaindropServer server = new Raindrop().server(config);
Add address to whitelist ( be careful, for security purposes, the id will only be generated one time. )
try{
String address = "0x..." //The user’s Ethereum address
Whitelist whitelist = server.whitelist(address);
}catch (RaindropException e) {
//something went worng
}
Whitelistwhitelist.getStatus(): Returns a 200 if the address has been whitelisted.whitelist.getMessage(): Success/Error messagewhitelist.getHydroAddressId(): The authenticating user’s newly assigned address idwhitelist.getTransactionHash(): The hash of the transaction whitelisting the user
After being whitelisted, each user must authenticate through the Server-side Raindrop process once every 24 hours to retain access to the protected system.
try{
String hydroAddressId = whitelist.getHydroAddressId(); // should be stored on your own database.
Challenge challenge = server.challenge(hydroAddressId);
}catch (RaindropException e) {
//something went worng
}
Challengechallenge.getStatus(): Returns a 200 if challenge response is success.challenge.getMessage(): Success/Error messagechallenge.getAmount(): The challenge amountchallenge.getChallenge(): The challenge stringchallenge.getPartnerId(): The unique identifier assigned to your firmchallenge.getTransactionHash(): The hash of the transaction that updates the user’s raindrop requirements
You will need to relay these values to the authenticating user who will send them to a Hydro smart contract, so treat them accordingly.
Once the raindrop has been completed by the end user and confirmed in the blockchain, the final authentication check can be performed
try{
String hydroAddressId = whitelist.getHydroAddressId(); // should be stored on your own database.
Authenticate authenticate = server.authenticate(hydroAddressId);
}catch (RaindropException e) {
//something went worng
}
Authenticateauthenticate.isAuthenticated(): Returnstrueif authenticatedauthenticate.getAuthenticationId(): A UUID for this verification attempt.authenticate.getTimestamp(): The time of this verification attempt.
Certain methods in the Hydro API trigger transactions on the Ethereum blockchain. Transactions take time to be confirmed, so rather than waiting for confirmation, these methods will return a transaction_hash as soon as our internal logic has completed successfully and the appropriate transaction has been broadcast to the Ethereum network.
try{
TransactionStatus transactionStatus = serverOrClientInstance.transactionStatus("0x....");
}catch (RaindropException e) {
//something went worng
}
TransactionStatustransactionStatus.isCompleted(): Indication of whether the transaction has been confirmedtransactionStatus.getTransactionHash(): The transaction hash
If you have any further question/suggestion/issue, do not hesitate to contact me.
Copyright (c) 2018, Under MIT licence Serkan Algül. All rights reserved.