vikunja/pkg/routes/api_tokens.go

95 lines
3.3 KiB
Go

// Vikunja is a to-do list application to facilitate your life.
// Copyright 2018-present Vikunja and contributors. All rights reserved.
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program. If not, see <https://www.gnu.org/licenses/>.
package routes
import (
"net/http"
"strings"
"code.vikunja.io/api/pkg/config"
"code.vikunja.io/api/pkg/log"
"code.vikunja.io/api/pkg/models"
"code.vikunja.io/api/pkg/modules/auth"
"code.vikunja.io/api/pkg/web"
echojwt "github.com/labstack/echo-jwt/v5"
"github.com/labstack/echo/v5"
)
// ErrCodeInvalidToken is the error code returned when the JWT is missing,
// malformed, or expired. The frontend uses this to distinguish "token expired,
// try refreshing" from other 401s (disabled account, wrong API token, etc.).
const ErrCodeInvalidToken = 11
func SetupTokenMiddleware() echo.MiddlewareFunc {
return echojwt.WithConfig(echojwt.Config{
SigningKey: []byte(config.ServiceSecret.GetString()),
Skipper: func(c *echo.Context) bool {
authHeader := c.Request().Header.Values("Authorization")
if len(authHeader) == 0 {
return false // let the jwt middleware handle invalid headers
}
for _, s := range authHeader {
if strings.HasPrefix(s, "Bearer "+models.APITokenPrefix) {
path := c.Request().URL.Path
// The MCP endpoint uses POST, GET, and DELETE on the same path
// (streamable-HTTP transport). CanDoAPIRoute does an exact
// (method, path) match per permission, so we skip it here
// and gate inside the MCP handler via token.HasMCPAccess().
skipRouteCheck := path == "/api/v1/token/test" ||
path == "/api/v1/mcp" ||
strings.HasPrefix(path, "/api/v1/mcp/")
err := checkAPITokenAndPutItInContext(s, c, skipRouteCheck)
return err == nil
}
}
return false
},
ErrorHandler: func(c *echo.Context, err error) error {
if err != nil {
return c.JSON(http.StatusUnauthorized, web.HTTPError{
HTTPCode: http.StatusUnauthorized,
Code: ErrCodeInvalidToken,
Message: "missing, malformed, expired or otherwise invalid token provided",
})
}
return nil
},
})
}
func checkAPITokenAndPutItInContext(tokenHeaderValue string, c *echo.Context, skipRouteCheck bool) error {
token, u, err := auth.ValidateAPITokenString(strings.TrimPrefix(tokenHeaderValue, "Bearer "))
if err != nil {
log.Debugf("[auth] API token validation failed: %v", err)
return echo.NewHTTPError(http.StatusUnauthorized, "Unauthorized")
}
if !skipRouteCheck && !models.CanDoAPIRoute(c, token) {
log.Debugf("[auth] Tried authenticating with token %d but it does not have permission to do this route", token.ID)
return echo.NewHTTPError(http.StatusUnauthorized, "Unauthorized")
}
c.Set("api_token", token)
c.Set("api_user", u)
return nil
}