yao/openapi/openapi.go
Max cc181a52f6 Enhance ACL configuration and enforcement with path prefix support
- Updated ACL configuration to include a PathPrefix field, allowing for dynamic path stripping from request URLs.
- Enhanced ACL enforcement logic to log the configured path prefix and adjust request paths accordingly during access checks.
- Improved logging throughout the enforcement process to provide clearer insights into access decisions and scope matching.
- Registered built-in scopes for temporary access tokens, enhancing flexibility in access control for specific endpoints.
- Updated scope management to support constraints for matched scopes, improving granularity in access control configurations.
2025-10-22 19:19:30 +08:00

133 lines
3.1 KiB
Go

package openapi
import (
"path/filepath"
"github.com/gin-gonic/gin"
"github.com/yaoapp/gou/application"
"github.com/yaoapp/yao/config"
"github.com/yaoapp/yao/openapi/captcha"
"github.com/yaoapp/yao/openapi/chat"
"github.com/yaoapp/yao/openapi/dsl"
"github.com/yaoapp/yao/openapi/file"
"github.com/yaoapp/yao/openapi/hello"
"github.com/yaoapp/yao/openapi/job"
"github.com/yaoapp/yao/openapi/kb"
"github.com/yaoapp/yao/openapi/messenger"
"github.com/yaoapp/yao/openapi/oauth"
"github.com/yaoapp/yao/openapi/oauth/acl"
"github.com/yaoapp/yao/openapi/oauth/types"
"github.com/yaoapp/yao/openapi/team"
"github.com/yaoapp/yao/openapi/user"
)
// Server is the OpenAPI server
var Server *OpenAPI = nil
// OpenAPI is the OpenAPI server
type OpenAPI struct {
Config *Config // OpenAPI configuration
OAuth types.OAuth // OAuth service interface
}
// Load loads the OpenAPI server from the configuration
func Load(appConfig config.Config) (*OpenAPI, error) {
var configPath string = filepath.Join("openapi", "openapi.yao")
var configRaw, err = application.App.Read(configPath)
if err != nil {
return nil, err
}
// Parse the configuration
var config Config
err = application.Parse(configPath, configRaw, &config)
if err != nil {
return nil, err
}
// Convert the configuration to an OAuth configuration
oauthConfig, err := config.OAuthConfig(appConfig)
if err != nil {
return nil, err
}
// Create the OAuth service
oauthService, err := oauth.NewService(oauthConfig)
if err != nil {
return nil, err
}
// Load user configurations
err = user.Load(appConfig)
if err != nil {
return nil, err
}
// Load the ACL enforcer
_, err = acl.Load(&acl.Config{
Enabled: true,
PathPrefix: config.BaseURL,
Cache: oauthConfig.Cache,
Provider: oauthConfig.UserProvider,
})
if err != nil {
return nil, err
}
// Create the OpenAPI server
Server = &OpenAPI{Config: &config, OAuth: oauthService}
return Server, nil
}
// Attach attaches the OpenAPI server to the router
func (openapi *OpenAPI) Attach(router *gin.Engine) {
// Ignore if the OpenAPI server is not configured
if openapi.Config == nil {
return
}
// Basic Groups
baseURL := openapi.Config.BaseURL
group := router.Group(baseURL)
// Well-known handlers
openapi.attachWellKnown(router)
// OAuth handlers
openapi.attachOAuth(group)
// Hello World handlers
hello.Attach(group.Group("/helloworld"), openapi.OAuth)
// DSL handlers
dsl.Attach(group.Group("/dsl"), openapi.OAuth)
// File handlers
file.Attach(group.Group("/file"), openapi.OAuth)
// Knowledge Base handlers
kb.Attach(group.Group("/kb"), openapi.OAuth)
// Job Management handlers
job.Attach(group.Group("/job"), openapi.OAuth)
// Chat handlers
chat.Attach(group.Group("/chat"), openapi.OAuth)
// Captcha handlers
captcha.Attach(group.Group("/captcha"), openapi.OAuth)
// User handlers
user.Attach(group.Group("/user"), openapi.OAuth)
// Team handlers
team.Attach(group.Group("/team"), openapi.OAuth)
// Messenger webhook handlers
messenger.Attach(group.Group("/messenger"), openapi.OAuth)
// Custom handlers (Defined by developer)
}