├── .gitignore ├── LICENSE ├── README.md ├── pom.xml └── src └── main ├── java └── com │ └── marcosbarbero │ └── cloud │ └── config │ └── oauth2 │ ├── ConfigClientOAuth2BootstrapConfiguration.java │ └── ConfigClientOAuth2ResourceDetails.java └── resources └── META-INF └── spring.factories /.gitignore: -------------------------------------------------------------------------------- 1 | ### Java template 2 | *.class 3 | 4 | # Mobile Tools for Java (J2ME) 5 | .mtj.tmp/ 6 | 7 | # Package Files # 8 | *.jar 9 | *.war 10 | *.ear 11 | 12 | # virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml 13 | hs_err_pid* 14 | ### Eclipse template 15 | *.pydevproject 16 | .metadata 17 | .gradle 18 | bin/ 19 | tmp/ 20 | *.tmp 21 | *.bak 22 | *.swp 23 | *~.nib 24 | local.properties 25 | .settings/ 26 | .loadpath 27 | target/ 28 | 29 | # Eclipse Core 30 | .project 31 | 32 | # External tool builders 33 | .externalToolBuilders/ 34 | 35 | # Locally stored "Eclipse launch configurations" 36 | *.launch 37 | 38 | # CDT-specific 39 | .cproject 40 | 41 | # JDT-specific (Eclipse Java Development Tools) 42 | .classpath 43 | 44 | # Java annotation processor (APT) 45 | .factorypath 46 | 47 | # PDT-specific 48 | .buildpath 49 | 50 | # sbteclipse plugin 51 | . 52 | 53 | 54 | # TeXlipse plugin 55 | .texlipse 56 | ### JetBrains template 57 | 58 | *.iml 59 | .idea/ -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | Spring Cloud Config Client OAuth2 2 | --- 3 | Spring Cloud Config Client that talks to Config Server with OAuth2 authentication. 4 | 5 | 6 | Adding Project Lombok Agent 7 | --- 8 | 9 | This project uses [Project Lombok](http://projectlombok.org/features/index.html) 10 | to generate getters and setters etc. Compiling from the command line this 11 | shouldn't cause any problems, but in an IDE you need to add an agent 12 | to the JVM. Full instructions can be found in the Lombok website. The 13 | sign that you need to do this is a lot of compiler errors to do with 14 | missing methods and fields. 15 | 16 | Usage 17 | --- 18 | >This project is available on maven central 19 | 20 | Import dependency to your project 21 | 22 | ``` 23 | 24 | com.marcosbarbero.cloud 25 | spring-cloud-config-client-oauth2 26 | 1.0.2.RELEASE 27 | 28 | ``` 29 | 30 | Configure the following properties on bootstrap.yml 31 | 32 | ``` 33 | spring.cloud.config.client: 34 | oauth2: 35 | client-id: myClientId 36 | client-secret: myClientSecret 37 | access-token-uri: http://authserver.domain/oauth/token 38 | scope: #optional - default values 'read' and 'write' 39 | - read 40 | - write 41 | ``` 42 | -------------------------------------------------------------------------------- /pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 4 | 4.0.0 5 | 6 | com.marcosbarbero.cloud 7 | spring-cloud-config-client-oauth2 8 | Spring Cloud Config Client OAuth2 9 | jar 10 | 1.0.2.RELEASE 11 | 12 | 15 | 16 | https://github.com/marcosbarbero/spring-cloud-config-client-oauth2 17 | 18 | 19 | 20 | Apache License, Version 2.0 21 | http://www.apache.org/licenses/LICENSE-2.0.txt 22 | repo 23 | 24 | 25 | 26 | 27 | 28 | marcosbarbero 29 | marcos.hgb@gmail.com 30 | Marcos Barbero 31 | CET 32 | 33 | 34 | 35 | 36 | scm:git:https://github.com/marcosbarbero/spring-cloud-config-client-oauth2.git 37 | scm:git:git@github.com:marcosbarbero/spring-cloud-config-client-oauth2.git 38 | https://github.com/marcosbarbero/spring-cloud-config-client-oauth2 39 | HEAD 40 | 41 | 42 | 43 | 44 | 45 | org.sonatype.plugins 46 | nexus-staging-maven-plugin 47 | 1.6.3 48 | true 49 | 50 | ossrh 51 | https://oss.sonatype.org/ 52 | true 53 | 54 | 55 | 56 | 57 | org.apache.maven.plugins 58 | maven-source-plugin 59 | 60 | 61 | attach-sources 62 | 63 | jar 64 | 65 | 66 | 67 | 68 | 69 | 70 | org.apache.maven.plugins 71 | maven-javadoc-plugin 72 | 73 | 74 | attach-javadocs 75 | 76 | jar 77 | 78 | 79 | 80 | 81 | -Xdoclint:none 82 | 83 | 84 | 85 | 86 | org.apache.maven.plugins 87 | maven-gpg-plugin 88 | 89 | 90 | sign-artifacts 91 | verify 92 | 93 | sign 94 | 95 | 96 | 97 | 98 | 99 | 100 | 101 | 102 | 103 | ossrh 104 | https://oss.sonatype.org/content/repositories/snapshots 105 | 106 | 107 | 108 | 109 | 1.16.12 110 | 1.8 111 | 1.8 112 | 1.8 113 | 114 | 115 | 116 | 117 | 118 | org.springframework.cloud 119 | spring-cloud-config 120 | 1.2.2.RELEASE 121 | pom 122 | import 123 | 124 | 125 | 126 | 127 | 128 | 129 | 130 | org.springframework.cloud 131 | spring-cloud-config-client 132 | 133 | 134 | 135 | org.springframework.security.oauth 136 | spring-security-oauth2 137 | 138 | 139 | 140 | org.projectlombok 141 | lombok 142 | ${lombok.version} 143 | 144 | 145 | 146 | junit 147 | junit 148 | test 149 | 150 | 151 | 152 | -------------------------------------------------------------------------------- /src/main/java/com/marcosbarbero/cloud/config/oauth2/ConfigClientOAuth2BootstrapConfiguration.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2016 the original author or authors. 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | package com.marcosbarbero.cloud.config.oauth2; 17 | 18 | import org.springframework.boot.autoconfigure.condition.ConditionalOnClass; 19 | import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean; 20 | import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty; 21 | import org.springframework.boot.context.properties.EnableConfigurationProperties; 22 | import org.springframework.cloud.config.client.ConfigServicePropertySourceLocator; 23 | import org.springframework.context.annotation.Bean; 24 | import org.springframework.context.annotation.Configuration; 25 | import org.springframework.context.annotation.Primary; 26 | import org.springframework.security.oauth2.client.OAuth2RestTemplate; 27 | 28 | import javax.annotation.PostConstruct; 29 | 30 | /** 31 | * @author Marcos Barbero 32 | */ 33 | @Configuration 34 | @EnableConfigurationProperties(ConfigClientOAuth2ResourceDetails.class) 35 | @ConditionalOnClass({ConfigServicePropertySourceLocator.class, OAuth2RestTemplate.class}) 36 | @ConditionalOnProperty(value = ConfigClientOAuth2ResourceDetails.PREFIX + ".oauth2.clientId") 37 | public class ConfigClientOAuth2BootstrapConfiguration { 38 | 39 | @Bean 40 | @Primary 41 | @ConditionalOnMissingBean(ConfigClientOAuth2ResourceDetails.class) 42 | public ConfigClientOAuth2ResourceDetails configClientOAuth2ResourceDetails() { 43 | return new ConfigClientOAuth2ResourceDetails(); 44 | } 45 | 46 | @Bean 47 | @Primary 48 | @ConditionalOnProperty(value = "spring.cloud.config.enabled", matchIfMissing = true) 49 | protected ConfigClientOAuth2Configurer configClientOAuth2Configurator(ConfigServicePropertySourceLocator locator, 50 | ConfigClientOAuth2ResourceDetails configClientOAuth2ResourceDetails) { 51 | return new ConfigClientOAuth2Configurer(locator, configClientOAuth2ResourceDetails); 52 | } 53 | 54 | protected static class ConfigClientOAuth2Configurer { 55 | 56 | private final ConfigServicePropertySourceLocator locator; 57 | 58 | private final ConfigClientOAuth2ResourceDetails configClientOAuth2ResourceDetails; 59 | 60 | public ConfigClientOAuth2Configurer(ConfigServicePropertySourceLocator locator, 61 | ConfigClientOAuth2ResourceDetails configClientOAuth2ResourceDetails) { 62 | this.locator = locator; 63 | this.configClientOAuth2ResourceDetails = configClientOAuth2ResourceDetails; 64 | } 65 | 66 | @PostConstruct 67 | public void init() { 68 | this.locator.setRestTemplate(new OAuth2RestTemplate(this.configClientOAuth2ResourceDetails.getOauth2())); 69 | } 70 | 71 | } 72 | 73 | } 74 | -------------------------------------------------------------------------------- /src/main/java/com/marcosbarbero/cloud/config/oauth2/ConfigClientOAuth2ResourceDetails.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2016 the original author or authors. 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | package com.marcosbarbero.cloud.config.oauth2; 17 | 18 | import lombok.Data; 19 | 20 | import org.springframework.beans.factory.InitializingBean; 21 | import org.springframework.boot.context.properties.ConfigurationProperties; 22 | import org.springframework.security.oauth2.client.resource.BaseOAuth2ProtectedResourceDetails; 23 | import org.springframework.security.oauth2.client.token.grant.client.ClientCredentialsResourceDetails; 24 | 25 | import java.util.Arrays; 26 | 27 | /** 28 | * @author Marcos Barbero 29 | */ 30 | @Data 31 | @ConfigurationProperties(ConfigClientOAuth2ResourceDetails.PREFIX) 32 | public class ConfigClientOAuth2ResourceDetails implements InitializingBean { 33 | public static final String PREFIX = "spring.cloud.config.client"; 34 | 35 | private BaseOAuth2ProtectedResourceDetails oauth2 = new ClientCredentialsResourceDetails(); 36 | 37 | public void afterPropertiesSet() throws Exception { 38 | if (oauth2.getScope() == null || oauth2.getScope().isEmpty()) { 39 | oauth2.setScope(Arrays.asList("read", "write")); 40 | } 41 | } 42 | } 43 | -------------------------------------------------------------------------------- /src/main/resources/META-INF/spring.factories: -------------------------------------------------------------------------------- 1 | # Bootstrap components 2 | org.springframework.cloud.bootstrap.BootstrapConfiguration=\ 3 | com.marcosbarbero.cloud.config.oauth2.ConfigClientOAuth2BootstrapConfiguration --------------------------------------------------------------------------------