mirror of
https://github.com/willnorris/imageproxy.git
synced 2026-05-23 02:45:13 +02:00
add support for URL encoding remote URL
Updates #250 Updates #290 Fixes #447 Co-authored-by: Will Norris <will@willnorris.com>
This commit is contained in:
Matthew Beatty
Will Norris
parent
1ceba2538c
commit
ee4a497c77
3 changed files with 80 additions and 12 deletions
22
README.md
22
README.md
|
|
@ -46,15 +46,23 @@ See the full list of available options at
|
|||
### Remote URL
|
||||
|
||||
The URL of the original image to load is specified as the remainder of the
|
||||
path, without any encoding. For example,
|
||||
`http://localhost/200/https://willnorris.com/logo.jpg`.
|
||||
path. It may be included in plain text without any encoding,
|
||||
percent-encoded (aka URL encoded), or base64 encoded (URL safe, no padding).
|
||||
|
||||
If the URL contains a query string, it is treated as part of the remote URL.
|
||||
When no encoding is used, any URL query string is treated as part of the remote URL.
|
||||
For example, given the proxy URL of `http://localhost/x/http://example.com/?id=1`,
|
||||
the remote URL is `http://example.com/?id=1`.
|
||||
|
||||
Alternatively, the remote URL may be base64 encoded (URL safe, no padding).
|
||||
This can be helpful if the URL contains characters or encoding that imageproxy
|
||||
is not handling properly. For example,
|
||||
`http://localhost/200/aHR0cHM6Ly93aWxsbm9ycmlzLmNvbS9sb2dvLmpwZw`.
|
||||
When percent-encoding is used, the full URL must be encoded.
|
||||
Any query string on the proxy URL is NOT included as part of the remote URL.
|
||||
Percent-encoded URLs must be absolute URLs;
|
||||
they cannot be relative URLs used with a default base URL.
|
||||
For example, `http://localhost/x/http%3A%2F%2Fexample.com%2F%3Fid%3D1`.
|
||||
|
||||
When base64 encoding is used, the full URL must be encoded.
|
||||
Any query string on the proxy URL is NOT included as part of the remote URL.
|
||||
Base64 encoded URLs may be relative URLs used with a default base URL.
|
||||
For example, `http://localhost/x/aHR0cDovL2V4YW1wbGUuY29tLz9pZD0x`.
|
||||
|
||||
### Examples
|
||||
|
||||
|
|
|
|||
33
data.go
33
data.go
|
|
@ -327,10 +327,23 @@ func (r Request) String() string {
|
|||
// NewRequest parses an http.Request into an imageproxy Request. Options and
|
||||
// the remote image URL are specified in the request path, formatted as:
|
||||
// /{options}/{remote_url}. Options may be omitted, so a request path may
|
||||
// simply contain /{remote_url}. The remote URL must either be:
|
||||
// simply contain /{remote_url}.
|
||||
//
|
||||
// - an absolute "http" or "https" URL, not be URL encoded, with optional query string, or
|
||||
// - base64 encoded (URL safe, no padding).
|
||||
// The remote URL may be included in plain text without any encoding,
|
||||
// percent-encoded (aka URL encoded), or base64 encoded (URL safe, no padding).
|
||||
//
|
||||
// When no encoding is used, any URL query string is treated as part of the remote URL.
|
||||
// For example, given the proxy URL of `http://localhost/x/http://example.com/?id=1`,
|
||||
// the remote URL is `http://example.com/?id=1`.
|
||||
//
|
||||
// When percent-encoding is used, the full URL must be encoded.
|
||||
// Any query string on the proxy URL is NOT included as part of the remote URL.
|
||||
// Percent-encoded URLs must be absolute URLs;
|
||||
// they cannot be relative URLs used with a default base URL.
|
||||
//
|
||||
// When base64 encoding is used, the full URL must be encoded.
|
||||
// Any query string on the proxy URL is NOT included as part of the remote URL.
|
||||
// Base64 encoded URLs may be relative URLs used with a default base URL.
|
||||
//
|
||||
// Assuming an imageproxy server running on localhost, the following are all
|
||||
// valid imageproxy requests:
|
||||
|
|
@ -339,11 +352,12 @@ func (r Request) String() string {
|
|||
// http://localhost/100x200,r90/http://example.com/image.jpg?foo=bar
|
||||
// http://localhost//http://example.com/image.jpg
|
||||
// http://localhost/http://example.com/image.jpg
|
||||
// http://localhost/x/http%3A%2F%2Fexample.com%2Fimage.jpg
|
||||
// http://localhost/100x200/aHR0cDovL2V4YW1wbGUuY29tL2ltYWdlLmpwZw
|
||||
func NewRequest(r *http.Request, baseURL *url.URL) (*Request, error) {
|
||||
var err error
|
||||
req := &Request{Original: r}
|
||||
var enc bool // whether the remote URL was base64 encoded
|
||||
var enc bool // whether the remote URL was base64 or URL encoded
|
||||
|
||||
path := r.URL.EscapedPath()[1:] // strip leading slash
|
||||
req.URL, enc, err = parseURL(path, baseURL)
|
||||
|
|
@ -376,7 +390,7 @@ func NewRequest(r *http.Request, baseURL *url.URL) (*Request, error) {
|
|||
}
|
||||
|
||||
if !enc {
|
||||
// if the remote URL was not base64-encoded,
|
||||
// if the remote URL was not base64 or URL encoded,
|
||||
// then the query string is part of the remote URL
|
||||
req.URL.RawQuery = r.URL.RawQuery
|
||||
}
|
||||
|
|
@ -384,6 +398,7 @@ func NewRequest(r *http.Request, baseURL *url.URL) (*Request, error) {
|
|||
}
|
||||
|
||||
var reCleanedURL = regexp.MustCompile(`^(https?):/+([^/])`)
|
||||
var reIsEncodedURL = regexp.MustCompile(`^(?i)https?%3A%2F`)
|
||||
|
||||
// parseURL parses s as a URL, handling URLs that have been munged by
|
||||
// path.Clean or a webserver that collapses multiple slashes.
|
||||
|
|
@ -406,6 +421,14 @@ func parseURL(s string, baseURL *url.URL) (_ *url.URL, enc bool, _ error) {
|
|||
}
|
||||
}
|
||||
|
||||
// If the string looks like a URL encoded absolute HTTP(S) URL, decode it.
|
||||
if reIsEncodedURL.MatchString(s) {
|
||||
if u, err := url.PathUnescape(s); err == nil {
|
||||
enc = true
|
||||
s = u
|
||||
}
|
||||
}
|
||||
|
||||
s = reCleanedURL.ReplaceAllString(s, "$1://$2")
|
||||
u, err := url.Parse(s)
|
||||
return u, enc, err
|
||||
|
|
|
|||
37
data_test.go
37
data_test.go
|
|
@ -177,6 +177,43 @@ func TestNewRequest(t *testing.T) {
|
|||
"http://localhost/http://example.com/%2C",
|
||||
"http://example.com/%2C", emptyOptions, false,
|
||||
},
|
||||
// percent encoded cases
|
||||
{
|
||||
"http://localhost/1x2/http%3A%2F%2Fexample.com%2Ffoo",
|
||||
"http://example.com/foo", Options{Width: 1, Height: 2}, false,
|
||||
},
|
||||
{
|
||||
"http://localhost/1x2/http%3A%2F%2Fexample.com%2Fhttp%2Fstuff",
|
||||
"http://example.com/http/stuff", Options{Width: 1, Height: 2}, false,
|
||||
},
|
||||
{
|
||||
"http://localhost/http%3A%2F%2Fexample.com%2Ffoo",
|
||||
"http://example.com/foo", emptyOptions, false,
|
||||
},
|
||||
{
|
||||
"http://localhost/HTTP%3a%2f%2fexample.com%2Ffoo",
|
||||
"http://example.com/foo", emptyOptions, false,
|
||||
},
|
||||
{
|
||||
"http://localhost/http%3A%2Fexample.com%2Ffoo",
|
||||
"http://example.com/foo", emptyOptions, false,
|
||||
},
|
||||
{
|
||||
"http://localhost/http%3A%2F%2F%2Fexample.com%2Ffoo",
|
||||
"http://example.com/foo", emptyOptions, false,
|
||||
},
|
||||
{
|
||||
"http://localhost//http%3A%2F%2Fexample.com%2Ffoo",
|
||||
"http://example.com/foo", emptyOptions, false,
|
||||
},
|
||||
{
|
||||
"http://localhost/http%3A%2F%2Fexample.com%2Ffoo%3Ftest%3D1%26test%3D2",
|
||||
"http://example.com/foo?test=1&test=2", emptyOptions, false,
|
||||
},
|
||||
{
|
||||
"http://localhost/1x2/http%3A%2F%2Fexample.com%2Ffoo%3Ftest%3D1%26test%3D2",
|
||||
"http://example.com/foo?test=1&test=2", Options{Width: 1, Height: 2}, false,
|
||||
},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue