2018-06-11 13:13:19 +00:00
|
|
|
package stacks
|
|
|
|
|
|
|
|
import (
|
|
|
|
"net/http"
|
|
|
|
|
2018-09-10 10:01:38 +00:00
|
|
|
httperror "github.com/portainer/libhttp/error"
|
|
|
|
"github.com/portainer/libhttp/request"
|
|
|
|
"github.com/portainer/libhttp/response"
|
2021-02-23 03:21:39 +00:00
|
|
|
portainer "github.com/portainer/portainer/api"
|
2020-07-07 21:57:52 +00:00
|
|
|
bolterrors "github.com/portainer/portainer/api/bolt/errors"
|
|
|
|
"github.com/portainer/portainer/api/http/errors"
|
2019-03-21 01:20:14 +00:00
|
|
|
"github.com/portainer/portainer/api/http/security"
|
2021-02-23 20:18:05 +00:00
|
|
|
"github.com/portainer/portainer/api/internal/stackutils"
|
2018-06-11 13:13:19 +00:00
|
|
|
)
|
|
|
|
|
|
|
|
type stackFileResponse struct {
|
2021-02-23 03:21:39 +00:00
|
|
|
// Content of the Stack file
|
|
|
|
StackFileContent string `json:"StackFileContent" example:"version: 3\n services:\n web:\n image:nginx"`
|
2018-06-11 13:13:19 +00:00
|
|
|
}
|
|
|
|
|
2021-02-23 03:21:39 +00:00
|
|
|
// @id StackFileInspect
|
|
|
|
// @summary Retrieve the content of the Stack file for the specified stack
|
|
|
|
// @description Get Stack file content.
|
|
|
|
// @description **Access policy**: restricted
|
|
|
|
// @tags stacks
|
2021-11-30 02:31:16 +00:00
|
|
|
// @security ApiKeyAuth
|
2021-02-23 03:21:39 +00:00
|
|
|
// @security jwt
|
|
|
|
// @produce json
|
|
|
|
// @param id path int true "Stack identifier"
|
|
|
|
// @success 200 {object} stackFileResponse "Success"
|
|
|
|
// @failure 400 "Invalid request"
|
|
|
|
// @failure 403 "Permission denied"
|
|
|
|
// @failure 404 "Stack not found"
|
|
|
|
// @failure 500 "Server error"
|
|
|
|
// @router /stacks/{id}/file [get]
|
2018-06-11 13:13:19 +00:00
|
|
|
func (handler *Handler) stackFile(w http.ResponseWriter, r *http.Request) *httperror.HandlerError {
|
2018-06-18 10:07:56 +00:00
|
|
|
stackID, err := request.RetrieveNumericRouteVariableValue(r, "id")
|
2018-06-11 13:13:19 +00:00
|
|
|
if err != nil {
|
|
|
|
return &httperror.HandlerError{http.StatusBadRequest, "Invalid stack identifier route variable", err}
|
|
|
|
}
|
|
|
|
|
2020-05-20 05:23:15 +00:00
|
|
|
stack, err := handler.DataStore.Stack().Stack(portainer.StackID(stackID))
|
2020-07-07 21:57:52 +00:00
|
|
|
if err == bolterrors.ErrObjectNotFound {
|
2018-06-11 13:13:19 +00:00
|
|
|
return &httperror.HandlerError{http.StatusNotFound, "Unable to find a stack with the specified identifier inside the database", err}
|
|
|
|
} else if err != nil {
|
|
|
|
return &httperror.HandlerError{http.StatusInternalServerError, "Unable to find a stack with the specified identifier inside the database", err}
|
|
|
|
}
|
|
|
|
|
2021-06-10 02:52:33 +00:00
|
|
|
securityContext, err := security.RetrieveRestrictedRequestContext(r)
|
|
|
|
if err != nil {
|
|
|
|
return &httperror.HandlerError{http.StatusInternalServerError, "Unable to retrieve info from request context", err}
|
|
|
|
}
|
|
|
|
|
2020-05-20 05:23:15 +00:00
|
|
|
endpoint, err := handler.DataStore.Endpoint().Endpoint(stack.EndpointID)
|
2020-07-07 21:57:52 +00:00
|
|
|
if err == bolterrors.ErrObjectNotFound {
|
2021-06-10 02:52:33 +00:00
|
|
|
if !securityContext.IsAdmin {
|
2021-09-08 08:42:17 +00:00
|
|
|
return &httperror.HandlerError{http.StatusNotFound, "Unable to find an environment with the specified identifier inside the database", err}
|
2021-06-10 02:52:33 +00:00
|
|
|
}
|
2019-05-24 06:04:58 +00:00
|
|
|
} else if err != nil {
|
2021-09-08 08:42:17 +00:00
|
|
|
return &httperror.HandlerError{http.StatusInternalServerError, "Unable to find an environment with the specified identifier inside the database", err}
|
2019-05-24 06:04:58 +00:00
|
|
|
}
|
|
|
|
|
2021-06-10 02:52:33 +00:00
|
|
|
if endpoint != nil {
|
|
|
|
err = handler.requestBouncer.AuthorizedEndpointOperation(r, endpoint)
|
|
|
|
if err != nil {
|
2021-09-08 08:42:17 +00:00
|
|
|
return &httperror.HandlerError{http.StatusForbidden, "Permission denied to access environment", err}
|
2021-06-10 02:52:33 +00:00
|
|
|
}
|
2018-06-11 13:13:19 +00:00
|
|
|
|
2021-09-07 00:37:26 +00:00
|
|
|
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.HandlerError{http.StatusInternalServerError, "Unable to retrieve a resource control associated to the stack", err}
|
|
|
|
}
|
2018-06-11 13:13:19 +00:00
|
|
|
|
2021-09-07 00:37:26 +00:00
|
|
|
access, err := handler.userCanAccessStack(securityContext, endpoint.ID, resourceControl)
|
|
|
|
if err != nil {
|
|
|
|
return &httperror.HandlerError{http.StatusInternalServerError, "Unable to verify user authorizations to validate stack access", err}
|
|
|
|
}
|
|
|
|
if !access {
|
|
|
|
return &httperror.HandlerError{http.StatusForbidden, "Access denied to resource", errors.ErrResourceAccessDenied}
|
|
|
|
}
|
2021-06-10 02:52:33 +00:00
|
|
|
}
|
2018-06-11 13:13:19 +00:00
|
|
|
}
|
|
|
|
|
2021-11-01 11:01:03 +00:00
|
|
|
stackFileContent, err := handler.FileService.GetFileContent(stack.ProjectPath, stack.EntryPoint)
|
2018-06-11 13:13:19 +00:00
|
|
|
if err != nil {
|
|
|
|
return &httperror.HandlerError{http.StatusInternalServerError, "Unable to retrieve Compose file from disk", err}
|
|
|
|
}
|
|
|
|
|
2018-07-03 18:31:02 +00:00
|
|
|
return response.JSON(w, &stackFileResponse{StackFileContent: string(stackFileContent)})
|
2018-06-11 13:13:19 +00:00
|
|
|
}
|