Проверка подлинности на основе форм Java JAAS

Внедрение модуля входа в систему с использованием JAAS является актуальной темой, и большинство разработчиков имеют редкие шансы участвовать в разработке такого рода. Но базовая реализация модуля входа в систему JAAS не так сложна, потому что я собирался опубликовать это.

Здесь я объясняю, как реализовать модуль управляемой аутентификации tomcat. Эта реализация не зависит от контейнера. Мы можем использовать его с любым контейнером с небольшим изменением конфигурации.

В качестве первого шага нам нужно создать класс модуля входа в систему, который реализует интерфейс javax.security.auth.spi.LoginModule . Этот интерфейс предоставляет 5 методов, которые должны быть реализованы нашим классом модуля входа в систему. Это initialize (), login (), commit (), abort (), logout () .

Метод initialize () получает четыре аргумента.

«Тема» — это то, что нам нужно аутентифицировать. Субъект может представлять связанную информацию для одного пользователя входа в систему. Он может представлять идентификаторы, такие как «имя пользователя», «пароль» и т. Д. А также он может представлять роли, назначенные пользователю. Все эти идентичности должны быть представлены как java.security.Principal. Поэтому мы должны создать отдельные классы, чтобы различать эти сущности путем реализации java.security.Principal . В своем руководстве я создал отдельные классы для имени пользователя, пароля и роли, такие как JAASUserPrincipal, JAASPasswordPrincipal и JAASRolePrincipal. Метод субъекта getPrincipals () возвращает набор java.security.Principal, связанный с темой. Чтобы различать их, важно создать отдельные классы для каждой идентичности.

CallbackHandler используется для связи с пользователем. При аутентификации пользователя модулем входа в систему модуль входа в систему вызывает метод handle () экземпляра CallbackHandler, чтобы получить имя пользователя и пароль. Мы пока не хотим беспокоиться об экземпляре CallbackHandler. Потому что контейнеру удается обеспечить требуемые коллбакки. Для этой цели кот предоставляет JAASCallbackHandler . Но, если мы хотим вызвать аутентификацию явно, нам нужно создать наш собственный класс обработчика обратного вызова, реализовав javax.security.auth.callback.CallbackHandler . Я объясню это в конце урока.

Следующий важный аргумент для метода initialize () — это ‘options’. Эти параметры, где мы объявляем их в файле ‘ jass.config ‘. При инициализации модуля входа в систему предоставляется карта опций, объявленных в файле ‘jass.config’. Я объясню файл jaas.config нашего руководства позже.

Далее я покажу полный исходный код для наших основных классов.

JAASUserPrincipal.java

package com.rainyday.server.login;
 
 import java.io.Serializable;
 import java.security.Principal;
 
/**
 * @author semika
 *
 */
 public class JAASUserPrincipal implements Principal, Serializable {
 
 private String name;
  
 /**
  * @param name
  */
 public JAASUserPrincipal(String name) {
   
 if (name == null) {
     throw new NullPointerException("NULL user name");
 }
     this.name = name;
 }
  
 @Override
 public String getName() {
     return name;
 }
 
 @Override
 public String toString() {
     return "UserPrincipal [name=" + name + "]";
 }
 
 @Override
 public int hashCode() {
     final int prime = 31;
     int result = 1;
     result = prime * result + ((name == null) ? 0 : name.hashCode());
     return result;
 }
 
 @Override
 public boolean equals(Object obj) {
     if (this == obj)
        return true;
     if (obj == null)
        return false;
     if (getClass() != obj.getClass())
        return false;
     JAASUserPrincipal other = (JAASUserPrincipal) obj;
     if (name == null) {
        if (other.name != null)
           return false;
     } else if (!name.equals(other.name))
        return false;
   
     return true;
 }
}

JAASRolePrincipal.java

package com.rainyday.server.login;
 
 import java.io.Serializable;
 import java.security.Principal;
 
/**
 * @author semika
 *
 */
 public class JAASRolePrincipal implements Principal, Serializable {
 
 private String name;
  
 /**
  * @param name
  */
 public JAASRolePrincipal(String name) {
     if (name == null) {
        throw new NullPointerException("NULL role name");
     }
     this.name = name;
 }
 
 @Override
 public String getName() {
    return name;
 }
 
 @Override
 public String toString() {
     return "JASSRolePrincipal [name=" + name + "]";
 }
 
 @Override
 public int hashCode() {
     final int prime = 31;
     int result = 1;
     result = prime * result + ((name == null) ? 0 : name.hashCode());
     return result;
 }
 
 @Override
 public boolean equals(Object obj) {
     if (this == obj)
        return true;
     if (obj == null)
        return false;
     if (getClass() != obj.getClass())
        return false;
     JAASRolePrincipal other = (JAASRolePrincipal) obj;
     if (name == null) {
        if (other.name != null)
           return false;
     } else if (!name.equals(other.name))
        return false;
      
     return true;
 }
}

JAASPasswordPrincipal.java

package com.rainyday.server.login;
 
 import java.io.Serializable;
 import java.security.Principal;
 
/**
 * @author semika
 *
 */
 public class JAASPasswordPrincipal implements Principal, Serializable {
 
 private String name;
  
 /**
  * @param name
  */
 public JAASPasswordPrincipal(String name) {
     if (name == null) {
        throw new NullPointerException("NULL password.");
     }
     this.name = name;
 }
 
 @Override
 public String getName() {
     return name;
 }
 
 @Override
 public int hashCode() {
     final int prime = 31;
     int result = 1;
     result = prime * result + ((name == null) ? 0 : name.hashCode());
     return result;
 }
 
 @Override
 public boolean equals(Object obj) {
     if (this == obj)
         return true;
     if (obj == null)
         return false;
     if (getClass() != obj.getClass())
         return false;
     JAASPasswordPrincipal other = (JAASPasswordPrincipal) obj;
     if (name == null) {
        if (other.name != null)
           return false;
     } else if (!name.equals(other.name))
        return false;
      
     return true;
 }
 
 @Override
 public String toString() {
     return "JAASPasswordPrincipal [name=" + name + "]";
 }
 
}

Выше три класса в точности похожи. Но нам нужно создать отдельные классы для каждого принципала, чтобы различать их.

Метод login () модуля login выполняет аутентификацию. Это проверяет введенные пользователем имя пользователя и пароль с базой данных. Теперь у вас может возникнуть проблема, как введенные пользователем данные для входа в систему входят в метод login (). Как я объяснил ранее, обработчик обратного вызова переносит идентификаторы входа в систему в метод login (). Из метода login () модуль login вызывает метод handle () обработчика обратного вызова, передавая в него необходимые обратные вызовы. Затем метод handle () заполняет эти обратные вызовы необходимой информацией и делает доступным метод login ().

Метод commit () вызывается модулем входа в систему после успешной аутентификации. Предмет может быть заполнен соответствующими принципами. Например, мы можем извлечь назначенные пользователем роли из базы данных и прикрепить их к теме.

Далее я объясню необходимые конфигурации для работы этого модуля входа в систему.

Мы должны создать файл ‘jass.config’ и поместить его в папку ‘ $ CATALINA_HOME / conf ‘.

Файл ‘jass.config’ этого руководства выглядит следующим образом.

rainyDay {
   com.rainyday.server.login.JAASLoginModule required
   dbDriver="com.mysql.jdbc.Driver"
   dbURL="jdbc:mysql://localhost/rainyday"
   dbUser="root"
   dbPassword="abc123"
   userQuery="select username from secu_user where secu_user.username=? and secu_user.password=?"
   roleQuery="select secu_user_role.rolename from secu_user, secu_user_role "
             + "where secu_user.username=secu_user_role.username and secu_user.username=?"
   debug=true;
};

Файл ‘jass.config’ должен иметь такой же формат. В дополнение к объявлению модуля входа в систему, вы можете объявить параметры по своему желанию. Эти параметры доступны модулем входа в систему с помощью карты параметров в аргументе метода initialize ().

Кроме того, мы должны сообщить tomcat, где найти файл ‘jaas.config’, добавив его путь к переменной среды JAVA_OPTS . Я добавил это в файл catalina.sh в каталоге $ CATALINA_HOME / bin следующим образом.

JAVA_OPTS = ”$ JAVA_OPTS -Djava.security.auth.login.config == .. / conf / jaas.config”

Далее необходимо объявить конфигурации JAASRealm . Вы можете добавить новую запись ‘Realm’ в файл server.xml в папке $ CATALINA_HOME / conf. В нашем уроке запись «Царство» выглядит следующим образом.

<Realm className="org.apache.catalina.realm.JAASRealm"
 appName="rainyDay"
 userClassNames="com.rainyday.server.login.JASSUserPrincipal,com.rainyday.server.login.JAASPasswordPrincipal"
 roleClassNames="com.rainyday.server.login.JASSRolePrincipal"/>

Для конфигурации области apache tomcat, Вы можете просмотреть эту документацию . Полный исходный код нашего модуля входа в систему jaas.

JAASLoginModule.java

package com.rainyday.server.login;
 
import java.io.IOException;
import java.sql.Connection;
import java.sql.DriverManager;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
 
import javax.security.auth.Subject;
import javax.security.auth.callback.Callback;
import javax.security.auth.callback.CallbackHandler;
import javax.security.auth.callback.NameCallback;
import javax.security.auth.callback.PasswordCallback;
import javax.security.auth.callback.UnsupportedCallbackException;
import javax.security.auth.login.LoginException;
import javax.security.auth.spi.LoginModule;
 
import org.apache.log4j.Logger;
 
/**
 * @author semika
 *
 */
public class JAASLoginModule implements LoginModule { 
  
    private static Logger LOGGER = Logger.getLogger(JAASLoginModule.class); 
  
    // initial state
    private Subject subject;
    private CallbackHandler callbackHandler;
    private Map sharedState;
    private Map options;
 
    // configurable option
    private boolean debug = false;
     
    // the authentication status
    private boolean succeeded = false;
    private boolean commitSucceeded = false;
     
    //user credentials
    private String username = null;
    private char[] password = null;
     
    //user principle
    private JAASUserPrincipal userPrincipal = null;
    private JAASPasswordPrincipal passwordPrincipal = null;
     
    public JAASLoginModule() {
         super();
    }
 
    @Override
    public void initialize(Subject subject, CallbackHandler callbackHandler,
                Map<string, ?=""> sharedState, Map<string, ?=""> options) {
        this.subject = subject;
        this.callbackHandler = callbackHandler;
        this.sharedState = sharedState;
        this.options = options;
   
        debug = "true".equalsIgnoreCase((String)options.get("debug")); 
    }
 
    @Override
    public boolean login() throws LoginException {
   
        if (callbackHandler == null){
            throw new LoginException("Error: no CallbackHandler available " +
            "to garner authentication information from the user");
        }
        Callback[] callbacks = new Callback[2];
        callbacks[0] = new NameCallback("username");
        callbacks[1] = new PasswordCallback("password: ", false);
   
        try {
    
            callbackHandler.handle(callbacks);
            username = ((NameCallback)callbacks[0]).getName();
            password = ((PasswordCallback)callbacks[1]).getPassword();
    
            if (debug) {
                LOGGER.debug("Username :" + username);
                LOGGER.debug("Password : " + password);
            }
    
            if (username == null || password == null) {
                LOGGER.error("Callback handler does not return login data properly");
                throw new LoginException("Callback handler does not return login data properly"); 
            }
    
            if (isValidUser()) { //validate user.
                succeeded = true;
                return true;
            } 
    
        } catch (IOException e) { 
             e.printStackTrace();
        } catch (UnsupportedCallbackException e) {
             e.printStackTrace();
        }
   
        return false;
    }
 
    @Override
    public boolean commit() throws LoginException {
        if (succeeded == false) {
            return false;
        } else { 
            userPrincipal = new JAASUserPrincipal(username);
            if (!subject.getPrincipals().contains(userPrincipal)) {
                subject.getPrincipals().add(userPrincipal);
                LOGGER.debug("User principal added:" + userPrincipal);
            }
            passwordPrincipal = new JAASPasswordPrincipal(new String(password)); 
            if (!subject.getPrincipals().contains(passwordPrincipal)) {
                subject.getPrincipals().add(passwordPrincipal);
                LOGGER.debug("Password principal added: " + passwordPrincipal);
            }
       
            //populate subject with roles.
            List<string> roles = getRoles();
            for (String role: roles) {
                JAASRolePrincipal rolePrincipal = new JAASRolePrincipal(role);
                if (!subject.getPrincipals().contains(rolePrincipal)) {
                    subject.getPrincipals().add(rolePrincipal); 
                    LOGGER.debug("Role principal added: " + rolePrincipal);
                }
            }
       
            commitSucceeded = true;
       
            LOGGER.info("Login subject were successfully populated with principals and roles"); 
       
            return true;
       }
   }
 
   @Override
   public boolean abort() throws LoginException {
      if (succeeded == false) {
          return false;
      } else if (succeeded == true && commitSucceeded == false) {
          succeeded = false;
          username = null;
          if (password != null) {
              password = null;
          }
          userPrincipal = null;    
      } else {
          logout();
      }
      return true;
   }
 
    @Override
    public boolean logout() throws LoginException {
        subject.getPrincipals().remove(userPrincipal);
        succeeded = false;
        succeeded = commitSucceeded;
        username = null;
        if (password != null) {
            for (int i = 0; i < password.length; i++){
                password[i] = ' ';
                password = null;
            }
        }
        userPrincipal = null;
        return true;
   }
  
   private boolean isValidUser() throws LoginException {
 
      String sql = (String)options.get("userQuery");
      Connection con = null;
      ResultSet rs = null;
      PreparedStatement stmt = null;
   
      try {
          con = getConnection();
          stmt = con.prepareStatement(sql);
          stmt.setString(1, username);
          stmt.setString(2, new String(password));
    
          rs = stmt.executeQuery();
    
          if (rs.next()) { //User exist with the given user name and password.
              return true;
          }
       } catch (Exception e) {
           LOGGER.error("Error when loading user from the database " + e);
           e.printStackTrace();
       } finally {
           try {
               rs.close();
           } catch (SQLException e) {
               LOGGER.error("Error when closing result set." + e);
           }
           try {
               stmt.close();
           } catch (SQLException e) {
               LOGGER.error("Error when closing statement." + e);
           }
           try {
               con.close();
           } catch (SQLException e) {
               LOGGER.error("Error when closing connection." + e);
           }
       }
       return false;
   }
 
 /**
  * Returns list of roles assigned to authenticated user.
  * @return
  */
  private List<string> getRoles() { 
   
      Connection con = null;
      ResultSet rs = null;
      PreparedStatement stmt = null;
   
      List<string> roleList = new ArrayList<string>(); 
   
      try {
          con = getConnection();
          String sql = (String)options.get("roleQuery");
          stmt = con.prepareStatement(sql);
          stmt.setString(1, username);
    
          rs = stmt.executeQuery();
    
          if (rs.next()) { 
              roleList.add(rs.getString("rolename")); 
          }
      } catch (Exception e) {
          LOGGER.error("Error when loading user from the database " + e);
          e.printStackTrace();
      } finally {
           try {
               rs.close();
           } catch (SQLException e) {
               LOGGER.error("Error when closing result set." + e);
           }
           try {
               stmt.close();
           } catch (SQLException e) {
               LOGGER.error("Error when closing statement." + e);
           }
           try {
               con.close();
           } catch (SQLException e) {
               LOGGER.error("Error when closing connection." + e);
           }
       }
       return roleList;
 }
  
 /**
  * Returns JDBC connection
  * @return
  * @throws LoginException
  */
  private Connection getConnection() throws LoginException {
   
      String dBUser = (String)options.get("dbUser");
      String dBPassword = (String)options.get("dbPassword");
      String dBUrl = (String)options.get("dbURL");
      String dBDriver = (String)options.get("dbDriver");
 
      Connection con = null;
      try {
         //loading driver
         Class.forName (dBDriver).newInstance();
         con = DriverManager.getConnection (dBUrl, dBUser, dBPassword);
      } 
      catch (Exception e) {
         LOGGER.error("Error when creating database connection" + e);
         e.printStackTrace();
      } finally {
      }
      return con;
   }
}

Метод abort () модуля login будет вызван, если что-то пошло не так в ходе выполнения метода login () или commit (). В подобной ситуации мы не можем сказать, что процесс аутентификации был успешно завершен, и необходимые операции очистки могут быть выполнены с помощью метода abort (), если в процессе аутентификации произошла ошибка.

Мы можем использовать карту ‘options’, которая была инициализирована в методе initialize () модуля login, чтобы получить информацию о конфигурации, объявленную в файле ‘jass.config’. Вы можете придумать хорошую технику для получения объекта соединения JDBC. Я не сосредоточился на этом в этом уроке и хотел показать вам механизм, как все должно быть сделано.

К настоящему времени мы завершили то, что требуется для базового модуля аутентификации JAAS. Далее нам нужно настроить ограничения безопасности в файле web.xml.

<login-config>
     <auth-method>FORM</auth-method>
     <realm-name>rainyDay</realm-name>
     <form-login-config>
          <form-login-page>/login.jsp</form-login-page>
          <form-error-page>/error.jsp</form-error-page>
     </form-login-config>
</login-config>
<security-role>
    <role-name>*</role-name>
</security-role>
<security-constraint>
    <web-resource-collection>
         <web-resource-name>Rainy day</web-resource-name>
         <url-pattern>/</url-pattern>
         <http-method>POST</http-method>
         <http-method>GET</http-method>
    </web-resource-collection>
    <auth-constraint>
         <role-name>*</role-name>
    </auth-constraint>
</security-constraint>

С учетом вышеуказанных ограничений безопасности, если какой-либо запрос поступает к конкретному ресурсу в защищенной области приложения без аутентификации, запрос будет перенаправлен на страницу входа в систему. Далее я покажу вам простую HTML-форму, которая вызывает наш модуль входа в систему с отправкой формы.

<form id="loginForm" name="loginForm" method="post" action="j_security_check">
       User Name : <input id="username" type="text" name="j_username" class="textbox"></input>
       Password : <input id="password" type="password" name="j_password" class="textbox"></input>
       <input name="login" type="submit" value="LOGIN" id="submit" class="button blue">
</form>

Итак, мы закончили с этим. Это очень базовая реализация JAAS. Преимущество этого типа модуля JAAS заключается в том, что мы можем переключиться на другую реализацию модуля входа в систему только с одним изменением конфигурации и без каких-либо изменений нашего существующего кода. А также это не зависит от контейнера. Если вы хотите развернуть его на сервере jBoss вместо jass.config, вы можете использовать файл login-config.xml в папке conf jboss. Как я и обещал вам объяснить, как явно вызывать этот вид модуля входа в систему, вот оно. Есть некоторые обстоятельства, нам нужно прагматично аутентифицировать конкретного пользователя, но все же мы должны использовать наш реализованный модуль входа в систему. В такой ситуации большая проблема заключается в предоставлении идентификаторов пользователя (имя пользователя, пароль и т. Д.) Нашему модулю входа в систему. В приведенном выше случае мы использовали класс CallbackHandler, который представляет собой JAASCallbackHander, предоставленный Apache Catalina. Но здесь мы не можем использовать, и мы должны реализовать наш собственный класс обработчика обратного вызова.

JAASCallbackHandler.java

package com.rainyday.server.login;
 
import java.io.IOException;
 
import javax.security.auth.callback.Callback;
import javax.security.auth.callback.CallbackHandler;
import javax.security.auth.callback.NameCallback;
import javax.security.auth.callback.PasswordCallback;
import javax.security.auth.callback.UnsupportedCallbackException;
 
import org.apache.log4j.Logger;
 
/**
 * @author semika
 *
 */
 public class JAASCallbackHandler implements CallbackHandler {
 
 private static final Logger LOGGER = Logger.getLogger(JAASCallbackHandler.class);
  
 private String username = null;
 private String password = null;
  
 /**
  * @param username
  * @param password
  */
 public JAASCallbackHandler(String username, String password) {
     this.username = username;
     this.password = password;
 }
 
 
 @Override
 public void handle(Callback[] callbacks) throws IOException,
   UnsupportedCallbackException {
   
     LOGGER.info("Callback Handler invoked ");
   
     for (int i = 0; i < callbacks.length; i++) {
        if (callbacks[i] instanceof NameCallback) {
           NameCallback nameCallback = (NameCallback) callbacks[i];
           nameCallback.setName(username);
        } else if (callbacks[i] instanceof PasswordCallback) {
           PasswordCallback passwordCallback = (PasswordCallback) callbacks[i];
           passwordCallback.setPassword(password.toCharArray());
        } else {
           throw new UnsupportedCallbackException(callbacks[i], "The submitted Callback is unsupported");
        }
     }
 }
}

Затем мы должны создать экземпляр LoginContext, чтобы явно вызвать аутентификацию.

LoginContext lc = null;
try {
    lc = new LoginContext("rainyDay", new JAASCallbackHandler(username, password));
    lc.login();
    //get the subject.
    Subject subject = lc.getSubject();
    //get principals
    subject.getPrincipals();
    LOGGER.info("established new logincontext");
} catch (LoginException e) {
    LOGGER.error("Authentication failed " + e);
} 

Если в итоге мы выполним приведенный выше код без каких-либо исключений, это означает, что аутентификация прошла успешно. Если возникла исключительная ситуация, проверка подлинности не удалась.

Это все из этого урока. http://docs.oracle.com/javaee/1.4/tutorial/doc/Security5.html был хорошим уроком для меня, чтобы понять аутентификацию при входе в систему.

Ссылка: аутентификация на основе Java-формы от нашего партнера по JCG Семика локу калуге в блоге Code Box .

Проверка подлинности на основе форм Java JAAS

Категории

Последние статьи

Рефакторинг Hudson God Class

Альтернативы синтаксиса Java лямбда

Morphia и MongoDB: развивающиеся структуры документов

OpenShift Express: развертывание приложения Java EE (с поддержкой AS7)

Интеграция jqGrid, REST, AJAX и Spring MVC