Keycloak dan Spring Boot: Panduan Terbaik untuk Melaksanakan Single Sign-On

pengenalan:

Single Sign-On (SSO) telah menjadi ciri penting dalam aplikasi web moden, meningkatkan pengalaman pengguna dan keselamatan. Panduan komprehensif ini akan memandu anda melaksanakan SSO menggunakan Keycloak dan Spring Boot, menyediakan penyelesaian pengesahan dan kebenaran yang teguh untuk aplikasi anda.

Kepentingan SSO dengan Keycloak

Single Sign-On (SSO) adalah penting untuk memperkemas proses pengesahan, meningkatkan keselamatan dan menambah baik pengalaman pengguna. Berikut adalah beberapa faedah utama:

1. Pengesahan Berpusat: SSO membenarkan pengguna untuk mengesahkan sekali dan mendapat akses kepada berbilang aplikasi. Keycloak menyediakan pengurusan terpusat untuk identiti pengguna, yang berguna dalam persekitaran dengan pelbagai aplikasi.

2. Keselamatan yang Dipertingkat: Dengan pengurusan identiti berpusat, dasar keselamatan (seperti kekuatan kata laluan, pengesahan dua faktor dan dasar kunci keluar akaun) boleh dikuatkuasakan secara seragam. Sokongan Keycloak untuk protokol seperti OpenID Connect dan OAuth 2.0 memastikan standard keselamatan moden yang teguh.

3. Mengurangkan Keletihan Kata Laluan dan Pengalaman Pengguna yang Dipertingkatkan: Dengan melog masuk sekali sahaja, pengguna mengelakkan keletihan kata laluan dan berbilang bukti kelayakan, yang membawa kepada interaksi yang lebih lancar dan pantas merentas aplikasi.

4. Skalabiliti dan Fleksibiliti: Konfigurasi Keycloak boleh menyokong sejumlah besar pengguna dan berbilang pembekal identiti, termasuk log masuk sosial (Google, Facebook, dll.) dan direktori perusahaan (LDAP, Active Directory).

5. Penyesuaian dan Kebolehlanjutan: Keycloak membenarkan tema tersuai, aliran log masuk dan sambungan, menjadikannya boleh disesuaikan dengan pelbagai keperluan. Ia juga merupakan sumber terbuka, memberikan fleksibiliti kepada organisasi untuk mengubah suai atau melanjutkan platform mengikut keperluan.
   Alternatif kepada Single Sign-On (SSO):

6. Log Masuk Berbilang / Pengesahan Tradisional:

   • Pengguna mempunyai kelayakan berasingan untuk setiap aplikasi atau perkhidmatan
   • Memerlukan log masuk secara individu ke setiap sistem
   • Setiap aplikasi menguruskan pengesahannya sendiri

7. Identiti Bersekutu:

   • Serupa dengan SSO, tetapi membenarkan pengesahan merentas organisasi yang berbeza
   • Menggunakan standard seperti SAML atau OpenID Connect
   • Identiti pengguna disahkan oleh organisasi rumah mereka

8. Pengesahan Berbilang Faktor (MFA):

   • Menambah lapisan keselamatan tambahan selain nama pengguna dan kata laluan
   • Boleh digunakan bersama SSO atau pengesahan tradisional
   • Lazimnya melibatkan sesuatu yang anda tahu, miliki dan sedang

Penjelasan Aliran SSO:

Sebelum menyelami pelaksanaan, mari kita fahami aliran SSO:

Prasyarat:

• Java 17 atau lebih baru
• Maven
• Docker (untuk menjalankan Keycloak)

Langkah 1: Persediaan Projek

Buat projek Spring Boot baharu dengan struktur berikut:

keycloak-demo/
├── src/
│   ├── main/
│   │   ├── java/
│   │   │   └── com/
│   │   │       └── bansikah/
│   │   │           └── keycloakdemo/
│   │   │               ├── config/
│   │   │               │   └── SecurityConfig.java
│   │   │               ├── controller/
│   │   │               │   └── FoodOrderingController.java
│   │   │               └── KeycloakDemoApplication.java
│   │   └── resources/
│   │       ├── templates/
│   │       │   ├── home.html
│   │       │   └── menu.html
│   │       └── application.yml
├── docker-compose.yml
└── pom.xml

Nota:

bansikah nama saya ? jadi anda boleh meletakkan contoh anda atau apa sahaja yang anda mahu...

Langkah 2: Konfigurasikan pom.xml

Tambah kebergantungan berikut pada pom.xml anda atau anda boleh menggantikan bahagian kebergantungan untuk mengelakkan konflik:

<dependencies>
        <dependency>
            <groupid>org.springframework.boot</groupid>
            <artifactid>spring-boot-starter-web</artifactid>
        </dependency>
        <dependency>
            <groupid>org.springframework.boot</groupid>
            <artifactid>spring-boot-starter-security</artifactid>
        </dependency>
        <dependency>
            <groupid>org.springframework.boot</groupid>
            <artifactid>spring-boot-starter-oauth2-client</artifactid>
        </dependency>
        <dependency>
            <groupid>org.springframework.boot</groupid>
            <artifactid>spring-boot-starter-oauth2-resource-server</artifactid>
        </dependency>
        <dependency>
            <groupid>org.springframework.boot</groupid>
            <artifactid>spring-boot-starter-thymeleaf</artifactid>
        </dependency>
        <dependency>
            <groupid>org.springframework.boot</groupid>
            <artifactid>spring-boot-starter-test</artifactid>
            <scope>test</scope>
        </dependency>
        <!-- https://mvnrepository.com/artifact/org.thymeleaf.extras/thymeleaf-extras-springsecurity3 -->
        <dependency>
            <groupid>org.thymeleaf.extras</groupid>
            <artifactid>thymeleaf-extras-springsecurity3</artifactid>
            <version>3.0.5.RELEASE</version>
        </dependency>
    </dependencies>

Langkah 3: Sediakan Keycloak dengan Docker

Buat fail docker-compose.yml dalam direktori akar:

version: '3'

services:
  keycloak:
    image: quay.io/keycloak/keycloak:latest
    environment:
      KEYCLOAK_ADMIN: admin
      KEYCLOAK_ADMIN_PASSWORD: admin
    ports:
      - "8088:8080"
    command:
      - start-dev

  app:
    build: .
    ports:
      - "8082:8082"
    depends_on:
      - keycloak

Jalankan pelayan Keycloak dengan:

docker-compose up -d

Langkah 4: Konfigurasi Keycloak

1. Akses Konsol Pentadbiran Keycloak:

   • Pergi ke http://localhost:8088
   • Log masuk dengan pentadbir/pentadbir sebagai nama pengguna dan kata laluan

2. Buat Alam Baharu:

   • Pergi ke "Master" di penjuru kiri sebelah atas
   • Pilih "Tambah alam"
   • Namakan alam pesanan makanan
   • Klik "Buat"

3. Buat Pelanggan Baharu:
   Pada skrin pertama:

   • Tetapkan "ID Pelanggan" kepada "pelanggan-pemesanan makanan"
   • Jenis pelanggan: Pilih "OpenID Connect"
   • Klik "Seterusnya"

Pada skrin seterusnya (Konfigurasi Keupayaan):

• Pengesahan pelanggan: HIDUPKAN ini (ini menggantikan tetapan "rahsia" lama)
• Keizinan: Anda boleh meninggalkan ini MATI melainkan anda memerlukan kebenaran terperinci
• Klik "Seterusnya"

1. Konfigurasi Pelanggan:
   • Tetapkan url akar kepada http://localhost:8082/
   • Tetapkan Jenis Akses kepada sulit
   • Tambahkan URI Ubah Hala yang Sah (setiap URI pada baris baharu):

 http://localhost:8082/
 http://localhost:8082/menu
 http://localhost:8082/login/oauth2/code/keycloak

• Tetapkan Asal Web: http://localhost:8082
• Klik "Simpan"

1. Dapatkan Rahsia Pelanggan:
   • Pergi ke tab Bukti kelayakan
   • Salin nilai medan Rahsia untuk digunakan dalam konfigurasi aplikasi

1. Buat Pengguna:
   • Pergi ke Pengguna dan klik "Tambah pengguna"
   • Tetapkan nama pengguna (cth., penguji)
   • Dalam tab Bukti kelayakan:
     • Tetapkan kata laluan
     • Lumpuhkan "Sementara"

dan tetapkan kata laluan:

Langkah 5: Konfigurasi Aplikasi But Spring

Buat application.yml dalam src/main/resources:

keycloak-demo/
├── src/
│   ├── main/
│   │   ├── java/
│   │   │   └── com/
│   │   │       └── bansikah/
│   │   │           └── keycloakdemo/
│   │   │               ├── config/
│   │   │               │   └── SecurityConfig.java
│   │   │               ├── controller/
│   │   │               │   └── FoodOrderingController.java
│   │   │               └── KeycloakDemoApplication.java
│   │   └── resources/
│   │       ├── templates/
│   │       │   ├── home.html
│   │       │   └── menu.html
│   │       └── application.yml
├── docker-compose.yml
└── pom.xml

Ganti dengan rahsia yang disalin daripada Keycloak, biasanya beberapa teks rawak.
Nota:

Dalam pengeluaran atau sebagai amalan yang baik adalah baik untuk menyimpan maklumat yang halus seperti itu dalam fail .env pada akar projek anda dan menggunakannya sebagai pembolehubah dalam konfigurasi anda ia akan menjadi sesuatu seperti ${CLIENT_SECRET} yang memilihnya daripada fail .env apabila anda memulakan aplikasi anda, ini juga terpakai kepada ubah hala, pengeluar-uri dan selebihnya..

Langkah 6: Buat Konfigurasi Keselamatan

Buat SecurityConfig.java dalam src/main/java/com/bansikah/keycloakdemo/config:

<dependencies>
        <dependency>
            <groupid>org.springframework.boot</groupid>
            <artifactid>spring-boot-starter-web</artifactid>
        </dependency>
        <dependency>
            <groupid>org.springframework.boot</groupid>
            <artifactid>spring-boot-starter-security</artifactid>
        </dependency>
        <dependency>
            <groupid>org.springframework.boot</groupid>
            <artifactid>spring-boot-starter-oauth2-client</artifactid>
        </dependency>
        <dependency>
            <groupid>org.springframework.boot</groupid>
            <artifactid>spring-boot-starter-oauth2-resource-server</artifactid>
        </dependency>
        <dependency>
            <groupid>org.springframework.boot</groupid>
            <artifactid>spring-boot-starter-thymeleaf</artifactid>
        </dependency>
        <dependency>
            <groupid>org.springframework.boot</groupid>
            <artifactid>spring-boot-starter-test</artifactid>
            <scope>test</scope>
        </dependency>
        <!-- https://mvnrepository.com/artifact/org.thymeleaf.extras/thymeleaf-extras-springsecurity3 -->
        <dependency>
            <groupid>org.thymeleaf.extras</groupid>
            <artifactid>thymeleaf-extras-springsecurity3</artifactid>
            <version>3.0.5.RELEASE</version>
        </dependency>
    </dependencies>

Langkah 7: Buat Pengawal

Buat FoodOrderingController.java dalam src/main/java/com/bansikah/keycloakdemo/controller:

version: '3'

services:
  keycloak:
    image: quay.io/keycloak/keycloak:latest
    environment:
      KEYCLOAK_ADMIN: admin
      KEYCLOAK_ADMIN_PASSWORD: admin
    ports:
      - "8088:8080"
    command:
      - start-dev

  app:
    build: .
    ports:
      - "8082:8082"
    depends_on:
      - keycloak

Langkah 8: Cipta Templat HTML

Buat home.html dalam src/main/resources/templates:

docker-compose up -d

Buat menu.html dalam src/main/resources/templates:

 http://localhost:8082/
 http://localhost:8082/menu
 http://localhost:8082/login/oauth2/code/keycloak

Langkah 9: Jalankan Aplikasi

Anda sepatutnya boleh mengakses aplikasi pada url ini http://localhost:8082 dan anda sepatutnya melihat ini

dan apabila anda mengklik pautan di sini ia membawa anda ke borang keycloak di mana pengguna perlu mengesahkan dengan nama pengguna dan kata laluan di bawah alam pesanan makanan

dan selepas disahkan anda akan melihat halaman menu

Kini dengan kepentingan SSO, walaupun saya log keluar, saya tidak perlu log masuk semula seperti di bawah

kemudian saya boleh mengklik pautan sekali lagi dan saya tidak akan diminta untuk memasukkan kata laluan dan nama pengguna saya sekali lagi seperti di bawah

Kesimpulan

Tahniah ?, dan Terima kasih kerana mengikuti sehingga saat ini
Pelaksanaan ini menunjukkan penyelesaian SSO yang mantap menggunakan Keycloak dan Spring Boot. Ia menyediakan pengalaman pengesahan yang lancar sambil mengekalkan keselamatan. Konfigurasi membolehkan penyesuaian dan sambungan yang mudah untuk memenuhi keperluan aplikasi tertentu.
Jika anda menghadapi sebarang isu atau mempunyai soalan tentang pelaksanaan ini, sila tinggalkan ulasan di bawah. Ingat untuk menyemak dokumentasi Spring Security dan Keycloak untuk konfigurasi dan ciri yang lebih lanjut.
Pautan ke kod pada github

Ruj:

• But musim bunga
• KeyCloak
• Jawa 17
• Maven
• Pelabuh

Atas ialah kandungan terperinci Keycloak dan Spring Boot: Panduan Terbaik untuk Melaksanakan Single Sign-On. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!