Въведение в Apache Shiro

1. Общ преглед

В тази статия ще разгледаме Apache Shiro, гъвкава рамка за защита на Java.

Рамката е силно адаптивна и модулна, тъй като предлага удостоверяване, оторизация, криптография и управление на сесии.

2. Зависимост

Apache Shiro има много модули. В този урок обаче ние използваме само артефакт на широ-ядрото .

Нека го добавим към нашия pom.xml :

 org.apache.shiro shiro-core 1.4.0 

Най-новата версия на модулите Apache Shiro може да бъде намерена в Maven Central.

3. Конфигуриране на Security Manager

В SecurityManager е център парче рамка Apache Широ. Приложенията обикновено имат един-единствен екземпляр от него.

В този урок ние изследваме рамката в работна среда. За да конфигурираме рамката, трябва да създадем файл shiro.ini в папката на ресурса със следното съдържание:

[users] user = password, admin user2 = password2, editor user3 = password3, author [roles] admin = * editor = articles:* author = articles:compose,articles:save

Разделът [потребители] на конфигурационния файл shiro.ini дефинира потребителските идентификационни данни, които се разпознават от SecurityManager . Форматът е: p rincipal (потребителско име) = парола, роля1, роля2, ..., роля .

Ролите и свързаните с тях разрешения са декларирани в раздела [role] . В администратор роля да бъде дадено разрешение и достъп до всяка част на заявлението. Това се обозначава със символа на заместващ знак (*) .

Ролята на редактора има всички разрешения, свързани със статии, докато ролята на автора може да съставя и запазва само статия.

В SecurityManager се използва за конфигуриране на SecurityUtils клас. От SecurityUtils можем да получим текущия потребител, който взаимодейства със системата и да извършим операции за удостоверяване и оторизация.

Нека използваме IniRealm, за да заредим нашите дефиниции на потребители и роли от файла shiro.ini и след това да го използваме за конфигуриране на обекта DefaultSecurityManager :

IniRealm iniRealm = new IniRealm("classpath:shiro.ini"); SecurityManager securityManager = new DefaultSecurityManager(iniRealm); SecurityUtils.setSecurityManager(securityManager); Subject currentUser = SecurityUtils.getSubject();

Сега, след като имаме SecurityManager, който е запознат с идентификационните данни на потребителя и ролите, дефинирани във файла shiro.ini , нека пристъпим към удостоверяване и упълномощаване на потребителя.

4. Удостоверяване

В терминологиите на Apache Shiro, Субект е всеки обект, взаимодействащ със системата. Може да е човек, сценарий или REST клиент.

Извикването на SecurityUtils.getSubject () връща екземпляр на текущия Subject , тоест currentUser .

Сега, когато имаме текущия обект на потребител, можем да извършим удостоверяване на предоставените идентификационни данни:

if (!currentUser.isAuthenticated()) { UsernamePasswordToken token = new UsernamePasswordToken("user", "password"); token.setRememberMe(true); try { currentUser.login(token); } catch (UnknownAccountException uae) { log.error("Username Not Found!", uae); } catch (IncorrectCredentialsException ice) { log.error("Invalid Credentials!", ice); } catch (LockedAccountException lae) { log.error("Your Account is Locked!", lae); } catch (AuthenticationException ae) { log.error("Unexpected Error!", ae); } }

Първо проверяваме дали текущият потребител вече не е удостоверен. След това създаваме токен за удостоверяване с главницата на потребителя (потребителско име) и идентификационни данни (парола).

След това се опитваме да влезем с токена. Ако предоставените идентификационни данни са верни, всичко трябва да се оправи.

Има различни изключения за различните случаи. Също така е възможно да се хвърли персонализирано изключение, което по-добре отговаря на изискванията на приложението. Това може да стане чрез подкласиране на класа AccountException .

5. Разрешение

Удостоверяването се опитва да провери самоличността на потребител, докато упълномощаването се опитва да контролира достъпа до определени ресурси в системата.

Спомнете си, че присвояваме една или повече роли на всеки потребител, който сме създали във файла shiro.ini . Освен това в раздела за роли дефинираме различни разрешения или нива на достъп за всяка роля.

Сега нека видим как можем да използваме това в нашето приложение, за да наложим контрол на достъпа на потребителите.

Във файла shiro.ini даваме на администратора пълен достъп до всяка част от системата.

Редакторът има пълен достъп до всеки ресурс / операция по отношение на статии , а авторът е ограничен само до съставяне и запазване на статии .

Нека приветстваме текущия потребител въз основа на ролята:

if (currentUser.hasRole("admin")) { log.info("Welcome Admin"); } else if(currentUser.hasRole("editor")) { log.info("Welcome, Editor!"); } else if(currentUser.hasRole("author")) { log.info("Welcome, Author"); } else { log.info("Welcome, Guest"); }

Сега нека видим какво е разрешено на текущия потребител да прави в системата:

if(currentUser.isPermitted("articles:compose")) { log.info("You can compose an article"); } else { log.info("You are not permitted to compose an article!"); } if(currentUser.isPermitted("articles:save")) { log.info("You can save articles"); } else { log.info("You can not save articles"); } if(currentUser.isPermitted("articles:publish")) { log.info("You can publish articles"); } else { log.info("You can not publish articles"); }

6. Конфигуриране на царството

В реални приложения ще ни е необходим начин за получаване на потребителски идентификационни данни от база данни, а не от файла shiro.ini . Тук влиза в игра концепцията за Царството.

В терминологията на Apache Shiro, Realm е DAO, който сочи към хранилище от потребителски идентификационни данни, необходими за удостоверяване и упълномощаване.

За да създадем царство, трябва само да внедрим интерфейса Realm . Това може да бъде досадно; обаче, рамката се предлага с реализации по подразбиране, от които можем да подкласираме. Една от тези реализации е JdbcRealm .

Създаваме персонализирана реализация, която разширява класа JdbcRealm и отменя следните методи: doGetAuthenticationInfo () , doGetAuthorizationInfo () , getRoleNamesForUser () и getPermissions () .

Нека създадем царство, като подкласираме класа JdbcRealm :

public class MyCustomRealm extends JdbcRealm { //... }

За по-голяма простота използваме java.util.Map, за да симулираме база данни:

private Map credentials = new HashMap(); private Map
    
      roles = new HashMap(); private Map
     
       perm = new HashMap(); { credentials.put("user", "password"); credentials.put("user2", "password2"); credentials.put("user3", "password3"); roles.put("user", new HashSet(Arrays.asList("admin"))); roles.put("user2", new HashSet(Arrays.asList("editor"))); roles.put("user3", new HashSet(Arrays.asList("author"))); perm.put("admin", new HashSet(Arrays.asList("*"))); perm.put("editor", new HashSet(Arrays.asList("articles:*"))); perm.put("author", new HashSet(Arrays.asList("articles:compose", "articles:save"))); }
     
    

Нека да продължим и да заменим doGetAuthenticationInfo () :

protected AuthenticationInfo doGetAuthenticationInfo(AuthenticationToken token) throws AuthenticationException { UsernamePasswordToken uToken = (UsernamePasswordToken) token; if(uToken.getUsername() == null || uToken.getUsername().isEmpty() || !credentials.containsKey(uToken.getUsername())) { throw new UnknownAccountException("username not found!"); } return new SimpleAuthenticationInfo( uToken.getUsername(), credentials.get(uToken.getUsername()), getName()); }

We first cast the AuthenticationToken provided to UsernamePasswordToken. From the uToken, we extract the username (uToken.getUsername()) and use it to get the user credentials (password) from the database.

If no record is found – we throw an UnknownAccountException, else we use the credential and username to construct a SimpleAuthenticatioInfo object that's returned from the method.

If the user credential is hashed with a salt, we need to return a SimpleAuthenticationInfo with the associated salt:

return new SimpleAuthenticationInfo( uToken.getUsername(), credentials.get(uToken.getUsername()), ByteSource.Util.bytes("salt"), getName() );

We also need to override the doGetAuthorizationInfo(), as well as getRoleNamesForUser() and getPermissions().

Finally, let's plug the custom realm into the securityManager. All we need to do is replace the IniRealm above with our custom realm, and pass it to the DefaultSecurityManager‘s constructor:

Realm realm = new MyCustomRealm(); SecurityManager securityManager = new DefaultSecurityManager(realm);

Every other part of the code is the same as before. This is all we need to configure the securityManager with a custom realm properly.

Now the question is – how does the framework match the credentials?

By default, the JdbcRealm uses the SimpleCredentialsMatcher, which merely checks for equality by comparing the credentials in the AuthenticationToken and the AuthenticationInfo.

If we hash our passwords, we need to inform the framework to use a HashedCredentialsMatcher instead. The INI configurations for realms with hashed passwords can be found here.

7. Logging Out

Now that we've authenticated the user, it's time to implement log out. That's done simply by calling a single method – which invalidates the user session and logs the user out:

currentUser.logout();

8. Session Management

The framework naturally comes with its session management system. If used in a web environment, it defaults to the HttpSession implementation.

For a standalone application, it uses its enterprise session management system. The benefit is that even in a desktop environment you can use a session object as you would do in a typical web environment.

Let's have a look at a quick example and interact with the session of the current user:

Session session = currentUser.getSession(); session.setAttribute("key", "value"); String value = (String) session.getAttribute("key"); if (value.equals("value")) { log.info("Retrieved the correct value! [" + value + "]"); }

9. Shiro for a Web Application With Spring

So far we've outlined the basic structure of Apache Shiro and we have implemented it in a desktop environment. Let's proceed by integrating the framework into a Spring Boot application.

Note that the main focus here is Shiro, not the Spring application – we're only going to use that to power a simple example app.

9.1. Dependencies

First, we need to add the Spring Boot parent dependency to our pom.xml:

 org.springframework.boot spring-boot-starter-parent 2.2.6.RELEASE 

Next, we have to add the following dependencies to the same pom.xml file:

 org.springframework.boot spring-boot-starter-web   org.springframework.boot spring-boot-starter-freemarker   org.apache.shiro shiro-spring-boot-web-starter ${apache-shiro-core-version} 

9.2. Configuration

Adding the shiro-spring-boot-web-starter dependency to our pom.xml will by default configure some features of the Apache Shiro application such as the SecurityManager.

However, we still need to configure the Realm and Shiro security filters. We will be using the same custom realm defined above.

And so, in the main class where the Spring Boot application is run, let's add the following Bean definitions:

@Bean public Realm realm() { return new MyCustomRealm(); } @Bean public ShiroFilterChainDefinition shiroFilterChainDefinition() { DefaultShiroFilterChainDefinition filter = new DefaultShiroFilterChainDefinition(); filter.addPathDefinition("/secure", "authc"); filter.addPathDefinition("/**", "anon"); return filter; }

In the ShiroFilterChainDefinition, we applied the authc filter to /secure path and applied the anon filter on other paths using the Ant pattern.

Both authc and anon filters come along by default for web applications. Other default filters can be found here.

If we did not define the Realm bean, ShiroAutoConfiguration will, by default, provide an IniRealm implementation that expects to find a shiro.ini file in src/main/resources or src/main/resources/META-INF.

If we do not define a ShiroFilterChainDefinition bean, the framework secures all paths and sets the login URL as login.jsp.

We can change this default login URL and other defaults by adding the following entries to our application.properties:

shiro.loginUrl = /login shiro.successUrl = /secure shiro.unauthorizedUrl = /login

Now that the authc filter has been applied to /secure, all requests to that route will require a form authentication.

9.3. Authentication and Authorization

Let's create a ShiroSpringController with the following path mappings: /index, /login, /logout and /secure.

The login() method is where we implement actual user authentication as described above. If authentication is successful, the user is redirected to the secure page:

Subject subject = SecurityUtils.getSubject(); if(!subject.isAuthenticated()) { UsernamePasswordToken token = new UsernamePasswordToken( cred.getUsername(), cred.getPassword(), cred.isRememberMe()); try { subject.login(token); } catch (AuthenticationException ae) { ae.printStackTrace(); attr.addFlashAttribute("error", "Invalid Credentials"); return "redirect:/login"; } } return "redirect:/secure";

And now in the secure() implementation, the currentUser was obtained by invoking the SecurityUtils.getSubject(). The role and permissions of the user are passed on to the secure page, as well the user's principal:

Subject currentUser = SecurityUtils.getSubject(); String role = "", permission = ""; if(currentUser.hasRole("admin")) { role = role + "You are an Admin"; } else if(currentUser.hasRole("editor")) { role = role + "You are an Editor"; } else if(currentUser.hasRole("author")) { role = role + "You are an Author"; } if(currentUser.isPermitted("articles:compose")) { permission = permission + "You can compose an article, "; } else { permission = permission + "You are not permitted to compose an article!, "; } if(currentUser.isPermitted("articles:save")) { permission = permission + "You can save articles, "; } else { permission = permission + "\nYou can not save articles, "; } if(currentUser.isPermitted("articles:publish")) { permission = permission + "\nYou can publish articles"; } else { permission = permission + "\nYou can not publish articles"; } modelMap.addAttribute("username", currentUser.getPrincipal()); modelMap.addAttribute("permission", permission); modelMap.addAttribute("role", role); return "secure";

And we're done. That's how we can integrate Apache Shiro into a Spring Boot Application.

Also, note that the framework offers additional annotations that can be used alongside filter chain definitions to secure our application.

10. JEE Integration

Интегрирането на Apache Shiro в приложение на JEE е само въпрос на конфигуриране на файла web.xml . Както обикновено, конфигурацията очаква shiro.ini да бъде в пътя на класа. Подробна примерна конфигурация е достъпна тук. Също така, JSP таговете можете да намерите тук.

11. Заключение

В този урок разгледахме механизмите за удостоверяване и упълномощаване на Apache Shiro. Също така се фокусирахме върху това как да дефинираме персонализирано царство и да го включим в SecurityManager .

Както винаги, пълният изходен код е достъпен в GitHub.