123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285 |
- // Copyright 2017 The Gitea Authors. All rights reserved.
- // Use of this source code is governed by a MIT-style
- // license that can be found in the LICENSE file.
-
- package user
-
- import (
- "fmt"
- "net/http"
-
- "code.gitea.io/gitea/models"
- "code.gitea.io/gitea/modules/context"
- "code.gitea.io/gitea/modules/convert"
- api "code.gitea.io/gitea/modules/structs"
- "code.gitea.io/gitea/modules/web"
- "code.gitea.io/gitea/routers/api/v1/utils"
- )
-
- func listGPGKeys(ctx *context.APIContext, uid int64, listOptions models.ListOptions) {
- keys, err := models.ListGPGKeys(uid, listOptions)
- if err != nil {
- ctx.Error(http.StatusInternalServerError, "ListGPGKeys", err)
- return
- }
-
- apiKeys := make([]*api.GPGKey, len(keys))
- for i := range keys {
- apiKeys[i] = convert.ToGPGKey(keys[i])
- }
-
- total, err := models.CountUserGPGKeys(uid)
- if err != nil {
- ctx.InternalServerError(err)
- return
- }
-
- ctx.SetTotalCountHeader(total)
- ctx.JSON(http.StatusOK, &apiKeys)
- }
-
- //ListGPGKeys get the GPG key list of a user
- func ListGPGKeys(ctx *context.APIContext) {
- // swagger:operation GET /users/{username}/gpg_keys user userListGPGKeys
- // ---
- // summary: List the given user's GPG keys
- // produces:
- // - application/json
- // parameters:
- // - name: username
- // in: path
- // description: username of user
- // type: string
- // required: true
- // - name: page
- // in: query
- // description: page number of results to return (1-based)
- // type: integer
- // - name: limit
- // in: query
- // description: page size of results
- // type: integer
- // responses:
- // "200":
- // "$ref": "#/responses/GPGKeyList"
-
- user := GetUserByParams(ctx)
- if ctx.Written() {
- return
- }
- listGPGKeys(ctx, user.ID, utils.GetListOptions(ctx))
- }
-
- //ListMyGPGKeys get the GPG key list of the authenticated user
- func ListMyGPGKeys(ctx *context.APIContext) {
- // swagger:operation GET /user/gpg_keys user userCurrentListGPGKeys
- // ---
- // summary: List the authenticated user's GPG keys
- // parameters:
- // - name: page
- // in: query
- // description: page number of results to return (1-based)
- // type: integer
- // - name: limit
- // in: query
- // description: page size of results
- // type: integer
- // produces:
- // - application/json
- // responses:
- // "200":
- // "$ref": "#/responses/GPGKeyList"
-
- listGPGKeys(ctx, ctx.User.ID, utils.GetListOptions(ctx))
- }
-
- //GetGPGKey get the GPG key based on a id
- func GetGPGKey(ctx *context.APIContext) {
- // swagger:operation GET /user/gpg_keys/{id} user userCurrentGetGPGKey
- // ---
- // summary: Get a GPG key
- // produces:
- // - application/json
- // parameters:
- // - name: id
- // in: path
- // description: id of key to get
- // type: integer
- // format: int64
- // required: true
- // responses:
- // "200":
- // "$ref": "#/responses/GPGKey"
- // "404":
- // "$ref": "#/responses/notFound"
-
- key, err := models.GetGPGKeyByID(ctx.ParamsInt64(":id"))
- if err != nil {
- if models.IsErrGPGKeyNotExist(err) {
- ctx.NotFound()
- } else {
- ctx.Error(http.StatusInternalServerError, "GetGPGKeyByID", err)
- }
- return
- }
- ctx.JSON(http.StatusOK, convert.ToGPGKey(key))
- }
-
- // CreateUserGPGKey creates new GPG key to given user by ID.
- func CreateUserGPGKey(ctx *context.APIContext, form api.CreateGPGKeyOption, uid int64) {
- token := models.VerificationToken(ctx.User, 1)
- lastToken := models.VerificationToken(ctx.User, 0)
-
- keys, err := models.AddGPGKey(uid, form.ArmoredKey, token, form.Signature)
- if err != nil && models.IsErrGPGInvalidTokenSignature(err) {
- keys, err = models.AddGPGKey(uid, form.ArmoredKey, lastToken, form.Signature)
- }
- if err != nil {
- HandleAddGPGKeyError(ctx, err, token)
- return
- }
- ctx.JSON(http.StatusCreated, convert.ToGPGKey(keys[0]))
- }
-
- // GetVerificationToken returns the current token to be signed for this user
- func GetVerificationToken(ctx *context.APIContext) {
- // swagger:operation GET /user/gpg_key_token user getVerificationToken
- // ---
- // summary: Get a Token to verify
- // produces:
- // - text/plain
- // parameters:
- // responses:
- // "200":
- // "$ref": "#/responses/string"
- // "404":
- // "$ref": "#/responses/notFound"
-
- token := models.VerificationToken(ctx.User, 1)
- ctx.PlainText(http.StatusOK, []byte(token))
- }
-
- // VerifyUserGPGKey creates new GPG key to given user by ID.
- func VerifyUserGPGKey(ctx *context.APIContext) {
- // swagger:operation POST /user/gpg_key_verify user userVerifyGPGKey
- // ---
- // summary: Verify a GPG key
- // consumes:
- // - application/json
- // produces:
- // - application/json
- // responses:
- // "201":
- // "$ref": "#/responses/GPGKey"
- // "404":
- // "$ref": "#/responses/notFound"
- // "422":
- // "$ref": "#/responses/validationError"
-
- form := web.GetForm(ctx).(*api.VerifyGPGKeyOption)
- token := models.VerificationToken(ctx.User, 1)
- lastToken := models.VerificationToken(ctx.User, 0)
-
- _, err := models.VerifyGPGKey(ctx.User.ID, form.KeyID, token, form.Signature)
- if err != nil && models.IsErrGPGInvalidTokenSignature(err) {
- _, err = models.VerifyGPGKey(ctx.User.ID, form.KeyID, lastToken, form.Signature)
- }
-
- if err != nil {
- if models.IsErrGPGInvalidTokenSignature(err) {
- ctx.Error(http.StatusUnprocessableEntity, "GPGInvalidSignature", fmt.Sprintf("The provided GPG key, signature and token do not match or token is out of date. Provide a valid signature for the token: %s", token))
- return
- }
- ctx.Error(http.StatusInternalServerError, "VerifyUserGPGKey", err)
- }
-
- key, err := models.GetGPGKeysByKeyID(form.KeyID)
- if err != nil {
- if models.IsErrGPGKeyNotExist(err) {
- ctx.NotFound()
- } else {
- ctx.Error(http.StatusInternalServerError, "GetGPGKeysByKeyID", err)
- }
- return
- }
- ctx.JSON(http.StatusOK, convert.ToGPGKey(key[0]))
- }
-
- // swagger:parameters userCurrentPostGPGKey
- type swaggerUserCurrentPostGPGKey struct {
- // in:body
- Form api.CreateGPGKeyOption
- }
-
- //CreateGPGKey create a GPG key belonging to the authenticated user
- func CreateGPGKey(ctx *context.APIContext) {
- // swagger:operation POST /user/gpg_keys user userCurrentPostGPGKey
- // ---
- // summary: Create a GPG key
- // consumes:
- // - application/json
- // produces:
- // - application/json
- // responses:
- // "201":
- // "$ref": "#/responses/GPGKey"
- // "404":
- // "$ref": "#/responses/notFound"
- // "422":
- // "$ref": "#/responses/validationError"
-
- form := web.GetForm(ctx).(*api.CreateGPGKeyOption)
- CreateUserGPGKey(ctx, *form, ctx.User.ID)
- }
-
- //DeleteGPGKey remove a GPG key belonging to the authenticated user
- func DeleteGPGKey(ctx *context.APIContext) {
- // swagger:operation DELETE /user/gpg_keys/{id} user userCurrentDeleteGPGKey
- // ---
- // summary: Remove a GPG key
- // produces:
- // - application/json
- // parameters:
- // - name: id
- // in: path
- // description: id of key to delete
- // type: integer
- // format: int64
- // required: true
- // responses:
- // "204":
- // "$ref": "#/responses/empty"
- // "403":
- // "$ref": "#/responses/forbidden"
- // "404":
- // "$ref": "#/responses/notFound"
-
- if err := models.DeleteGPGKey(ctx.User, ctx.ParamsInt64(":id")); err != nil {
- if models.IsErrGPGKeyAccessDenied(err) {
- ctx.Error(http.StatusForbidden, "", "You do not have access to this key")
- } else {
- ctx.Error(http.StatusInternalServerError, "DeleteGPGKey", err)
- }
- return
- }
-
- ctx.Status(http.StatusNoContent)
- }
-
- // HandleAddGPGKeyError handle add GPGKey error
- func HandleAddGPGKeyError(ctx *context.APIContext, err error, token string) {
- switch {
- case models.IsErrGPGKeyAccessDenied(err):
- ctx.Error(http.StatusUnprocessableEntity, "GPGKeyAccessDenied", "You do not have access to this GPG key")
- case models.IsErrGPGKeyIDAlreadyUsed(err):
- ctx.Error(http.StatusUnprocessableEntity, "GPGKeyIDAlreadyUsed", "A key with the same id already exists")
- case models.IsErrGPGKeyParsing(err):
- ctx.Error(http.StatusUnprocessableEntity, "GPGKeyParsing", err)
- case models.IsErrGPGNoEmailFound(err):
- ctx.Error(http.StatusNotFound, "GPGNoEmailFound", fmt.Sprintf("None of the emails attached to the GPG key could be found. It may still be added if you provide a valid signature for the token: %s", token))
- case models.IsErrGPGInvalidTokenSignature(err):
- ctx.Error(http.StatusUnprocessableEntity, "GPGInvalidSignature", fmt.Sprintf("The provided GPG key, signature and token do not match or token is out of date. Provide a valid signature for the token: %s", token))
- default:
- ctx.Error(http.StatusInternalServerError, "AddGPGKey", err)
- }
- }
|