org.wildfly.security.password.spec.OneTimePasswordSpec Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of wildfly-elytron
WildFly Security SPIs
There is a newer version: 2.4.1.Final
/*
 * JBoss, Home of Professional Open Source
 * Copyright 2015 Red Hat, Inc., and individual contributors
 * as indicated by the @author tags.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.wildfly.security.password.spec;

import static org.wildfly.common.math.HashMath.multiHashOrdered;

import java.util.Arrays;
import java.util.Objects;

import org.wildfly.common.Assert;

/**
 * A {@link PasswordSpec} for a one-time password as defined in RFC 2289.
 *
 * @author Farah Juma
 */
public final class OneTimePasswordSpec implements PasswordSpec {

    private final byte[] hash;
    private final String seed;
    private final int sequenceNumber;

    /**
     * Construct a new instance.
     *
     * @param hash the hash bytes
     * @param seed the seed
     * @param sequenceNumber the sequence number
     */
    public OneTimePasswordSpec(final byte[] hash, final String seed, final int sequenceNumber) {
        Assert.checkNotNullParam("hash", hash);
        Assert.checkNotNullParam("seed", seed);
        this.hash = hash;
        this.seed = seed;
        this.sequenceNumber = sequenceNumber;
    }

    /**
     * Gets the hash.
     *
     * @return the hash
     */
    public byte[] getHash() {
        return hash;
    }

    /**
     * Gets the seed.
     *
     * @return the seed
     */
    public String getSeed() {
        return seed;
    }

    /**
     * Gets the sequence number.
     *
     * @return the sequence number
     */
    public int getSequenceNumber() {
        return sequenceNumber;
    }

    @Override
    public boolean equals(Object other) {
        if (! (other instanceof OneTimePasswordSpec)) return false;
        OneTimePasswordSpec o = (OneTimePasswordSpec) other;
        return Arrays.equals(hash, o.hash) && Objects.equals(seed, o.seed) && sequenceNumber == o.sequenceNumber;
    }

    @Override
    public int hashCode() {
        return multiHashOrdered(multiHashOrdered(Arrays.hashCode(hash), Objects.hashCode(seed)), sequenceNumber);
    }
}