Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: swagger auth #187

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from
Open

feat: swagger auth #187

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
51f493a
fix: disable url templating in swagger and add plugin entries
MyleneSimon Dec 29, 2021
141daa6
feat: enable auth in swagger ui
MyleneSimon Dec 30, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions docs/auth-acl/realm-export.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -751,11 +751,15 @@
"secret": "**********",
"redirectUris": [
"http://localhost:4200/*",
"https://localhost:4200/*"
"https://localhost:4200/*",
"http://localhost:8080/api/swagger-ui/oauth2-redirect.html",
"https://localhost:8080/api/swagger-ui/oauth2-redirect.html"
],
"webOrigins": [
"https://localhost:4200",
"http://localhost:4200"
"http://localhost:4200",
"http://localhost:8080",
"https://localhost:8080"
],
"notBefore": 0,
"bearerOnly": false,
Expand Down
64 changes: 60 additions & 4 deletions wipp-backend-application/src/main/java/gov/nist/itl/ssd/wipp/backend/Application.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,14 @@
package gov.nist.itl.ssd.wipp.backend;

import java.io.File;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.logging.Level;
import java.util.logging.Logger;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.beans.factory.config.BeanDefinition;
import org.springframework.beans.factory.config.ServiceLocatorFactoryBean;
import org.springframework.boot.SpringApplication;
Expand All @@ -35,12 +39,21 @@
import gov.nist.itl.ssd.wipp.backend.core.model.data.DataHandlerFactory;
import gov.nist.itl.ssd.wipp.backend.core.rest.annotation.IdExposed;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.AuthorizationCodeGrantBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.AuthorizationScope;
import springfox.documentation.service.GrantType;
import springfox.documentation.service.OAuth;
import springfox.documentation.service.SecurityReference;
import springfox.documentation.service.Tag;
import springfox.documentation.service.TokenEndpoint;
import springfox.documentation.service.TokenRequestEndpoint;
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 gov.nist.itl.ssd.wipp.backend.core.CoreConfig;

/**
Expand All @@ -55,7 +68,16 @@
public class Application implements WebMvcConfigurer {

@Autowired
private CoreConfig coreConfig;
private CoreConfig coreConfig;

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

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

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

public static void main(String[] args) {
ConfigurableApplicationContext ctx = SpringApplication.run(
Expand Down Expand Up @@ -144,8 +166,6 @@ public Docket wippApi() {
.paths(PathSelectors.any())
.paths(PathSelectors.regex("/error.*").negate())
.paths(PathSelectors.regex("/api/profile").negate())
// workaround to avoid duplicate entries for plugins
.paths(PathSelectors.regex("/api/plugins").negate())
.build()
// manually create tags to manage custom descriptions
.tags(
Expand All @@ -163,7 +183,9 @@ public Docket wippApi() {
new Tag("Visualization Entity", "REST API for Pyramid Visualizations"),
new Tag("Workflow Entity", "REST API for Workflows"))
.apiInfo(apiEndPointsInfo())
.enableUrlTemplating(true);
.enableUrlTemplating(false)
.securitySchemes(Arrays.asList(securityScheme()))
.securityContexts(Arrays.asList(securityContext()));
}

/**
Expand All @@ -179,4 +201,38 @@ private ApiInfo apiEndPointsInfo() {
.build();
}

/**
* Configure Swagger UI Authorize pop-up display
* @return security configuration
*/
@Bean
public SecurityConfiguration securityConfiguration() {
// A placeholder for the client secret is added here since this client is public
return new SecurityConfiguration(this.keycloakClientId, "secret_placeholder", "WIPP", "wipp-api", "",
Collections.emptyMap(), false, false);
}

/**
* Configure Swagger UI security scheme for OAuth2
* @return security scheme
*/
private OAuth securityScheme() {
String keycloakOidcUrl = this.keycloakAuthUrl + "/realms/" + this.keycloakRealm + "/protocol/openid-connect";
List<GrantType> grantTypes = Arrays.asList(new AuthorizationCodeGrantBuilder()
.tokenEndpoint(new TokenEndpoint(keycloakOidcUrl + "/token", "KeycloakOAuth2Token"))
.tokenRequestEndpoint(new TokenRequestEndpoint(keycloakOidcUrl + "/auth", this.keycloakClientId, ""))
.build());
return new OAuth("KeycloakOAuth2", Collections.emptyList(), grantTypes);
}

/**
* Configure Swagger UI security context for OAuth2
* @return security context
*/
private SecurityContext securityContext() {
return SecurityContext.builder()
.securityReferences(Arrays.asList(new SecurityReference("KeycloakOAuth2", new AuthorizationScope[0])))
.forPaths(PathSelectors.any()).build();
}

}