Skip to content

Use a sentinel error when blocking paths for RepositoriesServices.GetContents #2837

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
gmlewis merged 1 commit into from
Jul 21, 2023
+3 −1
Merged

Use a sentinel error when blocking paths for RepositoriesServices.GetContents #2837

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
feat: Use a sentinel error when blocking paths for `RepositoriesServi… 
…ces.GetContents`

This allows users to catch this specific error using `errors.Is`.
  • Loading branch information
@k0ral
k0ral committed Jul 21, 2023
commit 995c57e5cb62db8c8b8562bc7bd764dd7713641f
4 changes: 3 additions & 1 deletion github/repos_contents.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ import (
"strings"
)

var ErrPathForbidden = errors.New("path must not contain '..' due to auth vulnerability issue")

// RepositoryContent represents a file or directory in a github repository.
type RepositoryContent struct {
Type *string `json:"type,omitempty"`
Expand Down Expand Up @@ -198,7 +200,7 @@ func (s *RepositoriesService) DownloadContentsWithMeta(ctx context.Context, owne
// GitHub API docs: https://docs.github.com/en/rest/repos/contents#get-repository-content
func (s *RepositoriesService) GetContents(ctx context.Context, owner, repo, path string, opts *RepositoryContentGetOptions) (fileContent *RepositoryContent, directoryContent []*RepositoryContent, resp *Response, err error) {
if strings.Contains(path, "..") {
return nil, nil, nil, errors.New("path must not contain '..' due to auth vulnerability issue")
return nil, nil, nil, ErrPathForbidden
}

escapedPath := (&url.URL{Path: strings.TrimSuffix(path, "/")}).String()
Expand Down