/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.apache.cassandra.db.guardrails;

import org.passay.DictionaryRule;
import org.passay.PasswordData;
import org.passay.RuleResult;

/**
 * Tells whether a validator, like e.g. {@link CassandraPasswordValidator} is supporting checking
 * the values (passwords) against a dictionary. It is up to implementator of a validator to call
 * {@link #initializeDictionaryRule(CassandraPasswordConfiguration)} in an implementation of a validator
 * to decide how {@link DictionaryRule} should be constructed.
 */
public interface PasswordDictionaryAware<T extends CassandraPasswordConfiguration>
{
    /**
     * Performs lookup of a password in a dictionary.
     *
     * @param password password to check if it is in a dictionary or not
     * @return result of operation
     */
    RuleResult foundInDictionary(String password);

    /**
     * Performs lookup of a password in a dictionary.
     *
     * @param passwordData password data to check if it is in a dictionary or not
     * @return result of operation
     */
    RuleResult foundInDictionary(PasswordData passwordData);

    /**
     * Initializes dictionary rule for a validator.
     *
     * @param configuration configuration to use to initialize dictionary rule
     * @return initialized dictionary rule
     */
    DictionaryRule initializeDictionaryRule(T configuration);
}
