woodpecker/server/api/global_secret.go
2024-02-11 18:42:33 +01:00

171 lines
5.2 KiB
Go

// Copyright 2022 Woodpecker Authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package api
import (
"net/http"
"github.com/gin-gonic/gin"
"go.woodpecker-ci.org/woodpecker/v2/server"
"go.woodpecker-ci.org/woodpecker/v2/server/model"
"go.woodpecker-ci.org/woodpecker/v2/server/router/middleware/session"
)
// GetGlobalSecretList
//
// @Summary Get the global secret list
// @Router /secrets [get]
// @Produce json
// @Success 200 {array} Secret
// @Tags Secrets
// @Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
// @Param page query int false "for response pagination, page offset number" default(1)
// @Param perPage query int false "for response pagination, max items per page" default(50)
func GetGlobalSecretList(c *gin.Context) {
secretService := server.Config.Services.Manager.SecretService()
list, err := secretService.GlobalSecretList(session.Pagination(c))
if err != nil {
c.String(http.StatusInternalServerError, "Error getting global secret list. %s", err)
return
}
// copy the secret detail to remove the sensitive
// password and token fields.
for i, secret := range list {
list[i] = secret.Copy()
}
c.JSON(http.StatusOK, list)
}
// GetGlobalSecret
//
// @Summary Get a global secret by name
// @Router /secrets/{secret} [get]
// @Produce json
// @Success 200 {object} Secret
// @Tags Secrets
// @Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
// @Param secret path string true "the secret's name"
func GetGlobalSecret(c *gin.Context) {
name := c.Param("secret")
secretService := server.Config.Services.Manager.SecretService()
secret, err := secretService.GlobalSecretFind(name)
if err != nil {
handleDBError(c, err)
return
}
c.JSON(http.StatusOK, secret.Copy())
}
// PostGlobalSecret
//
// @Summary Persist/create a global secret
// @Router /secrets [post]
// @Produce json
// @Success 200 {object} Secret
// @Tags Secrets
// @Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
// @Param secret body Secret true "the secret object data"
func PostGlobalSecret(c *gin.Context) {
in := new(model.Secret)
if err := c.Bind(in); err != nil {
c.String(http.StatusBadRequest, "Error parsing global secret. %s", err)
return
}
secret := &model.Secret{
Name: in.Name,
Value: in.Value,
Events: in.Events,
Images: in.Images,
}
if err := secret.Validate(); err != nil {
c.String(http.StatusBadRequest, "Error inserting global secret. %s", err)
return
}
secretService := server.Config.Services.Manager.SecretService()
if err := secretService.GlobalSecretCreate(secret); err != nil {
c.String(http.StatusInternalServerError, "Error inserting global secret %q. %s", in.Name, err)
return
}
c.JSON(http.StatusOK, secret.Copy())
}
// PatchGlobalSecret
//
// @Summary Update a global secret by name
// @Router /secrets/{secret} [patch]
// @Produce json
// @Success 200 {object} Secret
// @Tags Secrets
// @Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
// @Param secret path string true "the secret's name"
// @Param secretData body Secret true "the secret's data"
func PatchGlobalSecret(c *gin.Context) {
name := c.Param("secret")
in := new(model.Secret)
err := c.Bind(in)
if err != nil {
c.String(http.StatusBadRequest, "Error parsing secret. %s", err)
return
}
secretService := server.Config.Services.Manager.SecretService()
secret, err := secretService.GlobalSecretFind(name)
if err != nil {
handleDBError(c, err)
return
}
if in.Value != "" {
secret.Value = in.Value
}
if in.Events != nil {
secret.Events = in.Events
}
if in.Images != nil {
secret.Images = in.Images
}
if err := secret.Validate(); err != nil {
c.String(http.StatusBadRequest, "Error updating global secret. %s", err)
return
}
if err := secretService.GlobalSecretUpdate(secret); err != nil {
c.String(http.StatusInternalServerError, "Error updating global secret %q. %s", in.Name, err)
return
}
c.JSON(http.StatusOK, secret.Copy())
}
// DeleteGlobalSecret
//
// @Summary Delete a global secret by name
// @Router /secrets/{secret} [delete]
// @Produce plain
// @Success 204
// @Tags Secrets
// @Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
// @Param secret path string true "the secret's name"
func DeleteGlobalSecret(c *gin.Context) {
name := c.Param("secret")
secretService := server.Config.Services.Manager.SecretService()
if err := secretService.GlobalSecretDelete(name); err != nil {
handleDBError(c, err)
return
}
c.Status(http.StatusNoContent)
}