mirror of
https://github.com/yusing/godoxy.git
synced 2026-04-10 18:56:55 +02:00
Finish the file API traversal fix by rooting both GET and SET operations at the
actual file-type directory instead of the process working directory. This blocks
`..` escapes from `config/` and `config/middlewares/` while preserving valid
in-root reads and writes.
Also harden the optional unauthenticated local API listener so it only starts on
loopback addresses (`localhost`, `127.0.0.1`, `::1`). This preserves same-host
automation while preventing accidental exposure on wildcard, LAN, bridge, or
public interfaces.
Add regression tests for blocked traversal on GET and SET, valid in-root writes,
and loopback-only local API address validation. Fix an unrelated config test
cleanup panic so the touched package verification can run cleanly.
Constraint: `GODOXY_LOCAL_API_ADDR` is documented for local automation and must remain usable without adding a new auth flow
Constraint: File API behavior must keep valid config/provider/middleware edits working while blocking path escapes
Rejected: Mirror the previous GET `OpenInRoot(".", ...)` approach in SET | still allows escapes from `config/` to sibling paths under the working directory
Rejected: Keep unauthenticated non-loopback local API binds and document the risk | preserves a high-severity pre-auth network exposure
Confidence: high
Scope-risk: moderate
Reversibility: clean
Directive: Treat `LOCAL_API_ADDR` as same-host only; if non-loopback unauthenticated access is ever needed, gate it behind a separately named explicit insecure opt-in
Tested: `go test -count=1 -ldflags='-checklinkname=0' ./internal/api/v1/file -run 'Test(Get|Set)_PathTraversalBlocked' -v`
Tested: `go test -count=1 -ldflags='-checklinkname=0' ./internal/config -run '^TestValidateLocalAPIAddr$|^TestRouteValidateInboundMTLSProfile$' -v`
Tested: `go test -count=1 -ldflags='-checklinkname=0' ./internal/api/... ./internal/config/...`
Not-tested: End-to-end runtime verification of fsnotify reload behavior after a valid in-root provider edit
60 lines
1.6 KiB
Go
60 lines
1.6 KiB
Go
package fileapi
|
|
|
|
import (
|
|
"net/http"
|
|
"os"
|
|
|
|
"github.com/gin-gonic/gin"
|
|
apitypes "github.com/yusing/goutils/apitypes"
|
|
)
|
|
|
|
type SetFileContentRequest GetFileContentRequest
|
|
|
|
// @x-id "set"
|
|
// @BasePath /api/v1
|
|
// @Summary Set file content
|
|
// @Description Set file content
|
|
// @Tags file
|
|
// @Accept text/plain
|
|
// @Produce json
|
|
// @Param type query FileType true "Type"
|
|
// @Param filename query string true "Filename"
|
|
// @Param file body string true "File"
|
|
// @Success 200 {object} apitypes.SuccessResponse
|
|
// @Failure 400 {object} apitypes.ErrorResponse
|
|
// @Failure 403 {object} apitypes.ErrorResponse
|
|
// @Failure 500 {object} apitypes.ErrorResponse
|
|
// @Router /file/content [put]
|
|
func Set(c *gin.Context) {
|
|
var request SetFileContentRequest
|
|
if err := c.ShouldBindQuery(&request); err != nil {
|
|
c.JSON(http.StatusBadRequest, apitypes.Error("invalid request", err))
|
|
return
|
|
}
|
|
|
|
content, err := c.GetRawData()
|
|
if err != nil {
|
|
c.Error(apitypes.InternalServerError(err, "failed to read file"))
|
|
return
|
|
}
|
|
|
|
if valErr := validateFile(request.FileType, content); valErr != nil {
|
|
c.JSON(http.StatusBadRequest, apitypes.Error("invalid file", valErr))
|
|
return
|
|
}
|
|
|
|
f, err := request.FileType.OpenFile(request.Filename, os.O_WRONLY|os.O_CREATE|os.O_TRUNC, 0o644)
|
|
if err != nil {
|
|
c.Error(apitypes.InternalServerError(err, "failed to open file"))
|
|
return
|
|
}
|
|
defer f.Close()
|
|
|
|
_, err = f.Write(content)
|
|
if err != nil {
|
|
c.Error(apitypes.InternalServerError(err, "failed to write file"))
|
|
return
|
|
}
|
|
c.JSON(http.StatusOK, apitypes.Success("file set"))
|
|
}
|