add openapi service

This commit is contained in:
MaxKey
2023-05-23 10:10:40 +08:00
parent 973d715e47
commit 4b1c88c1a2
30 changed files with 1439 additions and 10 deletions

View File

@@ -0,0 +1,14 @@
org.maxkey.autoconfigure.ApplicationAutoConfiguration
org.maxkey.autoconfigure.KaptchaAutoConfiguration
org.maxkey.autoconfigure.MvcAutoConfiguration
org.maxkey.autoconfigure.JwtAuthnAutoConfiguration
org.maxkey.autoconfigure.RedisAutoConfiguration
org.maxkey.autoconfigure.AuthnProviderAutoConfiguration
org.maxkey.autoconfigure.OneTimePasswordAutoConfiguration
org.maxkey.autoconfigure.SmsAutoConfiguration
org.maxkey.autoconfigure.SessionAutoConfiguration
org.maxkey.autoconfigure.TokenAutoConfiguration
org.maxkey.autoconfigure.SwaggerConfig
org.maxkey.autoconfigure.Oauth20ClientAutoConfiguration
org.maxkey.autoconfigure.MaxKeyOpenApiConfig
org.maxkey.autoconfigure.MaxKeyOpenApiMvcConfig

View File

@@ -0,0 +1,258 @@
############################################################################
# Copyright [2022] [MaxKey of copyright http://www.maxkey.top]
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
############################################################################
#MaxKey Server configuration #
############################################################################
#server port
server.port =${SERVER_PORT:9525}
#server context path
server.servlet.context-path =/open
############################################################################
#domain name configuration #
############################################################################
maxkey.server.scheme =http
maxkey.server.basedomain =${SERVER_DOMAIN:maxkey.top}
maxkey.server.domain =sso.${maxkey.server.basedomain}
maxkey.server.name =${maxkey.server.scheme}://${maxkey.server.domain}
maxkey.server.uri =${maxkey.server.name}:${server.port}${server.servlet.context-path}
#default.uri
maxkey.server.default.uri =${maxkey.server.uri}/main
maxkey.server.mgt.uri =${maxkey.server.uri}
maxkey.server.authz.uri =https://${maxkey.server.domain}/maxkey
#InMemory 0 , Redis 2
maxkey.server.persistence =${SERVER_PERSISTENCE:0}
#identity true,false
maxkey.server.provision =${SERVER_PROVISION:false}
maxkey.session.timeout =${SERVER_SESSION_TIMEOUT:1800}
maxkey.auth.jwt.issuer =${maxkey.server.uri}
#default 900
maxkey.auth.jwt.expires =900
maxkey.auth.jwt.secret =7heM-14BtxjyKPuH3ITIm7q2-ps5MuBirWCsrrdbzzSAOuSPrbQYiaJ54AeA0uH2XdkYy3hHAkTFIsieGkyqxOJZ_dQzrCbaYISH9rhUZAKYx8tUY0wkE4ArOC6LqHDJarR6UIcMsARakK9U4dhoOPO1cj74XytemI-w6ACYfzRUn_Rn4e-CQMcnD1C56oNEukwalf06xVgXl41h6K8IBEzLVod58y_VfvFn-NGWpNG0fy_Qxng6dg8Dgva2DobvzMN2eejHGLGB-x809MvC4zbG7CKNVlcrzMYDt2Gt2sOVDrt2l9YqJNfgaLFjrOEVw5cuXemGkX1MvHj6TAsbLg
maxkey.auth.jwt.refresh.secret =7heM-14BtxjyKPuH3ITIm7q2-ps5MuBirWCsrrdbzzSAOuSPrbQYiaJ54AeA0uH2XdkYy3hHAkTFIsieGkyqxOJZ_dQzrCbaYISH9rhUZAKYx8tUY0wkE4ArOC6LqHDJarR6UIcMsARakK9U4dhoOPO1cj74XytemI-w6ACYfzRUn_Rn4e-CQMcnD1C56oNEukwalf06xVgXl41h6K8IBEzLVod58y_VfvFn-NGWpNG0fy_Qxng6dg8Dgva2DobvzMN2eejHGLGB-x809MvC4zbG7CKNVlcrzMYDt2Gt2sOVDrt2l9YqJNfgaLFjrOEVw5cuXemGkX1MvHj6TAsbLg
#plain,bcrypt,pbkdf2,scrypt,md4,md5,sha1,sha256,sha384,sha512,sm3,ldap
maxkey.crypto.password.encoder =bcrypt
############################################################################
#Login configuration #
############################################################################
#enable captcha
maxkey.login.captcha =${LOGIN_CAPTCHA:true}
#enable two factor,use one time password
maxkey.login.mfa =false
#Enable kerberos/SPNEGO
maxkey.login.kerberos =false
#wsFederation
maxkey.login.wsfederation =false
#remeberme
maxkey.login.remeberme =false
#validity
maxkey.login.remeberme.validity =0
#ipaddress whitelist
maxkey.ipaddress.whitelist =false
#JWT support
maxkey.login.jwt =${LOGIN_JWT:true}
maxkey.login.jwt.issuer =${LOGIN_JWT_ISSUER:${maxkey.server.authz.uri}}
############################################################################
#database configuration
# supported database
# mysql
# highgo
# postgresql
############################################################################
spring.datasource.type =com.alibaba.druid.pool.DruidDataSource
#mysql
spring.datasource.driver-class-name =com.mysql.cj.jdbc.Driver
spring.datasource.username =${DATABASE_USER:root}
spring.datasource.password =${DATABASE_PWD:maxkey}
spring.datasource.url =jdbc:mysql://${DATABASE_HOST:localhost}:${DATABASE_PORT:3306}/${DATABASE_NAME:maxkey}?autoReconnect=true&characterEncoding=UTF-8&serverTimezone=UTC
#highgo
#spring.datasource.driver-class-name=com.highgo.jdbc.Driver
#spring.datasource.username=highgo
#spring.datasource.password=High@123
#spring.datasource.url=jdbc:highgo://192.168.56.107:5866/highgo?characterEncoding=UTF-8&useUnicode=true&useSSL=false&tinyInt1isBit=false&allowPublicKeyRetrieval=true&serverTimezone=Asia/Shanghai
#postgresql
#spring.datasource.driver-class-name=org.postgresql.Driver
#spring.datasource.username=root
#spring.datasource.password=maxkey!
#spring.datasource.url=jdbc:postgresql://localhost/maxkey?characterEncoding=UTF-8&useUnicode=true&useSSL=false&tinyInt1isBit=false&allowPublicKeyRetrieval=true&serverTimezone=Asia/Shanghai
#mybatis
mybatis.dialect =mysql
mybatis.type-aliases-package =org.maxkey.entity,org.maxkey.entity.apps,
mybatis.mapper-locations =classpath*:/org/maxkey/persistence/mapper/xml/${mybatis.dialect}/*.xml
mybatis.table-column-snowflake-datacenter-id =1
mybatis.table-column-snowflake-machine-id =1
mybatis.table-column-escape =false
mybatis.table-column-case =lowercase
############################################################################
#redis server configuration #
############################################################################
spring.redis.host =${REDIS_HOST:127.0.0.1}
spring.redis.port =${REDIS_PORT:6379}
spring.redis.password =${REDIS_PWD:password}
spring.redis.timeout =10000
spring.redis.jedis.pool.max-wait =1000
spring.redis.jedis.pool.max-idle =200
spring.redis.lettuce.pool.max-active =-1
spring.redis.lettuce.pool.min-idle =0
############################################################################
#mail configuration #
############################################################################
spring.mail.default-encoding =utf-8
spring.mail.host =${MAIL_HOST:smtp.163.com}
spring.mail.port =${MAIL_PORT:465}
spring.mail.username =${MAIL_USER:maxkey@163.com}
spring.mail.password =${MAIL_PWD:password}
spring.mail.protocol =smtp
spring.mail.properties.ssl =true
spring.mail.properties.sender =${MAIL_SENDER:maxkey@163.com}
spring.mail.properties.mailotp.message.subject =MaxKey One Time PassWord
spring.mail.properties.mailotp.message.template ={0} You Token is {1} , it validity in {2} minutes.
spring.mail.properties.mailotp.message.type =html
spring.mail.properties.mailotp.message.validity =300
############################################################################
#Time-based One-Time Password configuration #
############################################################################
maxkey.otp.policy.type =totp
maxkey.otp.policy.digits =6
maxkey.otp.policy.issuer =${OTP_POLICY_ISSUER:MaxKey}
maxkey.otp.policy.domain =${maxkey.server.domain}
maxkey.otp.policy.period =30
#############################################################################
#SAML V2.0 configuration #
#############################################################################
#saml common
maxkey.saml.v20.max.parser.pool.size =2
maxkey.saml.v20.assertion.validity.time.ins.seconds =90
maxkey.saml.v20.replay.cache.life.in.millis =14400000
maxkey.saml.v20.issue.instant.check.clock.skew.in.seconds =90
maxkey.saml.v20.issue.instant.check.validity.time.in.seconds =300
#saml Identity Provider keystore
maxkey.saml.v20.idp.keystore.password =maxkey
maxkey.saml.v20.idp.keystore.private.key.password =maxkey
maxkey.saml.v20.idp.keystore =classpath\:config/samlServerKeystore.jks
#keystore Identity Provider for security
maxkey.saml.v20.idp.issuing.entity.id =maxkey.top
maxkey.saml.v20.idp.issuer =${maxkey.server.authz.uri}/saml
maxkey.saml.v20.idp.receiver.endpoint =https\://sso.maxkey.top/
#Saml v20 Identity Provider METADATA
maxkey.saml.v20.metadata.orgName =MaxKeyTop
maxkey.saml.v20.metadata.orgDisplayName =MaxKeyTop
maxkey.saml.v20.metadata.orgURL =https://www.maxkey.top
maxkey.saml.v20.metadata.contactType =technical
maxkey.saml.v20.metadata.company =MaxKeyTop
maxkey.saml.v20.metadata.givenName =maxkey
maxkey.saml.v20.metadata.surName =maxkey
maxkey.saml.v20.metadata.emailAddress =maxkeysupport@163.com
maxkey.saml.v20.metadata.telephoneNumber =4008981111
#saml RelayParty keystore
maxkey.saml.v20.sp.keystore.password =maxkey
maxkey.saml.v20.sp.keystore.private.key.password =maxkey
maxkey.saml.v20.sp.keystore =classpath\:config/samlClientKeystore.jks
maxkey.saml.v20.sp.issuing.entity.id =client.maxkey.org
#############################################################################
#OIDC V1.0 METADATA configuration #
#############################################################################
maxkey.oidc.metadata.issuer =${maxkey.server.authz.uri}
maxkey.oidc.metadata.authorizationEndpoint =${maxkey.server.authz.uri}/authz/oauth/v20/authorize
maxkey.oidc.metadata.tokenEndpoint =${maxkey.server.authz.uri}/authz/oauth/v20/token
maxkey.oidc.metadata.userinfoEndpoint =${maxkey.server.authz.uri}/api/connect/userinfo
#############################################################################
#Job Scheduler #
#############################################################################
#one hour for refresh Schedule
maxkey.job.cron.schedule =0 0 0/1 * * ?
maxkey.job.cron.enable =true
############################################################################
#Management endpoints configuration #
############################################################################
management.security.enabled =false
#management.endpoints.jmx.exposure.include=health,info
#management.endpoints.web.exposure.include=metrics,health,info,env,prometheus
management.endpoints.web.exposure.include =*
management.endpoint.health.show-details =ALWAYS
management.health.redis.enabled =false
management.health.mail.enabled =false
#Spring Boot Admin Client
spring.boot.admin.client.enabled =${SPRING_BOOT_ADMIN_ENABLED:false}
spring.boot.admin.client.url =${SPRING_BOOT_ADMIN_URL:http://127.0.0.1:9528}
spring.boot.admin.client.username =${SPRING_BOOT_ADMIN_USERNAME:}
spring.boot.admin.client.password =${SPRING_BOOT_ADMIN_PASSWORD:}
############################################################################
#Do not modify the following configuration
############################################################################
#springfox.documentation.swagger.v2.path=/api-docs #
#Swagger Configure Properties #
############################################################################
maxkey.swagger.enable =true
maxkey.swagger.title =MaxKey\u5355\u70b9\u767b\u5f55\u8ba4\u8bc1\u7cfb\u7edfAPI\u6587\u6863
maxkey.swagger.description =MaxKey\u5355\u70b9\u767b\u5f55\u8ba4\u8bc1\u7cfb\u7edfAPI\u6587\u6863
maxkey.swagger.version =${application.formatted-version}
springdoc.swagger-ui.path =/swagger-ui.html
springdoc.swagger-ui.enabled =true
springdoc.swagger-ui.tags-sorter =alpha
springdoc.swagger-ui.operations-sorter =alpha
springdoc.swagger-ui.showExtensions =true
springdoc.api-docs.path =/v3/api-docs
springdoc.group-configs[0].group =default
springdoc.group-configs[0].paths-to-match =/*
springdoc.group-configs[0].packages-to-scan =org.maxkey
knife4j.enable =true
knife4j.setting.language =zh_cn
knife4j.setting.swagger-model-name =\u5B9E\u4F53\u7C7B\u5217\u8868
############################################################################
#freemarker configuration #
############################################################################
spring.freemarker.template-loader-path =classpath:/templates/views
spring.freemarker.cache =false
spring.freemarker.charset =UTF-8
spring.freemarker.check-template-location =true
spring.freemarker.content-type =text/html
spring.freemarker.expose-request-attributes =false
spring.freemarker.expose-session-attributes =false
spring.freemarker.request-context-attribute =request
spring.freemarker.suffix =.ftl
############################################################################
#static resources configuration #
############################################################################
spring.mvc.static-path-pattern =/static/**
############################################################################
#server servlet encoding configuration #
############################################################################
#encoding
#server.servlet.encoding.charset=UTF-8
#server.servlet.encoding.enabled=true
#server.servlet.encoding.force=true
############################################################################
#Servlet multipart configuration #
############################################################################
spring.servlet.multipart.enabled =true
spring.servlet.multipart.max-file-size =4194304

View File

@@ -0,0 +1,30 @@
############################################################################
# Copyright [2022] [MaxKey of copyright http://www.maxkey.top]
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
############################################################################
#MaxKey Title and Version #
############################################################################
application.title =MaxKey-OpenApi
application.formatted-version =v3.5.18 GA
#for dynamic service discovery
spring.application.name =maxkey-openapi
############################################################################
#Main.banner-mode configuration #
############################################################################
spring.main.banner-mode =log
#spring.main.allow-bean-definition-overriding =true
############################################################################
#spring.profiles.active maxkey-mgt #
############################################################################
spring.profiles.active =${SERVER_PROFILES:maxkey-openapi}

View File

@@ -0,0 +1,18 @@
#nacos config
spring.cloud.nacos.config.server-addr =${NACOS_CONFIG_SERVER_ADDR:127.0.0.1:8848}
# Nacos Console add configuration:
# Data ID:maxkey.properties
# Group:DEFAULT_GROUP
# configuration:useLocalCache=true
spring.application.name =maxkey-mgt
# Suffix for the configuration. Supports properties,yaml,yml,default is properties
spring.cloud.nacos.config.file-extension =properties
#spring.cloud.nacos.config.file-extension=yaml
#nacos enabled
spring.cloud.nacos.config.enabled =${NACOS_CONFIG_ENABLED:false}
spring.cloud.nacos.config.namespace =${NACOS_CONFIG_NAMESPACE:net-maxsso}
#nacos discovery
spring.cloud.nacos.discovery.enabled =${NACOS_DISCOVERY_ENABLED:false}
spring.cloud.nacos.discovery.server-addr =${NACOS_DISCOVERY_SERVER_ADDR:127.0.0.1:8848}
spring.cloud.nacos.discovery.namespace =${NACOS_DISCOVERY_NAMESPACE:net-maxsso}

View File

@@ -0,0 +1,13 @@
{
"keys": [
{
"kty": "RSA",
"d": "K2VCm_6enq5uoFLZXUlWkgbCXj5m9X5uUX3_Ol3qcY9X1cP04TN98R8lpw-ASeFDRFRhe0FT-lYCYu_fqZcrNXVhyN3rgi27af5x4HdFMnHLTLMPvE6aEyTGmZjTF1AbiX5VOJAl6POI9FiyTbV1Uqt943ydJv8SH4NfcYhKBmpp8Fi1f58mon-bYwsIy8mzZjssc8KZy-GzpscKrc5ewb7106JY3uRQNprAHrpcGAPZ8uXUvVhrxp_FNn5Nf5KVxl2tm50L83_5nw0OZrbJ8Ceg7sZAw_Z41lbYbS9VDaST6TuKRb7W4XCKimZUn57LoQT2-Gkv6msJHCmqTgK02Q",
"e": "AQAB",
"use": "sig",
"kid": "maxkey_rsa",
"alg": "RS256",
"n": "vyfZwQuBLNvJDhmziUCFuAfIv-bC6ivodcR6PfanTt8XLd6G63Yx10YChAdsDACjoLz1tEU56WPp_ee_vcTSsEZT3ouWJYghuGI2j4XclXlEj0S7DzdpcBBpI4n5dr8K3iKY-3JUMZR1AMBHI50UaMST9ZTZJAjUPIYxkhRdca5lWBo4wGUh1yj_80-Bq6al0ia9S5NTzNLaJ18jSxFqZ79BAkBm-KjkP248YUk6WBGtYEAV5Fws4dpse4hrqJ3RRHiMZV1o1iTmPHz_l55ZSDP3vpYf6iKqKzoK2RmdjfH5mGpbc4-PclTs4GKfwZ7cWfrny6B7sMnQfzujCH996Q"
}
]
}

View File

@@ -0,0 +1,36 @@
<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="INFO" monitorInterval="300">
<Appenders>
<Console name="consolePrint" target="SYSTEM_OUT">
<PatternLayout pattern="%d{YYYY-MM-dd HH:mm:ss.SSS} %-5level [%t] %logger{36}:%L - %msg%n" />
</Console>
<!-- 输出到文件按天或者超过128MB分割 -->
<RollingFile name="RollingFile" fileName="logs/maxkey_openapi.log" filePattern="logs/$${date:yyyyMMdd}/maxkey-openapi-%d{yyyy-MM-dd}-%i.log.gz">
<!-- 需要记录的级别 -->
<!-- <ThresholdFilter level="info" onMatch="ACCEPT" onMismatch="DENY" /> -->
<PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss,SSS} %-5level [%t] (%logger{36}:%L) - %msg%n" />
<Policies>
<OnStartupTriggeringPolicy />
<TimeBasedTriggeringPolicy />
<SizeBasedTriggeringPolicy size="128 MB" />
</Policies>
<DefaultRolloverStrategy max="100"/>
</RollingFile>
</Appenders>
<Loggers>
<Logger level="INFO" name="org.springframework" ></Logger>
<Logger level="INFO" name="org.apache.logging" ></Logger>
<Logger level="DEBUG" name="org.maxkey" ></Logger>
<Logger level="DEBUG" name="org.apache.mybatis.jpa" ></Logger>
<Logger level="ERROR" name="org.reflections.Reflections" ></Logger>
<Logger level="ERROR" name="RocketmqRemoting" ></Logger>
<Logger level="OFF" name="org.hibernate.validator.internal.util.Version" ></Logger>
<Root level="INFO">
<AppenderRef ref="consolePrint" />
<AppenderRef ref="RollingFile" />
</Root>
</Loggers>
</Configuration>

Binary file not shown.

After

Width:  |  Height:  |  Size: 66 KiB

View File

@@ -0,0 +1,21 @@
<!DOCTYPE html>
<html >
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
<link rel="shortcut icon" type="image/x-icon" href="<@base />/static/favicon.ico"/>
<base href="<@base />"/>
<title>MaxKey Single Sign-On</title>
</head>
<body>
<center>
<hr>
Maxkey Community Edition <br>
Single Sign On ( SSO ) <br>
Version ${appVersion}<br>
<br>
©Copyright 2018 - ${.now?string["yyyy"]} https://www.maxkey.top/<br>
Licensed under the Apache License, Version 2.0 <br>
<hr>
</center>
</body>
</html>