io.mangoo.utils.totp.Totp Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of mangooio-core Show documentation
The newest version!
package io.mangoo.utils.totp;

import io.mangoo.constants.Hmac;

/**
 * Class which represents a Time-based One-time Password as per RFC 6238.
 * 
 * Refer to {@link TotpBuilder} on how to generate a {@code TOTP}.
 * 
 * 
 * @see RFC 6238
 */
public final class Totp {
    private final String value;
    private final long time;
    private final String hmacShaAlgorithm;
    private final int digits;
    private final long timeStep;

    /**
     * Creates a new instance of a Time-based one time password. Use the static
     * method to obtain a {@link TotpBuilder} instance and obtain a {@code TOTP}
     * from that. Note that all parameters are assumed to be valid since the
     * {@link TotpBuilder} is responsible for validation, and creation of
     * {@link Totp}s.
     * 
     * @param value
     *            the time-based one time password
     * @param time
     *            the time (in milliseconds)
     * @param hmacShaAlgorithm
     *            the {@link Hmac}
     * @param digits
     *            the number of digits the generated TOTP value contains
     * @param timeStep
     *            the time step size (in milliseconds)
     */
    Totp(String value, long time, String hmacShaAlgorithm, int digits, long timeStep) {
        this.value = value;
        this.time = time;
        this.hmacShaAlgorithm = hmacShaAlgorithm;
        this.digits = digits;
        this.timeStep = timeStep;
    }

    /**
     * Returns a new {@link TotpBuilder} instance initialized with the specified
     * {@code key}.
     * 
     * @param key
     *            the shared secret key
     * 
     * @return a new {@link TotpBuilder} instance.
     * 
     * @throws NullPointerException
     *             if {@code key} is {@code null}.
     */
    public static TotpBuilder key(byte[] key) {
        return new TotpBuilder(key);
    }

    /**
     * Returns the time-based one time password value.
     * 
     * @return the time-based one time password value.
     */
    public String value() {
        return value;
    }

    /**
     * Returns the time (in milliseconds) used to generate this {@code TOTP}.
     * 
     * @return the time (in milliseconds) used to generate this {@code TOTP}.
     */
    public long time() {
        return time;
    }

    /**
     * Returns the {@link Hmac} used to generate this {@code TOTP}.
     * 
     * @return the {@link Hmac} used to generate this {@code TOTP}.
     */
    public String hmacShaAlgorithm() {
        return hmacShaAlgorithm;
    }

    /**
     * Returns the number of digits of this {@code TOTP}.
     * 
     * @return the number of digits of this {@code TOTP}.
     */
    public int digits() {
        return digits;
    }

    /**
     * Returns the time step size (in milliseconds) used to generate this
     * {@code TOTP}.
     * 
     * @return the time step size (in milliseconds) used to generate this
     *         {@code TOTP}.
     */
    public long timeStep() {
        return timeStep;
    }

    @Override
    public int hashCode() {
        return value.hashCode();
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj) {
             return true;
        }
        if (obj == null) {
            return false;
        }
        if (getClass() != obj.getClass()) {
            return false;
        }
        Totp other = (Totp) obj;
        
        return value.equals(other.value);
    }
}