org.interledger.stream.Ids Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of stream-core Show documentation

Core libraries for implementing the STREAM protocol.

There is a newer version: 1.3.1

package org.interledger.stream;

import org.interledger.core.InterledgerAddress;
import org.interledger.core.SharedSecret;
import org.interledger.core.Wrapped;
import org.interledger.core.Wrapper;

import com.google.common.hash.Hashing;
import org.immutables.value.Value;

import java.util.Objects;

/**
 * Wrapped immutable classes for providing type-safe identifiers.
 */
public class Ids {

  @Value.Immutable
  @Wrapped
  @SuppressWarnings("checkstyle:TypeName")
  abstract static class _StreamConnectionId extends Wrapper {

    /**
     * Constructs a {@link StreamConnectionId} that is derived from from the supplied {@code receiverAddress} and {@code
     * sharedSecret} by computing an HMAC-SHA-256 of the receiver address using the shared-secret as a key so that the
     * actual shared secret isn't hanging around in memory from call to call. In this way the connection id will also be
     * uniquely scoped to a receiver address plus shared secret combination.
     *
     * @param receiverAddress The {@link InterledgerAddress} of the receiver of this STREAM payment.
     * @param sharedSecret    The {@link SharedSecret} used to encrypt and decrypt packets transmitted over this
     *                        connection.
     *
     * @return A {@link StreamConnectionId} constructed from the supplied inputs.
     */
    public static StreamConnectionId from(
        final InterledgerAddress receiverAddress, final SharedSecret sharedSecret
    ) {
      return StreamConnectionId.of(Hashing
          .hmacSha256(Objects.requireNonNull(sharedSecret, "sharedSecret must not be null").key())
          .hashBytes(
              Objects.requireNonNull(receiverAddress, "receiverAddress must not be null").getValue().getBytes())
          .toString()
      );
    }
  }
}