src/org/mxchange/jusercore/model/user/UserUtils.java

   1 /*
   2  * Copyright (C) 2016 Roland Haeder
   3  *
   4  * This program is free software: you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation, either version 3 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16  */
  17 package org.mxchange.jusercore.model.user;
  18
  19 import org.apache.commons.codec.digest.Crypt;
  20 import org.mxchange.jcore.BaseFrameworkSystem;
  21 import org.mxchange.jusercore.container.login.LoginContainer;
  22
  23 /**
  24  * An utilities class for customers
  25  * <p>
  26  * @author Roland Haeder
  27  */
  28 public class UserUtils extends BaseFrameworkSystem {
  29
  30         /**
  31          * Length of salt
  32          */
  33         private static final int SALT_LENGTH = 10;
  34
  35         /**
  36          * Hashes given user password and adds a salt to it
  37          * <p>
  38          * @param userPassword User password to be hashed
  39          * <p>
  40          * @return Hashed user password
  41          */
  42         public static String encryptPassword (final String userPassword) {
  43                 // Is it null or empty?
  44                 if (null == userPassword) {
  45                         // Throw NPE
  46                         throw new NullPointerException("userPassword is null");
  47                 } else if (userPassword.isEmpty()) {
  48                         // Empty passwords are hardcoded not allowed due to security risks
  49                         throw new IllegalArgumentException("userPassword is empty");
  50                 }
  51
  52                 // Generate large number
  53                 String number = Long.toString(Math.round(Math.random() * 10_000_000_000L));
  54
  55                 // Generate salt
  56                 String salt = Crypt.crypt(number);
  57
  58                 // First encrypt password
  59                 String encryptedPassword = Crypt.crypt(userPassword, salt);
  60
  61                 // Return it
  62                 return encryptedPassword;
  63         }
  64
  65         /**
  66          * Checks if password from container matches the updatedUser's password
  67          * <p>
  68          * @param container Container holding user instance and unencrypted password
  69          * @param updatedUser Updated user instance from database
  70          * <p>
  71          * @return Whethet the password matches
  72          */
  73         public static boolean ifPasswordMatches (final LoginContainer container, final User updatedUser) {
  74                 // Validate parameters
  75                 if (null == container) {
  76                         // Throw NPE
  77                         throw new NullPointerException("container is null");
  78                 } else if (null == updatedUser) {
  79                         // And again NPE ...
  80                         throw new NullPointerException("updatedUser is null");
  81                 } else if (container.getUser() == null) {
  82                         // NPE for user in container
  83                         throw new NullPointerException("container.user is null");
  84                 } else if (container.getUserPassword() == null) {
  85                         // NPE for user password in container
  86                         throw new NullPointerException("container.userPassword is null");
  87                 } else if (container.getUserPassword().isEmpty()) {
  88                         // Empty password in container
  89                         throw new IllegalArgumentException("container.userPassword is empty");
  90                 }
  91
  92                 // First encrypt password
  93                 String encryptedPassword = Crypt.crypt(container.getUserPassword(), updatedUser.getUserEncryptedPassword());
  94
  95                 // Is it matching?
  96                 return encryptedPassword.equals(updatedUser.getUserEncryptedPassword());
  97         }
  98
  99         /**
 100          * No instance from this class
 101          */
 102         private UserUtils () {
 103         }
 104 }