Zum Hauptinhalt springen

Spring Security Filter (OIDC)

Dieses Handbuch integriert Casdoor mit Ihrer Anwendung über den Spring Security Filter und OIDC.

Schritt 1: Casdoor bereitstellen​

Stellen Sie den Casdoor-Server bereit. Nach der Bereitstellung prüfen Sie Folgendes:

  • Der Casdoor-Server läuft unter http://localhost:8000.
  • Die Casdoor-Login-Seite befindet sich unter http://localhost:7001.
  • Sie können sich als built-in/admin mit dem von Ihnen festgelegten Passwort anmelden. Siehe Anmeldung im Admin-Konsolenbereich.

Nachdem Sie diese Schritte überprüft haben, folgen Sie den untenstehenden Schritten, um Casdoor mit Ihrer Anwendung zu integrieren.

Schritt 2: Die Casdoor-Anwendung konfigurieren​

  • Create or edit a Casdoor application and add your redirect URL (see next section for how to get it). Einstellungen der Casdoor-Anwendung
  • Erhalten Sie Ihr Zertifikat auf der Seite zur Bearbeitung von Zertifikaten. Einstellungen der Casdoor-Zertifizierung
  • Fügen Sie den Anbieter und andere Einstellungen nach Bedarf hinzu.

Notieren Sie sich Application Name, Organization Name, Redirect URL, Client ID, Client Secret und Certificate von der Anwendungsseite für den nächsten Schritt.

Schritt 3: Spring Security konfigurieren​

Passen Sie den Spring Security Filter an, um Tokens zu verarbeiten:

Vorsicht

Ersetzen Sie die Platzhalter durch Ihre eigene Casdoor-Instanz (Client ID, Client secret usw.).

server:
port: 8080
casdoor:
endpoint: http://CASDOOR_HOSTNAME:8000
client-id: <Client ID>
client-secret: <Client Secret>
certificate: <Certificate>
organization-name: <Organization Name>
application-name: <Application Name>
redirect-url: http://FRONTEND_HOSTNAME/callback
Vorsicht

Der Standardwert <FRONTEND_HOSTNAME> ist localhost:3000; die Redirect-URL ist http://localhost:3000/callback. Fügen Sie diese Redirect-URL in der Casdoor-Anwendung hinzu.

Schritt 4: Frontend konfigurieren​

Installieren Sie casdoor-js-sdk und konfigurieren Sie es wie folgt:

  1. Installiere casdoor-js-sdk.

    npm i casdoor-js-sdk 
    # or
    yarn add casdoor-js-sdk
  2. Richte SDK ein.

    import Sdk from "casdoor-js-sdk";

    // Serverurl is the URL where spring security is deployed
    export const ServerUrl = "http://BACKEND_HOSTNAME:8080";

    const sdkConfig = {
    serverUrl: "http://CASDOOR_HOSTNAME:8000",
    clientId: "<your client id>",
    appName: "<your application name>",
    organizationName: "<your organization name>",
    redirectPath: "/callback",
    };

    export const CasdoorSDK = new Sdk(sdkConfig);

Schritt 5: Ein Demo einrichten​

  1. Erstellen Sie eine Spring Boot-Anwendung.

  2. Fügen Sie einige Konfigurationen hinzu, um JWT zu verarbeiten.

    @EnableWebSecurity
    public class SecurityConfig {

    private final JwtTokenFilter jwtTokenFilter;

    public SecurityConfig(JwtTokenFilter jwtTokenFilter) {
    this.jwtTokenFilter = jwtTokenFilter;
    }

    @Bean
    public SecurityFilterChain securityFilterChain(HttpSecurity http) throws Exception {
    // enable CORS and disable CSRF
    http = http.cors(corsConfig -> corsConfig
    .configurationSource(configurationSource())
    ).csrf().disable();

    // set session management to stateless
    http = http
    .sessionManagement()
    .sessionCreationPolicy(SessionCreationPolicy.STATELESS)
    .and();

    // set permissions on endpoints
    http.authorizeHttpRequests(authorize -> authorize
    .mvcMatchers("/api/redirect-url", "/api/signin").permitAll()
    .mvcMatchers("/api/**").authenticated()
    );

    // set unauthorized requests exception handler
    http = http
    .exceptionHandling()
    .authenticationEntryPoint(
    (request, response, ex) -> ResponseUtils.fail(response, "unauthorized")
    )
    .and();

    // add JWT token filter
    http.addFilterBefore(
    jwtTokenFilter,
    UsernamePasswordAuthenticationFilter.class
    );
    return http.build();
    }

    // ...

    }
  3. Fügen Sie einen einfachen JWT-Filter hinzu, um Anfragen zu unterbrechen, die eine Token-Überprüfung erfordern.

    @Component
    public class JwtTokenFilter extends OncePerRequestFilter {

    private final CasdoorAuthService casdoorAuthService;

    public JwtTokenFilter(CasdoorAuthService casdoorAuthService) {
    this.casdoorAuthService = casdoorAuthService;
    }

    @Override
    protected void doFilterInternal(HttpServletRequest request,
    HttpServletResponse response,
    FilterChain chain)
    throws ServletException, IOException {
    // get authorization header and validate
    final String header = request.getHeader(HttpHeaders.AUTHORIZATION);
    if (!StringUtils.hasText(header) || !header.startsWith("Bearer ")) {
    chain.doFilter(request, response);
    return;
    }

    // get jwt token and validate
    final String token = header.split(" ")[1].trim();

    // get user identity and set it on the spring security context
    UserDetails userDetails = null;
    try {
    CasdoorUser casdoorUser = casdoorAuthService.parseJwtToken(token);
    userDetails = new CustomUserDetails(casdoorUser);
    } catch (CasdoorAuthException exception) {
    logger.error("casdoor auth exception", exception);
    chain.doFilter(request, response);
    return;
    }

    UsernamePasswordAuthenticationToken authentication = new UsernamePasswordAuthenticationToken(
    userDetails,
    null,
    AuthorityUtils.createAuthorityList("ROLE_casdoor")
    );

    authentication.setDetails(
    new WebAuthenticationDetailsSource().buildDetails(request)
    );

    SecurityContextHolder.getContext().setAuthentication(authentication);
    chain.doFilter(request, response);
    }

    }

    Wenn der Benutzer auf die Schnittstelle zugreift, die eine Authentifizierung erfordert, wird JwtTokenFilter das Token aus dem Anfrage-Header Authorization entnehmen und es verifizieren.

  4. Definieren Sie einen Controller, um zu handhaben, wenn sich der Benutzer bei Casdoor anmeldet. Nachdem sich der Benutzer angemeldet hat, wird er zum Server weitergeleitet und trägt den code und state. Der Server muss dann die Identität des Benutzers von Casdoor überprüfen und das token durch diese beiden Parameter erhalten.

    @RestController
    public class UserController {

    private static final Logger logger = LoggerFactory.getLogger(UserController.class);

    private final CasdoorAuthService casdoorAuthService;

    // ...

    @PostMapping("/api/signin")
    public Result signin(@RequestParam("code") String code, @RequestParam("state") String state) {
    try {
    String token = casdoorAuthService.getOAuthToken(code, state);
    return Result.success(token);
    } catch (CasdoorAuthException exception) {
    logger.error("casdoor auth exception", exception);
    return Result.failure(exception.getMessage());
    }
    }

    // ...
    }

Schritt 6: Das Demo ausprobieren​

Öffnen Sie das Frontend in einem Browser. Wenn nicht angemeldet, wird eine Login-Schaltfläche angezeigt; ein Klick darauf leitet zur Casdoor-Anmeldeseite weiter.

Wenn Sie Ihre Startseite besuchen,willkommen

Klicken Sie auf den Casdoor Login-Button, und die Seite wird zur Anmeldeseite von Casdoor weitergeleitet. casdoor

After login, the app redirects to /. Ressource