mirror of
https://github.com/pocket-id/pocket-id.git
synced 2026-09-21 18:39:05 +02:00
ItalyPaleAle
fadb1a5552
FRANCIS_HOST decides where the Francis actor runtime lives. When set to "embedded" (the default), Pocket ID starts the runtime inside its own process. Any other value is the address, or a comma-separated list of addresses, of a standalone Francis runtime. Pocket ID then connects to it as a remote actor host and starts no embedded runtime. Because when using a remote runtime, it's likewise not possible to enforce a single instance of Pocket ID is running at once, the env vars currently have the `EXPERIMENTAL_` prefix, are **undocumented**, and show a warning if used. Notes: - Connecting to a standalone runtime also needs FRANCIS_HOST_PSK or FRANCIS_HOST_JWT_FILE, and optionally (but recommended) FRANCIS_CA. - When connecting to a remote runtime, exporting Pocket ID data does not include the actor state, which will need to be backed up and restored separately
80 lines
2.3 KiB
Go
80 lines
2.3 KiB
Go
package apikey
|
|
|
|
import (
|
|
"context"
|
|
"errors"
|
|
"fmt"
|
|
|
|
"github.com/gin-gonic/gin"
|
|
francishost "github.com/italypaleale/francis/host"
|
|
"gorm.io/gorm"
|
|
|
|
"github.com/pocket-id/pocket-id/backend/internal/appconfig"
|
|
"github.com/pocket-id/pocket-id/backend/internal/httpserver"
|
|
"github.com/pocket-id/pocket-id/backend/internal/model"
|
|
)
|
|
|
|
type Dependencies struct {
|
|
DB *gorm.DB
|
|
Actors francishost.Host
|
|
StaticApiKey string
|
|
AppConfig appconfig.AppConfigResolver
|
|
EmailSender APIKeyExpiryEmailSender
|
|
CleanupDisabled bool
|
|
}
|
|
|
|
type Module struct {
|
|
service *Service
|
|
handler *handler
|
|
}
|
|
|
|
func New(ctx context.Context, deps Dependencies) (*Module, error) {
|
|
service, err := newService(ctx, deps.DB, deps.StaticApiKey)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
module := &Module{
|
|
service: service,
|
|
handler: newHandler(service),
|
|
}
|
|
|
|
// Register the cleanup job for expired API keys
|
|
if !deps.CleanupDisabled {
|
|
if deps.Actors == nil {
|
|
return nil, errors.New("actor host is required for the API key expiration cron job")
|
|
}
|
|
if deps.AppConfig == nil || deps.EmailSender == nil {
|
|
return nil, errors.New("notification dependencies are required for the API key expiration cron job")
|
|
}
|
|
|
|
expiryJob, err := newExpiryJob(service, deps.AppConfig, deps.EmailSender)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
err = deps.Actors.RegisterBuiltInActor(expiryJob)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("error registering API key expiration cron actor: %w", err)
|
|
}
|
|
}
|
|
|
|
return module, nil
|
|
}
|
|
|
|
// RegisterRoutes mounts the API key management endpoints
|
|
// authWithoutApiKey disables API key authentication so an API key cannot be used to mint or renew further API keys
|
|
func (m *Module) RegisterRoutes(apiGroup *gin.RouterGroup, auth, authWithoutApiKey gin.HandlerFunc) {
|
|
group := apiGroup.Group("/api-keys")
|
|
group.GET("", auth, httpserver.Handle(m.handler.list))
|
|
group.POST("", authWithoutApiKey, httpserver.Handle(m.handler.create))
|
|
group.POST("/:id/renew", authWithoutApiKey, httpserver.Handle(m.handler.renew))
|
|
group.DELETE("/:id", auth, httpserver.Handle(m.handler.revoke))
|
|
}
|
|
|
|
// ValidateApiKey resolves the user that owns the given raw API key
|
|
// It is used by the authentication middleware
|
|
func (m *Module) ValidateApiKey(ctx context.Context, apiKey string) (model.User, error) {
|
|
return m.service.ValidateApiKey(ctx, apiKey)
|
|
}
|