portainer/portainer

package stacks

import (
    "net/http"
    "time"

    portainer "github.com/portainer/portainer/api"
    gittypes "github.com/portainer/portainer/api/git/types"
    "github.com/portainer/portainer/api/git/update"
    httperrors "github.com/portainer/portainer/api/http/errors"
    "github.com/portainer/portainer/api/http/security"
    "github.com/portainer/portainer/api/stacks/deployments"
    "github.com/portainer/portainer/api/stacks/stackutils"
    httperror "github.com/portainer/portainer/pkg/libhttp/error"
    "github.com/portainer/portainer/pkg/libhttp/request"
    "github.com/portainer/portainer/pkg/libhttp/response"

    "github.com/pkg/errors"
)

type stackGitUpdatePayload struct {
    AutoUpdate               *portainer.AutoUpdateSettings
    Env                      []portainer.Pair
    Prune                    bool
    RepositoryReferenceName  string
    RepositoryAuthentication bool
    RepositoryUsername       string
    RepositoryPassword       string
    TLSSkipVerify            bool
}

func (payload *stackGitUpdatePayload) Validate(r *http.Request) error {
    if err := update.ValidateAutoUpdateSettings(payload.AutoUpdate); err != nil {
        return err
    }
    return nil
}

// @id StackUpdateGit
// @summary Update a stack's Git configs
// @description Update the Git settings in a stack, e.g., RepositoryReferenceName and AutoUpdate
// @description **Access policy**: authenticated
// @tags stacks
// @security ApiKeyAuth
// @security jwt
// @accept json
// @produce json
// @param id path int true "Stack identifier"
// @param endpointId query int false "Stacks created before version 1.18.0 might not have an associated environment(endpoint) identifier. Use this optional parameter to set the environment(endpoint) identifier used by the stack."
// @param body body stackGitUpdatePayload true "Git configs for pull and redeploy a stack"
// @success 200 {object} portainer.Stack "Success"
// @failure 400 "Invalid request"
// @failure 403 "Permission denied"
// @failure 404 "Not found"
// @failure 500 "Server error"
// @router /stacks/{id}/git [post]
func (handler *Handler) stackUpdateGit(w http.ResponseWriter, r *http.Request) *httperror.HandlerError {
    stackID, err := request.RetrieveNumericRouteVariableValue(r, "id")
    if err != nil {
        return httperror.BadRequest("Invalid stack identifier route variable", err)
    }

    var payload stackGitUpdatePayload
    err = request.DecodeAndValidateJSONPayload(r, &payload)
    if err != nil {
        return httperror.BadRequest("Invalid request payload", err)
    }

    stack, err := handler.DataStore.Stack().Read(portainer.StackID(stackID))
    if handler.DataStore.IsErrObjectNotFound(err) {
        return httperror.NotFound("Unable to find a stack with the specified identifier inside the database", err)
    } else if err != nil {
        return httperror.InternalServerError("Unable to find a stack with the specified identifier inside the database", err)
    } else if stack.GitConfig == nil {
        msg := "No Git config in the found stack"
        return httperror.InternalServerError(msg, errors.New(msg))
    }

    // TODO: this is a work-around for stacks created with Portainer version >= 1.17.1
    // The EndpointID property is not available for these stacks, this API environment(endpoint)
    // can use the optional EndpointID query parameter to associate a valid environment(endpoint) identifier to the stack.
    endpointID, err := request.RetrieveNumericQueryParameter(r, "endpointId", true)
    if err != nil {
        return httperror.BadRequest("Invalid query parameter: endpointId", err)
    }
    if endpointID != int(stack.EndpointID) {
        stack.EndpointID = portainer.EndpointID(endpointID)
    }

    endpoint, err := handler.DataStore.Endpoint().Endpoint(stack.EndpointID)
    if handler.DataStore.IsErrObjectNotFound(err) {
        return httperror.NotFound("Unable to find the environment associated to the stack inside the database", err)
    } else if err != nil {
        return httperror.InternalServerError("Unable to find the environment associated to the stack inside the database", err)
    }

    err = handler.requestBouncer.AuthorizedEndpointOperation(r, endpoint)
    if err != nil {
        return httperror.Forbidden("Permission denied to access environment", err)
    }

    securityContext, err := security.RetrieveRestrictedRequestContext(r)
    if err != nil {
        return httperror.InternalServerError("Unable to retrieve info from request context", err)
    }

    user, err := handler.DataStore.User().Read(securityContext.UserID)
    if err != nil {
        return httperror.BadRequest("Cannot find context user", errors.Wrap(err, "failed to fetch the user"))
    }

    if stack.Type == portainer.DockerSwarmStack || stack.Type == portainer.DockerComposeStack {
        resourceControl, err := handler.DataStore.ResourceControl().ResourceControlByResourceIDAndType(stackutils.ResourceControlID(stack.EndpointID, stack.Name), portainer.StackResourceControl)
        if err != nil {
            return httperror.InternalServerError("Unable to retrieve a resource control associated to the stack", err)
        }

        access, err := handler.userCanAccessStack(securityContext, endpoint.ID, resourceControl)
        if err != nil {
            return httperror.InternalServerError("Unable to verify user authorizations to validate stack access", err)
        }
        if !access {
            return httperror.Forbidden("Access denied to resource", httperrors.ErrResourceAccessDenied)
        }
    }

    canManage, err := handler.userCanManageStacks(securityContext, endpoint)
    if err != nil {
        return httperror.InternalServerError("Unable to verify user authorizations to validate stack deletion", err)
    }
    if !canManage {
        errMsg := "Stack editing is disabled for non-admin users"
        return httperror.Forbidden(errMsg, errors.New(errMsg))
    }

    //stop the autoupdate job if there is any
    if stack.AutoUpdate != nil {
        deployments.StopAutoupdate(stack.ID, stack.AutoUpdate.JobID, handler.Scheduler)
    }

    //update retrieved stack data based on the payload
    stack.GitConfig.ReferenceName = payload.RepositoryReferenceName
    stack.GitConfig.TLSSkipVerify = payload.TLSSkipVerify
    stack.AutoUpdate = payload.AutoUpdate
    stack.Env = payload.Env
    stack.UpdatedBy = user.Username
    stack.UpdateDate = time.Now().Unix()

    if stack.Type == portainer.DockerSwarmStack {
        stack.Option = &portainer.StackOption{
            Prune: payload.Prune,
        }
    }

    if payload.RepositoryAuthentication {
        password := payload.RepositoryPassword

        // When the existing stack is using the custom username/password and the password is not updated,
        // the stack should keep using the saved username/password
        if password == "" && stack.GitConfig != nil && stack.GitConfig.Authentication != nil {
            password = stack.GitConfig.Authentication.Password
        }
        stack.GitConfig.Authentication = &gittypes.GitAuthentication{
            Username: payload.RepositoryUsername,
            Password: password,
        }
        _, err = handler.GitService.LatestCommitID(stack.GitConfig.URL, stack.GitConfig.ReferenceName, stack.GitConfig.Authentication.Username, stack.GitConfig.Authentication.Password, stack.GitConfig.TLSSkipVerify)
        if err != nil {
            return httperror.InternalServerError("Unable to fetch git repository", err)
        }
    } else {
        stack.GitConfig.Authentication = nil
    }

    if payload.AutoUpdate != nil && payload.AutoUpdate.Interval != "" {
        jobID, e := deployments.StartAutoupdate(stack.ID, stack.AutoUpdate.Interval, handler.Scheduler, handler.StackDeployer, handler.DataStore, handler.GitService)
        if e != nil {
            return e
        }

        stack.AutoUpdate.JobID = jobID
    }

    //save the updated stack to DB
    err = handler.DataStore.Stack().Update(stack.ID, stack)
    if err != nil {
        return httperror.InternalServerError("Unable to persist the stack changes inside the database", err)
    }

    if stack.GitConfig != nil && stack.GitConfig.Authentication != nil && stack.GitConfig.Authentication.Password != "" {
        // sanitize password in the http response to minimise possible security leaks
        stack.GitConfig.Authentication.Password = ""
    }

    return response.JSON(w, stack)
}