keycloak~對框架中提供的Provider總結

张占岭發表於2024-04-10
框架IDE

提供者目錄

  • Provider
  • Authenticator
    • BaseDirectGrantAuthenticator
    • AbstractFormAuthenticator
      • AbstractUsernameFormAuthenticator
  • RequiredActionProvider
  • FormAction
  • ProtocolMapper
    • AbstractOIDCProtocolMapper
  • RealmResourceProvider

具體provider的作用

  1. Provider（提供者）：

    • 作用：表示Keycloak中的各種擴充套件點，用於自定義和擴充套件Keycloak的功能。
    • 使用方法：開發者可以建立自定義的Provider，以實現對Keycloak的功能進行擴充套件，比如新增新的認證方式、儲存方式等。

  2. Authenticator（認證器）：

    • 作用：用於處理使用者認證的元件，可以自定義不同型別的認證流程。
    • 使用方法：開發者可以基於BaseDirectGrantAuthenticator、AbstractFormAuthenticator等提供的基類，編寫自定義的認證器，實現特定的認證邏輯。
    • BaseDirectGrantAuthenticator：用於直接授予訪問令牌的認證器。
    • AbstractFormAuthenticator：用於處理表單認證的認證器基類。
      • AbstractUsernameFormAuthenticator：處理使用者名稱密碼錶單認證的認證器基類。

在brower,directgrant等認證流程中，新增自定義的Authenticator

  1. RequiredActionProvider（必需操作提供者）：
    • 作用：定義了使用者在登入後需要執行的操作，比如修改密碼、接受條款等。
    • 使用方法：開發者可以建立自定義的RequiredActionProvider，以實現對使用者的必需操作進行管理和觸發。

對於某些使用者新增某些標識，有這個標識的使用者，會進行這個RequiredActionProvider的執行，例如：臨時密碼（第一次登入需要修改密碼）

  1. FormAction（表單操作）：
    • 作用：用於處理使用者在登入過程中需要填寫的表單資訊，比如驗證碼、安全問題等。
    • 使用方法：開發者可以編寫自定義的FormAction，以實現對使用者登入過程中表單資訊的處理和驗證。

在使用者註冊頁面，可以新增FormAction，在註冊過程中新增自己的業務邏輯

  1. ProtocolMapper（協議對映器）：

    • 作用：用於將Keycloak中的屬性對映到OAuth或OpenID Connect（OIDC）協議中。

    • 使用方法：開發者可以基於AbstractOIDCProtocolMapper提供的基類，編寫自定義的協議對映器，實現將使用者屬性對映到OAuth或OIDC協議中。

    • AbstractOIDCProtocolMapper：用於實現將使用者屬性對映到OIDC協議中的協議對映器基類。

這塊主要用在自定義jwt token，當使用者認證成功後，在構建token時，配置keycloak中的客戶端模板中的Mappers來新增自己的個性資訊在token中

  1. RealmResourceProvider（http普通介面與響應）:
  • 作用：RealmResourceProvider是Keycloak中的一個介面，用於管理特定Realm下的資源（如Clients、Users等）。透過實現RealmResourceProvider介面，可以對Realm內的資源進行增刪改查等操作，實現對Realm級別資源的管理。
  • 使用方法：
    • 建立自定義RealmResourceProvider實現類：首先，需要建立一個自定義的RealmResourceProvider實現類，該類需要實現RealmResourceProvider介面，並實現其中定義的方法，包括對Realm資源的增刪改查等操作。
    • 註冊自定義RealmResourceProvider：將自定義的RealmResourceProvider實現類註冊到Keycloak中，以便Keycloak能夠識別並使用該Provider來管理特定Realm下的資源。
    • 使用RealmResourceProvider：在需要對特定Realm下的資源進行管理時，透過呼叫RealmResourceProvider提供的方法來執行相應的操作，比如建立新的Client、新增使用者等。
    • 處理Realm級別操作：利用RealmResourceProvider可以處理一些Realm級別的操作，例如管理Realm下的所有Clients、Roles等資源，實現更靈活和個性化的Realm管理功能。

瀏覽器認證流程擴充套件

相關文章