// Copyright 2015 The Gogs Authors. All rights reserved. // Copyright 2020 The Gitea Authors. // SPDX-License-Identifier: MIT package repo import ( stdCtx "context" "fmt" "net/http" asymkey_model "gitea.dev/models/asymkey" "gitea.dev/models/db" deploykey_model "gitea.dev/models/deploykey" "gitea.dev/models/perm" access_model "gitea.dev/models/perm/access" repo_model "gitea.dev/models/repo" api "gitea.dev/modules/structs" "gitea.dev/modules/util" "gitea.dev/modules/web" "gitea.dev/routers/api/v1/utils" asymkey_service "gitea.dev/services/asymkey" "gitea.dev/services/context" "gitea.dev/services/convert" ) // appendPrivateInformation appends the owner and key type information to api.PublicKey func appendPrivateInformation(ctx stdCtx.Context, apiKey *api.DeployKey, key *deploykey_model.DeployKey, repository *repo_model.Repository) (*api.DeployKey, error) { apiKey.ReadOnly = key.Mode == perm.AccessModeRead if repository.ID == key.RepoID { apiKey.Repository = convert.ToRepo(ctx, repository, access_model.Permission{AccessMode: key.Mode}) } else { repo, err := repo_model.GetRepositoryByID(ctx, key.RepoID) if err != nil { return apiKey, err } apiKey.Repository = convert.ToRepo(ctx, repo, access_model.Permission{AccessMode: key.Mode}) } return apiKey, nil } // ListDeployKeys list all the deploy keys of a repository func ListDeployKeys(ctx *context.APIContext) { // swagger:operation GET /repos/{owner}/{repo}/keys repository repoListKeys // --- // summary: List a repository's keys // produces: // - application/json // parameters: // - name: owner // in: path // description: owner of the repo // type: string // required: true // - name: repo // in: path // description: name of the repo // type: string // required: true // - name: key_id // in: query // description: the key_id to search for // type: integer // - name: fingerprint // in: query // description: fingerprint of the key // type: string // - 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/DeployKeyList" // "404": // "$ref": "#/responses/notFound" opts := deploykey_model.ListDeployKeysOptions{ ListOptions: utils.GetListOptions(ctx), RepoID: ctx.Repo.Repository.ID, KeyID: ctx.FormInt64("key_id"), Fingerprint: ctx.FormString("fingerprint"), } keys, count, err := db.FindAndCount[deploykey_model.DeployKey](ctx, opts) if err != nil { ctx.APIErrorInternal(err) return } apiDeployKeys := make([]*api.DeployKey, len(keys)) for i := range keys { apiDeployKeys[i] = convert.ToDeployKey(ctx, ctx.Repo.Repository, keys[i]) if ctx.Doer.IsAdmin || ((ctx.Repo.Repository.ID == keys[i].RepoID) && (ctx.Doer.ID == ctx.Repo.Owner.ID)) { apiDeployKeys[i], _ = appendPrivateInformation(ctx, apiDeployKeys[i], keys[i], ctx.Repo.Repository) } } ctx.SetTotalCountHeader(count) ctx.JSON(http.StatusOK, &apiDeployKeys) } // GetDeployKey get a deploy key by id func GetDeployKey(ctx *context.APIContext) { // swagger:operation GET /repos/{owner}/{repo}/keys/{id} repository repoGetKey // --- // summary: Get a repository's key by id // produces: // - application/json // parameters: // - name: owner // in: path // description: owner of the repo // type: string // required: true // - name: repo // in: path // description: name of the repo // type: string // required: true // - name: id // in: path // description: id of the key to get // type: integer // format: int64 // required: true // responses: // "200": // "$ref": "#/responses/DeployKey" // "404": // "$ref": "#/responses/notFound" key, err := deploykey_model.GetDeployKeyByID(ctx, ctx.Repo.Repository.ID, ctx.PathParamInt64("id")) if err != nil { ctx.APIErrorAuto(err) return } apiDeployKey := convert.ToDeployKey(ctx, ctx.Repo.Repository, key) if ctx.Doer.IsAdmin || ((ctx.Repo.Repository.ID == key.RepoID) && (ctx.Doer.ID == ctx.Repo.Owner.ID)) { apiDeployKey, _ = appendPrivateInformation(ctx, apiDeployKey, key, ctx.Repo.Repository) } ctx.JSON(http.StatusOK, apiDeployKey) } // HandleCheckKeyStringError handle check key error func HandleCheckKeyStringError(ctx *context.APIContext, err error) { if db.IsErrSSHDisabled(err) { ctx.APIError(http.StatusUnprocessableEntity, "SSH is disabled") } else if asymkey_model.IsErrKeyUnableVerify(err) { ctx.APIError(http.StatusUnprocessableEntity, "Unable to verify key content") } else { ctx.APIError(http.StatusUnprocessableEntity, fmt.Sprintf("Invalid key content: %v", err)) } } // HandleAddKeyError handle add key error func HandleAddKeyError(ctx *context.APIContext, err error) { switch { case deploykey_model.IsErrDeployKeyAlreadyExist(err): ctx.APIError(http.StatusUnprocessableEntity, "This key has already been added to this repository") case asymkey_model.IsErrKeyAlreadyExist(err): ctx.APIError(http.StatusUnprocessableEntity, "Key content has been used as non-deploy key") case asymkey_model.IsErrKeyNameAlreadyUsed(err): ctx.APIError(http.StatusUnprocessableEntity, "Key title has been used") case deploykey_model.IsErrDeployKeyNameAlreadyUsed(err): ctx.APIError(http.StatusUnprocessableEntity, "A key with the same name already exists") default: ctx.APIErrorInternal(err) } } // CreateDeployKey create deploy key for a repository func CreateDeployKey(ctx *context.APIContext) { // swagger:operation POST /repos/{owner}/{repo}/keys repository repoCreateKey // --- // summary: Add a key to a repository // consumes: // - application/json // produces: // - application/json // parameters: // - name: owner // in: path // description: owner of the repo // type: string // required: true // - name: repo // in: path // description: name of the repo // type: string // required: true // - name: body // in: body // schema: // "$ref": "#/definitions/CreateKeyOption" // responses: // "201": // "$ref": "#/responses/DeployKey" // "404": // "$ref": "#/responses/notFound" // "422": // "$ref": "#/responses/validationError" form := web.GetForm[*api.CreateKeyOption](ctx) content, err := asymkey_model.CheckPublicKeyString(form.Key) if err != nil { HandleCheckKeyStringError(ctx, err) return } accessMode := util.Iif(form.ReadOnly, perm.AccessModeRead, perm.AccessModeWrite) key, err := deploykey_model.AddDeployKeySSH(ctx, ctx.Repo.Repository.ID, form.Title, content, accessMode) if err != nil { HandleAddKeyError(ctx, err) return } ctx.JSON(http.StatusCreated, convert.ToDeployKey(ctx, ctx.Repo.Repository, key)) } // CreateDeployToken create a deploy token for a repository func CreateDeployToken(ctx *context.APIContext) { // swagger:operation POST /repos/{owner}/{repo}/keys/tokens repository repoCreateDeployToken // --- // summary: Add a deploy token to a repository, it authenticates git over HTTPS // consumes: // - application/json // produces: // - application/json // parameters: // - name: owner // in: path // description: owner of the repo // type: string // required: true // - name: repo // in: path // description: name of the repo // type: string // required: true // - name: body // in: body // schema: // "$ref": "#/definitions/CreateDeployKeyTokenOption" // responses: // "201": // "$ref": "#/responses/DeployKey" // "404": // "$ref": "#/responses/notFound" // "422": // "$ref": "#/responses/validationError" form := web.GetForm[*api.CreateDeployKeyTokenOption](ctx) accessMode := util.Iif(form.ReadOnly, perm.AccessModeRead, perm.AccessModeWrite) key, err := deploykey_model.AddDeployKeyToken(ctx, ctx.Repo.Repository.ID, form.Title, accessMode) if err != nil { HandleAddKeyError(ctx, err) return } ctx.JSON(http.StatusCreated, convert.ToDeployKey(ctx, ctx.Repo.Repository, key)) } // DeleteDeployKey delete deploy key for a repository func DeleteDeployKey(ctx *context.APIContext) { // swagger:operation DELETE /repos/{owner}/{repo}/keys/{id} repository repoDeleteKey // --- // summary: Delete a key from a repository // parameters: // - name: owner // in: path // description: owner of the repo // type: string // required: true // - name: repo // in: path // description: name of the repo // type: string // required: true // - name: id // in: path // description: id of the key to delete // type: integer // format: int64 // required: true // responses: // "204": // "$ref": "#/responses/empty" // "403": // "$ref": "#/responses/forbidden" // "404": // "$ref": "#/responses/notFound" // a key that is already gone still leaves the caller with the state it asked for if _, err := asymkey_service.DeleteDeployKey(ctx, ctx.Repo.Repository, ctx.PathParamInt64("id")); err != nil && !deploykey_model.IsErrDeployKeyNotExist(err) { if asymkey_model.IsErrKeyAccessDenied(err) { ctx.APIError(http.StatusForbidden, "You do not have access to this key") } else { ctx.APIErrorInternal(err) } return } ctx.Status(http.StatusNoContent) }