24904585a2
Fix user tests Add swagger docs Fix lint Add totp check when logging in Make totp enrollment work Add migration for totp table go mod vendor Add routes for totp routes Add route handler for totp routes Add basic implementation to enroll a user in totp Co-authored-by: kolaente <k@knt.li> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/383
124 lines
4.2 KiB
Go
124 lines
4.2 KiB
Go
// Vikunja is a to-do list application to facilitate your life.
|
|
// Copyright 2018-2020 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 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 General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU General Public License
|
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
|
|
|
package v1
|
|
|
|
import (
|
|
"bytes"
|
|
"code.vikunja.io/api/pkg/log"
|
|
"code.vikunja.io/api/pkg/models"
|
|
"code.vikunja.io/api/pkg/user"
|
|
"code.vikunja.io/web/handler"
|
|
"fmt"
|
|
"github.com/labstack/echo/v4"
|
|
"image/jpeg"
|
|
"net/http"
|
|
)
|
|
|
|
// UserTOTPEnroll is the handler to enroll a user into totp
|
|
// @Summary Enroll a user into totp
|
|
// @Description Creates an initial setup for the user in the db. After this step, the user needs to verify they have a working totp setup with the "enable totp" endpoint.
|
|
// @tags user
|
|
// @Accept json
|
|
// @Produce json
|
|
// @Security JWTKeyAuth
|
|
// @Success 200 {object} user.TOTP
|
|
// @Failure 400 {object} code.vikunja.io/web.HTTPError "Something's invalid."
|
|
// @Failure 404 {object} code.vikunja.io/web.HTTPError "User does not exist."
|
|
// @Failure 500 {object} models.Message "Internal server error."
|
|
// @Router /user/settings/totp/enroll [post]
|
|
func UserTOTPEnroll(c echo.Context) error {
|
|
u, err := user.GetCurrentUser(c)
|
|
if err != nil {
|
|
return handler.HandleHTTPError(err, c)
|
|
}
|
|
|
|
t, err := user.EnrollTOTP(u)
|
|
if err != nil {
|
|
return handler.HandleHTTPError(err, c)
|
|
}
|
|
|
|
return c.JSON(http.StatusOK, t)
|
|
}
|
|
|
|
// UserTOTPEnable is the handler to enable totp for a user
|
|
// @Summary Enable a previously enrolled totp setting.
|
|
// @Description Enables a previously enrolled totp setting by providing a totp passcode.
|
|
// @tags user
|
|
// @Accept json
|
|
// @Produce json
|
|
// @Param totp body user.TOTPPasscode true "The totp passcode."
|
|
// @Security JWTKeyAuth
|
|
// @Success 200 {object} models.Message "Successfully enabled"
|
|
// @Failure 400 {object} code.vikunja.io/web.HTTPError "Something's invalid."
|
|
// @Failure 404 {object} code.vikunja.io/web.HTTPError "User does not exist."
|
|
// @Failure 412 {object} code.vikunja.io/web.HTTPError "TOTP is not enrolled."
|
|
// @Failure 500 {object} models.Message "Internal server error."
|
|
// @Router /user/settings/totp/enable [post]
|
|
func UserTOTPEnable(c echo.Context) error {
|
|
u, err := user.GetCurrentUser(c)
|
|
if err != nil {
|
|
return handler.HandleHTTPError(err, c)
|
|
}
|
|
|
|
passcode := &user.TOTPPasscode{
|
|
User: u,
|
|
}
|
|
if err := c.Bind(passcode); err != nil {
|
|
log.Debugf("Invalid model error. Internal error was: %s", err.Error())
|
|
if he, is := err.(*echo.HTTPError); is {
|
|
return echo.NewHTTPError(http.StatusBadRequest, fmt.Sprintf("Invalid model provided. Error was: %s", he.Message))
|
|
}
|
|
return echo.NewHTTPError(http.StatusBadRequest, fmt.Sprintf("Invalid model provided."))
|
|
}
|
|
|
|
err = user.EnableTOTP(passcode)
|
|
if err != nil {
|
|
return handler.HandleHTTPError(err, c)
|
|
}
|
|
|
|
return c.JSON(http.StatusOK, models.Message{Message: "TOTP was enabled successfully."})
|
|
}
|
|
|
|
// UserTOTPQrCode is the handler to show a qr code to enroll the user into totp
|
|
// @Summary Totp QR Code
|
|
// @Description Returns a qr code for easier setup at end user's devices.
|
|
// @tags user
|
|
// @Accept json
|
|
// @Produce json
|
|
// @Security JWTKeyAuth
|
|
// @Success 200 {} string "The qr code as jpeg image"
|
|
// @Failure 500 {object} models.Message "Internal server error."
|
|
// @Router /user/settings/totp/qrcode [get]
|
|
func UserTOTPQrCode(c echo.Context) error {
|
|
u, err := user.GetCurrentUser(c)
|
|
if err != nil {
|
|
return handler.HandleHTTPError(err, c)
|
|
}
|
|
|
|
qrcode, err := user.GetTOTPQrCodeForUser(u)
|
|
if err != nil {
|
|
return handler.HandleHTTPError(err, c)
|
|
}
|
|
|
|
buff := &bytes.Buffer{}
|
|
err = jpeg.Encode(buff, qrcode, nil)
|
|
if err != nil {
|
|
return handler.HandleHTTPError(err, c)
|
|
}
|
|
|
|
return c.Blob(http.StatusOK, "image/jpeg", buff.Bytes())
|
|
}
|