web-dev-qa-db-ja.com

SwaggerでのKeycloakの統合

Swagger-ui経由でアクセスしたいKeycloakで保護されたバックエンドがあります。 Keycloakは、oauth2の暗黙的およびアクセスコードフローを提供しますが、動作させることはできませんでした。現在、Keycloakのドキュメントには、authorizationUrlおよびtokenUrlswagger.json内.

Keycloak内の各レルムは、 http：//keycloak.local/auth/realms/REALM/.well-known/openid-configuration にアクセスすることにより、構成URLの膨大なリストを提供します

さらに、次の行を追加して、keycloak js-clientをswagger-ui index.html内に直接統合しようとしました。

<script src="keycloak/keycloak.js"></script>
<script>
  var keycloak = Keycloak('keycloak.json');
    keycloak.init({ onLoad: 'login-required' })
      .success(function (authenticated) {
        console.log('Login Successful');
        window.authorizations.add("oauth2", new ApiKeyAuthorization("Authorization", "Bearer " + keycloak.token, "header"));
      }).error(function () {
        console.error('Login Failed');
        window.location.reload();
      }
    );
 </script>

「ログインに成功しました」後にこのようなことも試しました

swaggerUi.api.clientAuthorizations.add("key", new SwaggerClient.ApiKeyAuthorization("Authorization", "Bearer " + keycloak.token, "header"));

しかし、それも機能しません。

Swcloger内にkeycloak認証を統合する方法はありますか？

oauthswaggerswagger-uikeycloakjboss-tools
36
melistik

Swagger-uiは、implicit認証モードを使用してキークロークと統合できます。 swagger-uiにoauth2をセットアップして、swagger-uiに直接アクセストークンを与えるのではなく、認証を要求することができます。

まず、次のようなセキュリティ定義を参照する必要があります。

"securityDefinitions": {
    "oauth2": {
        "type":"oauth2",
        "authorizationUrl":"http://172.17.0.2:8080/auth/realms/master/protocol/openid-connect/auth",
        "flow":"implicit",
        "scopes": {
            "openid":"openid",
            "profile":"profile"
        }
    }
}

次に、他のパラメーターを参照する必要があります。純粋なjsでは、index.htmlで使用できます。

const ui = SwaggerUIBundle({ ...} );

ui.initOAuth({
    clientId: "test-uid",
    realm: "Master",
    appName: "swagger-ui",
    scopeSeparator: " ",
    additionalQueryStringParams: {"nonce": "132456"}
})

このコードでは、

  • authorizationUrlはキークロークレルムの認証エンドポイントです
  • スコープは、ニーズに合わせて設定できるものです
  • clientIdは、キークロークレルムでimplicitモードでパラメーター化されたクライアントです
  • 追加のパラメーターnonceはランダムでなければなりませんが、swagger-uiはまだ使用していません。

このすべてをSpringブートで実行したい場合、ここに例を追加します：

このフレームワークでは、主にSpringfoxのswaggerおよびswagger-ui web-jarを使用します。これを行うには、依存関係を追加します。

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.8.0</version>
</dependency>
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.8.0</version>
</dependency>

Swaggerは、メインクラスにswagger2という注釈を追加することで有効になります。

@SpringBootApplication
@EnableSwagger2
public class TestSpringApplication {
    ...

次のようにConfigurationクラスを設定できます：

@Configuration
public class SwaggerConfigurer {

    @Bean
    public SecurityConfiguration securityConfiguration() {

        Map<String, Object> additionalQueryStringParams=new HashMap<>();
        additionalQueryStringParams.put("nonce","123456");

        return SecurityConfigurationBuilder.builder()
            .clientId("test-uid").realm("Master").appName("swagger-ui")
            .additionalQueryStringParams(additionalQueryStringParams)
            .build();
    }

    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
            .select()
            .apis(RequestHandlerSelectors.basePackage("com.example.testspring"))
            .paths(PathSelectors.any())
            .build().securitySchemes(buildSecurityScheme()).securityContexts(buildSecurityContext());
    }

    private List<SecurityContext> buildSecurityContext() {
        List<SecurityReference> securityReferences = new ArrayList<>();

        securityReferences.add(SecurityReference.builder().reference("oauth2").scopes(scopes().toArray(new AuthorizationScope[]{})).build());

        SecurityContext context = SecurityContext.builder().forPaths(Predicates.alwaysTrue()).securityReferences(securityReferences).build();

        List<SecurityContext> ret = new ArrayList<>();
        ret.add(context);
        return ret;
    }

    private List<? extends SecurityScheme> buildSecurityScheme() {
        List<SecurityScheme> lst = new ArrayList<>();
        // lst.add(new ApiKey("api_key", "X-API-KEY", "header"));

        LoginEndpoint login = new LoginEndpointBuilder().url("http://172.17.0.2:8080/auth/realms/master/protocol/openid-connect/auth").build();

        List<GrantType> gTypes = new ArrayList<>();
        gTypes.add(new ImplicitGrant(login, "acces_token"));

        lst.add(new OAuth("oauth2", scopes(), gTypes));
        return lst;
    }

    private List<AuthorizationScope> scopes() {
        List<AuthorizationScope> scopes = new ArrayList<>();
        for (String scopeItem : new String[]{"openid=openid", "profile=profile"}) {
            String scope[] = scopeItem.split("=");
            if (scope.length == 2) {
                scopes.add(new AuthorizationScopeBuilder().scope(scope[0]).description(scope[1]).build());
            } else {
                log.warn("Scope '{}' is not valid (format is scope=description)", scopeItem);
            }
        }

        return scopes;
    }
}

このコードで更新できるものはたくさんあります。これは主に以前と同じです：

  • nonceこれはランダムなものでなければなりません（swagger-uiはまだ使用していません）
  • clientId keycloakで設定したクライアントに応じて設定する必要があります
  • basePackage：すべてのコントローラーが含まれるパッケージを設定する必要があります
  • APIキーが必要な場合は、それを有効にしてセキュリティスキームリストに追加できます。
  • LoginEndpoint：キークロークレルムの認証エンドポイントである必要があります
  • scopeItems：この認証に必要なスコープ。

以前と同じものを生成します：securityDefinitionを追加してswagger-UIがclientId、nonce、...のパラメーターを取るようにswaggerを更新します。

6
wargre

過去2日間、このセットアップに苦労していました。最終的に解決できない人のための実用的なソリューションを得ました。

pom.xml

    ...
    <dependency>
        <groupId>org.keycloak</groupId>
        <artifactId>keycloak-spring-security-adapter</artifactId>
    </dependency>
    <dependency>
        <groupId>org.keycloak</groupId>
        <artifactId>keycloak-spring-boot-starter</artifactId>
    </dependency>
    ...

メインクラスでSwaggerを有効にする

...    
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@SpringBootApplication
@EnableSwagger2
@EnableAsync
@EnableCaching
public class MainApplication {
  public static void main(String[] args) {
    SpringApplication app = new SpringApplication(MainApplication.class);
    app.run(args);
  }
}

SwaggerConfig.Java

package com.XXX.XXXXXXXX.app.config;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.AuthorizationCodeGrantBuilder;
import springfox.documentation.builders.OAuthBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.service.*;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spi.service.contexts.SecurityContext;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger.web.SecurityConfiguration;
import springfox.documentation.swagger.web.SecurityConfigurationBuilder;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

import Java.util.Arrays;

import static springfox.documentation.builders.PathSelectors.regex;

/*
 * Setting up Swagger for spring boot
 * https://www.baeldung.com/swagger-2-documentation-for-spring-rest-api
 */
@Configuration
@EnableSwagger2
public class SwaggerConfig {

 @Value("${keycloak.auth-server-url}")
 private String AUTH_SERVER;

 @Value("${keycloak.credentials.secret}")
 private String CLIENT_SECRET;

 @Value("${keycloak.resource}")
 private String CLIENT_ID;

 @Value("${keycloak.realm}")
 private String REALM;

 private static final String OAUTH_NAME = "spring_oauth";
 private static final String ALLOWED_PATHS = "/directory_to_controllers/.*";
 private static final String GROUP_NAME = "XXXXXXX-api";
 private static final String TITLE = "API Documentation for XXXXXXX Application";
 private static final String DESCRIPTION = "Description here";
 private static final String VERSION = "1.0";

 @Bean
 public Docket taskApi() {
   return new Docket(DocumentationType.SWAGGER_2)
    .groupName(GROUP_NAME)
    .useDefaultResponseMessages(true)
    .apiInfo(apiInfo())
    .select()
    .paths(regex(ALLOWED_PATHS))
    .build()
    .securitySchemes(Arrays.asList(securityScheme()))
    .securityContexts(Arrays.asList(securityContext()));
 }

 private ApiInfo apiInfo() {
   return new 
     ApiInfoBuilder().title(TITLE).description(DESCRIPTION).version(VERSION).build();
 }

 @Bean
 public SecurityConfiguration security() {
   return SecurityConfigurationBuilder.builder()
    .realm(REALM)
    .clientId(CLIENT_ID)
    .clientSecret(CLIENT_SECRET)
    .appName(GROUP_NAME)
    .scopeSeparator(" ")
    .build();
 }

 private SecurityScheme securityScheme() {
   GrantType grantType =
    new AuthorizationCodeGrantBuilder()
        .tokenEndpoint(new TokenEndpoint(AUTH_SERVER + "/realms/" + REALM + "/protocol/openid-connect/token", GROUP_NAME))
        .tokenRequestEndpoint(
            new TokenRequestEndpoint(AUTH_SERVER + "/realms/" + REALM + "/protocol/openid-connect/auth", CLIENT_ID, CLIENT_SECRET))
        .build();

SecurityScheme oauth =
    new OAuthBuilder()
        .name(OAUTH_NAME)
        .grantTypes(Arrays.asList(grantType))
        .scopes(Arrays.asList(scopes()))
        .build();
return oauth;
 }

 private AuthorizationScope[] scopes() {
AuthorizationScope[] scopes = {
  new AuthorizationScope("user", "for CRUD operations"),
  new AuthorizationScope("read", "for read operations"),
  new AuthorizationScope("write", "for write operations")
};
return scopes;
}

private SecurityContext securityContext() {
return SecurityContext.builder()
    .securityReferences(Arrays.asList(new SecurityReference(OAUTH_NAME, scopes())))
    .forPaths(PathSelectors.regex(ALLOWED_PATHS))
    .build();
 }
}

ターミナルから、「mvnw spring-boot：run」を実行します

ブラウザを開き、 http：// localhost：[port]/[app_name] /swagger-ui.html を押します。

[認証]ボタンをクリックします。 Swagger認証ボタン

これにより、キークローク設定を確認するモーダルが表示されます。

もう一度[認証]ボタンをクリックします。ログイン画面にリダイレクトされるはずです。

資格情報を入力して確認すると、完全に認証されたSwagger-UIにリダイレクトされます。

5
user1653042

暗黙のフロー、OpenAPI 3.0テンプレートを使用するSwagger-ui + Keycloak（またはその他のOAuth2プロバイダー）：

components:
  ...
   securitySchemes:
    my_auth_whatever:
      type: oauth2
      flows:
        implicit:
          authorizationUrl: https://MY-KEYCLOAK-Host/auth/realms/MY-REALM-ID/protocol/openid-connect/auth
          scopes: {}
  ...
security:
  - my_auth_whatever: []

使用するクライアントのKeycloak設定で暗黙フローが有効になっていることを確認してください。

欠点の1つは、Swagger UIで「Authorize」ボタンをクリックすると、ユーザーがモーダルでclient_idを要求されることです。ユーザーが入力した値は、クエリパラメータ?client_id=YOUR-CLIENT-IDをauthorizationUrlに送信しますが、それはちょっと汚いハックであり、モーダルはまだユーザーに表示されます。 dockerでswagger-uiを実行する場合-OAUTH_CLIENT_ID env varをコンテナーに提供して、モーダルのデフォルトclient_id値を設定できます。非ドッカー展開については、index.htmlを変更する@wargreのアプローチを参照してください（より良い方法があるかどうかはわかりません）。

SwaggerAPI（OpenAPI 2.0）の例については、@ wargreの回答とこのドキュメントの最初のコードスニペットを参照してください。 https://swagger.io/docs/specification/2-0/authentication/

0
Nikita Mendelbaum