-
Notifications
You must be signed in to change notification settings - Fork 505
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #8227 from yongyiduan/issue_8226
openapi 支持蓝鲸网关jwt鉴权 #8226
- Loading branch information
Showing
8 changed files
with
274 additions
and
54 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| {{ if and .Values.openapi.enabled .Values.openapi.secret.enabled }} | ||
| kind: Secret | ||
| apiVersion: v1 | ||
| metadata: | ||
| name: openapi-bk-key | ||
| data: | ||
| {{ .Values.config.bkCiOpenapiApiPubOuter | splitList "/" | last }}: {{ .Values.openapi.secret.content }} | ||
| type: Opaque | ||
| {{ end }} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
233 changes: 233 additions & 0 deletions
233
...i/biz-openapi/src/main/kotlin/com/tencent/devops/openapi/filter/impl/BlueKingApiFilter.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,233 @@ | ||
| /* | ||
| * Tencent is pleased to support the open source community by making BK-CI 蓝鲸持续集成平台 available. | ||
| * | ||
| * Copyright (C) 2019 THL A29 Limited, a Tencent company. All rights reserved. | ||
| * | ||
| * BK-CI 蓝鲸持续集成平台 is licensed under the MIT license. | ||
| * | ||
| * A copy of the MIT License is included in this file. | ||
| * | ||
| * | ||
| * Terms of the MIT License: | ||
| * --------------------------------------------------- | ||
| * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated | ||
| * documentation files (the "Software"), to deal in the Software without restriction, including without limitation the | ||
| * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to | ||
| * permit persons to whom the Software is furnished to do so, subject to the following conditions: | ||
| * | ||
| * The above copyright notice and this permission notice shall be included in all copies or substantial portions of | ||
| * the Software. | ||
| * | ||
| * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT | ||
| * LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN | ||
| * NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, | ||
| * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE | ||
| * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. | ||
| */ | ||
| package com.tencent.devops.openapi.filter.impl | ||
|
|
||
| import com.tencent.devops.common.api.auth.AUTH_HEADER_DEVOPS_APP_CODE | ||
| import com.tencent.devops.common.api.auth.AUTH_HEADER_DEVOPS_APP_SECRET | ||
| import com.tencent.devops.common.api.auth.AUTH_HEADER_DEVOPS_USER_ID | ||
| import com.tencent.devops.common.api.exception.ErrorCodeException | ||
| import com.tencent.devops.common.api.util.JsonUtil | ||
| import com.tencent.devops.common.service.utils.SpringContextUtil | ||
| import com.tencent.devops.common.web.RequestFilter | ||
| import com.tencent.devops.openapi.constant.OpenAPIMessageCode.ERROR_OPENAPI_JWT_PARSE_FAIL | ||
| import com.tencent.devops.openapi.filter.ApiFilter | ||
| import com.tencent.devops.openapi.utils.ApiGatewayPubFile | ||
| import com.tencent.devops.openapi.utils.ApiGatewayUtil | ||
| import io.jsonwebtoken.Jwts | ||
| import org.bouncycastle.asn1.x509.SubjectPublicKeyInfo | ||
| import org.bouncycastle.jce.provider.BouncyCastleProvider | ||
| import org.bouncycastle.openssl.PEMParser | ||
| import org.bouncycastle.openssl.jcajce.JcaPEMKeyConverter | ||
| import org.slf4j.LoggerFactory | ||
| import org.springframework.beans.factory.annotation.Value | ||
| import java.io.ByteArrayInputStream | ||
| import java.io.InputStreamReader | ||
| import java.security.Security | ||
| import javax.ws.rs.container.ContainerRequestContext | ||
| import javax.ws.rs.container.PreMatching | ||
| import javax.ws.rs.core.Response | ||
| import javax.ws.rs.ext.Provider | ||
|
|
||
| @Provider | ||
| @PreMatching | ||
| @RequestFilter | ||
| @Suppress("UNUSED") | ||
| class BlueKingApiFilter( | ||
| private val apiGatewayUtil: ApiGatewayUtil | ||
| ) : ApiFilter { | ||
|
|
||
| @Value("\${api.blueKing.enable:#{null}}") | ||
| private val apiFilterEnabled: Boolean? = false | ||
|
|
||
| companion object { | ||
| private val logger = LoggerFactory.getLogger(BlueKingApiFilter::class.java) | ||
| private const val appCodeHeader = "app_code" | ||
| private const val appSecHeader = "app_secret" | ||
| private const val jwtHeader = "X-Bkapi-JWT" | ||
| } | ||
|
|
||
| enum class ApiType(val startContextPath: String, val verify: Boolean) { | ||
| DEFAULT("/api/apigw/", true), | ||
| USER("/api/apigw-user/", true), | ||
| APP("/api/apigw-app/", true), | ||
| OP("/api/op/", false), | ||
| SWAGGER("/api/swagger.json", false); | ||
|
|
||
| companion object { | ||
| fun parseType(path: String): ApiType? { | ||
| values().forEach { type -> | ||
| if (path.contains(other = type.startContextPath, ignoreCase = true)) { | ||
| return type | ||
| } | ||
| } | ||
| return null | ||
| } | ||
| } | ||
| } | ||
|
|
||
| @Suppress("UNCHECKED_CAST", "ComplexMethod", "NestedBlockDepth", "ReturnCount") | ||
| override fun verifyJWT(requestContext: ContainerRequestContext): Boolean { | ||
| // path为为空的时候，直接退出 | ||
| val path = requestContext.uriInfo.requestUri.path | ||
| // 判断是否为合法的路径 | ||
| val apiType = ApiType.parseType(path) ?: return false | ||
| // 如果是op的接口访问直接跳过jwt认证 | ||
| if (!apiType.verify) return true | ||
|
|
||
| logger.info("FILTER| url=$path") | ||
| val bkApiJwt = requestContext.getHeaderString(jwtHeader) | ||
| if (bkApiJwt.isNullOrBlank()) { | ||
| logger.error("Request bk api jwt is empty for ${requestContext.request}") | ||
| requestContext.abortWith( | ||
| Response.status(Response.Status.BAD_REQUEST) | ||
| .entity("Request bkapi jwt is empty.") | ||
| .build() | ||
| ) | ||
| return false | ||
| } | ||
|
|
||
| val jwt = parseJwt(bkApiJwt) | ||
| logger.debug("Get the bkApiJwt header|X-Bkapi-JWT={}|jwt={}", bkApiJwt, jwt) | ||
|
|
||
| // 验证应用身份信息 | ||
| if (jwt.contains("app")) { | ||
| val app = jwt["app"] as Map<String, Any> | ||
| // 应用身份登录 | ||
| if (app.contains(appCodeHeader)) { | ||
| val appCode = app[appCodeHeader]?.toString() | ||
| val verified = app["verified"].toString().toBoolean() | ||
| if (apiType == ApiType.APP && (appCode.isNullOrEmpty() || !verified)) { | ||
| return false | ||
| } else { | ||
| if (!appCode.isNullOrBlank()) { | ||
| // 将appCode头部置空 | ||
| requestContext.headers[AUTH_HEADER_DEVOPS_APP_CODE]?.set(0, null) | ||
| if (requestContext.headers[AUTH_HEADER_DEVOPS_APP_CODE] != null) { | ||
| requestContext.headers[AUTH_HEADER_DEVOPS_APP_CODE]?.set(0, appCode) | ||
| } else { | ||
| requestContext.headers.add(AUTH_HEADER_DEVOPS_APP_CODE, appCode) | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| // 在验证应用身份信息 | ||
| if (jwt.contains("user")) { | ||
| // 先做app的验证再做 | ||
| val user = jwt["user"] as Map<String, Any> | ||
| // 用户身份登录 | ||
| if (user.contains("username")) { | ||
| val username = user["username"]?.toString() ?: "" | ||
| val verified = user["verified"].toString().toBoolean() | ||
| // 名字为空或者没有通过认证的时候，直接失败 | ||
| if (username.isNotBlank() && verified) { | ||
| // 将user头部置空 | ||
| requestContext.headers[AUTH_HEADER_DEVOPS_USER_ID]?.set(0, null) | ||
| if (requestContext.headers[AUTH_HEADER_DEVOPS_USER_ID] != null) { | ||
| requestContext.headers[AUTH_HEADER_DEVOPS_USER_ID]?.set(0, username) | ||
| } else { | ||
| requestContext.headers.add(AUTH_HEADER_DEVOPS_USER_ID, username) | ||
| } | ||
| } else if (apiType == ApiType.USER) { | ||
| requestContext.abortWith( | ||
| Response.status(Response.Status.BAD_REQUEST) | ||
| .entity("Request don't has user's access_token.") | ||
| .build() | ||
| ) | ||
| return false | ||
| } | ||
| } | ||
| } | ||
| return true | ||
| } | ||
|
|
||
| override fun filter(requestContext: ContainerRequestContext) { | ||
| if (apiFilterEnabled != true) { | ||
| return | ||
| } | ||
| if (!apiGatewayUtil.isAuth()) { | ||
| // 将query中的app_code和app_secret设置成头部 | ||
| setupHeader(requestContext) | ||
| } else { | ||
| // 验证通过 | ||
| if (!verifyJWT(requestContext)) { | ||
| requestContext.abortWith( | ||
| Response.status(Response.Status.BAD_REQUEST) | ||
| .entity("Devops OpenAPI Auth fail：user or app auth fail.") | ||
| .build() | ||
| ) | ||
| return | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private fun setupHeader(requestContext: ContainerRequestContext) { | ||
| requestContext.uriInfo?.pathParameters?.forEach { pathParam -> | ||
| if (pathParam.key == appCodeHeader && pathParam.value.isNotEmpty()) { | ||
| requestContext.headers[AUTH_HEADER_DEVOPS_APP_CODE]?.set(0, null) | ||
| if (requestContext.headers[AUTH_HEADER_DEVOPS_APP_CODE] != null) { | ||
| requestContext.headers[AUTH_HEADER_DEVOPS_APP_CODE]?.set(0, pathParam.value[0]) | ||
| } else { | ||
| requestContext.headers.add(AUTH_HEADER_DEVOPS_APP_CODE, pathParam.value[0]) | ||
| } | ||
| } else if (pathParam.key == appSecHeader && pathParam.value.isNotEmpty()) { | ||
| requestContext.headers[AUTH_HEADER_DEVOPS_APP_SECRET]?.set(0, null) | ||
| if (requestContext.headers[AUTH_HEADER_DEVOPS_APP_SECRET] != null) { | ||
| requestContext.headers[AUTH_HEADER_DEVOPS_APP_SECRET]?.set(0, pathParam.value[0]) | ||
| } else { | ||
| requestContext.headers.add(AUTH_HEADER_DEVOPS_APP_CODE, pathParam.value[0]) | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private fun parseJwt(bkApiJwt: String): Map<String, Any> { | ||
| var reader: PEMParser? = null | ||
| try { | ||
| val key = SpringContextUtil.getBean(ApiGatewayPubFile::class.java).getPubOuter().toByteArray() | ||
|
|
||
| Security.addProvider(BouncyCastleProvider()) | ||
| val bais = ByteArrayInputStream(key) | ||
| reader = PEMParser(InputStreamReader(bais)) | ||
| val publicKeyInfo = reader.readObject() as SubjectPublicKeyInfo | ||
| val publicKey = JcaPEMKeyConverter().getPublicKey(publicKeyInfo) | ||
| val jwtParser = Jwts.parserBuilder().setSigningKey(publicKey).build() | ||
| val parse = jwtParser.parse(bkApiJwt) | ||
| logger.info("Get the parse body(${parse.body}) and header(${parse.header})") | ||
| return JsonUtil.toMap(parse.body) | ||
| } catch (ignored: Exception) { | ||
| logger.error("BKSystemErrorMonitor| Parse jwt failed.", ignored) | ||
| throw ErrorCodeException( | ||
| errorCode = ERROR_OPENAPI_JWT_PARSE_FAIL, | ||
| defaultMessage = "Parse jwt failed", | ||
| params = arrayOf(bkApiJwt) | ||
| ) | ||
| } finally { | ||
| reader?.close() | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters