Skip to content

support oauth2 pre-selected scopes #800

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

Merged
merged 1 commit into from
Jul 27, 2020
Merged

support oauth2 pre-selected scopes #800

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
28 changes: 28 additions & 0 deletions springdoc-openapi-common/src/main/java/org/springdoc/core/SwaggerUiOAuthProperties.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,15 @@
package org.springdoc.core;


import java.util.List;
import java.util.Map;
import java.util.TreeMap;

import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Configuration;
import org.springframework.util.CollectionUtils;

import static org.springdoc.core.Constants.SPRINGDOC_SWAGGER_UI_ENABLED;

Expand Down Expand Up @@ -83,6 +85,11 @@ public class SwaggerUiOAuthProperties {
*/
private Boolean usePkceWithAuthorizationCodeGrant;

/**
* The Scopes selected by default upon authentication.
*/
private List<String> scopes;

/**
* Gets config parameters.
*
Expand All @@ -95,6 +102,9 @@ public Map<String, Object> getConfigParameters() {
SpringDocPropertiesUtils.put("realm", realm, params);
SpringDocPropertiesUtils.put("scopeSeparator", scopeSeparator, params);
SpringDocPropertiesUtils.put("appName", appName, params);
if (!CollectionUtils.isEmpty(scopes)) {
SpringDocPropertiesUtils.put("scopes", String.join(" ", scopes), params);
}
SpringDocPropertiesUtils.put("useBasicAuthenticationWithAccessCodeGrant", useBasicAuthenticationWithAccessCodeGrant, params);
SpringDocPropertiesUtils.put("usePkceWithAuthorizationCodeGrant", usePkceWithAuthorizationCodeGrant, params);
SpringDocPropertiesUtils.put("additionalQueryStringParams", additionalQueryStringParams, params);
Expand Down Expand Up @@ -244,4 +254,22 @@ public Boolean getUsePkceWithAuthorizationCodeGrant() {
public void setUsePkceWithAuthorizationCodeGrant(Boolean usePkceWithAuthorizationCodeGrant) {
this.usePkceWithAuthorizationCodeGrant = usePkceWithAuthorizationCodeGrant;
}

/**
* Get the pre-selected scopes during authentication.
*
* @return the pre-selected scopes during authentication
*/
public List<String> getScopes() {
return scopes;
}

/**
* Sets the pre-selected scopes during authentication.
*
* @param scopes the pre-selected scopes during authentication
*/
public void setScopes(List<String> scopes) {
this.scopes = scopes;
}
}
3 changes: 2 additions & 1 deletion springdoc-openapi-ui/src/test/java/test/org/springdoc/ui/app7/SpringDocApp7Test.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,8 @@

@TestPropertySource(properties = { "springdoc.swagger-ui.oauth.clientId=myClientId",
"springdoc.swagger-ui.oauth.additionalQueryStringParams.test1=test1",
"springdoc.swagger-ui.oauth.additionalQueryStringParams.test2=test2" })
"springdoc.swagger-ui.oauth.additionalQueryStringParams.test2=test2",
"springdoc.swagger-ui.oauth.scopes=scope1,scope2" })
public class SpringDocApp7Test extends AbstractSpringDocTest {

@Test
Expand Down
2 changes: 1 addition & 1 deletion springdoc-openapi-ui/src/test/resources/results/app7
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@

window.ui = ui
ui.initOAuth(
{"additionalQueryStringParams":{"test1":"test1","test2":"test2"},"clientId":"myClientId"})
{"additionalQueryStringParams":{"test1":"test1","test2":"test2"},"clientId":"myClientId","scopes":"scope1 scope2"})
}
</script>
</body>
Expand Down
2 changes: 1 addition & 1 deletion springdoc-openapi-webflux-ui/src/test/java/test/org/springdoc/ui/app5/SpringDocApp5Test.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertTrue;

@TestPropertySource(properties = "springdoc.swagger-ui.oauth.clientId=myClientId")
@TestPropertySource(properties = {"springdoc.swagger-ui.oauth.clientId=myClientId", "springdoc.swagger-ui.oauth.scopes=scope1,scope2"})
public class SpringDocApp5Test extends AbstractSpringDocTest {

@Test
Expand Down
2 changes: 1 addition & 1 deletion springdoc-openapi-webflux-ui/src/test/resources/results/index5
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@

window.ui = ui
ui.initOAuth(
{"clientId":"myClientId"})
{"clientId":"myClientId","scopes":"scope1 scope2"})
}
</script>
</body>
Expand Down