├── settings.gradle.kts ├── gradle.properties ├── gradle └── wrapper │ ├── gradle-wrapper.jar │ └── gradle-wrapper.properties ├── README.md ├── src └── main │ ├── kotlin │ └── com │ │ └── codersee │ │ ├── model │ │ └── User.kt │ │ ├── routing │ │ ├── request │ │ │ ├── RefreshTokenRequest.kt │ │ │ ├── LoginRequest.kt │ │ │ └── UserRequest.kt │ │ ├── response │ │ │ ├── RefreshTokenResponse.kt │ │ │ ├── AuthResponse.kt │ │ │ └── UserResponse.kt │ │ ├── Routing.kt │ │ ├── AuthRoute.kt │ │ └── UserRoute.kt │ │ ├── plugins │ │ ├── Serialization.kt │ │ └── Security.kt │ │ ├── repository │ │ ├── RefreshTokenRepository.kt │ │ └── UserRepository.kt │ │ ├── util │ │ └── UUIDSerializer.kt │ │ ├── Application.kt │ │ └── service │ │ ├── JwtService.kt │ │ └── UserService.kt │ └── resources │ ├── application.conf │ └── logback.xml ├── .gitignore ├── gradlew.bat └── gradlew /settings.gradle.kts: -------------------------------------------------------------------------------- 1 | rootProject.name = "com.codersee.ktor-refresh" 2 | -------------------------------------------------------------------------------- /gradle.properties: -------------------------------------------------------------------------------- 1 | ktor_version=2.3.6 2 | kotlin_version=1.9.20 3 | logback_version=1.4.11 4 | kotlin.code.style=official 5 | -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codersee-blog/kotlin-ktor-jwt-access-refresh-tokens/HEAD/gradle/wrapper/gradle-wrapper.jar -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Secure REST API with Ktor and JWT Access Tokens 2 | Repository for Codersee article: https://codersee.com/ktor-app-with-jwt-refresh-token-flow/ 3 | -------------------------------------------------------------------------------- /src/main/kotlin/com/codersee/model/User.kt: -------------------------------------------------------------------------------- 1 | package com.codersee.model 2 | 3 | import java.util.UUID 4 | 5 | data class User( 6 | val id: UUID, 7 | val username: String, 8 | val password: String 9 | ) 10 | -------------------------------------------------------------------------------- /src/main/kotlin/com/codersee/routing/request/RefreshTokenRequest.kt: -------------------------------------------------------------------------------- 1 | package com.codersee.routing.request 2 | 3 | import kotlinx.serialization.Serializable 4 | 5 | @Serializable 6 | data class RefreshTokenRequest( 7 | val token: String, 8 | ) -------------------------------------------------------------------------------- /src/main/kotlin/com/codersee/routing/response/RefreshTokenResponse.kt: -------------------------------------------------------------------------------- 1 | package com.codersee.routing.response 2 | 3 | import kotlinx.serialization.Serializable 4 | 5 | @Serializable 6 | data class RefreshTokenResponse( 7 | val token: String, 8 | ) -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.properties: -------------------------------------------------------------------------------- 1 | distributionBase=GRADLE_USER_HOME 2 | distributionPath=wrapper/dists 3 | distributionUrl=https\://services.gradle.org/distributions/gradle-8.4-bin.zip 4 | zipStoreBase=GRADLE_USER_HOME 5 | zipStorePath=wrapper/dists 6 | -------------------------------------------------------------------------------- /src/main/kotlin/com/codersee/routing/request/LoginRequest.kt: -------------------------------------------------------------------------------- 1 | package com.codersee.routing.request 2 | 3 | import kotlinx.serialization.Serializable 4 | 5 | @Serializable 6 | data class LoginRequest( 7 | val username: String, 8 | val password: String, 9 | ) -------------------------------------------------------------------------------- /src/main/kotlin/com/codersee/routing/request/UserRequest.kt: -------------------------------------------------------------------------------- 1 | package com.codersee.routing.request 2 | 3 | import kotlinx.serialization.Serializable 4 | 5 | @Serializable 6 | data class UserRequest( 7 | val username: String, 8 | val password: String, 9 | ) -------------------------------------------------------------------------------- /src/main/kotlin/com/codersee/routing/response/AuthResponse.kt: -------------------------------------------------------------------------------- 1 | package com.codersee.routing.response 2 | 3 | import kotlinx.serialization.Serializable 4 | 5 | @Serializable 6 | data class AuthResponse( 7 | val accessToken: String, 8 | val refreshToken: String, 9 | ) 10 | -------------------------------------------------------------------------------- /src/main/kotlin/com/codersee/plugins/Serialization.kt: -------------------------------------------------------------------------------- 1 | package com.codersee.plugins 2 | 3 | import io.ktor.serialization.kotlinx.json.* 4 | import io.ktor.server.application.* 5 | import io.ktor.server.plugins.contentnegotiation.* 6 | 7 | fun Application.configureSerialization() { 8 | install(ContentNegotiation) { 9 | json() 10 | } 11 | } 12 | -------------------------------------------------------------------------------- /src/main/resources/application.conf: -------------------------------------------------------------------------------- 1 | ktor { 2 | deployment { 3 | port = 8080 4 | port = ${?PORT} 5 | } 6 | application { 7 | modules = [ com.codersee.ApplicationKt.module ] 8 | } 9 | } 10 | jwt { 11 | audience = "my-audience" 12 | issuer = "http://localhost/" 13 | realm = "My realm" 14 | secret = ${SECRET} 15 | } -------------------------------------------------------------------------------- /src/main/kotlin/com/codersee/routing/response/UserResponse.kt: -------------------------------------------------------------------------------- 1 | package com.codersee.routing.response 2 | 3 | import com.codersee.util.UUIDSerializer 4 | import kotlinx.serialization.Serializable 5 | import java.util.* 6 | 7 | @Serializable 8 | data class UserResponse( 9 | @Serializable(with = UUIDSerializer::class) 10 | val id: UUID, 11 | val username: String, 12 | ) -------------------------------------------------------------------------------- /src/main/kotlin/com/codersee/repository/RefreshTokenRepository.kt: -------------------------------------------------------------------------------- 1 | package com.codersee.repository 2 | 3 | class RefreshTokenRepository { 4 | 5 | private val tokens = mutableMapOf() 6 | 7 | fun findUsernameByToken(token: String): String? = 8 | tokens[token] 9 | 10 | fun save(token: String, username: String) { 11 | tokens[token] = username 12 | } 13 | 14 | } -------------------------------------------------------------------------------- /src/main/kotlin/com/codersee/routing/Routing.kt: -------------------------------------------------------------------------------- 1 | package com.codersee.routing 2 | 3 | import com.codersee.service.UserService 4 | import io.ktor.server.application.* 5 | import io.ktor.server.routing.* 6 | 7 | fun Application.configureRouting( 8 | userService: UserService 9 | ) { 10 | routing { 11 | 12 | route("/api/auth") { 13 | authRoute(userService) 14 | } 15 | 16 | route("/api/user") { 17 | userRoute(userService) 18 | } 19 | 20 | } 21 | } -------------------------------------------------------------------------------- /src/main/resources/logback.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | %d{YYYY-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /src/main/kotlin/com/codersee/repository/UserRepository.kt: -------------------------------------------------------------------------------- 1 | package com.codersee.repository 2 | 3 | import com.codersee.model.User 4 | import java.util.* 5 | 6 | class UserRepository { 7 | 8 | private val users = mutableListOf() 9 | 10 | fun findAll(): List = 11 | users 12 | 13 | fun findById(id: UUID): User? = 14 | users.firstOrNull { it.id == id } 15 | 16 | fun findByUsername(username: String): User? = 17 | users.firstOrNull { it.username == username } 18 | 19 | fun save(user: User): Boolean = 20 | users.add(user) 21 | } -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .gradle 2 | build/ 3 | !gradle/wrapper/gradle-wrapper.jar 4 | !**/src/main/**/build/ 5 | !**/src/test/**/build/ 6 | 7 | ### STS ### 8 | .apt_generated 9 | .classpath 10 | .factorypath 11 | .project 12 | .settings 13 | .springBeans 14 | .sts4-cache 15 | bin/ 16 | !**/src/main/**/bin/ 17 | !**/src/test/**/bin/ 18 | 19 | ### IntelliJ IDEA ### 20 | .idea 21 | *.iws 22 | *.iml 23 | *.ipr 24 | out/ 25 | !**/src/main/**/out/ 26 | !**/src/test/**/out/ 27 | 28 | ### NetBeans ### 29 | /nbproject/private/ 30 | /nbbuild/ 31 | /dist/ 32 | /nbdist/ 33 | /.nb-gradle/ 34 | 35 | ### VS Code ### 36 | .vscode/ -------------------------------------------------------------------------------- /src/main/kotlin/com/codersee/plugins/Security.kt: -------------------------------------------------------------------------------- 1 | package com.codersee.plugins 2 | 3 | import com.codersee.service.JwtService 4 | import io.ktor.server.application.* 5 | import io.ktor.server.auth.* 6 | import io.ktor.server.auth.jwt.* 7 | 8 | fun Application.configureSecurity( 9 | jwtService: JwtService 10 | ) { 11 | authentication { 12 | jwt { 13 | realm = jwtService.realm 14 | verifier(jwtService.jwtVerifier) 15 | 16 | validate { credential -> 17 | jwtService.customValidator(credential) 18 | } 19 | } 20 | 21 | jwt("another-auth") { 22 | realm = jwtService.realm 23 | verifier(jwtService.jwtVerifier) 24 | 25 | validate { credential -> 26 | jwtService.customValidator(credential) 27 | } 28 | } 29 | } 30 | } 31 | 32 | -------------------------------------------------------------------------------- /src/main/kotlin/com/codersee/util/UUIDSerializer.kt: -------------------------------------------------------------------------------- 1 | package com.codersee.util 2 | 3 | import kotlinx.serialization.KSerializer 4 | import kotlinx.serialization.descriptors.PrimitiveKind 5 | import kotlinx.serialization.descriptors.PrimitiveSerialDescriptor 6 | import kotlinx.serialization.descriptors.SerialDescriptor 7 | import kotlinx.serialization.encoding.Decoder 8 | import kotlinx.serialization.encoding.Encoder 9 | import java.util.* 10 | 11 | object UUIDSerializer : KSerializer { 12 | 13 | override val descriptor: SerialDescriptor 14 | get() = PrimitiveSerialDescriptor("UUID", PrimitiveKind.STRING) 15 | 16 | override fun deserialize(decoder: Decoder): UUID = 17 | UUID.fromString(decoder.decodeString()) 18 | 19 | override fun serialize(encoder: Encoder, value: UUID) = 20 | encoder.encodeString(value.toString()) 21 | } -------------------------------------------------------------------------------- /src/main/kotlin/com/codersee/Application.kt: -------------------------------------------------------------------------------- 1 | package com.codersee 2 | 3 | import com.codersee.plugins.configureSecurity 4 | import com.codersee.plugins.configureSerialization 5 | import com.codersee.repository.RefreshTokenRepository 6 | import com.codersee.repository.UserRepository 7 | import com.codersee.routing.configureRouting 8 | import com.codersee.service.JwtService 9 | import com.codersee.service.UserService 10 | import io.ktor.server.application.* 11 | 12 | fun main(args: Array) { 13 | io.ktor.server.netty.EngineMain.main(args) 14 | } 15 | 16 | fun Application.module() { 17 | val userRepository = UserRepository() 18 | val refreshTokenRepository = RefreshTokenRepository() 19 | val jwtService = JwtService(this, userRepository) 20 | val userService = UserService(userRepository, jwtService, refreshTokenRepository) 21 | 22 | configureSerialization() 23 | configureSecurity(jwtService) 24 | configureRouting(userService) 25 | } 26 | -------------------------------------------------------------------------------- /src/main/kotlin/com/codersee/routing/AuthRoute.kt: -------------------------------------------------------------------------------- 1 | package com.codersee.routing 2 | 3 | import com.codersee.routing.request.LoginRequest 4 | import com.codersee.routing.request.RefreshTokenRequest 5 | import com.codersee.routing.response.AuthResponse 6 | import com.codersee.routing.response.RefreshTokenResponse 7 | import com.codersee.service.UserService 8 | import io.ktor.http.* 9 | import io.ktor.server.application.* 10 | import io.ktor.server.request.* 11 | import io.ktor.server.response.* 12 | import io.ktor.server.routing.* 13 | 14 | fun Route.authRoute(userService: UserService) { 15 | 16 | post { 17 | val loginRequest = call.receive() 18 | 19 | val authResponse: AuthResponse? = userService.authenticate(loginRequest) 20 | 21 | authResponse?.let { 22 | call.respond(authResponse) 23 | } ?: call.respond( 24 | message = HttpStatusCode.Unauthorized 25 | ) 26 | } 27 | 28 | post("/refresh") { 29 | val request = call.receive() 30 | 31 | val newAccessToken = userService.refreshToken(token = request.token) 32 | 33 | newAccessToken?.let { 34 | call.respond( 35 | RefreshTokenResponse(it) 36 | ) 37 | } ?: call.respond( 38 | message = HttpStatusCode.Unauthorized 39 | ) 40 | } 41 | 42 | } -------------------------------------------------------------------------------- /src/main/kotlin/com/codersee/routing/UserRoute.kt: -------------------------------------------------------------------------------- 1 | package com.codersee.routing 2 | 3 | import com.codersee.model.User 4 | import com.codersee.routing.request.UserRequest 5 | import com.codersee.routing.response.UserResponse 6 | import com.codersee.service.UserService 7 | import io.ktor.http.* 8 | import io.ktor.server.application.* 9 | import io.ktor.server.auth.* 10 | import io.ktor.server.auth.jwt.* 11 | import io.ktor.server.request.* 12 | import io.ktor.server.response.* 13 | import io.ktor.server.routing.* 14 | import java.util.* 15 | 16 | fun Route.userRoute(userService: UserService) { 17 | 18 | post { 19 | val userRequest = call.receive() 20 | 21 | val createdUser = userService.save( 22 | user = userRequest.toModel() 23 | ) ?: return@post call.respond(HttpStatusCode.BadRequest) 24 | 25 | call.response.header( 26 | name = "id", 27 | value = createdUser.id.toString() 28 | ) 29 | call.respond( 30 | message = HttpStatusCode.Created 31 | ) 32 | } 33 | 34 | authenticate { 35 | get { 36 | val users = userService.findAll() 37 | 38 | call.respond( 39 | message = users.map(User::toResponse) 40 | ) 41 | } 42 | } 43 | 44 | authenticate("another-auth") { 45 | get("/{id}") { 46 | val id: String = call.parameters["id"] 47 | ?: return@get call.respond(HttpStatusCode.BadRequest) 48 | 49 | val foundUser = userService.findById(id) 50 | ?: return@get call.respond(HttpStatusCode.NotFound) 51 | 52 | if (foundUser.username != extractPrincipalUsername(call)) 53 | return@get call.respond(HttpStatusCode.NotFound) 54 | 55 | call.respond( 56 | message = foundUser.toResponse() 57 | ) 58 | } 59 | } 60 | } 61 | 62 | private fun UserRequest.toModel(): User = 63 | User( 64 | id = UUID.randomUUID(), 65 | username = this.username, 66 | password = this.password 67 | ) 68 | 69 | private fun User.toResponse(): UserResponse = 70 | UserResponse( 71 | id = this.id, 72 | username = this.username, 73 | ) 74 | 75 | private fun extractPrincipalUsername(call: ApplicationCall): String? = 76 | call.principal() 77 | ?.payload 78 | ?.getClaim("username") 79 | ?.asString() 80 | -------------------------------------------------------------------------------- /src/main/kotlin/com/codersee/service/JwtService.kt: -------------------------------------------------------------------------------- 1 | package com.codersee.service 2 | 3 | import com.auth0.jwt.JWT 4 | import com.auth0.jwt.JWTVerifier 5 | import com.auth0.jwt.algorithms.Algorithm 6 | import com.codersee.model.User 7 | import com.codersee.repository.UserRepository 8 | import io.ktor.server.application.* 9 | import io.ktor.server.auth.jwt.* 10 | import java.util.* 11 | 12 | class JwtService( 13 | private val application: Application, 14 | private val userRepository: UserRepository, 15 | ) { 16 | 17 | private val secret = getConfigProperty("jwt.secret") 18 | private val issuer = getConfigProperty("jwt.issuer") 19 | private val audience = getConfigProperty("jwt.audience") 20 | 21 | val realm = getConfigProperty("jwt.realm") 22 | 23 | val jwtVerifier: JWTVerifier = 24 | JWT 25 | .require(Algorithm.HMAC256(secret)) 26 | .withAudience(audience) 27 | .withIssuer(issuer) 28 | .build() 29 | 30 | fun createAccessToken(username: String): String = 31 | createJwtToken(username, 3_600_000) 32 | 33 | fun createRefreshToken(username: String): String = 34 | createJwtToken(username, 86_400_000) 35 | 36 | private fun createJwtToken(username: String, expireIn: Int): String = 37 | JWT.create() 38 | .withAudience(audience) 39 | .withIssuer(issuer) 40 | .withClaim("username", username) 41 | .withExpiresAt(Date(System.currentTimeMillis() + expireIn)) 42 | .sign(Algorithm.HMAC256(secret)) 43 | 44 | 45 | fun customValidator( 46 | credential: JWTCredential, 47 | ): JWTPrincipal? { 48 | val username: String? = extractUsername(credential) 49 | val foundUser: User? = username?.let(userRepository::findByUsername) 50 | 51 | return foundUser?.let { 52 | if (audienceMatches(credential)) 53 | JWTPrincipal(credential.payload) 54 | else 55 | null 56 | } 57 | } 58 | 59 | private fun audienceMatches( 60 | credential: JWTCredential, 61 | ): Boolean = 62 | credential.payload.audience.contains(audience) 63 | 64 | fun audienceMatches( 65 | audience: String 66 | ): Boolean = 67 | this.audience == audience 68 | 69 | private fun getConfigProperty(path: String) = 70 | application.environment.config.property(path).getString() 71 | 72 | private fun extractUsername(credential: JWTCredential): String? = 73 | credential.payload.getClaim("username").asString() 74 | } 75 | 76 | 77 | -------------------------------------------------------------------------------- /src/main/kotlin/com/codersee/service/UserService.kt: -------------------------------------------------------------------------------- 1 | package com.codersee.service 2 | 3 | import com.auth0.jwt.interfaces.DecodedJWT 4 | import com.codersee.model.User 5 | import com.codersee.repository.RefreshTokenRepository 6 | import com.codersee.repository.UserRepository 7 | import com.codersee.routing.request.LoginRequest 8 | import com.codersee.routing.response.AuthResponse 9 | import java.util.* 10 | 11 | class UserService( 12 | private val userRepository: UserRepository, 13 | private val jwtService: JwtService, 14 | private val refreshTokenRepository: RefreshTokenRepository 15 | ) { 16 | 17 | fun findAll(): List = 18 | userRepository.findAll() 19 | 20 | fun findById(id: String): User? = 21 | userRepository.findById( 22 | id = UUID.fromString(id) 23 | ) 24 | 25 | fun findByUsername(username: String): User? = 26 | userRepository.findByUsername(username) 27 | 28 | fun save(user: User): User? { 29 | val foundUser = userRepository.findByUsername(user.username) 30 | 31 | return if (foundUser == null) { 32 | userRepository.save(user) 33 | user 34 | } else null 35 | } 36 | 37 | fun authenticate(loginRequest: LoginRequest): AuthResponse? { 38 | val username = loginRequest.username 39 | val foundUser: User? = userRepository.findByUsername(username) 40 | 41 | return if (foundUser != null && loginRequest.password == foundUser.password) { 42 | val accessToken = jwtService.createAccessToken(username) 43 | val refreshToken = jwtService.createRefreshToken(username) 44 | 45 | refreshTokenRepository.save(refreshToken, username) 46 | 47 | AuthResponse( 48 | accessToken = accessToken, 49 | refreshToken = refreshToken, 50 | ) 51 | } else 52 | null 53 | } 54 | 55 | fun refreshToken(token: String): String? { 56 | val decodedRefreshToken = verifyRefreshToken(token) 57 | val persistedUsername = refreshTokenRepository.findUsernameByToken(token) 58 | 59 | return if (decodedRefreshToken != null && persistedUsername != null) { 60 | val foundUser: User? = userRepository.findByUsername(persistedUsername) 61 | val usernameFromRefreshToken: String? = decodedRefreshToken.getClaim("username").asString() 62 | 63 | if (foundUser != null && usernameFromRefreshToken == foundUser.username) 64 | jwtService.createAccessToken(persistedUsername) 65 | else 66 | null 67 | } else 68 | null 69 | } 70 | 71 | private fun verifyRefreshToken(token: String): DecodedJWT? { 72 | val decodedJwt: DecodedJWT? = getDecodedJwt(token) 73 | 74 | return decodedJwt?.let { 75 | val audienceMatches = jwtService.audienceMatches(it.audience.first()) 76 | 77 | if (audienceMatches) 78 | decodedJwt 79 | else 80 | null 81 | } 82 | } 83 | 84 | private fun getDecodedJwt(token: String): DecodedJWT? = 85 | try { 86 | jwtService.jwtVerifier.verify(token) 87 | } catch (ex: Exception) { 88 | null 89 | } 90 | } -------------------------------------------------------------------------------- /gradlew.bat: -------------------------------------------------------------------------------- 1 | @rem 2 | @rem Copyright 2015 the original author or authors. 3 | @rem 4 | @rem Licensed under the Apache License, Version 2.0 (the "License"); 5 | @rem you may not use this file except in compliance with the License. 6 | @rem You may obtain a copy of the License at 7 | @rem 8 | @rem https://www.apache.org/licenses/LICENSE-2.0 9 | @rem 10 | @rem Unless required by applicable law or agreed to in writing, software 11 | @rem distributed under the License is distributed on an "AS IS" BASIS, 12 | @rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | @rem See the License for the specific language governing permissions and 14 | @rem limitations under the License. 15 | @rem 16 | 17 | @if "%DEBUG%" == "" @echo off 18 | @rem ########################################################################## 19 | @rem 20 | @rem Gradle startup script for Windows 21 | @rem 22 | @rem ########################################################################## 23 | 24 | @rem Set local scope for the variables with windows NT shell 25 | if "%OS%"=="Windows_NT" setlocal 26 | 27 | set DIRNAME=%~dp0 28 | if "%DIRNAME%" == "" set DIRNAME=. 29 | set APP_BASE_NAME=%~n0 30 | set APP_HOME=%DIRNAME% 31 | 32 | @rem Resolve any "." and ".." in APP_HOME to make it shorter. 33 | for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi 34 | 35 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 36 | set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" 37 | 38 | @rem Find java.exe 39 | if defined JAVA_HOME goto findJavaFromJavaHome 40 | 41 | set JAVA_EXE=java.exe 42 | %JAVA_EXE% -version >NUL 2>&1 43 | if "%ERRORLEVEL%" == "0" goto execute 44 | 45 | echo. 46 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 47 | echo. 48 | echo Please set the JAVA_HOME variable in your environment to match the 49 | echo location of your Java installation. 50 | 51 | goto fail 52 | 53 | :findJavaFromJavaHome 54 | set JAVA_HOME=%JAVA_HOME:"=% 55 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe 56 | 57 | if exist "%JAVA_EXE%" goto execute 58 | 59 | echo. 60 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 61 | echo. 62 | echo Please set the JAVA_HOME variable in your environment to match the 63 | echo location of your Java installation. 64 | 65 | goto fail 66 | 67 | :execute 68 | @rem Setup the command line 69 | 70 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar 71 | 72 | 73 | @rem Execute Gradle 74 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* 75 | 76 | :end 77 | @rem End local scope for the variables with windows NT shell 78 | if "%ERRORLEVEL%"=="0" goto mainEnd 79 | 80 | :fail 81 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of 82 | rem the _cmd.exe /c_ return code! 83 | if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 84 | exit /b 1 85 | 86 | :mainEnd 87 | if "%OS%"=="Windows_NT" endlocal 88 | 89 | :omega 90 | -------------------------------------------------------------------------------- /gradlew: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | # 4 | # Copyright © 2015-2021 the original authors. 5 | # 6 | # Licensed under the Apache License, Version 2.0 (the "License"); 7 | # you may not use this file except in compliance with the License. 8 | # You may obtain a copy of the License at 9 | # 10 | # https://www.apache.org/licenses/LICENSE-2.0 11 | # 12 | # Unless required by applicable law or agreed to in writing, software 13 | # distributed under the License is distributed on an "AS IS" BASIS, 14 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | # See the License for the specific language governing permissions and 16 | # limitations under the License. 17 | # 18 | 19 | ############################################################################## 20 | # 21 | # Gradle start up script for POSIX generated by Gradle. 22 | # 23 | # Important for running: 24 | # 25 | # (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is 26 | # noncompliant, but you have some other compliant shell such as ksh or 27 | # bash, then to run this script, type that shell name before the whole 28 | # command line, like: 29 | # 30 | # ksh Gradle 31 | # 32 | # Busybox and similar reduced shells will NOT work, because this script 33 | # requires all of these POSIX shell features: 34 | # * functions; 35 | # * expansions «$var», «${var}», «${var:-default}», «${var+SET}», 36 | # «${var#prefix}», «${var%suffix}», and «$( cmd )»; 37 | # * compound commands having a testable exit status, especially «case»; 38 | # * various built-in commands including «command», «set», and «ulimit». 39 | # 40 | # Important for patching: 41 | # 42 | # (2) This script targets any POSIX shell, so it avoids extensions provided 43 | # by Bash, Ksh, etc; in particular arrays are avoided. 44 | # 45 | # The "traditional" practice of packing multiple parameters into a 46 | # space-separated string is a well documented source of bugs and security 47 | # problems, so this is (mostly) avoided, by progressively accumulating 48 | # options in "$@", and eventually passing that to Java. 49 | # 50 | # Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, 51 | # and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; 52 | # see the in-line comments for details. 53 | # 54 | # There are tweaks for specific operating systems such as AIX, CygWin, 55 | # Darwin, MinGW, and NonStop. 56 | # 57 | # (3) This script is generated from the Groovy template 58 | # https://github.com/gradle/gradle/blob/master/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt 59 | # within the Gradle project. 60 | # 61 | # You can find Gradle at https://github.com/gradle/gradle/. 62 | # 63 | ############################################################################## 64 | 65 | # Attempt to set APP_HOME 66 | 67 | # Resolve links: $0 may be a link 68 | app_path=$0 69 | 70 | # Need this for daisy-chained symlinks. 71 | while 72 | APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path 73 | [ -h "$app_path" ] 74 | do 75 | ls=$( ls -ld "$app_path" ) 76 | link=${ls#*' -> '} 77 | case $link in #( 78 | /*) app_path=$link ;; #( 79 | *) app_path=$APP_HOME$link ;; 80 | esac 81 | done 82 | 83 | APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit 84 | 85 | APP_NAME="Gradle" 86 | APP_BASE_NAME=${0##*/} 87 | 88 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 89 | DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' 90 | 91 | # Use the maximum available, or set MAX_FD != -1 to use that value. 92 | MAX_FD=maximum 93 | 94 | warn () { 95 | echo "$*" 96 | } >&2 97 | 98 | die () { 99 | echo 100 | echo "$*" 101 | echo 102 | exit 1 103 | } >&2 104 | 105 | # OS specific support (must be 'true' or 'false'). 106 | cygwin=false 107 | msys=false 108 | darwin=false 109 | nonstop=false 110 | case "$( uname )" in #( 111 | CYGWIN* ) cygwin=true ;; #( 112 | Darwin* ) darwin=true ;; #( 113 | MSYS* | MINGW* ) msys=true ;; #( 114 | NONSTOP* ) nonstop=true ;; 115 | esac 116 | 117 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar 118 | 119 | 120 | # Determine the Java command to use to start the JVM. 121 | if [ -n "$JAVA_HOME" ] ; then 122 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then 123 | # IBM's JDK on AIX uses strange locations for the executables 124 | JAVACMD=$JAVA_HOME/jre/sh/java 125 | else 126 | JAVACMD=$JAVA_HOME/bin/java 127 | fi 128 | if [ ! -x "$JAVACMD" ] ; then 129 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME 130 | 131 | Please set the JAVA_HOME variable in your environment to match the 132 | location of your Java installation." 133 | fi 134 | else 135 | JAVACMD=java 136 | which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 137 | 138 | Please set the JAVA_HOME variable in your environment to match the 139 | location of your Java installation." 140 | fi 141 | 142 | # Increase the maximum file descriptors if we can. 143 | if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then 144 | case $MAX_FD in #( 145 | max*) 146 | MAX_FD=$( ulimit -H -n ) || 147 | warn "Could not query maximum file descriptor limit" 148 | esac 149 | case $MAX_FD in #( 150 | '' | soft) :;; #( 151 | *) 152 | ulimit -n "$MAX_FD" || 153 | warn "Could not set maximum file descriptor limit to $MAX_FD" 154 | esac 155 | fi 156 | 157 | # Collect all arguments for the java command, stacking in reverse order: 158 | # * args from the command line 159 | # * the main class name 160 | # * -classpath 161 | # * -D...appname settings 162 | # * --module-path (only if needed) 163 | # * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. 164 | 165 | # For Cygwin or MSYS, switch paths to Windows format before running java 166 | if "$cygwin" || "$msys" ; then 167 | APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) 168 | CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) 169 | 170 | JAVACMD=$( cygpath --unix "$JAVACMD" ) 171 | 172 | # Now convert the arguments - kludge to limit ourselves to /bin/sh 173 | for arg do 174 | if 175 | case $arg in #( 176 | -*) false ;; # don't mess with options #( 177 | /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath 178 | [ -e "$t" ] ;; #( 179 | *) false ;; 180 | esac 181 | then 182 | arg=$( cygpath --path --ignore --mixed "$arg" ) 183 | fi 184 | # Roll the args list around exactly as many times as the number of 185 | # args, so each arg winds up back in the position where it started, but 186 | # possibly modified. 187 | # 188 | # NB: a `for` loop captures its iteration list before it begins, so 189 | # changing the positional parameters here affects neither the number of 190 | # iterations, nor the values presented in `arg`. 191 | shift # remove old arg 192 | set -- "$@" "$arg" # push replacement arg 193 | done 194 | fi 195 | 196 | # Collect all arguments for the java command; 197 | # * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of 198 | # shell script including quotes and variable substitutions, so put them in 199 | # double quotes to make sure that they get re-expanded; and 200 | # * put everything else in single quotes, so that it's not re-expanded. 201 | 202 | set -- \ 203 | "-Dorg.gradle.appname=$APP_BASE_NAME" \ 204 | -classpath "$CLASSPATH" \ 205 | org.gradle.wrapper.GradleWrapperMain \ 206 | "$@" 207 | 208 | # Use "xargs" to parse quoted args. 209 | # 210 | # With -n1 it outputs one arg per line, with the quotes and backslashes removed. 211 | # 212 | # In Bash we could simply go: 213 | # 214 | # readarray ARGS < <( xargs -n1 <<<"$var" ) && 215 | # set -- "${ARGS[@]}" "$@" 216 | # 217 | # but POSIX shell has neither arrays nor command substitution, so instead we 218 | # post-process each arg (as a line of input to sed) to backslash-escape any 219 | # character that might be a shell metacharacter, then use eval to reverse 220 | # that process (while maintaining the separation between arguments), and wrap 221 | # the whole thing up as a single "set" statement. 222 | # 223 | # This will of course break if any of these variables contains a newline or 224 | # an unmatched quote. 225 | # 226 | 227 | eval "set -- $( 228 | printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | 229 | xargs -n1 | 230 | sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | 231 | tr '\n' ' ' 232 | )" '"$@"' 233 | 234 | exec "$JAVACMD" "$@" 235 | --------------------------------------------------------------------------------