├── .github └── workflows │ └── gradle.yml ├── .gitignore ├── LICENSE ├── README.md ├── build.gradle ├── codequality └── HEADER ├── gradle.properties ├── gradle └── wrapper │ ├── gradle-wrapper.jar │ └── gradle-wrapper.properties ├── gradlew ├── gradlew.bat ├── settings.gradle ├── springboot-apikey-example.paw └── src └── main ├── java └── springboot │ └── apikey │ └── example │ ├── Application.java │ ├── auth │ ├── ApiKeyAuthFilter.java │ ├── ApiKeyAuthManager.java │ └── AuthConfiguration.java │ ├── controller │ ├── NonSecureController.java │ └── SecureController.java │ └── util │ └── UUIDUtil.java └── resources ├── application.properties └── db └── migration └── V1__Initial_Schema.sql /.github/workflows/gradle.yml: -------------------------------------------------------------------------------- 1 | # This workflow will build a Java project with Gradle 2 | # For more information see: https://help.github.com/actions/language-and-framework-guides/building-and-testing-java-with-gradle 3 | 4 | name: Build 5 | 6 | on: 7 | push: 8 | branches: [ master ] 9 | pull_request: 10 | branches: [ master ] 11 | 12 | jobs: 13 | build: 14 | 15 | runs-on: ubuntu-latest 16 | 17 | steps: 18 | - uses: actions/checkout@v2 19 | - name: Set up JDK 1.8 20 | uses: actions/setup-java@v1 21 | with: 22 | java-version: 1.8 23 | - name: Grant execute permission for gradlew 24 | run: chmod +x gradlew 25 | - name: Build with Gradle 26 | run: ./gradlew build 27 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Created by https://www.gitignore.io/api/java,macos,gradle,intellij+all 2 | 3 | ### Intellij+all ### 4 | # Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and WebStorm 5 | # Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839 6 | 7 | # User-specific stuff 8 | .idea/**/workspace.xml 9 | .idea/**/tasks.xml 10 | .idea/**/usage.statistics.xml 11 | .idea/**/dictionaries 12 | .idea/**/shelf 13 | 14 | # Sensitive or high-churn files 15 | .idea/**/dataSources/ 16 | .idea/**/dataSources.ids 17 | .idea/**/dataSources.local.xml 18 | .idea/**/sqlDataSources.xml 19 | .idea/**/dynamic.xml 20 | .idea/**/uiDesigner.xml 21 | .idea/**/dbnavigator.xml 22 | 23 | # Gradle 24 | .idea/**/gradle.xml 25 | .idea/**/libraries 26 | 27 | # Gradle and Maven with auto-import 28 | # When using Gradle or Maven with auto-import, you should exclude module files, 29 | # since they will be recreated, and may cause churn. Uncomment if using 30 | # auto-import. 31 | # .idea/modules.xml 32 | # .idea/*.iml 33 | # .idea/modules 34 | 35 | # CMake 36 | cmake-build-*/ 37 | 38 | # Mongo Explorer plugin 39 | .idea/**/mongoSettings.xml 40 | 41 | # File-based project format 42 | *.iws 43 | 44 | # IntelliJ 45 | out/ 46 | **/out/ 47 | 48 | # mpeltonen/sbt-idea plugin 49 | .idea_modules/ 50 | 51 | # JIRA plugin 52 | atlassian-ide-plugin.xml 53 | 54 | # Cursive Clojure plugin 55 | .idea/replstate.xml 56 | 57 | # Crashlytics plugin (for Android Studio and IntelliJ) 58 | com_crashlytics_export_strings.xml 59 | crashlytics.properties 60 | crashlytics-build.properties 61 | fabric.properties 62 | 63 | # Editor-based Rest Client 64 | .idea/httpRequests 65 | 66 | ### Intellij+all Patch ### 67 | # Ignores the whole .idea folder and all .iml files 68 | # See https://github.com/joeblau/gitignore.io/issues/186 and https://github.com/joeblau/gitignore.io/issues/360 69 | 70 | .idea/ 71 | 72 | # Reason: https://github.com/joeblau/gitignore.io/issues/186#issuecomment-249601023 73 | 74 | *.iml 75 | modules.xml 76 | .idea/misc.xml 77 | *.ipr 78 | 79 | ### Java ### 80 | # Compiled class file 81 | *.class 82 | 83 | # Log file 84 | *.log 85 | 86 | # BlueJ files 87 | *.ctxt 88 | 89 | # Mobile Tools for Java (J2ME) 90 | .mtj.tmp/ 91 | 92 | # Package Files # 93 | *.jar 94 | *.war 95 | *.nar 96 | *.ear 97 | *.zip 98 | *.tar.gz 99 | *.rar 100 | 101 | # virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml 102 | hs_err_pid* 103 | 104 | ### macOS ### 105 | # General 106 | .DS_Store 107 | .AppleDouble 108 | .LSOverride 109 | 110 | # Icon must end with two \r 111 | Icon 112 | 113 | # Thumbnails 114 | ._* 115 | 116 | # Files that might appear in the root of a volume 117 | .DocumentRevisions-V100 118 | .fseventsd 119 | .Spotlight-V100 120 | .TemporaryItems 121 | .Trashes 122 | .VolumeIcon.icns 123 | .com.apple.timemachine.donotpresent 124 | 125 | # Directories potentially created on remote AFP share 126 | .AppleDB 127 | .AppleDesktop 128 | Network Trash Folder 129 | Temporary Items 130 | .apdisk 131 | 132 | ### Gradle ### 133 | .gradle 134 | **/build/ 135 | 136 | # Ignore Gradle GUI config 137 | gradle-app.setting 138 | 139 | # Local Properties 140 | gradle-local.properties 141 | 142 | # Avoid ignoring Gradle wrapper jar file (.jar files are usually ignored) 143 | !gradle-wrapper.jar 144 | 145 | # Cache of project 146 | .gradletasknamecache 147 | 148 | # # Work around https://youtrack.jetbrains.com/issue/IDEA-116898 149 | # gradle/wrapper/gradle-wrapper.properties 150 | 151 | ### Node ### 152 | # Logs 153 | logs 154 | *.log 155 | npm-debug.log* 156 | yarn-debug.log* 157 | yarn-error.log* 158 | 159 | # Runtime data 160 | pids 161 | *.pid 162 | *.seed 163 | *.pid.lock 164 | 165 | # Directory for instrumented libs generated by jscoverage/JSCover 166 | lib-cov 167 | 168 | # Coverage directory used by tools like istanbul 169 | coverage 170 | 171 | # nyc test coverage 172 | .nyc_output 173 | 174 | # Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) 175 | .grunt 176 | 177 | # Bower dependency directory (https://bower.io/) 178 | bower_components 179 | 180 | # node-waf configuration 181 | .lock-wscript 182 | 183 | # Compiled binary addons (https://nodejs.org/api/addons.html) 184 | build/Release 185 | 186 | # Dependency directories 187 | node_modules/ 188 | jspm_packages/ 189 | 190 | # TypeScript v1 declaration files 191 | typings/ 192 | 193 | # Optional npm cache directory 194 | .npm 195 | 196 | # Optional eslint cache 197 | .eslintcache 198 | 199 | # Optional REPL history 200 | .node_repl_history 201 | 202 | # Output of 'npm pack' 203 | *.tgz 204 | 205 | # Yarn Integrity file 206 | .yarn-integrity 207 | 208 | # dotenv environment variables file 209 | .env 210 | 211 | # parcel-bundler cache (https://parceljs.org/) 212 | .cache 213 | 214 | # next.js build output 215 | .next 216 | 217 | # nuxt.js build output 218 | .nuxt 219 | 220 | # vuepress build output 221 | .vuepress/dist 222 | 223 | # Serverless directories 224 | .serverless 225 | 226 | # End of https://www.gitignore.io/api/java,macos,gradle,intellij+all -------------------------------------------------------------------------------- /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. -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # springboot-apikey-example 2 | ![Build](https://github.com/gregwhitaker/springboot-apikey-example/workflows/Build/badge.svg) 3 | 4 | An example of authenticating with a Spring Boot application using an API key. 5 | 6 | If you are looking for an example using WebFlux, please check out [springboot-webflux-apikey-example](https://github.com/gregwhitaker/springboot-webflux-apikey-example). 7 | 8 | ## Prerequisites 9 | This example requires that you have a running [PostgreSQL](https://www.postgresql.org/) database. You can start one as a Docker container using the following commands: 10 | 11 | $ docker pull postgres 12 | $ docker run -p 5432:5432 postgres 13 | 14 | ## Running the Example 15 | Follow the steps below to run the example: 16 | 17 | 1. Ensure you have a running PostgreSQL instance at `localhost:5432`. 18 | 19 | 2. Run the following command to start the example application: 20 | 21 | ./gradlew bootRun 22 | 23 | 3. Run the following command to send a request to the non-secure endpoint: 24 | 25 | curl -v http://localhost:8080/api/v1/nonsecure 26 | 27 | If successful, you will receive an `HTTP 200 OK` response. 28 | 29 | 4. Run the following command to send a request to the secure endpoint: 30 | 31 | curl -v http://localhost:8080/api/v1/secure 32 | 33 | You will receive an `HTTP 403 Forbidden` response because you have not supplied a valid API key. 34 | 35 | 5. Run the following command to send a request to the secure endpoint with an API key: 36 | 37 | curl -v --header "API_KEY: aec093c2c98144f99a4a365ad1d2f05e" http://localhost:8080/api/v1/secure 38 | 39 | If successful, you will now receive an `HTTP 200 OK` response because you have supplied a valid API key. 40 | 41 | ## Bugs and Feedback 42 | For bugs, questions, and discussions please use the [Github Issues](https://github.com/gregwhitaker/springboot-apikey-example/issues). 43 | 44 | ## License 45 | Copyright 2019 Greg Whitaker 46 | 47 | Licensed under the Apache License, Version 2.0 (the "License"); 48 | you may not use this file except in compliance with the License. 49 | You may obtain a copy of the License at 50 | 51 | http://www.apache.org/licenses/LICENSE-2.0 52 | 53 | Unless required by applicable law or agreed to in writing, software 54 | distributed under the License is distributed on an "AS IS" BASIS, 55 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 56 | See the License for the specific language governing permissions and 57 | limitations under the License. 58 | -------------------------------------------------------------------------------- /build.gradle: -------------------------------------------------------------------------------- 1 | plugins { 2 | id 'com.gradle.build-scan' version '2.1' 3 | id 'java' 4 | id 'org.springframework.boot' version '2.1.2.RELEASE' 5 | id 'com.github.hierynomus.license' version '0.14.0' 6 | id 'io.spring.dependency-management' version '1.0.6.RELEASE' 7 | id 'org.flywaydb.flyway' version '5.2.0' 8 | } 9 | 10 | // Gradle Build Scan 11 | buildScan { 12 | termsOfServiceUrl = 'https://gradle.com/terms-of-service' 13 | termsOfServiceAgree = 'yes' 14 | publishOnFailure() 15 | } 16 | 17 | repositories { 18 | jcenter() 19 | mavenCentral() 20 | } 21 | 22 | dependencies { 23 | implementation 'org.springframework.boot:spring-boot-starter-web' 24 | implementation 'org.springframework.boot:spring-boot-starter-security' 25 | implementation 'org.springframework.boot:spring-boot-starter-jdbc' 26 | implementation 'org.flywaydb:flyway-core:5.2.0' 27 | implementation 'com.github.ben-manes.caffeine:caffeine:2.6.2' 28 | implementation 'commons-codec:commons-codec:1.11' 29 | 30 | runtime 'org.postgresql:postgresql' 31 | } 32 | 33 | // Database 34 | flyway { 35 | url = 'jdbc:postgresql://localhost:5432/postgres' 36 | user = 'postgres' 37 | } 38 | 39 | // Licensing 40 | license { 41 | header rootProject.file('codequality/HEADER') 42 | strictCheck true 43 | excludes([ "**/*.json", "**/*.html", "**/*.js", "**/*.jpg" ]) 44 | } 45 | -------------------------------------------------------------------------------- /codequality/HEADER: -------------------------------------------------------------------------------- 1 | Copyright 2019 Greg Whitaker 2 | 3 | Licensed under the Apache License, Version 2.0 (the "License"); 4 | you may not use this file except in compliance with the License. 5 | You may obtain a copy of the License at 6 | 7 | http://www.apache.org/licenses/LICENSE-2.0 8 | 9 | Unless required by applicable law or agreed to in writing, software 10 | distributed under the License is distributed on an "AS IS" BASIS, 11 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 | See the License for the specific language governing permissions and 13 | limitations under the License. -------------------------------------------------------------------------------- /gradle.properties: -------------------------------------------------------------------------------- 1 | group=com.github.gregwhitaker 2 | version=0.1.0 3 | -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/gregwhitaker/springboot-apikey-example/e6d78722e4b8ba70666d8767d1c8f949427900d5/gradle/wrapper/gradle-wrapper.jar -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.properties: -------------------------------------------------------------------------------- 1 | distributionBase=GRADLE_USER_HOME 2 | distributionPath=wrapper/dists 3 | distributionUrl=https\://services.gradle.org/distributions/gradle-5.1-bin.zip 4 | zipStoreBase=GRADLE_USER_HOME 5 | zipStorePath=wrapper/dists 6 | -------------------------------------------------------------------------------- /gradlew: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env sh 2 | 3 | ############################################################################## 4 | ## 5 | ## Gradle start up script for UN*X 6 | ## 7 | ############################################################################## 8 | 9 | # Attempt to set APP_HOME 10 | # Resolve links: $0 may be a link 11 | PRG="$0" 12 | # Need this for relative symlinks. 13 | while [ -h "$PRG" ] ; do 14 | ls=`ls -ld "$PRG"` 15 | link=`expr "$ls" : '.*-> \(.*\)$'` 16 | if expr "$link" : '/.*' > /dev/null; then 17 | PRG="$link" 18 | else 19 | PRG=`dirname "$PRG"`"/$link" 20 | fi 21 | done 22 | SAVED="`pwd`" 23 | cd "`dirname \"$PRG\"`/" >/dev/null 24 | APP_HOME="`pwd -P`" 25 | cd "$SAVED" >/dev/null 26 | 27 | APP_NAME="Gradle" 28 | APP_BASE_NAME=`basename "$0"` 29 | 30 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 31 | DEFAULT_JVM_OPTS="" 32 | 33 | # Use the maximum available, or set MAX_FD != -1 to use that value. 34 | MAX_FD="maximum" 35 | 36 | warn () { 37 | echo "$*" 38 | } 39 | 40 | die () { 41 | echo 42 | echo "$*" 43 | echo 44 | exit 1 45 | } 46 | 47 | # OS specific support (must be 'true' or 'false'). 48 | cygwin=false 49 | msys=false 50 | darwin=false 51 | nonstop=false 52 | case "`uname`" in 53 | CYGWIN* ) 54 | cygwin=true 55 | ;; 56 | Darwin* ) 57 | darwin=true 58 | ;; 59 | MINGW* ) 60 | msys=true 61 | ;; 62 | NONSTOP* ) 63 | nonstop=true 64 | ;; 65 | esac 66 | 67 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar 68 | 69 | # Determine the Java command to use to start the JVM. 70 | if [ -n "$JAVA_HOME" ] ; then 71 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then 72 | # IBM's JDK on AIX uses strange locations for the executables 73 | JAVACMD="$JAVA_HOME/jre/sh/java" 74 | else 75 | JAVACMD="$JAVA_HOME/bin/java" 76 | fi 77 | if [ ! -x "$JAVACMD" ] ; then 78 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME 79 | 80 | Please set the JAVA_HOME variable in your environment to match the 81 | location of your Java installation." 82 | fi 83 | else 84 | JAVACMD="java" 85 | which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 86 | 87 | Please set the JAVA_HOME variable in your environment to match the 88 | location of your Java installation." 89 | fi 90 | 91 | # Increase the maximum file descriptors if we can. 92 | if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then 93 | MAX_FD_LIMIT=`ulimit -H -n` 94 | if [ $? -eq 0 ] ; then 95 | if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then 96 | MAX_FD="$MAX_FD_LIMIT" 97 | fi 98 | ulimit -n $MAX_FD 99 | if [ $? -ne 0 ] ; then 100 | warn "Could not set maximum file descriptor limit: $MAX_FD" 101 | fi 102 | else 103 | warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" 104 | fi 105 | fi 106 | 107 | # For Darwin, add options to specify how the application appears in the dock 108 | if $darwin; then 109 | GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" 110 | fi 111 | 112 | # For Cygwin, switch paths to Windows format before running java 113 | if $cygwin ; then 114 | APP_HOME=`cygpath --path --mixed "$APP_HOME"` 115 | CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` 116 | JAVACMD=`cygpath --unix "$JAVACMD"` 117 | 118 | # We build the pattern for arguments to be converted via cygpath 119 | ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` 120 | SEP="" 121 | for dir in $ROOTDIRSRAW ; do 122 | ROOTDIRS="$ROOTDIRS$SEP$dir" 123 | SEP="|" 124 | done 125 | OURCYGPATTERN="(^($ROOTDIRS))" 126 | # Add a user-defined pattern to the cygpath arguments 127 | if [ "$GRADLE_CYGPATTERN" != "" ] ; then 128 | OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" 129 | fi 130 | # Now convert the arguments - kludge to limit ourselves to /bin/sh 131 | i=0 132 | for arg in "$@" ; do 133 | CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` 134 | CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option 135 | 136 | if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition 137 | eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` 138 | else 139 | eval `echo args$i`="\"$arg\"" 140 | fi 141 | i=$((i+1)) 142 | done 143 | case $i in 144 | (0) set -- ;; 145 | (1) set -- "$args0" ;; 146 | (2) set -- "$args0" "$args1" ;; 147 | (3) set -- "$args0" "$args1" "$args2" ;; 148 | (4) set -- "$args0" "$args1" "$args2" "$args3" ;; 149 | (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; 150 | (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; 151 | (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; 152 | (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; 153 | (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; 154 | esac 155 | fi 156 | 157 | # Escape application args 158 | save () { 159 | for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done 160 | echo " " 161 | } 162 | APP_ARGS=$(save "$@") 163 | 164 | # Collect all arguments for the java command, following the shell quoting and substitution rules 165 | eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS" 166 | 167 | # by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong 168 | if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then 169 | cd "$(dirname "$0")" 170 | fi 171 | 172 | exec "$JAVACMD" "$@" 173 | -------------------------------------------------------------------------------- /gradlew.bat: -------------------------------------------------------------------------------- 1 | @if "%DEBUG%" == "" @echo off 2 | @rem ########################################################################## 3 | @rem 4 | @rem Gradle startup script for Windows 5 | @rem 6 | @rem ########################################################################## 7 | 8 | @rem Set local scope for the variables with windows NT shell 9 | if "%OS%"=="Windows_NT" setlocal 10 | 11 | set DIRNAME=%~dp0 12 | if "%DIRNAME%" == "" set DIRNAME=. 13 | set APP_BASE_NAME=%~n0 14 | set APP_HOME=%DIRNAME% 15 | 16 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 17 | set DEFAULT_JVM_OPTS= 18 | 19 | @rem Find java.exe 20 | if defined JAVA_HOME goto findJavaFromJavaHome 21 | 22 | set JAVA_EXE=java.exe 23 | %JAVA_EXE% -version >NUL 2>&1 24 | if "%ERRORLEVEL%" == "0" goto init 25 | 26 | echo. 27 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 28 | echo. 29 | echo Please set the JAVA_HOME variable in your environment to match the 30 | echo location of your Java installation. 31 | 32 | goto fail 33 | 34 | :findJavaFromJavaHome 35 | set JAVA_HOME=%JAVA_HOME:"=% 36 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe 37 | 38 | if exist "%JAVA_EXE%" goto init 39 | 40 | echo. 41 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 42 | echo. 43 | echo Please set the JAVA_HOME variable in your environment to match the 44 | echo location of your Java installation. 45 | 46 | goto fail 47 | 48 | :init 49 | @rem Get command-line arguments, handling Windows variants 50 | 51 | if not "%OS%" == "Windows_NT" goto win9xME_args 52 | 53 | :win9xME_args 54 | @rem Slurp the command line arguments. 55 | set CMD_LINE_ARGS= 56 | set _SKIP=2 57 | 58 | :win9xME_args_slurp 59 | if "x%~1" == "x" goto execute 60 | 61 | set CMD_LINE_ARGS=%* 62 | 63 | :execute 64 | @rem Setup the command line 65 | 66 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar 67 | 68 | @rem Execute Gradle 69 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS% 70 | 71 | :end 72 | @rem End local scope for the variables with windows NT shell 73 | if "%ERRORLEVEL%"=="0" goto mainEnd 74 | 75 | :fail 76 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of 77 | rem the _cmd.exe /c_ return code! 78 | if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 79 | exit /b 1 80 | 81 | :mainEnd 82 | if "%OS%"=="Windows_NT" endlocal 83 | 84 | :omega 85 | -------------------------------------------------------------------------------- /settings.gradle: -------------------------------------------------------------------------------- 1 | rootProject.name = 'springboot-apikey-example' 2 | 3 | -------------------------------------------------------------------------------- /springboot-apikey-example.paw: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/gregwhitaker/springboot-apikey-example/e6d78722e4b8ba70666d8767d1c8f949427900d5/springboot-apikey-example.paw -------------------------------------------------------------------------------- /src/main/java/springboot/apikey/example/Application.java: -------------------------------------------------------------------------------- 1 | /** 2 | * Copyright 2019 Greg Whitaker 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 springboot.apikey.example; 17 | 18 | import org.springframework.boot.SpringApplication; 19 | import org.springframework.boot.autoconfigure.SpringBootApplication; 20 | 21 | @SpringBootApplication 22 | public class Application { 23 | 24 | public static void main(String... args) { 25 | SpringApplication.run(Application.class, args); 26 | } 27 | } 28 | -------------------------------------------------------------------------------- /src/main/java/springboot/apikey/example/auth/ApiKeyAuthFilter.java: -------------------------------------------------------------------------------- 1 | /** 2 | * Copyright 2019 Greg Whitaker 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 springboot.apikey.example.auth; 17 | 18 | import org.slf4j.Logger; 19 | import org.slf4j.LoggerFactory; 20 | import org.springframework.security.web.authentication.preauth.AbstractPreAuthenticatedProcessingFilter; 21 | 22 | import javax.servlet.http.HttpServletRequest; 23 | 24 | /** 25 | * Filter responsible for getting the api key off of incoming requests that need to be authorized. 26 | */ 27 | public class ApiKeyAuthFilter extends AbstractPreAuthenticatedProcessingFilter { 28 | private static final Logger LOG = LoggerFactory.getLogger(ApiKeyAuthFilter.class); 29 | 30 | private final String headerName; 31 | 32 | public ApiKeyAuthFilter(final String headerName) { 33 | this.headerName = headerName; 34 | } 35 | 36 | @Override 37 | protected Object getPreAuthenticatedPrincipal(HttpServletRequest request) { 38 | return request.getHeader(headerName); 39 | } 40 | 41 | @Override 42 | protected Object getPreAuthenticatedCredentials(HttpServletRequest request) { 43 | // No creds when using API key 44 | return null; 45 | } 46 | } 47 | -------------------------------------------------------------------------------- /src/main/java/springboot/apikey/example/auth/ApiKeyAuthManager.java: -------------------------------------------------------------------------------- 1 | /** 2 | * Copyright 2019 Greg Whitaker 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 springboot.apikey.example.auth; 17 | 18 | import com.github.benmanes.caffeine.cache.CacheLoader; 19 | import com.github.benmanes.caffeine.cache.Caffeine; 20 | import com.github.benmanes.caffeine.cache.LoadingCache; 21 | import org.slf4j.Logger; 22 | import org.slf4j.LoggerFactory; 23 | import org.springframework.security.authentication.AuthenticationManager; 24 | import org.springframework.security.authentication.BadCredentialsException; 25 | import org.springframework.security.core.Authentication; 26 | import org.springframework.security.core.AuthenticationException; 27 | import springboot.apikey.example.util.UUIDUtil; 28 | 29 | import javax.sql.DataSource; 30 | import java.sql.Connection; 31 | import java.sql.PreparedStatement; 32 | import java.sql.ResultSet; 33 | import java.util.concurrent.TimeUnit; 34 | 35 | /** 36 | * Handles authenticating api keys against the database. 37 | */ 38 | public class ApiKeyAuthManager implements AuthenticationManager { 39 | private static final Logger LOG = LoggerFactory.getLogger(ApiKeyAuthManager.class); 40 | 41 | private final LoadingCache keys; 42 | 43 | public ApiKeyAuthManager(DataSource dataSource) { 44 | this.keys = Caffeine.newBuilder() 45 | .expireAfterAccess(5, TimeUnit.MINUTES) 46 | .build(new DatabaseCacheLoader(dataSource)); 47 | } 48 | 49 | @Override 50 | public Authentication authenticate(Authentication authentication) throws AuthenticationException { 51 | String principal = (String) authentication.getPrincipal(); 52 | 53 | if (!keys.get(principal)) { 54 | throw new BadCredentialsException("The API key was not found or not the expected value."); 55 | } else { 56 | authentication.setAuthenticated(true); 57 | return authentication; 58 | } 59 | } 60 | 61 | /** 62 | * Caffeine CacheLoader that checks the database for the api key if it not found in the cache. 63 | */ 64 | private static class DatabaseCacheLoader implements CacheLoader { 65 | private final DataSource dataSource; 66 | 67 | DatabaseCacheLoader(DataSource dataSource) { 68 | this.dataSource = dataSource; 69 | } 70 | 71 | @Override 72 | public Boolean load(String key) throws Exception { 73 | LOG.info("Loading api key from database: [key: {}]", key); 74 | 75 | try (Connection conn = dataSource.getConnection()) { 76 | try (PreparedStatement ps = conn.prepareStatement("SELECT * FROM auth WHERE api_key = ?")) { 77 | ps.setObject(1, UUIDUtil.fromHex(key)); 78 | 79 | try (ResultSet rs = ps.executeQuery()) { 80 | if (rs.next()) { 81 | // Valid API Key 82 | return true; 83 | } else { 84 | // Invalid API Key 85 | return false; 86 | } 87 | } 88 | } 89 | } catch (Exception e) { 90 | LOG.error("An error occurred while retrieving api key from database", e); 91 | return false; 92 | } 93 | } 94 | } 95 | } 96 | -------------------------------------------------------------------------------- /src/main/java/springboot/apikey/example/auth/AuthConfiguration.java: -------------------------------------------------------------------------------- 1 | /** 2 | * Copyright 2019 Greg Whitaker 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 springboot.apikey.example.auth; 17 | 18 | import org.springframework.beans.factory.annotation.Autowired; 19 | import org.springframework.context.annotation.Configuration; 20 | import org.springframework.core.annotation.Order; 21 | import org.springframework.security.config.annotation.web.builders.HttpSecurity; 22 | import org.springframework.security.config.annotation.web.configuration.EnableWebSecurity; 23 | import org.springframework.security.config.annotation.web.configuration.WebSecurityConfigurerAdapter; 24 | import org.springframework.security.config.http.SessionCreationPolicy; 25 | 26 | import javax.sql.DataSource; 27 | 28 | @Configuration 29 | @EnableWebSecurity 30 | @Order(1) 31 | public class AuthConfiguration extends WebSecurityConfigurerAdapter { 32 | private static final String API_KEY_AUTH_HEADER_NAME = "API_KEY"; 33 | 34 | @Autowired 35 | private DataSource dataSource; 36 | 37 | @Override 38 | protected void configure(HttpSecurity http) throws Exception { 39 | ApiKeyAuthFilter filter = new ApiKeyAuthFilter(API_KEY_AUTH_HEADER_NAME); 40 | filter.setAuthenticationManager(new ApiKeyAuthManager(dataSource)); 41 | 42 | http.antMatcher("/api/v1/secure"). 43 | csrf(). 44 | disable(). 45 | sessionManagement().sessionCreationPolicy(SessionCreationPolicy.STATELESS). 46 | and() 47 | .addFilter(filter) 48 | .authorizeRequests() 49 | .anyRequest() 50 | .authenticated(); 51 | } 52 | } 53 | -------------------------------------------------------------------------------- /src/main/java/springboot/apikey/example/controller/NonSecureController.java: -------------------------------------------------------------------------------- 1 | /** 2 | * Copyright 2019 Greg Whitaker 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 springboot.apikey.example.controller; 17 | 18 | import org.slf4j.Logger; 19 | import org.slf4j.LoggerFactory; 20 | import org.springframework.http.ResponseEntity; 21 | import org.springframework.web.bind.annotation.GetMapping; 22 | import org.springframework.web.bind.annotation.RestController; 23 | 24 | @RestController 25 | public class NonSecureController { 26 | private static final Logger LOG = LoggerFactory.getLogger(NonSecureController.class); 27 | 28 | @GetMapping(value = "/api/v1/nonsecure") 29 | public ResponseEntity nonsecure() { 30 | LOG.info("Received request: /api/v1/nonsecure"); 31 | return ResponseEntity.ok().build(); 32 | } 33 | } 34 | -------------------------------------------------------------------------------- /src/main/java/springboot/apikey/example/controller/SecureController.java: -------------------------------------------------------------------------------- 1 | /** 2 | * Copyright 2019 Greg Whitaker 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 springboot.apikey.example.controller; 17 | 18 | import org.slf4j.Logger; 19 | import org.slf4j.LoggerFactory; 20 | import org.springframework.http.ResponseEntity; 21 | import org.springframework.web.bind.annotation.GetMapping; 22 | import org.springframework.web.bind.annotation.RestController; 23 | 24 | @RestController 25 | public class SecureController { 26 | private static final Logger LOG = LoggerFactory.getLogger(SecureController.class); 27 | 28 | @GetMapping(value = "/api/v1/secure") 29 | public ResponseEntity secure() { 30 | LOG.info("Received request: /api/v1/secure"); 31 | return ResponseEntity.ok().build(); 32 | } 33 | } 34 | -------------------------------------------------------------------------------- /src/main/java/springboot/apikey/example/util/UUIDUtil.java: -------------------------------------------------------------------------------- 1 | /** 2 | * Copyright 2019 Greg Whitaker 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 springboot.apikey.example.util; 17 | 18 | import org.apache.commons.codec.binary.Hex; 19 | 20 | import java.nio.ByteBuffer; 21 | import java.util.UUID; 22 | 23 | /** 24 | * Utility class for working with UUIDs. 25 | */ 26 | public final class UUIDUtil { 27 | 28 | private UUIDUtil() { 29 | // Noop 30 | } 31 | 32 | /** 33 | * Creates a {@link UUID} from its hex representation. 34 | * 35 | * @param uuid hex representation of uuid 36 | * @return {@link UUID} converted from the hex string 37 | * @throws org.apache.commons.codec.DecoderException thrown if the hex string cannot be decoded 38 | * @throws IndexOutOfBoundsException thrown if the string is not the proper length for a uuid 39 | */ 40 | public static UUID fromHex(String uuid) throws Exception { 41 | byte[] data = Hex.decodeHex(uuid.toCharArray()); 42 | return new UUID(ByteBuffer.wrap(data, 0, 8).getLong(), ByteBuffer.wrap(data, 8, 8).getLong()); 43 | } 44 | 45 | /** 46 | * Gets the hex representation of the supplied {@link UUID} 47 | * 48 | * @param uuid uuid to convert to hex 49 | * @return hex representation of the uuid 50 | */ 51 | public static String toHex(UUID uuid) { 52 | ByteBuffer bytes = ByteBuffer.wrap(new byte[16]); 53 | bytes.putLong(uuid.getMostSignificantBits()); 54 | bytes.putLong(uuid.getLeastSignificantBits()); 55 | return new String(Hex.encodeHex(bytes.array())); 56 | } 57 | } 58 | -------------------------------------------------------------------------------- /src/main/resources/application.properties: -------------------------------------------------------------------------------- 1 | # 2 | # Copyright 2019 Greg Whitaker 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 | 17 | # Database Configuration 18 | spring.datasource.url = jdbc:postgresql://localhost:5432/postgres 19 | spring.datasource.username = postgres 20 | 21 | # Database Version Configuration 22 | spring.flyway.enabled=true 23 | spring.flyway.baseline-on-migrate=true 24 | spring.flyway.locations=classpath:/db/migration 25 | -------------------------------------------------------------------------------- /src/main/resources/db/migration/V1__Initial_Schema.sql: -------------------------------------------------------------------------------- 1 | -- 2 | -- Copyright 2019 Greg Whitaker 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 | 17 | CREATE TABLE auth ( 18 | api_key UUID PRIMARY KEY, 19 | user_id VARCHAR(50) NOT NULL 20 | ); 21 | 22 | INSERT INTO auth(api_key, user_id) VALUES ('aec093c2-c981-44f9-9a4a-365ad1d2f05e','testuser@gmail.com'); 23 | --------------------------------------------------------------------------------