/*
 * Copyright 2014 Red Hat, Inc.
 *
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * and Apache License v2.0 which accompanies this distribution.
 *
 * The Eclipse Public License is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * The Apache License v2.0 is available at
 * http://www.opensource.org/licenses/apache2.0.php
 *
 * You may elect to redistribute this code under either of these licenses.
 */

package io.vertx.ext.auth.mongo;

import io.vertx.codegen.annotations.Nullable;
import io.vertx.codegen.annotations.VertxGen;
import io.vertx.ext.auth.User;

Determines how the hashing is computed in the implementation You can implement this to provide a different hashing strategy to the default.
Author:mremme
/** * Determines how the hashing is computed in the implementation You can implement this to provide a different hashing * strategy to the default. * * @author mremme */
@VertxGen @Deprecated public interface HashStrategy {
Compute the hashed password given the unhashed password and the user
Params:
  • password – the unhashed password
  • user – the user to get the salt for. This paramter is needed, if the HashSaltStyle.COLUMN is declared to be used
Returns:the hashed password
/** * Compute the hashed password given the unhashed password and the user * * @param password * the unhashed password * @param user * the user to get the salt for. This paramter is needed, if the {@link HashSaltStyle#COLUMN} is declared to be * used * @return the hashed password */
String computeHash(String password, User user);
Retrieve the password from the user, or as clear text or as hashed version, depending on the definition
Params:
  • user – the user to get the stored password for
Returns:the password, either as hashed version or as cleartext, depending on the preferences
/** * Retrieve the password from the user, or as clear text or as hashed version, depending on the definition * * @param user * the user to get the stored password for * @return the password, either as hashed version or as cleartext, depending on the preferences */
String getStoredPwd(User user);
Retrieve the salt. The source of the salt can be the external salt or the propriate column of the given user, depending on the defined HashSaltStyle
Params:
  • user – the user to get the salt for. This paramter is needed, if the HashSaltStyle.COLUMN is declared to be used
Returns:null in case of HashSaltStyle.NO_SALT the salt of the user or a defined external salt
/** * Retrieve the salt. The source of the salt can be the external salt or the propriate column of the given user, * depending on the defined {@link HashSaltStyle} * * @param user * the user to get the salt for. This paramter is needed, if the {@link HashSaltStyle#COLUMN} is declared to be * used * @return null in case of {@link HashSaltStyle#NO_SALT} the salt of the user or a defined external salt */
@Nullable String getSalt(User user);
Set an external salt. This method should be used in case of HashSaltStyle.EXTERNAL
Params:
  • salt – the salt, which shall be used
/** * Set an external salt. This method should be used in case of {@link HashSaltStyle#EXTERNAL} * * @param salt * the salt, which shall be used */
void setExternalSalt(String salt);
Set the saltstyle as defined by HashSaltStyle.
Params:
/** * Set the saltstyle as defined by {@link HashSaltStyle}. * * @param saltStyle * the {@link HashSaltStyle} to be used */
void setSaltStyle(HashSaltStyle saltStyle);
Get the defined HashSaltStyle of the current instance
Returns:the saltStyle
/** * Get the defined {@link HashSaltStyle} of the current instance * * @return the saltStyle */
HashSaltStyle getSaltStyle();
Allows the selection of the hashing algorithm.
Params:
  • algorithm – the choosen algorithm
/** * Allows the selection of the hashing algorithm. * * @param algorithm the choosen algorithm */
void setAlgorithm(HashAlgorithm algorithm); }