vikunja/pkg/routes/api/v2/oauth.go

112 lines
4.0 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 apiv2
import (
"context"
"net/http"
"code.vikunja.io/api/pkg/modules/auth/oauth2server"
"code.vikunja.io/api/pkg/user"
"github.com/danielgtaylor/huma/v2"
)
// oauthTokenBody wraps the OAuth 2.0 token response.
type oauthTokenBody struct {
// Cache-Control: no-store is required by RFC 6749 §5.1 so tokens are not
// cached. v2 already sets it globally, but declaring it keeps the contract
// explicit in the spec.
CacheControl string `header:"Cache-Control"`
Body *oauth2server.TokenResponse
}
// oauthAuthorizeBody wraps the OAuth 2.0 authorization response.
type oauthAuthorizeBody struct {
Body *oauth2server.AuthorizeResponse
}
func init() { AddRouteRegistrar(RegisterOAuthRoutes) }
// RegisterOAuthRoutes wires the OAuth 2.0 token and authorize endpoints. The
// token endpoint is public (it authenticates the request itself); authorize
// inherits the global JWT auth.
func RegisterOAuthRoutes(api huma.API) {
tags := []string{"auth"}
Register(api, huma.Operation{
OperationID: "oauth-token",
Summary: "OAuth 2.0 token endpoint",
Description: "Exchanges an authorization code (grant_type=authorization_code) or a refresh token (grant_type=refresh_token) for an access token. Accepts application/x-www-form-urlencoded per RFC 6749 as well as JSON.",
Method: http.MethodPost,
Path: "/oauth/token",
DefaultStatus: http.StatusOK,
Tags: tags,
Security: publicSecurity,
}, oauthToken)
Register(api, huma.Operation{
OperationID: "oauth-authorize",
Summary: "OAuth 2.0 authorize endpoint",
Description: "Creates a single-use authorization code for the authenticated user. PKCE (code_challenge with method S256) and a loopback or vikunja- scheme redirect_uri are required.",
Method: http.MethodPost,
Path: "/oauth/authorize",
DefaultStatus: http.StatusOK,
Tags: tags,
}, oauthAuthorize)
}
func oauthToken(ctx context.Context, in *struct {
Body oauth2server.TokenRequest `contentType:"application/x-www-form-urlencoded"`
}) (*oauthTokenBody, error) {
deviceInfo, ipAddress := requestClientInfo(ctx)
resp, err := oauth2server.ExchangeToken(ctx, &in.Body, deviceInfo, ipAddress)
if err != nil {
return nil, translateDomainError(err)
}
return &oauthTokenBody{CacheControl: "no-store", Body: resp}, nil
}
func oauthAuthorize(ctx context.Context, in *struct{ Body oauth2server.AuthorizeRequest }) (*oauthAuthorizeBody, error) {
a, err := authFromCtx(ctx)
if err != nil {
return nil, err
}
u, err := user.GetFromAuth(a)
if err != nil {
return nil, translateDomainError(err)
}
resp, err := oauth2server.Authorize(&in.Body, u.ID)
if err != nil {
return nil, translateDomainError(err)
}
return &oauthAuthorizeBody{Body: resp}, nil
}
// requestClientInfo pulls the user agent and client IP off the underlying Echo
// request so the authorization_code grant (and login) can record them on the
// session they create, mirroring v1. Both fall back to "" when the context is
// unavailable.
func requestClientInfo(ctx context.Context) (deviceInfo, ipAddress string) {
ec := echoContextFromCtx(ctx)
if ec == nil {
return "", ""
}
return (*ec).Request().UserAgent(), (*ec).RealIP()
}