Pengantar Apache Shiro

1. Ikhtisar

Pada artikel ini, kita akan melihat Apache Shiro, kerangka kerja keamanan Java yang serbaguna.

Framework ini sangat dapat disesuaikan dan modular, karena menawarkan otentikasi, otorisasi, kriptografi, dan manajemen sesi.

2. Ketergantungan

Apache Shiro memiliki banyak modul. Namun, dalam tutorial ini, kami hanya menggunakan artefak shiro-core .

Mari tambahkan ke pom.xml kita :

 org.apache.shiro shiro-core 1.4.0 

Versi terbaru dari modul Apache Shiro dapat ditemukan di Maven Central.

3. Konfigurasi Manajer Keamanan

The SecurityManager adalah bagian pusat dari kerangka Apache Shiro ini. Aplikasi biasanya akan menjalankan satu contoh.

Dalam tutorial ini, kami menjelajahi kerangka kerja di lingkungan desktop. Untuk mengonfigurasi kerangka kerja, kita perlu membuat file shiro.ini di folder sumber daya dengan konten berikut:

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

Bagian [pengguna] dari file konfigurasi shiro.ini menentukan kredensial pengguna yang dikenali oleh SecurityManager . Formatnya adalah: p rincipal (nama pengguna) = sandi, peran1, peran2,…, peran .

Peran dan izin yang terkait dideklarasikan di bagian [peran] . The admin Peran diberikan izin dan akses ke setiap bagian dari aplikasi. Ini ditunjukkan dengan simbol wildcard (*) .

The Editor peran memiliki semua izin yang terkait dengan artikel sedangkan penulis peran hanya bisa menulis dan menyimpan sebuah artikel.

The SecurityManager digunakan untuk mengkonfigurasi SecurityUtils kelas. Dari SecurityUtils kita bisa mendapatkan pengguna saat ini yang berinteraksi dengan sistem dan melakukan operasi otentikasi dan otorisasi.

Mari gunakan IniRealm untuk memuat definisi pengguna dan peran kita dari file shiro.ini dan kemudian menggunakannya untuk mengkonfigurasi objek DefaultSecurityManager :

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

Sekarang setelah kita memiliki SecurityManager yang mengetahui kredensial dan peran pengguna yang ditentukan dalam file shiro.ini , mari lanjutkan ke otentikasi dan otorisasi pengguna.

4. Otentikasi

Dalam terminologi Apache Shiro, Subjek adalah entitas apa pun yang berinteraksi dengan sistem. Ini bisa berupa manusia, skrip, atau Klien REST.

Memanggil SecurityUtils.getSubject () mengembalikan instance dari Subjek saat ini , yaitu, currentUser .

Sekarang kita memiliki Objek Pengguna saat ini , kita dapat melakukan otentikasi pada kredensial yang diberikan:

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); } }

Pertama, kami memeriksa apakah pengguna saat ini belum diautentikasi. Kemudian kami membuat token otentikasi dengan prinsip pengguna (nama pengguna) dan kredensial (kata sandi).

Selanjutnya, kami mencoba masuk dengan token. Jika kredensial yang diberikan benar, semuanya akan baik-baik saja.

Ada pengecualian berbeda untuk kasus berbeda. Dimungkinkan juga untuk membuat pengecualian khusus yang lebih sesuai dengan persyaratan aplikasi. Ini dapat dilakukan dengan membuat subclass kelas AccountException .

5. Otorisasi

Otentikasi mencoba untuk memvalidasi identitas pengguna sementara otorisasi mencoba untuk mengontrol akses ke sumber daya tertentu dalam sistem.

Ingatlah bahwa kami menetapkan satu atau lebih peran untuk setiap pengguna yang telah kami buat di file shiro.ini . Selanjutnya, di bagian peran, kami menetapkan izin atau tingkat akses yang berbeda untuk setiap peran.

Sekarang mari kita lihat bagaimana kita bisa menggunakannya di aplikasi kita untuk menegakkan kontrol akses pengguna.

Di file shiro.ini , kami memberikan akses total kepada admin ke setiap bagian sistem.

Editor memiliki akses total ke setiap sumber daya / operasi terkait artikel , dan penulis dibatasi hanya untuk menulis dan menyimpan artikel saja.

Mari kita sambut pengguna saat ini berdasarkan peran:

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"); }

Sekarang, mari kita lihat apa yang diizinkan untuk dilakukan oleh pengguna saat ini di sistem:

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. Konfigurasi Realm

Dalam aplikasi nyata, kita membutuhkan cara untuk mendapatkan kredensial pengguna dari database daripada dari file shiro.ini . Di sinilah konsep Realm berperan.

Dalam terminologi Apache Shiro, Realm adalah DAO yang mengarah ke penyimpanan kredensial pengguna yang diperlukan untuk otentikasi dan otorisasi.

Untuk membuat sebuah realm, kita hanya perlu mengimplementasikan interface Realm . Itu bisa membosankan; namun, kerangka kerja ini dilengkapi dengan implementasi default yang dapat kita gunakan untuk membuat subkelas. Salah satu implementasi ini adalah JdbcRealm .

Kami membuat implementasi realm kustom yang memperluas kelas JdbcRealm dan mengganti metode berikut: doGetAuthenticationInfo () , doGetAuthorizationInfo () , getRoleNamesForUser () dan getPermissions () .

Mari buat sebuah realm dengan membuat subclass kelas JdbcRealm :

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

Demi kesederhanaan, kami menggunakan java.util.Map untuk mensimulasikan database:

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"))); }
     
    

Mari lanjutkan dan timpa 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

Mengintegrasikan Apache Shiro ke dalam aplikasi JEE hanyalah masalah konfigurasi file web.xml . Seperti biasa, konfigurasi mengharapkan shiro.ini berada di jalur kelas. Contoh konfigurasi terperinci tersedia di sini. Juga, tag JSP dapat ditemukan di sini.

11. Kesimpulan

Dalam tutorial ini, kita melihat mekanisme otentikasi dan otorisasi Apache Shiro. Kami juga fokus pada cara menentukan ranah kustom dan menghubungkannya ke SecurityManager .

Seperti biasa, kode sumber lengkap tersedia di GitHub.